Iot Dps Resource - List Keys

Referentie

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Haal de beveiligingsmetagegevens voor een inrichtingsservice op.
De primaire en secundaire sleutels voor een inrichtingsservice weergeven.

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

URI-parameters

Name	In	Vereist	Type	Description
provisioningServiceName	path	True	string	De naam van de inrichtingsservice waarvoor u de gedeelde toegangssleutels wilt ophalen.
resourceGroupName	path	True	string	naam van resourcegroep
subscriptionId	path	True	string	De abonnements-id.
api-version	query	True	string	De versie van de API.

Antwoorden

Name	Type	Description
200 OK	SharedAccessSignatureAuthorizationRuleListResult	Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerde matrix van beleid voor gedeelde toegang, inclusief sleutels, die u kunt gebruiken voor toegang tot de eindpunten van de inrichtingsservice.
Other Status Codes	ErrorDetails	Standaardfoutantwoord.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

DPSListKeys

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Definities

Name	Description
AccessRightsDescription	Rechten die deze sleutel heeft.
ErrorDetails	Foutdetails.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beschrijving van de gedeelde toegangssleutel.
SharedAccessSignatureAuthorizationRuleListResult	Lijst met gedeelde toegangssleutels.

AccessRightsDescription

Rechten die deze sleutel heeft.

Name	Type	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Foutdetails.

Name	Type	Description
code	integer	De foutcode.
details	string	De foutdetails.
httpStatusCode	string	De HTTP-statuscode.
message	string	Het foutbericht.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschrijving van de gedeelde toegangssleutel.

Name	Type	Description
keyName	string	Naam van de sleutel.
primaryKey	string	Waarde van primaire SAS-sleutel.
rights	AccessRightsDescription	Rechten die deze sleutel heeft.
secondaryKey	string	Waarde van secundaire SAS-sleutel.

SharedAccessSignatureAuthorizationRuleListResult

Lijst met gedeelde toegangssleutels.

Name	Type	Description
nextLink	string	De volgende koppeling.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	De lijst met beleid voor gedeelde toegang.