你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

IotHubDescriptionResource.GetKeysForKeyNameAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.IotHub
Assembly:
Azure.ResourceManager.IotHub.dll
Package:
Azure.ResourceManager.IotHub v1.1.1
Package:
Azure.ResourceManager.IotHub v1.2.0-beta.1
Source:
IotHubDescriptionResource.cs

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

Task<Response<SharedAccessSignatureAuthorizationRule>>

Exceptions

ArgumentException

keyName is an empty string, and was expected to be non-empty.

ArgumentNullException

keyName is null.

Applies to