Iot Hub Resource - Get Keys For Key Name

Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security
Get a shared access policy by name from an IoT hub. For more information, see: 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}/IotHubKeys/{keyName}/listkeys?api-version=2018-04-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription identifier.

resourceGroupName
path True
  • string

The name of the resource group that contains the IoT hub.

resourceName
path True
  • string

The name of the IoT hub.

keyName
path True
  • string

The name of the shared access policy.

api-version
query True
  • string

The version of the API.

Responses

Name Type Description
200 OK

This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more IoT hub endpoints.

Other Status Codes

DefaultErrorResponse

Security

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 impersonate your user account

Examples

IotHubResource_GetKeysForKeyName

Sample Request

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/IotHubKeys/iothubowner/listkeys?api-version=2018-04-01

Sample Response

{
  "keyName": "iothubowner",
  "primaryKey": "2aWPrKloLLdcug12ZHNpA0e07yJmRRmYMXDLpEOTd/Y=",
  "secondaryKey": "DLyFnDTGMDK0BU2QjT5TCkNBQ4h08mi20vOqWMC7TxU=",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}

Definitions

AccessRights

The permissions assigned to the shared access policy.

ErrorDetails

Error details.

SharedAccessSignatureAuthorizationRule

The properties of an IoT hub shared access policy.

AccessRights

The permissions assigned to the shared access policy.

Name Type 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

Error details.

Name Type Description
code
  • string

The error code.

details
  • string

The error details.

httpStatusCode
  • string

The HTTP status code.

message
  • string

The error message.

SharedAccessSignatureAuthorizationRule

The properties of an IoT hub shared access policy.

Name Type Description
keyName
  • string

The name of the shared access policy.

primaryKey
  • string

The primary key.

rights

The permissions assigned to the shared access policy.

secondaryKey
  • string

The secondary key.