pools

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

Overview

Name	pools
Type	Resource
Id	azure.batch.pools

Fields

The following fields are returned by SELECT queries:

get

The operation was successful. The response contains the pool entity.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
identity	object	The type of identity used for the Batch Pool. (title: The type of identity used for the Batch Pool.)
properties	object	The properties associated with the pool.
tags	object	The tags of the resource.
type	string	The type of the resource.

list_by_batch_account

The operation was successful. The response contains a list of certificates associated with the account.

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
etag	string	The ETag of the resource, used for concurrency statements.
identity	object	The type of identity used for the Batch Pool. (title: The type of identity used for the Batch Pool.)
properties	object	The properties associated with the pool.
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	resourceGroupName, accountName, poolName, subscriptionId		Gets information about the specified pool.
list_by_batch_account	select	resourceGroupName, accountName, subscriptionId	maxresults, $select, $filter	Lists all of the pools in the specified account.
create	insert	resourceGroupName, accountName, poolName, subscriptionId	If-Match, If-None-Match	Creates a new pool inside the specified account.
update	update	resourceGroupName, accountName, poolName, subscriptionId	If-Match	Updates the properties of an existing pool.
delete	delete	resourceGroupName, accountName, poolName, subscriptionId		Deletes the specified pool.
disable_auto_scale	exec	resourceGroupName, accountName, poolName, subscriptionId		Disables automatic scaling for a pool.
stop_resize	exec	resourceGroupName, accountName, poolName, subscriptionId		This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

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
accountName	string	The name of the Batch account.
poolName	string	The pool name. This must be unique within the account.
resourceGroupName	string	The name of the resource group that contains the Batch account.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
$filter	string	OData filter expression. Valid properties for filtering are: name properties/allocationState properties/allocationStateTransitionTime properties/creationTime properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale properties/scaleSettings/fixedScale
$select	string	Comma separated list of properties that should be returned. e.g. "properties/provisioningState". Only top level properties under properties/ are valid for selection.
If-Match	string	The entity state (ETag) version of the pool to update. This value can be omitted or set to "*" to apply the operation unconditionally.
If-None-Match	string	Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.
maxresults	integer (int32)	The maximum number of items to return in the response.

SELECT examples

get

Gets information about the specified pool.

SELECT
id,
name,
etag,
identity,
properties,
tags,
type
FROM azure.batch.pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_batch_account

Lists all of the pools in the specified account.

SELECT
id,
name,
etag,
identity,
properties,
tags,
type
FROM azure.batch.pools
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND maxresults = '{{ maxresults }}'
AND $select = '{{ $select }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a new pool inside the specified account.

INSERT INTO azure.batch.pools (
data__properties,
data__identity,
data__tags,
resourceGroupName,
accountName,
poolName,
subscriptionId,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ poolName }}',
'{{ subscriptionId }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
id,
name,
etag,
identity,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: pools
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the pools resource.
    - name: accountName
      value: string
      description: Required parameter for the pools resource.
    - name: poolName
      value: string
      description: Required parameter for the pools resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the pools resource.
    - name: properties
      value: object
      description: |
        The properties associated with the pool.
    - name: identity
      value: object
      description: |
        The type of identity used for the Batch Pool.
    - name: tags
      value: object
      description: |
        The tags of the resource.
    - name: If-Match
      value: string
      description: The entity state (ETag) version of the pool to update. A value of "*" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored.

UPDATE examples

update

Updates the properties of an existing pool.

UPDATE azure.batch.pools
SET 
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
identity,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified pool.

DELETE FROM azure.batch.pools
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

disable_auto_scale

Disables automatic scaling for a pool.

EXEC azure.batch.pools.disable_auto_scale 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

stop_resize

This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

EXEC azure.batch.pools.stop_resize 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;