Iot Dps Resource - Create Or Update

サービス:: IoT Hub Device Provisioning Service

API バージョン:: 2026-08-31

プロビジョニングサービスのメタデータを作成または更新します。プロパティを変更する通常のパターンは、プロビジョニングサービスのメタデータとセキュリティメタデータを取得し、それらを新しい本文で変更した値と組み合わせてプロビジョニングサービスを更新することです。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2026-08-31

URI パラメーター

名前	/	必須	型	説明
provisioningServiceName	path	True	string	取得すべきプロビジョニングサービスの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前は大文字と小文字を区別しません。
subscriptionId	path	True	string minLength: 1	ターゲットサブスクリプションの ID。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
location	True	string	リソースが存在する地理的な場所
properties	True	IotDpsPropertiesDescription	プロビジョニングサービスのサービス固有のプロパティ
sku	True	IotDpsSkuInfo	プロビジョニングサービスの SKU 情報。
etag		string	Etag フィールドは必須ではありません。応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
identity		ManagedServiceIdentity	このリソースに割り当てられているマネージドサービス ID。
resourcegroup		string	リソースのリソースグループ。
subscriptionid		string	リソースのサブスクリプション ID。
tags		object	リソースタグ。

応答

名前	型	説明
200 OK	ProvisioningServiceDescription	リソース「ProvisioningServiceDescription」更新操作が成功しました
201 Created	ProvisioningServiceDescription	リソース「ProvisioningServiceDescription」作成操作が成功しましたヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorDetails	予期しないエラー応答。

名前

型

説明

200 OK

ProvisioningServiceDescription

リソース「ProvisioningServiceDescription」更新操作が成功しました

201 Created

ProvisioningServiceDescription

リソース「ProvisioningServiceDescription」作成操作が成功しました

ヘッダー

Location: string
Retry-After: integer

Other Status Codes

ErrorDetails

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	あなたのユーザーアカウントになりすます

例

DPSCreate

DPSCreate_DisableLocalAuthFalse

DPSCreate_DisableLocalAuthTrue

DPSCreateWithIotHub

DPSCreateWithNamespace

DPSUpdate

DPSUpdate_DisableLocalAuth

DPSCreate

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 201

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

定義

名前	説明
AccessRightsDescription	このキーが持つ権限。
AllocationPolicy	このプロビジョニングサービスで使用される割り当てポリシー。
createdByType	リソースを作成した ID の種類。
ErrorDetails	エラーの詳細。
IotDpsPropertiesDescription	キー、リンクされた IoT ハブ、現在の状態、およびホスト名や idScope などのシステム生成プロパティを含む、プロビジョニングサービスのサービス固有のプロパティ
IotDpsSku	SKU 名。
IotDpsSkuInfo	使用可能なプロビジョニングサービス SKU の一覧。
IotHubAuthenticationType	IotHub MI認証タイプ:KeyBased、UserAssigned、SystemAssigned。
IotHubDefinitionDescription	IoT ハブの説明。
IpFilterActionType	このルールによってキャプチャされた要求に対して必要なアクション。
IpFilterRule	プロビジョニングサービスの IP フィルター規則。
IpFilterTargetType	このルールによってキャプチャされた要求のターゲット。
ManagedServiceIdentity	マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)
ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
PrivateEndpoint	プライベートエンドポイント接続のプライベートエンドポイントプロパティ
PrivateEndpointConnection	プロビジョニングサービスのプライベートエンドポイント接続
PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ
PrivateLinkServiceConnectionState	プライベートエンドポイント接続の現在の状態
PrivateLinkServiceConnectionStatus	プライベートエンドポイント接続の状態
ProvisioningServiceDescription	プロビジョニングサービスの説明。
PublicNetworkAccess	パブリックネットワークからの要求が許可されるかどうか
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	共有アクセスキーの説明。
State	プロビジョニングサービスの現在の状態。
systemData	リソースの作成と最後の変更に関連するメタデータ。
UserAssignedIdentity	ユーザー割り当て ID プロパティ

