Sdílet prostřednictvím

Microsoft.Devices provisioningServices 2022-02-05

  • Článek

Definice prostředku Bicep

Typ prostředku provisioningServices je možné nasadit s operacemi, které cílí:

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-02-05' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        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: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Hodnoty vlastností

IotDpsPropertiesDescription

Jméno Popis Hodnota
allocationPolicy Zásady přidělování, které má tato služba zřizování používat. "GeoLatency"
"Hashed"
Statická
authorizationPolicies Seznam autorizačních klíčů pro službu zřizování SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency Volitelný.
Označuje, jestli má instance DPS povolenou rezidenci dat, odebrání zotavení po havárii mezi geografickou dvojicí.		 Bool
iotHubs Seznam center IoT přidružených k této službě zřizování IotHubDefinitionDescription []
ipFilterRules Pravidla filtru IP adres. IpFilterRule[]
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
stát Aktuální stav služby zřizování Aktivace
Aktivace se nezdařila.
Aktivní
Odstraněno
Odstranění
Odstranění se nezdařilo.
Převzetí služeb při selhání
Převzetí služeb při selhání selhalo
Obnovení
"Pozastaveno"
"Pozastavení"
Přechody

IotDpsSkuInfo

Jméno Popis Hodnota
kapacita Počet jednotek, které se mají zřídit Int
Jméno Název skladové položky. S1

IotHubDefinitionDescription

Jméno Popis Hodnota
allocationWeight hmotnost, která se použije pro danou iot h. Int
applyAllocationPolicy příznak pro použití allocationPolicy nebo ne pro dané centrum IoT. Bool
connectionString Připojovací řetězec centra IoT. string (povinné)
umístění Oblast ARM centra IoT string (povinné)

IpFilterRule

Jméno Popis Hodnota
akce 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 pravidla. string (povinné)
cíl Cíl pro požadavky zachycené tímto pravidlem. "all" (vše)
DeviceApi
ServiceApi

Microsoft.Devices/provisioningServices

Jméno Popis Hodnota
etag Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag. řetězec
umístění Umístění prostředku. string (povinné)
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti specifické pro službu zřizování IotDpsPropertiesDescription (povinné)
sku Informace o skladové pořizovací službě IotDpsSkuInfo (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

PrivateEndpoint

Jméno Popis Hodnota

PrivateEndpointConnection

Jméno Popis Hodnota
vlastnosti Vlastnosti připojení privátního koncového bodu privateEndpointConnectionProperties (povinné)

PrivateEndpointConnectionProperties

Jméno Popis Hodnota
privateEndpoint Vlastnost privátního koncového bodu připojení privátního koncového bodu PrivateEndpoint
privateLinkServiceConnectionState Aktuální stav připojení privátního koncového bodu PrivateLinkServiceConnectionState (povinné)

PrivateLinkServiceConnectionState

Jméno Popis Hodnota
ActionsRequired Akce vyžadované pro připojení privátního koncového bodu řetězec
popis Popis aktuálního stavu připojení privátního koncového bodu string (povinné)
stav Stav připojení privátního koncového bodu "Schváleno"
Odpojeno
Čeká na vyřízení
Odmítnuto (povinné)

Značky prostředků

Jméno Popis Hodnota

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Jméno Popis Hodnota
keyName 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

Ukázky rychlého startu

Následující ukázky rychlého startu nasadí tento typ prostředku.

Soubor Bicep Popis
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 obě služby.

Definice prostředku šablony ARM

Typ prostředku provisioningServices je možné nasadit s operacemi, které cílí:

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í JSON.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2022-02-05",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "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": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Hodnoty vlastností

IotDpsPropertiesDescription

Jméno Popis Hodnota
allocationPolicy Zásady přidělování, které má tato služba zřizování používat. "GeoLatency"
"Hashed"
Statická
authorizationPolicies Seznam autorizačních klíčů pro službu zřizování SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency Volitelný.
Označuje, jestli má instance DPS povolenou rezidenci dat, odebrání zotavení po havárii mezi geografickou dvojicí.		 Bool
iotHubs Seznam center IoT přidružených k této službě zřizování IotHubDefinitionDescription []
ipFilterRules Pravidla filtru IP adres. IpFilterRule[]
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
stát Aktuální stav služby zřizování Aktivace
Aktivace se nezdařila.
Aktivní
Odstraněno
Odstranění
Odstranění se nezdařilo.
Převzetí služeb při selhání
Převzetí služeb při selhání selhalo
Obnovení
"Pozastaveno"
"Pozastavení"
Přechody

IotDpsSkuInfo

Jméno Popis Hodnota
kapacita Počet jednotek, které se mají zřídit Int
Jméno Název skladové položky. S1

IotHubDefinitionDescription

Jméno Popis Hodnota
allocationWeight hmotnost, která se použije pro danou iot h. Int
applyAllocationPolicy příznak pro použití allocationPolicy nebo ne pro dané centrum IoT. Bool
connectionString Připojovací řetězec centra IoT. string (povinné)
umístění Oblast ARM centra IoT string (povinné)

IpFilterRule

Jméno Popis Hodnota
akce 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 pravidla. string (povinné)
cíl Cíl pro požadavky zachycené tímto pravidlem. "all" (vše)
DeviceApi
ServiceApi

Microsoft.Devices/provisioningServices

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2022-02-05'
etag Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag. řetězec
umístění Umístění prostředku. string (povinné)
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti specifické pro službu zřizování IotDpsPropertiesDescription (povinné)
sku Informace o skladové pořizovací službě IotDpsSkuInfo (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.Devices/provisioningServices

PrivateEndpoint

Jméno Popis Hodnota

PrivateEndpointConnection

Jméno Popis Hodnota
vlastnosti Vlastnosti připojení privátního koncového bodu privateEndpointConnectionProperties (povinné)

PrivateEndpointConnectionProperties

Jméno Popis Hodnota
privateEndpoint Vlastnost privátního koncového bodu připojení privátního koncového bodu PrivateEndpoint
privateLinkServiceConnectionState Aktuální stav připojení privátního koncového bodu PrivateLinkServiceConnectionState (povinné)

PrivateLinkServiceConnectionState

Jméno Popis Hodnota
ActionsRequired Akce vyžadované pro připojení privátního koncového bodu řetězec
popis Popis aktuálního stavu připojení privátního koncového bodu string (povinné)
stav Stav připojení privátního koncového bodu "Schváleno"
Odpojeno
Čeká na vyřízení
Odmítnuto (povinné)

Značky prostředků

Jméno Popis Hodnota

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Jméno Popis Hodnota
keyName 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

Šablony pro rychlý start

Následující šablony pro rychlý start nasazují tento typ prostředku.

Šablona Popis
vytvoření simulátoru IOT Hub a Ubuntu Edge

nasazení do Azure		 Tato šablona vytvoří simulátor ioT Hubu a hraničního simulátoru Ubuntu virtuálního počítače.
vytvoření služby IoT Hub Device Provisioning

nasazení do Azure		 Tato šablona umožňuje vytvořit centrum IoT a službu IoT Hub Device Provisioning a propojit obě služby.

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku provisioningServices je možné nasadit s operacemi, které cílí:

  • 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-02-05"
  name = "string"
  etag = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      allocationPolicy = "string"
      authorizationPolicies = [
        {
          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"
    }
  })
}

