Freigeben über


Iot Dps Resource - List Keys

Rufen Sie die Sicherheitsmetadaten für einen Bereitstellungsdienst ab.
Listen Sie die primären und sekundären Schlüssel für einen Bereitstellungsdienst auf.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
provisioningServiceName
path True

string

Der Name des Bereitstellungsdiensts, für den die freigegebenen Zugriffsschlüssel abgerufen werden sollen.

resourceGroupName
path True

string

Ressourcengruppenname

subscriptionId
path True

string

Die Abonnement-ID.

api-version
query True

string

Die Version der API.

Antworten

Name Typ Beschreibung
200 OK

SharedAccessSignatureAuthorizationRuleListResult

Dies ist ein synchroner Vorgang. Der Text enthält ein JSON-serialisiertes Array von Shared Access-Richtlinien, einschließlich Schlüsseln, die Sie für den Zugriff auf die Bereitstellungsdienstendpunkte verwenden können.

Other Status Codes

ErrorDetails

Standardfehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

DPSListKeys

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
AccessRightsDescription

Rechte, die dieser Schlüssel besitzt.

ErrorDetails

Fehlerdetails.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des freigegebenen Zugriffsschlüssels.

SharedAccessSignatureAuthorizationRuleListResult

Liste der freigegebenen Zugriffsschlüssel.

AccessRightsDescription

Rechte, die dieser Schlüssel besitzt.

Name Typ Beschreibung
DeviceConnect

string

EnrollmentRead

string

EnrollmentWrite

string

RegistrationStatusRead

string

RegistrationStatusWrite

string

ServiceConfig

string

ErrorDetails

Fehlerdetails.

Name Typ Beschreibung
code

integer

Der Fehlercode.

details

string

Die Fehlerdetails.

httpStatusCode

string

Der HTTP-Statuscode.

message

string

Die Fehlermeldung.

SharedAccessSignatureAuthorizationRule[AccessRightsDescription]

Beschreibung des freigegebenen Zugriffsschlüssels.

Name Typ Beschreibung
keyName

string

Name des Schlüssels.

primaryKey

string

Primärer SAS-Schlüsselwert.

rights

AccessRightsDescription

Rechte, die dieser Schlüssel besitzt.

secondaryKey

string

Sekundärer SAS-Schlüsselwert.

SharedAccessSignatureAuthorizationRuleListResult

Liste der freigegebenen Zugriffsschlüssel.

Name Typ Beschreibung
nextLink

string

Der nächste Link.

value

SharedAccessSignatureAuthorizationRule[AccessRightsDescription][]

Die Liste der Shared Access-Richtlinien.