Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AzureCluster.
An Anthos cluster running on Azure.
Generated from protobuf message google.cloud.gkemulticloud.v1.AzureCluster
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of this resource. Cluster names are formatted as |
↳ description |
string
Optional. A human readable description of this cluster. Cannot be longer than 255 UTF-8 encoded bytes. |
↳ azure_region |
string
Required. The Azure region where the cluster runs. Each Google Cloud region supports a subset of nearby Azure regions. You can call GetAzureServerConfig to list all supported Azure regions within a given Google Cloud region. |
↳ resource_group_id |
string
Required. The ARM ID of the resource group where the cluster resources are deployed. For example: |
↳ azure_client |
string
Required. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs. The |
↳ networking |
Google\Cloud\GkeMultiCloud\V1\AzureClusterNetworking
Required. Cluster-wide networking configuration. |
↳ control_plane |
Google\Cloud\GkeMultiCloud\V1\AzureControlPlane
Required. Configuration related to the cluster control plane. |
↳ authorization |
Google\Cloud\GkeMultiCloud\V1\AzureAuthorization
Required. Configuration related to the cluster RBAC settings. |
↳ state |
int
Output only. The current state of the cluster. |
↳ endpoint |
string
Output only. The endpoint of the cluster's API server. |
↳ uid |
string
Output only. A globally unique identifier for the cluster. |
↳ reconciling |
bool
Output only. If set, there are currently changes in flight to the cluster. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time at which this cluster was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The time at which this cluster was last updated. |
↳ etag |
string
Allows clients to perform consistent read-modify-writes through optimistic concurrency control. Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
↳ annotations |
array|Google\Protobuf\Internal\MapField
Optional. Annotations on the cluster. 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. |
↳ workload_identity_config |
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig
Output only. Workload Identity settings. |
↳ cluster_ca_certificate |
string
Output only. PEM encoded x509 certificate of the cluster root of trust. |
↳ fleet |
Google\Cloud\GkeMultiCloud\V1\Fleet
Optional. Fleet configuration. |
↳ managed_resources |
Google\Cloud\GkeMultiCloud\V1\AzureClusterResources
Output only. Mananged Azure resources for this cluster. |
↳ logging_config |
Google\Cloud\GkeMultiCloud\V1\LoggingConfig
Optional. Logging configuration for this cluster. |
getName
The name of this resource.
Cluster names are formatted as
projects/<project-number>/locations/<region>/azureClusters/<cluster-id>.
See Resource Names
for more details on GCP resource names.
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The name of this resource.
Cluster names are formatted as
projects/<project-number>/locations/<region>/azureClusters/<cluster-id>.
See Resource Names
for more details on GCP resource names.
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
Optional. A human readable description of this cluster.
Cannot be longer than 255 UTF-8 encoded bytes.
Generated from protobuf field string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAzureRegion
Required. The Azure region where the cluster runs.
Each Google Cloud region supports a subset of nearby Azure regions. You can call GetAzureServerConfig to list all supported Azure regions within a given Google Cloud region.
Generated from protobuf field string azure_region = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setAzureRegion
Required. The Azure region where the cluster runs.
Each Google Cloud region supports a subset of nearby Azure regions. You can call GetAzureServerConfig to list all supported Azure regions within a given Google Cloud region.
Generated from protobuf field string azure_region = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResourceGroupId
Required. The ARM ID of the resource group where the cluster resources are deployed.
For example:
/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>
Generated from protobuf field string resource_group_id = 17 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setResourceGroupId
Required. The ARM ID of the resource group where the cluster resources are deployed.
For example:
/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>
Generated from protobuf field string resource_group_id = 17 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAzureClient
Required. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs.
The AzureClient resource must reside on the same GCP project and region
as the AzureCluster.
AzureClient 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 azure_client = 16 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setAzureClient
Required. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs.
The AzureClient resource must reside on the same GCP project and region
as the AzureCluster.
AzureClient 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 azure_client = 16 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetworking
Required. Cluster-wide networking configuration.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureClusterNetworking networking = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AzureClusterNetworking|null | |
hasNetworking
clearNetworking
setNetworking
Required. Cluster-wide networking configuration.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureClusterNetworking networking = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AzureClusterNetworking
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getControlPlane
Required. Configuration related to the cluster control plane.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AzureControlPlane|null | |
hasControlPlane
clearControlPlane
setControlPlane
Required. Configuration related to the cluster control plane.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureControlPlane control_plane = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AzureControlPlane
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAuthorization
Required. Configuration related to the cluster RBAC settings.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureAuthorization authorization = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AzureAuthorization|null | |
hasAuthorization
clearAuthorization
setAuthorization
Required. Configuration related to the cluster RBAC settings.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureAuthorization authorization = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AzureAuthorization
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the cluster.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureCluster.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the cluster.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureCluster.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpoint
Output only. The endpoint of the cluster's API server.
Generated from protobuf field string endpoint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setEndpoint
Output only. The endpoint of the cluster's API server.
Generated from protobuf field string endpoint = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUid
Output only. A globally unique identifier for the cluster.
Generated from protobuf field string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setUid
Output only. A globally unique identifier for the cluster.
Generated from protobuf field string uid = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReconciling
Output only. If set, there are currently changes in flight to the cluster.
Generated from protobuf field bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
bool | |
setReconciling
Output only. If set, there are currently changes in flight to the cluster.
Generated from protobuf field bool reconciling = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The time at which this cluster was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this cluster was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The time at which this cluster was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this cluster was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEtag
Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Generated from protobuf field string etag = 13;
| Returns | |
|---|---|
| Type | Description |
string | |
setEtag
Allows clients to perform consistent read-modify-writes through optimistic concurrency control.
Can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
Generated from protobuf field string etag = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAnnotations
Optional. Annotations on the cluster.
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 = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAnnotations
Optional. Annotations on the cluster.
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 = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWorkloadIdentityConfig
Output only. Workload Identity settings.
Generated from protobuf field .google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig|null | |
hasWorkloadIdentityConfig
clearWorkloadIdentityConfig
setWorkloadIdentityConfig
Output only. Workload Identity settings.
Generated from protobuf field .google.cloud.gkemulticloud.v1.WorkloadIdentityConfig workload_identity_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getClusterCaCertificate
Output only. PEM encoded x509 certificate of the cluster root of trust.
Generated from protobuf field string cluster_ca_certificate = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
string | |
setClusterCaCertificate
Output only. PEM encoded x509 certificate of the cluster root of trust.
Generated from protobuf field string cluster_ca_certificate = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFleet
Optional. Fleet configuration.
Generated from protobuf field .google.cloud.gkemulticloud.v1.Fleet fleet = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\Fleet|null | |
hasFleet
clearFleet
setFleet
Optional. Fleet configuration.
Generated from protobuf field .google.cloud.gkemulticloud.v1.Fleet fleet = 20 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\Fleet
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getManagedResources
Output only. Mananged Azure resources for this cluster.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureClusterResources managed_resources = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\AzureClusterResources|null | |
hasManagedResources
clearManagedResources
setManagedResources
Output only. Mananged Azure resources for this cluster.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureClusterResources managed_resources = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\AzureClusterResources
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLoggingConfig
Optional. Logging configuration for this cluster.
Generated from protobuf field .google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\GkeMultiCloud\V1\LoggingConfig|null | |
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Logging configuration for this cluster.
Generated from protobuf field .google.cloud.gkemulticloud.v1.LoggingConfig logging_config = 23 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\GkeMultiCloud\V1\LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |