Compartir a través de


Iot Dps Resource - List Keys

Obtenga los metadatos de seguridad de un servicio de aprovisionamiento.
Enumere las claves principal y secundaria de un servicio de aprovisionamiento.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/listkeys?api-version=2022-12-12

Parámetros de identificador URI

Nombre En Requerido Tipo Description
provisioningServiceName
path True

string

Nombre del servicio de aprovisionamiento para el que se obtienen las claves de acceso compartido.

resourceGroupName
path True

string

nombre del grupo de recursos

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

SharedAccessSignatureAuthorizationRuleListResult

Se trata de una operación sincrónica. El cuerpo contiene una matriz serializada por JSON de directivas de acceso compartido, incluidas las claves, que puede usar para acceder a los puntos de conexión del servicio de aprovisionamiento.

Other Status Codes

ErrorDetails

Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de 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

DPSListKeys

Solicitud de ejemplo

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

Respuesta de muestra

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

Definiciones

Nombre Description
AccessRightsDescription

Derechos que tiene esta clave.

ErrorDetails

Detalles del error.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Descripción de la clave de acceso compartido.

SharedAccessSignatureAuthorizationRuleListResult

Lista de claves 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 secundaria.

SharedAccessSignatureAuthorizationRuleListResult

Lista de claves de acceso compartido.

Nombre Tipo Description
nextLink

string

Vínculo siguiente.

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Lista de directivas de acceso compartido.