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
Methods
__construct
Constructor.
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
Google\Cloud\GkeMultiCloud\V1\AzureSshConfig
Required. SSH configuration for how to access the underlying control plane machines.
↳ root_volume
Google\Cloud\GkeMultiCloud\V1\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
Google\Cloud\GkeMultiCloud\V1\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
Google\Cloud\GkeMultiCloud\V1\AzureDatabaseEncryption
Optional. Configuration related to application-layer secrets encryption.
↳ proxy_config
Google\Cloud\GkeMultiCloud\V1\AzureProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
↳ config_encryption
Google\Cloud\GkeMultiCloud\V1\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< Google\Cloud\GkeMultiCloud\V1\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 .
Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED];
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 .
Generated from protobuf field string version = 1 [(.google.api.field_behavior) = REQUIRED];
var
string
$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
.
Generated from protobuf field string subnet_id = 2 [(.google.api.field_behavior) = OPTIONAL];
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
.
Generated from protobuf field string subnet_id = 2 [(.google.api.field_behavior) = OPTIONAL];
var
string
$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
.
Generated from protobuf field string vm_size = 3 [(.google.api.field_behavior) = OPTIONAL];
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
.
Generated from protobuf field string vm_size = 3 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
getSshConfig
Required. SSH configuration for how to access the underlying control plane machines.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureSshConfig ssh_config = 11 [(.google.api.field_behavior) = REQUIRED];
hasSshConfig
clearSshConfig
setSshConfig
Required. SSH configuration for how to access the underlying control plane machines.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureSshConfig ssh_config = 11 [(.google.api.field_behavior) = REQUIRED];
$this
getRootVolume
Optional. Configuration related to the root volume provisioned for each control plane replica.
When unspecified, it defaults to 32-GiB Azure Disk.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureDiskTemplate root_volume = 4 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureDiskTemplate root_volume = 4 [(.google.api.field_behavior) = OPTIONAL];
$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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureDiskTemplate main_volume = 5 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureDiskTemplate main_volume = 5 [(.google.api.field_behavior) = OPTIONAL];
$this
getDatabaseEncryption
Optional. Configuration related to application-layer secrets encryption.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = OPTIONAL];
hasDatabaseEncryption
clearDatabaseEncryption
setDatabaseEncryption
Optional. Configuration related to application-layer secrets encryption.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureDatabaseEncryption database_encryption = 10 [(.google.api.field_behavior) = OPTIONAL];
$this
getProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];
hasProxyConfig
clearProxyConfig
setProxyConfig
Optional. Proxy configuration for outbound HTTP(S) traffic.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureProxyConfig proxy_config = 12 [(.google.api.field_behavior) = OPTIONAL];
$this
getConfigEncryption
Optional. Configuration related to vm config encryption.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureConfigEncryption config_encryption = 14 [(.google.api.field_behavior) = OPTIONAL];
hasConfigEncryption
clearConfigEncryption
setConfigEncryption
Optional. Configuration related to vm config encryption.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureConfigEncryption config_encryption = 14 [(.google.api.field_behavior) = OPTIONAL];
$this
getTags
Optional. A set of tags to apply to all underlying control plane Azure resources.
Generated from protobuf field map<string, string> tags = 7 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\MapField
setTags
Optional. A set of tags to apply to all underlying control plane Azure resources.
Generated from protobuf field map<string, string> tags = 7 [(.google.api.field_behavior) = OPTIONAL];
var
array|Google\Protobuf\Internal\MapField
$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.
Generated from protobuf field repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];
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.
Generated from protobuf field repeated .google.cloud.gkemulticloud.v1.ReplicaPlacement replica_placements = 13 [(.google.api.field_behavior) = OPTIONAL];
$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"
Generated from protobuf field string endpoint_subnet_id = 15 [(.google.api.field_behavior) = OPTIONAL];
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"
Generated from protobuf field string endpoint_subnet_id = 15 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this
