agent_pools

Creates, updates, deletes, gets or lists an agent_pools resource.

Overview

Name	`agent_pools`
Type	Resource
Id	`azure_extras.network_cloud.agent_pools`

Fields

The following fields are returned by SELECT queries:

get
list_by_kubernetes_cluster

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`administratorConfiguration`	`object`	The administrator credentials to be used for the nodes in this agent pool.
`agentOptions`	`object`	The configurations that will be applied to each agent in this agent pool.
`attachedNetworkConfiguration`	`object`	The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
`availabilityZones`	`array`	The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
`count`	`integer`	The number of virtual machines that use this configuration. Required.
`detailedStatus`	`string`	The current status of the agent pool. Known values are: "Available", "Error", and "Provisioning". (Available, Error, Provisioning)
`detailedStatusMessage`	`string`	The descriptive message about the current detailed status.
`etag`	`string`	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
`extendedLocation`	`object`	:vartype extended_location: ~azure.mgmt.networkcloud.models.ExtendedLocation
`kubernetesVersion`	`string`	The Kubernetes version running in this agent pool.
`labels`	`array`	The labels applied to the nodes in this agent pool.
`location`	`string`	The geo-location where the resource lives. Required.
`mode`	`string`	The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. Required. Known values are: "System", "User", and "NotApplicable". (System, User, NotApplicable)
`provisioningState`	`string`	The provisioning state of the agent pool. Known values are: "Accepted", "Canceled", "Deleting", "Failed", "InProgress", "Succeeded", and "Updating". (Accepted, Canceled, Deleting, Failed, InProgress, Succeeded, Updating)
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`taints`	`array`	The taints applied to the nodes in this agent pool.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`upgradeSettings`	`object`	The configuration of the agent pool.
`vmSkuName`	`string`	The name of the VM SKU that determines the size of resources allocated for node VMs. Required.

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`administratorConfiguration`	`object`	The administrator credentials to be used for the nodes in this agent pool.
`agentOptions`	`object`	The configurations that will be applied to each agent in this agent pool.
`attachedNetworkConfiguration`	`object`	The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
`availabilityZones`	`array`	The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
`count`	`integer`	The number of virtual machines that use this configuration. Required.
`detailedStatus`	`string`	The current status of the agent pool. Known values are: "Available", "Error", and "Provisioning". (Available, Error, Provisioning)
`detailedStatusMessage`	`string`	The descriptive message about the current detailed status.
`etag`	`string`	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
`extendedLocation`	`object`	:vartype extended_location: ~azure.mgmt.networkcloud.models.ExtendedLocation
`kubernetesVersion`	`string`	The Kubernetes version running in this agent pool.
`labels`	`array`	The labels applied to the nodes in this agent pool.
`location`	`string`	The geo-location where the resource lives. Required.
`mode`	`string`	The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. Required. Known values are: "System", "User", and "NotApplicable". (System, User, NotApplicable)
`provisioningState`	`string`	The provisioning state of the agent pool. Known values are: "Accepted", "Canceled", "Deleting", "Failed", "InProgress", "Succeeded", and "Updating". (Accepted, Canceled, Deleting, Failed, InProgress, Succeeded, Updating)
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Resource tags.
`taints`	`array`	The taints applied to the nodes in this agent pool.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`upgradeSettings`	`object`	The configuration of the agent pool.
`vmSkuName`	`string`	The name of the VM SKU that determines the size of resources allocated for node VMs. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`resource_group_name`, `kubernetes_cluster_name`, `agent_pool_name`, `subscription_id`		Get properties of the provided Kubernetes cluster agent pool.
`list_by_kubernetes_cluster`	`select`	`resource_group_name`, `kubernetes_cluster_name`, `subscription_id`	`$top`, `$skipToken`	Get a list of agent pools for the provided Kubernetes cluster.
`create_or_update`	`insert`	`resource_group_name`, `kubernetes_cluster_name`, `agent_pool_name`, `subscription_id`, `location`, `properties`		Create a new Kubernetes cluster agent pool or update the properties of the existing one.
`update`	`update`	`resource_group_name`, `kubernetes_cluster_name`, `agent_pool_name`, `subscription_id`		Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.
`create_or_update`	`replace`	`resource_group_name`, `kubernetes_cluster_name`, `agent_pool_name`, `subscription_id`, `location`, `properties`		Create a new Kubernetes cluster agent pool or update the properties of the existing one.
`delete`	`delete`	`resource_group_name`, `kubernetes_cluster_name`, `agent_pool_name`, `subscription_id`		Delete the provided Kubernetes cluster agent pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`agent_pool_name`	`string`	The name of the Kubernetes cluster agent pool. Required.
`kubernetes_cluster_name`	`string`	The name of the Kubernetes cluster. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`subscription_id`	`string`
`$skipToken`	`string`	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
`$top`	`integer`	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

