Dela via

Microsoft.Devices provisioningServices 2020-09-01-preview

  • 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-09-01-preview' = {
  etag: 'string'
  identity: {
    identityType: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    allocationPolicy: 'string'
    authorizationPolicies: [
      {
        keyName: 'string'
        primaryKey: 'string'
        rights: 'string'
        secondaryKey: 'string'
      }
    ]
    encryption: {
      identity: {
        userAssignedIdentity: 'string'
      }
      keySource: 'string'
      keyVaultProperties: [
        {
          keyIdentifier: 'string'
        }
      ]
    }
    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'
  }
}

Egenskapsvärden

ArmIdentity

Namn Beskrivning Värde
identityType Identitetstyp. Endast tillåtna värden är SystemAssigned och UserAssigned. Kommaavgränsade om båda för t.ex. SystemAssigned,UserAssigned. sträng
userAssignedIdentities Uppsättningen användartilldelade identiteter som är associerade med IoT DPS-resursen. ArmIdentityUserAssignedIdentiteter

ArmIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

ArmUserIdentity

Namn Beskrivning Värde

EncryptionKeyIdentity

Namn Beskrivning Värde
userAssignedIdentity Den användartilldelade identiteten. sträng

EncryptionPropertiesDescription

Namn Beskrivning Värde
identitet Den identitet som används för att komma åt krypteringsnyckeln i KeyVault. EncryptionKeyIdentity
keySource Källan till krypteringsnyckeln. Vanligtvis Microsoft.KeyVault sträng
keyVaultProperties Egenskaperna för krypteringsnyckeln som konfigurerats i KeyVault. KeyVaultKeyProperties[]

IotDpsPropertiesDescription

Namn 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. SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
kryptering Krypteringsegenskaperna för IoT DPS-instansen. EncryptionPropertiesDescription
iotHubs Lista över IoT-hubbar som är associerade med den här etableringstjänsten. IotHubDefinitionDescription[]
ipFilterRules IP-filterreglerna. IpFilterRule[]
privateEndpointConnections Privata slutpunktsanslutningar som skapats på denna IotHub PrivateEndpointConnection[]
provisioningState ARM-etableringstillståndet för etableringstjänsten. sträng
publicNetworkAccess Om begäranden från offentliga nätverk tillåts "Inaktiverad"
"Aktiverad"
stat Etableringstjänstens aktuella tillstånd. "Aktivera"
"ActivationFailed"
"Aktiv"
"Borttaget"
"Ta bort"
"DeletionFailed"
"Redundans"
"FailoverFailed"
"Återuppta"
"Pausad"
"Pausa"
"Övergång"

IotDpsSkuInfo

Namn Beskrivning Värde
kapacitet Antalet enheter som ska etableras Int
Namn Sku-namn. "S1"

IotHubDefinitionDescription

Namn Beskrivning Värde
allocationWeight vikt för att ansöka om en given iot h. Int
applyAllocationPolicy flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. Bool
connectionString Anslutningssträng för IoT-hubben. sträng (krävs)
plats ARM-regionen för IoT-hubben. sträng (krävs)

IpFilterRule

Namn Beskrivning Värde
handling Ö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-notationen 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"

KeyVaultKeyProperties

Namn Beskrivning Värde
keyIdentifier Nyckelns identifierare. sträng

Microsoft.Devices/provisioningServices

Namn Beskrivning Värde
etag Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
identitet Hanterade identiteter för IotDps-instansen. ArmIdentity
plats Resursplatsen. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Tjänstspecifika egenskaper för en etableringstjänst IotDpsPropertiesDescription (krävs)
Sku SKU-information för en etableringstjänst. IotDpsSkuInfo (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

PrivateEndpoint

Namn Beskrivning Värde

PrivateEndpointConnection

Namn Beskrivning Värde
Egenskaper Egenskaperna för en privat slutpunktsanslutning PrivateEndpointConnectionProperties (krävs)

PrivateEndpointConnectionProperties

Namn Beskrivning Värde
privateEndpoint Egenskapen privat slutpunkt för en privat slutpunktsanslutning PrivateEndpoint
privateLinkServiceConnectionState Det aktuella tillståndet för en privat slutpunktsanslutning PrivateLinkServiceConnectionState (krävs)

PrivateLinkServiceConnectionState

Namn Beskrivning Värde
actionsRequired Åtgärder som krävs för en privat slutpunktsanslutning sträng
beskrivning Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning sträng (krävs)
status Status för en privat slutpunktsanslutning "Godkänd"
"Frånkopplad"
"Väntar"
"Avvisad" (krävs)

ResourceTags

Namn Beskrivning Värde

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Skapa en IoT Hub Device Provisioning-tjänst Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning-tjänst 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-09-01-preview",
  "name": "string",
  "etag": "string",
  "identity": {
    "identityType": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "allocationPolicy": "string",
    "authorizationPolicies": [
      {
        "keyName": "string",
        "primaryKey": "string",
        "rights": "string",
        "secondaryKey": "string"
      }
    ],
    "encryption": {
      "identity": {
        "userAssignedIdentity": "string"
      },
      "keySource": "string",
      "keyVaultProperties": [
        {
          "keyIdentifier": "string"
        }
      ]
    },
    "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"
  }
}

