Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The discoveredAssetEndpointProfiles resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles@2024-09-01-preview' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
additionalConfiguration: 'string'
discoveryId: 'string'
endpointProfileType: 'string'
supportedAuthenticationMethods: [
'string'
]
targetAddress: 'string'
version: int
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | DiscoveredAssetEndpointProfileProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
DiscoveredAssetEndpointProfileProperties
| Name | Description | Value |
|---|---|---|
| additionalConfiguration | Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). | string |
| discoveryId | Identifier used to detect changes in the asset endpoint profile. | string (required) |
| endpointProfileType | Defines the configuration for the connector type that is being used with the endpoint profile. | string (required) |
| supportedAuthenticationMethods | List of supported authentication methods supported by the target server. | String array containing any of: 'Anonymous' 'Certificate' 'UsernamePassword' |
| targetAddress | 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. | string (required) |
| version | An integer that is incremented each time the resource is modified. | int (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The extended location name. | string (required) |
| type | The extended location type. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The discoveredAssetEndpointProfiles resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles resource, add the following JSON to your template.
{
"type": "Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles",
"apiVersion": "2024-09-01-preview",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"additionalConfiguration": "string",
"discoveryId": "string",
"endpointProfileType": "string",
"supportedAuthenticationMethods": [ "string" ],
"targetAddress": "string",
"version": "int"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-09-01-preview' |
| extendedLocation | The extended location. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | DiscoveredAssetEndpointProfileProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles' |
DiscoveredAssetEndpointProfileProperties
| Name | Description | Value |
|---|---|---|
| additionalConfiguration | Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). | string |
| discoveryId | Identifier used to detect changes in the asset endpoint profile. | string (required) |
| endpointProfileType | Defines the configuration for the connector type that is being used with the endpoint profile. | string (required) |
| supportedAuthenticationMethods | List of supported authentication methods supported by the target server. | String array containing any of: 'Anonymous' 'Certificate' 'UsernamePassword' |
| targetAddress | 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. | string (required) |
| version | An integer that is incremented each time the resource is modified. | int (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The extended location name. | string (required) |
| type | The extended location type. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Terraform (AzAPI provider) resource definition
The discoveredAssetEndpointProfiles resource type can be deployed with operations that target:
- Resource groups For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles@2024-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
additionalConfiguration = "string"
discoveryId = "string"
endpointProfileType = "string"
supportedAuthenticationMethods = [
"string"
]
targetAddress = "string"
version = int
}
}
}
Property Values
Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 63 Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (required) |
| properties | The resource-specific properties for this resource. | DiscoveredAssetEndpointProfileProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DeviceRegistry/discoveredAssetEndpointProfiles@2024-09-01-preview" |
DiscoveredAssetEndpointProfileProperties
| Name | Description | Value |
|---|---|---|
| additionalConfiguration | Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). | string |
| discoveryId | Identifier used to detect changes in the asset endpoint profile. | string (required) |
| endpointProfileType | Defines the configuration for the connector type that is being used with the endpoint profile. | string (required) |
| supportedAuthenticationMethods | List of supported authentication methods supported by the target server. | String array containing any of: 'Anonymous' 'Certificate' 'UsernamePassword' |
| targetAddress | 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. | string (required) |
| version | An integer that is incremented each time the resource is modified. | int (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The extended location name. | string (required) |
| type | The extended location type. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|