Freigeben über


Microsoft.Devices provisioningServices 2020-03-01

Bicep-Ressourcendefinition

Der Ressourcentyp provisioningServices kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Devices/provisioningServices-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Devices/provisioningServices@2020-03-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'
      }
    ]
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
}

Eigenschaftswerte

provisioningServices

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-64

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Enden Sie mit einem alphanumerischen Zeichen.
location Der Ressourcenspeicherort. Zeichenfolge (erforderlich)
tags Die Ressourcentags. Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
sku SKU-Informationen für einen Bereitstellungsdienst. IotDpsSkuInfo (erforderlich)
etag Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden. Zeichenfolge
properties Dienstspezifische Eigenschaften für einen Bereitstellungsdienst IotDpsPropertiesDescription (erforderlich)

IotDpsPropertiesDescription

Name BESCHREIBUNG Wert
allocationPolicy Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. "GeoLatency"
"Hashed"
"Statisch"
authorizationPolicies Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Liste der IoT Hubs, die diesem Bereitstellungsdienst zugeordnet sind. IotHubDefinitionDescription[]
ipFilterRules Die IP-Filterregeln. IpFilterRule[]
privateEndpointConnections. Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden PrivateEndpointConnection[]
provisioningState Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts. Zeichenfolge
publicNetworkAccess Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind "Deaktiviert"
"Aktiviert"
state Aktueller Status des Bereitstellungsdiensts. "Aktivieren"
"ActivationFailed"
"Aktiv"
"Gelöscht"
"Löschen"
"DeletionFailed"
"FailOver"
"FailoverFailed"
"Fortsetzen"
"Angehalten"
"Anhalten"
"Übergang"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Name BESCHREIBUNG Wert
keyName Name des Schlüssels. Zeichenfolge (erforderlich)
primaryKey Primärer SAS-Schlüsselwert. Zeichenfolge
Rechte Rechte, über die dieser Schlüssel verfügt. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (erforderlich)
secondaryKey Wert des sekundären SAS-Schlüssels. Zeichenfolge
keyName Name des Schlüssels. Zeichenfolge (erforderlich)
primaryKey Primärer SAS-Schlüsselwert. Zeichenfolge
Rechte Rechte, über die dieser Schlüssel verfügt. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (erforderlich)
secondaryKey Wert des sekundären SAS-Schlüssels. Zeichenfolge

IotHubDefinitionDescription

Name BESCHREIBUNG Wert
allocationWeight Gewichtung, die für einen bestimmten iot h-Wert angewendet werden soll. INT
applyAllocationPolicy flag for applying allocationPolicy or not for a given iot hub. bool
connectionString Verbindungszeichenfolge des IoT-Hubs. Zeichenfolge (erforderlich)
location ARM-Region des IoT-Hubs. Zeichenfolge (erforderlich)

IpFilterRule

Name BESCHREIBUNG Wert
action Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. "Annehmen"
"Ablehnen" (erforderlich)
filterName Der Name der IP-Filterregel. Zeichenfolge (erforderlich)
ipMask Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. Zeichenfolge (erforderlich)
target Ziel für Anforderungen, die von dieser Regel erfasst werden. 'all'
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Name BESCHREIBUNG Wert
properties Die Eigenschaften einer Verbindung mit einem privaten Endpunkt PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name BESCHREIBUNG Wert
privateEndpoint Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt PrivateEndpoint
privateLinkServiceConnectionState Der aktuelle Status einer Verbindung mit einem privaten Endpunkt PrivateLinkServiceConnectionState (erforderlich)

PrivateEndpoint

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

PrivateLinkServiceConnectionState

Name BESCHREIBUNG Wert
actionsRequired Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen Zeichenfolge
description Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt Zeichenfolge (erforderlich)
status Die status einer Verbindung mit einem privaten Endpunkt "Genehmigt"
"Getrennt"
"Ausstehend"
"Abgelehnt" (erforderlich)

IotDpsSkuInfo

Name BESCHREIBUNG Wert
Kapazität Die Anzahl der bereitzustellenden Einheiten INT
name Sku-Name. 'S1'

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines IOT Hub- und Ubuntu-Edgesimulators

Bereitstellen in Azure
Mit dieser Vorlage wird ein IOT Hub und ein Ubuntu-Edgesimulator für virtuelle Computer erstellt.
Erstellen eines IoT Hub Device Provisioning Service

Bereitstellen in Azure
Mit dieser Vorlage können Sie einen IoT Hub und einen IoT Hub Device Provisioning Service erstellen und die beiden Dienste miteinander verknüpfen.

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp provisioningServices kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Devices/provisioningServices-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2020-03-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"
      }
    ],
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {},
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  }
}

Eigenschaftswerte

