Dela via

Microsoft.Devices provisioningServices 2020-01-01

  • Artikel

Bicep-resursdefinition

Resurstypen provisioningServices kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Devices/provisioningServices-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.Devices/provisioningServices@2020-01-01' = {
  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'
      }
    ]
    iotHubs: [
      {
        allocationWeight: int
        applyAllocationPolicy: bool
        connectionString: 'string'
        location: 'string'
      }
    ]
    ipFilterRules: [
      {
        action: 'string'
        filterName: 'string'
        ipMask: 'string'
        target: 'string'
      }
    ]
    provisioningState: 'string'
    state: 'string'
  }
}

Egenskapsvärden

provisioningServices

Name Beskrivning Värde
name Resursnamnet sträng (krävs)

Teckengräns: 3–64

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Sluta med alfanumeriskt.
location Resursplatsen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
sku SKU-information för en etableringstjänst. IotDpsSkuInfo (krävs)
Etag Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
properties Tjänstspecifika egenskaper för en etableringstjänst IotDpsPropertiesDescription (krävs)

IotDpsPropertiesDescription

Name Beskrivning Värde
allocationPolicy Allokeringsprincip som ska användas av den här etableringstjänsten. "GeoLatency"
"Hashed"
"Statisk"
authorizationPolicies Lista över auktoriseringsnycklar för en etableringstjänst. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista över IoT-hubbar som är associerade med den här etableringstjänsten. IotHubDefinitionDescription[]
ipFilterRules IP-filterreglerna. IpFilterRule[]
provisioningState ARM-etableringstillståndet för etableringstjänsten. sträng
state Etableringstjänstens aktuella tillstånd. "Aktivera"
"ActivationFailed"
"Aktiv"
"Borttagen"
"Ta bort"
'DeletionFailed'
"Redundans"
"FailoverFailed"
"Återuppta"
"Pausad"
"Pausa"
"Övergång"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Name Beskrivning Värde
Nyckelnamn Namnet på nyckeln. sträng (krävs)
primaryKey Primärt SAS-nyckelvärde. sträng
Rättigheter Rättigheter som nyckeln har. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (krävs)
secondaryKey Sekundärt SAS-nyckelvärde. sträng
Nyckelnamn Namnet på nyckeln. sträng (krävs)
primaryKey Primärt SAS-nyckelvärde. sträng
Rättigheter Rättigheter som nyckeln har. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (krävs)
secondaryKey Sekundärt SAS-nyckelvärde. sträng

IotHubDefinitionDescription

Name Beskrivning Värde
allocationWeight vikt att ansöka om en viss iot h. int
applyAllocationPolicy flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. boolesk
Connectionstring Anslutningssträng från IoT-hubben. sträng (krävs)
location ARM-regionen i IoT-hubben. sträng (krävs)

IpFilterRule

Name Beskrivning Värde
åtgärd Önskad åtgärd för begäranden som samlas in av den här regeln. "Acceptera"
"Avvisa" (krävs)
filterName Namnet på IP-filterregeln. sträng (krävs)
ipMask En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln. sträng (krävs)
Mål Mål för begäranden som samlas in av den här regeln. "alla"
"deviceApi"
"serviceApi"

IotDpsSkuInfo

Name Beskrivning Värde
capacity Antalet enheter som ska etableras int
name Sku-namn. 'S1'

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en IOT Hub- och Ubuntu-kantsimulator

Distribuera till Azure		 Den här mallen skapar en IOT Hub- och Virtual Machine Ubuntu-gränssimulator.
Skapa en IoT Hub Device Provisioning Service

Distribuera till Azure		 Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning Service och länka ihop de två tjänsterna.

Resursdefinition för ARM-mall

Resurstypen provisioningServices kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.Devices/provisioningServices-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2020-01-01",
  "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"
      }
    ],
    "iotHubs": [
      {
        "allocationWeight": "int",
        "applyAllocationPolicy": "bool",
        "connectionString": "string",
        "location": "string"
      }
    ],
    "ipFilterRules": [
      {
        "action": "string",
        "filterName": "string",
        "ipMask": "string",
        "target": "string"
      }
    ],
    "provisioningState": "string",
    "state": "string"
  }
}

Egenskapsvärden

provisioningServices

Name Beskrivning Värde
typ Resurstypen "Microsoft.Devices/provisioningServices"
apiVersion Resurs-API-versionen '2020-01-01'
name Resursnamnet sträng (krävs)

Teckengräns: 3–64

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Sluta med alfanumeriskt.
location Resursplatsen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden. Se Taggar i mallar
sku SKU-information för en etableringstjänst. IotDpsSkuInfo (krävs)
Etag Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
properties Tjänstspecifika egenskaper för en etableringstjänst IotDpsPropertiesDescription (krävs)

IotDpsPropertiesDescription