AccessRightsDescription

列挙

このキーが持つ権限。

値	説明
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

AllocationPolicy

列挙

このプロビジョニングサービスで使用される割り当てポリシー。

値	説明
Hashed
GeoLatency
Static

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

ErrorDetails

Object

エラーの詳細。

名前	型	説明
code	integer (int32)	エラーコード。
details	string	エラーの詳細。
httpStatusCode	string	HTTP 状態コード。
message	string	エラーメッセージ。

IotDpsPropertiesDescription

Object

キー、リンクされた IoT ハブ、現在の状態、およびホスト名や idScope などのシステム生成プロパティを含む、プロビジョニングサービスのサービス固有のプロパティ

名前	型	規定値	説明
allocationPolicy	AllocationPolicy		このプロビジョニングサービスで使用される割り当てポリシー。
authorizationPolicies	SharedAccessSignatureAuthorizationRuleAccessRightsDescription[]		プロビジョニングサービスの承認キーの一覧。
deviceProvisioningHostName	string		このプロビジョニングサービスのデバイスエンドポイント。
disableLocalAuth	boolean	False	Azure RBAC以外のすべての認証方法を無効にします。
enableDataResidency	boolean		オプション。 DPS インスタンスで Data Residency が有効になっているかどうかを示し、geo ペア間のディザスターリカバリーを削除します。
idScope	string		このプロビジョニングサービスの一意識別子。
iotHubs	IotHubDefinitionDescription[]		このプロビジョニングサービスに関連付けられている IoT ハブの一覧。
ipFilterRules	IpFilterRule[]		IP フィルター規則。
portalOperationsHostName	string		このプロビジョニングサービスに対して CORS を有効にするポータルエンドポイント。
privateEndpointConnections	PrivateEndpointConnection[]		この IotHub で作成されたプライベートエンドポイント接続
provisioningState	string		プロビジョニングサービスの ARM プロビジョニング状態。
publicNetworkAccess	PublicNetworkAccess		パブリックネットワークからの要求が許可されるかどうか
serviceOperationsHostName	string		プロビジョニングサービスのサービスエンドポイント。
state	State		プロビジョニングサービスの現在の状態。

IotDpsSku

列挙

SKU 名。

値	説明
S1

IotDpsSkuInfo

Object

使用可能なプロビジョニングサービス SKU の一覧。

名前	型	説明
capacity	integer (int64)	プロビジョニングするユニット数
name	IotDpsSku	SKU 名。
tier	string	プロビジョニングサービスの価格レベル名。

IotHubAuthenticationType

列挙

IotHub MI認証タイプ:KeyBased、UserAssigned、SystemAssigned。

値	説明
KeyBased	鍵ベースの認証タイプ。
UserAssigned	ユーザーが割り当てた認証タイプ。
SystemAssigned	システム割り当ての認証タイプ。

IotHubDefinitionDescription

Object

IoT ハブの説明。

名前	型	説明
allocationWeight	integer (int32)	特定の IoT h に適用する重み。
applyAllocationPolicy	boolean	特定の IoT ハブに対して allocationPolicy を適用するかどうかを示すフラグ。
authenticationType	IotHubAuthenticationType	IotHub MI認証タイプ:KeyBased、UserAssigned、SystemAssigned。
connectionString	string	IoT ハブの接続文字列。これはAuthenticationTypeがKeyBasedの場合に必要です。
hostName	string	IoT ハブのホスト名。これはconnectionStringが提供されていない場合に必要です。
location	string	IoT ハブの ARM リージョン。
name	string	IoT ハブのホスト名。
selectedUserAssignedIdentityResourceId	string (arm-id)	選択したユーザー割り当てのIDリソースはIoTハブに関連付けられています。これは、authenticationType が UserAssigned の場合に必要です。

