Google Anthos Multi Cloud V1 Client - Class AzureControlPlane (1.1.1)

Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AzureControlPlane.

AzureControlPlane represents the control plane configurations.

Generated from protobuf message google.cloud.gkemulticloud.v1.AzureControlPlane

Namespace

Google \ Cloud \ GkeMultiCloud \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ version string

Required. The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000). You can list all supported versions on a given Google Cloud region by calling GetAzureServerConfig.
↳ subnet_id string

Optional. The ARM ID of the default subnet for the control plane. The control plane VMs are deployed in this subnet, unless AzureControlPlane.replica_placements is specified. This subnet will also be used as default for AzureControlPlane.endpoint_subnet_id if AzureControlPlane.endpoint_subnet_id is not specified. Similarly it will be used as default for AzureClusterNetworking.service_load_balancer_subnet_id. Example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default.
↳ vm_size string

Optional. The Azure VM size name. Example: Standard_DS2_v2. For available VM sizes, see https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions. When unspecified, it defaults to Standard_DS2_v2.
↳ ssh_config AzureSshConfig

Required. SSH configuration for how to access the underlying control plane machines.
↳ root_volume AzureDiskTemplate

Optional. Configuration related to the root volume provisioned for each control plane replica. When unspecified, it defaults to 32-GiB Azure Disk.
↳ main_volume AzureDiskTemplate

Optional. Configuration related to the main volume provisioned for each control plane replica. The main volume is in charge of storing all of the cluster's etcd state. When unspecified, it defaults to a 8-GiB Azure Disk.
↳ database_encryption AzureDatabaseEncryption

Optional. Configuration related to application-layer secrets encryption.
↳ proxy_config AzureProxyConfig

Optional. Proxy configuration for outbound HTTP(S) traffic.
↳ config_encryption AzureConfigEncryption

Optional. Configuration related to vm config encryption.
↳ tags array|Google\Protobuf\Internal\MapField

Optional. A set of tags to apply to all underlying control plane Azure resources.
↳ replica_placements array<ReplicaPlacement>

Optional. Configuration for where to place the control plane replicas. Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.
↳ endpoint_subnet_id string

Optional. The ARM ID of the subnet where the control plane load balancer is deployed. When unspecified, it defaults to AzureControlPlane.subnet_id. Example: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123"

getVersion

Required. The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAzureServerConfig.

Returns
Type Description
string

setVersion

Required. The Kubernetes version to run on control plane replicas (e.g. 1.19.10-gke.1000).

You can list all supported versions on a given Google Cloud region by calling GetAzureServerConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

getSubnetId

Optional. The ARM ID of the default subnet for the control plane. The control plane VMs are deployed in this subnet, unless AzureControlPlane.replica_placements is specified. This subnet will also be used as default for AzureControlPlane.endpoint_subnet_id if AzureControlPlane.endpoint_subnet_id is not specified. Similarly it will be used as default for AzureClusterNetworking.service_load_balancer_subnet_id.

Example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default.

Returns
Type Description
string

setSubnetId

Optional. The ARM ID of the default subnet for the control plane. The control plane VMs are deployed in this subnet, unless AzureControlPlane.replica_placements is specified. This subnet will also be used as default for AzureControlPlane.endpoint_subnet_id if AzureControlPlane.endpoint_subnet_id is not specified. Similarly it will be used as default for AzureClusterNetworking.service_load_balancer_subnet_id.

Example: /subscriptions/<subscription-id>/resourceGroups/<resource-group-id>/providers/Microsoft.Network/virtualNetworks/<vnet-id>/subnets/default.

Parameter
Name Description
var string
Returns
Type Description
$this

getVmSize

Optional. The Azure VM size name. Example: Standard_DS2_v2.

For available VM sizes, see https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions. When unspecified, it defaults to Standard_DS2_v2.

Returns
Type Description
string

setVmSize

Optional. The Azure VM size name. Example: Standard_DS2_v2.

