다음을 통해 공유


Iot Hub Resource - List Keys

IoT Hub에 대한 보안 메타데이터를 가져옵니다. 자세한 내용은 https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security를 참조하세요.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys?api-version=2023-06-30

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
resourceGroupName
path True

string

IoT Hub를 포함하는 리소스 그룹의 이름입니다.

resourceName
path True

string

IoT Hub의 이름입니다.

subscriptionId
path True

string

구독 식별자입니다.

api-version
query True

string

API 버전입니다.

응답

Name 형식 Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

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

Other Status Codes

ErrorDetails

DefaultErrorResponse

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

IotHubResource_ListKeys

샘플 요청

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/listkeys?api-version=2023-06-30

샘플 응답

{
  "value": [
    {
      "keyName": "iothubowner",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
    },
    {
      "keyName": "service",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "ServiceConnect"
    },
    {
      "keyName": "device",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "DeviceConnect"
    },
    {
      "keyName": "registryRead",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryRead"
    },
    {
      "keyName": "registryReadWrite",
      "primaryKey": "<primaryKey>",
      "secondaryKey": "<secondaryKey>",
      "rights": "RegistryWrite"
    }
  ]
}

정의

Name Description
AccessRights

공유 액세스 정책에 할당된 권한입니다.

ErrorDetails

오류 세부 정보입니다.

SharedAccessSignatureAuthorizationRule

IoT Hub 공유 액세스 정책의 속성입니다.

SharedAccessSignatureAuthorizationRuleListResult

다음 링크가 있는 공유 액세스 정책 목록입니다.

AccessRights

공유 액세스 정책에 할당된 권한입니다.

Name 형식 Description
DeviceConnect

string

RegistryRead

string

RegistryRead, DeviceConnect

string

RegistryRead, RegistryWrite

string

RegistryRead, RegistryWrite, DeviceConnect

string

RegistryRead, RegistryWrite, ServiceConnect

string

RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect

string

RegistryRead, ServiceConnect

string

RegistryRead, ServiceConnect, DeviceConnect

string

RegistryWrite

string

RegistryWrite, DeviceConnect

string

RegistryWrite, ServiceConnect

string

RegistryWrite, ServiceConnect, DeviceConnect

string

ServiceConnect

string

ServiceConnect, DeviceConnect

string

ErrorDetails

오류 세부 정보입니다.

Name 형식 Description
code

string

오류 코드입니다.

details

string

오류 세부 정보입니다.

httpStatusCode

string

HTTP 상태 코드입니다.

message

string

오류 메시지입니다.

SharedAccessSignatureAuthorizationRule

IoT Hub 공유 액세스 정책의 속성입니다.

Name 형식 Description
keyName

string

공유 액세스 정책의 이름입니다.

primaryKey

string

기본 키입니다.

rights

AccessRights

공유 액세스 정책에 할당된 권한입니다.

secondaryKey

string

보조 키입니다.

SharedAccessSignatureAuthorizationRuleListResult

다음 링크가 있는 공유 액세스 정책 목록입니다.

Name 형식 Description
nextLink

string

다음 링크입니다.

value

SharedAccessSignatureAuthorizationRule[]

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