instances

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

Overview

Name	instances
Type	Resource
Id	azure.device_update.instances

Fields

The following fields are returned by SELECT queries:

get

Instance details.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Device Update instance properties.
tags	object	Resource tags.

list_by_account

List of Instances.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Device Update instance 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, instanceName		Returns instance details for the given instance and account name.
list_by_account	select	resourceGroupName, subscriptionId, accountName		Returns instances for the given account name.
create	insert	resourceGroupName, subscriptionId, accountName, instanceName, data__properties		Creates or updates instance.
update	update	resourceGroupName, subscriptionId, accountName, instanceName		Updates instance's tags.
delete	delete	resourceGroupName, subscriptionId, accountName, instanceName		Deletes instance.

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.
instanceName	string	Instance 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 instance details for the given instance and account name.

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

list_by_account

Returns instances for the given account name.

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

INSERT examples

create

Creates or updates instance.

INSERT INTO azure.device_update.instances (
data__tags,
data__location,
data__properties,
resourceGroupName,
subscriptionId,
accountName,
instanceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ accountName }}',
'{{ instanceName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the instances resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the instances resource.
    - name: accountName
      value: string
      description: Required parameter for the instances resource.
    - name: instanceName
      value: string
      description: Required parameter for the instances 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 instance properties.

UPDATE examples

update

Updates instance's tags.

UPDATE azure.device_update.instances
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND accountName = '{{ accountName }}' --required
AND instanceName = '{{ instanceName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes instance.

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