Asset Microsoft.DeviceRegistry 2023-11-01-preview

Definizione della risorsa Bicep

Il tipo di risorsa asset può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DeviceRegistry/assets, aggiungi il seguente Bicep al tuo template.

resource symbolicname 'Microsoft.DeviceRegistry/assets@2023-11-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    assetEndpointProfileUri: 'string'
    assetType: 'string'
    attributes: {
      {customized property}: any(...)
    }
    dataPoints: [
      {
        capabilityId: 'string'
        dataPointConfiguration: 'string'
        dataSource: 'string'
        name: 'string'
        observabilityMode: 'string'
      }
    ]
    defaultDataPointsConfiguration: 'string'
    defaultEventsConfiguration: 'string'
    description: 'string'
    displayName: 'string'
    documentationUri: 'string'
    enabled: bool
    events: [
      {
        capabilityId: 'string'
        eventConfiguration: 'string'
        eventNotifier: 'string'
        name: 'string'
        observabilityMode: 'string'
      }
    ]
    externalAssetId: 'string'
    hardwareRevision: 'string'
    manufacturer: 'string'
    manufacturerUri: 'string'
    model: 'string'
    productCode: 'string'
    serialNumber: 'string'
    softwareRevision: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

Microsoft.DeviceRegistry/assets

Name Description Value
extendedLocation Posizione estesa. ExtendedLocation (obbligatorio)
location Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
name Nome della risorsa string

Constraints:
Lunghezza minima = 3
Lunghezza massima = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obbligatorio)
properties Proprietà specifiche della risorsa. AssetProperties
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

AssetProperties

Name Description Value
assetEndpointProfileUri Riferimento al profilo dell'endpoint asset (informazioni di connessione) usato dai broker per connettersi a un endpoint che fornisce punti dati per questo asset. Deve avere il formato <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. stringa (obbligatorio)
assetType Percorso della risorsa per la definizione del tipo di asset (modello). string
attributes Set di coppie chiave-valore che contengono attributi personalizzati impostati dal cliente. AssetPropertiesAttributes
dataPoints Matrice di punti dati che fanno parte dell'asset. Ogni punto dati può fare riferimento a una funzionalità del tipo di asset e avere una configurazione per punto dati. DataPoint[]
defaultDataPointsConfiguration JSON stringato che contiene la configurazione predefinita specifica del protocollo per tutti i punti dati. Ogni punto dati può avere una propria configurazione che esegue l'override delle impostazioni predefinite qui. string
defaultEventsConfiguration JSON stringato che contiene la configurazione predefinita specifica del connettore per tutti gli eventi. Ogni evento può avere una propria configurazione che esegue l'override delle impostazioni predefinite qui. string
description Descrizione leggibile dell'asset. string
displayName Nome visualizzato leggibile. string
documentationUri Riferimento alla documentazione. string
enabled Stato abilitato/disabilitato dell'asset. bool
events Matrice di eventi che fanno parte dell'asset. Ogni evento può avere una configurazione per evento. Event[]
externalAssetId ID risorsa fornito dal cliente. string
hardwareRevision Numero di revisione dell'hardware. string
manufacturer Nome produttore asset. string
manufacturerUri URI del produttore di asset. string
model Nome del modello di asset. string
productCode Codice prodotto asset. string
serialNumber Numero di serie dell'asset. string
softwareRevision Numero di revisione del software. string

AssetPropertiesAttributes

Name Description Value

DataPoint

Name Description Value
capabilityId Percorso della definizione del tipo della funzionalità (ad esempio DTMI, ID nodo del modello informativo OPC UA e così via), ad esempio dtmi:com:example:Robot:_contents::__prop1;1. string
dataPointConfiguration JSON stringato che contiene la configurazione specifica del connettore per il punto dati. Per OPC UA, può includere la configurazione, ad esempio publishingInterval, samplingInterval e queueSize. string
dataSource Indirizzo dell'origine dei dati nell'asset ,ad esempio URL, in modo che un client possa accedere all'origine dati nell'asset. stringa (obbligatorio)
name Nome del punto dati. string
observabilityMode Indicazione della modalità di mapping del punto dati a OpenTelemetry. 'counter'
'gauge'
'histogram'
'log'
'none'

