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 매개 변수

Name	In(다음 안에)	필수	형식	Description
provisioningServiceName	path	True	string	만들거나 업데이트할 프로비전 서비스의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹 식별자입니다.
subscriptionId	path	True	string	구독 식별자입니다.
api-version	query	True	string	API 버전입니다.

요청 본문

Name	필수	형식	Description
location	True	string	리소스 위치입니다.
properties	True	IotDpsPropertiesDescription	프로비저닝 서비스에 대한 서비스별 속성
sku	True	IotDpsSkuInfo	프로비저닝 서비스에 대한 SKU 정보입니다.
etag		string	Etag 필드는 필요하지 않습니다 . 응답 본문에 제공된 경우 일반 ETag 규칙에 따라 헤더로도 제공해야 합니다.
resourcegroup		string	리소스의 리소스 그룹입니다.
subscriptionid		string	리소스의 구독 ID입니다.
tags		object	리소스 태그입니다.

응답

Name	형식	Description
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 Flow.

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

Scopes

Name	Description
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
  }
}

정의

Name	Description
AccessRightsDescription	이 키에 있는 권한입니다.
AllocationPolicy	이 프로비저닝 서비스에서 사용할 할당 정책입니다.
createdByType	리소스를 만든 ID의 형식입니다.
ErrorDetails	오류 세부 정보입니다.
IotDpsPropertiesDescription	키, 연결된 iot Hubs, 현재 상태 및 시스템 생성 속성(예: hostname 및 idScope)을 포함한 프로비저닝 서비스의 서비스별 속성
IotDpsSku	Sku 이름입니다.
IotDpsSkuInfo	가능한 프로비저닝 서비스 SKU 목록입니다.
IotHubDefinitionDescription	IoT Hub에 대한 설명입니다.
IpFilterActionType	이 규칙에서 캡처한 요청에 대해 원하는 작업입니다.
IpFilterRule	프로비저닝 서비스에 대한 IP 필터 규칙입니다.
IpFilterTargetType	이 규칙에서 캡처한 요청의 대상입니다.
PrivateEndpoint	프라이빗 엔드포인트 연결의 프라이빗 엔드포인트 속성
PrivateEndpointConnection	프로비저닝 서비스의 프라이빗 엔드포인트 연결
PrivateEndpointConnectionProperties	프라이빗 엔드포인트 연결의 속성
PrivateLinkServiceConnectionState	프라이빗 엔드포인트 연결의 현재 상태
PrivateLinkServiceConnectionStatus	프라이빗 엔드포인트 연결의 상태
ProvisioningServiceDescription	프로비저닝 서비스에 대한 설명입니다.
PublicNetworkAccess	공용 네트워크의 요청 허용 여부
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	공유 액세스 키에 대한 설명입니다.
state	프로비저닝 서비스의 현재 상태입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

AccessRightsDescription

이 키에 있는 권한입니다.

Name	형식	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

AllocationPolicy

이 프로비저닝 서비스에서 사용할 할당 정책입니다.

Name	형식	Description
GeoLatency	string
Hashed	string
Static	string

createdByType

리소스를 만든 ID의 형식입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDetails

오류 세부 정보입니다.

Name	형식	Description
code	integer	오류 코드입니다.
details	string	오류 세부 정보입니다.
httpStatusCode	string	HTTP 상태 코드입니다.
message	string	오류 메시지입니다.

IotDpsPropertiesDescription

키, 연결된 iot Hubs, 현재 상태 및 시스템 생성 속성(예: hostname 및 idScope)을 포함한 프로비저닝 서비스의 서비스별 속성

