pools

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

Overview

Name	pools
Type	Resource
Id	azure.dev_center.pools

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

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

list_by_project

OK. The request has succeeded.

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a machine pool
list_by_project	select			Lists pools for a project
create_or_update	insert			Creates or updates a machine pool
update	update			Partially updates a machine pool
delete	delete			Deletes a machine pool
run_health_checks	exec	subscriptionId, resourceGroupName, projectName, poolName		Triggers a refresh of the pool status.

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
poolName	string	Name of the pool.
projectName	string	The name of the project.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a machine pool

SELECT
location,
properties,
tags
FROM azure.dev_center.pools
;

list_by_project

Lists pools for a project

SELECT
location,
properties,
tags
FROM azure.dev_center.pools
;

INSERT examples

create_or_update

Creates or updates a machine pool

INSERT INTO azure.dev_center.pools (
data__tags,
data__location,
data__properties
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: pools
  props:
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Pool properties

UPDATE examples

update

Partially updates a machine pool

UPDATE azure.dev_center.pools
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a machine pool

DELETE FROM azure.dev_center.pools
;

Lifecycle Methods

run_health_checks

Triggers a refresh of the pool status.

EXEC azure.dev_center.pools.run_health_checks 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@projectName='{{ projectName }}' --required, 
@poolName='{{ poolName }}' --required
;