Event

Name Description Value
capabilityId Percorso della definizione del tipo della funzionalità (ad esempio DTMI, ID nodo del modello informativo OPC UA e così via), ad esempio dtmi:com:example:Robot:_contents::__prop1;1. string
eventConfiguration JSON stringato che contiene la configurazione specifica del connettore per l'evento. Per OPC UA, può includere la configurazione, ad esempio publishingInterval, samplingInterval e queueSize. string
eventNotifier Indirizzo del notifier dell'evento nell'asset (ad esempio URL) in modo che un client possa accedere all'evento sull'asset. stringa (obbligatorio)
name Nome dell'evento. string
observabilityMode Indicazione della modalità di mapping dell'evento a OpenTelemetry. 'log'
'none'

ExtendedLocation

Name Description Value
name Nome della posizione estesa. stringa (obbligatorio)
type Tipo di posizione estesa. stringa (obbligatorio)

TrackedResourceTags

Name Description Value

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa asset può essere distribuito con operazioni destinate a:

Esempi di utilizzo

Formato risorsa

Per creare una risorsa Microsoft.DeviceRegistry/assets, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DeviceRegistry/assets",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "assetEndpointProfileUri": "string",
    "assetType": "string",
    "attributes": {
      "{customized property}": {}
    },
    "dataPoints": [
      {
        "capabilityId": "string",
        "dataPointConfiguration": "string",
        "dataSource": "string",
        "name": "string",
        "observabilityMode": "string"
      }
    ],
    "defaultDataPointsConfiguration": "string",
    "defaultEventsConfiguration": "string",
    "description": "string",
    "displayName": "string",
    "documentationUri": "string",
    "enabled": "bool",
    "events": [
      {
        "capabilityId": "string",
        "eventConfiguration": "string",
        "eventNotifier": "string",
        "name": "string",
        "observabilityMode": "string"
      }
    ],
    "externalAssetId": "string",
    "hardwareRevision": "string",
    "manufacturer": "string",
    "manufacturerUri": "string",
    "model": "string",
    "productCode": "string",
    "serialNumber": "string",
    "softwareRevision": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

Microsoft.DeviceRegistry/assets

Name Description Value
apiVersion Versione dell'API '2023-11-01-preview'
extendedLocation Posizione estesa. ExtendedLocation (obbligatorio)
location Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
name Nome della risorsa string

Constraints:
Lunghezza minima = 3
Lunghezza massima = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obbligatorio)
properties Proprietà specifiche della risorsa. AssetProperties
tags Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
type Tipo di risorsa 'Microsoft.DeviceRegistry/assets'

AssetProperties

Name Description Value
assetEndpointProfileUri Riferimento al profilo dell'endpoint asset (informazioni di connessione) usato dai broker per connettersi a un endpoint che fornisce punti dati per questo asset. Deve avere il formato <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. stringa (obbligatorio)
assetType Percorso della risorsa per la definizione del tipo di asset (modello). string
attributes Set di coppie chiave-valore che contengono attributi personalizzati impostati dal cliente. AssetPropertiesAttributes
dataPoints Matrice di punti dati che fanno parte dell'asset. Ogni punto dati può fare riferimento a una funzionalità del tipo di asset e avere una configurazione per punto dati. DataPoint[]
defaultDataPointsConfiguration JSON stringato che contiene la configurazione predefinita specifica del protocollo per tutti i punti dati. Ogni punto dati può avere una propria configurazione che esegue l'override delle impostazioni predefinite qui. string
defaultEventsConfiguration JSON stringato che contiene la configurazione predefinita specifica del connettore per tutti gli eventi. Ogni evento può avere una propria configurazione che esegue l'override delle impostazioni predefinite qui. string
description Descrizione leggibile dell'asset. string
displayName Nome visualizzato leggibile. string
documentationUri Riferimento alla documentazione. string
enabled Stato abilitato/disabilitato dell'asset. bool
events Matrice di eventi che fanno parte dell'asset. Ogni evento può avere una configurazione per evento. Event[]
externalAssetId ID risorsa fornito dal cliente. string
hardwareRevision Numero di revisione dell'hardware. string
manufacturer Nome produttore asset. string
manufacturerUri URI del produttore di asset. string
model Nome del modello di asset. string
productCode Codice prodotto asset. string
serialNumber Numero di serie dell'asset. string
softwareRevision Numero di revisione del software. string

