IotHubDescriptionResource.GetKeysForKeyNameAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys
- Operation Id: IotHubResource_GetKeysForKeyName
- Default Api Version: 2023-06-30
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.Models.SharedAccessSignatureAuthorizationRule>> GetKeysForKeyNameAsync (string keyName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetKeysForKeyNameAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.Models.SharedAccessSignatureAuthorizationRule>>
override this.GetKeysForKeyNameAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.Models.SharedAccessSignatureAuthorizationRule>>
Public Overridable Function GetKeysForKeyNameAsync (keyName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SharedAccessSignatureAuthorizationRule))
Parameters
- keyName
- String
The name of the shared access policy.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
keyName
is an empty string, and was expected to be non-empty.
keyName
is null.