Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Bicep-resursdefinition
Resurstypen tillgångar kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DeviceRegistry/assets-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.DeviceRegistry/assets@2024-11-01' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
assetEndpointProfileRef: 'string'
attributes: {
{customized property}: any(...)
}
datasets: [
{
dataPoints: [
{
dataPointConfiguration: 'string'
dataSource: 'string'
name: 'string'
observabilityMode: 'string'
}
]
datasetConfiguration: 'string'
name: 'string'
topic: {
path: 'string'
retain: 'string'
}
}
]
defaultDatasetsConfiguration: 'string'
defaultEventsConfiguration: 'string'
defaultTopic: {
path: 'string'
retain: 'string'
}
description: 'string'
discoveredAssetRefs: [
'string'
]
displayName: 'string'
documentationUri: 'string'
enabled: bool
events: [
{
eventConfiguration: 'string'
eventNotifier: 'string'
name: 'string'
observabilityMode: 'string'
topic: {
path: 'string'
retain: 'string'
}
}
]
externalAssetId: 'string'
hardwareRevision: 'string'
manufacturer: 'string'
manufacturerUri: 'string'
model: 'string'
productCode: 'string'
serialNumber: 'string'
softwareRevision: 'string'
}
tags: {
{customized property}: 'string'
}
}
Egenskapsvärden
TillgångEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
assetEndpointProfileRef | En referens till den tillgångsslutpunktsprofil (anslutningsinformation) som används av koordinatorer för att ansluta till en slutpunkt som tillhandahåller datapunkter för den här tillgången. Måste ange namnet på tillgångsslutpunktens profil. | sträng (krävs) |
Attribut | En uppsättning nyckel/värde-par som innehåller anpassade attribut som har angetts av kunden. | AssetPropertiesAttributes |
Datamängder | Matris med datauppsättningar som är en del av tillgången. Varje datauppsättning beskriver de datapunkter som utgör uppsättningen. | datauppsättning[] |
defaultDatasetsConfiguration | Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla datauppsättningar. Varje datauppsättning kan ha en egen konfiguration som åsidosätter standardinställningarna här. | sträng |
defaultEventsConfiguration | Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla händelser. Varje händelse kan ha en egen konfiguration som åsidosätter standardinställningarna här. | sträng |
defaultTopic | Objekt som beskriver standardämnesinformationen för tillgången. | Ämne |
beskrivning | Läsbar beskrivning av tillgången. | sträng |
discoveredAssetRefs | Referens till en lista över identifierade tillgångar. Fylls endast i om tillgången har skapats från identifieringsflödet. Identifierade tillgångsnamn måste anges. | string[] |
displayName | Visningsnamn som kan läsas av människor. | sträng |
documentationUri | Referens till dokumentationen. | sträng |
Aktiverat | Aktiverad/inaktiverad status för tillgången. | Bool |
evenemang | Matris med händelser som är en del av tillgången. Varje händelse kan ha konfiguration per händelse. | händelse[] |
externalAssetId | Tillgångs-ID som tillhandahålls av kunden. | sträng |
hardwareRevision | Revisionsnummer för maskinvaran. | sträng |
tillverkare | Namn på tillgångstillverkare. | sträng |
manufacturerUri | Tillgångstillverkarens URI. | sträng |
modell | Namn på tillgångsmodell. | sträng |
productCode | Tillgångsproduktkod. | sträng |
serialNumber | Tillgångsserienummer. | sträng |
softwareRevision | Revisionsnummer för programvaran. | sträng |
AssetPropertiesAttributes
Namn | Beskrivning | Värde |
---|
DataPoint
Namn | Beskrivning | Värde |
---|---|---|
dataPointConfiguration | Strängifierad JSON som innehåller anslutningsspecifik konfiguration för datapunkten. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize. | sträng |
dataSource | Adressen till datakällan i tillgången (t.ex. URL) så att en klient kan komma åt datakällan på tillgången. | sträng (krävs) |
Namn | Namnet på datapunkten. | sträng (krävs) |
observabilityMode | En indikation på hur datapunkten ska mappas till OpenTelemetry. | "Räknare" "Mätare" "Histogram" "Logg" "Ingen" |
Dataset
Namn | Beskrivning | Värde |
---|---|---|
dataPoints | Matris med datapunkter som ingår i datauppsättningen. Varje datapunkt kan ha konfiguration per datapunkt. | DataPoint[] |
datasetConfiguration | Strängifierad JSON som innehåller anslutningsspecifik JSON-sträng som beskriver konfigurationen för den specifika datauppsättningen. | sträng |
Namn | Namnet på datauppsättningen. | sträng (krävs) |
ämne | Objekt som beskriver ämnesinformationen för den specifika datauppsättningen. | Ämne |
Händelse
Namn | Beskrivning | Värde |
---|---|---|
eventConfiguration | Strängifierad JSON som innehåller anslutningsspecifik konfiguration för händelsen. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize. | sträng |
eventNotifier | Adressen till anmälaren för händelsen i tillgången (t.ex. URL) så att en klient kan komma åt händelsen på tillgången. | sträng (krävs) |
Namn | Namnet på händelsen. | sträng (krävs) |
observabilityMode | En indikation på hur händelsen ska mappas till OpenTelemetry. | "Logg" "Ingen" |
ämne | Objekt som beskriver ämnesinformationen för den specifika händelsen. | Ämne |
ExtendedLocation
Namn | Beskrivning | Värde |
---|---|---|
Namn | Namnet på den utökade platsen. | sträng (krävs) |
typ | Den utökade platstypen. | sträng (krävs) |
Microsoft.DeviceRegistry/assets
Namn | Beskrivning | Värde |
---|---|---|
extendedLocation | Den utökade platsen. | ExtendedLocation (krävs) |
plats | Den geo-plats där resursen finns | sträng (krävs) |
Namn | Resursnamnet | sträng Begränsningar: Min längd = 3 Max längd = 63 Mönster = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (krävs) |
Egenskaper | Resursspecifika egenskaper för den här resursen. | AssetProperties |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
Ämne
Namn | Beskrivning | Värde |
---|---|---|
stig | Ämnessökvägen för meddelanden som publicerats till en MQTT-asynkron meddelandekö. | sträng (krävs) |
behålla | När det är inställt på "Behåll" har meddelanden som publicerats till en MQTT-asynkron meddelandekö kvarhållningsflaggan inställd. Standard: "Aldrig". | "Behåll" "Aldrig" |
TrackedResourceTags
Namn | Beskrivning | Värde |
---|
Resursdefinition för ARM-mall
Resurstypen tillgångar kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DeviceRegistry/assets-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.DeviceRegistry/assets",
"apiVersion": "2024-11-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"assetEndpointProfileRef": "string",
"attributes": {
"{customized property}": {}
},
"datasets": [
{
"dataPoints": [
{
"dataPointConfiguration": "string",
"dataSource": "string",
"name": "string",
"observabilityMode": "string"
}
],
"datasetConfiguration": "string",
"name": "string",
"topic": {
"path": "string",
"retain": "string"
}
}
],
"defaultDatasetsConfiguration": "string",
"defaultEventsConfiguration": "string",
"defaultTopic": {
"path": "string",
"retain": "string"
},
"description": "string",
"discoveredAssetRefs": [ "string" ],
"displayName": "string",
"documentationUri": "string",
"enabled": "bool",
"events": [
{
"eventConfiguration": "string",
"eventNotifier": "string",
"name": "string",
"observabilityMode": "string",
"topic": {
"path": "string",
"retain": "string"
}
}
],
"externalAssetId": "string",
"hardwareRevision": "string",
"manufacturer": "string",
"manufacturerUri": "string",
"model": "string",
"productCode": "string",
"serialNumber": "string",
"softwareRevision": "string"
},
"tags": {
"{customized property}": "string"
}
}
Egenskapsvärden
TillgångEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
assetEndpointProfileRef | En referens till den tillgångsslutpunktsprofil (anslutningsinformation) som används av koordinatorer för att ansluta till en slutpunkt som tillhandahåller datapunkter för den här tillgången. Måste ange namnet på tillgångsslutpunktens profil. | sträng (krävs) |
Attribut | En uppsättning nyckel/värde-par som innehåller anpassade attribut som har angetts av kunden. | AssetPropertiesAttributes |
Datamängder | Matris med datauppsättningar som är en del av tillgången. Varje datauppsättning beskriver de datapunkter som utgör uppsättningen. | datauppsättning[] |
defaultDatasetsConfiguration | Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla datauppsättningar. Varje datauppsättning kan ha en egen konfiguration som åsidosätter standardinställningarna här. | sträng |
defaultEventsConfiguration | Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla händelser. Varje händelse kan ha en egen konfiguration som åsidosätter standardinställningarna här. | sträng |
defaultTopic | Objekt som beskriver standardämnesinformationen för tillgången. | Ämne |
beskrivning | Läsbar beskrivning av tillgången. | sträng |
discoveredAssetRefs | Referens till en lista över identifierade tillgångar. Fylls endast i om tillgången har skapats från identifieringsflödet. Identifierade tillgångsnamn måste anges. | string[] |
displayName | Visningsnamn som kan läsas av människor. | sträng |
documentationUri | Referens till dokumentationen. | sträng |
Aktiverat | Aktiverad/inaktiverad status för tillgången. | Bool |
evenemang | Matris med händelser som är en del av tillgången. Varje händelse kan ha konfiguration per händelse. | händelse[] |
externalAssetId | Tillgångs-ID som tillhandahålls av kunden. | sträng |
hardwareRevision | Revisionsnummer för maskinvaran. | sträng |
tillverkare | Namn på tillgångstillverkare. | sträng |
manufacturerUri | Tillgångstillverkarens URI. | sträng |
modell | Namn på tillgångsmodell. | sträng |
productCode | Tillgångsproduktkod. | sträng |
serialNumber | Tillgångsserienummer. | sträng |
softwareRevision | Revisionsnummer för programvaran. | sträng |
AssetPropertiesAttributes
Namn | Beskrivning | Värde |
---|
DataPoint
Namn | Beskrivning | Värde |
---|---|---|
dataPointConfiguration | Strängifierad JSON som innehåller anslutningsspecifik konfiguration för datapunkten. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize. | sträng |
dataSource | Adressen till datakällan i tillgången (t.ex. URL) så att en klient kan komma åt datakällan på tillgången. | sträng (krävs) |
Namn | Namnet på datapunkten. | sträng (krävs) |
observabilityMode | En indikation på hur datapunkten ska mappas till OpenTelemetry. | "Räknare" "Mätare" "Histogram" "Logg" "Ingen" |
Dataset
Namn | Beskrivning | Värde |
---|---|---|
dataPoints | Matris med datapunkter som ingår i datauppsättningen. Varje datapunkt kan ha konfiguration per datapunkt. | DataPoint[] |
datasetConfiguration | Strängifierad JSON som innehåller anslutningsspecifik JSON-sträng som beskriver konfigurationen för den specifika datauppsättningen. | sträng |
Namn | Namnet på datauppsättningen. | sträng (krävs) |
ämne | Objekt som beskriver ämnesinformationen för den specifika datauppsättningen. | Ämne |
Händelse
Namn | Beskrivning | Värde |
---|---|---|
eventConfiguration | Strängifierad JSON som innehåller anslutningsspecifik konfiguration för händelsen. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize. | sträng |
eventNotifier | Adressen till anmälaren för händelsen i tillgången (t.ex. URL) så att en klient kan komma åt händelsen på tillgången. | sträng (krävs) |
Namn | Namnet på händelsen. | sträng (krävs) |
observabilityMode | En indikation på hur händelsen ska mappas till OpenTelemetry. | "Logg" "Ingen" |
ämne | Objekt som beskriver ämnesinformationen för den specifika händelsen. | Ämne |
ExtendedLocation
Namn | Beskrivning | Värde |
---|---|---|
Namn | Namnet på den utökade platsen. | sträng (krävs) |
typ | Den utökade platstypen. | sträng (krävs) |
Microsoft.DeviceRegistry/assets
Namn | Beskrivning | Värde |
---|---|---|
apiVersion | API-versionen | '2024-11-01' |
extendedLocation | Den utökade platsen. | ExtendedLocation (krävs) |
plats | Den geo-plats där resursen finns | sträng (krävs) |
Namn | Resursnamnet | sträng Begränsningar: Min längd = 3 Max längd = 63 Mönster = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (krävs) |
Egenskaper | Resursspecifika egenskaper för den här resursen. | AssetProperties |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. Se taggar i mallar |
typ | Resurstypen | "Microsoft.DeviceRegistry/assets" |
Ämne
Namn | Beskrivning | Värde |
---|---|---|
stig | Ämnessökvägen för meddelanden som publicerats till en MQTT-asynkron meddelandekö. | sträng (krävs) |
behålla | När det är inställt på "Behåll" har meddelanden som publicerats till en MQTT-asynkron meddelandekö kvarhållningsflaggan inställd. Standard: "Aldrig". | "Behåll" "Aldrig" |
TrackedResourceTags
Namn | Beskrivning | Värde |
---|
Användningsexempel
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tillgångar kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.DeviceRegistry/assets-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DeviceRegistry/assets@2024-11-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
assetEndpointProfileRef = "string"
attributes = {
{customized property} = ?
}
datasets = [
{
dataPoints = [
{
dataPointConfiguration = "string"
dataSource = "string"
name = "string"
observabilityMode = "string"
}
]
datasetConfiguration = "string"
name = "string"
topic = {
path = "string"
retain = "string"
}
}
]
defaultDatasetsConfiguration = "string"
defaultEventsConfiguration = "string"
defaultTopic = {
path = "string"
retain = "string"
}
description = "string"
discoveredAssetRefs = [
"string"
]
displayName = "string"
documentationUri = "string"
enabled = bool
events = [
{
eventConfiguration = "string"
eventNotifier = "string"
name = "string"
observabilityMode = "string"
topic = {
path = "string"
retain = "string"
}
}
]
externalAssetId = "string"
hardwareRevision = "string"
manufacturer = "string"
manufacturerUri = "string"
model = "string"
productCode = "string"
serialNumber = "string"
softwareRevision = "string"
}
}
}
Egenskapsvärden
TillgångEgenskaper
Namn | Beskrivning | Värde |
---|---|---|
assetEndpointProfileRef | En referens till den tillgångsslutpunktsprofil (anslutningsinformation) som används av koordinatorer för att ansluta till en slutpunkt som tillhandahåller datapunkter för den här tillgången. Måste ange namnet på tillgångsslutpunktens profil. | sträng (krävs) |
Attribut | En uppsättning nyckel/värde-par som innehåller anpassade attribut som har angetts av kunden. | AssetPropertiesAttributes |
Datamängder | Matris med datauppsättningar som är en del av tillgången. Varje datauppsättning beskriver de datapunkter som utgör uppsättningen. | datauppsättning[] |
defaultDatasetsConfiguration | Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla datauppsättningar. Varje datauppsättning kan ha en egen konfiguration som åsidosätter standardinställningarna här. | sträng |
defaultEventsConfiguration | Strängifierad JSON som innehåller anslutningsspecifik standardkonfiguration för alla händelser. Varje händelse kan ha en egen konfiguration som åsidosätter standardinställningarna här. | sträng |
defaultTopic | Objekt som beskriver standardämnesinformationen för tillgången. | Ämne |
beskrivning | Läsbar beskrivning av tillgången. | sträng |
discoveredAssetRefs | Referens till en lista över identifierade tillgångar. Fylls endast i om tillgången har skapats från identifieringsflödet. Identifierade tillgångsnamn måste anges. | string[] |
displayName | Visningsnamn som kan läsas av människor. | sträng |
documentationUri | Referens till dokumentationen. | sträng |
Aktiverat | Aktiverad/inaktiverad status för tillgången. | Bool |
evenemang | Matris med händelser som är en del av tillgången. Varje händelse kan ha konfiguration per händelse. | händelse[] |
externalAssetId | Tillgångs-ID som tillhandahålls av kunden. | sträng |
hardwareRevision | Revisionsnummer för maskinvaran. | sträng |
tillverkare | Namn på tillgångstillverkare. | sträng |
manufacturerUri | Tillgångstillverkarens URI. | sträng |
modell | Namn på tillgångsmodell. | sträng |
productCode | Tillgångsproduktkod. | sträng |
serialNumber | Tillgångsserienummer. | sträng |
softwareRevision | Revisionsnummer för programvaran. | sträng |
AssetPropertiesAttributes
Namn | Beskrivning | Värde |
---|
DataPoint
Namn | Beskrivning | Värde |
---|---|---|
dataPointConfiguration | Strängifierad JSON som innehåller anslutningsspecifik konfiguration för datapunkten. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize. | sträng |
dataSource | Adressen till datakällan i tillgången (t.ex. URL) så att en klient kan komma åt datakällan på tillgången. | sträng (krävs) |
Namn | Namnet på datapunkten. | sträng (krävs) |
observabilityMode | En indikation på hur datapunkten ska mappas till OpenTelemetry. | "Räknare" "Mätare" "Histogram" "Logg" "Ingen" |
Dataset
Namn | Beskrivning | Värde |
---|---|---|
dataPoints | Matris med datapunkter som ingår i datauppsättningen. Varje datapunkt kan ha konfiguration per datapunkt. | DataPoint[] |
datasetConfiguration | Strängifierad JSON som innehåller anslutningsspecifik JSON-sträng som beskriver konfigurationen för den specifika datauppsättningen. | sträng |
Namn | Namnet på datauppsättningen. | sträng (krävs) |
ämne | Objekt som beskriver ämnesinformationen för den specifika datauppsättningen. | Ämne |
Händelse
Namn | Beskrivning | Värde |
---|---|---|
eventConfiguration | Strängifierad JSON som innehåller anslutningsspecifik konfiguration för händelsen. För OPC UA kan detta omfatta konfiguration som publishingInterval, samplingInterval och queueSize. | sträng |
eventNotifier | Adressen till anmälaren för händelsen i tillgången (t.ex. URL) så att en klient kan komma åt händelsen på tillgången. | sträng (krävs) |
Namn | Namnet på händelsen. | sträng (krävs) |
observabilityMode | En indikation på hur händelsen ska mappas till OpenTelemetry. | "Logg" "Ingen" |
ämne | Objekt som beskriver ämnesinformationen för den specifika händelsen. | Ämne |
ExtendedLocation
Namn | Beskrivning | Värde |
---|---|---|
Namn | Namnet på den utökade platsen. | sträng (krävs) |
typ | Den utökade platstypen. | sträng (krävs) |
Microsoft.DeviceRegistry/assets
Namn | Beskrivning | Värde |
---|---|---|
extendedLocation | Den utökade platsen. | ExtendedLocation (krävs) |
plats | Den geo-plats där resursen finns | sträng (krävs) |
Namn | Resursnamnet | sträng Begränsningar: Min längd = 3 Max längd = 63 Mönster = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (krävs) |
Egenskaper | Resursspecifika egenskaper för den här resursen. | AssetProperties |
Taggar | Resurstaggar | Ordlista med taggnamn och värden. |
typ | Resurstypen | "Microsoft.DeviceRegistry/assets@2024-11-01" |
Ämne
Namn | Beskrivning | Värde |
---|---|---|
stig | Ämnessökvägen för meddelanden som publicerats till en MQTT-asynkron meddelandekö. | sträng (krävs) |
behålla | När det är inställt på "Behåll" har meddelanden som publicerats till en MQTT-asynkron meddelandekö kvarhållningsflaggan inställd. Standard: "Aldrig". | "Behåll" "Aldrig" |
TrackedResourceTags
Namn | Beskrivning | Värde |
---|