AzureKeyVaultResource Methods

ClassMethods3 members

A resource that represents an Azure Key Vault.

AddAsExistingResource(AzureResourceInfrastructure)overrideProvisionableResource

Adds a new Primitives.ProvisionableResource into infra. The new resource represents a reference to the current Azure.AzureProvisioningResource via https://learn.microsoft.com/azure/azure-resource-manager/bicep/existing-resource.

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

AzureKeyVaultResource.cs#L119-L142

Parameters

infraAzureResourceInfrastructureThe Azure.AzureResourceInfrastructure to add the existing resource into.

Returns

ProvisionableResourceA new Primitives.ProvisionableResource, typically using the FromExisting method on the derived Primitives.ProvisionableResource class.

GetConnectionStringAsync(CancellationToken)ValueTask<string?>

Gets the connection string for the Azure Key Vault resource.

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

AzureKeyVaultResource.cs#L84-L89

Parameters

cancellationTokenCancellationTokenoptional 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)IAzureKeyVaultSecretReference

Gets a secret reference for the specified secret name.

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

AzureKeyVaultResource.cs#L111-L113

Parameters

secretNamestring

Exceptions

ArgumentException