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. |
↳ reconciling |
bool
Output only. If set, there are currently pending changes to the client. |
↳ 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. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which this client was last updated. |
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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTenantId
Required. The Azure Active Directory Tenant ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setTenantId
Required. The Azure Active Directory Tenant ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getApplicationId
Required. The Azure Active Directory Application ID.
| Returns | |
|---|---|
| Type | Description |
string | |
setApplicationId
Required. The Azure Active Directory Application ID.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReconciling
Output only. If set, there are currently pending changes to the client.
| Returns | |
|---|---|
| Type | Description |
bool | |
setReconciling
Output only. If set, there are currently pending changes to the client.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| 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.
| 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPemCertificate
Output only. The PEM encoded x509 certificate.
| Returns | |
|---|---|
| Type | Description |
string | |
setPemCertificate
Output only. The PEM encoded x509 certificate.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. A globally unique identifier for the client.
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. A globally unique identifier for the client.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which this resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time at which this client was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this client was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |