IIotHubResourceOperations.GetKeysForKeyNameWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Management.IotHub

Assembly:: Microsoft.Azure.Management.IotHub.dll

Package:: Microsoft.Azure.Management.IotHub v4.2.0

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.IotHub.Models.SharedAccessSignatureAuthorizationRule>> GetKeysForKeyNameWithHttpMessagesAsync (string resourceGroupName, string resourceName, string keyName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetKeysForKeyNameWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.IotHub.Models.SharedAccessSignatureAuthorizationRule>>

Public Function GetKeysForKeyNameWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, keyName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of SharedAccessSignatureAuthorizationRule))

Parameters

resourceGroupName: String

The name of the resource group that contains the IoT hub.

resourceName: String

The name of the IoT hub.

keyName: String

The name of the shared access policy.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<SharedAccessSignatureAuthorizationRule>>

Exceptions

ErrorDetailsException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

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.

Applies to