pools

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

Overview

Name	pools
Type	Resource
Id	azure.devops_infrastructure.pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
agentProfile	object	Defines how the machine will be handled once it executed a job. Required.
devCenterProjectResourceId	string	The resource id of the DevCenter Project the pool belongs to. Required.
fabricProfile	object	Defines the type of fabric the agent will run on. Required.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
maximumConcurrency	integer	Defines how many resources can there be created at any given time. Required.
organizationProfile	object	Defines the organization in which the pool will be used. Required.
provisioningState	string	The status of the current operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
agentProfile	object	Defines how the machine will be handled once it executed a job. Required.
devCenterProjectResourceId	string	The resource id of the DevCenter Project the pool belongs to. Required.
fabricProfile	object	Defines the type of fabric the agent will run on. Required.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
maximumConcurrency	integer	Defines how many resources can there be created at any given time. Required.
organizationProfile	object	Defines the organization in which the pool will be used. Required.
provisioningState	string	The status of the current operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
agentProfile	object	Defines how the machine will be handled once it executed a job. Required.
devCenterProjectResourceId	string	The resource id of the DevCenter Project the pool belongs to. Required.
fabricProfile	object	Defines the type of fabric the agent will run on. Required.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
maximumConcurrency	integer	Defines how many resources can there be created at any given time. Required.
organizationProfile	object	Defines the organization in which the pool will be used. Required.
provisioningState	string	The status of the current operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, pool_name, subscription_id		Get a Pool.
list_by_resource_group	select	resource_group_name, subscription_id		List Pool resources by resource group.
list_by_subscription	select	subscription_id		List Pool resources by subscription ID.
create_or_update	insert	resource_group_name, pool_name, subscription_id, location		Create a Pool.
update	update	resource_group_name, pool_name, subscription_id		Update a Pool.
create_or_update	replace	resource_group_name, pool_name, subscription_id, location		Create a Pool.
delete	delete	resource_group_name, pool_name, subscription_id		Delete a 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
pool_name	string	Name of the pool. It needs to be globally unique. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Pool.

SELECT
id,
name,
agentProfile,
devCenterProjectResourceId,
fabricProfile,
identity,
location,
maximumConcurrency,
organizationProfile,
provisioningState,
systemData,
tags,
type
FROM azure.devops_infrastructure.pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List Pool resources by resource group.

SELECT
id,
name,
agentProfile,
devCenterProjectResourceId,
fabricProfile,
identity,
location,
maximumConcurrency,
organizationProfile,
provisioningState,
systemData,
tags,
type
FROM azure.devops_infrastructure.pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Pool resources by subscription ID.

SELECT
id,
name,
agentProfile,
devCenterProjectResourceId,
fabricProfile,
identity,
location,
maximumConcurrency,
organizationProfile,
provisioningState,
systemData,
tags,
type
FROM azure.devops_infrastructure.pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a Pool.

INSERT INTO azure.devops_infrastructure.pools (
tags,
location,
properties,
identity,
resource_group_name,
pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the pools resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the 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 resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      maximumConcurrency: {{ maximumConcurrency }}
      organizationProfile:
        kind: "{{ kind }}"
      agentProfile:
        kind: "{{ kind }}"
        resourcePredictions: "{{ resourcePredictions }}"
        resourcePredictionsProfile:
          kind: "{{ kind }}"
      fabricProfile:
        kind: "{{ kind }}"
      devCenterProjectResourceId: "{{ devCenterProjectResourceId }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a Pool.

UPDATE azure.devops_infrastructure.pools
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a Pool.

REPLACE azure.devops_infrastructure.pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Pool.

DELETE FROM azure.devops_infrastructure.pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;