provisioningServices

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.Devices/provisioningServices"
apiVersion Die Ressourcen-API-Version '2020-03-01'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-64

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Enden Sie mit einem alphanumerischen Zeichen.
location Der Ressourcenspeicherort. Zeichenfolge (erforderlich)
tags Die Ressourcentags. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku SKU-Informationen für einen Bereitstellungsdienst. IotDpsSkuInfo (erforderlich)
etag Das Feld Etag ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss es auch als Header gemäß der normalen ETag-Konvention bereitgestellt werden. Zeichenfolge
properties Dienstspezifische Eigenschaften für einen Bereitstellungsdienst IotDpsPropertiesDescription (erforderlich)

IotDpsPropertiesDescription

Name BESCHREIBUNG Wert
allocationPolicy Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. Geolatenz
"Hashed"
"Statisch"
authorizationPolicies Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Liste der IoT Hubs, die diesem Bereitstellungsdienst zugeordnet sind. IotHubDefinitionDescription[]
ipFilterRules Die IP-Filterregeln. IpFilterRule[]
privateEndpointConnections. Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden PrivateEndpointConnection[]
provisioningState Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts. Zeichenfolge
publicNetworkAccess Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind "Deaktiviert"
"Aktiviert"
state Aktueller Status des Bereitstellungsdiensts. "Aktivieren"
"ActivationFailed"
"Aktiv"
"Gelöscht"
"Löschen"
"DeletionFailed"
"FailOver"
"FailoverFailed"
"Fortsetzen"
"Angehalten"
"Anhalten"
"Übergang"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Name BESCHREIBUNG Wert
keyName Name des Schlüssels. Zeichenfolge (erforderlich)
primaryKey Primärer SAS-Schlüsselwert. Zeichenfolge
Rechte Rechte, über die dieser Schlüssel verfügt. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (erforderlich)
secondaryKey Wert des sekundären SAS-Schlüssels. Zeichenfolge
keyName Name des Schlüssels. Zeichenfolge (erforderlich)
primaryKey Primärer SAS-Schlüsselwert. Zeichenfolge
Rechte Rechte, über die dieser Schlüssel verfügt. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
'ServiceConfig' (erforderlich)
secondaryKey Wert des sekundären SAS-Schlüssels. Zeichenfolge

IotHubDefinitionDescription

Name BESCHREIBUNG Wert
allocationWeight Gewichtung, die für einen bestimmten iot h-Wert angewendet werden soll. INT
applyAllocationPolicy flag for applying allocationPolicy or not for a given iot hub. bool
connectionString Verbindungszeichenfolge des IoT-Hubs. Zeichenfolge (erforderlich)
location ARM-Region des IoT-Hubs. Zeichenfolge (erforderlich)

IpFilterRule

Name BESCHREIBUNG Wert
action Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. "Annehmen"
"Ablehnen" (erforderlich)
filterName Der Name der IP-Filterregel. Zeichenfolge (erforderlich)
ipMask Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. Zeichenfolge (erforderlich)
target Ziel für Anforderungen, die von dieser Regel erfasst werden. 'all'
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Name BESCHREIBUNG Wert
properties Die Eigenschaften einer Verbindung mit einem privaten Endpunkt PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name BESCHREIBUNG Wert
privateEndpoint Die Eigenschaft des privaten Endpunkts einer Verbindung mit einem privaten Endpunkt PrivateEndpoint
privateLinkServiceConnectionState Der aktuelle Status einer Verbindung mit einem privaten Endpunkt PrivateLinkServiceConnectionState (erforderlich)

PrivateEndpoint

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

PrivateLinkServiceConnectionState

Name BESCHREIBUNG Wert
actionsRequired Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen Zeichenfolge
description Die Beschreibung für den aktuellen Status einer Verbindung mit einem privaten Endpunkt Zeichenfolge (erforderlich)
status Die status einer Verbindung mit einem privaten Endpunkt "Genehmigt"
"Getrennt"
"Ausstehend"
"Abgelehnt" (erforderlich)

IotDpsSkuInfo

Name BESCHREIBUNG Wert
Kapazität Die Anzahl der bereitzustellenden Einheiten INT
name SKU-Name. 'S1'

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines IOT Hub- und Ubuntu-Edgesimulators

Bereitstellen in Azure
Diese Vorlage erstellt einen IOT Hub und einen Ubuntu-Edgesimulator für virtuelle Computer.
Erstellen eines IoT Hub Device Provisioning-Diensts

Bereitstellen in Azure
Mit dieser Vorlage können Sie einen IoT Hub und einen IoT Hub Device Provisioning Service erstellen und die beiden Dienste miteinander verknüpfen.

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp provisioningServices kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Devices/provisioningServices-Ressource zu erstellen, fügen Sie Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2020-03-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"
        }
      ]
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {}
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
    sku = {
      capacity = int
      name = "S1"
    }
    etag = "string"
  })
}

