次の方法で共有

Iot Dps Resource - Create Or Update

サービス:
IoT Hub Device Provisioning Service
API バージョン:
2022-12-12

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

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 フロー。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

例

DPSCreate

要求のサンプル

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

応答のサンプル

状態コード:
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
  }
}
状態コード:
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

列挙

このキーが持つ権限。

値 説明
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

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

IotDpsSkuInfo

Object

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

名前 型 説明
capacity

integer (int64)

プロビジョニングするユニット数
name

IotDpsSku

SKU 名。
tier

string

プロビジョニング サービスの価格レベル名。

IotHubDefinitionDescription

Object

IoT ハブの説明。

名前 型 説明
allocationWeight

integer (int32)

特定の IoT h に適用する重み。
applyAllocationPolicy

boolean

特定の IoT ハブに対して allocationPolicy を適用するかどうかを示すフラグ。
connectionString

string

IoT ハブの接続文字列。
location

string

IoT ハブの ARM リージョン。
name

string

IoT ハブのホスト名。

IpFilterActionType

列挙

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

値 説明
Accept
Reject

IpFilterRule

Object

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

名前 型 説明
action

IpFilterActionType

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

string

IP フィルター規則の名前。
ipMask

string

規則の IP アドレス範囲を CIDR 表記で含む文字列。
target

IpFilterTargetType

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

IpFilterTargetType

列挙

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

値 説明
all
serviceApi
deviceApi

PrivateEndpoint

Object

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

名前 型 説明
id

string

リソース識別子。

PrivateEndpointConnection

Object

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

名前 型 説明
id

string

リソース識別子。
name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

リソース名。
properties

PrivateEndpointConnectionProperties

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

systemData

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

string

リソースの種類。

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

リソース識別子。
location

string

リソースの場所。
name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$

リソース名。
properties

IotDpsPropertiesDescription

プロビジョニング サービスのサービス固有のプロパティ
resourcegroup

string

リソースのリソース グループ。
sku

IotDpsSkuInfo

プロビジョニング サービスの SKU 情報。
subscriptionid

string

リソースのサブスクリプション ID。
systemData

systemData

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

object

リソース タグ。
type

string

リソースの種類。

PublicNetworkAccess

列挙

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

値 説明
Enabled
Disabled

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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 の種類。