Name	형식	Description
allocationPolicy	AllocationPolicy	이 프로비저닝 서비스에서 사용할 할당 정책입니다.
authorizationPolicies	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	프로비저닝 서비스에 대한 권한 부여 키 목록입니다.
deviceProvisioningHostName	string	이 프로비저닝 서비스에 대한 디바이스 엔드포인트입니다.
enableDataResidency	boolean	선택 사항입니다. DPS instance Data Residency 사용하도록 설정되어 있는지를 나타내며 지역 쌍 간 재해 복구를 제거합니다.
idScope	string	이 프로비저닝 서비스의 고유 식별자입니다.
iotHubs	IotHubDefinitionDescription[]	이 프로비저닝 서비스와 연결된 IoT Hub 목록입니다.
ipFilterRules	IpFilterRule[]	IP 필터 규칙입니다.
portalOperationsHostName	string	이 프로비저닝 서비스에 CORS를 사용하도록 설정하는 포털 엔드포인트입니다.
privateEndpointConnections	PrivateEndpointConnection[]	이 IotHub에서 만든 프라이빗 엔드포인트 연결
provisioningState	string	프로비저닝 서비스의 ARM 프로비저닝 상태입니다.
publicNetworkAccess	PublicNetworkAccess	공용 네트워크의 요청 허용 여부
serviceOperationsHostName	string	서비스 프로비저닝을 위한 서비스 엔드포인트입니다.
state	state	프로비저닝 서비스의 현재 상태입니다.

IotDpsSku

Sku 이름입니다.

Name	형식	Description
S1	string

IotDpsSkuInfo

가능한 프로비저닝 서비스 SKU 목록입니다.

Name	형식	Description
capacity	integer	프로비전할 단위 수
name	IotDpsSku	Sku 이름입니다.
tier	string	프로비저닝 서비스의 가격 책정 계층 이름입니다.

IotHubDefinitionDescription

IoT Hub에 대한 설명입니다.

Name	형식	Description
allocationWeight	integer	지정된 iot h에 적용할 가중치입니다.
applyAllocationPolicy	boolean	지정된 iot 허브에 대해 allocationPolicy를 적용하거나 적용하지 않는 플래그입니다.
connectionString	string	IoT Hub의 연결 문자열입니다.
location	string	IoT Hub의 ARM 지역입니다.
name	string	IoT Hub의 호스트 이름입니다.

IpFilterActionType

이 규칙에서 캡처한 요청에 대해 원하는 작업입니다.

Name	형식	Description
Accept	string
Reject	string

IpFilterRule

프로비저닝 서비스에 대한 IP 필터 규칙입니다.

Name	형식	Description
action	IpFilterActionType	이 규칙에서 캡처한 요청에 대해 원하는 작업입니다.
filterName	string	IP 필터 규칙의 이름입니다.
ipMask	string	규칙에 대한 CIDR 표기법의 IP 주소 범위를 포함하는 문자열입니다.
target	IpFilterTargetType	이 규칙에서 캡처한 요청의 대상입니다.

IpFilterTargetType

이 규칙에서 캡처한 요청의 대상입니다.

Name	형식	Description
all	string
deviceApi	string
serviceApi	string

PrivateEndpoint

프라이빗 엔드포인트 연결의 프라이빗 엔드포인트 속성

Name	형식	Description
id	string	리소스 식별자입니다.

PrivateEndpointConnection

프로비저닝 서비스의 프라이빗 엔드포인트 연결

Name	형식	Description
id	string	리소스 식별자입니다.
name	string	리소스 이름입니다.
properties	PrivateEndpointConnectionProperties	프라이빗 엔드포인트 연결의 속성
systemData	systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
type	string	리소스 종류입니다.

PrivateEndpointConnectionProperties

프라이빗 엔드포인트 연결의 속성

Name	형식	Description
privateEndpoint	PrivateEndpoint	프라이빗 엔드포인트 연결의 프라이빗 엔드포인트 속성
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	프라이빗 엔드포인트 연결의 현재 상태

PrivateLinkServiceConnectionState

프라이빗 엔드포인트 연결의 현재 상태

Name	형식	Description
actionsRequired	string	프라이빗 엔드포인트 연결에 필요한 작업
description	string	프라이빗 엔드포인트 연결의 현재 상태에 대한 설명
status	PrivateLinkServiceConnectionStatus	프라이빗 엔드포인트 연결의 상태

PrivateLinkServiceConnectionStatus

프라이빗 엔드포인트 연결의 상태

Name	형식	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

ProvisioningServiceDescription

프로비저닝 서비스에 대한 설명입니다.

Name	형식	Description
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

공용 네트워크의 요청 허용 여부

Name	형식	Description
Disabled	string
Enabled	string

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

공유 액세스 키에 대한 설명입니다.

Name	형식	Description
keyName	string	키 이름입니다.
primaryKey	string	기본 SAS 키 값입니다.
rights	AccessRightsDescription	이 키에 있는 권한입니다.
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

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.