AzureKeyVaultResource Class

Reference

Definition

Namespace:: Aspire.Hosting.Azure

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

Package:: Aspire.Hosting.Azure.KeyVault v8.2.0

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

Source:: AzureKeyVaultResource.cs

Source:: AzureKeyVaultResource.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.

A resource that represents an Azure Key Vault.

public class AzureKeyVaultResource : Aspire.Hosting.AzureConstructResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString

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

type AzureKeyVaultResource = class
    inherit AzureConstructResource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

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

Public Class AzureKeyVaultResource
Inherits AzureConstructResource
Implements IResourceWithConnectionString

Public Class AzureKeyVaultResource
Inherits AzureProvisioningResource
Implements IResourceWithConnectionString

Inheritance: Object

Resource

AzureBicepResource

AzureConstructResource
AzureKeyVaultResource

Inheritance: Object

Resource

AzureBicepResource

AzureProvisioningResource
AzureKeyVaultResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IValueProvider IValueWithReferences

Constructors

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

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConfigureConstruct	Callback for configuring construct. (Inherited from AzureConstructResource)
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.
Name	Gets the name of the resource. (Inherited from 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)
SecretOutputs	Secret outputs that will be generated by the bicep template. (Inherited from AzureBicepResource)
VaultUri	Gets the "vaultUri" output reference for the Azure Key Vault resource.

Methods

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 AzureConstructResource)
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 AzureConstructResource)
GetBicepTemplateString()	Get the bicep template as a string. Does not write to disk. (Inherited from AzureProvisioningResource)
WriteToManifest(ManifestPublishingContext)	Writes the resource to the manifest. (Inherited from AzureBicepResource)

Extension Methods

GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
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.
GetBicepIdentifier(IAzureResource)	Gets the Bicep identifier for the Azure resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.

Applies to

Share via