Compartir a través de


Iot Hub Resource - Get Keys For Key Name

Obtenga una directiva de acceso compartido por su nombre desde un centro de IoT. Para obtener más información, consulte: 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=2023-06-30

Parámetros de identificador URI

Nombre En Requerido Tipo Description
keyName
path True

string

Nombre de la directiva de acceso compartido.

resourceGroupName
path True

string

Nombre del grupo de recursos que contiene el centro de IoT.

resourceName
path True

string

Nombre del centro de IoT.

subscriptionId
path True

string

Identificador de la suscripción.

api-version
query True

string

La versión de la API.

Respuestas

Nombre Tipo Description
200 OK

SharedAccessSignatureAuthorizationRule

Se trata de una operación sincrónica. El cuerpo contiene una directiva de acceso compartido serializada por JSON, incluidas las claves, que puede usar para acceder a uno o varios puntos de conexión de IoT Hub.

Other Status Codes

ErrorDetails

DefaultErrorResponse

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantación de su cuenta de usuario

Ejemplos

IotHubResource_GetKeysForKeyName

Solicitud de ejemplo

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

Respuesta de muestra

{
  "keyName": "iothubowner",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}

Definiciones

Nombre Description
AccessRights

Permisos asignados a la directiva de acceso compartido.

ErrorDetails

Detalles del error.

SharedAccessSignatureAuthorizationRule

Las propiedades de una directiva de acceso compartido de IoT Hub.

AccessRights

Permisos asignados a la directiva de acceso compartido.

Nombre Tipo 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

Detalles del error.

Nombre Tipo Description
code

string

Código de error.

details

string

Los detalles del error.

httpStatusCode

string

El código de estado HTTP.

message

string

El mensaje de error.

SharedAccessSignatureAuthorizationRule

Las propiedades de una directiva de acceso compartido de IoT Hub.

Nombre Tipo Description
keyName

string

Nombre de la directiva de acceso compartido.

primaryKey

string

Clave principal.

rights

AccessRights

Permisos asignados a la directiva de acceso compartido.

secondaryKey

string

Clave secundaria.