Iot Dps Resource - List Keys For Key Name

Servicio:: IoT Hub Device Provisioning Service

Versión de la API:: 2026-08-31

Enumerar las claves primarias y secundarias para un nombre de clave específico

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/keys/{keyName}/listkeys?api-version=2026-08-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
keyName	path	True	string	Nombre lógico de clave para obtener clave-valores.
provisioningServiceName	path	True	string	Nombre del servicio de aprovisionamiento a recuperar.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Operación de Azure completada con éxito.
Other Status Codes	ErrorDetails	Una respuesta de error inesperada.

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	suplantar su cuenta de usuario

Ejemplos

DPSGetKey

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

{
  "keyName": "testKey",
  "primaryKey": "##################################",
  "rights": "RegistrationStatusWrite",
  "secondaryKey": "################################"
}

Definiciones

Nombre	Description
AccessRightsDescription	Derechos que tiene esta clave.
ErrorDetails	Detalles del error.
SharedAccessSignatureAuthorizationRuleAccessRightsDescription	Descripción de la clave de acceso compartido.

AccessRightsDescription

Enumeración

Derechos que tiene esta clave.

Valor	Description
ServiceConfig
EnrollmentRead
EnrollmentWrite
DeviceConnect
RegistrationStatusRead
RegistrationStatusWrite

ErrorDetails

Objeto

Detalles del error.

Nombre	Tipo	Description
code	integer (int32)	Código de error.
details	string	Detalles del error.
httpStatusCode	string	El código de estado HTTP.
message	string	El mensaje de error.

SharedAccessSignatureAuthorizationRuleAccessRightsDescription

Objeto

Descripción de la clave de acceso compartido.

Nombre	Tipo	Description
keyName	string	Nombre de la clave.
primaryKey	string	Valor de clave SAS principal.
rights	AccessRightsDescription	Derechos que tiene esta clave.
secondaryKey	string	Valor de clave SAS secundaria.