discovered_assets

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

Overview

Name	discovered_assets
Type	Resource
Id	azure.device_registry.discovered_assets

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
extendedLocation	object	The extended location.
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, discoveredAssetName		Get a DiscoveredAsset
list_by_resource_group	select	subscriptionId, resourceGroupName		List DiscoveredAsset resources by resource group
list_by_subscription	select	subscriptionId		List DiscoveredAsset resources by subscription ID
create_or_replace	insert	subscriptionId, resourceGroupName, discoveredAssetName, data__extendedLocation		Create a DiscoveredAsset
update	update	subscriptionId, resourceGroupName, discoveredAssetName		Update a DiscoveredAsset
delete	delete	subscriptionId, resourceGroupName, discoveredAssetName		Delete a DiscoveredAsset

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
discoveredAssetName	string	Discovered Asset name parameter.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a DiscoveredAsset

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.device_registry.discovered_assets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND discoveredAssetName = '{{ discoveredAssetName }}' -- required
;

list_by_resource_group

List DiscoveredAsset resources by resource group

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.device_registry.discovered_assets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List DiscoveredAsset resources by subscription ID

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.device_registry.discovered_assets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_replace

Create a DiscoveredAsset

INSERT INTO azure.device_registry.discovered_assets (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
discoveredAssetName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ discoveredAssetName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: discovered_assets
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the discovered_assets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the discovered_assets resource.
    - name: discoveredAssetName
      value: string
      description: Required parameter for the discovered_assets resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a DiscoveredAsset

UPDATE azure.device_registry.discovered_assets
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND discoveredAssetName = '{{ discoveredAssetName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete a DiscoveredAsset

DELETE FROM azure.device_registry.discovered_assets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND discoveredAssetName = '{{ discoveredAssetName }}' --required
;