Microsoft.DeviceRegistry (preview:2025-07-01)

2025/07/08 • 57 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.DeviceRegistry/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssetEndpointProfiles_ListBySubscription (new)
Description :  List AssetEndpointProfile resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssetEndpointProfile items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assets_ListBySubscription (new)
Description :  List Asset resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Asset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingContainers_ListBySubscription (new)
Description :  List BillingContainer resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/billingContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BillingContainer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource ETag ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BillingContainers_Get (new)
Description :  Get a BillingContainer
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/billingContainers/{billingContainerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
billingContainerName:
{
Description: Name of the billing container. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource ETag ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OperationStatus_Get (new)
Description :  Returns the current status of an async operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/locations/{location}/operationStatuses/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified ID for the async operation. ,
Format: arm-id ,
Required: False ,
}
string ,
resourceId:
{
Description: Fully qualified ID of the resource against which the original async operation was started. ,
Format: arm-id ,
Required: False ,
}
string ,
name:
{
Description: Name of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Required: True ,
}
string ,
percentComplete:
{
Description: Percent of the operation that is complete. ,
Required: False ,
}
number ,
startTime:
{
Description: The start time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
operations:
{
Description: The operations list. ,
Required: False ,
}
[
string ,
]
,
error:
{
Description: If present, details of the operation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
error:
{
Description: If present, details of the operation error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListBySubscription (new)
Description :  List Namespace resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/namespaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Namespace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistries_ListBySubscription (new)
Description :  List SchemaRegistry resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/schemaRegistries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SchemaRegistry items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssetEndpointProfiles_ListByResourceGroup (new)
Description :  List AssetEndpointProfile resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AssetEndpointProfile items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssetEndpointProfiles_Get (new)
Description :  Get a AssetEndpointProfile
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/{assetEndpointProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetEndpointProfileName:
{
Description: Asset Endpoint Profile name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssetEndpointProfiles_CreateOrReplace (new)
Description :  Create a AssetEndpointProfile
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/{assetEndpointProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetEndpointProfileName:
{
Description: Asset Endpoint Profile name parameter. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Asset Endpoint Profile definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssetEndpointProfiles_Update (new)
Description :  Update a AssetEndpointProfile
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/{assetEndpointProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetEndpointProfileName:
{
Description: Asset Endpoint Profile name parameter. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: False ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: False ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: False ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: False ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: False ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: False ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
targetAddress:
{
Description: 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. ,
Format: uri ,
Required: True ,
}
string ,
endpointProfileType:
{
Description: Defines the configuration for the connector type that is being used with the endpoint profile. ,
Required: True ,
}
string ,
authentication:
{
Description: Defines the client authentication mechanism to the server. ,
Required: False ,
}
{
method:
{
Description: Defines the method to authenticate the user of the client at the server. ,
Enum:
{
Anonymous: The user authentication method is anonymous. ,
Certificate: The user authentication method is an x509 certificate. ,
UsernamePassword: The user authentication method is a username and password. ,
}
,
Required: True ,
}
enum ,
usernamePasswordCredentials:
{
Description: Defines the username and password references when UsernamePassword user authentication mode is selected. ,
Required: False ,
}
{
usernameSecretName:
{
Description: The name of the secret containing the username. ,
Required: True ,
}
string ,
passwordSecretName:
{
Description: The name of the secret containing the password. ,
Required: True ,
}
string ,
}
,
x509Credentials:
{
Description: Defines the certificate reference when Certificate user authentication mode is selected. ,
Required: False ,
}
{
certificateSecretName:
{
Description: The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). ,
Required: True ,
}
string ,
}
,
}
,
additionalConfiguration:
{
Description: Stringified JSON that contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF). ,
Required: False ,
}
string ,
discoveredAssetEndpointProfileRef:
{
Description: 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. ,
Required: False ,
}
string ,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). ,
Required: False ,
}
string ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AssetEndpointProfiles_Delete (new)
Description :  Delete a AssetEndpointProfile
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/{assetEndpointProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetEndpointProfileName:
{
Description: Asset Endpoint Profile name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assets_ListByResourceGroup (new)
Description :  List Asset resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Asset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assets_Get (new)
Description :  Get a Asset
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetName:
{
Description: Asset name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assets_CreateOrReplace (new)
Description :  Create a Asset
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetName:
{
Description: Asset name parameter. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Asset definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assets_Update (new)
Description :  Update a Asset
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetName:
{
Description: Asset name parameter. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: False ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/Disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset id provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetEndpointProfileRef:
{
Description: A reference to the asset endpoint profile (connection information) used by brokers to connect to an endpoint that provides data points for this asset. Must provide asset endpoint profile name. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer name. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model name. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Revision number of the hardware. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Revision number of the software. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Reference to the documentation. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Object that describes the default topic information for the asset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
topic:
{
Description: Object that describes the topic information for the specific dataset. ,
Required: False ,
}
{
path:
{
Description: The topic path for messages published to an MQTT broker. ,
Required: True ,
}
string ,
retain:
{
Description: When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
}
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the data point should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Counter: Map as counter to OpenTelemetry. ,
Gauge: Map as gauge to OpenTelemetry. ,
Histogram: Map as histogram to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
observabilityMode:
{
Description: An indication of how the event should be mapped to OpenTelemetry. ,
Enum:
{
None: No mapping to OpenTelemetry. ,
Log: Map as log to OpenTelemetry. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
errors:
{
Description: Array object to transfer and persist errors that originate from the Edge. ,
Required: False ,
}
[
{
code:
{
Description: Error code for classification of errors (ex: 400, 404, 500, etc.). ,
Format: int32 ,
Required: False ,
}
integer ,
message:
{
Description: Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). ,
Required: False ,
}
string ,
}
,
]
,
version:
{
Description: A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Assets_Delete (new)
Description :  Delete a Asset
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
assetName:
{
Description: Asset name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_ListByResourceGroup (new)
Description :  List Namespace resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Namespace items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Get (new)
Description :  Get a Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_CreateOrReplace (new)
Description :  Create a Namespace
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Namespace definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Update (new)
Description :  Update a Namespace
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
messaging:
{
Description: Assigned and unassigned messaging endpoints. ,
Required: False ,
}
{
endpoints:
{
Description: Dictionary of messaging endpoints. ,
Required: False ,
}
object ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Delete (new)
Description :  Delete a Namespace
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceAssets_ListByResourceGroup (new)
Description :  List NamespaceAsset resources by Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/assets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NamespaceAsset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset ID provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
config:
{
Description: Defines the asset status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
streams:
{
Description: Array of stream statuses that describe the status of each stream. ,
Required: False ,
}
[
{
name:
{
Description: The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
managementGroups:
{
Description: Array of management group statuses that describe the status of each management group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
actions:
{
Description: Array of action statuses that describe the status of each action. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
requestMessageSchemaReference:
{
Description: The request message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
responseMessageSchemaReference:
{
Description: The response message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceAssets_Get (new)
Description :  Get a NamespaceAsset
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset ID provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
config:
{
Description: Defines the asset status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
streams:
{
Description: Array of stream statuses that describe the status of each stream. ,
Required: False ,
}
[
{
name:
{
Description: The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
managementGroups:
{
Description: Array of management group statuses that describe the status of each management group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
actions:
{
Description: Array of action statuses that describe the status of each action. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
requestMessageSchemaReference:
{
Description: The request message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
responseMessageSchemaReference:
{
Description: The response message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceAssets_CreateOrReplace (new)
Description :  Create a NamespaceAsset
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset ID provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
config:
{
Description: Defines the asset status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
streams:
{
Description: Array of stream statuses that describe the status of each stream. ,
Required: False ,
}
[
{
name:
{
Description: The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
managementGroups:
{
Description: Array of management group statuses that describe the status of each management group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
actions:
{
Description: Array of action statuses that describe the status of each action. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
requestMessageSchemaReference:
{
Description: The request message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
responseMessageSchemaReference:
{
Description: The response message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset ID provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
config:
{
Description: Defines the asset status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
streams:
{
Description: Array of stream statuses that describe the status of each stream. ,
Required: False ,
}
[
{
name:
{
Description: The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
managementGroups:
{
Description: Array of management group statuses that describe the status of each management group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
actions:
{
Description: Array of action statuses that describe the status of each action. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
requestMessageSchemaReference:
{
Description: The request message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
responseMessageSchemaReference:
{
Description: The response message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Asset definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset ID provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
config:
{
Description: Defines the asset status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
streams:
{
Description: Array of stream statuses that describe the status of each stream. ,
Required: False ,
}
[
{
name:
{
Description: The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
managementGroups:
{
Description: Array of management group statuses that describe the status of each management group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
actions:
{
Description: Array of action statuses that describe the status of each action. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
requestMessageSchemaReference:
{
Description: The request message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
responseMessageSchemaReference:
{
Description: The response message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceAssets_Update (new)
Description :  Update a NamespaceAsset
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable ID. ,
Required: False ,
}
string ,
enabled:
{
Description: Enabled/disabled status of the asset. ,
Required: False ,
}
boolean ,
externalAssetId:
{
Description: Asset ID provided by the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the asset. ,
Required: False ,
}
string ,
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
discoveredAssetRefs:
{
Description: Reference to a list of discovered assets. Populated only if the asset has been created from discovery flow. Discovered asset names must be provided. ,
Required: False ,
}
[
string ,
]
,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
status:
{
Description: Read only object to reflect changes that have occurred on the Edge. Similar to Kubernetes status property for custom resources. ,
Required: False ,
}
{
config:
{
Description: Defines the asset status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
datasets:
{
Description: Array of dataset statuses that describe the status of each dataset. ,
Required: False ,
}
[
{
name:
{
Description: The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
events:
{
Description: Array of event statuses that describe the status of each event. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
streams:
{
Description: Array of stream statuses that describe the status of each stream. ,
Required: False ,
}
[
{
name:
{
Description: The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
messageSchemaReference:
{
Description: The message schema reference object. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
managementGroups:
{
Description: Array of management group statuses that describe the status of each management group. ,
Required: False ,
}
[
{
name:
{
Description: The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
actions:
{
Description: Array of action statuses that describe the status of each action. ,
Required: False ,
}
[
{
name:
{
Description: The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. ,
Required: True ,
}
string ,
requestMessageSchemaReference:
{
Description: The request message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
responseMessageSchemaReference:
{
Description: The response message schema reference object for the action. ,
Required: False ,
}
{
schemaRegistryNamespace:
{
Description: The message schema registry namespace. ,
Required: True ,
}
string ,
schemaName:
{
Description: The message schema name. ,
Required: True ,
}
string ,
schemaVersion:
{
Description: The message schema version. ,
Required: True ,
}
string ,
}
,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceAssets_Delete (new)
Description :  Delete a NamespaceAsset
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/assets/{assetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDevices_ListByResourceGroup (new)
Description :  List NamespaceDevice resources by Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/devices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NamespaceDevice items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: A unique identifier for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the resource is enabled or not. ,
Required: False ,
}
boolean ,
externalDeviceId:
{
Description: The Device ID provided by the customer. ,
Required: False ,
}
string ,
discoveredDeviceRef:
{
Description: Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
status:
{
Description: Device status updates. ,
Required: False ,
}
{
config:
{
Description: Defines the device status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
endpoints:
{
Description: Defines the device status for inbound/outbound endpoints. ,
Required: False ,
}
{
inbound:
{
Description: KeyValue pair representing status of inbound endpoints. ,
Required: False ,
}
object ,
}
,
}
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource Tag. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: The extended location. ,
Required: False ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDevices_Get (new)
Description :  Get a NamespaceDevice
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: A unique identifier for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the resource is enabled or not. ,
Required: False ,
}
boolean ,
externalDeviceId:
{
Description: The Device ID provided by the customer. ,
Required: False ,
}
string ,
discoveredDeviceRef:
{
Description: Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
status:
{
Description: Device status updates. ,
Required: False ,
}
{
config:
{
Description: Defines the device status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
endpoints:
{
Description: Defines the device status for inbound/outbound endpoints. ,
Required: False ,
}
{
inbound:
{
Description: KeyValue pair representing status of inbound endpoints. ,
Required: False ,
}
object ,
}
,
}
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource Tag. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: The extended location. ,
Required: False ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDevices_CreateOrReplace (new)
Description :  Create a NamespaceDevice
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: A unique identifier for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the resource is enabled or not. ,
Required: False ,
}
boolean ,
externalDeviceId:
{
Description: The Device ID provided by the customer. ,
Required: False ,
}
string ,
discoveredDeviceRef:
{
Description: Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
status:
{
Description: Device status updates. ,
Required: False ,
}
{
config:
{
Description: Defines the device status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
endpoints:
{
Description: Defines the device status for inbound/outbound endpoints. ,
Required: False ,
}
{
inbound:
{
Description: KeyValue pair representing status of inbound endpoints. ,
Required: False ,
}
object ,
}
,
}
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource Tag. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: The extended location. ,
Required: False ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: A unique identifier for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the resource is enabled or not. ,
Required: False ,
}
boolean ,
externalDeviceId:
{
Description: The Device ID provided by the customer. ,
Required: False ,
}
string ,
discoveredDeviceRef:
{
Description: Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
status:
{
Description: Device status updates. ,
Required: False ,
}
{
config:
{
Description: Defines the device status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
endpoints:
{
Description: Defines the device status for inbound/outbound endpoints. ,
Required: False ,
}
{
inbound:
{
Description: KeyValue pair representing status of inbound endpoints. ,
Required: False ,
}
object ,
}
,
}
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource Tag. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: The extended location. ,
Required: False ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Device definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: A unique identifier for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the resource is enabled or not. ,
Required: False ,
}
boolean ,
externalDeviceId:
{
Description: The Device ID provided by the customer. ,
Required: False ,
}
string ,
discoveredDeviceRef:
{
Description: Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
status:
{
Description: Device status updates. ,
Required: False ,
}
{
config:
{
Description: Defines the device status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
endpoints:
{
Description: Defines the device status for inbound/outbound endpoints. ,
Required: False ,
}
{
inbound:
{
Description: KeyValue pair representing status of inbound endpoints. ,
Required: False ,
}
object ,
}
,
}
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource Tag. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: The extended location. ,
Required: False ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDevices_Update (new)
Description :  Update a NamespaceDevice
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: False ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
enabled:
{
Description: Indicates if the resource and identity are enabled or not. A disabled device cannot authenticate with Microsoft Entra ID. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: A unique identifier for the device. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the resource is enabled or not. ,
Required: False ,
}
boolean ,
externalDeviceId:
{
Description: The Device ID provided by the customer. ,
Required: False ,
}
string ,
discoveredDeviceRef:
{
Description: Reference to a device. Populated only if the device had been created from discovery flow. Discovered device name must be provided. ,
Required: False ,
}
string ,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
endpoints:
{
Description: Property bag containing the device's unassigned and assigned endpoints. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
unassigned:
{
Description: Set of most recently removed endpoints. ,
Required: False ,
}
object ,
}
,
}
,
attributes:
{
Description: A set of key-value pairs that contain custom attributes set by the customer. ,
Required: False ,
}
object ,
status:
{
Description: Device status updates. ,
Required: False ,
}
{
config:
{
Description: Defines the device status config properties. ,
Required: False ,
}
{
version:
{
Description: A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Object to transfer and persist errors that originate from the edge. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
endpoints:
{
Description: Defines the device status for inbound/outbound endpoints. ,
Required: False ,
}
{
inbound:
{
Description: KeyValue pair representing status of inbound endpoints. ,
Required: False ,
}
object ,
}
,
}
,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTransitionTime:
{
Description: A timestamp (in UTC) that is updated each time the resource is modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: Resource Tag. ,
Required: False ,
}
string ,
extendedLocation:
{
Description: The extended location. ,
Required: False ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDevices_Delete (new)
Description :  Delete a NamespaceDevice
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/devices/{deviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
deviceName:
{
Description: The name of the device. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredAssets_ListByResourceGroup (new)
Description :  List NamespaceDiscoveredAsset resources by Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredAssets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NamespaceDiscoveredAsset items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredAssets_Get (new)
Description :  Get a NamespaceDiscoveredAsset
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredAssets/{discoveredAssetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredAssetName:
{
Description: The name of the discovered asset. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredAssets_CreateOrReplace (new)
Description :  Create a NamespaceDiscoveredAsset
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredAssets/{discoveredAssetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredAssetName:
{
Description: The name of the discovered asset. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Discovered asset definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredAssets_Update (new)
Description :  Update a NamespaceDiscoveredAsset
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredAssets/{discoveredAssetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredAssetName:
{
Description: The name of the discovered asset. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: False ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: False ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: False ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: False ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
deviceRef:
{
Description: Reference to the device that provides data for this asset. Must provide device name & endpoint on the device to use. ,
Required: True ,
}
{
deviceName:
{
Description: Name of the device resource ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of endpoint to use ,
Required: True ,
}
string ,
}
,
assetTypeRefs:
{
Description: URIs or type definition IDs. ,
Required: False ,
}
[
string ,
]
,
discoveryId:
{
Description: Identifier used to detect changes in the asset. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
manufacturer:
{
Description: Asset manufacturer. ,
Required: False ,
}
string ,
manufacturerUri:
{
Description: Asset manufacturer URI. ,
Required: False ,
}
string ,
model:
{
Description: Asset model. ,
Required: False ,
}
string ,
productCode:
{
Description: Asset product code. ,
Required: False ,
}
string ,
hardwareRevision:
{
Description: Asset hardware revision number. ,
Required: False ,
}
string ,
softwareRevision:
{
Description: Asset software revision number. ,
Required: False ,
}
string ,
documentationUri:
{
Description: Asset documentation reference. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Asset serial number. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
defaultDatasetsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultEventsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultStreamsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultManagementGroupsConfiguration:
{
Description: Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. ,
Required: False ,
}
string ,
defaultDatasetsDestinations:
{
Description: Default destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultEventsDestinations:
{
Description: Default destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
defaultStreamsDestinations:
{
Description: Default destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
datasets:
{
Description: Array of datasets that are part of the asset. Each dataset spec describes the data points that make up the set. ,
Required: False ,
}
[
{
name:
{
Description: Name of the dataset. ,
Required: True ,
}
string ,
dataSource:
{
Description: Reference to a data source for a given dataset. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
datasetConfiguration:
{
Description: Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a dataset. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
BrokerStateStore: Broker State Store target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
dataPoints:
{
Description: Array of data points that are part of the dataset. Each data point can have per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the dataset was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
events:
{
Description: Array of events that are part of the asset. Each event can have per-event configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the event. ,
Required: True ,
}
string ,
eventNotifier:
{
Description: The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. ,
Required: True ,
}
string ,
eventConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for an event. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
dataPoints:
{
Description: Array of data points that are part of the event. Each data point can have a per-data point configuration. ,
Required: False ,
}
[
{
name:
{
Description: The name of the data point. ,
Required: True ,
}
string ,
dataSource:
{
Description: The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. ,
Required: True ,
}
string ,
dataPointConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. ,
Required: False ,
}
string ,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the data point was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: UTC timestamp indicating when the event was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
streams:
{
Description: Array of streams that are part of the asset. Each stream can have a per-stream configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the stream definition. ,
Required: True ,
}
string ,
streamConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the specific stream. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
destinations:
{
Description: Destinations for a stream. ,
Required: False ,
}
[
{
target:
{
Description: Target destination. ,
Enum:
{
Mqtt: MQTT target. ,
Storage: Storage target. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the stream was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
managementGroups:
{
Description: Array of management groups that are part of the asset. Each management group can have a per-group configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the management group. ,
Required: True ,
}
string ,
managementGroupConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the management group. ,
Required: False ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
defaultTopic:
{
Description: Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. ,
Required: False ,
}
string ,
defaultTimeoutInSeconds:
{
Description: Default response timeout for all actions that are part of the management group. ,
Format: int32 ,
Required: False ,
}
integer ,
actions:
{
Description: Array of actions that are part of the management group. Each action can have an individual configuration. ,
Required: False ,
}
[
{
name:
{
Description: Name of the action. ,
Required: True ,
}
string ,
actionConfiguration:
{
Description: Stringified JSON that contains connector-specific configuration for the action. ,
Required: False ,
}
string ,
targetUri:
{
Description: The target URI on which a client can invoke the specific action. ,
Required: True ,
}
string ,
typeRef:
{
Description: URI or type definition ID. ,
Required: False ,
}
string ,
topic:
{
Description: The MQTT topic path on which a client will receive the request for the action. ,
Required: False ,
}
string ,
actionType:
{
Description: The type of the action. ,
Enum:
{
Call: Call action type. ,
Read: Read action type. ,
Write: Write action type. ,
}
,
Required: False ,
}
enum ,
timeoutInSeconds:
{
Description: Response timeout for the action. ,
Format: int32 ,
Required: False ,
}
integer ,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management action was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
lastUpdatedOn:
{
Description: Timestamp (in UTC) indicating when the management group was added or modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredAssets_Delete (new)
Description :  Delete a NamespaceDiscoveredAsset
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredAssets/{discoveredAssetName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredAssetName:
{
Description: The name of the discovered asset. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredDevices_ListByResourceGroup (new)
Description :  List NamespaceDiscoveredDevice resources by Namespace
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NamespaceDiscoveredDevice items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
}
,
}
,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system name. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredDevices_Get (new)
Description :  Get a NamespaceDiscoveredDevice
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredDevices/{discoveredDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredDeviceName:
{
Description: The name of the discovered device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
}
,
}
,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system name. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredDevices_CreateOrReplace (new)
Description :  Create a NamespaceDiscoveredDevice
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredDevices/{discoveredDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredDeviceName:
{
Description: The name of the discovered device. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
}
,
}
,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system name. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
}
,
}
,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system name. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Discovered device definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
}
,
}
,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system name. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredDevices_Update (new)
Description :  Update a NamespaceDiscoveredDevice
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredDevices/{discoveredDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredDeviceName:
{
Description: The name of the discovered device. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: False ,
}
object ,
}
,
}
,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: False ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
externalDeviceId:
{
Description: A device ID that represents the device in a system external to Azure. Unique within scope of an Azure tenant. ,
Required: False ,
}
string ,
endpoints:
{
Description: Endpoints for discovered devices. ,
Required: False ,
}
{
inbound:
{
Description: Set of endpoints to connect to the device. ,
Required: False ,
}
object ,
outbound:
{
Description: Set of endpoints a device can connect to. ,
Required: False ,
}
{
assigned:
{
Description: Endpoints the device can connect to. ,
Required: True ,
}
object ,
}
,
}
,
manufacturer:
{
Description: Device manufacturer. ,
Required: False ,
}
string ,
model:
{
Description: Device model. ,
Required: False ,
}
string ,
operatingSystem:
{
Description: Device operating system name. ,
Required: False ,
}
string ,
operatingSystemVersion:
{
Description: Device operating system version. ,
Required: False ,
}
string ,
attributes:
{
Description: A set of key-value pairs that contain custom attributes. ,
Required: False ,
}
object ,
discoveryId:
{
Description: Identifier used to detect changes in the discovered device. ,
Required: True ,
}
string ,
version:
{
Description: An integer that is incremented each time the resource is modified. ,
Format: int64 ,
Required: True ,
}
integer ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: The extended location. ,
Required: True ,
}
{
type:
{
Description: The extended location type. ,
Required: True ,
}
string ,
name:
{
Description: The extended location name. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NamespaceDiscoveredDevices_Delete (new)
Description :  Delete a NamespaceDiscoveredDevice
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/discoveredDevices/{discoveredDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
discoveredDeviceName:
{
Description: The name of the discovered device. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Namespaces_Migrate (new)
Description :  Migrate the resources into Namespace
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/namespaces/{namespaceName}/migrate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
namespaceName:
{
Description: The name of the namespace. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
scope:
{
Description: Scope of the migrate resources operation. ,
Enum:
{
Resources: Scoping the migration to resourceIds provided ,
}
,
Required: False ,
}
enum ,
resourceIds:
{
Description: List of asset resources to be migrated. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
migrateResults:
{
Description: List of migrate results containing result of each asset migrate operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource Id of the asset resource. ,
Required: False ,
}
string ,
result:
{
Description: The result of the migrate operation. ,
Enum:
{
Succeeded: Resource Migrate operation is successful. ,
Failed: Resource Migrate operation is not successful. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: The error if the migrate operation is not successful. ,
Required: False ,
}
{
code:
{
Description: Error code for classification of errors (ex: '400', '404', '500', etc.). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). ,
Required: False ,
}
string ,
details:
{
Description: Array of error details that describe the status of each error. ,
Required: False ,
}
[
{
code:
{
Description: Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). ,
Required: False ,
}
string ,
message:
{
Description: Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). ,
Required: False ,
}
string ,
info:
{
Description: Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). ,
Required: False ,
}
string ,
correlationId:
{
Description: Unique identifier for the transaction to aid in debugging. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistries_ListByResourceGroup (new)
Description :  List SchemaRegistry resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SchemaRegistry items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistries_Get (new)
Description :  Get a SchemaRegistry
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistries_CreateOrReplace (new)
Description :  Create a SchemaRegistry
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Schema registry definition. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistries_Update (new)
Description :  Update a SchemaRegistry
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
namespace:
{
Description: Schema registry namespace. Uniquely identifies a schema registry within a tenant. ,
Required: True ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema registry. ,
Required: False ,
}
string ,
storageAccountContainerUrl:
{
Description: The Storage Account's Container URL where schemas will be stored. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (either system assigned, or none). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaRegistries_Delete (new)
Description :  Delete a SchemaRegistry
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schemas_ListBySchemaRegistry (new)
Description :  List Schema resources by SchemaRegistry
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Schema items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
format:
{
Description: Format of the schema. ,
Enum:
{
JsonSchema/draft-07: JSON Schema version draft 7 format ,
Delta/1.0: Delta format ,
}
,
Required: True ,
}
enum ,
schemaType:
{
Description: Type of the schema. ,
Enum:
{
MessageSchema: Message Schema schema type ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Schema tags. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schemas_Get (new)
Description :  Get a Schema
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
format:
{
Description: Format of the schema. ,
Enum:
{
JsonSchema/draft-07: JSON Schema version draft 7 format ,
Delta/1.0: Delta format ,
}
,
Required: True ,
}
enum ,
schemaType:
{
Description: Type of the schema. ,
Enum:
{
MessageSchema: Message Schema schema type ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Schema tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schemas_CreateOrReplace (new)
Description :  Create a Schema
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
format:
{
Description: Format of the schema. ,
Enum:
{
JsonSchema/draft-07: JSON Schema version draft 7 format ,
Delta/1.0: Delta format ,
}
,
Required: True ,
}
enum ,
schemaType:
{
Description: Type of the schema. ,
Enum:
{
MessageSchema: Message Schema schema type ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Schema tags. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
format:
{
Description: Format of the schema. ,
Enum:
{
JsonSchema/draft-07: JSON Schema version draft 7 format ,
Delta/1.0: Delta format ,
}
,
Required: True ,
}
enum ,
schemaType:
{
Description: Type of the schema. ,
Enum:
{
MessageSchema: Message Schema schema type ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Schema tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
displayName:
{
Description: Human-readable display name. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
format:
{
Description: Format of the schema. ,
Enum:
{
JsonSchema/draft-07: JSON Schema version draft 7 format ,
Delta/1.0: Delta format ,
}
,
Required: True ,
}
enum ,
schemaType:
{
Description: Type of the schema. ,
Enum:
{
MessageSchema: Message Schema schema type ,
}
,
Required: True ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
tags:
{
Description: Schema tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Schemas_Delete (new)
Description :  Delete a Schema
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaVersions_ListBySchema (new)
Description :  List SchemaVersion resources by Schema
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}/schemaVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SchemaVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
schemaContent:
{
Description: Schema content. ,
Required: True ,
}
string ,
hash:
{
Description: Hash of the schema content. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaVersions_Get (new)
Description :  Get a SchemaVersion
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}/schemaVersions/{schemaVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: Schema version name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
schemaContent:
{
Description: Schema content. ,
Required: True ,
}
string ,
hash:
{
Description: Hash of the schema content. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaVersions_CreateOrReplace (new)
Description :  Create a SchemaVersion
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}/schemaVersions/{schemaVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: Schema version name parameter. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
schemaContent:
{
Description: Schema content. ,
Required: True ,
}
string ,
hash:
{
Description: Hash of the schema content. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
schemaContent:
{
Description: Schema content. ,
Required: True ,
}
string ,
hash:
{
Description: Hash of the schema content. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
uuid:
{
Description: Globally unique, immutable, non-reusable id. ,
Required: False ,
}
string ,
description:
{
Description: Human-readable description of the schema. ,
Required: False ,
}
string ,
schemaContent:
{
Description: Schema content. ,
Required: True ,
}
string ,
hash:
{
Description: Hash of the schema content. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Accepted: Resource has been accepted by the server. ,
Deleting: Resource is deleting. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SchemaVersions_Delete (new)
Description :  Delete a SchemaVersion
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/schemaRegistries/{schemaRegistryName}/schemas/{schemaName}/schemaVersions/{schemaVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
schemaRegistryName:
{
Description: Schema registry name parameter. ,
Required: True ,
}
string ,
schemaName:
{
Description: Schema name parameter. ,
Required: True ,
}
string ,
schemaVersionName:
{
Description: Schema version name parameter. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}