asset_endpoint_profiles

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

Overview

Name	asset_endpoint_profiles
Type	Resource
Id	azure.device_registry.asset_endpoint_profiles

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, assetEndpointProfileName		Get a AssetEndpointProfile
list_by_resource_group	select	subscriptionId, resourceGroupName		List AssetEndpointProfile resources by resource group
list_by_subscription	select	subscriptionId		List AssetEndpointProfile resources by subscription ID
create_or_replace	insert	subscriptionId, resourceGroupName, assetEndpointProfileName, data__extendedLocation		Create a AssetEndpointProfile
update	update	subscriptionId, resourceGroupName, assetEndpointProfileName		Update a AssetEndpointProfile
delete	delete	subscriptionId, resourceGroupName, assetEndpointProfileName		Delete a AssetEndpointProfile

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
assetEndpointProfileName	string	Asset Endpoint Profile 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 AssetEndpointProfile

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

list_by_resource_group

List AssetEndpointProfile resources by resource group

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

list_by_subscription

List AssetEndpointProfile resources by subscription ID

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

INSERT examples

create_or_replace

Create a AssetEndpointProfile

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

Manifest

# Description fields are for documentation purposes
- name: asset_endpoint_profiles
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the asset_endpoint_profiles resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the asset_endpoint_profiles resource.
    - name: assetEndpointProfileName
      value: string
      description: Required parameter for the asset_endpoint_profiles 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 AssetEndpointProfile

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

DELETE examples

delete

Delete a AssetEndpointProfile

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