Sdílet prostřednictvím


Iot Dps Resource - List Keys For Key Name

Získejte zásady sdíleného přístupu podle názvu ze služby zřizování.
Výpis primárního a sekundárního klíče pro konkrétní název klíče

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
keyName
path True

string

Název logického klíče, pro který chcete získat hodnoty klíče.

provisioningServiceName
path True

string

Název služby zřizování

resourceGroupName
path True

string

Název skupiny prostředků, která obsahuje službu zřizování.

subscriptionId
path True

string

Identifikátor předplatného.

api-version
query True

string

Verze rozhraní API

Odpovědi

Name Typ Description
200 OK

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Jedná se o synchronní operaci. Tělo obsahuje serializované zásady sdíleného přístupu JSON, včetně klíčů, které můžete použít pro přístup k jednomu nebo několika koncovým bodům služby zřizování.

Other Status Codes

ErrorDetails

Výchozí odpověď na chybu.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

DPSGetKey

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
AccessRightsDescription

Práva, která tento klíč má.

ErrorDetails

Podrobnosti o chybě.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Popis sdíleného přístupového klíče

AccessRightsDescription

Práva, která tento klíč má.

Name Typ Description
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

ErrorDetails

Podrobnosti o chybě.

Name Typ Description
code

integer

Kód chyby

details

string

Podrobnosti o chybě

httpStatusCode

string

Stavový kód HTTP

message

string

Chybová zpráva

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Popis sdíleného přístupového klíče

Name Typ Description
keyName

string

Název klíče.

primaryKey

string

Hodnota primárního klíče SAS.

rights

AccessRightsDescription

Práva, která tento klíč má.

secondaryKey

string

Hodnota sekundárního klíče SAS.