Iot Hub Resource - Get Keys For Key Name

Haal een beleid voor gedeelde toegang op naam op van 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=2018-04-01

URI-parameters

Name In Required Type Description
keyName
path True
  • string

De naam van het beleid voor gedeelde toegang.

resourceGroupName
path True
  • string

De naam van de resourcegroep die de IoT-hub bevat.

resourceName
path True
  • string

De naam van de IoT-hub.

subscriptionId
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 body bevat een met JSON geser serialiseerd beleid voor gedeelde toegang, 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-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

IotHubResource_GetKeysForKeyName

Sample Request

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/IotHubKeys/iothubowner/listkeys?api-version=2018-04-01

Sample Response

{
  "keyName": "iothubowner",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "rights": "RegistryWrite, ServiceConnect, DeviceConnect"
}

Definities

AccessRights

De machtigingen die zijn toegewezen aan het beleid voor gedeelde toegang.

ErrorDetails

Foutdetails.

SharedAccessSignatureAuthorizationRule

De eigenschappen van een gedeeld toegangsbeleid voor IoT Hub.

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 Hub.

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.