AssetPropertiesAttributes

Name Description Value

DataPoint

Name Description Value
capabilityId Percorso della definizione del tipo della funzionalità (ad esempio DTMI, ID nodo del modello informativo OPC UA e così via), ad esempio dtmi:com:example:Robot:_contents::__prop1;1. string
dataPointConfiguration JSON stringato che contiene la configurazione specifica del connettore per il punto dati. Per OPC UA, può includere la configurazione, ad esempio publishingInterval, samplingInterval e queueSize. string
dataSource Indirizzo dell'origine dei dati nell'asset ,ad esempio URL, in modo che un client possa accedere all'origine dati nell'asset. stringa (obbligatorio)
name Nome del punto dati. string
observabilityMode Indicazione della modalità di mapping del punto dati a OpenTelemetry. 'counter'
'gauge'
'histogram'
'log'
'none'

Event

Name Description Value
capabilityId Percorso della definizione del tipo della funzionalità (ad esempio DTMI, ID nodo del modello informativo OPC UA e così via), ad esempio dtmi:com:example:Robot:_contents::__prop1;1. string
eventConfiguration JSON stringato che contiene la configurazione specifica del connettore per l'evento. Per OPC UA, può includere la configurazione, ad esempio publishingInterval, samplingInterval e queueSize. string
eventNotifier Indirizzo del notifier dell'evento nell'asset (ad esempio URL) in modo che un client possa accedere all'evento sull'asset. stringa (obbligatorio)
name Nome dell'evento. string
observabilityMode Indicazione della modalità di mapping dell'evento a OpenTelemetry. 'log'
'none'

ExtendedLocation

Name Description Value
name Nome della posizione estesa. stringa (obbligatorio)
type Tipo di posizione estesa. stringa (obbligatorio)

TrackedResourceTags

Name Description Value

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa asset può essere distribuito con operazioni destinate a:

  • Gruppi di risorse Per un elenco delle proprietà modificate in ogni versione dell'API, vedi il registro modifiche.

Formato risorsa

Per creare una risorsa Microsoft.DeviceRegistry/assets, aggiungere il formato Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeviceRegistry/assets@2023-11-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      assetEndpointProfileUri = "string"
      assetType = "string"
      attributes = {
        {customized property} = ?
      }
      dataPoints = [
        {
          capabilityId = "string"
          dataPointConfiguration = "string"
          dataSource = "string"
          name = "string"
          observabilityMode = "string"
        }
      ]
      defaultDataPointsConfiguration = "string"
      defaultEventsConfiguration = "string"
      description = "string"
      displayName = "string"
      documentationUri = "string"
      enabled = bool
      events = [
        {
          capabilityId = "string"
          eventConfiguration = "string"
          eventNotifier = "string"
          name = "string"
          observabilityMode = "string"
        }
      ]
      externalAssetId = "string"
      hardwareRevision = "string"
      manufacturer = "string"
      manufacturerUri = "string"
      model = "string"
      productCode = "string"
      serialNumber = "string"
      softwareRevision = "string"
    }
  }
}

Valori delle proprietà

Microsoft.DeviceRegistry/assets

Name Description Value
extendedLocation Posizione estesa. ExtendedLocation (obbligatorio)
location Posizione geografica in cui risiede la risorsa stringa (obbligatorio)
name Nome della risorsa string