Egenskapsvärden

ArmIdentity

Namn Beskrivning Värde
identityType Identitetstyp. Endast tillåtna värden är SystemAssigned och UserAssigned. Kommaavgränsade om båda för t.ex. SystemAssigned,UserAssigned. sträng
userAssignedIdentities Uppsättningen användartilldelade identiteter som är associerade med IoT DPS-resursen. ArmIdentityUserAssignedIdentiteter

ArmIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

ArmUserIdentity

Namn Beskrivning Värde

EncryptionKeyIdentity

Namn Beskrivning Värde
userAssignedIdentity Den användartilldelade identiteten. sträng

EncryptionPropertiesDescription

Namn Beskrivning Värde
identitet Den identitet som används för att komma åt krypteringsnyckeln i KeyVault. EncryptionKeyIdentity
keySource Källan till krypteringsnyckeln. Vanligtvis Microsoft.KeyVault sträng
keyVaultProperties Egenskaperna för krypteringsnyckeln som konfigurerats i KeyVault. KeyVaultKeyProperties[]

IotDpsPropertiesDescription

Namn 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. SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
kryptering Krypteringsegenskaperna för IoT DPS-instansen. EncryptionPropertiesDescription
iotHubs Lista över IoT-hubbar som är associerade med den här etableringstjänsten. IotHubDefinitionDescription[]
ipFilterRules IP-filterreglerna. IpFilterRule[]
privateEndpointConnections Privata slutpunktsanslutningar som skapats på denna IotHub PrivateEndpointConnection[]
provisioningState ARM-etableringstillståndet för etableringstjänsten. sträng
publicNetworkAccess Om begäranden från offentliga nätverk tillåts "Inaktiverad"
"Aktiverad"
stat Etableringstjänstens aktuella tillstånd. "Aktivera"
"ActivationFailed"
"Aktiv"
"Borttaget"
"Ta bort"
"DeletionFailed"
"Redundans"
"FailoverFailed"
"Återuppta"
"Pausad"
"Pausa"
"Övergång"

IotDpsSkuInfo

Namn Beskrivning Värde
kapacitet Antalet enheter som ska etableras Int
Namn Sku-namn. "S1"

IotHubDefinitionDescription

Namn Beskrivning Värde
allocationWeight vikt för att ansöka om en given iot h. Int
applyAllocationPolicy flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. Bool
connectionString Anslutningssträng för IoT-hubben. sträng (krävs)
plats ARM-regionen för IoT-hubben. sträng (krävs)

IpFilterRule

Namn Beskrivning Värde
handling Ö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-notationen 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"

KeyVaultKeyProperties

Namn Beskrivning Värde
keyIdentifier Nyckelns identifierare. sträng

Microsoft.Devices/provisioningServices

Namn Beskrivning Värde
apiVersion API-versionen "2020-09-01-preview"
etag Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
identitet Hanterade identiteter för IotDps-instansen. ArmIdentity
plats Resursplatsen. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Tjänstspecifika egenskaper för en etableringstjänst IotDpsPropertiesDescription (krävs)
Sku SKU-information för en etableringstjänst. IotDpsSkuInfo (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.Devices/provisioningServices"

PrivateEndpoint

Namn Beskrivning Värde

PrivateEndpointConnection

Namn Beskrivning Värde
Egenskaper Egenskaperna för en privat slutpunktsanslutning PrivateEndpointConnectionProperties (krävs)

PrivateEndpointConnectionProperties

Namn Beskrivning Värde
privateEndpoint Egenskapen privat slutpunkt för en privat slutpunktsanslutning PrivateEndpoint
privateLinkServiceConnectionState Det aktuella tillståndet för en privat slutpunktsanslutning PrivateLinkServiceConnectionState (krävs)

PrivateLinkServiceConnectionState

Namn Beskrivning Värde
actionsRequired Åtgärder som krävs för en privat slutpunktsanslutning sträng
beskrivning Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning sträng (krävs)
status Status för en privat slutpunktsanslutning "Godkänd"
"Frånkopplad"
"Väntar"
"Avvisad" (krävs)

ResourceTags

Namn Beskrivning Värde

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Skapa en IOT Hub- och Ubuntu-kantsimulator

Distribuera till Azure 		Den här mallen skapar en IOT Hub- och Virtual Machine Ubuntu edge-simulator.
Skapa en IoT Hub Device Provisioning-tjänst

Distribuera till Azure 		Med den här mallen kan du skapa en IoT-hubb och en IoT Hub Device Provisioning-tjänst 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-09-01-preview"
  name = "string"
  etag = "string"
  identity = {
    identityType = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  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"
        }
      ]
      encryption = {
        identity = {
          userAssignedIdentity = "string"
        }
        keySource = "string"
        keyVaultProperties = [
          {
            keyIdentifier = "string"
          }
        ]
      }
      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"
    }
  })
}

