Microsoft.Devices provisioningServices 2022-12-12

Artikel
10/26/2024

Bicep-Ressourcendefinition

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

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@2022-12-12' = {
  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'
      }
    ]
    portalOperationsHostName: 'string'
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {}
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
        }
      }
    ]
    provisioningState: 'string'
    publicNetworkAccess: 'string'
    state: 'string'
  }
  resourcegroup: 'string'
  sku: {
    capacity: int
    name: 'string'
  }
  subscriptionid: 'string'
  tags: {
    {customized property}: 'string'
  }
}

Eigenschaftswerte

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.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Wahlfrei. Gibt an, ob die DPS-Instanz Data Residency aktiviert hat und die cross-geo-pair-Notfallwiederherstellung entfernt wird.	Bool
iotHubs	Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind.	IotHubDefinitionDescription[]
ipFilterRules	Die IP-Filterregeln.	IpFilterRule-[]
portalOperationsHostName	Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst.	Schnur
privateEndpointConnections	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden	PrivateEndpointConnection[]
provisioningState	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.	Schnur
publicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.	"Deaktiviert" "Aktiviert"
Zustand	Aktueller Status des Bereitstellungsdiensts.	"Aktivieren" "ActivationFailed" "Aktiv" "Gelöscht" "Löschen" "DeleteFailed" 'FailOver' 'FailoverFailed' "Fortsetzen" "Angehalten" "Anhalten" "Transitioning"

IotDpsSkuInfo

Name	Beschreibung	Wert
Fassungsvermögen	Die Anzahl der bereitzustellenden Einheiten	Int
Name	Sku-Name.	'S1'

IotHubDefinitionDescription

Name	Beschreibung	Wert
allocationWeight	Gewichtung, um für einen bestimmten Iot h anzuwenden.	Int
applyAllocationPolicy	flag for applying allocationPolicy or not for a given iot hub.	Bool
connectionString	Verbindungszeichenfolge des IoT-Hubs.	Zeichenfolge (erforderlich)
Ort	ARM-Region des IoT-Hubs.	Zeichenfolge (erforderlich)

IpFilterRule

Name	Beschreibung	Wert
Aktion	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)
Ziel	Ziel für Anforderungen, die von dieser Regel erfasst werden.	"alle" "deviceApi" 'serviceApi'

Microsoft.Devices/provisioningServices

Name	Beschreibung	Wert
etag	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.	Schnur
Ort	Der Ressourcenspeicherort.	Zeichenfolge (erforderlich)
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Eigenschaften	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst	IotDpsPropertiesDescription (erforderlich)
resourcegroup	Die Ressourcengruppe der Ressource.	Schnur
Sku	Sku-Informationen für einen Bereitstellungsdienst.	IotDpsSkuInfo- (erforderlich)
subscriptionid	Die Abonnement-ID der Ressource.	Schnur
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

PrivateEndpoint

Name	Beschreibung	Wert

PrivateEndpointConnection

Name	Beschreibung	Wert
Eigenschaften	Die Eigenschaften einer privaten Endpunktverbindung	PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name	Beschreibung	Wert
privateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung	PrivateEndpoint-
privateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung	PrivateLinkServiceConnectionState (erforderlich)

PrivateLinkServiceConnectionState

Name	Beschreibung	Wert
actionsRequired	Aktionen, die für eine private Endpunktverbindung erforderlich sind	Schnur
Beschreibung	Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung	Zeichenfolge (erforderlich)
Status	Der Status einer privaten Endpunktverbindung	"Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich)

ResourceTags

Name	Beschreibung	Wert

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Name	Beschreibung	Wert
keyName	Der Name des Schlüssels.	Zeichenfolge (erforderlich)
primaryKey	Primärer SAS-Schlüsselwert.	Schnur
Rechte	Rechte, die dieser Schlüssel hat.	"DeviceConnect" "EnrollmentRead" 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (erforderlich)
secondaryKey	Sekundärer SAS-Schlüsselwert.	Schnur

Schnellstartbeispiele

Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.

Bicep-Datei	Beschreibung
Erstellen eines IoT Hub-Gerätebereitstellungsdiensts	Mit dieser Vorlage können Sie einen IoT-Hub und einen IoT Hub-Gerätebereitstellungsdienst erstellen und die beiden Dienste miteinander verknüpfen.

ARM-Vorlagenressourcendefinition

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

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 JSON-Code hinzu.

{
  "type": "Microsoft.Devices/provisioningServices",
  "apiVersion": "2022-12-12",
  "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"
      }
    ],
    "portalOperationsHostName": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          }
        }
      }
    ],
    "provisioningState": "string",
    "publicNetworkAccess": "string",
    "state": "string"
  },
  "resourcegroup": "string",
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "subscriptionid": "string",
  "tags": {
    "{customized property}": "string"
  }
}

