agent_pools

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

Overview

Name	agent_pools
Type	Resource
Id	azure.container_registry.agent_pools

Fields

The following fields are returned by SELECT queries:

get

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties associated with the agent pool
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

list

The request was successful; the request was well-formed and received properly.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
location	string	The location of the resource. This cannot be changed after the resource is created.
properties	object	The properties associated with the agent pool
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, registryName, agentPoolName		Gets the detailed information for a given agent pool.
list	select	subscriptionId, resourceGroupName, registryName		Lists all the agent pools for a specified container registry.
create	insert	subscriptionId, resourceGroupName, registryName, agentPoolName		Creates an agent pool for a container registry with the specified parameters.
update	update	subscriptionId, resourceGroupName, registryName, agentPoolName		Updates an agent pool with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, registryName, agentPoolName		Deletes a specified agent pool resource.

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 agent pool.
registryName	string	The name of the container registry.
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

Gets the detailed information for a given agent pool.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.container_registry.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
AND agentPoolName = '{{ agentPoolName }}' -- required
;

list

Lists all the agent pools for a specified container registry.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.container_registry.agent_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND registryName = '{{ registryName }}' -- required
;

INSERT examples

create

Creates an agent pool for a container registry with the specified parameters.

INSERT INTO azure.container_registry.agent_pools (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
registryName,
agentPoolName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ registryName }}',
'{{ agentPoolName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

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: registryName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: agentPoolName
      value: string
      description: Required parameter for the agent_pools resource.
    - name: location
      value: string
      description: |
        The location of the resource. This cannot be changed after the resource is created.
    - name: tags
      value: object
      description: |
        The tags of the resource.
    - name: properties
      value: object
      description: |
        The properties associated with the agent pool

UPDATE examples

update

Updates an agent pool with the specified parameters.

UPDATE azure.container_registry.agent_pools
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND registryName = '{{ registryName }}' --required
AND agentPoolName = '{{ agentPoolName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a specified agent pool resource.

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