AzureManagedRedisResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Azure.Redis / AzureManagedRedisResource

AzureManagedRedisResource

Docs Reference TypeScript APIs Aspire.Hosting.Azure.Redis AzureManagedRedisResource

Handle TypeScript

📦 Aspire.Hosting.Azure.Redis v13.2.0-preview.1.26159.1

interface AzureManagedRedisResource
  extends IAzureResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithConnectionString,
    IResourceWithParameters,
    IValueProvider,
    IValueWithReferences,
    IAzurePrivateEndpointTarget {
  readonly connectionStringExpression: ReferenceExpression;
  readonly hostName: ReferenceExpression;
  readonly name: string;
  readonly outputs: Dict<string,any>;
  readonly parameters: Dict<string,any>;
  readonly password: ReferenceExpression;
  readonly port: ReferenceExpression;
  readonly secretOutputs: Dict<string,string>;
  readonly uriExpression: ReferenceExpression;
  readonly useAccessKeyAuthentication: boolean;
  runAsContainer(configureContainer?: (obj: RedisResource) => void): AzureManagedRedisResource;
  withAccessKeyAuthentication(): AzureManagedRedisResource;
  withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureManagedRedisResource;
}

Implements

• IAzureResource
• IManifestExpressionProvider
• IResource
• IResourceWithConnectionString
• IResourceWithParameters
• IValueProvider
• IValueWithReferences
• IAzurePrivateEndpointTarget

Search members of AzureManagedRedisResource…

method property

13 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property hostName ReferenceExpression get

Gets the HostName property

property name string get

Gets the Name property

property outputs Dict<string,any> get

Gets the Outputs property

property parameters Dict<string,any> get

Gets the Parameters property

property password ReferenceExpression get

Gets the Password property

property port ReferenceExpression get

Gets the Port property

property secretOutputs Dict<string,string> get

Gets the SecretOutputs property

property uriExpression ReferenceExpression get

Gets the UriExpression property

property useAccessKeyAuthentication boolean get

Gets the UseAccessKeyAuthentication property

Methods

method runAsContainer builder

Configures Azure Managed Redis to run in a local container

runAsContainer(configureContainer?: (obj: RedisResource) => void): AzureManagedRedisResource

Parameters

configureContainer (obj: RedisResource) => void optional

Returns

AzureManagedRedisResource

method withAccessKeyAuthentication builder

Configures Azure Managed Redis to use access key authentication

withAccessKeyAuthentication(): AzureManagedRedisResource

Returns

AzureManagedRedisResource

method withAccessKeyAuthenticationWithKeyVault builder

Configures Azure Managed Redis to use access key authentication with a specific Key Vault

withAccessKeyAuthenticationWithKeyVault(keyVaultBuilder: IAzureKeyVaultResource): AzureManagedRedisResource

Parameters

keyVaultBuilder IAzureKeyVaultResource

Returns

AzureManagedRedisResource