Anthos Multi-Cloud v1 API - Class AzureClusterName (2.2.0)

public sealed class AzureClusterName : IResourceName, IEquatable<AzureClusterName>

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

Resource name for the AzureCluster resource.

Inheritance

object > AzureClusterName

Implements

IResourceName, IEquatable AzureClusterName

Inherited Members

object.GetType()

object.MemberwiseClone()

Namespace

Google CloudGoogle.Cloud.GkeMultiCloudV1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AzureClusterName(string, string, string)

public AzureClusterName(string projectId, string locationId, string azureClusterId)

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

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.

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`

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 AzureClusterName.ResourceNameType Type { get; }

The AzureClusterName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`AzureClusterNameResourceNameType`

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)

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

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

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.

Returns
Type	Description
`string`	The string representation of this AzureClusterName with pattern `projects/{project}/locations/{location}/azureClusters/{azure_cluster}`.

FormatProjectLocationAzureCluster(string, string, string)

public static string FormatProjectLocationAzureCluster(string projectId, string locationId, string azureClusterId)

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

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.

Returns
Type	Description
`string`	The string representation of this AzureClusterName with pattern `projects/{project}/locations/{location}/azureClusters/{azure_cluster}`.

FromProjectLocationAzureCluster(string, string, string)

public static AzureClusterName FromProjectLocationAzureCluster(string projectId, string locationId, string azureClusterId)

Creates a AzureClusterName with the pattern projects/{project}/locations/{location}/azureClusters/{azure_cluster}.

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.

Returns
Type	Description
`AzureClusterName`	A new instance of AzureClusterName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AzureClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AzureClusterName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`AzureClusterName`	A new instance of AzureClusterName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

Object.GetHashCode()

Parse(string)

public static AzureClusterName Parse(string azureClusterName)

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

Parameter
Name	Description
`azureClusterName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`AzureClusterName`	The parsed AzureClusterName if successful.

Remarks

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

projects/{project}/locations/{location}/azureClusters/{azure_cluster}

Parse(string, bool)

public static AzureClusterName Parse(string azureClusterName, bool allowUnparsed)

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

Parameters
Name	Description
`azureClusterName`	`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
`AzureClusterName`	The parsed AzureClusterName if successful.

Remarks

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

projects/{project}/locations/{location}/azureClusters/{azure_cluster}

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 AzureClusterName)

public static bool TryParse(string azureClusterName, out AzureClusterName result)

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

Parameters
Name	Description
`azureClusterName`	`string` The resource name in string form. Must not be `null`.
`result`	`AzureClusterName` When this method returns, the parsed AzureClusterName, 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}

TryParse(string, bool, out AzureClusterName)

public static bool TryParse(string azureClusterName, bool allowUnparsed, out AzureClusterName result)

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

Parameters
Name	Description
`azureClusterName`	`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`	`AzureClusterName` When this method returns, the parsed AzureClusterName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(AzureClusterName, AzureClusterName)

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

Parameters
Name	Description
`a`	`AzureClusterName`
`b`	`AzureClusterName`

Returns
Type	Description
`bool`

operator !=(AzureClusterName, AzureClusterName)

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

Parameters
Name	Description
`a`	`AzureClusterName`
`b`	`AzureClusterName`

Returns
Type	Description
`bool`