Microsoft.Devices ProvisioningServices 2022-12-12
Definice prostředku Bicep
Typ prostředku ProvisioningServices je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení skupiny prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Devices/provisioningServices, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.Devices/provisioningServices@2022-12-12' = {
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'
}
]
portalOperationsHostName: 'string'
privateEndpointConnections: [
{
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
}
]
provisioningState: 'string'
publicNetworkAccess: 'string'
state: 'string'
}
resourcegroup: 'string'
subscriptionid: 'string'
}
Hodnoty vlastností
provisioningServices
Název | Description | Hodnota |
---|---|---|
name | Název prostředku | string (povinné) Limit počtu znaků: 3–64 Platné znaky: Alfanumerické znaky a spojovníky. Konec alfanumerickým znakem |
location | Umístění prostředku. | string (povinné) |
tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
Sku | Informace o skladové pořizovací službě | IotDpsSkuInfo (povinné) |
Etag | Pole Etag není povinné. Pokud je uveden v textu odpovědi, musí být také uveden jako hlavička podle normální konvence ETag. | řetězec |
properties | Vlastnosti specifické pro službu zřizování | IotDpsPropertiesDescription (povinné) |
skupina prostředků | Skupina prostředků prostředku. | řetězec |
id předplatného | ID předplatného prostředku. | řetězec |
Popis IotDpsPropertiesDescription
Název | Description | Hodnota |
---|---|---|
allocationPolicy | Zásady přidělování, které má tato služba zřizování používat. | 'GeoLatency' 'Hashed' 'Static' |
authorizationPolicies | Seznam autorizačních klíčů pro službu zřizování | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | Nepovinný parametr. Označuje, jestli má instance DPS Data Residency povolená, čímž se odebere zotavení po havárii mezi geografickým párem. |
bool |
iotHubs | Seznam ioT hub přidružených k této službě zřizování | IotHubDefinitionDescription[] |
ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
portalOperationsHostName | Koncový bod portálu pro povolení CORS pro tuto službu zřizování | řetězec |
privateEndpointConnections | Připojení privátního koncového bodu vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
provisioningState | Stav zřizování ARM služby zřizování. | řetězec |
publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno 'Povoleno' |
state | Aktuální stav služby zřizování. | 'Aktivace' Aktivace selhala Aktivní Odstraněno "Odstraňuje se" Odstranění selhalo Při selhání Selhání při selhání "Obnovení" "Pozastaveno" "Pozastavení" "Přechod" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
Název | Description | Hodnota |
---|---|---|
Název_klíče | Název klíče. | string (povinné) |
primaryKey | Hodnota primárního klíče SAS. | řetězec |
Práva | Práva, která tento klíč má. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' ServiceConfig (povinné) |
secondaryKey | Hodnota sekundárního klíče SAS. | řetězec |
Název_klíče | Název klíče. | string (povinné) |
primaryKey | Hodnota primárního klíče SAS. | řetězec |
Práva | Práva, která tento klíč má. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' ServiceConfig (povinné) |
secondaryKey | Hodnota sekundárního klíče SAS. | řetězec |
Popis IotHubDefinitionDescription
Název | Description | Hodnota |
---|---|---|
allocationWeight | hmotnosti, která se má použít pro danou iot h. | int |
applyAllocationPolicy | příznak pro použití zásady allocationPolicy nebo ne pro dané centrum iot. | bool |
připojovací řetězec | Připojovací řetězec centra IoT. | string (povinné) |
location | Oblast ARM centra IoT. | string (povinné) |
IpFilterRule
Název | Description | Hodnota |
---|---|---|
action | Požadovaná akce pro požadavky zachycené tímto pravidlem | "Přijmout" Odmítnout (povinné) |
filterName | Název pravidla filtru IP adres. | string (povinné) |
ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. | string (povinné) |
Cíl | Cíl pro požadavky zachycené tímto pravidlem. | "all" (vše) 'deviceApi' 'serviceApi' |
PrivateEndpointConnection
Název | Description | Hodnota |
---|---|---|
properties | Vlastnosti připojení privátního koncového bodu | PrivateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
Název | Description | Hodnota |
---|---|---|
privátní koncový bod | Vlastnost privátního koncového bodu připojení privátního koncového bodu | Privátní koncový bod |
privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
Privátní koncový bod
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
PrivateLinkServiceConnectionState
Název | Description | Hodnota |
---|---|---|
actionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
description | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
status | Stav připojení privátního koncového bodu | "Schváleno" Odpojeno Čeká na vyřízení Zamítnuto (povinné) |
IotDpsSkuInfo
Název | Description | Hodnota |
---|---|---|
capacity | Počet jednotek, které se mají zřídit | int |
name | Název skladové položky. | 'S1' |
Šablony pro rychlý start
Následující šablony rychlého startu nasadí tento typ prostředku.
Template (Šablona) | Description |
---|---|
Vytvoření iot Hubu a hraničního simulátoru Ubuntu |
Tato šablona vytvoří simulátor hraničních zařízení IOT Hub a Ubuntu virtuálního počítače. |
Vytvoření služby IoT Hub Device Provisioning |
Tato šablona umožňuje vytvořit centrum IoT a službu IoT Hub Device Provisioning a propojit tyto dvě služby. |
Definice prostředku šablony ARM
Typ prostředku ProvisioningServices je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy nasazení skupiny prostředků.
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Devices/provisioningServices, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.Devices/provisioningServices",
"apiVersion": "2022-12-12",
"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"
}
],
"portalOperationsHostName": "string",
"privateEndpointConnections": [
{
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
}
}
],
"provisioningState": "string",
"publicNetworkAccess": "string",
"state": "string"
},
"resourcegroup": "string",
"subscriptionid": "string"
}
Hodnoty vlastností
provisioningServices
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Devices/provisioningServices |
apiVersion | Verze rozhraní API prostředků | '2022-12-12' |
name | Název prostředku | string (povinné) Limit počtu znaků: 3–64 Platné znaky: Alfanumerické znaky a spojovníky. Konec alfanumerickým znakem |
location | Umístění prostředku. | string (povinné) |
tags | Značky prostředků. | Slovník názvů značek a hodnot. Viz Značky v šablonách |
Sku | Informace o skladové pořizovací službě | IotDpsSkuInfo (povinné) |
Etag | Pole Etag není povinné. Pokud je uveden v textu odpovědi, musí být také uveden jako hlavička podle normální konvence ETag. | řetězec |
properties | Vlastnosti specifické pro službu zřizování | IotDpsPropertiesDescription (povinné) |
skupina prostředků | Skupina prostředků prostředku. | řetězec |
id předplatného | ID předplatného prostředku. | řetězec |
Popis IotDpsPropertiesDescription
Název | Description | Hodnota |
---|---|---|
allocationPolicy | Zásady přidělování, které má tato služba zřizování používat. | 'GeoLatency' 'Hashed' 'Static' |
authorizationPolicies | Seznam autorizačních klíčů pro službu zřizování | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | Nepovinný parametr. Označuje, jestli má instance DPS Data Residency povolená, čímž se odebere zotavení po havárii mezi geografickým párem. |
bool |
iotHubs | Seznam ioT hub přidružených k této službě zřizování | IotHubDefinitionDescription[] |
ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
portalOperationsHostName | Koncový bod portálu pro povolení CORS pro tuto službu zřizování | řetězec |
privateEndpointConnections | Připojení privátního koncového bodu vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
provisioningState | Stav zřizování ARM služby zřizování. | řetězec |
publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | Zakázáno 'Povoleno' |
state | Aktuální stav služby zřizování. | 'Aktivace' Aktivace selhala Aktivní Odstraněno "Odstraňuje se" Odstranění selhalo Při selhání Selhání při selhání "Obnovení" "Pozastaveno" "Pozastavení" "Přechod" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
Název | Description | Hodnota |
---|---|---|
Název_klíče | Název klíče. | string (povinné) |
primaryKey | Hodnota primárního klíče SAS. | řetězec |
Práva | Práva, která tento klíč má. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' ServiceConfig (povinné) |
secondaryKey | Hodnota sekundárního klíče SAS. | řetězec |
Název_klíče | Název klíče. | string (povinné) |
primaryKey | Hodnota primárního klíče SAS. | řetězec |
Práva | Práva, která tento klíč má. | 'DeviceConnect' 'EnrollmentRead' 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' ServiceConfig (povinné) |
secondaryKey | Hodnota sekundárního klíče SAS. | řetězec |
Popis IotHubDefinitionDescription
Název | Description | Hodnota |
---|---|---|
allocationWeight | hmotnosti, která se má použít pro danou iot h. | int |
applyAllocationPolicy | příznak pro použití zásady allocationPolicy nebo ne pro dané centrum iot. | bool |
připojovací řetězec | Připojovací řetězec centra IoT. | string (povinné) |
location | Oblast ARM centra IoT. | string (povinné) |
IpFilterRule
Název | Description | Hodnota |
---|---|---|
action | Požadovaná akce pro požadavky zachycené tímto pravidlem | "Přijmout" Odmítnout (povinné) |
filterName | Název pravidla filtru IP adres. | string (povinné) |
ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. | string (povinné) |
Cíl | Cíl pro požadavky zachycené tímto pravidlem. | 'all' (vše) 'deviceApi' 'serviceApi' |
PrivateEndpointConnection
Název | Description | Hodnota |
---|---|---|
properties | Vlastnosti připojení privátního koncového bodu | PrivateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
Název | Description | Hodnota |
---|---|---|
privátní koncový bod | Vlastnost privátního koncového bodu připojení privátního koncového bodu | Privátní koncový bod |
privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
Privátní koncový bod
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou jen pro čtení.
PrivateLinkServiceConnectionState
Název | Description | Hodnota |
---|---|---|
ActionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
description | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
status | Stav připojení privátního koncového bodu | Schváleno Odpojeno Čeká na vyřízení Zamítnuto (povinné) |
IotDpsSkuInfo
Název | Description | Hodnota |
---|---|---|
capacity | Počet jednotek, které se mají zřídit | int |
name | Název skladové položky. | 'S1' |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
Template (Šablona) | Description |
---|---|
Vytvoření simulátoru IoT Hub a Ubuntu Edge |
Tato šablona vytvoří hraniční simulátor iot hubu a virtuálního počítače Ubuntu. |
Vytvoření služby IoT Hub Device Provisioning |
Tato šablona umožňuje vytvořit centrum IoT a službu IoT Hub Device Provisioning a propojit tyto dvě služby dohromady. |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku provisioningServices je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Devices/provisioningServices, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Devices/provisioningServices@2022-12-12"
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"
}
]
portalOperationsHostName = "string"
privateEndpointConnections = [
{
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
}
]
provisioningState = "string"
publicNetworkAccess = "string"
state = "string"
}
resourcegroup = "string"
subscriptionid = "string"
sku = {
capacity = int
name = "S1"
}
etag = "string"
})
}
Hodnoty vlastností
provisioningServices
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | "Microsoft.Devices/provisioningServices@2022-12-12" |
name | Název prostředku | string (povinné) Omezení počtu znaků: 3–64 Platné znaky: Alfanumerické znaky a pomlčky. Končí alfanumerickými znaky. |
location | Umístění prostředku. | string (povinné) |
parent_id | K nasazení do skupiny prostředků použijte ID této skupiny prostředků. | string (povinné) |
tags | Značky prostředků. | Slovník názvů a hodnot značek. |
Sku | Informace o SKU pro službu zřizování | IotDpsSkuInfo (povinné) |
Etag | Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí být také uvedený jako hlavička podle normální konvence ETag. | řetězec |
properties | Vlastnosti specifické pro službu zřizování | IotDpsPropertiesDescription (povinné) |
skupina prostředků | Skupina prostředků prostředku. | řetězec |
id předplatného | ID předplatného prostředku. | řetězec |
Popis IotDpsPropertiesDescription
Název | Description | Hodnota |
---|---|---|
allocationPolicy | Zásady přidělování, které má tato služba zřizování používat. | "GeoLatency" "Hashováno" "Statická" |
authorizationPolicies | Seznam autorizačních klíčů pro službu zřizování | SharedAccessSignatureAuthorizationRuleAccessRightsDe...[] |
enableDataResidency | Nepovinný parametr. Označuje, jestli má instance DPS Data Residency povolená, čímž se odebere zotavení po havárii mezi geografickým párem. |
bool |
iotHubs | Seznam ioT hub přidružených k této službě zřizování | IotHubDefinitionDescription[] |
ipFilterRules | Pravidla filtru IP adres. | IpFilterRule[] |
portalOperationsHostName | Koncový bod portálu pro povolení CORS pro tuto službu zřizování | řetězec |
privateEndpointConnections | Připojení privátního koncového bodu vytvořená na tomto IotHubu | PrivateEndpointConnection[] |
provisioningState | Stav zřizování ARM služby zřizování. | řetězec |
publicNetworkAccess | Jestli jsou povolené požadavky z veřejné sítě | "Zakázáno" "Povoleno" |
state | Aktuální stav služby zřizování. | "Aktivace" "Aktivace selhala" "Aktivní" "Odstraněno" "Odstranění" "Odstranění selhalo" "Selhání při selhání" Selhání při selhání "Obnovení" "Pozastaveno" "Pozastavení" "Přechod" |
SharedAccessSignatureAuthorizationRuleAccessRightsDe...
Název | Description | Hodnota |
---|---|---|
Název_klíče | Název klíče. | string (povinné) |
primaryKey | Hodnota primárního klíče SAS. | řetězec |
Práva | Práva, která tento klíč má. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (povinné) |
secondaryKey | Hodnota sekundárního klíče SAS. | řetězec |
Název_klíče | Název klíče. | string (povinné) |
primaryKey | Hodnota primárního klíče SAS. | řetězec |
Práva | Práva, která tento klíč má. | "DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (povinné) |
secondaryKey | Hodnota sekundárního klíče SAS. | řetězec |
Popis IotHubDefinitionDescription
Název | Description | Hodnota |
---|---|---|
allocationWeight | hmotnosti, která se má použít pro danou iot h. | int |
applyAllocationPolicy | příznak pro použití zásady allocationPolicy nebo ne pro dané centrum iot. | bool |
připojovací řetězec | Připojovací řetězec centra IoT. | string (povinné) |
location | Oblast ARM centra IoT. | string (povinné) |
IpFilterRule
Název | Description | Hodnota |
---|---|---|
action | Požadovaná akce pro požadavky zachycené tímto pravidlem | "Přijmout" "Odmítnout" (povinné) |
filterName | Název pravidla filtru IP adres. | string (povinné) |
ipMask | Řetězec, který obsahuje rozsah IP adres v zápisu CIDR pro pravidlo. | string (povinné) |
Cíl | Cíl pro požadavky zachycené tímto pravidlem. | "all" (vše) "deviceApi" "serviceApi" |
PrivateEndpointConnection
Název | Description | Hodnota |
---|---|---|
properties | Vlastnosti připojení privátního koncového bodu | PrivateEndpointConnectionProperties (povinné) |
PrivateEndpointConnectionProperties
Název | Description | Hodnota |
---|---|---|
privátní koncový bod | Vlastnost privátního koncového bodu připojení privátního koncového bodu | Privátní koncový bod |
privateLinkServiceConnectionState | Aktuální stav připojení privátního koncového bodu | PrivateLinkServiceConnectionState (povinné) |
Privátní koncový bod
Tento objekt neobsahuje žádné vlastnosti, které by se nastavily během nasazování. Všechny vlastnosti jsou Jen pro čtení.
PrivateLinkServiceConnectionState
Název | Description | Hodnota |
---|---|---|
actionsRequired | Akce vyžadované pro připojení privátního koncového bodu | řetězec |
description | Popis aktuálního stavu připojení privátního koncového bodu | string (povinné) |
status | Stav připojení privátního koncového bodu | "Schváleno" "Odpojeno" "Čeká na vyřízení" "Odmítnuto" (povinné) |
IotDpsSkuInfo
Název | Description | Hodnota |
---|---|---|
capacity | Počet jednotek, které se mají zřídit | int |
name | Název skladové položky. | "S1" |