Iot Dps Resource - List Keys For Key Name
프로비저닝 서비스에서 이름으로 공유 액세스 정책을 가져옵니다.
특정 키 이름에 대한 기본 및 보조 키 나열
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys?api-version=2022-12-12
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
key
|
path | True |
string |
키-값을 가져올 논리적 키 이름입니다. |
provisioning
|
path | True |
string |
프로비저닝 서비스의 이름입니다. |
resource
|
path | True |
string |
프로비저닝 서비스를 포함하는 리소스 그룹의 이름입니다. |
subscription
|
path | True |
string |
구독 식별자입니다. |
api-version
|
query | True |
string |
API 버전입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
Shared |
동기 작업입니다. 본문에는 하나 이상의 프로비전 서비스 엔드포인트에 액세스하는 데 사용할 수 있는 키를 포함하여 JSON 직렬화된 공유 액세스 정책이 포함되어 있습니다. |
Other Status Codes |
기본 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
DPSGetKey
샘플 요청
POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/keys/testKey/listkeys?api-version=2022-12-12
샘플 응답
{
"keyName": "testKey",
"primaryKey": "##################################",
"secondaryKey": "################################",
"rights": "RegistrationStatusWrite"
}
정의
Name | Description |
---|---|
Access |
이 키에 있는 권한입니다. |
Error |
오류 세부 정보입니다. |
Shared |
공유 액세스 키에 대한 설명입니다. |
AccessRightsDescription
이 키에 있는 권한입니다.
Name | 형식 | Description |
---|---|---|
DeviceConnect |
string |
|
EnrollmentRead |
string |
|
EnrollmentWrite |
string |
|
RegistrationStatusRead |
string |
|
RegistrationStatusWrite |
string |
|
ServiceConfig |
string |
ErrorDetails
오류 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
integer |
오류 코드입니다. |
details |
string |
오류 세부 정보입니다. |
httpStatusCode |
string |
HTTP 상태 코드입니다. |
message |
string |
오류 메시지입니다. |
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]
공유 액세스 키에 대한 설명입니다.
Name | 형식 | Description |
---|---|---|
keyName |
string |
키 이름입니다. |
primaryKey |
string |
기본 SAS 키 값입니다. |
rights |
이 키에 있는 권한입니다. |
|
secondaryKey |
string |
보조 SAS 키 값입니다. |