# AzureKeyVaultResource Methods

- Package: [Aspire.Hosting.Azure.KeyVault](/reference/api/csharp/aspire.hosting.azure.keyvault.md)
- Type: [AzureKeyVaultResource](/reference/api/csharp/aspire.hosting.azure.keyvault/azurekeyvaultresource.md)
- Kind: `Methods`
- Members: `3`

A resource that represents an Azure Key Vault.

## AddAsExistingResource(AzureResourceInfrastructure)

- Name: `AddAsExistingResource(AzureResourceInfrastructure)`
- Modifiers: `override`
- Returns: `ProvisionableResource`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/cbc352350f1a9bafbaff10d14a2c8de4ac186a48/src/Aspire.Hosting.Azure.KeyVault/AzureKeyVaultResource.cs#L119-L142)

```csharp
public class AzureKeyVaultResource
{
    public override ProvisionableResource AddAsExistingResource(
        AzureResourceInfrastructure infra)
    {
        // ...
    }
}
```

## Parameters

- `infra` (`AzureResourceInfrastructure`)

## GetConnectionStringAsync(CancellationToken)

- Name: `GetConnectionStringAsync(CancellationToken)`
- Returns: `ValueTask<string?>`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/cbc352350f1a9bafbaff10d14a2c8de4ac186a48/src/Aspire.Hosting.Azure.KeyVault/AzureKeyVaultResource.cs#L84-L89)

Gets the connection string for the Azure Key Vault resource.

```csharp
public class AzureKeyVaultResource
{
    public ValueTask<string?> GetConnectionStringAsync(
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}
```

## Parameters

- `cancellationToken` (`CancellationToken`) `optional`
  A `Threading.CancellationToken` to observe while waiting for the task to complete.

## Returns

`ValueTask<string?>` -- The connection string for the Azure Key Vault resource.

## GetSecret(string)

- Name: `GetSecret(string)`
- Returns: `IAzureKeyVaultSecretReference`
- Source: [GitHub](https://github.com/microsoft/aspire/blob/cbc352350f1a9bafbaff10d14a2c8de4ac186a48/src/Aspire.Hosting.Azure.KeyVault/AzureKeyVaultResource.cs#L111-L113)

Gets a secret reference for the specified secret name.

```csharp
public class AzureKeyVaultResource
{
    public IAzureKeyVaultSecretReference GetSecret(
        string secretName)
    {
        // ...
    }
}
```

## Parameters

- `secretName` (`string`)

## Exceptions

- `ArgumentException`