Share via


KeyVaultResource.GetKeyVaultSecretAsync(String, CancellationToken) Method

Definition

Gets the specified secret. NOTE: This API is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
  • Operation Id: Secrets_Get
  • Default Api Version: 2023-07-01
  • Resource: KeyVaultSecretResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>> GetKeyVaultSecretAsync (string secretName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetKeyVaultSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>>
override this.GetKeyVaultSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.KeyVault.KeyVaultSecretResource>>
Public Overridable Function GetKeyVaultSecretAsync (secretName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of KeyVaultSecretResource))

Parameters

secretName
String

The name of the secret.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

secretName is null.

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

Applies to