Iot Dps Resource - Create Or Update

リファレンス

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

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

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

URI パラメーター

名前	/	必須	型	説明
provisioningServiceName	path	True	string	作成または更新するプロビジョニングサービスの名前。
resourceGroupName	path	True	string	リソースグループ識別子。
subscriptionId	path	True	string	サブスクリプションの識別子です。
api-version	query	True	string	API のバージョン。

要求本文

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

応答

名前	型	説明
200 OK	ProvisioningServiceDescription	本文には、プロビジョニングサービスのすべてのセキュリティ以外のプロパティが含まれています。セキュリティ関連のプロパティは null に設定されます。
201 Created	ProvisioningServiceDescription	この操作の実行には時間がかかります。検証が完了した場合、操作は 201 を返します。応答には、状態 URL を含む Azure-AsyncOperation ヘッダーが含まれています。クライアントは、操作の状態の状態 URL をポーリングする必要があります。成功した場合、操作は HTTP 状態コード 201 (OK) を返します。
Other Status Codes	ErrorDetails	既定のエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザーアカウントの借用

例

DPSCreate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2022-12-12

{
  "location": "East US",
  "properties": {
    "enableDataResidency": false
  },
  "sku": {
    "name": "S1",
    "capacity": 1
  },
  "tags": {}
}

Sample Response

Status code:: 200

{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

Status code:: 201

{
  "etag": "AAAAAAAADGk=",
  "name": "myFirstProvisioningService",
  "location": "eastus",
  "properties": {
    "state": "Active",
    "allocationPolicy": "Hashed",
    "serviceOperationsHostName": "myFirstProvisioningService.azure-devices-provisioning.net",
    "deviceProvisioningHostName": "global.azure-devices-provisioning.net",
    "idScope": "0ne00000012",
    "authorizationPolicies": [],
    "enableDataResidency": false,
    "portalOperationsHostName": "myFirstProvisioningService.services.azure-devices-provisioning.net"
  },
  "resourcegroup": "myResourceGroup",
  "type": "Microsoft.Devices/ProvisioningServices",
  "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
  "subscriptionid": "91d12660-3dec-467a-be2a-213b5544ddc0",
  "tags": {},
  "sku": {
    "name": "S1",
    "tier": "Standard",
    "capacity": 1
  }
}

定義

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

AccessRightsDescription

このキーに含まれる権限。

名前	型	説明
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

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

名前	型	説明
GeoLatency	string
Hashed	string
Static	string

createdByType

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

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

エラーの詳細。

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

IotDpsPropertiesDescription

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

名前	型	説明
allocationPolicy	AllocationPolicy	このプロビジョニングサービスで使用される割り当てポリシー。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	プロビジョニングサービスの承認キーの一覧。
deviceProvisioningHostName	string	このプロビジョニングサービスのデバイスエンドポイント。
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	string

IotDpsSkuInfo

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

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

IotHubDefinitionDescription

IoT ハブの説明。

名前	型	説明
allocationWeight	integer	特定の iot h に適用する重み。
applyAllocationPolicy	boolean	特定の iot ハブに allocationPolicy を適用する場合はフラグ。
connectionString	string	IoT ハブの接続文字列。
location	string	IoT ハブの ARM リージョン。
name	string	IoT ハブのホスト名。

IpFilterActionType

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

名前	型	説明
Accept	string
Reject	string

IpFilterRule

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

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

IpFilterTargetType

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

名前	型	説明
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

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

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

PrivateEndpointConnection

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

名前	型	説明
id	string	リソース識別子。
name	string	リソースの名前。
properties	PrivateEndpointConnectionProperties	プライベートエンドポイント接続のプロパティ
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
type	string	リソースの種類。

PrivateEndpointConnectionProperties

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

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

PrivateLinkServiceConnectionState

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

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

PrivateLinkServiceConnectionStatus

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

名前	型	説明
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

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

名前	型	説明
etag	string	Etag フィールドは必須ではありません。応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
id	string	リソース識別子。
location	string	リソースの場所。
name	string	リソースの名前。
properties	IotDpsPropertiesDescription	プロビジョニングサービスのサービス固有のプロパティ
resourcegroup	string	リソースのリソースグループ。
sku	IotDpsSkuInfo	プロビジョニングサービスの SKU 情報。
subscriptionid	string	リソースのサブスクリプション ID。
systemData	systemData	リソースの作成と最後の変更に関連するメタデータ。
tags	object	リソースタグ。
type	string	リソースの種類。

PublicNetworkAccess

パブリックネットワークからの要求を許可するかどうか

名前	型	説明
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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

名前	型	説明
keyName	string	キーの名前。
primaryKey	string	プライマリ SAS キーの値。
rights	AccessRightsDescription	このキーに含まれる権限。
secondaryKey	string	セカンダリ SAS キー値。

state

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

名前	型	説明
Activating	string
ActivationFailed	string
Active	string
Deleted	string
Deleting	string
DeletionFailed	string
FailingOver	string
FailoverFailed	string
Resuming	string
Suspended	string
Suspending	string
Transitioning	string

systemData

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

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

次の方法で共有