Iot Dps Resource - List Keys For Key Name

Referencia

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Közös hozzáférési szabályzat lekérése név szerint egy kiépítési szolgáltatásból.
Egy adott kulcsnév elsődleges és másodlagos kulcsainak listázása

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
keyName	path	True	string	Logikai kulcs neve a kulcsértékek lekéréséhez.
provisioningServiceName	path	True	string	A kiépítési szolgáltatás neve.
resourceGroupName	path	True	string	A kiépítési szolgáltatást tartalmazó erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés azonosítója.
api-version	query	True	string	Az API verziója.

Válaszok

Name	Típus	Description
200 OK	SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	Ez egy szinkron művelet. A törzs tartalmaz egy JSON-szerializált megosztott hozzáférési szabályzatot, beleértve a kulcsokat is, amelyeket egy vagy több kiépítési szolgáltatásvégpont eléréséhez használhat.
Other Status Codes	ErrorDetails	Alapértelmezett hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

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"
}

Definíciók

Name	Description
AccessRightsDescription	A kulcshoz fűződő jogok.
ErrorDetails	Hiba részletei.
SharedAccessSignatureAuthorizationRule[AccessRightsDescription]	A megosztott hozzáférési kulcs leírása.

AccessRightsDescription

A kulcshoz fűződő jogok.

Name	Típus	Description
DeviceConnect	string
EnrollmentRead	string
EnrollmentWrite	string
RegistrationStatusRead	string
RegistrationStatusWrite	string
ServiceConfig	string

ErrorDetails

Hiba részletei.

Name	Típus	Description
code	integer	A hibakód.
details	string	A hiba részletei.
httpStatusCode	string	A HTTP-állapotkód.
message	string	A hibaüzenet.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

A megosztott hozzáférési kulcs leírása.

Name	Típus	Description
keyName	string	A kulcs neve.
primaryKey	string	Elsődleges SAS-kulcs értéke.
rights	AccessRightsDescription	A kulcshoz fűződő jogok.
secondaryKey	string	Másodlagos SAS-kulcs értéke.