pools

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

Overview

Name	pools
Type	Resource
Id	azure.dev_center.pools

Fields

vw_pools

Name	Datatype	Description
dev_box_count	text	field from the properties object
dev_box_definition	text	field from the properties object
dev_box_definition_name	text	field from the properties object
dev_box_definition_type	text	field from the properties object
display_name	text	field from the properties object
health_status	text	field from the properties object
health_status_details	text	field from the properties object
license_type	text	field from the properties object
local_administrator	text	field from the properties object
location	text	The geo-location where the resource lives
managed_virtual_network_regions	text	field from the properties object
network_connection_name	text	field from the properties object
poolName	text	field from the properties object
projectName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
single_sign_on_status	text	field from the properties object
stop_on_disconnect	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
virtual_network_type	text	field from the properties object

pools

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

Methods

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

SELECT examples

Lists pools for a project

vw_pools

SELECT
dev_box_count,
dev_box_definition,
dev_box_definition_name,
dev_box_definition_type,
display_name,
health_status,
health_status_details,
license_type,
local_administrator,
location,
managed_virtual_network_regions,
network_connection_name,
poolName,
projectName,
provisioning_state,
resourceGroupName,
single_sign_on_status,
stop_on_disconnect,
subscriptionId,
tags,
virtual_network_type
FROM azure.dev_center.vw_pools
WHERE projectName = '{{ projectName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

pools

SELECT
location,
properties,
tags
FROM azure.dev_center.pools
WHERE projectName = '{{ projectName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new pools resource.

All Properties

/*+ create */
INSERT INTO azure.dev_center.pools (
poolName,
projectName,
resourceGroupName,
subscriptionId,
tags,
location,
properties
)
SELECT 
'{{ poolName }}',
'{{ projectName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: devBoxDefinitionType
          value: []
        - name: devBoxDefinitionName
          value: string
        - name: devBoxDefinition
          value:
            - name: imageReference
              value:
                - name: id
                  value: string
                - name: exactVersion
                  value: string
            - name: sku
              value:
                - name: name
                  value: string
                - name: tier
                  value: []
                - name: size
                  value: string
                - name: family
                  value: string
                - name: capacity
                  value: integer
        - name: networkConnectionName
          value: string
        - name: licenseType
          value: []
        - name: localAdministrator
          value: []
        - name: stopOnDisconnect
          value:
            - name: status
              value: []
            - name: gracePeriodMinutes
              value: integer
        - name: singleSignOnStatus
          value: []
        - name: displayName
          value: string
        - name: virtualNetworkType
          value: []
        - name: managedVirtualNetworkRegions
          value:
            - string
        - name: healthStatus
          value: []
        - name: healthStatusDetails
          value:
            - - name: code
                value: string
              - name: message
                value: string
        - name: devBoxCount
          value: integer
        - name: provisioningState
          value: []

UPDATE example

Updates a pools resource.

/*+ update */
UPDATE azure.dev_center.pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
poolName = '{{ poolName }}'
AND projectName = '{{ projectName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified pools resource.

/*+ delete */
DELETE FROM azure.dev_center.pools
WHERE poolName = '{{ poolName }}'
AND projectName = '{{ projectName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';