namespace_devices

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

Overview

Name	namespace_devices
Type	Resource
Id	azure.device_registry.namespace_devices

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.
attributes	object	A set of key-value pairs that contain custom attributes set by the customer.
discoveredDeviceRef	string	Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided.
enabled	boolean	Indicates if the resource is enabled or not.
endpoints	object	Property bag containing the device's unassigned and assigned endpoints.
etag	string	Resource Tag.
extendedLocation	object	The extended location.
externalDeviceId	string	The Device ID provided by the customer.
lastTransitionTime	string (date-time)	A timestamp (in UTC) that is updated each time the resource is modified.
location	string	The geo-location where the resource lives. Required.
manufacturer	string	Device manufacturer.
model	string	Device model.
operatingSystem	string	Device operating system.
operatingSystemVersion	string	Device operating system version.
policy	object	Policy used to issue device certificates.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
status	object	Device status updates.
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".
uuid	string	A unique identifier for the device.
version	integer	An integer that is incremented each time the resource is modified.

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.
attributes	object	A set of key-value pairs that contain custom attributes set by the customer.
discoveredDeviceRef	string	Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided.
enabled	boolean	Indicates if the resource is enabled or not.
endpoints	object	Property bag containing the device's unassigned and assigned endpoints.
etag	string	Resource Tag.
extendedLocation	object	The extended location.
externalDeviceId	string	The Device ID provided by the customer.
lastTransitionTime	string (date-time)	A timestamp (in UTC) that is updated each time the resource is modified.
location	string	The geo-location where the resource lives. Required.
manufacturer	string	Device manufacturer.
model	string	Device model.
operatingSystem	string	Device operating system.
operatingSystemVersion	string	Device operating system version.
policy	object	Policy used to issue device certificates.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
status	object	Device status updates.
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".
uuid	string	A unique identifier for the device.
version	integer	An integer that is incremented each time the resource is modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, device_name, subscription_id		Get a NamespaceDevice.
list_by_resource_group	select	resource_group_name, namespace_name, subscription_id		List NamespaceDevice resources by Namespace.
create_or_replace	insert	resource_group_name, namespace_name, device_name, subscription_id, location		Create a NamespaceDevice.
update	update	resource_group_name, namespace_name, device_name, subscription_id		Update a NamespaceDevice.
create_or_replace	replace	resource_group_name, namespace_name, device_name, subscription_id, location		Create a NamespaceDevice.
delete	delete	resource_group_name, namespace_name, device_name, subscription_id		Delete a NamespaceDevice.
revoke	exec	resource_group_name, namespace_name, device_name, subscription_id		A long-running resource action.

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_name	string	The name of the device. Required.
namespace_name	string	The name of the namespace. 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 NamespaceDevice.

SELECT
id,
name,
attributes,
discoveredDeviceRef,
enabled,
endpoints,
etag,
extendedLocation,
externalDeviceId,
lastTransitionTime,
location,
manufacturer,
model,
operatingSystem,
operatingSystemVersion,
policy,
provisioningState,
status,
systemData,
tags,
type,
uuid,
version
FROM azure.device_registry.namespace_devices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND device_name = '{{ device_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List NamespaceDevice resources by Namespace.

SELECT
id,
name,
attributes,
discoveredDeviceRef,
enabled,
endpoints,
etag,
extendedLocation,
externalDeviceId,
lastTransitionTime,
location,
manufacturer,
model,
operatingSystem,
operatingSystemVersion,
policy,
provisioningState,
status,
systemData,
tags,
type,
uuid,
version
FROM azure.device_registry.namespace_devices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_replace

Create a NamespaceDevice.

INSERT INTO azure.device_registry.namespace_devices (
tags,
location,
properties,
extendedLocation,
resource_group_name,
namespace_name,
device_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ device_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: namespace_devices
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the namespace_devices resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the namespace_devices resource.
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the namespace_devices resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the namespace_devices 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:
      uuid: "{{ uuid }}"
      enabled: {{ enabled }}
      externalDeviceId: "{{ externalDeviceId }}"
      discoveredDeviceRef: "{{ discoveredDeviceRef }}"
      manufacturer: "{{ manufacturer }}"
      model: "{{ model }}"
      operatingSystem: "{{ operatingSystem }}"
      operatingSystemVersion: "{{ operatingSystemVersion }}"
      endpoints:
        inbound: "{{ inbound }}"
        outbound:
          assigned: "{{ assigned }}"
          unassigned: "{{ unassigned }}"
      attributes: "{{ attributes }}"
      status:
        config:
          version: {{ version }}
          lastTransitionTime: "{{ lastTransitionTime }}"
          error:
            code: "{{ code }}"
            message: "{{ message }}"
            details:
              - code: "{{ code }}"
                message: "{{ message }}"
                info: "{{ info }}"
                correlationId: "{{ correlationId }}"
        endpoints:
          inbound: "{{ inbound }}"
      version: {{ version }}
      lastTransitionTime: "{{ lastTransitionTime }}"
      provisioningState: "{{ provisioningState }}"
      policy:
        resourceId: "{{ resourceId }}"
  - name: extendedLocation
    description: |
      The extended location.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Update a NamespaceDevice.

UPDATE azure.device_registry.namespace_devices
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND device_name = '{{ device_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_replace

Create a NamespaceDevice.

REPLACE azure.device_registry.namespace_devices
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND device_name = '{{ device_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a NamespaceDevice.

DELETE FROM azure.device_registry.namespace_devices
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND device_name = '{{ device_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

revoke

A long-running resource action.

EXEC azure.device_registry.namespace_devices.revoke 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@device_name='{{ device_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"disable": {{ disable }}
}'
;