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

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.
additionalConfiguration	string	Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
authentication	object	Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef	string	Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
endpointProfileType	string	Defines the configuration for the connector type that is being used with the endpoint profile. Required.
extendedLocation	object	The extended location. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
status	object	Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetAddress	string	The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable id.

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.
additionalConfiguration	string	Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
authentication	object	Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef	string	Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
endpointProfileType	string	Defines the configuration for the connector type that is being used with the endpoint profile. Required.
extendedLocation	object	The extended location. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
status	object	Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetAddress	string	The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable id.

list_by_subscription

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.
additionalConfiguration	string	Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
authentication	object	Defines the client authentication mechanism to the server.
discoveredAssetEndpointProfileRef	string	Reference to a discovered asset endpoint profile. Populated only if the asset endpoint profile has been created from discovery flow. Discovered asset endpoint profile name must be provided.
endpointProfileType	string	Defines the configuration for the connector type that is being used with the endpoint profile. Required.
extendedLocation	object	The extended location. Required.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
status	object	Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
targetAddress	string	The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable id.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, asset_endpoint_profile_name, subscription_id		Get a AssetEndpointProfile.
list_by_resource_group	select	resource_group_name, subscription_id		List AssetEndpointProfile resources by resource group.
list_by_subscription	select	subscription_id		List AssetEndpointProfile resources by subscription ID.
create_or_replace	insert	resource_group_name, asset_endpoint_profile_name, subscription_id, location, extendedLocation		Create a AssetEndpointProfile.
update	update	resource_group_name, asset_endpoint_profile_name, subscription_id		Update a AssetEndpointProfile.
create_or_replace	replace	resource_group_name, asset_endpoint_profile_name, subscription_id, location, extendedLocation		Create a AssetEndpointProfile.
delete	delete	resource_group_name, asset_endpoint_profile_name, subscription_id		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
asset_endpoint_profile_name	string	Asset Endpoint Profile name parameter. 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 AssetEndpointProfile.

SELECT
id,
name,
additionalConfiguration,
authentication,
discoveredAssetEndpointProfileRef,
endpointProfileType,
extendedLocation,
location,
provisioningState,
status,
systemData,
tags,
targetAddress,
type,
uuid
FROM azure.device_registry.asset_endpoint_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND asset_endpoint_profile_name = '{{ asset_endpoint_profile_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List AssetEndpointProfile resources by resource group.

SELECT
id,
name,
additionalConfiguration,
authentication,
discoveredAssetEndpointProfileRef,
endpointProfileType,
extendedLocation,
location,
provisioningState,
status,
systemData,
tags,
targetAddress,
type,
uuid
FROM azure.device_registry.asset_endpoint_profiles
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List AssetEndpointProfile resources by subscription ID.

SELECT
id,
name,
additionalConfiguration,
authentication,
discoveredAssetEndpointProfileRef,
endpointProfileType,
extendedLocation,
location,
provisioningState,
status,
systemData,
tags,
targetAddress,
type,
uuid
FROM azure.device_registry.asset_endpoint_profiles
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_replace

Create a AssetEndpointProfile.

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

Manifest

# Description fields are for documentation purposes
- name: asset_endpoint_profiles
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the asset_endpoint_profiles resource.
  - name: asset_endpoint_profile_name
    value: "{{ asset_endpoint_profile_name }}"
    description: Required parameter for the asset_endpoint_profiles resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the asset_endpoint_profiles 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 }}"
      targetAddress: "{{ targetAddress }}"
      endpointProfileType: "{{ endpointProfileType }}"
      authentication:
        method: "{{ method }}"
        usernamePasswordCredentials:
          usernameSecretName: "{{ usernameSecretName }}"
          passwordSecretName: "{{ passwordSecretName }}"
        x509Credentials:
          certificateSecretName: "{{ certificateSecretName }}"
      additionalConfiguration: "{{ additionalConfiguration }}"
      discoveredAssetEndpointProfileRef: "{{ discoveredAssetEndpointProfileRef }}"
      status:
        errors:
          - code: {{ code }}
            message: "{{ message }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location. Required.
    value:
      type: "{{ type }}"
      name: "{{ name }}"

UPDATE examples

update

Update a AssetEndpointProfile.

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

REPLACE examples

create_or_replace

Create a AssetEndpointProfile.

REPLACE azure.device_registry.asset_endpoint_profiles
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND asset_endpoint_profile_name = '{{ asset_endpoint_profile_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 AssetEndpointProfile.

DELETE FROM azure.device_registry.asset_endpoint_profiles
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND asset_endpoint_profile_name = '{{ asset_endpoint_profile_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;