Iot Dps Resource - Create Or Update
Erstellen oder aktualisieren Sie die Metadaten des Bereitstellungsdiensts. Das übliche Muster zum Ändern einer Eigenschaft besteht darin, die Metadaten und Sicherheitsmetadaten des Bereitstellungsdiensts abzurufen und sie dann mit den geänderten Werten in einem neuen Text zu kombinieren, um den Bereitstellungsdienst zu aktualisieren.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2026-08-31
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
provisioning
|
path | True |
string |
Name des zu abrufenden Bereitstellungsdienstes. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet. |
|
subscription
|
path | True |
string minLength: 1 |
Die ID des Zielabonnements. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| location | True |
string |
Der geografische Standort, an dem sich die Ressource befindet |
| properties | True |
Dienstspezifische Eigenschaften für einen Bereitstellungsdienst |
|
| sku | True |
Sku-Informationen für einen Bereitstellungsdienst. |
|
| etag |
string |
Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden. |
|
| identity |
Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. |
||
| resourcegroup |
string |
Die Ressourcengruppe der Ressource. |
|
| subscriptionid |
string |
Die Abonnement-ID der Ressource. |
|
| tags |
object |
Ressourcenkennzeichnungen. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 200 OK |
Die Aktualisierungsoperation der Ressource 'ProvisioningServiceDescription' war erfolgreich |
|
| 201 Created |
Resource 'ProvisioningServiceDescription'-Erstellungsoperation erfolgreich Header
|
|
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
azure_auth
Azure Active Directory OAuth2 Flow.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| user_impersonation | Sich als Ihr Benutzerkonto ausgeben |
Beispiele
| DPSCreate |
|
DPSCreate_Disable |
|
DPSCreate_Disable |
|
DPSCreate |
|
DPSCreate |
| DPSUpdate |
|
DPSUpdate_Disable |
DPSCreate
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"location": "East US",
"properties": {
"enableDataResidency": false
},
"sku": {
"name": "S1",
"capacity": 1
},
"tags": {}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
DPSCreate_DisableLocalAuthFalse
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"location": "East US",
"properties": {
"publicNetworkAccess": "Enabled",
"disableLocalAuth": false
},
"sku": {
"name": "S1",
"capacity": 1
},
"tags": {
"key1": "value1"
}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active",
"disableLocalAuth": false
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {
"key1": "value1"
}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active",
"disableLocalAuth": false
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {
"key1": "value1"
}
}
DPSCreate_DisableLocalAuthTrue
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"location": "East US",
"properties": {
"publicNetworkAccess": "Enabled",
"disableLocalAuth": true
},
"sku": {
"name": "S1",
"capacity": 1
},
"tags": {
"key1": "value1",
"key2": "value2"
}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active",
"disableLocalAuth": true
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {
"key1": "value1",
"key2": "value2"
}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active",
"disableLocalAuth": true
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {
"key1": "value1",
"key2": "value2"
}
}
DPSCreateWithIotHub
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"location": "East US",
"properties": {
"enableDataResidency": false,
"iotHubs": [
{
"applyAllocationPolicy": true,
"allocationWeight": 1,
"hostName": "myFirstIoTHub.azure-devices.net",
"authenticationType": "UserAssigned",
"selectedUserAssignedIdentityResourceId": "/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1",
"location": "eastus"
}
]
},
"sku": {
"name": "S1",
"capacity": 1
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1": {}
}
},
"tags": {}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"iotHubs": [
{
"applyAllocationPolicy": true,
"allocationWeight": 1,
"name": "myFirstIoTHub.azure-devices.net",
"hostName": "myFirstIoTHub.azure-devices.net",
"authenticationType": "UserAssigned",
"selectedUserAssignedIdentityResourceId": "/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1",
"location": "eastus"
}
],
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1": {}
}
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"iotHubs": [
{
"applyAllocationPolicy": true,
"allocationWeight": 1,
"name": "myFirstIoTHub.azure-devices.net",
"hostName": "myFirstIoTHub.azure-devices.net",
"authenticationType": "UserAssigned",
"selectedUserAssignedIdentityResourceId": "/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1",
"location": "eastus"
}
],
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1": {}
}
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
DPSCreateWithNamespace
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"location": "East US",
"properties": {
"enableDataResidency": false
},
"sku": {
"name": "S1",
"capacity": 1
},
"tags": {}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1": {},
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-2": {}
}
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-1": {},
"/subscriptions/abcf2d55-764f-419f-974d-f77a55c2ce55/resourcegroups/my-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/my-mi-2": {}
}
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
DPSUpdate
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"identity": {
"type": "SystemAssigned,UserAssigned",
"userAssignedIdentities": {
"/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {}
}
},
"location": "East US",
"properties": {
"enableDataResidency": false
},
"sku": {
"name": "S1",
"capacity": 1
},
"tags": {}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"identity": {
"type": "SystemAssigned,UserAssigned",
"principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5",
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
"userAssignedIdentities": {
"/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {
"clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323",
"principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9"
}
}
},
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"identity": {
"type": "SystemAssigned,UserAssigned",
"principalId": "aa80bd74-a3f0-4f14-b9da-99c5351cf9d5",
"tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
"userAssignedIdentities": {
"/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourcegroups/testrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity": {
"clientId": "c38f618d-47f6-4260-8b3d-1dd8c130f323",
"principalId": "f1b0b133-10dc-4985-966f-a98a04675fe9"
}
}
},
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"enableDataResidency": false,
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active"
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
DPSUpdate_DisableLocalAuth
Beispielanforderung
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2026-08-31
{
"location": "East US",
"properties": {
"disableLocalAuth": true
},
"sku": {
"name": "S1",
"capacity": 1
},
"tags": {}
}
Beispiel für eine Antwort
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active",
"disableLocalAuth": true
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
{
"name": "myFirstProvisioningService",
"type": "Microsoft.Devices/ProvisioningServices",
"etag": "AAAAAAAADGk=",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"location": "eastus",
"properties": {
"allocationPolicy": "Hashed",
"authorizationPolicies": [],
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012",
"portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net",
"serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
"state": "Active",
"disableLocalAuth": true
},
"resourcegroup": "myResourceGroup",
"sku": {
"name": "S1",
"capacity": 1,
"tier": "Standard"
},
"subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
"tags": {}
}
Definitionen
| Name | Beschreibung |
|---|---|
|
Access |
Rechte, die dieser Schlüssel hat. |
|
Allocation |
Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. |
|
created |
Der Identitätstyp, der die Ressource erstellt hat. |
|
Error |
Fehlerdetails. |
|
Iot |
die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot-Hubs, aktueller Status und vom System generierte Eigenschaften wie Hostname und idScope |
|
Iot |
Sku-Name. |
|
Iot |
Liste der möglichen Bereitstellungsdienst-SKUs. |
|
Iot |
IotHub MI-Authentifizierungstyp: KeyBased, UserAssigned, SystemAssigned. |
|
Iot |
Beschreibung des IoT-Hubs. |
|
Ip |
Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. |
|
Ip |
Die IP-Filterregeln für einen Bereitstellungsdienst. |
|
Ip |
Ziel für Anforderungen, die von dieser Regel erfasst werden. |
|
Managed |
Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten) |
|
Managed |
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). |
|
Private |
Die private Endpunkteigenschaft einer privaten Endpunktverbindung |
|
Private |
Die private Endpunktverbindung eines Bereitstellungsdiensts |
|
Private |
Die Eigenschaften einer privaten Endpunktverbindung |
|
Private |
Der aktuelle Status einer privaten Endpunktverbindung |
|
Private |
Der Status einer privaten Endpunktverbindung |
|
Provisioning |
Die Beschreibung des Bereitstellungsdiensts. |
|
Public |
Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. |
|
Shared |
Beschreibung des freigegebenen Zugriffsschlüssels. |
| State |
Aktueller Status des Bereitstellungsdiensts. |
|
system |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
|
User |
Benutzer zugewiesene Identitätseigenschaften |
AccessRightsDescription
Rechte, die dieser Schlüssel hat.
| Wert | Beschreibung |
|---|---|
| ServiceConfig | |
| EnrollmentRead | |
| EnrollmentWrite | |
| DeviceConnect | |
| RegistrationStatusRead | |
| RegistrationStatusWrite |
AllocationPolicy
Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| Hashed | |
| GeoLatency | |
| Static |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
| Wert | Beschreibung |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorDetails
Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| code |
integer (int32) |
Der Fehlercode. |
| details |
string |
Die Fehlerdetails. |
| httpStatusCode |
string |
Der HTTP-Statuscode. |
| message |
string |
Die Fehlermeldung. |
IotDpsPropertiesDescription
die dienstspezifischen Eigenschaften eines Bereitstellungsdiensts, einschließlich Schlüsseln, verknüpften Iot-Hubs, aktueller Status und vom System generierte Eigenschaften wie Hostname und idScope
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| allocationPolicy |
Zuordnungsrichtlinie, die von diesem Bereitstellungsdienst verwendet werden soll. |
||
| authorizationPolicies |
Shared |
Liste der Autorisierungsschlüssel für einen Bereitstellungsdienst. |
|
| deviceProvisioningHostName |
string |
Geräteendpunkt für diesen Bereitstellungsdienst. |
|
| disableLocalAuth |
boolean |
False |
Deaktiviert alle Authentifizierungsmethoden außer Azure RBAC. |
| enableDataResidency |
boolean |
Dies ist optional. Gibt an, ob die DPS-Instanz Data Residency aktiviert hat und die cross-geo-pair-Notfallwiederherstellung entfernt wird. |
|
| idScope |
string |
Eindeutiger Bezeichner dieses Bereitstellungsdiensts. |
|
| iotHubs |
Liste der IoT-Hubs, die diesem Bereitstellungsdienst zugeordnet sind. |
||
| ipFilterRules |
Die IP-Filterregeln. |
||
| portalOperationsHostName |
string |
Portalendpunkt zum Aktivieren von CORS für diesen Bereitstellungsdienst. |
|
| privateEndpointConnections |
Private Endpunktverbindungen, die auf diesem IotHub erstellt wurden |
||
| provisioningState |
string |
Der ARM-Bereitstellungsstatus des Bereitstellungsdiensts. |
|
| publicNetworkAccess |
Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind. |
||
| serviceOperationsHostName |
string |
Dienstendpunkt für den Bereitstellungsdienst. |
|
| state |
Aktueller Status des Bereitstellungsdiensts. |
IotDpsSku
Sku-Name.
| Wert | Beschreibung |
|---|---|
| S1 |
IotDpsSkuInfo
Liste der möglichen Bereitstellungsdienst-SKUs.
| Name | Typ | Beschreibung |
|---|---|---|
| capacity |
integer (int64) |
Die Anzahl der bereitzustellenden Einheiten |
| name |
Sku-Name. |
|
| tier |
string |
Preisstufenname des Bereitstellungsdiensts. |
IotHubAuthenticationType
IotHub MI-Authentifizierungstyp: KeyBased, UserAssigned, SystemAssigned.
| Wert | Beschreibung |
|---|---|
| KeyBased |
Schlüsselbasierte Authentifizierungsart. |
| UserAssigned |
Vom Benutzer zugewiesener Authentifizierungstyp. |
| SystemAssigned |
Vom System zugewiesener Authentifizierungstyp. |
IotHubDefinitionDescription
Beschreibung des IoT-Hubs.
| Name | Typ | Beschreibung |
|---|---|---|
| allocationWeight |
integer (int32) |
Gewichtung, um für einen bestimmten Iot h anzuwenden. |
| applyAllocationPolicy |
boolean |
Flag für die Anwendung von allocationPolicy oder nicht für einen bestimmten IoT Hub. |
| authenticationType |
IotHub MI-Authentifizierungstyp: KeyBased, UserAssigned, SystemAssigned. |
|
| connectionString |
string |
Verbindungszeichenfolge des IoT-Hubs. Dies ist erforderlich, wenn Authentifizierungstyp KeyBased ist. |
| hostName |
string |
Hostname des IoT-Hubs. Dies ist erforderlich, wenn connectionString nicht bereitgestellt wird. |
| location |
string |
ARM-Region des IoT-Hubs. |
| name |
string |
Hostname des IoT-Hubs. |
| selectedUserAssignedIdentityResourceId |
string (arm-id) |
Die ausgewählte, benutzerzugewiesene Identitätsressourcen-ID, die mit dem IoT-Hub verknüpft ist. Dies ist erforderlich, wenn authenticationType userAssigned ist. |
IpFilterActionType
Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden.
| Wert | Beschreibung |
|---|---|
| Accept | |
| Reject |
IpFilterRule
Die IP-Filterregeln für einen Bereitstellungsdienst.
| Name | Typ | Beschreibung |
|---|---|---|
| action |
Die gewünschte Aktion für Anforderungen, die von dieser Regel erfasst werden. |
|
| filterName |
string |
Der Name der IP-Filterregel. |
| ipMask |
string |
Eine Zeichenfolge, die den IP-Adressbereich in der CIDR-Notation für die Regel enthält. |
| target |
Ziel für Anforderungen, die von dieser Regel erfasst werden. |
IpFilterTargetType
Ziel für Anforderungen, die von dieser Regel erfasst werden.
| Wert | Beschreibung |
|---|---|
| all | |
| serviceApi | |
| deviceApi |
ManagedServiceIdentity
Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
| Name | Typ | Beschreibung |
|---|---|---|
| principalId |
string (uuid) |
Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt. |
| tenantId |
string (uuid) |
Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt. |
| type |
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind). |
|
| userAssignedIdentities |
<string,
User |
User-Assigned Identitäten |
ManagedServiceIdentityType
Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
| Wert | Beschreibung |
|---|---|
| None | |
| SystemAssigned | |
| UserAssigned | |
| SystemAssigned,UserAssigned |
PrivateEndpoint
Die private Endpunkteigenschaft einer privaten Endpunktverbindung
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Der Ressourcenbezeichner. |
PrivateEndpointConnection
Die private Endpunktverbindung eines Bereitstellungsdiensts
| Name | Typ | Beschreibung |
|---|---|---|
| id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
Der Name der Ressource |
| properties |
Die Eigenschaften einer privaten Endpunktverbindung |
|
| systemData |
Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. |
|
| type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
PrivateEndpointConnectionProperties
Die Eigenschaften einer privaten Endpunktverbindung
| Name | Typ | Beschreibung |
|---|---|---|
| privateEndpoint |
Die private Endpunkteigenschaft einer privaten Endpunktverbindung |
|
| privateLinkServiceConnectionState |
Der aktuelle Status einer privaten Endpunktverbindung |
PrivateLinkServiceConnectionState
Der aktuelle Status einer privaten Endpunktverbindung
| Name | Typ | Beschreibung |
|---|---|---|
| actionsRequired |
string |
Aktionen, die für eine private Endpunktverbindung erforderlich sind |
| description |
string |
Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung |
| status |
Der Status einer privaten Endpunktverbindung |
PrivateLinkServiceConnectionStatus
Der Status einer privaten Endpunktverbindung
| Wert | Beschreibung |
|---|---|
| Pending | |
| Approved | |
| Rejected | |
| Disconnected |
ProvisioningServiceDescription
Die Beschreibung des Bereitstellungsdiensts.
| Name | Typ | Beschreibung |
|---|---|---|
| etag |
string |
Das Feld "Etag" ist nicht erforderlich. Wenn sie im Antworttext bereitgestellt wird, muss sie auch als Kopfzeile gemäß der normalen ETag-Konvention bereitgestellt werden. |
| id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| identity |
Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind. |
|
| location |
string |
Der geografische Standort, an dem sich die Ressource befindet |
| name |
string |
Der Name der Ressource |
| properties |
Dienstspezifische Eigenschaften für einen Bereitstellungsdienst |
|
| resourcegroup |
string |
Die Ressourcengruppe der Ressource. |
| sku |
Sku-Informationen für einen Bereitstellungsdienst. |
|
| subscriptionid |
string |
Die Abonnement-ID der Ressource. |
| systemData |
Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten. |
|
| tags |
object |
Ressourcenkennzeichnungen. |
| type |
string |
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" |
PublicNetworkAccess
Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.
| Wert | Beschreibung |
|---|---|
| Enabled | |
| Disabled |
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
Beschreibung des freigegebenen Zugriffsschlüssels.
| Name | Typ | Beschreibung |
|---|---|---|
| keyName |
string |
Name des Schlüssels. |
| primaryKey |
string |
Primärer SAS-Schlüsselwert. |
| rights |
Rechte, die dieser Schlüssel hat. |
|
| secondaryKey |
string |
Sekundärer SAS-Schlüsselwert. |
State
Aktueller Status des Bereitstellungsdiensts.
| Wert | Beschreibung |
|---|---|
| Activating | |
| Active | |
| Deleting | |
| Deleted | |
| ActivationFailed | |
| DeletionFailed | |
| Transitioning | |
| Suspending | |
| Suspended | |
| Resuming | |
| FailingOver | |
| FailoverFailed |
systemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
| Name | Typ | Beschreibung |
|---|---|---|
| createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
| createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
| createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
| lastModifiedAt |
string (date-time) |
Der Zeitstempel der letzten Änderung der Ressource (UTC) |
| lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
| lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
UserAssignedIdentity
Benutzer zugewiesene Identitätseigenschaften
| Name | Typ | Beschreibung |
|---|---|---|
| clientId |
string (uuid) |
Die Client-ID der zugewiesenen Identität. |
| principalId |
string (uuid) |
Die Prinzipal-ID der zugewiesenen Identität. |