IpFilterActionType

列挙

このルールによってキャプチャされた要求に対して必要なアクション。

値	説明
Accept
Reject

IpFilterRule

Object

プロビジョニングサービスの IP フィルター規則。

名前	型	説明
action	IpFilterActionType	このルールによってキャプチャされた要求に対して必要なアクション。
filterName	string	IP フィルター規則の名前。
ipMask	string	規則の IP アドレス範囲を CIDR 表記で含む文字列。
target	IpFilterTargetType	このルールによってキャプチャされた要求のターゲット。

IpFilterTargetType

列挙

このルールによってキャプチャされた要求のターゲット。

値	説明
all
serviceApi
deviceApi

ManagedServiceIdentity

Object

マネージドサービス ID (システム割り当て ID またはユーザー割り当て ID)

名前	型	説明
principalId	string (uuid)	システム割り当て ID のサービスプリンシパル ID。このプロパティは、システム割り当て ID にのみ提供されます。
tenantId	string (uuid)	システム割り当て ID のテナント ID。このプロパティは、システム割り当て ID にのみ提供されます。
type	ManagedServiceIdentityType	マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned ID リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリキーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。ディクショナリ値は、要求内の空のオブジェクト ({}) にすることができます。

ManagedServiceIdentityType

列挙

マネージドサービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。

値	説明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PrivateEndpoint

Object

プライベートエンドポイント接続のプライベートエンドポイントプロパティ

名前	型	説明
id	string	リソース識別子。

PrivateEndpointConnection

Object

プロビジョニングサービスのプライベートエンドポイント接続

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties	PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Object

プライベートエンドポイント接続のプロパティ

名前	型	説明
privateEndpoint	PrivateEndpoint	プライベートエンドポイント接続のプライベートエンドポイントプロパティ
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	プライベートエンドポイント接続の現在の状態

PrivateLinkServiceConnectionState

Object

プライベートエンドポイント接続の現在の状態

名前	型	説明
actionsRequired	string	プライベートエンドポイント接続に必要なアクション
description	string	プライベートエンドポイント接続の現在の状態の説明
status	PrivateLinkServiceConnectionStatus	プライベートエンドポイント接続の状態

PrivateLinkServiceConnectionStatus

列挙

プライベートエンドポイント接続の状態

値	説明
Pending
Approved
Rejected
Disconnected

ProvisioningServiceDescription

Object

プロビジョニングサービスの説明。

名前	型	説明
etag	string	Etag フィールドは必須ではありません。応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	このリソースに割り当てられているマネージドサービス ID。
location	string	リソースが存在する地理的な場所
name	string	リソースの名前
properties	IotDpsPropertiesDescription	プロビジョニングサービスのサービス固有のプロパティ
resourcegroup	string	リソースのリソースグループ。
sku	IotDpsSkuInfo	プロビジョニングサービスの SKU 情報。
subscriptionid	string	リソースのサブスクリプション ID。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソースタグ。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

PublicNetworkAccess

列挙

パブリックネットワークからの要求が許可されるかどうか

値	説明
Enabled
Disabled

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Object

共有アクセスキーの説明。

名前	型	説明
keyName	string	キーの名前。
primaryKey	string	プライマリ SAS キーの値。
rights	AccessRightsDescription	このキーが持つ権限。
secondaryKey	string	セカンダリ SAS キー値。

State

列挙

プロビジョニングサービスの現在の状態。

値	説明
Activating
Active
Deleting
Deleted
ActivationFailed
DeletionFailed
Transitioning
Suspending
Suspended
Resuming
FailingOver
FailoverFailed

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UserAssignedIdentity

Object

ユーザー割り当て ID プロパティ

名前	型	説明
clientId	string (uuid)	割り当てられた ID のクライアント ID。
principalId	string (uuid)	割り当てられた ID のプリンシパル ID。