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
Namespace
Google \ Cloud \ GkeMultiCloud \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of this resource. Node pool names are formatted as |
↳ version |
string
Required. The Kubernetes version (e.g. |
↳ config |
AzureNodeConfig
Required. The node configuration of the node pool. |
↳ 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 |
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 |
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 |
↳ errors |
array<AzureNodePoolError>
Output only. A set of errors found in the node pool. |
↳ management |
AzureNodeManagement
Optional. The Management configuration for this node pool. |
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
| Returns | |
|---|---|
| Type | Description |
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVersion
Required. The Kubernetes version (e.g. 1.19.10-gke.1000) running on this
node pool.
| Returns | |
|---|---|
| Type | Description |
string |
|
setVersion
Required. The Kubernetes version (e.g. 1.19.10-gke.1000) running on this
node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConfig
Required. The node configuration of the node pool.
| Returns | |
|---|---|
| Type | Description |
AzureNodeConfig|null |
|
hasConfig
clearConfig
setConfig
Required. The node configuration of the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
AzureNodeConfig
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutoscaling
Required. Autoscaler configuration for this node pool.
| Returns | |
|---|---|
| Type | Description |
AzureNodePoolAutoscaling|null |
|
hasAutoscaling
clearAutoscaling
setAutoscaling
Required. Autoscaler configuration for this node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
AzureNodePoolAutoscaling
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the node pool.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. The current state of the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUid
Output only. A globally unique identifier for the node pool.
| Returns | |
|---|---|
| Type | Description |
string |
|
setUid
Output only. A globally unique identifier for the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReconciling
Output only. If set, there are currently pending changes to the node pool.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReconciling
Output only. If set, there are currently pending changes to the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time at which this node pool was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time at which this node pool was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The time at which this node pool was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time at which this node pool 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 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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
| Returns | |
|---|---|
| Type | Description |
MaxPodsConstraint|null |
|
hasMaxPodsConstraint
clearMaxPodsConstraint
setMaxPodsConstraint
Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
MaxPodsConstraint
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAzureAvailabilityZone
Optional. The Azure availability zone of the nodes in this nodepool.
When unspecified, it defaults to 1.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAzureAvailabilityZone
Optional. The Azure availability zone of the nodes in this nodepool.
When unspecified, it defaults to 1.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrors
Output only. A set of errors found in the node pool.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setErrors
Output only. A set of errors found in the node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AzureNodePoolError>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getManagement
Optional. The Management configuration for this node pool.
| Returns | |
|---|---|
| Type | Description |
AzureNodeManagement|null |
|
hasManagement
clearManagement
setManagement
Optional. The Management configuration for this node pool.
| Parameter | |
|---|---|
| Name | Description |
var |
AzureNodeManagement
|
| Returns | |
|---|---|
| Type | Description |
$this |
|