Reference documentation and code samples for the Google Anthos Multi Cloud V1 Client class AzureNodePool.
An Anthos node pool running on Azure.
Generated from protobuf message google.cloud.gkemulticloud.v1.AzureNodePool
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The name of this resource. Node pool names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>
. For more details on Google Cloud resource names, see Resource Names
↳ version
string
Required. The Kubernetes version (e.g. 1.19.10-gke.1000
) running on this node pool.
↳ config
↳ subnet_id
string
Required. The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.
↳ autoscaling
Google\Cloud\GkeMultiCloud\V1\AzureNodePoolAutoscaling
Required. Autoscaler configuration for this node pool.
↳ state
int
Output only. The current state of the node pool.
↳ uid
string
Output only. A globally unique identifier for the node pool.
↳ reconciling
bool
Output only. If set, there are currently pending changes to the node pool.
↳ create_time
Google\Protobuf\Timestamp
Output only. The time at which this node pool was created.
↳ update_time
Google\Protobuf\Timestamp
Output only. The time at which this node pool 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 node pool. 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.
↳ max_pods_constraint
Google\Cloud\GkeMultiCloud\V1\MaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
↳ azure_availability_zone
string
Optional. The Azure availability zone of the nodes in this nodepool. When unspecified, it defaults to 1
.
getName
The name of this resource.
Node pool names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>
.
For more details on Google Cloud resource names,
see Resource Names
Generated from protobuf field string name = 1;
string
setName
The name of this resource.
Node pool names are formatted as projects/<project-number>/locations/<region>/azureClusters/<cluster-id>/azureNodePools/<node-pool-id>
.
For more details on Google Cloud resource names,
see Resource Names
Generated from protobuf field string name = 1;
var
string
$this
getVersion
Required. The Kubernetes version (e.g. 1.19.10-gke.1000
) running on this node pool.
Generated from protobuf field string version = 2 [(.google.api.field_behavior) = REQUIRED];
string
setVersion
Required. The Kubernetes version (e.g. 1.19.10-gke.1000
) running on this node pool.
Generated from protobuf field string version = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getConfig
Required. The node configuration of the node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureNodeConfig config = 22 [(.google.api.field_behavior) = REQUIRED];
hasConfig
clearConfig
setConfig
Required. The node configuration of the node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureNodeConfig config = 22 [(.google.api.field_behavior) = REQUIRED];
$this
getSubnetId
Required. The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.
Generated from protobuf field string subnet_id = 3 [(.google.api.field_behavior) = REQUIRED];
string
setSubnetId
Required. The ARM ID of the subnet where the node pool VMs run. Make sure it's a subnet under the virtual network in the cluster configuration.
Generated from protobuf field string subnet_id = 3 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getAutoscaling
Required. Autoscaler configuration for this node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureNodePoolAutoscaling autoscaling = 4 [(.google.api.field_behavior) = REQUIRED];
hasAutoscaling
clearAutoscaling
setAutoscaling
Required. Autoscaler configuration for this node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureNodePoolAutoscaling autoscaling = 4 [(.google.api.field_behavior) = REQUIRED];
$this
getState
Output only. The current state of the node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureNodePool.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setState
Output only. The current state of the node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.AzureNodePool.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
getUid
Output only. A globally unique identifier for the node pool.
Generated from protobuf field string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setUid
Output only. A globally unique identifier for the node pool.
Generated from protobuf field string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$this
getReconciling
Output only. If set, there are currently pending changes to the node pool.
Generated from protobuf field bool reconciling = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
bool
setReconciling
Output only. If set, there are currently pending changes to the node pool.
Generated from protobuf field bool reconciling = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
bool
$this
getCreateTime
Output only. The time at which this node pool was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this node pool was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getUpdateTime
Output only. The time at which this node pool was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this node pool was last updated.
Generated from protobuf field .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$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 = 12;
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 = 12;
var
string
$this
getAnnotations
Optional. Annotations on the node pool.
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
Google\Protobuf\Internal\MapField
setAnnotations
Optional. Annotations on the node pool.
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 = 13 [(.google.api.field_behavior) = OPTIONAL];
var
array|Google\Protobuf\Internal\MapField
$this
getMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 21 [(.google.api.field_behavior) = REQUIRED];
hasMaxPodsConstraint
clearMaxPodsConstraint
setMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
Generated from protobuf field .google.cloud.gkemulticloud.v1.MaxPodsConstraint max_pods_constraint = 21 [(.google.api.field_behavior) = REQUIRED];
$this
getAzureAvailabilityZone
Optional. The Azure availability zone of the nodes in this nodepool.
When unspecified, it defaults to 1
.
Generated from protobuf field string azure_availability_zone = 23 [(.google.api.field_behavior) = OPTIONAL];
string
setAzureAvailabilityZone
Optional. The Azure availability zone of the nodes in this nodepool.
When unspecified, it defaults to 1
.
Generated from protobuf field string azure_availability_zone = 23 [(.google.api.field_behavior) = OPTIONAL];
var
string
$this