For available VM sizes, see https://docs.microsoft.com/en-us/azure/virtual-machines/vm-naming-conventions. When unspecified, it defaults to Standard_DS2_v2.

Parameter
Name Description
var string
Returns
Type Description
$this

getSshConfig

Required. SSH configuration for how to access the underlying control plane machines.

Returns
Type Description
AzureSshConfig|null

hasSshConfig

clearSshConfig

setSshConfig

Required. SSH configuration for how to access the underlying control plane machines.

Parameter
Name Description
var AzureSshConfig
Returns
Type Description
$this

getRootVolume

Optional. Configuration related to the root volume provisioned for each control plane replica.

When unspecified, it defaults to 32-GiB Azure Disk.

Returns
Type Description
AzureDiskTemplate|null

hasRootVolume

clearRootVolume

setRootVolume

Optional. Configuration related to the root volume provisioned for each control plane replica.

When unspecified, it defaults to 32-GiB Azure Disk.

Parameter
Name Description
var AzureDiskTemplate
Returns
Type Description
$this

getMainVolume

Optional. Configuration related to the main volume provisioned for each control plane replica.

The main volume is in charge of storing all of the cluster's etcd state. When unspecified, it defaults to a 8-GiB Azure Disk.

Returns
Type Description
AzureDiskTemplate|null

hasMainVolume

clearMainVolume

setMainVolume

Optional. Configuration related to the main volume provisioned for each control plane replica.

The main volume is in charge of storing all of the cluster's etcd state. When unspecified, it defaults to a 8-GiB Azure Disk.

Parameter
Name Description
var AzureDiskTemplate
Returns
Type Description
$this

getDatabaseEncryption

Optional. Configuration related to application-layer secrets encryption.

Returns
Type Description
AzureDatabaseEncryption|null

hasDatabaseEncryption

clearDatabaseEncryption

setDatabaseEncryption

Optional. Configuration related to application-layer secrets encryption.

Parameter
Name Description
var AzureDatabaseEncryption
Returns
Type Description
$this

getProxyConfig

Optional. Proxy configuration for outbound HTTP(S) traffic.

Returns
Type Description
AzureProxyConfig|null

hasProxyConfig

clearProxyConfig

setProxyConfig

Optional. Proxy configuration for outbound HTTP(S) traffic.

Parameter
Name Description
var AzureProxyConfig
Returns
Type Description
$this

getConfigEncryption

Optional. Configuration related to vm config encryption.

Returns
Type Description
AzureConfigEncryption|null

hasConfigEncryption

clearConfigEncryption

setConfigEncryption

Optional. Configuration related to vm config encryption.

Parameter
Name Description
var AzureConfigEncryption
Returns
Type Description
$this

getTags

Optional. A set of tags to apply to all underlying control plane Azure resources.

Returns
Type Description
Google\Protobuf\Internal\MapField

setTags

Optional. A set of tags to apply to all underlying control plane Azure resources.

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

getReplicaPlacements

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setReplicaPlacements

Optional. Configuration for where to place the control plane replicas.

Up to three replica placement instances can be specified. If replica_placements is set, the replica placement instances will be applied to the three control plane replicas as evenly as possible.

Parameter
Name Description
var array<ReplicaPlacement>
Returns
Type Description
$this

getEndpointSubnetId

Optional. The ARM ID of the subnet where the control plane load balancer is deployed. When unspecified, it defaults to AzureControlPlane.subnet_id.

Example: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123"

Returns
Type Description
string

setEndpointSubnetId

Optional. The ARM ID of the subnet where the control plane load balancer is deployed. When unspecified, it defaults to AzureControlPlane.subnet_id.

Example: "/subscriptions/d00494d6-6f3c-4280-bbb2-899e163d1d30/resourceGroups/anthos_cluster_gkeust4/providers/Microsoft.Network/virtualNetworks/gke-vnet-gkeust4/subnets/subnetid123"

Parameter
Name Description
var string
Returns
Type Description
$this