Eigenschaftswerte

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.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Wahlfrei. Gibt an, ob die DPS-Instanz Data Residency aktiviert hat und die cross-geo-pair-Notfallwiederherstellung entfernt wird.	Bool
iotHubs	Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind.	IotHubDefinitionDescription[]
ipFilterRules	Die IP-Filterregeln.	IpFilterRule-[]
portalOperationsHostName	Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst.	Schnur
privateEndpointConnections	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden	PrivateEndpointConnection[]
provisioningState	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.	Schnur
publicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.	"Deaktiviert" "Aktiviert"
Zustand	Aktueller Status des Bereitstellungsdiensts.	"Aktivieren" "ActivationFailed" "Aktiv" "Gelöscht" "Löschen" "DeleteFailed" 'FailOver' 'FailoverFailed' "Fortsetzen" "Angehalten" "Anhalten" "Transitioning"

IotDpsSkuInfo

Name	Beschreibung	Wert
Fassungsvermögen	Die Anzahl der bereitzustellenden Einheiten	Int
Name	Sku-Name.	'S1'

IotHubDefinitionDescription

Name	Beschreibung	Wert
allocationWeight	Gewichtung, um für einen bestimmten Iot h anzuwenden.	Int
applyAllocationPolicy	flag for applying allocationPolicy or not for a given iot hub.	Bool
connectionString	Verbindungszeichenfolge des IoT-Hubs.	Zeichenfolge (erforderlich)
Ort	ARM-Region des IoT-Hubs.	Zeichenfolge (erforderlich)

IpFilterRule

Name	Beschreibung	Wert
Aktion	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)
Ziel	Ziel für Anforderungen, die von dieser Regel erfasst werden.	"alle" "deviceApi" 'serviceApi'

Microsoft.Devices/provisioningServices

Name	Beschreibung	Wert
apiVersion	Die API-Version	'2022-12-12'
etag	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.	Schnur
Ort	Der Ressourcenspeicherort.	Zeichenfolge (erforderlich)
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Eigenschaften	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst	IotDpsPropertiesDescription (erforderlich)
resourcegroup	Die Ressourcengruppe der Ressource.	Schnur
Sku	Sku-Informationen für einen Bereitstellungsdienst.	IotDpsSkuInfo- (erforderlich)
subscriptionid	Die Abonnement-ID der Ressource.	Schnur
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art	Der Ressourcentyp	"Microsoft.Devices/provisioningServices"

PrivateEndpoint

Name	Beschreibung	Wert

PrivateEndpointConnection

Name	Beschreibung	Wert
Eigenschaften	Die Eigenschaften einer privaten Endpunktverbindung	PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name	Beschreibung	Wert
privateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung	PrivateEndpoint-
privateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung	PrivateLinkServiceConnectionState (erforderlich)

PrivateLinkServiceConnectionState

Name	Beschreibung	Wert
actionsRequired	Aktionen, die für eine private Endpunktverbindung erforderlich sind	Schnur
Beschreibung	Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung	Zeichenfolge (erforderlich)
Status	Der Status einer privaten Endpunktverbindung	"Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich)

ResourceTags

Name	Beschreibung	Wert

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Name	Beschreibung	Wert
keyName	Der Name des Schlüssels.	Zeichenfolge (erforderlich)
primaryKey	Primärer SAS-Schlüsselwert.	Schnur
Rechte	Rechte, die dieser Schlüssel hat.	"DeviceConnect" "EnrollmentRead" 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (erforderlich)
secondaryKey	Sekundärer SAS-Schlüsselwert.	Schnur

Schnellstartvorlagen

Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.

Schablone	Beschreibung
Erstellen eines IOT Hub- und Ubuntu-Edgesimulators	Diese Vorlage erstellt einen IOT Hub und einen Virtuellen Computer Ubuntu Edge Simulator.
Erstellen eines IoT Hub-Gerätebereitstellungsdiensts	Mit dieser Vorlage können Sie einen IoT-Hub und einen IoT Hub-Gerätebereitstellungsdienst 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 unter Änderungsprotokoll.

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Devices/provisioningServices@2022-12-12"
  name = "string"
  etag = "string"
  location = "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"
        }
      ]
      portalOperationsHostName = "string"
      privateEndpointConnections = [
        {
          properties = {
            privateEndpoint = {
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
          }
        }
      ]
      provisioningState = "string"
      publicNetworkAccess = "string"
      state = "string"
    }
  })
  resourcegroup = "string"
  sku = {
    capacity = int
    name = "string"
  }
  subscriptionid = "string"
  tags = {
    {customized property} = "string"
  }
}

