AzureKeyVaultResource Class

Definition

Namespace:

Aspire.Hosting.Azure

Assembly:

Aspire.Hosting.Azure.KeyVault.dll

Package:

Aspire.Hosting.Azure.KeyVault v13.1.0

Source:

AzureKeyVaultResource.cs

A resource that represents an Azure Key Vault.

public class AzureKeyVaultResource : Aspire.Hosting.Azure.AzureProvisioningResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString, Aspire.Hosting.ApplicationModel.IResourceWithEndpoints, Aspire.Hosting.Azure.IAzureKeyVaultResource

type AzureKeyVaultResource = class
    inherit AzureProvisioningResource
    interface IResourceWithEndpoints
    interface IResource
    interface IResourceWithConnectionString
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences
    interface IAzureKeyVaultResource
    interface IAzureResource

Public Class AzureKeyVaultResource
Inherits AzureProvisioningResource
Implements IAzureKeyVaultResource, IResourceWithConnectionString, IResourceWithEndpoints

Inheritance

Object

Resource

AzureBicepResource

AzureProvisioningResource

AzureKeyVaultResource

Implements

IAzureResource IManifestExpressionProvider IResource IResourceWithConnectionString IResourceWithEndpoints IValueProvider IValueWithReferences IAzureKeyVaultResource

Constructors

Name	Description
AzureKeyVaultResource(String, Action<AzureResourceInfrastructure>)	A resource that represents an Azure Key Vault.

Properties

Name	Description
Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConfigureInfrastructure	Callback for configuring the Azure resources. (Inherited from AzureProvisioningResource)
ConnectionStringExpression	Gets the connection string template for the manifest for the Azure Key Vault resource.
IsEmulator	Gets a value indicating whether the Azure Key Vault resource is running in the local emulator.
Name	Gets the name of the resource. (Inherited from Resource)
NameOutputReference	Gets the "name" output reference for the Azure Key Vault resource.
Outputs	Outputs that will be generated by the bicep template. (Inherited from AzureBicepResource)
Parameters	Parameters that will be passed into the bicep template. (Inherited from AzureBicepResource)
ProvisioningBuildOptions	Gets or sets the ProvisioningBuildOptions which contains common settings and functionality for building Azure resources. (Inherited from AzureProvisioningResource)
ProvisioningTaskCompletionSource	The task completion source for the provisioning operation. (Inherited from AzureBicepResource)
References	References to other objects that may contain Azure resource references. (Inherited from AzureBicepResource)
Scope	The scope of the resource that will be configured in the main Bicep file. (Inherited from AzureBicepResource)
SecretOutputs	Secret outputs that will be generated by the bicep template. (Inherited from AzureBicepResource)
UriExpression	Gets the endpoint URI expression for the Key Vault resource.
VaultUri	Gets the "vaultUri" output reference for the Azure Key Vault resource.

Methods

Name	Description
AddAsExistingResource(AzureResourceInfrastructure)	Adds a new ProvisionableResource into infra. The new resource represents a reference to the current AzureProvisioningResource via https://learn.microsoft.com/azure/azure-resource-manager/bicep/existing-resource.
AddRoleAssignments(IAddRoleAssignmentsContext)	Adds role assignments to this Azure resource. (Inherited from AzureProvisioningResource)
GetBicepTemplateFile(String, Boolean)	Gets the path to the bicep file. If the template is a string or embedded resource, it will be written to a temporary file. (Inherited from AzureProvisioningResource)
GetBicepTemplateString()	Get the bicep template as a string. Does not write to disk. (Inherited from AzureProvisioningResource)
GetConnectionStringAsync(CancellationToken)	Gets the connection string for the Azure Key Vault resource.
GetSecret(String)	Gets a secret reference for the specified secret name.
WriteToManifest(ManifestPublishingContext)	Writes the resource to the manifest. (Inherited from AzureBicepResource)

Explicit Interface Implementations

Name	Description
IAzureKeyVaultResource.SecretResolver
IAzureKeyVaultResource.VaultUriOutputReference
IResourceWithConnectionString.GetConnectionProperties()
IResourceWithParameters.Parameters	(Inherited from AzureBicepResource)

Extension Methods

Name	Description
AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)	Creates a placeholder for an environment variable in the Docker Compose file.
AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, String, Nullable<Boolean>)	Creates a new ProvisioningParameter in infrastructure, or reuses an existing bicep parameter if one with
CombineProperties(IResourceWithConnectionString, IEnumerable<KeyValuePair<String,ReferenceExpression>>)	Combines two sets of connection properties, with properties from the additional set overriding those in the source set in case of key conflicts.
GetBicepIdentifier(IAzureResource)	Gets the Bicep identifier for the Azure resource.
GetConnectionProperty(IResourceWithConnectionString, String)	Retrieves the value of a specified connection property from the resource's connection properties.
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.
GetEndpoint(IResourceWithEndpoints, String, NetworkIdentifier)	Gets an endpoint reference for the specified endpoint name.
GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints, NetworkIdentifier)	Gets references to all endpoints for the specified resource.
GetEndpoints(IResourceWithEndpoints)	Gets references to all endpoints for the specified resource.
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
IsContainer(IResource)	Determines whether the specified resource is a container resource.
IsEmulator(IResource)	Determines whether the specified resource is an emulator resource.
IsExcludedFromPublish(IResource)	Gets a value indicating whether the resource is excluded from being published.
IsExisting(IResource)	Determines if the resource is an existing resource.
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, CancellationToken)	Obsolete. Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, CancellationToken)	Obsolete. Processes environment variable values for the specified resource within the given execution context.
RequiresImageBuild(IResource)	Determines whether the specified resource requires image building.
RequiresImageBuildAndPush(IResource)	Determines whether the specified resource requires image building and pushing.
ResolveEndpoints(IResource, IPortAllocator)	Resolves endpoint port configuration for the specified resource. Computes target ports and exposed ports based on resource type, endpoint configuration, and whether the endpoint is considered a default HTTP endpoint.
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, Boolean, String)	Attempts to get the container image name 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.