Skip to content
Docs Try Aspire

AzureKeyVaultResource

Handle TypeScript
📦 Aspire.Hosting.Azure.KeyVault v13.2.0-preview.1.26159.1
interface AzureKeyVaultResource
extends IAzureResource,
IManifestExpressionProvider,
IResource,
IResourceWithConnectionString,
IResourceWithEndpoints,
IResourceWithParameters,
IValueProvider,
IValueWithReferences,
IAzureKeyVaultResource,
IAzurePrivateEndpointTarget {
addSecret(
name: string,
parameterResource: ParameterResource): AzureKeyVaultSecretResource;
addSecretFromExpression(
name: string,
value: ReferenceExpression): AzureKeyVaultSecretResource;
addSecretWithName(
name: string,
secretName: string,
parameterResource: ParameterResource): AzureKeyVaultSecretResource;
addSecretWithNameFromExpression(
name: string,
secretName: string,
value: ReferenceExpression): AzureKeyVaultSecretResource;
getSecret(secretName: string): IAzureKeyVaultSecretReference;
}

Methods

method addSecret builder
Adds a secret to the Azure Key Vault from a parameter resource
addSecret(
name: string,
parameterResource: ParameterResource): AzureKeyVaultSecretResource
name string
parameterResource ParameterResource
AzureKeyVaultSecretResource
method addSecretFromExpression builder
Adds a secret to the Azure Key Vault from a reference expression
addSecretFromExpression(
name: string,
value: ReferenceExpression): AzureKeyVaultSecretResource
name string
value ReferenceExpression
AzureKeyVaultSecretResource
method addSecretWithName builder
Adds a named secret to the Azure Key Vault from a parameter resource
addSecretWithName(
name: string,
secretName: string,
parameterResource: ParameterResource): AzureKeyVaultSecretResource
name string
secretName string
parameterResource ParameterResource
AzureKeyVaultSecretResource
method addSecretWithNameFromExpression builder
Adds a named secret to the Azure Key Vault from a reference expression
addSecretWithNameFromExpression(
name: string,
secretName: string,
value: ReferenceExpression): AzureKeyVaultSecretResource
name string
secretName string
value ReferenceExpression
AzureKeyVaultSecretResource
method getSecret
Gets a secret reference from the Azure Key Vault
getSecret(secretName: string): IAzureKeyVaultSecretReference
secretName string
IAzureKeyVaultSecretReference