KeyVaultSettingsClient.GetSettingAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.Security.KeyVault.Administration

Assembly:

Azure.Security.KeyVault.Administration.dll

Package:

Azure.Security.KeyVault.Administration v4.5.0

Source:

KeyVaultSettingsClient.cs

Gets the specified account setting.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultSetting>> GetSettingAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSettingAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultSetting>>
override this.GetSettingAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Security.KeyVault.Administration.KeyVaultSetting>>

Public Overridable Function GetSettingAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultSetting))

Parameters

name

String

The name of the account setting. Must be a valid settings option.

cancellationToken

CancellationToken

A CancellationToken controlling the request lifetime.

Returns

Task<Response<KeyVaultSetting>>

A response containing the specified account setting.

Exceptions

ArgumentException

name is an empty string.

ArgumentNullException

name is null.

RequestFailedException

The server returned an error. See Message for details returned from the server.