Ativos Microsoft.DeviceRegistry 2023-11-01-preview

Definição de recurso Bicep

O tipo de recurso de ativos pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.DeviceRegistry/assets, adicione o seguinte Bicep ao seu modelo.

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'
  }
}

Valores de propriedade

Microsoft.DeviceRegistry/assets

Name Description Value
extendedLocation A localização estendida. ExtendedLocation (obrigatório)
localização A geolocalização onde o recurso vive string (obrigatório)
name O nome do recurso string

Constraints:
Comprimento mínimo = 3
Comprimento máximo = 63
Padrão = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obrigatório)
properties As propriedades específicas do recurso para este recurso. AssetProperties
tags Etiquetas de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

AssetProperties

Name Description Value
assetEndpointProfileUri Uma referência ao perfil do ponto de extremidade do ativo (informações de conexão) usado pelos corretores para se conectar a um ponto de extremidade que fornece pontos de dados para esse ativo. Deve ter o formato <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. string (obrigatório)
assetType Definição de caminho de recurso para tipo de ativo (modelo). cadeia (de caracteres)
attributes Um conjunto de pares chave-valor que contêm atributos personalizados definidos pelo cliente. AssetPropertiesAttributes
dataPoints Matriz de pontos de dados que fazem parte do ativo. Cada ponto de dados pode fazer referência a um recurso de tipo de ativo e ter configuração por ponto de dados. DataPoint[]
defaultDataPointsConfiguration JSON stringified que contém configuração padrão específica do protocolo para todos os pontos de dados. Cada ponto de dados pode ter sua própria configuração que substitui as configurações padrão aqui. cadeia (de caracteres)
defaultEventsConfiguration JSON stringified que contém configuração padrão específica do conector para todos os eventos. Cada evento pode ter sua própria configuração que substitui as configurações padrão aqui. cadeia (de caracteres)
description Descrição legível por humanos do ativo. cadeia (de caracteres)
displayName Nome de exibição legível por humanos. cadeia (de caracteres)
documentationUri Referência à documentação. cadeia (de caracteres)
enabled Status habilitado/desativado do ativo. bool
events Matriz de eventos que fazem parte do ativo. Cada evento pode ter configuração por evento. Event[]
externalAssetId ID do ativo fornecido pelo cliente. cadeia (de caracteres)
hardwareRevision Número de revisão do hardware. cadeia (de caracteres)
fabricante Nome do fabricante do ativo. cadeia (de caracteres)
manufacturerUri URI do fabricante de ativos. cadeia (de caracteres)
modelo Nome do modelo de ativo. cadeia (de caracteres)
productCode Código do produto do ativo. cadeia (de caracteres)
serialNumber Número de série do ativo. cadeia (de caracteres)
softwareRevision Número de revisão do software. cadeia (de caracteres)

AssetPropertiesAttributes

Name Description Value

DataPoint

Name Description Value
capabilityId O caminho para a definição de tipo da capacidade (por exemplo, DTMI, OPC UA information model node id, etc.), por exemplo dtmi:com:example:Robot:_contents:__prop1;1. cadeia (de caracteres)
dataPointConfiguration JSON stringified que contém configuração específica do conector para o ponto de dados. Para OPC UA, isso pode incluir configurações como, publishingInterval, samplingInterval e queueSize. cadeia (de caracteres)
dataSource O endereço da fonte dos dados no ativo (por exemplo, URL) para que um cliente possa acessar a fonte de dados no ativo. string (obrigatório)
name O nome do ponto de dados. cadeia (de caracteres)
observabilityMode Uma indicação de como o ponto de dados deve ser mapeado para OpenTelemetry. 'counter'
'gauge'
'histogram'
'log'
'none'

Event

Name Description Value
capabilityId O caminho para a definição de tipo da capacidade (por exemplo, DTMI, OPC UA information model node id, etc.), por exemplo dtmi:com:example:Robot:_contents:__prop1;1. cadeia (de caracteres)
eventConfiguration JSON stringified que contém configuração específica do conector para o evento. Para OPC UA, isso pode incluir configurações como, publishingInterval, samplingInterval e queueSize. cadeia (de caracteres)
eventNotifier O endereço do notificador do evento no ativo (por exemplo, URL) para que um cliente possa acessar o evento no ativo. string (obrigatório)
name O nome do evento. cadeia (de caracteres)
observabilityMode Uma indicação de como o evento deve ser mapeado para OpenTelemetry. 'log'
'none'

ExtendedLocation

Name Description Value
name O nome do local estendido. string (obrigatório)
tipo O tipo de local estendido. string (obrigatório)

TrackedResourceTags

Name Description Value

Definição de recurso de modelo ARM