Hodnoty vlastností

IotDpsPropertiesDescription

Jméno Popis Hodnota
allocationPolicy Zásady přidělování, které má tato služba zřizování používat. "GeoLatency"
"Hashed"
Statická
authorizationPolicies Seznam autorizačních klíčů pro službu zřizování SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency Volitelný.
Označuje, jestli má instance DPS povolenou rezidenci dat, odebrání zotavení po havárii mezi geografickou dvojicí.		 Bool
iotHubs Seznam center IoT přidružených k této službě zřizování IotHubDefinitionDescription []
ipFilterRules Pravidla filtru IP adres. IpFilterRule[]
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
stát Aktuální stav služby zřizování Aktivace
Aktivace se nezdařila.
Aktivní
Odstraněno
Odstranění
Odstranění se nezdařilo.
Převzetí služeb při selhání
Převzetí služeb při selhání selhalo
Obnovení
"Pozastaveno"
"Pozastavení"
Přechody

IotDpsSkuInfo

Jméno Popis Hodnota
kapacita Počet jednotek, které se mají zřídit Int
Jméno Název skladové položky. S1

IotHubDefinitionDescription

Jméno Popis Hodnota
allocationWeight hmotnost, která se použije pro danou iot h. Int
applyAllocationPolicy příznak pro použití allocationPolicy nebo ne pro dané centrum IoT. Bool
connectionString Připojovací řetězec centra IoT. string (povinné)
umístění Oblast ARM centra IoT string (povinné)

IpFilterRule

Jméno Popis Hodnota
akce 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 pravidla. string (povinné)
cíl Cíl pro požadavky zachycené tímto pravidlem. "all" (vše)
DeviceApi
ServiceApi

Microsoft.Devices/provisioningServices

Jméno Popis Hodnota
etag Pole Etag není povinné. Pokud je uvedený v textu odpovědi, musí se také poskytnout jako hlavička podle normální konvence značky ETag. řetězec
umístění Umístění prostředku. string (povinné)
Jméno Název prostředku string (povinné)
vlastnosti Vlastnosti specifické pro službu zřizování IotDpsPropertiesDescription (povinné)
sku Informace o skladové pořizovací službě IotDpsSkuInfo (povinné)
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku "Microsoft.Devices/provisioningServices@2022-02-05"

PrivateEndpoint

Jméno Popis Hodnota

PrivateEndpointConnection

Jméno Popis Hodnota
vlastnosti Vlastnosti připojení privátního koncového bodu privateEndpointConnectionProperties (povinné)

PrivateEndpointConnectionProperties

Jméno Popis Hodnota
privateEndpoint Vlastnost privátního koncového bodu připojení privátního koncového bodu PrivateEndpoint
privateLinkServiceConnectionState Aktuální stav připojení privátního koncového bodu PrivateLinkServiceConnectionState (povinné)

PrivateLinkServiceConnectionState

Jméno Popis Hodnota
ActionsRequired Akce vyžadované pro připojení privátního koncového bodu řetězec
popis Popis aktuálního stavu připojení privátního koncového bodu string (povinné)
stav Stav připojení privátního koncového bodu "Schváleno"
Odpojeno
Čeká na vyřízení
Odmítnuto (povinné)

Značky prostředků

Jméno Popis Hodnota

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Jméno Popis Hodnota
keyName 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