IAzureKeyVaultSecretReference Interface

Reference

Definition

Namespace:: Aspire.Hosting.Azure

Assembly:: Aspire.Hosting.Azure.dll

Package:: Aspire.Hosting.Azure v9.2.0

Package:: Aspire.Hosting.Azure v9.3.0

Source:: IAzureKeyVaultSecretReference.cs

Source:: IAzureKeyVaultSecretReference.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a reference to a secret in an Azure Key Vault resource.

public interface IAzureKeyVaultSecretReference : Aspire.Hosting.ApplicationModel.IManifestExpressionProvider, Aspire.Hosting.ApplicationModel.IValueProvider

public interface IAzureKeyVaultSecretReference : Aspire.Hosting.ApplicationModel.IManifestExpressionProvider, Aspire.Hosting.ApplicationModel.IValueProvider, Aspire.Hosting.ApplicationModel.IValueWithReferences

type IAzureKeyVaultSecretReference = interface
    interface IValueProvider
    interface IManifestExpressionProvider

type IAzureKeyVaultSecretReference = interface
    interface IValueProvider
    interface IManifestExpressionProvider
    interface IValueWithReferences

Public Interface IAzureKeyVaultSecretReference
Implements IManifestExpressionProvider, IValueProvider

Public Interface IAzureKeyVaultSecretReference
Implements IManifestExpressionProvider, IValueProvider, IValueWithReferences

Implements: IManifestExpressionProvider IValueProvider IValueWithReferences

Properties

References	The referenced objects of the value. (Inherited from IValueWithReferences)
Resource	Gets the Azure Key Vault resource.
SecretName	Gets the name of the secret.
ValueExpression	Gets the expression that represents a value in manifest. (Inherited from IManifestExpressionProvider)

Methods

GetValueAsync(CancellationToken)

Gets the value for use as an environment variable.

(Inherited from IValueProvider)

Explicit Interface Implementations

IValueWithReferences.References

Extension Methods

AsKeyVaultSecret(IAzureKeyVaultSecretReference, AzureResourceInfrastructure)

Gets or creates a KeyVaultSecret resource in the specified AzureResourceInfrastructure for the given IAzureKeyVaultSecretReference.

If the referenced Key Vault or secret does not already exist in the infrastructure, they will be created and added. This allows referencing secrets that are provisioned outside of the current deployment.

AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, String, Nullable<Boolean>)

Creates a new ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with

AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)

Creates a placeholder for an environment variable in the Docker Compose file.

Applies to

Share via