Anthos Multi-Cloud v1 API - Class AzureNodePoolName (2.5.0) 

public sealed class AzureNodePoolName : IResourceName, IEquatable<AzureNodePoolName>

Reference documentation and code samples for the Anthos Multi-Cloud v1 API class AzureNodePoolName.

Resource name for the AzureNodePool resource.

Inheritance

object > AzureNodePoolName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AzureNodePoolName(string, string, string, string)

public AzureNodePoolName(string projectId, string locationId, string azureClusterId, string azureNodePoolId)

Constructs a new instance of a AzureNodePoolName class from the component parts of pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
azureClusterId string

The AzureCluster ID. Must not be null or empty.
azureNodePoolId string

The AzureNodePool ID. Must not be null or empty.

Properties

AzureClusterId

public string AzureClusterId { get; }

The AzureCluster ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

AzureNodePoolId

public string AzureNodePoolId { get; }

The AzureNodePool ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Type

public AzureNodePoolName.ResourceNameType Type { get; }

The AzureNodePoolName.ResourceNameType of the contained resource name.

Property Value
Type Description
AzureNodePoolNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string azureClusterId, string azureNodePoolId)

Formats the IDs into the string representation of this AzureNodePoolName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
azureClusterId string

The AzureCluster ID. Must not be null or empty.
azureNodePoolId string

The AzureNodePool ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AzureNodePoolName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool} .

FormatProjectLocationAzureClusterAzureNodePool(string, string, string, string)

public static string FormatProjectLocationAzureClusterAzureNodePool(string projectId, string locationId, string azureClusterId, string azureNodePoolId)

Formats the IDs into the string representation of this AzureNodePoolName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
azureClusterId string

The AzureCluster ID. Must not be null or empty.
azureNodePoolId string

The AzureNodePool ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this AzureNodePoolName with pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool} .

FromProjectLocationAzureClusterAzureNodePool(string, string, string, string)

public static AzureNodePoolName FromProjectLocationAzureClusterAzureNodePool(string projectId, string locationId, string azureClusterId, string azureNodePoolId)

Creates a AzureNodePoolName with the pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
azureClusterId string

The AzureCluster ID. Must not be null or empty.
azureNodePoolId string

The AzureNodePool ID. Must not be null or empty.
Returns
Type Description
AzureNodePoolName

A new instance of AzureNodePoolName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AzureNodePoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AzureNodePoolName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
AzureNodePoolName

A new instance of AzureNodePoolName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static AzureNodePoolName Parse(string azureNodePoolName)

Parses the given resource name string into a new AzureNodePoolName instance.

Parameter
Name Description
azureNodePoolName string

The resource name in string form. Must not be null.
Returns
Type Description
AzureNodePoolName

The parsed AzureNodePoolName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool}

Parse(string, bool)

public static AzureNodePoolName Parse(string azureNodePoolName, bool allowUnparsed)

Parses the given resource name string into a new AzureNodePoolName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
azureNodePoolName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
Returns
Type Description
AzureNodePoolName

The parsed AzureNodePoolName if successful.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.
Overrides

TryParse(string, out AzureNodePoolName)

public static bool TryParse(string azureNodePoolName, out AzureNodePoolName result)

Tries to parse the given resource name string into a new AzureNodePoolName instance.

Parameters
Name Description
azureNodePoolName string

The resource name in string form. Must not be null.
result AzureNodePoolName

When this method returns, the parsed AzureNodePoolName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool}

TryParse(string, bool, out AzureNodePoolName)

public static bool TryParse(string azureNodePoolName, bool allowUnparsed, out AzureNodePoolName result)

Tries to parse the given resource name string into a new AzureNodePoolName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
azureNodePoolName string

The resource name in string form. Must not be null.
allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result AzureNodePoolName

When this method returns, the parsed AzureNodePoolName, or null if parsing failed.
Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.
Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/azureClusters/{azure_cluster}/azureNodePools/{azure_node_pool}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AzureNodePoolName, AzureNodePoolName)

public static bool operator ==(AzureNodePoolName a, AzureNodePoolName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AzureNodePoolName

The first resource name to compare, or null.
b AzureNodePoolName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(AzureNodePoolName, AzureNodePoolName)

public static bool operator !=(AzureNodePoolName a, AzureNodePoolName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a AzureNodePoolName

The first resource name to compare, or null.
b AzureNodePoolName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.