Google Anthos Multi Cloud V1 Client - Class AzureCluster (0.5.4)

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

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

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 projects/<project-number>/locations/<region>/azureClusters/<cluster-id>. See Resource Names for more details on Google Cloud Platform resource names.
↳ 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: /subscriptions/<subscription-id>/resourceGroups/<resource-group-name>
↳ azure_client string

Optional. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs. Either azure_client or azure_services_authentication should be provided. The AzureClient resource must reside on the same Google Cloud Platform 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.
↳ 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.
↳ azure_services_authentication Google\Cloud\GkeMultiCloud\V1\AzureServicesAuthentication

Optional. Authentication configuration for management of Azure resources. Either azure_client or azure_services_authentication should be provided.
↳ 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

Required. Fleet configuration.
↳ managed_resources Google\Cloud\GkeMultiCloud\V1\AzureClusterResources

Output only. Managed Azure resources for this cluster.
↳ logging_config Google\Cloud\GkeMultiCloud\V1\LoggingConfig

Optional. Logging configuration for this cluster.
↳ errors array<Google\Cloud\GkeMultiCloud\V1\AzureClusterError>

Output only. A set of errors found in the cluster.
↳ monitoring_config Google\Cloud\GkeMultiCloud\V1\MonitoringConfig

Optional. Monitoring 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 Google Cloud Platform resource names.

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 Google Cloud Platform resource names.

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.

Returns
Type Description
string

setDescription

Optional. A human readable description of this cluster.

Cannot be longer than 255 UTF-8 encoded bytes.

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.

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.

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>

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>

Parameter
Name Description
var string
Returns
Type Description
$this

getAzureClient

Optional. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs.

Either azure_client or azure_services_authentication should be provided. The AzureClient resource must reside on the same Google Cloud Platform 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.

Returns
Type Description
string

setAzureClient

Optional. Name of the AzureClient that contains authentication configuration for how the Anthos Multi-Cloud API connects to Azure APIs.

Either azure_client or azure_services_authentication should be provided. The AzureClient resource must reside on the same Google Cloud Platform 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.

Parameter
Name Description
var string
Returns
Type Description
$this

getNetworking

Required. Cluster-wide networking configuration.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AzureClusterNetworking|null

hasNetworking

clearNetworking

setNetworking

Required. Cluster-wide networking configuration.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AzureClusterNetworking
Returns
Type Description
$this

getControlPlane

Required. Configuration related to the cluster control plane.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AzureControlPlane|null

hasControlPlane

clearControlPlane

setControlPlane

Required. Configuration related to the cluster control plane.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AzureControlPlane
Returns
Type Description
$this

getAuthorization

Required. Configuration related to the cluster RBAC settings.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AzureAuthorization|null

hasAuthorization

clearAuthorization

setAuthorization

Required. Configuration related to the cluster RBAC settings.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AzureAuthorization
Returns
Type Description
$this

getAzureServicesAuthentication

Optional. Authentication configuration for management of Azure resources.

Either azure_client or azure_services_authentication should be provided.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AzureServicesAuthentication|null

hasAzureServicesAuthentication

clearAzureServicesAuthentication

setAzureServicesAuthentication

Optional. Authentication configuration for management of Azure resources.

Either azure_client or azure_services_authentication should be provided.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AzureServicesAuthentication
Returns
Type Description
$this

getState

Output only. The current state of the cluster.

Returns
Type Description
int

setState

Output only. The current state of the cluster.

Parameter
Name Description
var int
Returns
Type Description
$this

getEndpoint

Output only. The endpoint of the cluster's API server.

Returns
Type Description
string

setEndpoint

Output only. The endpoint of the cluster's API server.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. A globally unique identifier for the cluster.

Returns
Type Description
string

setUid

Output only. A globally unique identifier for the cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getReconciling

Output only. If set, there are currently changes in flight to the cluster.

Returns
Type Description
bool

setReconciling

Output only. If set, there are currently changes in flight to the cluster.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCreateTime

Output only. The time at which this cluster was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time at which this cluster was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time at which this cluster was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time at which this cluster was last updated.

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.

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.

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.

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getWorkloadIdentityConfig

Output only. Workload Identity settings.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\WorkloadIdentityConfig|null

hasWorkloadIdentityConfig

clearWorkloadIdentityConfig

setWorkloadIdentityConfig

Output only. Workload Identity settings.

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.

Returns
Type Description
string

setClusterCaCertificate

Output only. PEM encoded x509 certificate of the cluster root of trust.

Parameter
Name Description
var string
Returns
Type Description
$this

getFleet

Required. Fleet configuration.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\Fleet|null

hasFleet

clearFleet

setFleet

Required. Fleet configuration.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\Fleet
Returns
Type Description
$this

getManagedResources

Output only. Managed Azure resources for this cluster.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\AzureClusterResources|null

hasManagedResources

clearManagedResources

setManagedResources

Output only. Managed Azure resources for this cluster.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\AzureClusterResources
Returns
Type Description
$this

getLoggingConfig

Optional. Logging configuration for this cluster.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\LoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Optional. Logging configuration for this cluster.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\LoggingConfig
Returns
Type Description
$this

getErrors

Output only. A set of errors found in the cluster.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setErrors

Output only. A set of errors found in the cluster.

Parameter
Name Description
var array<Google\Cloud\GkeMultiCloud\V1\AzureClusterError>
Returns
Type Description
$this

getMonitoringConfig

Optional. Monitoring configuration for this cluster.

Returns
Type Description
Google\Cloud\GkeMultiCloud\V1\MonitoringConfig|null

hasMonitoringConfig

clearMonitoringConfig

setMonitoringConfig

Optional. Monitoring configuration for this cluster.

Parameter
Name Description
var Google\Cloud\GkeMultiCloud\V1\MonitoringConfig
Returns
Type Description
$this