Iot Dps Resource - List Keys For Key Name
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=2026-11-01
Parametry identyfikatora URI
| Nazwisko | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
key
|
path | True |
string |
Logiczna nazwa klucza, dla której można uzyskać wartości klucza. |
|
provisioning
|
path | True |
string |
Nazwa usługi provisioning do pobrania. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter. |
|
subscription
|
path | True |
string minLength: 1 |
Identyfikator subskrypcji docelowej. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Odpowiedzi
| Nazwisko | Typ | Opis |
|---|---|---|
| 200 OK |
Shared |
Operacja Azure zakończyła się pomyślnie. |
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 w usłudze Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwisko | Opis |
|---|---|
| user_impersonation | podszywaj się pod konto 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=2026-11-01
Przykładowa odpowiedź
{
"keyName": "testKey",
"primaryKey": "##################################",
"rights": "RegistrationStatusWrite",
"secondaryKey": "################################"
}
Definicje
| Nazwisko | Opis |
|---|---|
|
Access |
Prawa, które ma ten klucz. |
|
Error |
Szczegóły błędu. |
|
Shared |
Opis klucza dostępu współdzielonego. |
AccessRightsDescription
Prawa, które ma ten klucz.
| Wartość | Opis |
|---|---|
| ServiceConfig | |
| EnrollmentRead | |
| EnrollmentWrite | |
| DeviceConnect | |
| RegistrationStatusRead | |
| RegistrationStatusWrite |
ErrorDetails
Szczegóły błędu.
| Nazwisko | Typ | Opis |
|---|---|---|
| code |
integer (int32) |
Kod błędu. |
| details |
string |
Szczegóły błędu. |
| httpStatusCode |
string |
Kod statusu HTTP. |
| message |
string |
Komunikat o błędzie. |
SharedAccessSignatureAuthorizationRuleAccessRightsDescription
Opis klucza dostępu współdzielonego.
| Nazwisko | Typ | Opis |
|---|---|---|
| keyName |
string |
Nazwa klucza. |
| primaryKey |
string |
Podstawowa wartość klucza sygnatury dostępu współdzielonego. |
| rights |
Prawa, które ma ten klucz. |
|
| secondaryKey |
string |
Pomocnicza wartość klucza sygnatury dostępu współdzielonego. |