Iot Hub Resource - Get Keys For Key Name
Rufen Sie eine SAS-Richtlinie anhand des Namens von einem IoT Hub ab. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys?api-version=2023-06-30
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
key
|
path | True |
string |
Der Name der SAS-Richtlinie. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die den IoT Hub enthält. |
resource
|
path | True |
string |
Der Name des IoT-Hubs. |
subscription
|
path | True |
string |
Die Abonnement-ID. |
api-version
|
query | True |
string |
Die Version der API. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Dies ist ein synchroner Vorgang. Der Text enthält eine JSON-serialisierte SAS-Richtlinie, einschließlich Schlüsseln, die Sie für den Zugriff auf einen oder mehrere IoT Hub-Endpunkte verwenden können. |
|
Other Status Codes |
DefaultErrorResponse |
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
IotHubResource_GetKeysForKeyName
Beispielanforderung
Beispiel für eine Antwort
{
"keyName": "iothubowner",
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>",
"rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}
Definitionen
Name | Beschreibung |
---|---|
Access |
Die berechtigungen, die der SAS-Richtlinie zugewiesen sind. |
Error |
Fehlerdetails. |
Shared |
Die Eigenschaften einer IoT Hub-Richtlinie für freigegebenen Zugriff. |
AccessRights
Die berechtigungen, die der SAS-Richtlinie zugewiesen sind.
Name | Typ | Beschreibung |
---|---|---|
DeviceConnect |
string |
|
RegistryRead |
string |
|
RegistryRead, DeviceConnect |
string |
|
RegistryRead, RegistryWrite |
string |
|
RegistryRead, RegistryWrite, DeviceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect |
string |
|
RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
RegistryRead, ServiceConnect |
string |
|
RegistryRead, ServiceConnect, DeviceConnect |
string |
|
RegistryWrite |
string |
|
RegistryWrite, DeviceConnect |
string |
|
RegistryWrite, ServiceConnect |
string |
|
RegistryWrite, ServiceConnect, DeviceConnect |
string |
|
ServiceConnect |
string |
|
ServiceConnect, DeviceConnect |
string |
ErrorDetails
Fehlerdetails.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Der Fehlercode. |
details |
string |
Die Fehlerdetails. |
httpStatusCode |
string |
Der HTTP-Statuscode. |
message |
string |
Die Fehlermeldung. |
SharedAccessSignatureAuthorizationRule
Die Eigenschaften einer IoT Hub-Richtlinie für freigegebenen Zugriff.
Name | Typ | Beschreibung |
---|---|---|
keyName |
string |
Der Name der SAS-Richtlinie. |
primaryKey |
string |
Der primäre Schlüssel. |
rights |
Die berechtigungen, die der SAS-Richtlinie zugewiesen sind. |
|
secondaryKey |
string |
Der sekundäre Schlüssel. |