Iot Dps Resource - List Keys

프로비저닝 서비스에 대한 보안 메타데이터를 가져옵니다.
프로비저닝 서비스의 기본 및 보조 키를 나열합니다.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys?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
200 OK

SharedAccessSignatureAuthorizationRuleListResult

동기 작업입니다. 본문에는 프로비저닝 서비스 엔드포인트에 액세스하는 데 사용할 수 있는 키를 포함한 공유 액세스 정책의 JSON 직렬화된 배열이 포함되어 있습니다.

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 사용자 계정 가장

예제

DPSListKeys

Sample Request

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/listkeys?api-version=2022-12-12

Sample Response

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

정의

Name Description
AccessRightsDescription

이 키에 있는 권한입니다.

ErrorDetails

오류 세부 정보입니다.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

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

SharedAccessSignatureAuthorizationRuleListResult

공유 액세스 키 목록입니다.

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

AccessRightsDescription

이 키에 있는 권한입니다.

secondaryKey

string

보조 SAS 키 값입니다.

SharedAccessSignatureAuthorizationRuleListResult

공유 액세스 키 목록입니다.

Name 형식 Description
nextLink

string

다음 링크입니다.

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

공유 액세스 정책 목록입니다.