Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2021-04-273265113.0 KB
POST

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/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys

Path parameters

subscriptionIdstring required

The subscription identifier.

resourceGroupNamestring required

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

resourceNamestring required

The name of the IoT hub.

keyNamestring required

The name of the shared access policy.

Query parameters

api-versionstring required

The version of the API.

Response

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.

keyNamestring required

The name of the shared access policy.

primaryKeystring

The primary key.

secondaryKeystring

The secondary key.

rights'RegistryRead' | 'RegistryWrite' | 'ServiceConnect' | 'DeviceConnect' | 'RegistryRead, RegistryWrite' | 'RegistryRead, ServiceConnect' | 'RegistryRead, DeviceConnect' | 'RegistryWrite, ServiceConnect' | 'RegistryWrite, DeviceConnect' | 'ServiceConnect, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect' | 'RegistryRead, RegistryWrite, DeviceConnect' | 'RegistryRead, ServiceConnect, DeviceConnect' | 'RegistryWrite, ServiceConnect, DeviceConnect' | 'RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect' required

The permissions assigned to the shared access policy.