Iot Dps Resource - List Keys

Referencia

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

Lekérheti egy kiépítési szolgáltatás biztonsági metaadatait.
Egy kiépítési szolgáltatás elsődleges és másodlagos kulcsainak listázása.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
provisioningServiceName	path	True	string	A kiépítési szolgáltatás neve a megosztott hozzáférési kulcsok lekéréséhez.
resourceGroupName	path	True	string	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	SharedAccessSignatureAuthorizationRuleListResult	Ez egy szinkron művelet. A törzs megosztott hozzáférési szabályzatok JSON-szerializált tömbje, beleértve a kulcsokat is, amelyeket a kiépítési szolgáltatásvégpontok 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

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

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.
SharedAccessSignatureAuthorizationRuleListResult	A megosztott hozzáférési kulcsok listája.

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.

SharedAccessSignatureAuthorizationRuleListResult

A megosztott hozzáférési kulcsok listája.

Name	Típus	Description
nextLink	string	A következő hivatkozás.
value	SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]	A megosztott hozzáférési szabályzatok listája.