accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure.device_update.accounts

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.
encryption	object	CMK encryption at rest properties.
hostName	string	API host name.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
locations	array	Device Update account primary and failover location details.
privateEndpointConnections	array	List of private endpoint connections associated with the account.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Deleted", "Failed", "Canceled", "Accepted", and "Creating".
publicNetworkAccess	string	Whether or not public network access is allowed for the account. Known values are: "Enabled" and "Disabled".
sku	string	Device Update Sku. Known values are: "Free" and "Standard".
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.
encryption	object	CMK encryption at rest properties.
hostName	string	API host name.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
locations	array	Device Update account primary and failover location details.
privateEndpointConnections	array	List of private endpoint connections associated with the account.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Deleted", "Failed", "Canceled", "Accepted", and "Creating".
publicNetworkAccess	string	Whether or not public network access is allowed for the account. Known values are: "Enabled" and "Disabled".
sku	string	Device Update Sku. Known values are: "Free" and "Standard".
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.
encryption	object	CMK encryption at rest properties.
hostName	string	API host name.
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives. Required.
locations	array	Device Update account primary and failover location details.
privateEndpointConnections	array	List of private endpoint connections associated with the account.
provisioningState	string	Provisioning state. Known values are: "Succeeded", "Deleted", "Failed", "Canceled", "Accepted", and "Creating".
publicNetworkAccess	string	Whether or not public network access is allowed for the account. Known values are: "Enabled" and "Disabled".
sku	string	Device Update Sku. Known values are: "Free" and "Standard".
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, account_name, subscription_id		Returns account details for the given account name.
list_by_resource_group	select	resource_group_name, subscription_id		Returns list of Accounts.
list_by_subscription	select	subscription_id		Returns list of Accounts.
create	insert	resource_group_name, account_name, subscription_id, location		Creates or updates Account.
update	update	resource_group_name, account_name, subscription_id		Updates account's patchable properties.
delete	delete	resource_group_name, account_name, subscription_id		Deletes account.
head	exec	resource_group_name, account_name, subscription_id		Checks whether account exists.

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
account_name	string	Account name. Required.
resource_group_name	string	The resource group name. Required.
subscription_id	string

SELECT examples

get

Returns account details for the given account name.

SELECT
id,
name,
encryption,
hostName,
identity,
location,
locations,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.device_update.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Returns list of Accounts.

SELECT
id,
name,
encryption,
hostName,
identity,
location,
locations,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.device_update.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Returns list of Accounts.

SELECT
id,
name,
encryption,
hostName,
identity,
location,
locations,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type
FROM azure.device_update.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or updates Account.

INSERT INTO azure.device_update.accounts (
tags,
location,
identity,
properties,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the accounts resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The type of identity used for the resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            groupIds:
              - "{{ groupIds }}"
            provisioningState: "{{ provisioningState }}"
      sku: "{{ sku }}"
      encryption:
        keyVaultKeyUri: "{{ keyVaultKeyUri }}"
        userAssignedIdentity: "{{ userAssignedIdentity }}"

UPDATE examples

update

Updates account's patchable properties.

UPDATE azure.device_update.accounts
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes account.

DELETE FROM azure.device_update.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

head

Checks whether account exists.

EXEC azure.device_update.accounts.head 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;