agent_pools

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

Overview

Name	agent_pools
Type	Resource
Id	azure.hybrid_aks.agent_pools

Fields

The following fields are returned by SELECT queries:

get

Gets the agentPool resource.

Name	Datatype	Description
extendedLocation	object	Extended location pointing to the underlying infrastructure
properties	object	Properties of the agent pool resource
tags	object	Resource tags

list_by_provisioned_cluster

Gets the list of agentPools in the provisionedClusterInstances resource.

Name	Datatype	Description
extendedLocation	object	Extended location pointing to the underlying infrastructure
properties	object	Properties of the agent pool resource
tags	object	Resource tags

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	connectedClusterResourceUri, agentPoolName		Gets the specified agent pool in the provisioned cluster
list_by_provisioned_cluster	select	connectedClusterResourceUri		Gets the list of agent pools in the specified provisioned cluster
create_or_update	insert	connectedClusterResourceUri, agentPoolName		Creates or updates the agent pool in the provisioned cluster
delete	delete	connectedClusterResourceUri, agentPoolName		Deletes the specified agent pool in the provisioned cluster

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	Parameter for the name of the agent pool in the provisioned cluster.
connectedClusterResourceUri	string	The fully qualified Azure Resource Manager identifier of the connected cluster resource.

SELECT examples

get

Gets the specified agent pool in the provisioned cluster

SELECT
extendedLocation,
properties,
tags
FROM azure.hybrid_aks.agent_pools
WHERE connectedClusterResourceUri = '{{ connectedClusterResourceUri }}' -- required
AND agentPoolName = '{{ agentPoolName }}' -- required
;

list_by_provisioned_cluster

Gets the list of agent pools in the specified provisioned cluster

SELECT
extendedLocation,
properties,
tags
FROM azure.hybrid_aks.agent_pools
WHERE connectedClusterResourceUri = '{{ connectedClusterResourceUri }}' -- required
;

INSERT examples

create_or_update

Creates or updates the agent pool in the provisioned cluster

INSERT INTO azure.hybrid_aks.agent_pools (
data__properties,
data__tags,
data__extendedLocation,
connectedClusterResourceUri,
agentPoolName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ extendedLocation }}',
'{{ connectedClusterResourceUri }}',
'{{ agentPoolName }}'
RETURNING
extendedLocation,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: agent_pools
  props:
    - name: connectedClusterResourceUri
      value: string
      description: Required parameter for the agent_pools resource.
    - name: agentPoolName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: properties
      value: object
      description: |
        Properties of the agent pool resource
    - name: tags
      value: object
      description: |
        Resource tags
    - name: extendedLocation
      value: object
      description: |
        Extended location pointing to the underlying infrastructure

DELETE examples

delete

Deletes the specified agent pool in the provisioned cluster

DELETE FROM azure.hybrid_aks.agent_pools
WHERE connectedClusterResourceUri = '{{ connectedClusterResourceUri }}' --required
AND agentPoolName = '{{ agentPoolName }}' --required
;