Iot Dps Resource - List By Resource Group
指定されたリソース グループ内のすべてのプロビジョニング サービスの一覧を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices?api-version=2018-01-22
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループ識別子。 |
subscription
|
path | True |
string |
サブスクリプションの識別子です。 |
api-version
|
query | True |
string |
API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
リソース グループ内のプロビジョニング サービスの一覧。 |
|
Other Status Codes |
既定のエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
DPSListByResourceGroup
Sample Request
GET https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices?api-version=2018-01-22
Sample Response
{
"value": [
{
"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"
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
},
{
"etag": "AAAAAAAADGk=",
"name": "mySecondProvisioningService",
"location": "eastus",
"properties": {
"state": "Active",
"allocationPolicy": "Hashed",
"serviceOperationsHostName": "mySecondProvisioningService.azure-devices-provisioning.net",
"deviceProvisioningHostName": "global.azure-devices-provisioning.net",
"idScope": "0ne00000012"
},
"type": "Microsoft.Devices/ProvisioningServices",
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/mySecondProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
]
}
定義
名前 | 説明 |
---|---|
Access |
このキーに与える権限。 |
Allocation |
このプロビジョニング サービスで使用される割り当てポリシー。 |
Error |
エラーの詳細。 |
Iot |
キー、リンクされた iot ハブ、現在の状態、およびホスト名や idScope などのシステムによって生成されたプロパティなど、プロビジョニング サービスのサービス固有のプロパティ |
Iot |
SKU 名。 |
Iot |
使用可能なプロビジョニング サービス SKU の一覧。 |
Iot |
IoT ハブの説明。 |
Provisioning |
プロビジョニング サービスの説明。 |
Provisioning |
プロビジョニング サービスの説明の一覧。 |
Shared |
共有アクセス キーの説明。 |
state |
プロビジョニング サービスの現在の状態。 |
AccessRightsDescription
このキーに与える権限。
名前 | 型 | 説明 |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
このプロビジョニング サービスで使用される割り当てポリシー。
名前 | 型 | 説明 |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
ErrorDetails
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
details |
string |
エラーの詳細です。 |
httpStatusCode |
string |
HTTP 状態コード。 |
message |
string |
エラー メッセージ。 |
IotDpsPropertiesDescription
キー、リンクされた iot ハブ、現在の状態、およびホスト名や idScope などのシステムによって生成されたプロパティなど、プロビジョニング サービスのサービス固有のプロパティ
名前 | 型 | 説明 |
---|---|---|
allocationPolicy |
このプロビジョニング サービスで使用される割り当てポリシー。 |
|
authorizationPolicies |
Shared |
プロビジョニング サービスの承認キーの一覧。 |
deviceProvisioningHostName |
string |
このプロビジョニング サービスのデバイス エンドポイント。 |
idScope |
string |
このプロビジョニング サービスの一意識別子。 |
iotHubs |
このプロビジョニング サービスに関連付けられている IoT ハブの一覧。 |
|
provisioningState |
string |
プロビジョニング サービスの ARM プロビジョニング状態。 |
serviceOperationsHostName |
string |
プロビジョニング サービスのサービス エンドポイント。 |
state |
プロビジョニング サービスの現在の状態。 |
IotDpsSku
SKU 名。
名前 | 型 | 説明 |
---|---|---|
S1 |
string |
IotDpsSkuInfo
使用可能なプロビジョニング サービス SKU の一覧。
名前 | 型 | 説明 |
---|---|---|
capacity |
integer |
プロビジョニングするユニット数 |
name |
SKU 名。 |
|
tier |
string |
プロビジョニング サービスの価格レベル名。 |
IotHubDefinitionDescription
IoT ハブの説明。
名前 | 型 | 説明 |
---|---|---|
allocationWeight |
integer |
特定の iot h に適用する重み。 |
applyAllocationPolicy |
boolean |
指定された iot ハブに allocationPolicy を適用するためのフラグ。 |
connectionString |
string |
接続文字列 og the IoT Hub。 |
location |
string |
IoT ハブの ARM リージョン。 |
name |
string |
IoT ハブのホスト名。 |
ProvisioningServiceDescription
プロビジョニング サービスの説明。
名前 | 型 | 説明 |
---|---|---|
etag |
string |
Etag フィールドは必須 ではありません 。 応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。 |
id |
string |
リソース識別子。 |
location |
string |
リソースの場所。 |
name |
string |
リソースの名前。 |
properties |
プロビジョニング サービスのサービス固有のプロパティ |
|
sku |
プロビジョニング サービスの SKU 情報。 |
|
tags |
object |
リソース タグ。 |
type |
string |
リソースの種類。 |
ProvisioningServiceDescriptionListResult
プロビジョニング サービスの説明の一覧。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
次のリンク |
value |
プロビジョニング サービスの説明の一覧。 |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
共有アクセス キーの説明。
名前 | 型 | 説明 |
---|---|---|
keyName |
string |
キーの名前。 |
primaryKey |
string |
プライマリ SAS キー値。 |
rights |
このキーに与える権限。 |
|
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 |