Iot Hub Resource - Get Keys For Key Name
Een beleid voor gedeelde toegang op naam ophalen uit een IoT-hub. Zie https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security voor meer informatie.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys?api-version=2023-06-30
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
key
|
path | True |
string |
De naam van het beleid voor gedeelde toegang. |
resource
|
path | True |
string |
De naam van de resourcegroep die de IoT-hub bevat. |
resource
|
path | True |
string |
De naam van de IoT-hub. |
subscription
|
path | True |
string |
De abonnements-id. |
api-version
|
query | True |
string |
De versie van de API. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Dit is een synchrone bewerking. De hoofdtekst bevat een JSON-geserialiseerd gedeeld toegangsbeleid, inclusief sleutels, dat u kunt gebruiken voor toegang tot een of meer IoT Hub-eindpunten. |
|
Other Status Codes |
DefaultErrorResponse |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom
Type:
oauth2
Stroom:
implicit
Autorisatie-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiken
Name | Description |
---|---|
user_impersonation | uw gebruikersaccount imiteren |
Voorbeelden
IotHubResource_GetKeysForKeyName
Voorbeeldaanvraag
Voorbeeldrespons
{
"keyName": "iothubowner",
"primaryKey": "<primaryKey>",
"secondaryKey": "<secondaryKey>",
"rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}
Definities
Name | Description |
---|---|
Access |
De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. |
Error |
Foutdetails. |
Shared |
De eigenschappen van een gedeeld toegangsbeleid voor IoT-hubs. |
AccessRights
De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.
Name | Type | Description |
---|---|---|
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
Foutdetails.
Name | Type | Description |
---|---|---|
code |
string |
De foutcode. |
details |
string |
De foutdetails. |
httpStatusCode |
string |
De HTTP-statuscode. |
message |
string |
Het foutbericht. |
SharedAccessSignatureAuthorizationRule
De eigenschappen van een gedeeld toegangsbeleid voor IoT-hubs.
Name | Type | Description |
---|---|---|
keyName |
string |
De naam van het beleid voor gedeelde toegang. |
primaryKey |
string |
De primaire sleutel. |
rights |
De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang. |
|
secondaryKey |
string |
De secundaire sleutel. |