AzureKeyVaultSecretResource Class

Definition

Namespace:: Aspire.Hosting.Azure

Assembly:: Aspire.Hosting.Azure.KeyVault.dll

Package:: Aspire.Hosting.Azure.KeyVault v9.4.0

Source:: AzureKeyVaultSecretResource.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 an Azure Key Vault Secret. Initializes a new instance of the AzureKeyVaultSecretResource class.

public class AzureKeyVaultSecretResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IManifestExpressionProvider, Aspire.Hosting.ApplicationModel.IResourceWithParent<Aspire.Hosting.Azure.AzureKeyVaultResource>, Aspire.Hosting.ApplicationModel.IValueProvider, Aspire.Hosting.ApplicationModel.IValueWithReferences, Aspire.Hosting.Azure.IAzureKeyVaultSecretReference

type AzureKeyVaultSecretResource = class
    inherit Resource
    interface IResourceWithParent<AzureKeyVaultResource>
    interface IResourceWithParent
    interface IResource
    interface IAzureKeyVaultSecretReference
    interface IValueProvider
    interface IManifestExpressionProvider
    interface IValueWithReferences

Public Class AzureKeyVaultSecretResource
Inherits Resource
Implements IAzureKeyVaultSecretReference, IManifestExpressionProvider, IResourceWithParent(Of AzureKeyVaultResource), IValueProvider, IValueWithReferences

Inheritance: Object

Resource
AzureKeyVaultSecretResource

Implements: IManifestExpressionProvider IResource IResourceWithParent IResourceWithParent<AzureKeyVaultResource> IValueProvider IValueWithReferences IAzureKeyVaultSecretReference

Remarks

Use ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>) to configure specific Aspire.Hosting.Azure.Provisioning properties.

Constructors

AzureKeyVaultSecretResource(String, String, AzureKeyVaultResource, Object)

Represents an Azure Key Vault Secret. Initializes a new instance of the AzureKeyVaultSecretResource class.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
Name	Gets the name of the resource. (Inherited from Resource)
Parent	Gets the parent Azure Key Vault resource.
SecretName	Gets or sets the secret name.
Value	Gets the value provider for the secret.

Explicit Interface Implementations

IAzureKeyVaultSecretReference.Resource	Gets the Azure Key Vault resource that contains this secret.
IManifestExpressionProvider.ValueExpression	Gets the expression for the secret value in the manifest.
IValueProvider.GetValueAsync(CancellationToken)	Gets the secret value asynchronously.

Extension Methods

GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)	Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
IsExcludedFromPublish(IResource)	Gets a value indicating whether the resource is excluded from being published.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)	Attempts to retrieve the URLs for the given resource.
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
IsContainer(IResource)	Determines whether the specified resource is a container resource.
AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)	Creates a placeholder for an environment variable in the Docker Compose file.
IsEmulator(IResource)	Determines whether the specified resource is an emulator resource.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to