Sdílet prostřednictvím


Iot Dps Resource - List Keys

Získejte metadata zabezpečení pro službu zřizování.
Vypíše primární a sekundární klíč pro službu zřizování.

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

Parametry identifikátoru URI

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

string

Název služby zřizování, ke které chcete získat sdílené přístupové klíče.

resourceGroupName
path True

string

název skupiny prostředků

subscriptionId
path True

string

Identifikátor předplatného.

api-version
query True

string

Verze rozhraní API

Odpovědi

Name Typ Description
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Jedná se o synchronní operaci. Tělo obsahuje serializované pole zásad sdíleného přístupu json, včetně klíčů, které můžete použít pro přístup ke 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

DPSListKeys

Ukázkový požadavek

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

Ukázková odpověď

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

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

SharedAccessSignatureAuthorizationRuleListResult

Seznam sdílených přístupových klíčů

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.

SharedAccessSignatureAuthorizationRuleListResult

Seznam sdílených přístupových klíčů

Name Typ Description
nextLink

string

Další odkaz.

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Seznam zásad sdíleného přístupu