Eigenschaftswerte

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.	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]
enableDataResidency	Wahlfrei. Gibt an, ob die DPS-Instanz Data Residency aktiviert hat und die cross-geo-pair-Notfallwiederherstellung entfernt wird.	Bool
iotHubs	Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind.	IotHubDefinitionDescription[]
ipFilterRules	Die IP-Filterregeln.	IpFilterRule-[]
portalOperationsHostName	Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst.	Schnur
privateEndpointConnections	Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden	PrivateEndpointConnection[]
provisioningState	Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts.	Schnur
publicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.	"Deaktiviert" "Aktiviert"
Zustand	Aktueller Status des Bereitstellungsdiensts.	"Aktivieren" "ActivationFailed" "Aktiv" "Gelöscht" "Löschen" "DeleteFailed" 'FailOver' 'FailoverFailed' "Fortsetzen" "Angehalten" "Anhalten" "Transitioning"

IotDpsSkuInfo

Name	Beschreibung	Wert
Fassungsvermögen	Die Anzahl der bereitzustellenden Einheiten	Int
Name	Sku-Name.	'S1'

IotHubDefinitionDescription

Name	Beschreibung	Wert
allocationWeight	Gewichtung, um für einen bestimmten Iot h anzuwenden.	Int
applyAllocationPolicy	flag for applying allocationPolicy or not for a given iot hub.	Bool
connectionString	Verbindungszeichenfolge des IoT-Hubs.	Zeichenfolge (erforderlich)
Ort	ARM-Region des IoT-Hubs.	Zeichenfolge (erforderlich)

IpFilterRule

Name	Beschreibung	Wert
Aktion	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)
Ziel	Ziel für Anforderungen, die von dieser Regel erfasst werden.	"alle" "deviceApi" 'serviceApi'

Microsoft.Devices/provisioningServices

Name	Beschreibung	Wert
etag	Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden.	Schnur
Ort	Der Ressourcenspeicherort.	Zeichenfolge (erforderlich)
Name	Der Ressourcenname	Zeichenfolge (erforderlich)
Eigenschaften	Dienstspezifische Eigenschaften für einen Bereitstellungsdienst	IotDpsPropertiesDescription (erforderlich)
resourcegroup	Die Ressourcengruppe der Ressource.	Schnur
Sku	Sku-Informationen für einen Bereitstellungsdienst.	IotDpsSkuInfo- (erforderlich)
subscriptionid	Die Abonnement-ID der Ressource.	Schnur
Schilder	Ressourcentags	Wörterbuch der Tagnamen und -werte.
Art	Der Ressourcentyp	"Microsoft.Devices/provisioningServices@2022-12-12"

PrivateEndpoint

Name	Beschreibung	Wert

PrivateEndpointConnection

Name	Beschreibung	Wert
Eigenschaften	Die Eigenschaften einer privaten Endpunktverbindung	PrivateEndpointConnectionProperties (erforderlich)

PrivateEndpointConnectionProperties

Name	Beschreibung	Wert
privateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung	PrivateEndpoint-
privateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung	PrivateLinkServiceConnectionState (erforderlich)

PrivateLinkServiceConnectionState

Name	Beschreibung	Wert
actionsRequired	Aktionen, die für eine private Endpunktverbindung erforderlich sind	Schnur
Beschreibung	Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung	Zeichenfolge (erforderlich)
Status	Der Status einer privaten Endpunktverbindung	"Genehmigt" "Getrennt" "Ausstehend" "Abgelehnt" (erforderlich)

ResourceTags

Name	Beschreibung	Wert

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Name	Beschreibung	Wert
keyName	Der Name des Schlüssels.	Zeichenfolge (erforderlich)
primaryKey	Primärer SAS-Schlüsselwert.	Schnur
Rechte	Rechte, die dieser Schlüssel hat.	"DeviceConnect" "EnrollmentRead" 'EnrollmentWrite' 'RegistrationStatusRead' 'RegistrationStatusWrite' 'ServiceConfig' (erforderlich)
secondaryKey	Sekundärer SAS-Schlüsselwert.	Schnur

Freigeben über

Microsoft.Devices provisioningServices 2022-12-12

Bicep-Ressourcendefinition

Ressourcenformat

Eigenschaftswerte

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Schnellstartbeispiele

ARM-Vorlagenressourcendefinition

Ressourcenformat

Eigenschaftswerte

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Schnellstartvorlagen

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Ressourcenformat

Eigenschaftswerte

IotDpsPropertiesDescription

IotDpsSkuInfo

IotHubDefinitionDescription

IpFilterRule

Microsoft.Devices/provisioningServices

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState

ResourceTags

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Feedback

Zusätzliche Ressourcen