O tipo de recurso de ativos pode ser implantado com operações que visam:

Exemplos de uso

Formato do recurso

Para criar um recurso Microsoft.DeviceRegistry/assets, adicione o seguinte JSON ao seu modelo.

{
  "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"
  }
}

Valores de propriedade

Microsoft.DeviceRegistry/assets

Name Description Value
apiVersion A versão api '2023-11-01-preview'
extendedLocation A localização estendida. ExtendedLocation (obrigatório)
localização A geolocalização onde o recurso vive string (obrigatório)
name O nome do recurso string

Constraints:
Comprimento mínimo = 3
Comprimento máximo = 63
Padrão = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obrigatório)
properties As propriedades específicas do recurso para este recurso. AssetProperties
tags Etiquetas de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DeviceRegistry/assets'

AssetProperties

Name Description Value
assetEndpointProfileUri Uma referência ao perfil do ponto de extremidade do ativo (informações de conexão) usado pelos corretores para se conectar a um ponto de extremidade que fornece pontos de dados para esse ativo. Deve ter o formato <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. string (obrigatório)
assetType Definição de caminho de recurso para tipo de ativo (modelo). cadeia (de caracteres)
attributes Um conjunto de pares chave-valor que contêm atributos personalizados definidos pelo cliente. AssetPropertiesAttributes
dataPoints Matriz de pontos de dados que fazem parte do ativo. Cada ponto de dados pode fazer referência a um recurso de tipo de ativo e ter configuração por ponto de dados. DataPoint[]
defaultDataPointsConfiguration JSON stringified que contém configuração padrão específica do protocolo para todos os pontos de dados. Cada ponto de dados pode ter sua própria configuração que substitui as configurações padrão aqui. cadeia (de caracteres)
defaultEventsConfiguration JSON stringified que contém configuração padrão específica do conector para todos os eventos. Cada evento pode ter sua própria configuração que substitui as configurações padrão aqui. cadeia (de caracteres)
description Descrição legível por humanos do ativo. cadeia (de caracteres)
displayName Nome de exibição legível por humanos. cadeia (de caracteres)
documentationUri Referência à documentação. cadeia (de caracteres)
enabled Status habilitado/desativado do ativo. bool
events Matriz de eventos que fazem parte do ativo. Cada evento pode ter configuração por evento. Event[]
externalAssetId ID do ativo fornecido pelo cliente. cadeia (de caracteres)
hardwareRevision Número de revisão do hardware. cadeia (de caracteres)
fabricante Nome do fabricante do ativo. cadeia (de caracteres)
manufacturerUri URI do fabricante de ativos. cadeia (de caracteres)
modelo Nome do modelo de ativo. cadeia (de caracteres)
productCode Código do produto do ativo. cadeia (de caracteres)
serialNumber Número de série do ativo. cadeia (de caracteres)
softwareRevision Número de revisão do software. cadeia (de caracteres)

AssetPropertiesAttributes

Name Description Value

DataPoint

Name Description Value
capabilityId O caminho para a definição de tipo da capacidade (por exemplo, DTMI, OPC UA information model node id, etc.), por exemplo dtmi:com:example:Robot:_contents:__prop1;1. cadeia (de caracteres)
dataPointConfiguration JSON stringified que contém configuração específica do conector para o ponto de dados. Para OPC UA, isso pode incluir configurações como, publishingInterval, samplingInterval e queueSize. cadeia (de caracteres)
dataSource O endereço da fonte dos dados no ativo (por exemplo, URL) para que um cliente possa acessar a fonte de dados no ativo. string (obrigatório)
name O nome do ponto de dados. cadeia (de caracteres)
observabilityMode Uma indicação de como o ponto de dados deve ser mapeado para OpenTelemetry. 'counter'
'gauge'
'histogram'
'log'
'none'

Event

Name Description Value
capabilityId O caminho para a definição de tipo da capacidade (por exemplo, DTMI, OPC UA information model node id, etc.), por exemplo dtmi:com:example:Robot:_contents:__prop1;1. cadeia (de caracteres)
eventConfiguration JSON stringified que contém configuração específica do conector para o evento. Para OPC UA, isso pode incluir configurações como, publishingInterval, samplingInterval e queueSize. cadeia (de caracteres)
eventNotifier O endereço do notificador do evento no ativo (por exemplo, URL) para que um cliente possa acessar o evento no ativo. string (obrigatório)
name O nome do evento. cadeia (de caracteres)
observabilityMode Uma indicação de como o evento deve ser mapeado para OpenTelemetry. 'log'
'none'

ExtendedLocation

Name Description Value
name O nome do local estendido. string (obrigatório)
tipo O tipo de local estendido. string (obrigatório)

