Udostępnij za pośrednictwem


Iot Dps Resource - List Keys

Pobierz metadane zabezpieczeń dla usługi aprowizacji.
Wyświetl listę kluczy podstawowych i pomocniczych dla usługi aprowizacji.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
provisioningServiceName
path True

string

Nazwa usługi aprowizacji w celu pobrania kluczy dostępu współużytkowanego.

resourceGroupName
path True

string

nazwa grupy zasobów

subscriptionId
path True

string

Identyfikator subskrypcji.

api-version
query True

string

Wersja interfejsu API.

Odpowiedzi

Nazwa Typ Opis
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Jest to operacja synchroniczna. Treść zawiera szeregowaną w formacie JSON tablicę zasad dostępu współdzielonego, w tym klucze, których można użyć do uzyskiwania dostępu do punktów końcowych 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

DPSListKeys

Przykładowe żądanie

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/listkeys?api-version=2022-12-12

Przykładowa odpowiedź

{
  "value": [
    {
      "keyName": "key1",
      "primaryKey": "#####################################",
      "secondaryKey": "###################################",
      "rights": "ServiceConfig"
    },
    {
      "keyName": "key2",
      "primaryKey": "#######################################",
      "secondaryKey": "####################################=",
      "rights": "ServiceConfig"
    }
  ]
}

Definicje

Nazwa Opis
AccessRightsDescription

Prawa, które ma ten klucz.

ErrorDetails

Szczegóły błędu.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Opis klucza dostępu współdzielonego.

SharedAccessSignatureAuthorizationRuleListResult

Lista kluczy 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.

SharedAccessSignatureAuthorizationRuleListResult

Lista kluczy dostępu współdzielonego.

Nazwa Typ Opis
nextLink

string

Następny link.

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Lista zasad dostępu współdzielonego.