Name Beskrivning Värde
allocationPolicy Allokeringsprincip som ska användas av den här etableringstjänsten. "GeoLatency"
"Hashed"
"Statisk"
authorizationPolicies Lista över auktoriseringsnycklar för en etableringstjänst. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista över IoT-hubbar som är associerade med den här etableringstjänsten. IotHubDefinitionDescription[]
ipFilterRules IP-filterreglerna. IpFilterRule[]
provisioningState ARM-etableringstillståndet för etableringstjänsten. sträng
state Etableringstjänstens aktuella tillstånd. "Aktivera"
"ActivationFailed"
"Aktiv"
"Borttagen"
"Ta bort"
'DeletionFailed'
"Redundans"
"FailoverFailed"
"Återuppta"
"Pausad"
"Pausa"
"Övergång"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Name Beskrivning Värde
Nyckelnamn Namnet på nyckeln. sträng (krävs)
primaryKey Primärt SAS-nyckelvärde. sträng
Rättigheter Rättigheter som nyckeln har. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (krävs)
secondaryKey Sekundärt SAS-nyckelvärde. sträng
Nyckelnamn Namnet på nyckeln. sträng (krävs)
primaryKey Primärt SAS-nyckelvärde. sträng
Rättigheter Rättigheter som nyckeln har. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (krävs)
secondaryKey Sekundärt SAS-nyckelvärde. sträng

IotHubDefinitionDescription

Name Beskrivning Värde
allocationWeight vikt att ansöka om en viss iot h. int
applyAllocationPolicy flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. boolesk
Connectionstring Anslutningssträng från IoT-hubben. sträng (krävs)
location ARM-regionen i IoT-hubben. sträng (krävs)

IpFilterRule

Name Beskrivning Värde
åtgärd Önskad åtgärd för begäranden som samlas in av den här regeln. "Acceptera"
"Avvisa" (krävs)
filterName Namnet på IP-filterregeln. sträng (krävs)
ipMask En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln. sträng (krävs)
Mål Mål för begäranden som samlas in av den här regeln. "alla"
"deviceApi"
"serviceApi"

IotDpsSkuInfo

Name Beskrivning Värde
capacity Antalet enheter som ska etableras int
name Sku-namn. 'S1'

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa en IOT Hub- och Ubuntu-kantsimulator

Distribuera till Azure		 Den här mallen skapar en IOT Hub- och Virtual Machine Ubuntu-gränssimulator.
Skapa en IoT Hub Device Provisioning Service

Distribuera till Azure		 Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning Service och länka ihop de två tjänsterna.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen provisioningServices 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.Devices/provisioningServices-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2020-01-01"
  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"
        }
      ]
      iotHubs = [
        {
          allocationWeight = int
          applyAllocationPolicy = bool
          connectionString = "string"
          location = "string"
        }
      ]
      ipFilterRules = [
        {
          action = "string"
          filterName = "string"
          ipMask = "string"
          target = "string"
        }
      ]
      provisioningState = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

Egenskapsvärden

provisioningServices

Name Beskrivning Värde
typ Resurstypen "Microsoft.Devices/provisioningServices@2020-01-01"
name Resursnamnet sträng (krävs)

Teckengräns: 3–64

Giltiga tecken:
Alfanumeriska tecken och bindestreck.

Sluta med alfanumeriskt.
location Resursplatsen. sträng (krävs)
parent_id Om du vill distribuera till en resursgrupp använder du ID:t för den resursgruppen. sträng (krävs)
tags Resurstaggar. Ordlista med taggnamn och värden.
sku SKU-information för en etableringstjänst. IotDpsSkuInfo (krävs)
Etag Fältet Etag krävs inte . Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
properties Tjänstspecifika egenskaper för en etableringstjänst IotDpsPropertiesDescription (krävs)

IotDpsPropertiesDescription

Name Beskrivning Värde
allocationPolicy Allokeringsprincip som ska användas av den här etableringstjänsten. "GeoLatency"
"Hashed"
"Statisk"
authorizationPolicies Lista över auktoriseringsnycklar för en etableringstjänst. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Lista över IoT-hubbar som är associerade med den här etableringstjänsten. IotHubDefinitionDescription[]
ipFilterRules IP-filterreglerna. IpFilterRule[]
provisioningState ARM-etableringstillståndet för etableringstjänsten. sträng
state Etableringstjänstens aktuella tillstånd. "Aktivera"
"ActivationFailed"
"Aktiv"
"Borttaget"
"Ta bort"
"DeletionFailed"
"Redundans"
"FailoverFailed"
"Återuppta"
"Pausad"
"Pausa"
"Övergång"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Name Beskrivning Värde
Nyckelnamn Namnet på nyckeln. sträng (krävs)
primaryKey Primärt SAS-nyckelvärde. sträng
Rättigheter Rättigheter som nyckeln har. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (krävs)
secondaryKey Sekundärt SAS-nyckelvärde. sträng
Nyckelnamn Namnet på nyckeln. sträng (krävs)
primaryKey Primärt SAS-nyckelvärde. sträng
Rättigheter Rättigheter som nyckeln har. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (krävs)
secondaryKey Sekundärt SAS-nyckelvärde. sträng

IotHubDefinitionDescription

Name Beskrivning Värde
allocationWeight vikt att ansöka om en viss iot h. int
applyAllocationPolicy flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. boolesk
Connectionstring Anslutningssträng från IoT-hubben. sträng (krävs)
location ARM-regionen i IoT-hubben. sträng (krävs)

IpFilterRule

Name Beskrivning Värde
åtgärd Önskad åtgärd för begäranden som samlas in av den här regeln. "Acceptera"
"Avvisa" (krävs)
filterName Namnet på IP-filterregeln. sträng (krävs)
ipMask En sträng som innehåller IP-adressintervallet i CIDR-notation för regeln. sträng (krävs)
Mål Mål för begäranden som samlas in av den här regeln. "alla"
"deviceApi"
"serviceApi"

IotDpsSkuInfo

Name Beskrivning Värde
capacity Antalet enheter som ska etableras int
name Sku-namn. "S1"