Iot Dps Resource - List Keys For Key Name

Referens

Tjänst:: IoT Hub Device Provisioning Service

API-version:: 2022-12-12

Hämta en princip för delad åtkomst efter namn från en etableringstjänst.
Lista primära och sekundära nycklar för ett specifikt nyckelnamn

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
keyName	path	True	string	Namn på logisk nyckel som nyckelvärden ska hämtas för.
provisioningServiceName	path	True	string	Namnet på etableringstjänsten.
resourceGroupName	path	True	string	Namnet på resursgruppen som innehåller etableringstjänsten.
subscriptionId	path	True	string	Prenumerationsidentifieraren.
api-version	query	True	string	Versionen av API:et.

Svar

Name	Typ	Description
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Det här är en synkron åtgärd. Brödtexten innehåller en JSON-serialiserad princip för delad åtkomst, inklusive nycklar, som du kan använda för att komma åt en eller flera etableringstjänstslutpunkter.
Other Status Codes	ErrorDetails	Standardfelsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

DPSGetKey

Exempelbegäran

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

Exempelsvar

Statuskod:: 200

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

Definitioner

Name	Description
AccessRightsDescription	Rättigheter som den här nyckeln har.
ErrorDetails	Felinformation.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Beskrivning av nyckeln för delad åtkomst.

AccessRightsDescription

Uppräkning

Rättigheter som den här nyckeln har.

Värde	Description
DeviceConnect
EnrollmentRead
EnrollmentWrite
RegistrationStatusRead
RegistrationStatusWrite
ServiceConfig

ErrorDetails

Objekt

Felinformation.

Name	Typ	Description
code	integer (int32)	Felkoden.
details	string	Felinformationen.
httpStatusCode	string	HTTP-statuskoden.
message	string	Felmeddelandet.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]