Iot Dps Resource - List Keys For Key Name

Referencia

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Obtenga una directiva de acceso compartido por su nombre desde un servicio de aprovisionamiento.
Enumeración de claves principales 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=2022-12-12

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
keyName	path	True	string	Nombre de clave lógica para el que se obtienen los valores de clave.
provisioningServiceName	path	True	string	Nombre del servicio de aprovisionamiento.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el servicio de aprovisionamiento.
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[AccessRightsDescription]	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 servicio de aprovisionamiento.
Other Status Codes	ErrorDetails	Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

DPSGetKey

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definiciones

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

AccessRightsDescription

Derechos que tiene esta clave.

Nombre	Tipo	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Detalles del error.

Nombre	Tipo	Description
code	integer	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[AccessRightsDescription]

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 secundario.