Aspire.Hosting.Azure.Redis
Official
📦 Aspire.Hosting.Azure.Redis v13.2.0-preview.1.26159.1 54 Functions
17 Types
17 types and 68 members
Types
handle
AzureBicepResource 9 members handle
AzureEnvironmentResource 2 members handle
AzureKeyVaultResource 5 members handle
AzureKeyVaultSecretResource handle
AzureManagedRedisResource 13 members handle
AzureProvisioningResource 1 members handle
AzureResourceInfrastructure 3 members handle
AzureUserAssignedIdentityResource handle
BicepOutputReference 3 members interface
IAzureKeyVaultResource interface
IAzureKeyVaultSecretReference interface
IAzureResource 9 members handle
RedisCommanderResource 1 members handle
RedisInsightResource 3 members handle
RedisResource 19 members Functions
function
addAzureEnvironment builder Adds the shared Azure environment resource to the application model
addAzureEnvironment(): AzureEnvironmentResource function
addAzureInfrastructure builder Adds an Azure provisioning resource to the application model
addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
addAzureKeyVault builder Adds an Azure Key Vault resource
addAzureKeyVault(name: string): AzureKeyVaultResource function
addAzureManagedRedis builder Adds an Azure Managed Redis resource
addAzureManagedRedis(name: string): AzureManagedRedisResource function
addAzureProvisioning Adds Azure provisioning services to the distributed application builder
addAzureProvisioning(): IDistributedApplicationBuilder function
addAzureUserAssignedIdentity builder Adds an Azure user-assigned identity resource
addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource function
addBicepTemplate builder Adds an Azure Bicep template resource from a file
addBicepTemplate(name: string, bicepFile: string): AzureBicepResource function
addBicepTemplateString builder Adds an Azure Bicep template resource from inline Bicep content
addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource function
addRedis builder Adds a Redis container resource
addRedis(name: string, port?: number, password?: ParameterResource): RedisResource function
addRedisWithPort builder Adds a Redis container resource with specific port
addRedisWithPort(name: string, port: number): RedisResource function
addSecret builder Adds a secret to the Azure Key Vault from a parameter resource
addSecret(name: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource function
addSecretFromExpression builder Adds a secret to the Azure Key Vault from a reference expression
addSecretFromExpression(name: string, value: ReferenceExpression): AzureKeyVaultSecretResource function
addSecretWithName builder Adds a named secret to the Azure Key Vault from a parameter resource
addSecretWithName(name: string, secretName: string, parameterResource: ParameterResource): AzureKeyVaultSecretResource function
addSecretWithNameFromExpression builder Adds a named secret to the Azure Key Vault from a reference expression
addSecretWithNameFromExpression(name: string, secretName: string, value: ReferenceExpression): AzureKeyVaultSecretResource function
asExisting builder Marks an Azure resource as existing in both run and publish modes
asExisting(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
clearDefaultRoleAssignments builder Clears the default Azure role assignments from a resource
clearDefaultRoleAssignments(): IAzureResource function
configureInfrastructure builder Configures the Azure provisioning infrastructure callback
configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => void): AzureProvisioningResource function
getBicepIdentifier Gets the normalized Bicep identifier for an Azure resource
getBicepIdentifier(): string function
getOutput Gets an output reference from an Azure Bicep template resource
getOutput(name: string): BicepOutputReference function
getSecret Gets a secret reference from the Azure Key Vault
getSecret(secretName: string): IAzureKeyVaultSecretReference function
isExisting Determines whether a resource is marked as existing
isExisting(): boolean function
publishAsConnectionString builder Publishes an Azure resource to the manifest as a connection string
publishAsConnectionString(): IAzureResource function
publishAsExisting builder Marks an Azure resource as existing in publish mode
publishAsExisting(name: string, resourceGroup: string): IAzureResource function
publishAsExistingFromParameters builder Marks an Azure resource as existing in publish mode by using parameter resources
publishAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
runAsContainer builder Configures Azure Managed Redis to run in a local container
runAsContainer(configureContainer?: (obj: RedisResource) => void): AzureManagedRedisResource function
runAsExisting builder Marks an Azure resource as existing in run mode
runAsExisting(name: string, resourceGroup: string): IAzureResource function
runAsExistingFromParameters builder Marks an Azure resource as existing in run mode by using parameter resources
runAsExistingFromParameters(nameParameter: ParameterResource, resourceGroupParameter: ParameterResource): IAzureResource function
withAccessKeyAuthentication builder Configures Azure Managed Redis to use access key authentication
withAccessKeyAuthentication(): AzureManagedRedisResource function
withAccessKeyAuthenticationWithKeyVault builder Configures Azure Managed Redis to use access key authentication with a specific Key Vault
withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureManagedRedisResource function
withAzureUserAssignedIdentity builder Associates an Azure user-assigned identity with a compute resource
withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource function
withDataBindMount builder Adds a data bind mount with persistence
withDataBindMount(source: string, isReadOnly?: boolean): RedisResource function
withDataBindMount builder Adds a data bind mount for Redis Insight
withDataBindMount(source: string): RedisInsightResource function
withDataVolume builder Adds a data volume with persistence
withDataVolume(name?: string, isReadOnly?: boolean): RedisResource function
withDataVolume builder Adds a data volume for Redis Insight
withDataVolume(name?: string): RedisInsightResource function
withEnvironmentFromKeyVaultSecret builder Sets an environment variable from an Azure Key Vault secret reference
withEnvironmentFromKeyVaultSecret(name: string, secretReference: IAzureKeyVaultSecretReference): IResourceWithEnvironment function
withEnvironmentFromOutput builder Sets an environment variable from a Bicep output reference
withEnvironmentFromOutput(name: string, bicepOutputReference: BicepOutputReference): IResourceWithEnvironment function
withHostPort builder Sets the host port for Redis Commander
withHostPort(port: number): RedisCommanderResource function
withHostPort builder Sets the host port for Redis Insight
withHostPort(port: number): RedisInsightResource function
withHostPort builder Sets the host port for Redis
withHostPort(port: number): RedisResource function
withKeyVaultRoleAssignments builder Assigns Key Vault roles to a resource
withKeyVaultRoleAssignments(target: AzureKeyVaultResource, roles: AzureKeyVaultRole[]): IResource function
withLocation builder Sets the Azure location for the shared Azure environment resource
withLocation(location: ParameterResource): AzureEnvironmentResource function
withParameter builder Adds a Bicep parameter without a value
withParameter(name: string): AzureBicepResource function
withParameterFromConnectionString builder Adds a Bicep parameter from a connection string resource builder
withParameterFromConnectionString(name: string, value: IResourceWithConnectionString): AzureBicepResource function
withParameterFromEndpoint builder Adds a Bicep parameter from an endpoint reference
withParameterFromEndpoint(name: string, value: EndpointReference): AzureBicepResource function
withParameterFromOutput builder Adds a Bicep parameter from another Bicep output reference
withParameterFromOutput(name: string, value: BicepOutputReference): AzureBicepResource function
withParameterFromParameter builder Adds a Bicep parameter from a parameter resource builder
withParameterFromParameter(name: string, value: ParameterResource): AzureBicepResource function
withParameterFromReferenceExpression builder Adds a Bicep parameter from a reference expression
withParameterFromReferenceExpression(name: string, value: ReferenceExpression): AzureBicepResource function
withParameterStringValue builder Adds a Bicep parameter with a string value
withParameterStringValue(name: string, value: string): AzureBicepResource function
withParameterStringValues builder Adds a Bicep parameter with a string list value
withParameterStringValues(name: string, value: string[]): AzureBicepResource function
withPassword builder Configures the password for Redis
withPassword(password: ParameterResource): RedisResource function
withPersistence builder Configures Redis persistence
withPersistence(interval?: timespan, keysChangedThreshold?: number): RedisResource function
withRedisCommander builder Adds Redis Commander management UI
withRedisCommander(configureContainer?: (obj: RedisCommanderResource) => void, containerName?: string): RedisResource function
withRedisInsight builder Adds Redis Insight management UI
withRedisInsight(configureContainer?: (obj: RedisInsightResource) => void, containerName?: string): RedisResource function
withResourceGroup builder Sets the Azure resource group for the shared Azure environment resource
withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource