Iot Dps Resource - Get

リファレンス

Service:: IoT Hub Device Provisioning Service

API Version:: 2018-01-22

プロビジョニングサービスのセキュリティ関連以外のメタデータを取得します。
SAS キーを使用せずにプロビジョニングサービスのメタデータを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22

URI パラメーター

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

応答

名前	型	説明
200 OK	ProvisioningServiceDescription	キーのないプロビジョニングサービスの説明が応答に含まれます。
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	ユーザーアカウントの借用

例

DPSGet

Sample Request

HTTP

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

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": []
  },
  "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
  }
}

定義

名前	説明
AccessRightsDescription	このキーに与える権限。
AllocationPolicy	このプロビジョニングサービスで使用される割り当てポリシー。
ErrorDetails	エラーの詳細。
IotDpsPropertiesDescription	キー、リンクされた iot ハブ、現在の状態、およびホスト名や idScope などのシステムによって生成されたプロパティなど、プロビジョニングサービスのサービス固有のプロパティ
IotDpsSku	SKU 名。
IotDpsSkuInfo	使用可能なプロビジョニングサービス SKU の一覧。
IotHubDefinitionDescription	IoT ハブの説明。
ProvisioningServiceDescription	プロビジョニングサービスの説明。
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	共有アクセスキーの説明。
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	AllocationPolicy	このプロビジョニングサービスで使用される割り当てポリシー。
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	プロビジョニングサービスの承認キーの一覧。
deviceProvisioningHostName	string	このプロビジョニングサービスのデバイスエンドポイント。
idScope	string	このプロビジョニングサービスの一意識別子。
iotHubs	IotHubDefinitionDescription[]	このプロビジョニングサービスに関連付けられている IoT ハブの一覧。
provisioningState	string	プロビジョニングサービスの ARM プロビジョニング状態。
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	接続文字列 og the IoT Hub。
location	string	IoT ハブの ARM リージョン。
name	string	IoT ハブのホスト名。

ProvisioningServiceDescription

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

名前	型	説明
etag	string	Etag フィールドは必須ではありません。応答本文で指定する場合は、通常の ETag 規則に従ってヘッダーとしても指定する必要があります。
id	string	リソース識別子。
location	string	リソースの場所。
name	string	リソースの名前。
properties	IotDpsPropertiesDescription	プロビジョニングサービスのサービス固有のプロパティ
sku	IotDpsSkuInfo	プロビジョニングサービスの SKU 情報。
tags	object	リソースタグ。
type	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