Constraints:
Lunghezza minima = 3
Lunghezza massima = 63
Pattern = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obbligatorio)
properties Proprietà specifiche della risorsa. AssetProperties
tags Tag delle risorse Dizionario di nomi e valori di tag.
type Tipo di risorsa "Microsoft.DeviceRegistry/assets@2023-11-01-preview"

AssetProperties

Name Description Value
assetEndpointProfileUri Riferimento al profilo dell'endpoint asset (informazioni di connessione) usato dai broker per connettersi a un endpoint che fornisce punti dati per questo asset. Deve avere il formato <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. stringa (obbligatorio)
assetType Percorso della risorsa per la definizione del tipo di asset (modello). string
attributes Set di coppie chiave-valore che contengono attributi personalizzati impostati dal cliente. AssetPropertiesAttributes
dataPoints Matrice di punti dati che fanno parte dell'asset. Ogni punto dati può fare riferimento a una funzionalità del tipo di asset e avere una configurazione per punto dati. DataPoint[]
defaultDataPointsConfiguration JSON stringato che contiene la configurazione predefinita specifica del protocollo per tutti i punti dati. Ogni punto dati può avere una propria configurazione che esegue l'override delle impostazioni predefinite qui. string
defaultEventsConfiguration JSON stringato che contiene la configurazione predefinita specifica del connettore per tutti gli eventi. Ogni evento può avere una propria configurazione che esegue l'override delle impostazioni predefinite qui. string
description Descrizione leggibile dell'asset. string
displayName Nome visualizzato leggibile. string
documentationUri Riferimento alla documentazione. string
enabled Stato abilitato/disabilitato dell'asset. bool
events Matrice di eventi che fanno parte dell'asset. Ogni evento può avere una configurazione per evento. Event[]
externalAssetId ID risorsa fornito dal cliente. string
hardwareRevision Numero di revisione dell'hardware. string
manufacturer Nome produttore asset. string
manufacturerUri URI del produttore di asset. string
model Nome del modello di asset. string
productCode Codice prodotto asset. string
serialNumber Numero di serie dell'asset. string
softwareRevision Numero di revisione del software. string

AssetPropertiesAttributes

Name Description Value

DataPoint

Name Description Value
capabilityId Percorso della definizione del tipo della funzionalità (ad esempio DTMI, ID nodo del modello informativo OPC UA e così via), ad esempio dtmi:com:example:Robot:_contents::__prop1;1. string
dataPointConfiguration JSON stringato che contiene la configurazione specifica del connettore per il punto dati. Per OPC UA, può includere la configurazione, ad esempio publishingInterval, samplingInterval e queueSize. string
dataSource Indirizzo dell'origine dei dati nell'asset ,ad esempio URL, in modo che un client possa accedere all'origine dati nell'asset. stringa (obbligatorio)
name Nome del punto dati. string
observabilityMode Indicazione della modalità di mapping del punto dati a OpenTelemetry. 'counter'
'gauge'
'histogram'
'log'
'none'

Event

Name Description Value
capabilityId Percorso della definizione del tipo della funzionalità (ad esempio DTMI, ID nodo del modello informativo OPC UA e così via), ad esempio dtmi:com:example:Robot:_contents::__prop1;1. string
eventConfiguration JSON stringato che contiene la configurazione specifica del connettore per l'evento. Per OPC UA, può includere la configurazione, ad esempio publishingInterval, samplingInterval e queueSize. string
eventNotifier Indirizzo del notifier dell'evento nell'asset (ad esempio URL) in modo che un client possa accedere all'evento sull'asset. stringa (obbligatorio)
name Nome dell'evento. string
observabilityMode Indicazione della modalità di mapping dell'evento a OpenTelemetry. 'log'
'none'

ExtendedLocation

Name Description Value
name Nome della posizione estesa. stringa (obbligatorio)
type Tipo di posizione estesa. stringa (obbligatorio)

TrackedResourceTags

Name Description Value