Eigenschaftswerte

provisioningServices

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.Devices/provisioningServices@2020-03-01"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-64

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Enden Sie mit einem alphanumerischen Zeichen.
location Der Ressourcenspeicherort. Zeichenfolge (erforderlich)
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Die Ressourcentags. Wörterbuch der Tagnamen und -werte.
sku SKU-Informationen für einen Bereitstellungsdienst. IotDpsSkuInfo (erforderlich)
etag Das Etag-Feld ist nicht erforderlich. Wenn es im Antworttext angegeben wird, muss er gemäß der normalen ETag-Konvention auch als Header bereitgestellt werden. Zeichenfolge
properties Dienstspezifische Eigenschaften für einen Bereitstellungsdienst IotDpsPropertiesDescription (erforderlich)

IotDpsPropertiesDescription

Name BESCHREIBUNG Wert
allocationPolicy Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. "GeoLatency"
"Hashed"
"Statisch"
authorizationPolicies Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst. SharedAccessSignatureAuthorizationRuleAccessRightsDe...[]
iotHubs Liste der IoT Hubs, die diesem Bereitstellungsdienst zugeordnet sind. IotHubDefinitionDescription[]
ipFilterRules Die IP-Filterregeln. IpFilterRule[]
privateEndpointConnections. Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden PrivateEndpointConnection[]
provisioningState Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts. Zeichenfolge
publicNetworkAccess Ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind "Deaktiviert"
"Aktiviert"
state Aktueller Status des Bereitstellungsdiensts. "Aktivieren"
"ActivationFailed"
"Aktiv"
"Gelöscht"
"Löschen"
"DeletionFailed"
"FailOver"
"FailoverFailed"
"Fortsetzen"
"Angehalten"
"Anhalten"
"Übergang"

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

Name BESCHREIBUNG Wert
keyName Name des Schlüssels. Zeichenfolge (erforderlich)
primaryKey Primärer SAS-Schlüsselwert. Zeichenfolge
Rechte Rechte, über die dieser Schlüssel verfügt. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (erforderlich)
secondaryKey Wert des sekundären SAS-Schlüssels. Zeichenfolge
keyName Name des Schlüssels. Zeichenfolge (erforderlich)
primaryKey Primärer SAS-Schlüsselwert. Zeichenfolge
Rechte Rechte, über die dieser Schlüssel verfügt. "DeviceConnect"
"EnrollmentRead"
"EnrollmentWrite"
"RegistrationStatusRead"
"RegistrationStatusWrite"
"ServiceConfig" (erforderlich)
secondaryKey Wert des sekundären SAS-Schlüssels. Zeichenfolge

IotHubDefinitionDescription

Name BESCHREIBUNG Wert
allocationWeight Gewichtung, die für einen bestimmten iot h-Wert angewendet werden soll. INT
applyAllocationPolicy flag for applying allocationPolicy or not for a given iot hub. bool
connectionString Verbindungszeichenfolge des IoT-Hubs. Zeichenfolge (erforderlich)
location ARM-Region des IoT-Hubs. Zeichenfolge (erforderlich)

IpFilterRule

Name BESCHREIBUNG Wert
action Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. "Annehmen"
"Ablehnen" (erforderlich)
filterName Der Name der IP-Filterregel. Zeichenfolge (erforderlich)
ipMask Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. Zeichenfolge (erforderlich)
target Ziel für Anforderungen, die von dieser Regel erfasst werden. "alle"
"deviceApi"
"serviceApi"

PrivateEndpointConnection

Name BESCHREIBUNG Wert
properties Die Eigenschaften einer Verbindung mit einem privaten Endpunkt PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name BESCHREIBUNG Wert
privateEndpoint Die Eigenschaft des privaten Endpunkts einer privaten Endpunktverbindung PrivateEndpoint
privateLinkServiceConnectionState Der aktuelle Zustand einer Verbindung mit einem privaten Endpunkt PrivateLinkServiceConnectionState (erforderlich)

PrivateEndpoint

Dieses Objekt enthält keine Eigenschaften, die während der Bereitstellung festgelegt werden sollen. Alle Eigenschaften sind ReadOnly.

PrivateLinkServiceConnectionState

Name BESCHREIBUNG Wert
actionsRequired Für eine Verbindung mit einem privaten Endpunkt erforderliche Aktionen Zeichenfolge
description Die Beschreibung für den aktuellen Zustand einer Verbindung mit einem privaten Endpunkt Zeichenfolge (erforderlich)
status Die status einer privaten Endpunktverbindung "Genehmigt"
"Getrennt"
"Ausstehend"
"Abgelehnt" (erforderlich)

IotDpsSkuInfo

Name BESCHREIBUNG Wert
Kapazität Die Anzahl der bereitzustellenden Einheiten INT
name Sku-Name. "S1"