Anthos Multi-Cloud v1 API - Class AzureNodePoolName (2.1.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

Implements

IResourceName, IEquatable<AzureNodePoolName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

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
`Boolean`

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
`AzureNodePoolName.ResourceNameType`

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
`Int32`

Overrides

Object.GetHashCode()

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, Boolean)

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`	`Boolean` 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

Object.ToString()

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
`Boolean`	`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, Boolean, 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`	`Boolean` 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
`Boolean`	`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

Equality(AzureNodePoolName, AzureNodePoolName)

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

Parameters
Name	Description
`a`	`AzureNodePoolName`
`b`	`AzureNodePoolName`

Returns
Type	Description
`Boolean`

Inequality(AzureNodePoolName, AzureNodePoolName)

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

Parameters
Name	Description
`a`	`AzureNodePoolName`
`b`	`AzureNodePoolName`

Returns
Type	Description
`Boolean`