KeyVaultSecretCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Tries to get details for this resource from the service.

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