Microsoft.Devices ProvisioningServices 2020-01-01

Artikel
04/10/2024

Bicep-Ressourcendefinition

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

Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle

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 ihrer Vorlage den folgenden Bicep hinzu.

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'
  }
}

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. 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[]
provisioningState	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.	Zeichenfolge
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, die dieser Schlüssel besitzt.	"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 für den IoT-Hub.	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"

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	Diese Vorlage erstellt einen IOT Hub und einen Ubuntu-Edgesimulator für virtuelle Computer.
Erstellen eines IoT Hub Device Provisioning-Diensts	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 auf Folgendes abzielen:

Ressourcengruppen – Siehe Bereitstellungsbefehle für 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 den folgenden JSON-Code hinzu.

{
  "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"
  }
}

Eigenschaftswerte

provisioningServices

Name	BESCHREIBUNG	Wert
type	Der Ressourcentyp	"Microsoft.Devices/provisioningServices"
apiVersion	Die Version der Ressourcen-API	'2020-01-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[]
provisioningState	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.	Zeichenfolge
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, die dieser Schlüssel besitzt.	"DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (erforderlich)
secondaryKey	Sekundärer SAS-Schlüsselwert.	Zeichenfolge
keyName	Name des Schlüssels.	Zeichenfolge (erforderlich)
primaryKey	Primärer SAS-Schlüsselwert.	Zeichenfolge
Rechte	Rechte, die dieser Schlüssel besitzt.	"DeviceConnect" "EnrollmentRead" "EnrollmentWrite" "RegistrationStatusRead" "RegistrationStatusWrite" "ServiceConfig" (erforderlich)
secondaryKey	Sekundärer SAS-Schlüsselwert.	Zeichenfolge

IotHubDefinitionDescription

Name	BESCHREIBUNG	Wert
allocationWeight	Gewicht, das für einen bestimmten iot h beantragt werden soll.	INT
applyAllocationPolicy	Flag für die Anwendung von allocationPolicy oder nicht für einen bestimmten iot Hub.	bool
connectionString	Verbindungszeichenfolge und IoT Hub.	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.	"Akzeptieren" "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"

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	Mit dieser Vorlage wird ein IOT Hub und ein Ubuntu-Edgesimulator für virtuelle Computer erstellt.
Erstellen eines IoT Hub Device Provisioning Service	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 (AzAPI-Anbieter) Ressourcendefinition

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

Ressourcengruppen

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 die folgende Terraform-Ressource hinzu.

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"
  })
}

Eigenschaftswerte

provisioningServices

Name	BESCHREIBUNG	Wert
type	Ressourcentyp	"Microsoft.Devices/provisioningServices@2020-01-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 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.	"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[]
provisioningState	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.	Zeichenfolge
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 für den IoT-Hub.	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"

IotDpsSkuInfo

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

Share via

Microsoft.Devices ProvisioningServices 2020-01-01

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IpFilterRule

IotDpsSkuInfo

Schnellstartvorlagen

Ressourcendefinition mit einer ARM-Vorlage

Ressourcenformat

Eigenschaftswerte

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IpFilterRule

IotDpsSkuInfo

Schnellstartvorlagen

Terraform (AzAPI-Anbieter) Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

provisioningServices

IotDpsPropertiesDescription

SharedAccessSignatureAuthorizationRuleAccessRightsDe...

IotHubDefinitionDescription

IpFilterRule

IotDpsSkuInfo

Feedback

Feedback

Zusätzliche Ressourcen