agent_pools

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

Overview

Name	agent_pools
Type	Resource
Id	azure.nexus.agent_pools

Fields

vw_agent_pools

Name	Datatype	Description
administrator_configuration	text	field from the properties object
agentPoolName	text	field from the properties object
agent_options	text	field from the properties object
attached_network_configuration	text	field from the properties object
availability_zones	text	field from the properties object
count	text	field from the properties object
detailed_status	text	field from the properties object
detailed_status_message	text	field from the properties object
extended_location	text	field from the properties object
kubernetesClusterName	text	field from the properties object
kubernetes_version	text	field from the properties object
labels	text	field from the properties object
location	text	The geo-location where the resource lives
mode	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
taints	text	field from the properties object
upgrade_settings	text	field from the properties object
vm_sku_name	text	field from the properties object

agent_pools

Name	Datatype	Description
extendedLocation	object
location	string	The geo-location where the resource lives
properties	object
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	agentPoolName, kubernetesClusterName, resourceGroupName, subscriptionId	Get properties of the provided Kubernetes cluster agent pool.
list_by_kubernetes_cluster	SELECT	kubernetesClusterName, resourceGroupName, subscriptionId	Get a list of agent pools for the provided Kubernetes cluster.
create_or_update	INSERT	agentPoolName, kubernetesClusterName, resourceGroupName, subscriptionId, data__properties	Create a new Kubernetes cluster agent pool or update the properties of the existing one.
delete	DELETE	agentPoolName, kubernetesClusterName, resourceGroupName, subscriptionId	Delete the provided Kubernetes cluster agent pool.
update	UPDATE	agentPoolName, kubernetesClusterName, resourceGroupName, subscriptionId	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.

SELECT examples

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

vw_agent_pools

SELECT
administrator_configuration,
agentPoolName,
agent_options,
attached_network_configuration,
availability_zones,
count,
detailed_status,
detailed_status_message,
extended_location,
kubernetesClusterName,
kubernetes_version,
labels,
location,
mode,
provisioning_state,
resourceGroupName,
subscriptionId,
tags,
taints,
upgrade_settings,
vm_sku_name
FROM azure.nexus.vw_agent_pools
WHERE kubernetesClusterName = '{{ kubernetesClusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

agent_pools

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

INSERT example

Use the following StackQL query and manifest file to create a new agent_pools resource.

All Properties

/*+ create */
INSERT INTO azure.nexus.agent_pools (
agentPoolName,
kubernetesClusterName,
resourceGroupName,
subscriptionId,
data__properties,
extendedLocation,
properties,
tags,
location
)
SELECT 
'{{ agentPoolName }}',
'{{ kubernetesClusterName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: string
    - name: properties
      value:
        - name: administratorConfiguration
          value:
            - name: adminUsername
              value: string
            - name: sshPublicKeys
              value:
                - - name: keyData
                    value: string
        - name: agentOptions
          value:
            - name: hugepagesCount
              value: integer
            - name: hugepagesSize
              value: string
        - name: attachedNetworkConfiguration
          value:
            - name: l2Networks
              value:
                - - name: networkId
                    value: string
                  - name: pluginType
                    value: string
            - name: l3Networks
              value:
                - - name: ipamEnabled
                    value: string
                  - name: networkId
                    value: string
                  - name: pluginType
                    value: string
            - name: trunkedNetworks
              value:
                - - name: networkId
                    value: string
                  - name: pluginType
                    value: string
        - name: availabilityZones
          value:
            - string
        - name: count
          value: integer
        - name: detailedStatus
          value: string
        - name: detailedStatusMessage
          value: string
        - name: kubernetesVersion
          value: string
        - name: labels
          value:
            - - name: key
                value: string
              - name: value
                value: string
        - name: mode
          value: string
        - name: provisioningState
          value: string
        - name: taints
          value:
            - - name: key
                value: string
              - name: value
                value: string
        - name: upgradeSettings
          value:
            - name: drainTimeout
              value: integer
            - name: maxSurge
              value: string
            - name: maxUnavailable
              value: string
        - name: vmSkuName
          value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a agent_pools resource.

/*+ update */
UPDATE azure.nexus.agent_pools
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
agentPoolName = '{{ agentPoolName }}'
AND kubernetesClusterName = '{{ kubernetesClusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified agent_pools resource.

/*+ delete */
DELETE FROM azure.nexus.agent_pools
WHERE agentPoolName = '{{ agentPoolName }}'
AND kubernetesClusterName = '{{ kubernetesClusterName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';