namespace_discovered_devices

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

Overview

Name	namespace_discovered_devices
Type	Resource
Id	azure.device_registry.namespace_discovered_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.
discoveryId	string	Identifier used to detect changes in the discovered device. Required.
endpoints	object	Endpoints for discovered devices.
extendedLocation	object	The extended location. Required.
externalDeviceId	string	A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant.
location	string	The geo-location where the resource lives. Required.
manufacturer	string	Device manufacturer.
model	string	Device model.
operatingSystem	string	Device operating system name.
operatingSystemVersion	string	Device operating system version.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
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".
version	integer	An integer that is incremented each time the resource is modified. Required.

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.
discoveryId	string	Identifier used to detect changes in the discovered device. Required.
endpoints	object	Endpoints for discovered devices.
extendedLocation	object	The extended location. Required.
externalDeviceId	string	A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant.
location	string	The geo-location where the resource lives. Required.
manufacturer	string	Device manufacturer.
model	string	Device model.
operatingSystem	string	Device operating system name.
operatingSystemVersion	string	Device operating system version.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
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".
version	integer	An integer that is incremented each time the resource is modified. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, discovered_device_name, subscription_id		Get a NamespaceDiscoveredDevice.
list_by_resource_group	select	resource_group_name, namespace_name, subscription_id		List NamespaceDiscoveredDevice resources by Namespace.
create_or_replace	insert	resource_group_name, namespace_name, discovered_device_name, subscription_id, location, extendedLocation		Create a NamespaceDiscoveredDevice.
update	update	resource_group_name, namespace_name, discovered_device_name, subscription_id		Update a NamespaceDiscoveredDevice.
create_or_replace	replace	resource_group_name, namespace_name, discovered_device_name, subscription_id, location, extendedLocation		Create a NamespaceDiscoveredDevice.
delete	delete	resource_group_name, namespace_name, discovered_device_name, subscription_id		Delete a NamespaceDiscoveredDevice.

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
discovered_device_name	string	The name of the discovered 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 NamespaceDiscoveredDevice.

SELECT
id,
name,
attributes,
discoveryId,
endpoints,
extendedLocation,
externalDeviceId,
location,
manufacturer,
model,
operatingSystem,
operatingSystemVersion,
provisioningState,
systemData,
tags,
type,
version
FROM azure.device_registry.namespace_discovered_devices
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND discovered_device_name = '{{ discovered_device_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List NamespaceDiscoveredDevice resources by Namespace.

SELECT
id,
name,
attributes,
discoveryId,
endpoints,
extendedLocation,
externalDeviceId,
location,
manufacturer,
model,
operatingSystem,
operatingSystemVersion,
provisioningState,
systemData,
tags,
type,
version
FROM azure.device_registry.namespace_discovered_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 NamespaceDiscoveredDevice.

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

Manifest

# Description fields are for documentation purposes
- name: namespace_discovered_devices
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the namespace_discovered_devices resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the namespace_discovered_devices resource.
  - name: discovered_device_name
    value: "{{ discovered_device_name }}"
    description: Required parameter for the namespace_discovered_devices resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the namespace_discovered_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:
      externalDeviceId: "{{ externalDeviceId }}"
      endpoints:
        inbound: "{{ inbound }}"
        outbound:
          assigned: "{{ assigned }}"
      manufacturer: "{{ manufacturer }}"
      model: "{{ model }}"
      operatingSystem: "{{ operatingSystem }}"
      operatingSystemVersion: "{{ operatingSystemVersion }}"
      attributes: "{{ attributes }}"
      discoveryId: "{{ discoveryId }}"
      version: {{ version }}
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location. Required.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Update a NamespaceDiscoveredDevice.

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

REPLACE examples

create_or_replace

Create a NamespaceDiscoveredDevice.

REPLACE azure.device_registry.namespace_discovered_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 discovered_device_name = '{{ discovered_device_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a NamespaceDiscoveredDevice.

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