REST Resource: projects.locations.azureClusters.azureNodePools

Resource: AzureNodePool

An Anthos node pool running on Azure.

JSON representation 
{
  "name": string,
  "version": string,
  "config": {
    object (AzureNodeConfig)
  },
  "subnetId": string,
  "autoscaling": {
    object (AzureNodePoolAutoscaling)
  },
  "state": enum (State),
  "uid": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "annotations": {
    string: string,
    ...
  },
  "maxPodsConstraint": {
    object (MaxPodsConstraint)
  },
  "azureAvailabilityZone": string,
  "errors": [
    {
      object (AzureNodePoolError)
    }
  ],
  "management": {
    object (AzureNodeManagement)
  }
}
Fields
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

object (AzureNodeConfig)

Required. The node configuration of the node pool.
subnetId

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

object (AzureNodePoolAutoscaling)

Required. Autoscaler configuration for this node pool.
state

enum (State)

Output only. The current state of the node pool.
uid

string

Output only. A globally unique identifier for the node pool.
reconciling

boolean

Output only. If set, there are currently pending changes to the node pool.
createTime

string (Timestamp format)

Output only. The time at which this node pool was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time at which this node pool was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
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

map (key: string, value: string)

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
maxPodsConstraint

object (MaxPodsConstraint)

Required. The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
azureAvailabilityZone

string

Optional. The Azure availability zone of the nodes in this nodepool.

When unspecified, it defaults to 1.
errors[]

object (AzureNodePoolError)

Output only. A set of errors found in the node pool.
management

object (AzureNodeManagement)

Optional. The Management configuration for this node pool.

AzureNodeConfig

Parameters that describe the configuration of all node machines on a given node pool.

JSON representation 
{
  "vmSize": string,
  "rootVolume": {
    object (AzureDiskTemplate)
  },
  "tags": {
    string: string,
    ...
  },
  "imageType": string,
  "sshConfig": {
    object (AzureSshConfig)
  },
  "proxyConfig": {
    object (AzureProxyConfig)
  },
  "configEncryption": {
    object (AzureConfigEncryption)
  },
  "taints": [
    {
      object (NodeTaint)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Fields
vmSize

string

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

See Supported VM sizes for options.

When unspecified, it defaults to Standard_DS2_v2.
rootVolume

object (AzureDiskTemplate)

Optional. Configuration related to the root volume provisioned for each node pool machine.

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

map (key: string, value: string)

Optional. A set of tags to apply to all underlying Azure resources for this node pool. This currently only includes Virtual Machine Scale Sets.

Specify at most 50 pairs containing alphanumerics, spaces, and symbols (.+-=_:@/). Keys can be up to 127 Unicode characters. Values can be up to 255 Unicode characters.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
imageType

string

Optional. The OS image type to use on node pool instances. Can be unspecified, or have a value of ubuntu.

When unspecified, it defaults to ubuntu.
sshConfig

object (AzureSshConfig)

Required. SSH configuration for how to access the node pool machines.
proxyConfig

object (AzureProxyConfig)

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

object (AzureConfigEncryption)

Optional. Configuration related to vm config encryption.
taints[]

object (NodeTaint)

Optional. The initial taints assigned to nodes of this node pool.
labels

map (key: string, value: string)

Optional. The initial labels assigned to nodes of this node pool. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

AzureNodePoolAutoscaling

Configuration related to Kubernetes cluster autoscaler.

The Kubernetes cluster autoscaler will automatically adjust the size of the node pool based on the cluster load.

JSON representation 
{
  "minNodeCount": integer,
  "maxNodeCount": integer
}
Fields
minNodeCount

integer

Required. Minimum number of nodes in the node pool. Must be greater than or equal to 1 and less than or equal to maxNodeCount.
maxNodeCount

integer

Required. Maximum number of nodes in the node pool. Must be greater than or equal to minNodeCount and less than or equal to 50.

State

The lifecycle state of the node pool.

Enums
STATE_UNSPECIFIED Not set.
PROVISIONING The PROVISIONING state indicates the node pool is being created.
RUNNING The RUNNING state indicates the node pool has been created and is fully usable.
RECONCILING The RECONCILING state indicates that the node pool is being reconciled.
STOPPING The STOPPING state indicates the node pool is being deleted.
ERROR The ERROR state indicates the node pool is in a broken unrecoverable state.
DEGRADED The DEGRADED state indicates the node pool requires user action to restore full functionality.

AzureNodePoolError

AzureNodePoolError describes errors found on Azure node pools.

JSON representation 
{
  "message": string
}
Fields
message

string

Human-friendly description of the error.

AzureNodeManagement

AzureNodeManagement defines the set of node management features turned on for an Azure node pool.

JSON representation 
{
  "autoRepair": boolean
}
Fields
autoRepair

boolean

Optional. Whether or not the nodes will be automatically repaired. When set to true, the nodes in this node pool will be monitored and if they fail health checks consistently over a period of time, an automatic repair action will be triggered to replace them with new nodes.

Methods

create

 Creates a new AzureNodePool, attached to a given AzureCluster.

delete

 Deletes a specific AzureNodePool resource.

get

 Describes a specific AzureNodePool resource.

list

 Lists all AzureNodePool resources on a given AzureCluster.

patch

 Updates an AzureNodePool.