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

Account details.

Name	Datatype	Description
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives
properties	object	Device Update account properties.
tags	object	Resource tags.

list_by_resource_group

List of Accounts.

Name	Datatype	Description
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives
properties	object	Device Update account properties.
tags	object	Resource tags.

list_by_subscription

List of Accounts.

Name	Datatype	Description
identity	object	The type of identity used for the resource.
location	string	The geo-location where the resource lives
properties	object	Device Update account properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, subscriptionId, accountName		Returns account details for the given account name.
list_by_resource_group	select	resourceGroupName, subscriptionId		Returns list of Accounts.
list_by_subscription	select	subscriptionId		Returns list of Accounts.
create	insert	resourceGroupName, subscriptionId, accountName		Creates or updates Account.
update	update	resourceGroupName, subscriptionId, accountName		Updates account's patchable properties
delete	delete	resourceGroupName, subscriptionId, accountName		Deletes account.

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	Account name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns account details for the given account name.

SELECT
identity,
location,
properties,
tags
FROM azure.device_update.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list_by_resource_group

Returns list of Accounts.

SELECT
identity,
location,
properties,
tags
FROM azure.device_update.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Returns list of Accounts.

SELECT
identity,
location,
properties,
tags
FROM azure.device_update.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates or updates Account.

INSERT INTO azure.device_update.accounts (
data__tags,
data__location,
data__properties,
data__identity,
resourceGroupName,
subscriptionId,
accountName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ accountName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the accounts resource.
    - name: accountName
      value: string
      description: Required parameter for the accounts resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Device Update account properties.
    - name: identity
      value: object
      description: |
        The type of identity used for the resource.

UPDATE examples

update

Updates account's patchable properties

UPDATE azure.device_update.accounts
SET 
data__identity = '{{ identity }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes account.

DELETE FROM azure.device_update.accounts
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND accountName = '{{ accountName }}' --required
;