TrackedResourceTags

Name Description Value

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso de ativos pode ser implantado com operações que visam:

  • Grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.DeviceRegistry/assets, adicione o seguinte Terraform ao seu modelo.

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"
    }
  }
}

Valores de propriedade

Microsoft.DeviceRegistry/assets

Name Description Value
extendedLocation A localização estendida. ExtendedLocation (obrigatório)
localização A geolocalização onde o recurso vive string (obrigatório)
name O nome do recurso string

Constraints:
Comprimento mínimo = 3
Comprimento máximo = 63
Padrão = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (obrigatório)
properties As propriedades específicas do recurso para este recurso. AssetProperties
tags Etiquetas de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DeviceRegistry/assets@2023-11-01-preview"

AssetProperties

Name Description Value
assetEndpointProfileUri Uma referência ao perfil do ponto de extremidade do ativo (informações de conexão) usado pelos corretores para se conectar a um ponto de extremidade que fornece pontos de dados para esse ativo. Deve ter o formato <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. string (obrigatório)
assetType Definição de caminho de recurso para tipo de ativo (modelo). cadeia (de caracteres)
attributes Um conjunto de pares chave-valor que contêm atributos personalizados definidos pelo cliente. AssetPropertiesAttributes
dataPoints Matriz de pontos de dados que fazem parte do ativo. Cada ponto de dados pode fazer referência a um recurso de tipo de ativo e ter configuração por ponto de dados. DataPoint[]
defaultDataPointsConfiguration JSON stringified que contém configuração padrão específica do protocolo para todos os pontos de dados. Cada ponto de dados pode ter sua própria configuração que substitui as configurações padrão aqui. cadeia (de caracteres)
defaultEventsConfiguration JSON stringified que contém configuração padrão específica do conector para todos os eventos. Cada evento pode ter sua própria configuração que substitui as configurações padrão aqui. cadeia (de caracteres)
description Descrição legível por humanos do ativo. cadeia (de caracteres)
displayName Nome de exibição legível por humanos. cadeia (de caracteres)
documentationUri Referência à documentação. cadeia (de caracteres)
enabled Status habilitado/desativado do ativo. bool
events Matriz de eventos que fazem parte do ativo. Cada evento pode ter configuração por evento. Event[]
externalAssetId ID do ativo fornecido pelo cliente. cadeia (de caracteres)
hardwareRevision Número de revisão do hardware. cadeia (de caracteres)
fabricante Nome do fabricante do ativo. cadeia (de caracteres)
manufacturerUri URI do fabricante de ativos. cadeia (de caracteres)
modelo Nome do modelo de ativo. cadeia (de caracteres)
productCode Código do produto do ativo. cadeia (de caracteres)
serialNumber Número de série do ativo. cadeia (de caracteres)
softwareRevision Número de revisão do software. cadeia (de caracteres)

AssetPropertiesAttributes

Name Description Value

DataPoint

Name Description Value
capabilityId O caminho para a definição de tipo da capacidade (por exemplo, DTMI, OPC UA information model node id, etc.), por exemplo dtmi:com:example:Robot:_contents:__prop1;1. cadeia (de caracteres)
dataPointConfiguration JSON stringified que contém configuração específica do conector para o ponto de dados. Para OPC UA, isso pode incluir configurações como, publishingInterval, samplingInterval e queueSize. cadeia (de caracteres)
dataSource O endereço da fonte dos dados no ativo (por exemplo, URL) para que um cliente possa acessar a fonte de dados no ativo. string (obrigatório)
name O nome do ponto de dados. cadeia (de caracteres)
observabilityMode Uma indicação de como o ponto de dados deve ser mapeado para OpenTelemetry. 'counter'
'gauge'
'histogram'
'log'
'none'

Event

Name Description Value
capabilityId O caminho para a definição de tipo da capacidade (por exemplo, DTMI, OPC UA information model node id, etc.), por exemplo dtmi:com:example:Robot:_contents:__prop1;1. cadeia (de caracteres)
eventConfiguration JSON stringified que contém configuração específica do conector para o evento. Para OPC UA, isso pode incluir configurações como, publishingInterval, samplingInterval e queueSize. cadeia (de caracteres)
eventNotifier O endereço do notificador do evento no ativo (por exemplo, URL) para que um cliente possa acessar o evento no ativo. string (obrigatório)
name O nome do evento. cadeia (de caracteres)
observabilityMode Uma indicação de como o evento deve ser mapeado para OpenTelemetry. 'log'
'none'

ExtendedLocation

Name Description Value
name O nome do local estendido. string (obrigatório)
tipo O tipo de local estendido. string (obrigatório)

TrackedResourceTags

Name Description Value