Udostępnij za pośrednictwem


Iot Dps Resource - List Keys For Key Name

Pobierz zasady dostępu współdzielonego według nazwy z usługi aprowizacji.
Wyświetlanie listy kluczy podstawowych i pomocniczych dla określonej nazwy klucza

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
keyName
path True

string

Nazwa klucza logicznego w celu pobrania wartości klucza.

provisioningServiceName
path True

string

Nazwa usługi aprowizacji.

resourceGroupName
path True

string

Nazwa grupy zasobów, która zawiera usługę aprowizacji.

subscriptionId
path True

string

Identyfikator subskrypcji.

api-version
query True

string

Wersja interfejsu API.

Odpowiedzi

Nazwa Typ Opis
200 OK

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Jest to operacja synchroniczna. Treść zawiera zasady dostępu współdzielonego serializowane w formacie JSON, w tym klucze, których można użyć do uzyskiwania dostępu do co najmniej jednego punktu końcowego usługi aprowizacji.

Other Status Codes

ErrorDetails

Domyślna odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

DPSGetKey

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
AccessRightsDescription

Prawa, które ma ten klucz.

ErrorDetails

Szczegóły błędu.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Opis klucza dostępu współdzielonego.

AccessRightsDescription

Prawa, które ma ten klucz.

Nazwa Typ Opis
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

ErrorDetails

Szczegóły błędu.

Nazwa Typ Opis
code

integer

Kod błędu.

details

string

Szczegóły błędu.

httpStatusCode

string

Kod stanu HTTP.

message

string

Komunikat o błędzie.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Opis klucza dostępu współdzielonego.

Nazwa Typ Opis
keyName

string

Nazwa klucza.

primaryKey

string

Podstawowa wartość klucza sygnatury dostępu współdzielonego.

rights

AccessRightsDescription

Prawa, które ma ten klucz.

secondaryKey

string

Wartość pomocniczego klucza sygnatury dostępu współdzielonego.