agent_pools

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

Overview

Name	agent_pools
Type	Resource
Id	azure.nexus.agent_pools

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: AgentPoolProperties represents the properties of the Kubernetes cluster agent pool.)
tags	object	Resource tags.

list_by_kubernetes_cluster

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: AgentPoolProperties represents the properties of the Kubernetes cluster agent pool.)
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, kubernetesClusterName, agentPoolName		Get properties of the provided Kubernetes cluster agent pool.
list_by_kubernetes_cluster	select	subscriptionId, resourceGroupName, kubernetesClusterName		Get a list of agent pools for the provided Kubernetes cluster.
create_or_update	insert	subscriptionId, resourceGroupName, kubernetesClusterName, agentPoolName, data__properties		Create a new Kubernetes cluster agent pool or update the properties of the existing one.
update	update	subscriptionId, resourceGroupName, kubernetesClusterName, agentPoolName		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.
delete	delete	subscriptionId, resourceGroupName, kubernetesClusterName, agentPoolName		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
agentPoolName	string	The name of the Kubernetes cluster agent pool.
kubernetesClusterName	string	The name of the Kubernetes cluster.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get properties of the provided Kubernetes cluster agent pool.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' -- required
AND agentPoolName = '{{ agentPoolName }}' -- required
;

list_by_kubernetes_cluster

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

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.nexus.agent_pools (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
kubernetesClusterName,
agentPoolName
)
SELECT 
'{{ extendedLocation }}',
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ kubernetesClusterName }}',
'{{ agentPoolName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: agent_pools
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the agent_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: kubernetesClusterName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: agentPoolName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

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.nexus.agent_pools
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' --required
AND agentPoolName = '{{ agentPoolName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the provided Kubernetes cluster agent pool.

DELETE FROM azure.nexus.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND kubernetesClusterName = '{{ kubernetesClusterName }}' --required
AND agentPoolName = '{{ agentPoolName }}' --required
;