Microsoft.Devices provisioningServices 2022-02-05
Definicja zasobu Bicep
Typ zasobu provisioningServices można wdrożyć z operacjami docelowymi:
- 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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Devices/provisioningServices, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.Devices/provisioningServices@2022-02-05' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'S1'
}
etag: 'string'
properties: {
allocationPolicy: 'string'
authorizationPolicies: [
{
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
keyName: 'string'
primaryKey: 'string'
rights: 'string'
secondaryKey: 'string'
}
]
enableDataResidency: bool
iotHubs: [
{
allocationWeight: int
applyAllocationPolicy: bool
connectionString: 'string'
location: 'string'
}
]
ipFilterRules: [
{
action: 'string'
filterName: 'string'
ipMask: 'string'
target: 'string'
}
]
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
provisioningState: 'string'
publicNetworkAccess: 'string'
state: 'string'
}
}
Wartości właściwości
provisioningServices
Nazwa | Opis | Wartość |
---|---|---|
name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 3–64 Prawidłowe znaki: Alfanumeryczne i łączniki. Koniec z alfanumerycznym. |
location | Lokalizacja zasobu. | ciąg (wymagany) |
tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
sku | Informacje o jednostce SKU dla usługi aprowizacji. | IotDpsSkuInfo (wymagane) |
Etag | Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag. | ciąg |
properties | Właściwości specyficzne dla usługi aprowizacji | IotDpsPropertiesDescription (wymagane) |
IotDpsPropertiesDescription
Nazwa | Opis | Wartość |
---|---|---|
allocationPolicy | Zasady alokacji, które mają być używane przez tę usługę aprowizacji. | "GeoLatency" "Skrót" "Statyczny" |
authorizationPolicies | Lista kluczy autoryzacji dla usługi aprowizacji. | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | Opcjonalny. Wskazuje, czy wystąpienie usługi DPS Data Residency włączone, usunięcie odzyskiwania po awarii między parami geograficznymi. |
bool |
iotHubs | Lista centrów IoT skojarzonych z tą usługą aprowizacji. | IotHubDefinitionDescription[] |
ipFilterRules | Reguły filtrowania adresów IP. | IpFilterRule[] |
privateEndpointConnections | Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub | PrivateEndpointConnection[] |
provisioningState | Stan aprowizacji usługi ARM dla usługi aprowizacji. | ciąg |
publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" |
stan | Bieżący stan usługi aprowizacji. | "Aktywowanie" "ActivationFailed" "Aktywny" "Usunięte" "Usuwanie" "DeletionFailed" "Tryb failOver" "Tryb failoverFailed" "Wznawianie" "Zawieszone" "Wstrzymanie" "Przenoszenie" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
Nazwa | Opis | Wartość |
---|---|---|
keyName | Nazwa klucza. | ciąg (wymagany) |
primaryKey | Podstawowa wartość klucza sygnatury dostępu współdzielonego. | ciąg |
Prawa | Prawa, które ma ten klucz. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane) |
secondaryKey | Wartość pomocniczego klucza sygnatury dostępu współdzielonego. | ciąg |
keyName | Nazwa klucza. | ciąg (wymagany) |
primaryKey | Podstawowa wartość klucza sygnatury dostępu współdzielonego. | ciąg |
Prawa | Prawa, które ma ten klucz. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane) |
secondaryKey | Wartość pomocniczego klucza sygnatury dostępu współdzielonego. | ciąg |
IotHubDefinitionDescription
Nazwa | Opis | Wartość |
---|---|---|
allocationWeight | wagi do ubiegania się o daną iot h. | int |
applyAllocationPolicy | flaga stosowania właściwości allocationPolicy lub nie dla danego centrum iot. | bool |
Parametry połączenia | Parametry połączenia centrum IoT. | ciąg (wymagany) |
location | Region usługi ARM centrum IoT. | ciąg (wymagany) |
IpFilterRule
Nazwa | Opis | Wartość |
---|---|---|
action | Żądana akcja żądań przechwyconych przez tę regułę. | "Akceptuj" "Odrzuć" (wymagane) |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
Docelowego | Element docelowy dla żądań przechwyconych przez tę regułę. | "wszystko" "deviceApi" "serviceApi" |
PrivateEndpointConnection
Nazwa | Opis | Wartość |
---|---|---|
properties | Właściwości połączenia prywatnego punktu końcowego | PrivateEndpointConnectionProperties (wymagane) |
PrivateEndpointConnectionProperties
Nazwa | Opis | Wartość |
---|---|---|
privateEndpoint | Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego | PrivateEndpoint |
privateLinkServiceConnectionState | Bieżący stan połączenia prywatnego punktu końcowego | PrivateLinkServiceConnectionState (wymagane) |
PrivateEndpoint
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
PrivateLinkServiceConnectionState
Nazwa | Opis | Wartość |
---|---|---|
actionsRequired | Akcje wymagane dla połączenia prywatnego punktu końcowego | ciąg |
description (opis) | Opis bieżącego stanu połączenia prywatnego punktu końcowego | ciąg (wymagany) |
status | Stan połączenia prywatnego punktu końcowego | "Zatwierdzone" "Rozłączone" "Oczekujące" "Odrzucono" (wymagane) |
IotDpsSkuInfo
Nazwa | Opis | Wartość |
---|---|---|
capacity | Liczba jednostek do aprowizowania | int |
name | Nazwa jednostki SKU. | "S1" |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | Opis |
---|---|
Tworzenie symulatora usługi IOT Hub i ubuntu edge |
Ten szablon tworzy symulator usługi IOT Hub i maszyny wirtualnej Ubuntu edge. |
Tworzenie usługi IoT Hub Device Provisioning Service |
Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Oraz połączenie tych dwóch usług. |
Definicja zasobu szablonu usługi ARM
Typ zasobu provisioningServices 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 dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Devices/provisioningServices, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.Devices/provisioningServices",
"apiVersion": "2022-02-05",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "S1"
},
"etag": "string",
"properties": {
"allocationPolicy": "string",
"authorizationPolicies": [
{
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string",
"keyName": "string",
"primaryKey": "string",
"rights": "string",
"secondaryKey": "string"
}
],
"enableDataResidency": "bool",
"iotHubs": [
{
"allocationWeight": "int",
"applyAllocationPolicy": "bool",
"connectionString": "string",
"location": "string"
}
],
"ipFilterRules": [
{
"action": "string",
"filterName": "string",
"ipMask": "string",
"target": "string"
}
],
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"provisioningState": "string",
"publicNetworkAccess": "string",
"state": "string"
}
}
Wartości właściwości
provisioningServices
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.Devices/provisioningServices" |
apiVersion | Wersja interfejsu API zasobów | '2022-02-05' |
name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 3–64 Prawidłowe znaki: Alfanumeryczne i łączniki. Koniec z alfanumerycznym. |
location | Lokalizacja zasobu. | ciąg (wymagany) |
tags | Tagi zasobów. | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
sku | Informacje o jednostce SKU dla usługi aprowizacji. | IotDpsSkuInfo (wymagane) |
Etag | Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag. | ciąg |
properties | Właściwości specyficzne dla usługi aprowizacji | IotDpsPropertiesDescription (wymagane) |
IotDpsPropertiesDescription
Nazwa | Opis | Wartość |
---|---|---|
allocationPolicy | Zasady alokacji, które mają być używane przez tę usługę aprowizacji. | "GeoLatency" "Skrót" "Statyczny" |
authorizationPolicies | Lista kluczy autoryzacji dla usługi aprowizacji. | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | Opcjonalny. Wskazuje, czy wystąpienie usługi DPS Data Residency włączone, usunięcie odzyskiwania po awarii między parami geograficznymi. |
bool |
iotHubs | Lista centrów IoT skojarzonych z tą usługą aprowizacji. | IotHubDefinitionDescription[] |
ipFilterRules | Reguły filtrowania adresów IP. | IpFilterRule[] |
privateEndpointConnections | Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub | PrivateEndpointConnection[] |
provisioningState | Stan aprowizacji usługi ARM usługi aprowizacji. | ciąg |
publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" |
stan | Bieżący stan usługi aprowizacji. | "Aktywowanie" "ActivationFailed" "Aktywny" "Usunięte" "Usuwanie" "DeletionFailed" "Tryb failOver" "Tryb failoverFailed" "Wznawianie" "Zawieszone" "Wstrzymanie" "Przejście" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
Nazwa | Opis | Wartość |
---|---|---|
keyName | Nazwa klucza. | ciąg (wymagany) |
primaryKey | Podstawowa wartość klucza sygnatury dostępu współdzielonego. | ciąg |
Prawa | Prawa, które ma ten klucz. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane) |
secondaryKey | Wartość klucza pomocniczego sygnatury dostępu współdzielonego. | ciąg |
keyName | Nazwa klucza. | ciąg (wymagany) |
primaryKey | Podstawowa wartość klucza sygnatury dostępu współdzielonego. | ciąg |
Prawa | Prawa, które ma ten klucz. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagane) |
secondaryKey | Wartość klucza pomocniczego sygnatury dostępu współdzielonego. | ciąg |
IotHubDefinitionDescription
Nazwa | Opis | Wartość |
---|---|---|
alokacja wagi | waga do ubiegania się o daną iot h. | int |
applyAllocationPolicy | flaga stosowania alokacjiPolicy lub nie dla danego centrum iot. | bool |
Parametry połączenia | Parametry połączenia centrum IoT. | ciąg (wymagany) |
location | Region usługi ARM centrum IoT. | ciąg (wymagany) |
IpFilterRule
Nazwa | Opis | Wartość |
---|---|---|
action | Żądana akcja żądań przechwyconych przez tę regułę. | "Akceptuj" "Odrzuć" (wymagane) |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
Docelowego | Cel dla żądań przechwyconych przez tę regułę. | "wszystko" "deviceApi" "serviceApi" |
PrivateEndpointConnection
Nazwa | Opis | Wartość |
---|---|---|
properties | Właściwości połączenia prywatnego punktu końcowego | PrivateEndpointConnectionProperties (wymagane) |
PrivateEndpointConnectionProperties
Nazwa | Opis | Wartość |
---|---|---|
privateEndpoint | Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego | PrivateEndpoint |
privateLinkServiceConnectionState | Bieżący stan połączenia prywatnego punktu końcowego | PrivateLinkServiceConnectionState (wymagane) |
PrivateEndpoint
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
PrivateLinkServiceConnectionState
Nazwa | Opis | Wartość |
---|---|---|
actionsRequired | Akcje wymagane dla połączenia prywatnego punktu końcowego | ciąg |
description (opis) | Opis bieżącego stanu połączenia prywatnego punktu końcowego | ciąg (wymagany) |
status | Stan połączenia prywatnego punktu końcowego | "Zatwierdzone" "Rozłączone" "Oczekujące" "Odrzucono" (wymagane) |
IotDpsSkuInfo
Nazwa | Opis | Wartość |
---|---|---|
capacity | Liczba jednostek do aprowizowania | int |
name | Nazwa jednostki SKU. | "S1" |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
Template | Opis |
---|---|
Tworzenie symulatora usługi IOT Hub i ubuntu edge |
Ten szablon tworzy symulator usługi IOT Hub i maszyny wirtualnej Ubuntu edge. |
Tworzenie usługi IoT Hub Device Provisioning Service |
Ten szablon umożliwia utworzenie centrum IoT i usługi IoT Hub Device Provisioning Oraz połączenie tych dwóch usług. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu provisioningServices można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.Devices/provisioningServices, dodaj następujące narzędzie Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/provisioningServices@2022-02-05"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
allocationPolicy = "string"
authorizationPolicies = [
{
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
keyName = "string"
primaryKey = "string"
rights = "string"
secondaryKey = "string"
}
]
enableDataResidency = bool
iotHubs = [
{
allocationWeight = int
applyAllocationPolicy = bool
connectionString = "string"
location = "string"
}
]
ipFilterRules = [
{
action = "string"
filterName = "string"
ipMask = "string"
target = "string"
}
]
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
provisioningState = "string"
publicNetworkAccess = "string"
state = "string"
}
sku = {
capacity = int
name = "S1"
}
etag = "string"
})
}
Wartości właściwości
provisioningServices
Nazwa | Opis | Wartość |
---|---|---|
typ | Typ zasobu | "Microsoft.Devices/provisioningServices@2022-02-05" |
name | Nazwa zasobu | ciąg (wymagany) Limit znaków: 3–64 Prawidłowe znaki: Alfanumeryczne i łączniki. Koniec z alfanumerycznym. |
location | Lokalizacja zasobu. | ciąg (wymagany) |
parent_id | Aby wdrożyć w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
tags | Tagi zasobów. | Słownik nazw tagów i wartości. |
sku | Informacje o jednostce SKU dla usługi aprowizacji. | IotDpsSkuInfo (wymagane) |
Etag | Pole Etag nie jest wymagane. Jeśli jest on podany w treści odpowiedzi, musi być również podany jako nagłówek zgodnie z normalną konwencją ETag. | ciąg |
properties | Właściwości specyficzne dla usługi aprowizacji | IotDpsPropertiesDescription (wymagane) |
IotDpsPropertiesDescription
Nazwa | Opis | Wartość |
---|---|---|
allocationPolicy | Zasady alokacji, które mają być używane przez tę usługę aprowizacji. | "GeoLatency" "Skrót" "Statyczne" |
authorizationPolicies | Lista kluczy autoryzacji dla usługi aprowizacji. | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | Opcjonalny. Wskazuje, czy wystąpienie usługi DPS Data Residency włączone, usunięcie odzyskiwania po awarii między parami geograficznymi. |
bool |
iotHubs | Lista centrów IoT skojarzonych z tą usługą aprowizacji. | IotHubDefinitionDescription[] |
ipFilterRules | Reguły filtrowania adresów IP. | IpFilterRule[] |
privateEndpointConnections | Połączenia prywatnego punktu końcowego utworzone w tej usłudze IotHub | PrivateEndpointConnection[] |
provisioningState | Stan aprowizacji usługi ARM usługi aprowizacji. | ciąg |
publicNetworkAccess | Czy żądania z sieci publicznej są dozwolone | "Wyłączone" "Włączone" |
stan | Bieżący stan usługi aprowizacji. | "Aktywowanie" "ActivationFailed" "Aktywny" "Usunięte" "Usuwanie" "DeletionFailed" "FailOver" "Tryb failoverFailed" "Wznawianie" "Zawieszone" "Wstrzymanie" "Przejście" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
Nazwa | Opis | Wartość |
---|---|---|
keyName | Nazwa klucza. | ciąg (wymagany) |
primaryKey | Podstawowa wartość klucza sygnatury dostępu współdzielonego. | ciąg |
Prawa | Prawa, które ma ten klucz. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagana) |
secondaryKey | Wartość klucza pomocniczego sygnatury dostępu współdzielonego. | ciąg |
keyName | Nazwa klucza. | ciąg (wymagany) |
primaryKey | Podstawowa wartość klucza sygnatury dostępu współdzielonego. | ciąg |
Prawa | Prawa, które ma ten klucz. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (wymagana) |
secondaryKey | Wartość klucza pomocniczego sygnatury dostępu współdzielonego. | ciąg |
IotHubDefinitionDescription
Nazwa | Opis | Wartość |
---|---|---|
alokacja wagi | waga do ubiegania się o daną iot h. | int |
applyAllocationPolicy | flaga stosowania alokacjiPolicy lub nie dla danego centrum iot. | bool |
Parametry połączenia | Parametry połączenia centrum IoT. | ciąg (wymagany) |
location | Region usługi ARM centrum IoT. | ciąg (wymagany) |
IpFilterRule
Nazwa | Opis | Wartość |
---|---|---|
action | Żądana akcja żądań przechwyconych przez tę regułę. | "Akceptuj" "Odrzuć" (wymagane) |
Filtername | Nazwa reguły filtrowania adresów IP. | ciąg (wymagany) |
ipMask | Ciąg zawierający zakres adresów IP w notacji CIDR dla reguły. | ciąg (wymagany) |
Docelowego | Cel dla żądań przechwyconych przez tę regułę. | "wszystko" "deviceApi" "serviceApi" |
PrivateEndpointConnection
Nazwa | Opis | Wartość |
---|---|---|
properties | Właściwości połączenia prywatnego punktu końcowego | PrivateEndpointConnectionProperties (wymagane) |
PrivateEndpointConnectionProperties
Nazwa | Opis | Wartość |
---|---|---|
privateEndpoint | Właściwość prywatnego punktu końcowego połączenia prywatnego punktu końcowego | PrivateEndpoint |
privateLinkServiceConnectionState | Bieżący stan połączenia prywatnego punktu końcowego | PrivateLinkServiceConnectionState (wymagane) |
PrivateEndpoint
Ten obiekt nie zawiera żadnych właściwości do ustawienia podczas wdrażania. Wszystkie właściwości to ReadOnly.
PrivateLinkServiceConnectionState
Nazwa | Opis | Wartość |
---|---|---|
actionsRequired | Akcje wymagane dla połączenia prywatnego punktu końcowego | ciąg |
description (opis) | Opis bieżącego stanu połączenia prywatnego punktu końcowego | ciąg (wymagany) |
status | Stan połączenia prywatnego punktu końcowego | "Zatwierdzone" "Rozłączone" "Oczekujące" "Odrzucone" (wymagane) |
IotDpsSkuInfo
Nazwa | Opis | Wartość |
---|---|---|
capacity | Liczba jednostek do aprowizowania | int |
name | Nazwa jednostki SKU. | "S1" |