Egenskapsvärden

ArmIdentity

Namn Beskrivning Värde
identityType Identitetstyp. Endast tillåtna värden är SystemAssigned och UserAssigned. Kommaavgränsade om båda för t.ex. SystemAssigned,UserAssigned. sträng
userAssignedIdentities Uppsättningen användartilldelade identiteter som är associerade med IoT DPS-resursen. ArmIdentityUserAssignedIdentiteter

ArmIdentityUserAssignedIdentiteter

Namn Beskrivning Värde

ArmUserIdentity

Namn Beskrivning Värde

EncryptionKeyIdentity

Namn Beskrivning Värde
userAssignedIdentity Den användartilldelade identiteten. sträng

EncryptionPropertiesDescription

Namn Beskrivning Värde
identitet Den identitet som används för att komma åt krypteringsnyckeln i KeyVault. EncryptionKeyIdentity
keySource Källan till krypteringsnyckeln. Vanligtvis Microsoft.KeyVault sträng
keyVaultProperties Egenskaperna för krypteringsnyckeln som konfigurerats i KeyVault. KeyVaultKeyProperties[]

IotDpsPropertiesDescription

Namn 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. SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
kryptering Krypteringsegenskaperna för IoT DPS-instansen. EncryptionPropertiesDescription
iotHubs Lista över IoT-hubbar som är associerade med den här etableringstjänsten. IotHubDefinitionDescription[]
ipFilterRules IP-filterreglerna. IpFilterRule[]
privateEndpointConnections Privata slutpunktsanslutningar som skapats på denna IotHub PrivateEndpointConnection[]
provisioningState ARM-etableringstillståndet för etableringstjänsten. sträng
publicNetworkAccess Om begäranden från offentliga nätverk tillåts "Inaktiverad"
"Aktiverad"
stat Etableringstjänstens aktuella tillstånd. "Aktivera"
"ActivationFailed"
"Aktiv"
"Borttaget"
"Ta bort"
"DeletionFailed"
"Redundans"
"FailoverFailed"
"Återuppta"
"Pausad"
"Pausa"
"Övergång"

IotDpsSkuInfo

Namn Beskrivning Värde
kapacitet Antalet enheter som ska etableras Int
Namn Sku-namn. "S1"

IotHubDefinitionDescription

Namn Beskrivning Värde
allocationWeight vikt för att ansöka om en given iot h. Int
applyAllocationPolicy flagga för att tillämpa allocationPolicy eller inte för en viss iot-hubb. Bool
connectionString Anslutningssträng för IoT-hubben. sträng (krävs)
plats ARM-regionen för IoT-hubben. sträng (krävs)

IpFilterRule

Namn Beskrivning Värde
handling Ö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-notationen 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"

KeyVaultKeyProperties

Namn Beskrivning Värde
keyIdentifier Nyckelns identifierare. sträng

Microsoft.Devices/provisioningServices

Namn Beskrivning Värde
etag Fältet Etag är inte krävs. Om den anges i svarstexten måste den också anges som en rubrik enligt den normala ETag-konventionen. sträng
identitet Hanterade identiteter för IotDps-instansen. ArmIdentity
plats Resursplatsen. sträng (krävs)
Namn Resursnamnet sträng (krävs)
Egenskaper Tjänstspecifika egenskaper för en etableringstjänst IotDpsPropertiesDescription (krävs)
Sku SKU-information för en etableringstjänst. IotDpsSkuInfo (krävs)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.Devices/provisioningServices@2020-09-01-preview"

PrivateEndpoint

Namn Beskrivning Värde

PrivateEndpointConnection

Namn Beskrivning Värde
Egenskaper Egenskaperna för en privat slutpunktsanslutning PrivateEndpointConnectionProperties (krävs)

PrivateEndpointConnectionProperties

Namn Beskrivning Värde
privateEndpoint Egenskapen privat slutpunkt för en privat slutpunktsanslutning PrivateEndpoint
privateLinkServiceConnectionState Det aktuella tillståndet för en privat slutpunktsanslutning PrivateLinkServiceConnectionState (krävs)

PrivateLinkServiceConnectionState

Namn Beskrivning Värde
actionsRequired Åtgärder som krävs för en privat slutpunktsanslutning sträng
beskrivning Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning sträng (krävs)
status Status för en privat slutpunktsanslutning "Godkänd"
"Frånkopplad"
"Väntar"
"Avvisad" (krävs)

ResourceTags

Namn Beskrivning Värde

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

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