Anthos Multi-Cloud v1 API - Class AzureClientName (2.8.0) 

public sealed class AzureClientName : IResourceName, IEquatable<AzureClientName>

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

Resource name for the AzureClient resource.

Inheritance

object > AzureClientName

Namespace

Google.Cloud.GkeMultiCloud.V1

Assembly

Google.Cloud.GkeMultiCloud.V1.dll

Constructors

AzureClientName(string, string, string)

public AzureClientName(string projectId, string locationId, string azureClientId)

Constructs a new instance of a AzureClientName class from the component parts of pattern projects/{project}/locations/{location}/azureClients/{azure_client}

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.
azureClientId string

The AzureClient ID. Must not be null or empty.

Properties

AzureClientId

public string AzureClientId { get; }

The AzureClient 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 AzureClientName.ResourceNameType Type { get; }

The AzureClientName.ResourceNameType of the contained resource name.

Property Value
Type Description
AzureClientNameResourceNameType

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

Formats the IDs into the string representation of this AzureClientName with pattern projects/{project}/locations/{location}/azureClients/{azure_client}.

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.
azureClientId string

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

The string representation of this AzureClientName with pattern projects/{project}/locations/{location}/azureClients/{azure_client}.

FormatProjectLocationAzureClient(string, string, string)

public static string FormatProjectLocationAzureClient(string projectId, string locationId, string azureClientId)

Formats the IDs into the string representation of this AzureClientName with pattern projects/{project}/locations/{location}/azureClients/{azure_client}.

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.
azureClientId string

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

The string representation of this AzureClientName with pattern projects/{project}/locations/{location}/azureClients/{azure_client}.

FromProjectLocationAzureClient(string, string, string)

public static AzureClientName FromProjectLocationAzureClient(string projectId, string locationId, string azureClientId)

Creates a AzureClientName with the pattern projects/{project}/locations/{location}/azureClients/{azure_client}.

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.
azureClientId string

The AzureClient ID. Must not be null or empty.
Returns
Type Description
AzureClientName

A new instance of AzureClientName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AzureClientName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AzureClientName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of AzureClientName 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 AzureClientName Parse(string azureClientName)

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

Parameter
Name Description
azureClientName string

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

The parsed AzureClientName if successful.
Remarks

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

  • projects/{project}/locations/{location}/azureClients/{azure_client}

Parse(string, bool)

public static AzureClientName Parse(string azureClientName, bool allowUnparsed)

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

Parameters
Name Description
azureClientName 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
AzureClientName

The parsed AzureClientName if successful.
Remarks

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

  • projects/{project}/locations/{location}/azureClients/{azure_client}
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 AzureClientName)

public static bool TryParse(string azureClientName, out AzureClientName result)

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

Parameters
Name Description
azureClientName string

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

When this method returns, the parsed AzureClientName, 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}/azureClients/{azure_client}

TryParse(string, bool, out AzureClientName)

public static bool TryParse(string azureClientName, bool allowUnparsed, out AzureClientName result)

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

Parameters
Name Description
azureClientName 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 AzureClientName

When this method returns, the parsed AzureClientName, 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}/azureClients/{azure_client}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(AzureClientName, AzureClientName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AzureClientName

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

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 !=(AzureClientName, AzureClientName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AzureClientName

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

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.