pools

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

Overview

Name	pools
Type	Resource
Id	azure.devcenter.pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
devBoxCount	integer	Indicates the number of provisioned Dev Boxes in this pool.
devBoxDefinitionName	string	Name of a Dev Box definition in parent Project of this Pool.
displayName	string	The display name of the pool.
healthStatus	string	Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. Known values are: "Unknown", "Pending", "Healthy", "Warning", and "Unhealthy".
healthStatusDetails	array	Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state.
licenseType	string	Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. "Windows_Client"
localAdministrator	string	Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. Known values are: "Disabled" and "Enabled".
location	string	The geo-location where the resource lives. Required.
managedVirtualNetworkRegions	array	The regions of the managed virtual network (required when managedNetworkType is Managed).
networkConnectionName	string	Name of a Network Connection in parent Project of this Pool.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
singleSignOnStatus	string	Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant. Known values are: "Disabled" and "Enabled".
stopOnDisconnect	object	Stop on disconnect configuration settings for Dev Boxes created in this pool.
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".
virtualNetworkType	string	Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. Known values are: "Managed" and "Unmanaged".

list_by_project

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
devBoxCount	integer	Indicates the number of provisioned Dev Boxes in this pool.
devBoxDefinitionName	string	Name of a Dev Box definition in parent Project of this Pool.
displayName	string	The display name of the pool.
healthStatus	string	Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes. Known values are: "Unknown", "Pending", "Healthy", "Warning", and "Unhealthy".
healthStatusDetails	array	Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state.
licenseType	string	Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created. "Windows_Client"
localAdministrator	string	Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box. Known values are: "Disabled" and "Enabled".
location	string	The geo-location where the resource lives. Required.
managedVirtualNetworkRegions	array	The regions of the managed virtual network (required when managedNetworkType is Managed).
networkConnectionName	string	Name of a Network Connection in parent Project of this Pool.
provisioningState	string	The provisioning state of the resource. Known values are: "NotSpecified", "Accepted", "Running", "Creating", "Created", "Updating", "Updated", "Deleting", "Deleted", "Succeeded", "Failed", "Canceled", "MovingResources", "TransientFailure", "RolloutInProgress", and "StorageProvisioningFailed".
singleSignOnStatus	string	Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant. Known values are: "Disabled" and "Enabled".
stopOnDisconnect	object	Stop on disconnect configuration settings for Dev Boxes created in this pool.
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".
virtualNetworkType	string	Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network. Known values are: "Managed" and "Unmanaged".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, pool_name, subscription_id		Gets a machine pool.
list_by_project	select	resource_group_name, project_name, subscription_id	$top	Lists pools for a project.
create_or_update	insert	resource_group_name, project_name, pool_name, subscription_id, location		Creates or updates a machine pool.
update	update	resource_group_name, project_name, pool_name, subscription_id		Partially updates a machine pool.
create_or_update	replace	resource_group_name, project_name, pool_name, subscription_id, location		Creates or updates a machine pool.
delete	delete	resource_group_name, project_name, pool_name, subscription_id		Deletes a machine pool.
run_health_checks	exec	resource_group_name, project_name, pool_name, subscription_id		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
pool_name	string	Name of the pool. Required.
project_name	string	The name of the project. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Gets a machine pool.

SELECT
id,
name,
devBoxCount,
devBoxDefinitionName,
displayName,
healthStatus,
healthStatusDetails,
licenseType,
localAdministrator,
location,
managedVirtualNetworkRegions,
networkConnectionName,
provisioningState,
singleSignOnStatus,
stopOnDisconnect,
systemData,
tags,
type,
virtualNetworkType
FROM azure.devcenter.pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_project

Lists pools for a project.

SELECT
id,
name,
devBoxCount,
devBoxDefinitionName,
displayName,
healthStatus,
healthStatusDetails,
licenseType,
localAdministrator,
location,
managedVirtualNetworkRegions,
networkConnectionName,
provisioningState,
singleSignOnStatus,
stopOnDisconnect,
systemData,
tags,
type,
virtualNetworkType
FROM azure.devcenter.pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates a machine pool.

INSERT INTO azure.devcenter.pools (
tags,
location,
properties,
resource_group_name,
project_name,
pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
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: project_name
    value: "{{ project_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
    value:
      devBoxDefinitionName: "{{ devBoxDefinitionName }}"
      networkConnectionName: "{{ networkConnectionName }}"
      licenseType: "{{ licenseType }}"
      localAdministrator: "{{ localAdministrator }}"
      stopOnDisconnect:
        status: "{{ status }}"
        gracePeriodMinutes: {{ gracePeriodMinutes }}
      singleSignOnStatus: "{{ singleSignOnStatus }}"
      displayName: "{{ displayName }}"
      virtualNetworkType: "{{ virtualNetworkType }}"
      managedVirtualNetworkRegions:
        - "{{ managedVirtualNetworkRegions }}"

UPDATE examples

update

Partially updates a machine pool.

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

REPLACE examples

create_or_update

Creates or updates a machine pool.

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

DELETE examples

delete

Deletes a machine pool.

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

Lifecycle Methods

run_health_checks

Triggers a refresh of the pool status.

EXEC azure.devcenter.pools.run_health_checks 
@resource_group_name='{{ resource_group_name }}' --required, 
@project_name='{{ project_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;