device_pools

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

Overview

Name	device_pools
Type	Resource
Id	azure_stack.azure_stack_hci.device_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}.
name	string	The name of the resource.
cloudId	string	Unique, immutable resource id.
customLocationName	string	Custom Location Name for the pool, default: -CL.
customLocationResourceId	string	Custom Location Resource Id for the pool.
devices	array	List of machines in device pool.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroup	string	Managed resource group name for the pool.
operationDetails	array	operation status details for device pool.
provisioningState	string	The provisioning state of a resource. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
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}.
name	string	The name of the resource.
cloudId	string	Unique, immutable resource id.
customLocationName	string	Custom Location Name for the pool, default: -CL.
customLocationResourceId	string	Custom Location Resource Id for the pool.
devices	array	List of machines in device pool.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroup	string	Managed resource group name for the pool.
operationDetails	array	operation status details for device pool.
provisioningState	string	The provisioning state of a resource. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
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}.
name	string	The name of the resource.
cloudId	string	Unique, immutable resource id.
customLocationName	string	Custom Location Name for the pool, default: -CL.
customLocationResourceId	string	Custom Location Resource Id for the pool.
devices	array	List of machines in device pool.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
managedResourceGroup	string	Managed resource group name for the pool.
operationDetails	array	operation status details for device pool.
provisioningState	string	The provisioning state of a resource. Known values are: "NotSpecified", "Error", "Succeeded", "Failed", "Canceled", "Connected", "Disconnected", "Deleted", "Creating", "Updating", "Deleting", "Moving", "PartiallySucceeded", "PartiallyConnected", "InProgress", "Accepted", "Provisioning", and "DisableInProgress". (NotSpecified, Error, Succeeded, Failed, Canceled, Connected, Disconnected, Deleted, Creating, Updating, Deleting, Moving, PartiallySucceeded, PartiallyConnected, InProgress, Accepted, Provisioning, DisableInProgress)
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, device_pool_name, subscription_id		Get a DevicePool.
list_by_resource_group	select	resource_group_name, subscription_id		List all device pools in a resource group.
list_by_subscription	select	subscription_id		List all device pools in a subscription.
create_or_update	insert	resource_group_name, device_pool_name, subscription_id, location		Create a DevicePool.
update	update	resource_group_name, device_pool_name, subscription_id		Update a devicePool.
create_or_update	replace	resource_group_name, device_pool_name, subscription_id, location		Create a DevicePool.
delete	delete	resource_group_name, device_pool_name, subscription_id		Delete a DevicePool.
claim_devices	exec	resource_group_name, device_pool_name, subscription_id, devices		Claiming devices of the pool.
release_devices	exec	resource_group_name, device_pool_name, subscription_id, devices		Releasing devices of the 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
device_pool_name	string	The name of the DevicePool. 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 DevicePool.

SELECT
id,
name,
cloudId,
customLocationName,
customLocationResourceId,
devices,
identity,
location,
managedResourceGroup,
operationDetails,
provisioningState,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci.device_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND device_pool_name = '{{ device_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all device pools in a resource group.

SELECT
id,
name,
cloudId,
customLocationName,
customLocationResourceId,
devices,
identity,
location,
managedResourceGroup,
operationDetails,
provisioningState,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci.device_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all device pools in a subscription.

SELECT
id,
name,
cloudId,
customLocationName,
customLocationResourceId,
devices,
identity,
location,
managedResourceGroup,
operationDetails,
provisioningState,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci.device_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a DevicePool.

INSERT INTO azure_stack.azure_stack_hci.device_pools (
tags,
location,
properties,
identity,
resource_group_name,
device_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ device_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: device_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the device_pools resource.
  - name: device_pool_name
    value: "{{ device_pool_name }}"
    description: Required parameter for the device_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the device_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 }}"
      cloudId: "{{ cloudId }}"
      devices:
        - deviceResourceId: "{{ deviceResourceId }}"
          claimedBy: "{{ claimedBy }}"
      customLocationResourceId: "{{ customLocationResourceId }}"
      customLocationName: "{{ customLocationName }}"
      managedResourceGroup: "{{ managedResourceGroup }}"
      operationDetails:
        - name: "{{ name }}"
          id: "{{ id }}"
          type: "{{ type }}"
          resourceId: "{{ resourceId }}"
          description: "{{ description }}"
          status: "{{ status }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                target: "{{ target }}"
                details: "{{ details }}"
                additionalInfo: "{{ additionalInfo }}"
            additionalInfo:
              - type: "{{ type }}"
                info: "{{ info }}"
  - 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 devicePool.

UPDATE azure_stack.azure_stack_hci.device_pools
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND device_pool_name = '{{ device_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 DevicePool.

REPLACE azure_stack.azure_stack_hci.device_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND device_pool_name = '{{ device_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 DevicePool.

DELETE FROM azure_stack.azure_stack_hci.device_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND device_pool_name = '{{ device_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

claim_devices

Claiming devices of the pool.

EXEC azure_stack.azure_stack_hci.device_pools.claim_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_pool_name='{{ device_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"devices": "{{ devices }}", 
"claimedBy": "{{ claimedBy }}"
}'
;

release_devices

Releasing devices of the pool.

EXEC azure_stack.azure_stack_hci.device_pools.release_devices 
@resource_group_name='{{ resource_group_name }}' --required, 
@device_pool_name='{{ device_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"devices": "{{ devices }}"
}'
;