Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Definicja zasobu Bicepsa
Typ zasobu zasobów można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby stworzyć zasób Microsoft.DeviceRegistry/assets, dodaj do szablonu następujący Bicep.
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'
}
}
Wartości właściwości
Microsoft.DeviceRegistry/assets
| Name | Description | Value |
|---|---|---|
| extendedLocation | Lokalizacja rozszerzona. | ExtendedLocation (wymagane) |
| lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| name | Nazwa zasobu | string Constraints: Minimalna długość = 3 Maksymalna długość = 63 Wzorzec = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (wymagane) |
| properties | Właściwości specyficzne dla zasobu dla tego zasobu. | AssetProperties |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
AssetProperties
| Name | Description | Value |
|---|---|---|
| assetEndpointProfileUri | Odwołanie do profilu punktu końcowego zasobu (informacje o połączeniu) używanego przez brokerów do nawiązywania połączenia z punktem końcowym, który udostępnia punkty danych dla tego zasobu. Musi mieć format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. | ciąg (wymagany) |
| assetType | Ścieżka zasobu do definicji typu zasobu (modelu). | ciąg |
| attributes | Zestaw par klucz-wartość, które zawierają atrybuty niestandardowe ustawione przez klienta. | AssetPropertiesAttributes |
| dataPoints | Tablica punktów danych, które są częścią zasobu. Każdy punkt danych może odwoływać się do możliwości typu zasobu i mieć konfigurację punktu danych. | DataPoint[] |
| defaultDataPointsConfiguration | Ciągowany kod JSON zawierający domyślną konfigurację specyficzną dla protokołu dla wszystkich punktów danych. Każdy punkt danych może mieć własną konfigurację, która zastępuje ustawienia domyślne w tym miejscu. | ciąg |
| defaultEventsConfiguration | Ciągowany kod JSON zawierający domyślną konfigurację specyficzną dla łącznika dla wszystkich zdarzeń. Każde zdarzenie może mieć własną konfigurację, która zastępuje ustawienia domyślne w tym miejscu. | ciąg |
| description | Czytelny dla człowieka opis zasobu. | ciąg |
| displayName | Czytelna dla człowieka nazwa wyświetlana. | ciąg |
| documentationUri | Dokumentacja. | ciąg |
| enabled | Stan włączone/wyłączone elementu zawartości. | bool |
| events | Tablica zdarzeń, które są częścią zasobu. Każde zdarzenie może mieć konfigurację poszczególnych zdarzeń. | Event[] |
| externalAssetId | Identyfikator zasobu dostarczony przez klienta. | ciąg |
| hardwareRevision | Numer poprawki sprzętu. | ciąg |
| producent | Nazwa producenta zasobów. | ciąg |
| manufacturerUri | Identyfikator URI producenta zasobów. | ciąg |
| model | Nazwa modelu zasobów. | ciąg |
| productCode | Kod produktu zawartości. | ciąg |
| serialNumber | Numer seryjny elementu zawartości. | ciąg |
| softwareRevision | Numer poprawki oprogramowania. | ciąg |
AssetPropertiesAttributes
| Name | Description | Value |
|---|
DataPoint
| Name | Description | Value |
|---|---|---|
| capabilityId | Ścieżka do definicji typu możliwości (np. DTMI, identyfikator węzła modelu informacyjnego OPC UA itp.), na przykład dtmi:com:example:Robot:_contents:__prop1;1. | ciąg |
| dataPointConfiguration | Ciągowany kod JSON zawierający konfigurację specyficzną dla łącznika dla punktu danych. W przypadku OPC UA może to obejmować konfigurację, taką jak publishingInterval, samplingInterval i queueSize. | ciąg |
| dataSource | Adres źródła danych w zasobie (np. adres URL), aby klient mógł uzyskać dostęp do źródła danych w zasobie. | ciąg (wymagany) |
| name | Nazwa punktu danych. | ciąg |
| observabilityMode | Wskazanie sposobu mapowania punktu danych na metrykę OpenTelemetry. | 'counter' 'gauge' 'histogram' 'log' 'none' |
Event
| Name | Description | Value |
|---|---|---|
| capabilityId | Ścieżka do definicji typu możliwości (np. DTMI, identyfikator węzła modelu informacyjnego OPC UA itp.), na przykład dtmi:com:example:Robot:_contents:__prop1;1. | ciąg |
| eventConfiguration | Ciągowany kod JSON zawierający konfigurację specyficzną dla łącznika dla zdarzenia. W przypadku OPC UA może to obejmować konfigurację, taką jak publishingInterval, samplingInterval i queueSize. | ciąg |
| eventNotifier | Adres powiadomienia o zdarzeniu w zasobie (np. adres URL), aby klient mógł uzyskać dostęp do zdarzenia w zasobie. | ciąg (wymagany) |
| name | Nazwa zdarzenia. | ciąg |
| observabilityMode | Wskazanie, jak zdarzenie powinno być mapowane na bibliotekę OpenTelemetry. | 'log' 'none' |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | Nazwa lokalizacji rozszerzonej. | ciąg (wymagany) |
| typ | Typ lokalizacji rozszerzonej. | ciąg (wymagany) |
TrackedResourceTags
| Name | Description | Value |
|---|
Definicja zasobu szablonu usługi ARM
Typ zasobu zasobów można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów – Zobacz polecenia wdrożenia grup zasobów Aby uzyskać listę zmienionych właściwości w każdej wersji API, zobacz log zmian.
Przykłady użycia
Format zasobu
Aby utworzyć zasób Microsoft.DeviceRegistry/assets, dodaj następujący kod JSON do szablonu.
{
"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"
}
}
Wartości właściwości
Microsoft.DeviceRegistry/assets
| Name | Description | Value |
|---|---|---|
| apiVersion | Wersja interfejsu API | '2023-11-01-preview' |
| extendedLocation | Lokalizacja rozszerzona. | ExtendedLocation (wymagane) |
| lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| name | Nazwa zasobu | string Constraints: Minimalna długość = 3 Maksymalna długość = 63 Wzorzec = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (wymagane) |
| properties | Właściwości specyficzne dla zasobu dla tego zasobu. | AssetProperties |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. Zobacz tagi w szablonach |
| typ | Typ zasobu | 'Microsoft.DeviceRegistry/assets' |
AssetProperties
| Name | Description | Value |
|---|---|---|
| assetEndpointProfileUri | Odwołanie do profilu punktu końcowego zasobu (informacje o połączeniu) używanego przez brokerów do nawiązywania połączenia z punktem końcowym, który udostępnia punkty danych dla tego zasobu. Musi mieć format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. | ciąg (wymagany) |
| assetType | Ścieżka zasobu do definicji typu zasobu (modelu). | ciąg |
| attributes | Zestaw par klucz-wartość, które zawierają atrybuty niestandardowe ustawione przez klienta. | AssetPropertiesAttributes |
| dataPoints | Tablica punktów danych, które są częścią zasobu. Każdy punkt danych może odwoływać się do możliwości typu zasobu i mieć konfigurację punktu danych. | DataPoint[] |
| defaultDataPointsConfiguration | Ciągowany kod JSON zawierający domyślną konfigurację specyficzną dla protokołu dla wszystkich punktów danych. Każdy punkt danych może mieć własną konfigurację, która zastępuje ustawienia domyślne w tym miejscu. | ciąg |
| defaultEventsConfiguration | Ciągowany kod JSON zawierający domyślną konfigurację specyficzną dla łącznika dla wszystkich zdarzeń. Każde zdarzenie może mieć własną konfigurację, która zastępuje ustawienia domyślne w tym miejscu. | ciąg |
| description | Czytelny dla człowieka opis zasobu. | ciąg |
| displayName | Czytelna dla człowieka nazwa wyświetlana. | ciąg |
| documentationUri | Dokumentacja. | ciąg |
| enabled | Stan włączone/wyłączone elementu zawartości. | bool |
| events | Tablica zdarzeń, które są częścią zasobu. Każde zdarzenie może mieć konfigurację poszczególnych zdarzeń. | Event[] |
| externalAssetId | Identyfikator zasobu dostarczony przez klienta. | ciąg |
| hardwareRevision | Numer poprawki sprzętu. | ciąg |
| producent | Nazwa producenta zasobów. | ciąg |
| manufacturerUri | Identyfikator URI producenta zasobów. | ciąg |
| model | Nazwa modelu zasobów. | ciąg |
| productCode | Kod produktu zawartości. | ciąg |
| serialNumber | Numer seryjny elementu zawartości. | ciąg |
| softwareRevision | Numer poprawki oprogramowania. | ciąg |
AssetPropertiesAttributes
| Name | Description | Value |
|---|
DataPoint
| Name | Description | Value |
|---|---|---|
| capabilityId | Ścieżka do definicji typu możliwości (np. DTMI, identyfikator węzła modelu informacyjnego OPC UA itp.), na przykład dtmi:com:example:Robot:_contents:__prop1;1. | ciąg |
| dataPointConfiguration | Ciągowany kod JSON zawierający konfigurację specyficzną dla łącznika dla punktu danych. W przypadku OPC UA może to obejmować konfigurację, taką jak publishingInterval, samplingInterval i queueSize. | ciąg |
| dataSource | Adres źródła danych w zasobie (np. adres URL), aby klient mógł uzyskać dostęp do źródła danych w zasobie. | ciąg (wymagany) |
| name | Nazwa punktu danych. | ciąg |
| observabilityMode | Wskazanie sposobu mapowania punktu danych na metrykę OpenTelemetry. | 'counter' 'gauge' 'histogram' 'log' 'none' |
Event
| Name | Description | Value |
|---|---|---|
| capabilityId | Ścieżka do definicji typu możliwości (np. DTMI, identyfikator węzła modelu informacyjnego OPC UA itp.), na przykład dtmi:com:example:Robot:_contents:__prop1;1. | ciąg |
| eventConfiguration | Ciągowany kod JSON zawierający konfigurację specyficzną dla łącznika dla zdarzenia. W przypadku OPC UA może to obejmować konfigurację, taką jak publishingInterval, samplingInterval i queueSize. | ciąg |
| eventNotifier | Adres powiadomienia o zdarzeniu w zasobie (np. adres URL), aby klient mógł uzyskać dostęp do zdarzenia w zasobie. | ciąg (wymagany) |
| name | Nazwa zdarzenia. | ciąg |
| observabilityMode | Wskazanie, jak zdarzenie powinno być mapowane na bibliotekę OpenTelemetry. | 'log' 'none' |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | Nazwa lokalizacji rozszerzonej. | ciąg (wymagany) |
| typ | Typ lokalizacji rozszerzonej. | ciąg (wymagany) |
TrackedResourceTags
| Name | Description | Value |
|---|
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu zasobów można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów Listę zmienionych właściwości w każdej wersji API można znaleźć w dzienniku zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DeviceRegistry/assets, dodaj następujący program Terraform do szablonu.
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"
}
}
}
Wartości właściwości
Microsoft.DeviceRegistry/assets
| Name | Description | Value |
|---|---|---|
| extendedLocation | Lokalizacja rozszerzona. | ExtendedLocation (wymagane) |
| lokalizacja | Lokalizacja geograficzna, w której znajduje się zasób | ciąg (wymagany) |
| name | Nazwa zasobu | string Constraints: Minimalna długość = 3 Maksymalna długość = 63 Wzorzec = ^[a-z0-9][a-z0-9-]*[a-z0-9]$ (wymagane) |
| properties | Właściwości specyficzne dla zasobu dla tego zasobu. | AssetProperties |
| tags | Tagi zasobów | Słownik nazw tagów i wartości. |
| typ | Typ zasobu | "Microsoft.DeviceRegistry/assets@2023-11-01-preview" |
AssetProperties
| Name | Description | Value |
|---|---|---|
| assetEndpointProfileUri | Odwołanie do profilu punktu końcowego zasobu (informacje o połączeniu) używanego przez brokerów do nawiązywania połączenia z punktem końcowym, który udostępnia punkty danych dla tego zasobu. Musi mieć format <ModuleCR.metadata.namespace>/<ModuleCR.metadata.name>. | ciąg (wymagany) |
| assetType | Ścieżka zasobu do definicji typu zasobu (modelu). | ciąg |
| attributes | Zestaw par klucz-wartość, które zawierają atrybuty niestandardowe ustawione przez klienta. | AssetPropertiesAttributes |
| dataPoints | Tablica punktów danych, które są częścią zasobu. Każdy punkt danych może odwoływać się do możliwości typu zasobu i mieć konfigurację punktu danych. | DataPoint[] |
| defaultDataPointsConfiguration | Ciągowany kod JSON zawierający domyślną konfigurację specyficzną dla protokołu dla wszystkich punktów danych. Każdy punkt danych może mieć własną konfigurację, która zastępuje ustawienia domyślne w tym miejscu. | ciąg |
| defaultEventsConfiguration | Ciągowany kod JSON zawierający domyślną konfigurację specyficzną dla łącznika dla wszystkich zdarzeń. Każde zdarzenie może mieć własną konfigurację, która zastępuje ustawienia domyślne w tym miejscu. | ciąg |
| description | Czytelny dla człowieka opis zasobu. | ciąg |
| displayName | Czytelna dla człowieka nazwa wyświetlana. | ciąg |
| documentationUri | Dokumentacja. | ciąg |
| enabled | Stan włączone/wyłączone elementu zawartości. | bool |
| events | Tablica zdarzeń, które są częścią zasobu. Każde zdarzenie może mieć konfigurację poszczególnych zdarzeń. | Event[] |
| externalAssetId | Identyfikator zasobu dostarczony przez klienta. | ciąg |
| hardwareRevision | Numer poprawki sprzętu. | ciąg |
| producent | Nazwa producenta zasobów. | ciąg |
| manufacturerUri | Identyfikator URI producenta zasobów. | ciąg |
| model | Nazwa modelu zasobów. | ciąg |
| productCode | Kod produktu zawartości. | ciąg |
| serialNumber | Numer seryjny elementu zawartości. | ciąg |
| softwareRevision | Numer poprawki oprogramowania. | ciąg |
AssetPropertiesAttributes
| Name | Description | Value |
|---|
DataPoint
| Name | Description | Value |
|---|---|---|
| capabilityId | Ścieżka do definicji typu możliwości (np. DTMI, identyfikator węzła modelu informacyjnego OPC UA itp.), na przykład dtmi:com:example:Robot:_contents:__prop1;1. | ciąg |
| dataPointConfiguration | Ciągowany kod JSON zawierający konfigurację specyficzną dla łącznika dla punktu danych. W przypadku OPC UA może to obejmować konfigurację, taką jak publishingInterval, samplingInterval i queueSize. | ciąg |
| dataSource | Adres źródła danych w zasobie (np. adres URL), aby klient mógł uzyskać dostęp do źródła danych w zasobie. | ciąg (wymagany) |
| name | Nazwa punktu danych. | ciąg |
| observabilityMode | Wskazanie sposobu mapowania punktu danych na metrykę OpenTelemetry. | 'counter' 'gauge' 'histogram' 'log' 'none' |
Event
| Name | Description | Value |
|---|---|---|
| capabilityId | Ścieżka do definicji typu możliwości (np. DTMI, identyfikator węzła modelu informacyjnego OPC UA itp.), na przykład dtmi:com:example:Robot:_contents:__prop1;1. | ciąg |
| eventConfiguration | Ciągowany kod JSON zawierający konfigurację specyficzną dla łącznika dla zdarzenia. W przypadku OPC UA może to obejmować konfigurację, taką jak publishingInterval, samplingInterval i queueSize. | ciąg |
| eventNotifier | Adres powiadomienia o zdarzeniu w zasobie (np. adres URL), aby klient mógł uzyskać dostęp do zdarzenia w zasobie. | ciąg (wymagany) |
| name | Nazwa zdarzenia. | ciąg |
| observabilityMode | Wskazanie, jak zdarzenie powinno być mapowane na bibliotekę OpenTelemetry. | 'log' 'none' |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | Nazwa lokalizacji rozszerzonej. | ciąg (wymagany) |
| typ | Typ lokalizacji rozszerzonej. | ciąg (wymagany) |
TrackedResourceTags
| Name | Description | Value |
|---|