`SELECT` examples

get
list_by_kubernetes_cluster

Get properties of the provided Kubernetes cluster agent pool.

SELECT
id,
name,
administratorConfiguration,
agentOptions,
attachedNetworkConfiguration,
availabilityZones,
count,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
kubernetesVersion,
labels,
location,
mode,
provisioningState,
systemData,
tags,
taints,
type,
upgradeSettings,
vmSkuName
FROM azure_extras.network_cloud.agent_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' -- required
AND agent_pool_name = '{{ agent_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Get a list of agent pools for the provided Kubernetes cluster.

SELECT
id,
name,
administratorConfiguration,
agentOptions,
attachedNetworkConfiguration,
availabilityZones,
count,
detailedStatus,
detailedStatusMessage,
etag,
extendedLocation,
kubernetesVersion,
labels,
location,
mode,
provisioningState,
systemData,
tags,
taints,
type,
upgradeSettings,
vmSkuName
FROM azure_extras.network_cloud.agent_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

`INSERT` examples

create_or_update
Manifest

Create a new Kubernetes cluster agent pool or update the properties of the existing one.

INSERT INTO azure_extras.network_cloud.agent_pools (
tags,
location,
properties,
extendedLocation,
resource_group_name,
kubernetes_cluster_name,
agent_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ kubernetes_cluster_name }}',
'{{ agent_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: agent_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the agent_pools resource.
  - name: kubernetes_cluster_name
    value: "{{ kubernetes_cluster_name }}"
    description: Required parameter for the agent_pools resource.
  - name: agent_pool_name
    value: "{{ agent_pool_name }}"
    description: Required parameter for the agent_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the agent_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The list of the resource properties. Required.
    value:
      administratorConfiguration:
        adminUsername: "{{ adminUsername }}"
        sshPublicKeys:
          - keyData: "{{ keyData }}"
      agentOptions:
        hugepagesCount: {{ hugepagesCount }}
        hugepagesSize: "{{ hugepagesSize }}"
      attachedNetworkConfiguration:
        l2Networks:
          - networkId: "{{ networkId }}"
            pluginType: "{{ pluginType }}"
        l3Networks:
          - ipamEnabled: "{{ ipamEnabled }}"
            networkId: "{{ networkId }}"
            pluginType: "{{ pluginType }}"
        trunkedNetworks:
          - networkId: "{{ networkId }}"
            pluginType: "{{ pluginType }}"
      availabilityZones:
        - "{{ availabilityZones }}"
      count: {{ count }}
      labels:
        - key: "{{ key }}"
          value: "{{ value }}"
      mode: "{{ mode }}"
      taints:
        - key: "{{ key }}"
          value: "{{ value }}"
      upgradeSettings:
        drainTimeout: {{ drainTimeout }}
        maxSurge: "{{ maxSurge }}"
        maxUnavailable: "{{ maxUnavailable }}"
      vmSkuName: "{{ vmSkuName }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      kubernetesVersion: "{{ kubernetesVersion }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      :vartype extended_location: ~azure.mgmt.networkcloud.models.ExtendedLocation
    value:
      name: "{{ name }}"
      type: "{{ type }}"

`UPDATE` examples

update

Patch the properties of the provided Kubernetes cluster agent pool, or update the tags associated with the Kubernetes cluster agent pool. Properties and tag updates can be done independently.

UPDATE azure_extras.network_cloud.agent_pools
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

`REPLACE` examples

create_or_update

Create a new Kubernetes cluster agent pool or update the properties of the existing one.

REPLACE azure_extras.network_cloud.agent_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

`DELETE` examples

delete

Delete the provided Kubernetes cluster agent pool.

DELETE FROM azure_extras.network_cloud.agent_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND kubernetes_cluster_name = '{{ kubernetes_cluster_name }}' --required
AND agent_pool_name = '{{ agent_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​