Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AzureClient.
AzureClient resources hold client authentication information needed by the
Anthos Multi-Cloud API to manage Azure resources on your Azure subscription.
When an AzureCluster is created, an AzureClient resource needs to be
provided and all operations on Azure resources associated to that cluster
will authenticate to Azure services using the given client.
AzureClient resources are immutable and cannot be modified upon creation.
Each AzureClient resource is bound to a single Azure Active Directory
Application and tenant.
Generated from protobuf message google.cloud.gkemulticloud.v1.AzureClient
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of this resource. |
↳ tenant_id |
string
Required. The Azure Active Directory Tenant ID. |
↳ application_id |
string
Required. The Azure Active Directory Application ID. |
↳ annotations |
array|Google\Protobuf\Internal\MapField
Optional. Annotations on the resource. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. |
↳ pem_certificate |
string
Output only. The PEM encoded x509 certificate. |
↳ uid |
string
Output only. A globally unique identifier for the client. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which this resource was created. |
getName
The name of this resource.
AzureClient resource names are formatted as
projects/<project-number>/locations/<region>/azureClients/<client-id>.
See Resource Names
for more details on Google Cloud resource names.
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The name of this resource.
AzureClient resource names are formatted as
projects/<project-number>/locations/<region>/azureClients/<client-id>.
See Resource Names
for more details on Google Cloud resource names.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTenantId
Required. The Azure Active Directory Tenant ID.
Generated from protobuf field string tenant_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string |
|
setTenantId
Required. The Azure Active Directory Tenant ID.
Generated from protobuf field string tenant_id = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApplicationId
Required. The Azure Active Directory Application ID.
Generated from protobuf field string application_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string |
|
setApplicationId
Required. The Azure Active Directory Application ID.
Generated from protobuf field string application_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAnnotations
Optional. Annotations on the resource.
This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
Generated from protobuf field map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setAnnotations
Optional. Annotations on the resource.
This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Keys can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.
Generated from protobuf field map<string, string> annotations = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPemCertificate
Output only. The PEM encoded x509 certificate.
Generated from protobuf field string pem_certificate = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setPemCertificate
Output only. The PEM encoded x509 certificate.
Generated from protobuf field string pem_certificate = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. A globally unique identifier for the client.
Generated from protobuf field string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. A globally unique identifier for the client.
Generated from protobuf field string uid = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which this resource was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this resource was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|