Iot Dps Resource - Create Or Update
프로비저닝 서비스의 메타데이터를 만들거나 업데이트합니다. 속성을 수정하는 일반적인 패턴은 프로비전 서비스 메타데이터 및 보안 메타데이터를 검색한 다음 새 본문의 수정된 값과 결합하여 프로비저닝 서비스를 업데이트하는 것입니다.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}?api-version=2018-01-22
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
provisioning
|
path | True |
string |
만들거나 업데이트할 프로비전 서비스의 이름입니다. |
resource
|
path | True |
string |
리소스 그룹 식별자입니다. |
subscription
|
path | True |
string |
구독 식별자입니다. |
api-version
|
query | True |
string |
API 버전입니다. |
요청 본문
Name | 필수 | 형식 | Description |
---|---|---|---|
location | True |
string |
리소스 위치입니다. |
properties | True |
프로비저닝 서비스에 대한 서비스별 속성 |
|
sku | True |
프로비저닝 서비스에 대한 Sku 정보입니다. |
|
etag |
string |
Etag 필드는 필요하지 않습니다 . 응답 본문에 제공된 경우 일반적인 ETag 규칙에 따라 헤더로도 제공해야 합니다. |
|
tags |
object |
리소스 태그입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
본문에는 프로비저닝 서비스의 모든 비보안 속성이 포함됩니다. 보안 관련 속성은 null로 설정됩니다. |
|
201 Created |
이 작업을 실행하는 데는 오랜 시간이 소요됩니다. 유효성 검사가 완료되면 작업은 201을 반환합니다. 응답에는 상태 URL이 포함된 Azure-AsyncOperation 헤더가 포함됩니다. 클라이언트는 작업의 상태 대한 상태 URL을 폴링해야 합니다. 성공하면 작업은 HTTP 상태 코드 201(OK)을 반환합니다. |
|
Other Status Codes |
기본 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
DPSCreate
Sample Request
PUT https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService?api-version=2018-01-22
{
"location": "East US",
"type": "Microsoft.Devices/ProvisioningServices",
"properties": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
},
"tags": {}
}
Sample Response
{
"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//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
{
"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//providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService",
"tags": {},
"sku": {
"name": "S1",
"tier": "Standard",
"capacity": 1
}
}
정의
Name | Description |
---|---|
Access |
이 키에 있는 권한입니다. |
Allocation |
이 프로비저닝 서비스에서 사용할 할당 정책입니다. |
Error |
오류 세부 정보입니다. |
Iot |
키, 연결된 iot 허브, 현재 상태 및 호스트 이름 및 idScope와 같은 시스템 생성 속성을 포함하여 프로비저닝 서비스의 서비스별 속성 |
Iot |
Sku 이름입니다. |
Iot |
가능한 프로비저닝 서비스 SKU 목록입니다. |
Iot |
IoT Hub에 대한 설명입니다. |
Provisioning |
프로비저닝 서비스에 대한 설명입니다. |
Shared |
공유 액세스 키에 대한 설명입니다. |
state |
프로비전 서비스의 현재 상태입니다. |
AccessRightsDescription
이 키에 있는 권한입니다.
Name | 형식 | Description |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
AllocationPolicy
이 프로비저닝 서비스에서 사용할 할당 정책입니다.
Name | 형식 | Description |
---|---|---|
GeoLatency |
string |
|
Hashed |
string |
|
Static |
string |
ErrorDetails
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드입니다. |
details |
string |
오류 세부 정보입니다. |
httpStatusCode |
string |
HTTP 상태 코드입니다. |
message |
string |
오류 메시지입니다. |
IotDpsPropertiesDescription
키, 연결된 iot 허브, 현재 상태 및 호스트 이름 및 idScope와 같은 시스템 생성 속성을 포함하여 프로비저닝 서비스의 서비스별 속성
Name | 형식 | Description |
---|---|---|
allocationPolicy |
이 프로비저닝 서비스에서 사용할 할당 정책입니다. |
|
authorizationPolicies |
Shared |
프로비저닝 서비스에 대한 권한 부여 키 목록입니다. |
deviceProvisioningHostName |
string |
이 프로비저닝 서비스에 대한 디바이스 엔드포인트입니다. |
idScope |
string |
이 프로비저닝 서비스의 고유 식별자입니다. |
iotHubs |
이 프로비저닝 서비스와 연결된 IoT Hub 목록입니다. |
|
provisioningState |
string |
프로비저닝 서비스의 ARM 프로비저닝 상태입니다. |
serviceOperationsHostName |
string |
서비스 프로비저닝을 위한 서비스 엔드포인트입니다. |
state |
프로비전 서비스의 현재 상태입니다. |
IotDpsSku
Sku 이름입니다.
Name | 형식 | Description |
---|---|---|
S1 |
string |
IotDpsSkuInfo
가능한 프로비저닝 서비스 SKU 목록입니다.
Name | 형식 | Description |
---|---|---|
capacity |
integer |
프로비전할 단위 수 |
name |
Sku 이름입니다. |
|
tier |
string |
프로비저닝 서비스의 가격 책정 계층 이름입니다. |
IotHubDefinitionDescription
IoT Hub에 대한 설명입니다.
Name | 형식 | Description |
---|---|---|
allocationWeight |
integer |
지정된 iot h에 적용할 가중치입니다. |
applyAllocationPolicy |
boolean |
지정된 iot 허브에 대해 allocationPolicy를 적용하기 위한 플래그입니다. |
connectionString |
string |
연결 문자열 og IoT Hub. |
location |
string |
IoT Hub의 ARM 지역입니다. |
name |
string |
IoT Hub의 호스트 이름입니다. |
ProvisioningServiceDescription
프로비저닝 서비스에 대한 설명입니다.
Name | 형식 | Description |
---|---|---|
etag |
string |
Etag 필드는 필요하지 않습니다 . 응답 본문에 제공된 경우 일반적인 ETag 규칙에 따라 헤더로도 제공해야 합니다. |
id |
string |
리소스 식별자입니다. |
location |
string |
리소스 위치입니다. |
name |
string |
리소스 이름입니다. |
properties |
프로비저닝 서비스에 대한 서비스별 속성 |
|
sku |
프로비저닝 서비스에 대한 Sku 정보입니다. |
|
tags |
object |
리소스 태그입니다. |
type |
string |
리소스 종류입니다. |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
공유 액세스 키에 대한 설명입니다.
Name | 형식 | Description |
---|---|---|
keyName |
string |
키 이름입니다. |
primaryKey |
string |
기본 SAS 키 값입니다. |
rights |
이 키에 있는 권한입니다. |
|
secondaryKey |
string |
보조 SAS 키 값입니다. |
state
프로비전 서비스의 현재 상태입니다.
Name | 형식 | Description |
---|---|---|
Activating |
string |
|
ActivationFailed |
string |
|
Active |
string |
|
Deleted |
string |
|
Deleting |
string |
|
DeletionFailed |
string |
|
FailingOver |
string |
|
FailoverFailed |
string |
|
Resuming |
string |
|
Suspended |
string |
|
Suspending |
string |
|
Transitioning |
string |