[{"n":"addConnectionString","f":"addConnectionString(name: string, environmentVariableNameOrExpression?: ReferenceExpression): IResourceWithConnectionString","k":"method","p":"Aspire.Hosting","s":"Adds a connection string resource","h":"/reference/api/typescript/aspire.hosting/addconnectionstring/","v":"13.4.0"},{"n":"addContainer","f":"addContainer(name: string, image: AddContainerOptions): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a container resource to the application.","h":"/reference/api/typescript/aspire.hosting/addcontainer/","v":"13.4.0"},{"n":"addContainerFiles","f":"addContainerFiles(resource: IResource, rootDestinationPath: string, logger?: ILogger): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds COPY --from statements for published container files","h":"/reference/api/typescript/aspire.hosting/addcontainerfiles/","v":"13.4.0"},{"n":"addContainerFilesStages","f":"addContainerFilesStages(resource: IResource, logger?: ILogger): DockerfileBuilder","k":"method","p":"Aspire.Hosting","s":"Adds Dockerfile stages for published container files","h":"/reference/api/typescript/aspire.hosting/addcontainerfilesstages/","v":"13.4.0"},{"n":"addContainerRegistry","f":"addContainerRegistry(name: string, endpoint: ParameterResource, repository?: ParameterResource): ContainerRegistryResource","k":"method","p":"Aspire.Hosting","s":"Adds a container registry resource","h":"/reference/api/typescript/aspire.hosting/addcontainerregistry/","v":"13.4.0"},{"n":"addCSharpApp","f":"addCSharpApp(name: string, path: string, options?: ProjectResourceOptions): CSharpAppResource","k":"method","p":"Aspire.Hosting","s":"Adds a C# application resource","h":"/reference/api/typescript/aspire.hosting/addcsharpapp/","v":"13.4.0"},{"n":"addDockerfile","f":"addDockerfile(name: string, contextPath: string, dockerfilePath?: string, stage?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a Dockerfile to the application model that can be treated like a container resource.","h":"/reference/api/typescript/aspire.hosting/adddockerfile/","v":"13.4.0"},{"n":"addDockerfileBuilder","f":"addDockerfileBuilder(name: string, contextPath: string, callback: (arg: DockerfileBuilderCallbackContext) => Promise, stage?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a container resource built from a programmatically generated Dockerfile","h":"/reference/api/typescript/aspire.hosting/adddockerfilebuilder/","v":"13.4.0"},{"n":"addDockerfileFactory","f":"addDockerfileFactory(name: string, contextPath: string, dockerfileFactory: (arg: DockerfileFactoryContext) => Promise, stage?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a Dockerfile to the application model that can be treated like a container resource, with the Dockerfile content generated by an asynchronous factory function.","h":"/reference/api/typescript/aspire.hosting/adddockerfilefactory/","v":"13.4.0"},{"n":"addDotnetTool","f":"addDotnetTool(name: string, packageId: string): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Adds a .NET tool resource to the application model.","h":"/reference/api/typescript/aspire.hosting/adddotnettool/","v":"13.4.0"},{"n":"addEventingSubscriber","f":"addEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise): void","k":"method","p":"Aspire.Hosting","s":"Adds an ATS-friendly eventing subscriber callback to the distributed-application builder.","h":"/reference/api/typescript/aspire.hosting/addeventingsubscriber/","v":"13.4.0"},{"n":"addExecutable","f":"addExecutable(name: string, command: string, workingDirectory: string, args: string[]): ExecutableResource","k":"method","p":"Aspire.Hosting","s":"Adds an executable resource to the application model.","h":"/reference/api/typescript/aspire.hosting/addexecutable/","v":"13.4.0"},{"n":"addExternalService","f":"addExternalService(name: string, url: ParameterResource): ExternalServiceResource","k":"method","p":"Aspire.Hosting","s":"Adds an external service resource","h":"/reference/api/typescript/aspire.hosting/addexternalservice/","v":"13.4.0"},{"n":"addMarkdown","f":"addMarkdown(key: string, markdownString: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a key-value pair to the pipeline summary with a Markdown-formatted value.","h":"/reference/api/typescript/aspire.hosting/addmarkdown/","v":"13.4.0"},{"n":"addParameter","f":"addParameter(name: string, value?: string, publishValueAsDefault?: boolean, secret?: boolean): ParameterResource","k":"method","p":"Aspire.Hosting","s":"Adds a parameter resource","h":"/reference/api/typescript/aspire.hosting/addparameter/","v":"13.4.0"},{"n":"addParameterFromConfiguration","f":"addParameterFromConfiguration(name: string, configurationKey: string, secret?: boolean): ParameterResource","k":"method","p":"Aspire.Hosting","s":"Adds a parameter resource to the application, with a value coming from configuration.","h":"/reference/api/typescript/aspire.hosting/addparameterfromconfiguration/","v":"13.4.0"},{"n":"addParameterWithGeneratedValue","f":"addParameterWithGeneratedValue(name: string, value: GenerateParameterDefault, secret?: boolean, persist?: boolean): ParameterResource","k":"method","p":"Aspire.Hosting","s":"Adds a parameter with a generated default value","h":"/reference/api/typescript/aspire.hosting/addparameterwithgeneratedvalue/","v":"13.4.0"},{"n":"addProject","f":"addProject(name: string, projectPath: string, launchProfileOrOptions?: ProjectResourceOptions): ProjectResource","k":"method","p":"Aspire.Hosting","s":"Adds a .NET project resource","h":"/reference/api/typescript/aspire.hosting/addproject/","v":"13.4.0"},{"n":"addStep","f":"addStep(stepName: string, callback: (arg: PipelineStepContext) => Promise, dependsOn?: string[], requiredBy?: string[]): void","k":"method","p":"Aspire.Hosting","s":"Adds an application-level pipeline step in a TypeScript-friendly shape.","h":"/reference/api/typescript/aspire.hosting/addstep/","v":"13.4.0"},{"n":"arg","f":"arg(name: string, defaultValue?: string): DockerfileBuilder","k":"method","p":"Aspire.Hosting","s":"Adds a global ARG statement to the Dockerfile","h":"/reference/api/typescript/aspire.hosting/arg-aspire-hosting-applicationmodel-docker-dockerfilebuilder-string-string/","v":"13.4.0"},{"n":"arg","f":"arg(name: string, defaultValue?: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds an ARG statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/arg-aspire-hosting-applicationmodel-docker-dockerfilestage-string-string/","v":"13.4.0"},{"n":"asHttp2Service","f":"asHttp2Service(): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Configures a resource to mark all endpoints' transport as HTTP/2. This is useful for HTTP/2 services that need prior knowledge.","h":"/reference/api/typescript/aspire.hosting/ashttp2service/","v":"13.4.0"},{"n":"build","f":"build(executionContext: DistributedApplicationExecutionContext, resourceLogger?: ILogger, cancellationToken?: cancellationToken): IExecutionConfigurationResult","k":"method","p":"Aspire.Hosting","s":"Builds the execution configuration for the specified builder.","h":"/reference/api/typescript/aspire.hosting/build/","v":"13.4.0"},{"n":"clearContainerFilesSources","f":"clearContainerFilesSources(): IResourceWithContainerFiles","k":"method","p":"Aspire.Hosting","s":"Removes any container files source annotation from the resource being built.","h":"/reference/api/typescript/aspire.hosting/clearcontainerfilessources/","v":"13.4.0"},{"n":"cmd","f":"cmd(command: string[]): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a CMD statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/cmd/","v":"13.4.0"},{"n":"comment","f":"comment(comment: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a comment to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/comment/","v":"13.4.0"},{"n":"completeLog","f":"completeLog(resource: IResource): void","k":"method","p":"Aspire.Hosting","s":"Completes the log stream for a resource.","h":"/reference/api/typescript/aspire.hosting/completelog/","v":"13.4.0"},{"n":"completeLogByName","f":"completeLogByName(resourceName: string): void","k":"method","p":"Aspire.Hosting","s":"Completes the log stream by resource name.","h":"/reference/api/typescript/aspire.hosting/completelogbyname/","v":"13.4.0"},{"n":"completeStep","f":"completeStep(completionText: string, completionState?: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Completes the reporting step with plain-text completion text.","h":"/reference/api/typescript/aspire.hosting/completestep/","v":"13.4.0"},{"n":"completeStepMarkdown","f":"completeStepMarkdown(markdownString: string, completionState?: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Completes the reporting step with Markdown-formatted completion text.","h":"/reference/api/typescript/aspire.hosting/completestepmarkdown/","v":"13.4.0"},{"n":"completeTask","f":"completeTask(completionMessage?: string, completionState?: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Completes the reporting task with plain-text completion text.","h":"/reference/api/typescript/aspire.hosting/completetask/","v":"13.4.0"},{"n":"completeTaskMarkdown","f":"completeTaskMarkdown(markdownString: string, completionState?: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Completes the reporting task with Markdown-formatted completion text.","h":"/reference/api/typescript/aspire.hosting/completetaskmarkdown/","v":"13.4.0"},{"n":"configure","f":"configure(callback: (arg: PipelineConfigurationContext) => Promise): void","k":"method","p":"Aspire.Hosting","s":"Registers a pipeline configuration callback in a TypeScript-friendly shape.","h":"/reference/api/typescript/aspire.hosting/configure/","v":"13.4.0"},{"n":"copy","f":"copy(source: string, destination: string, chown?: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a COPY statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/copy/","v":"13.4.0"},{"n":"copyFrom","f":"copyFrom(from: string, source: string, destination: string, chown?: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a COPY --from statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/copyfrom/","v":"13.4.0"},{"n":"createBuilder","f":"createBuilder(): IDistributedApplicationBuilder","k":"method","p":"Aspire.Hosting","s":"Creates a new distributed application builder","h":"/reference/api/typescript/aspire.hosting/createbuilder/","v":"13.4.0"},{"n":"createExecutionConfiguration","f":"createExecutionConfiguration(): IExecutionConfigurationBuilder","k":"method","p":"Aspire.Hosting","s":"Creates an execution configuration builder for the specified resource.","h":"/reference/api/typescript/aspire.hosting/createexecutionconfiguration/","v":"13.4.0"},{"n":"createLogger","f":"createLogger(categoryName: string): ILogger","k":"method","p":"Aspire.Hosting","s":"Creates a logger for the specified category name.","h":"/reference/api/typescript/aspire.hosting/createlogger/","v":"13.4.0"},{"n":"createMarkdownTask","f":"createMarkdownTask(markdownString: string, cancellationToken?: cancellationToken): IReportingTask","k":"method","p":"Aspire.Hosting","s":"Creates a reporting task with Markdown-formatted status text.","h":"/reference/api/typescript/aspire.hosting/createmarkdowntask/","v":"13.4.0"},{"n":"createTask","f":"createTask(statusText: string, cancellationToken?: cancellationToken): IReportingTask","k":"method","p":"Aspire.Hosting","s":"Creates a reporting task with plain-text status text.","h":"/reference/api/typescript/aspire.hosting/createtask/","v":"13.4.0"},{"n":"disableBuildOnlyContainerValidation","f":"disableBuildOnlyContainerValidation(): IDistributedApplicationPipeline","k":"method","p":"Aspire.Hosting","s":"Disables the publish and deploy validation that requires build-only containers to be consumed by another resource.","h":"/reference/api/typescript/aspire.hosting/disablebuildonlycontainervalidation/","v":"13.4.0"},{"n":"disableForwardedHeaders","f":"disableForwardedHeaders(): ProjectResource","k":"method","p":"Aspire.Hosting","s":"Configures the project to disable forwarded headers when being published.","h":"/reference/api/typescript/aspire.hosting/disableforwardedheaders/","v":"13.4.0"},{"n":"emptyLine","f":"emptyLine(): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds an empty line to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/emptyline/","v":"13.4.0"},{"n":"entrypoint","f":"entrypoint(command: string[]): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds an ENTRYPOINT statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/entrypoint/","v":"13.4.0"},{"n":"env","f":"env(name: string, value: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds an ENV statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/env/","v":"13.4.0"},{"n":"excludeFromManifest","f":"excludeFromManifest(): IResource","k":"method","p":"Aspire.Hosting","s":"Excludes a resource from being published to the manifest.","h":"/reference/api/typescript/aspire.hosting/excludefrommanifest/","v":"13.4.0"},{"n":"excludeFromMcp","f":"excludeFromMcp(): IResource","k":"method","p":"Aspire.Hosting","s":"Exclude the resource from MCP operations using the Aspire MCP server. The resource is excluded from results that return resources, console logs and telemetry.","h":"/reference/api/typescript/aspire.hosting/excludefrommcp/","v":"13.4.0"},{"n":"executeCommandAsync","f":"executeCommandAsync(resource: IResource, commandName: string, arguments?: Dict, cancellationToken?: cancellationToken): ExecuteCommandResult","k":"method","p":"Aspire.Hosting","s":"Executes a command for the specified resource.","h":"/reference/api/typescript/aspire.hosting/executecommandasync/","v":"13.4.0"},{"n":"exists","f":"exists(key: string): boolean","k":"method","p":"Aspire.Hosting","s":"Checks whether a configuration section exists.","h":"/reference/api/typescript/aspire.hosting/exists/","v":"13.4.0"},{"n":"expose","f":"expose(port: number): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds an EXPOSE statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/expose/","v":"13.4.0"},{"n":"findResourceByName","f":"findResourceByName(name: string): IResource","k":"method","p":"Aspire.Hosting","s":"Finds a resource by name.","h":"/reference/api/typescript/aspire.hosting/findresourcebyname/","v":"13.4.0"},{"n":"from","f":"from(image: string, stageName?: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a FROM statement to start a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/from/","v":"13.4.0"},{"n":"getAspireStore","f":"getAspireStore(): IAspireStore","k":"method","p":"Aspire.Hosting","s":"Gets the Aspire store from the service provider.","h":"/reference/api/typescript/aspire.hosting/getaspirestore/","v":"13.4.0"},{"n":"getCertificateTrustData","f":"getCertificateTrustData(): CertificateTrustExecutionConfigurationExportData","k":"method","p":"Aspire.Hosting","s":"Gets certificate trust execution-configuration data when present.","h":"/reference/api/typescript/aspire.hosting/getcertificatetrustdata/","v":"13.4.0"},{"n":"getChildren","f":"getChildren(): IConfigurationSection[]","k":"method","p":"Aspire.Hosting","s":"Gets the child sections of a configuration handle.","h":"/reference/api/typescript/aspire.hosting/getchildren/","v":"13.4.0"},{"n":"getConfiguration","f":"getConfiguration(): IConfiguration","k":"method","p":"Aspire.Hosting","s":"Gets the application configuration.","h":"/reference/api/typescript/aspire.hosting/getconfiguration/","v":"13.4.0"},{"n":"getConfigValue","f":"getConfigValue(key: string): string","k":"method","p":"Aspire.Hosting","s":"Gets a configuration value by key.","h":"/reference/api/typescript/aspire.hosting/getconfigvalue/","v":"13.4.0"},{"n":"getConnectionProperty","f":"getConnectionProperty(key: string): ReferenceExpression","k":"method","p":"Aspire.Hosting","s":"Retrieves the value of a specified connection property from the resource's connection properties.","h":"/reference/api/typescript/aspire.hosting/getconnectionproperty/","v":"13.4.0"},{"n":"getConnectionString","f":"getConnectionString(name: string): string","k":"method","p":"Aspire.Hosting","s":"Gets a connection string by name.","h":"/reference/api/typescript/aspire.hosting/getconnectionstring/","v":"13.4.0"},{"n":"getDistributedApplicationModel","f":"getDistributedApplicationModel(): DistributedApplicationModel","k":"method","p":"Aspire.Hosting","s":"Gets the distributed application model from the service provider.","h":"/reference/api/typescript/aspire.hosting/getdistributedapplicationmodel/","v":"13.4.0"},{"n":"getEndpoint","f":"getEndpoint(name: string): EndpointReference","k":"method","p":"Aspire.Hosting","s":"Gets an endpoint reference","h":"/reference/api/typescript/aspire.hosting/getendpoint/","v":"13.4.0"},{"n":"getEventing","f":"getEventing(): IDistributedApplicationEventing","k":"method","p":"Aspire.Hosting","s":"Gets the distributed application eventing service from the service provider.","h":"/reference/api/typescript/aspire.hosting/geteventing/","v":"13.4.0"},{"n":"getFileNameWithContent","f":"getFileNameWithContent(filenameTemplate: string, sourceFilename: string): string","k":"method","p":"Aspire.Hosting","s":"Gets a deterministic file path that is a copy of the `sourceFilename`. The resulting file name will depend on the content of the file.","h":"/reference/api/typescript/aspire.hosting/getfilenamewithcontent/","v":"13.4.0"},{"n":"getHttpsCertificateData","f":"getHttpsCertificateData(): HttpsCertificateExecutionConfigurationExportData","k":"method","p":"Aspire.Hosting","s":"Gets HTTPS certificate execution-configuration data when present.","h":"/reference/api/typescript/aspire.hosting/gethttpscertificatedata/","v":"13.4.0"},{"n":"getLoggerFactory","f":"getLoggerFactory(): ILoggerFactory","k":"method","p":"Aspire.Hosting","s":"Gets the logger factory from the service provider.","h":"/reference/api/typescript/aspire.hosting/getloggerfactory/","v":"13.4.0"},{"n":"getOrSetSecret","f":"getOrSetSecret(resourceBuilder: IResource, name: string, value: string): void","k":"method","p":"Aspire.Hosting","s":"Gets a secret value if it exists in configuration, or sets it to the provided value if it does not.","h":"/reference/api/typescript/aspire.hosting/getorsetsecret/","v":"13.4.0"},{"n":"getResourceCommandService","f":"getResourceCommandService(): ResourceCommandService","k":"method","p":"Aspire.Hosting","s":"Gets the resource command service from the service provider.","h":"/reference/api/typescript/aspire.hosting/getresourcecommandservice/","v":"13.4.0"},{"n":"getResourceLoggerService","f":"getResourceLoggerService(): ResourceLoggerService","k":"method","p":"Aspire.Hosting","s":"Gets the resource logger service from the service provider.","h":"/reference/api/typescript/aspire.hosting/getresourceloggerservice/","v":"13.4.0"},{"n":"getResourceName","f":"getResourceName(): string","k":"method","p":"Aspire.Hosting","s":"Gets the name of the resource from a builder.","h":"/reference/api/typescript/aspire.hosting/getresourcename/","v":"13.4.0"},{"n":"getResourceNotificationService","f":"getResourceNotificationService(): ResourceNotificationService","k":"method","p":"Aspire.Hosting","s":"Gets the resource notification service from the service provider.","h":"/reference/api/typescript/aspire.hosting/getresourcenotificationservice/","v":"13.4.0"},{"n":"getResources","f":"getResources(): IResource[]","k":"method","p":"Aspire.Hosting","s":"Gets all resources in the distributed application model.","h":"/reference/api/typescript/aspire.hosting/getresources/","v":"13.4.0"},{"n":"getSection","f":"getSection(key: string): IConfigurationSection","k":"method","p":"Aspire.Hosting","s":"Gets a configuration section by key.","h":"/reference/api/typescript/aspire.hosting/getsection/","v":"13.4.0"},{"n":"getUserSecretsManager","f":"getUserSecretsManager(): IUserSecretsManager","k":"method","p":"Aspire.Hosting","s":"Gets the user secrets manager from the service provider.","h":"/reference/api/typescript/aspire.hosting/getusersecretsmanager/","v":"13.4.0"},{"n":"isDevelopment","f":"isDevelopment(): boolean","k":"method","p":"Aspire.Hosting","s":"Checks if the environment is Development.","h":"/reference/api/typescript/aspire.hosting/isdevelopment/","v":"13.4.0"},{"n":"isEnvironment","f":"isEnvironment(environmentName: string): boolean","k":"method","p":"Aspire.Hosting","s":"Checks if the environment matches the specified name.","h":"/reference/api/typescript/aspire.hosting/isenvironment/","v":"13.4.0"},{"n":"isProduction","f":"isProduction(): boolean","k":"method","p":"Aspire.Hosting","s":"Checks if the environment is Production.","h":"/reference/api/typescript/aspire.hosting/isproduction/","v":"13.4.0"},{"n":"isStaging","f":"isStaging(): boolean","k":"method","p":"Aspire.Hosting","s":"Checks if the environment is Staging.","h":"/reference/api/typescript/aspire.hosting/isstaging/","v":"13.4.0"},{"n":"log","f":"log(level: string, message: string): void","k":"method","p":"Aspire.Hosting","s":"Logs a message with a specified log level.","h":"/reference/api/typescript/aspire.hosting/log/","v":"13.4.0"},{"n":"logDebug","f":"logDebug(message: string): void","k":"method","p":"Aspire.Hosting","s":"Logs a debug message.","h":"/reference/api/typescript/aspire.hosting/logdebug/","v":"13.4.0"},{"n":"logError","f":"logError(message: string): void","k":"method","p":"Aspire.Hosting","s":"Logs an error message.","h":"/reference/api/typescript/aspire.hosting/logerror/","v":"13.4.0"},{"n":"logInformation","f":"logInformation(message: string): void","k":"method","p":"Aspire.Hosting","s":"Logs an information message.","h":"/reference/api/typescript/aspire.hosting/loginformation/","v":"13.4.0"},{"n":"logStep","f":"logStep(level: string, message: string): void","k":"method","p":"Aspire.Hosting","s":"Logs a plain-text message for the reporting step.","h":"/reference/api/typescript/aspire.hosting/logstep/","v":"13.4.0"},{"n":"logStepMarkdown","f":"logStepMarkdown(level: string, markdownString: string): void","k":"method","p":"Aspire.Hosting","s":"Logs a Markdown-formatted message for the reporting step.","h":"/reference/api/typescript/aspire.hosting/logstepmarkdown/","v":"13.4.0"},{"n":"logWarning","f":"logWarning(message: string): void","k":"method","p":"Aspire.Hosting","s":"Logs a warning message.","h":"/reference/api/typescript/aspire.hosting/logwarning/","v":"13.4.0"},{"n":"onAfterPublish","f":"onAfterPublish(callback: (arg: AfterPublishEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the AfterPublish event from an eventing subscriber registration context.","h":"/reference/api/typescript/aspire.hosting/onafterpublish/","v":"13.4.0"},{"n":"onAfterResourcesCreated","f":"onAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the AfterResourcesCreated event from an eventing subscriber registration context.","h":"/reference/api/typescript/aspire.hosting/onafterresourcescreated/","v":"13.4.0"},{"n":"onBeforePublish","f":"onBeforePublish(callback: (arg: BeforePublishEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the BeforePublish event from an eventing subscriber registration context.","h":"/reference/api/typescript/aspire.hosting/onbeforepublish/","v":"13.4.0"},{"n":"onBeforeResourceStarted","f":"onBeforeResourceStarted(callback: (arg: BeforeResourceStartedEvent) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Subscribes to the BeforeResourceStarted event.","h":"/reference/api/typescript/aspire.hosting/onbeforeresourcestarted/","v":"13.4.0"},{"n":"onBeforeStart","f":"onBeforeStart(callback: (arg: BeforeStartEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the BeforeStart event from an eventing subscriber registration context.","h":"/reference/api/typescript/aspire.hosting/onbeforestart/","v":"13.4.0"},{"n":"onConnectionStringAvailable","f":"onConnectionStringAvailable(callback: (arg: ConnectionStringAvailableEvent) => Promise): IResourceWithConnectionString","k":"method","p":"Aspire.Hosting","s":"Subscribes to the ConnectionStringAvailable event.","h":"/reference/api/typescript/aspire.hosting/onconnectionstringavailable/","v":"13.4.0"},{"n":"onInitializeResource","f":"onInitializeResource(callback: (arg: InitializeResourceEvent) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Subscribes to the InitializeResource event.","h":"/reference/api/typescript/aspire.hosting/oninitializeresource/","v":"13.4.0"},{"n":"onResourceEndpointsAllocated","f":"onResourceEndpointsAllocated(callback: (arg: ResourceEndpointsAllocatedEvent) => Promise): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Subscribes to the ResourceEndpointsAllocated event.","h":"/reference/api/typescript/aspire.hosting/onresourceendpointsallocated/","v":"13.4.0"},{"n":"onResourceReady","f":"onResourceReady(callback: (arg: ResourceReadyEvent) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Subscribes to the ResourceReady event.","h":"/reference/api/typescript/aspire.hosting/onresourceready/","v":"13.4.0"},{"n":"onResourceStopped","f":"onResourceStopped(callback: (arg: ResourceStoppedEvent) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Subscribes to the ResourceStopped event.","h":"/reference/api/typescript/aspire.hosting/onresourcestopped/","v":"13.4.0"},{"n":"publishAsConnectionString","f":"publishAsConnectionString(): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Changes the resource to be published as a connection string reference in the manifest.","h":"/reference/api/typescript/aspire.hosting/publishasconnectionstring/","v":"13.4.0"},{"n":"publishAsContainer","f":"publishAsContainer(): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Changes the resource to be published as a container in the manifest.","h":"/reference/api/typescript/aspire.hosting/publishascontainer/","v":"13.4.0"},{"n":"publishAsDockerFile","f":"publishAsDockerFile(configure: (obj: ContainerResource) => Promise): ExecutableResource","k":"method","p":"Aspire.Hosting","s":"Publishes an executable as a Docker file","h":"/reference/api/typescript/aspire.hosting/publishasdockerfile-aspire-hosting-applicationmodel-executableresource-obj-containerresource-promise-void/","v":"13.4.0"},{"n":"publishAsDockerFile","f":"publishAsDockerFile(configure?: (obj: ContainerResource) => Promise): ProjectResource","k":"method","p":"Aspire.Hosting","s":"Publishes a project as a Docker file with optional container configuration","h":"/reference/api/typescript/aspire.hosting/publishasdockerfile-aspire-hosting-applicationmodel-projectresource-obj-containerresource-promise-void/","v":"13.4.0"},{"n":"publishResourceUpdate","f":"publishResourceUpdate(resource: IResource, state?: string, stateStyle?: string): void","k":"method","p":"Aspire.Hosting","s":"Publishes an update for a resource's state.","h":"/reference/api/typescript/aspire.hosting/publishresourceupdate/","v":"13.4.0"},{"n":"publishWithContainerFiles","f":"publishWithContainerFiles(source: IResourceWithContainerFiles, destinationPath: string): IContainerFilesDestinationResource","k":"method","p":"Aspire.Hosting","s":"Configures the resource to copy container files from the specified source resource during publishing.","h":"/reference/api/typescript/aspire.hosting/publishwithcontainerfiles/","v":"13.4.0"},{"n":"run","f":"run(command: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a RUN statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/run/","v":"13.4.0"},{"n":"runWithMounts","f":"runWithMounts(command: string, mounts: string[]): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a RUN statement with mounts to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/runwithmounts/","v":"13.4.0"},{"n":"saveStateJson","f":"saveStateJson(json: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Saves state to user secrets from a JSON string.","h":"/reference/api/typescript/aspire.hosting/savestatejson/","v":"13.4.0"},{"n":"subscribeAfterPublish","f":"subscribeAfterPublish(callback: (arg: AfterPublishEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the AfterPublish event, which fires after the application is published.","h":"/reference/api/typescript/aspire.hosting/subscribeafterpublish/","v":"13.4.0"},{"n":"subscribeAfterResourcesCreated","f":"subscribeAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the AfterResourcesCreated event, which fires after all resources are created.","h":"/reference/api/typescript/aspire.hosting/subscribeafterresourcescreated/","v":"13.4.0"},{"n":"subscribeBeforePublish","f":"subscribeBeforePublish(callback: (arg: BeforePublishEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the BeforePublish event, which fires before the application is published.","h":"/reference/api/typescript/aspire.hosting/subscribebeforepublish/","v":"13.4.0"},{"n":"subscribeBeforeStart","f":"subscribeBeforeStart(callback: (arg: BeforeStartEvent) => Promise): DistributedApplicationEventSubscription","k":"method","p":"Aspire.Hosting","s":"Subscribes to the BeforeStart event, which fires before the application starts.","h":"/reference/api/typescript/aspire.hosting/subscribebeforestart/","v":"13.4.0"},{"n":"tryAddEventingSubscriber","f":"tryAddEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise): void","k":"method","p":"Aspire.Hosting","s":"Attempts to add an ATS-friendly eventing subscriber callback to the distributed-application builder.","h":"/reference/api/typescript/aspire.hosting/tryaddeventingsubscriber/","v":"13.4.0"},{"n":"tryGetResourceState","f":"tryGetResourceState(resourceName: string): ResourceEventDto","k":"method","p":"Aspire.Hosting","s":"Tries to get the current state of a resource.","h":"/reference/api/typescript/aspire.hosting/trygetresourcestate/","v":"13.4.0"},{"n":"updateTask","f":"updateTask(statusText: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Updates the reporting task with plain-text status text.","h":"/reference/api/typescript/aspire.hosting/updatetask/","v":"13.4.0"},{"n":"updateTaskMarkdown","f":"updateTaskMarkdown(markdownString: string, cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Updates the reporting task with Markdown-formatted status text.","h":"/reference/api/typescript/aspire.hosting/updatetaskmarkdown/","v":"13.4.0"},{"n":"user","f":"user(user: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a USER statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/user/","v":"13.4.0"},{"n":"waitFor","f":"waitFor(dependency: IResource, waitBehavior?: WaitBehavior): IResourceWithWaitSupport","k":"method","p":"Aspire.Hosting","s":"Waits for another resource to be ready","h":"/reference/api/typescript/aspire.hosting/waitfor/","v":"13.4.0"},{"n":"waitForCompletion","f":"waitForCompletion(dependency: IResource, exitCode?: number): IResourceWithWaitSupport","k":"method","p":"Aspire.Hosting","s":"Waits for the dependency resource to enter the Exited or Finished state before starting the resource.","h":"/reference/api/typescript/aspire.hosting/waitforcompletion/","v":"13.4.0"},{"n":"waitForDependencies","f":"waitForDependencies(resource: IResource): void","k":"method","p":"Aspire.Hosting","s":"Waits for all dependencies of a resource to be ready.","h":"/reference/api/typescript/aspire.hosting/waitfordependencies/","v":"13.4.0"},{"n":"waitForResourceHealthy","f":"waitForResourceHealthy(resourceName: string): ResourceEventDto","k":"method","p":"Aspire.Hosting","s":"Waits for a resource to become healthy.","h":"/reference/api/typescript/aspire.hosting/waitforresourcehealthy/","v":"13.4.0"},{"n":"waitForResourceState","f":"waitForResourceState(resourceName: string, targetState?: string): void","k":"method","p":"Aspire.Hosting","s":"Waits for a resource to reach a specified state.","h":"/reference/api/typescript/aspire.hosting/waitforresourcestate/","v":"13.4.0"},{"n":"waitForResourceStates","f":"waitForResourceStates(resourceName: string, targetStates: string[]): string","k":"method","p":"Aspire.Hosting","s":"Waits for a resource to reach one of the specified states.","h":"/reference/api/typescript/aspire.hosting/waitforresourcestates/","v":"13.4.0"},{"n":"waitForStart","f":"waitForStart(dependency: IResource, waitBehavior?: WaitBehavior): IResourceWithWaitSupport","k":"method","p":"Aspire.Hosting","s":"Waits for another resource to start","h":"/reference/api/typescript/aspire.hosting/waitforstart/","v":"13.4.0"},{"n":"withArgs","f":"withArgs(args: string[]): IResourceWithArgs","k":"method","p":"Aspire.Hosting","s":"Adds arguments to be passed to a resource that supports arguments when it is launched.","h":"/reference/api/typescript/aspire.hosting/withargs/","v":"13.4.0"},{"n":"withArgsCallback","f":"withArgsCallback(callback: (obj: CommandLineArgsCallbackContext) => Promise): IResourceWithArgs","k":"method","p":"Aspire.Hosting","s":"Adds a callback to be executed with a list of command-line arguments when a resource is started.","h":"/reference/api/typescript/aspire.hosting/withargscallback/","v":"13.4.0"},{"n":"withArgumentsConfig","f":"withArgumentsConfig(): IExecutionConfigurationBuilder","k":"method","p":"Aspire.Hosting","s":"Adds a command line arguments configuration gatherer to the builder.","h":"/reference/api/typescript/aspire.hosting/withargumentsconfig/","v":"13.4.0"},{"n":"withBindMount","f":"withBindMount(source: string, target: string, isReadOnly?: boolean): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a bind mount to a container resource.","h":"/reference/api/typescript/aspire.hosting/withbindmount/","v":"13.4.0"},{"n":"withBuildArg","f":"withBuildArg(name: string, value: ParameterResource): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a build argument when the container is built from a Dockerfile.","h":"/reference/api/typescript/aspire.hosting/withbuildarg/","v":"13.4.0"},{"n":"withBuildSecret","f":"withBuildSecret(name: string, value: ParameterResource): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a secret build argument when the container is built from a Dockerfile.","h":"/reference/api/typescript/aspire.hosting/withbuildsecret/","v":"13.4.0"},{"n":"withCertificateTrustConfig","f":"withCertificateTrustConfig(configContextFactory: (arg: CertificateTrustScope) => Promise): IExecutionConfigurationBuilder","k":"method","p":"Aspire.Hosting","s":"Adds a certificate trust configuration gatherer to the builder.","h":"/reference/api/typescript/aspire.hosting/withcertificatetrustconfig/","v":"13.4.0"},{"n":"withCertificateTrustScope","f":"withCertificateTrustScope(scope: CertificateTrustScope): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Sets the certificate trust scope","h":"/reference/api/typescript/aspire.hosting/withcertificatetrustscope/","v":"13.4.0"},{"n":"withChildRelationship","f":"withChildRelationship(child: IResource): IResource","k":"method","p":"Aspire.Hosting","s":"Sets a child relationship","h":"/reference/api/typescript/aspire.hosting/withchildrelationship/","v":"13.4.0"},{"n":"withCommand","f":"withCommand(name: string, displayName: string, executeCommand: (arg: ExecuteCommandContext) => Promise, commandOptions?: CommandOptions): IResource","k":"method","p":"Aspire.Hosting","s":"Adds a resource command","h":"/reference/api/typescript/aspire.hosting/withcommand/","v":"13.4.0"},{"n":"withComputeEnvironment","f":"withComputeEnvironment(computeEnvironmentResource: IComputeEnvironmentResource): IComputeResource","k":"method","p":"Aspire.Hosting","s":"Configures the compute environment for the compute resource.","h":"/reference/api/typescript/aspire.hosting/withcomputeenvironment/","v":"13.4.0"},{"n":"withConnectionProperty","f":"withConnectionProperty(name: string, value: ReferenceExpression): IResourceWithConnectionString","k":"method","p":"Aspire.Hosting","s":"Adds a connection property annotation to the resource being built.","h":"/reference/api/typescript/aspire.hosting/withconnectionproperty/","v":"13.4.0"},{"n":"withContainerCertificatePaths","f":"withContainerCertificatePaths(customCertificatesDestination?: string, defaultCertificateBundlePaths?: string[], defaultCertificateDirectoryPaths?: string[]): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds container certificate path overrides used for certificate trust at run time.","h":"/reference/api/typescript/aspire.hosting/withcontainercertificatepaths/","v":"13.4.0"},{"n":"withContainerFilesSource","f":"withContainerFilesSource(sourcePath: string): IResourceWithContainerFiles","k":"method","p":"Aspire.Hosting","s":"Adds a container files source annotation to the resource being built, specifying the path to the container files source.","h":"/reference/api/typescript/aspire.hosting/withcontainerfilessource/","v":"13.4.0"},{"n":"withContainerName","f":"withContainerName(name: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Overrides the default container name for this resource. By default Aspire generates a unique container name based on the resource name and a random postfix (or a postfix based on a hash of the AppHost project path for persistent container resources). This method allows you to override that behavior with a custom name, but could lead to naming conflicts if the specified name is not unique.","h":"/reference/api/typescript/aspire.hosting/withcontainername/","v":"13.4.0"},{"n":"withContainerNetworkAlias","f":"withContainerNetworkAlias(alias: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a network alias to container resource.","h":"/reference/api/typescript/aspire.hosting/withcontainernetworkalias/","v":"13.4.0"},{"n":"withContainerRegistry","f":"withContainerRegistry(registry: IResource): IResource","k":"method","p":"Aspire.Hosting","s":"Configures the resource to use the specified container registry for container image operations.","h":"/reference/api/typescript/aspire.hosting/withcontainerregistry/","v":"13.4.0"},{"n":"withContainerRuntimeArgs","f":"withContainerRuntimeArgs(args: string[]): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a callback to be executed with a list of arguments to add to the container runtime run command when a container resource is started.","h":"/reference/api/typescript/aspire.hosting/withcontainerruntimeargs/","v":"13.4.0"},{"n":"withCustomInput","f":"withCustomInput(options: ParameterCustomInputOptions): ParameterResource","k":"method","p":"Aspire.Hosting","s":"Sets a custom input for the parameter resource from a polyglot app host.","h":"/reference/api/typescript/aspire.hosting/withcustominput/","v":"13.4.0"},{"n":"withDescription","f":"withDescription(description: string, enableMarkdown?: boolean): ParameterResource","k":"method","p":"Aspire.Hosting","s":"Sets the description of the parameter resource.","h":"/reference/api/typescript/aspire.hosting/withdescription/","v":"13.4.0"},{"n":"withDeveloperCertificateTrust","f":"withDeveloperCertificateTrust(trust: boolean): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Indicates whether developer certificates should be treated as trusted certificate authorities for the resource at run time. Currently this indicates trust for the ASP.NET Core developer certificate. The developer certificate will only be trusted when running in local development scenarios; in publish mode resources will use their default certificate trust.","h":"/reference/api/typescript/aspire.hosting/withdevelopercertificatetrust/","v":"13.4.0"},{"n":"withDockerfile","f":"withDockerfile(contextPath: string, dockerfilePath?: string, stage?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Causes Aspire to build the specified container image from a Dockerfile.","h":"/reference/api/typescript/aspire.hosting/withdockerfile/","v":"13.4.0"},{"n":"withDockerfileBaseImage","f":"withDockerfileBaseImage(buildImage?: string, runtimeImage?: string): IResource","k":"method","p":"Aspire.Hosting","s":"Configures custom base images for generated Dockerfiles.","h":"/reference/api/typescript/aspire.hosting/withdockerfilebaseimage/","v":"13.4.0"},{"n":"withDockerfileBuilder","f":"withDockerfileBuilder(contextPath: string, callback: (arg: DockerfileBuilderCallbackContext) => Promise, stage?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Configures the resource to use a programmatically generated Dockerfile","h":"/reference/api/typescript/aspire.hosting/withdockerfilebuilder/","v":"13.4.0"},{"n":"withDockerfileFactory","f":"withDockerfileFactory(contextPath: string, dockerfileFactory: (arg: DockerfileFactoryContext) => Promise, stage?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Builds the specified container image from a Dockerfile generated by an asynchronous factory function.","h":"/reference/api/typescript/aspire.hosting/withdockerfilefactory/","v":"13.4.0"},{"n":"withEndpoint","f":"withEndpoint(port?: number, targetPort?: number, scheme?: string, name?: string, env?: string, isProxied?: boolean, isExternal?: boolean, protocol?: ProtocolType): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Adds a network endpoint","h":"/reference/api/typescript/aspire.hosting/withendpoint/","v":"13.4.0"},{"n":"withEndpointCallback","f":"withEndpointCallback(endpointName: string, callback: (obj: EndpointUpdateContext) => Promise, createIfNotExists?: boolean): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Updates a named endpoint via callback","h":"/reference/api/typescript/aspire.hosting/withendpointcallback/","v":"13.4.0"},{"n":"withEndpointProxySupport","f":"withEndpointProxySupport(proxyEnabled: boolean): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Set whether a resource can use proxied endpoints or whether they should be disabled for all endpoints belonging to the resource. If set to `false`, endpoints belonging to the resource will ignore the configured proxy settings and run proxy-less.","h":"/reference/api/typescript/aspire.hosting/withendpointproxysupport/","v":"13.4.0"},{"n":"withEntrypoint","f":"withEntrypoint(entrypoint: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Sets the Entrypoint for the container.","h":"/reference/api/typescript/aspire.hosting/withentrypoint/","v":"13.4.0"},{"n":"withEnvironment","f":"withEnvironment(name: string, value: IExpressionValue): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Sets an environment variable","h":"/reference/api/typescript/aspire.hosting/withenvironment/","v":"13.4.0"},{"n":"withEnvironmentCallback","f":"withEnvironmentCallback(callback: (arg: EnvironmentCallbackContext) => Promise): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Allows for the population of environment variables on a resource.","h":"/reference/api/typescript/aspire.hosting/withenvironmentcallback/","v":"13.4.0"},{"n":"withEnvironmentVariablesConfig","f":"withEnvironmentVariablesConfig(): IExecutionConfigurationBuilder","k":"method","p":"Aspire.Hosting","s":"Adds an environment variables configuration gatherer to the builder.","h":"/reference/api/typescript/aspire.hosting/withenvironmentvariablesconfig/","v":"13.4.0"},{"n":"withExecutableCommand","f":"withExecutableCommand(command: string): ExecutableResource","k":"method","p":"Aspire.Hosting","s":"Sets the command for the executable resource.","h":"/reference/api/typescript/aspire.hosting/withexecutablecommand/","v":"13.4.0"},{"n":"withExplicitStart","f":"withExplicitStart(): IResource","k":"method","p":"Aspire.Hosting","s":"Prevents resource from starting automatically","h":"/reference/api/typescript/aspire.hosting/withexplicitstart/","v":"13.4.0"},{"n":"withExternalHttpEndpoints","f":"withExternalHttpEndpoints(): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Marks existing http or https endpoints on a resource as external.","h":"/reference/api/typescript/aspire.hosting/withexternalhttpendpoints/","v":"13.4.0"},{"n":"withHealthCheck","f":"withHealthCheck(key: string): IResource","k":"method","p":"Aspire.Hosting","s":"Adds a health check by key","h":"/reference/api/typescript/aspire.hosting/withhealthcheck/","v":"13.4.0"},{"n":"withHidden","f":"withHidden(): IResource","k":"method","p":"Aspire.Hosting","s":"Hides the resource from default resource lists","h":"/reference/api/typescript/aspire.hosting/withhidden/","v":"13.4.0"},{"n":"withHiddenOnCompletion","f":"withHiddenOnCompletion(exitCode?: number, exitCodes?: number[]): IResource","k":"method","p":"Aspire.Hosting","s":"Hides the resource from default resource lists after successful completion","h":"/reference/api/typescript/aspire.hosting/withhiddenoncompletion/","v":"13.4.0"},{"n":"withHttpCommand","f":"withHttpCommand(path: string, displayName: string, options?: HttpCommandExportOptions): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Adds an HTTP resource command","h":"/reference/api/typescript/aspire.hosting/withhttpcommand/","v":"13.4.0"},{"n":"withHttpEndpoint","f":"withHttpEndpoint(port?: number, targetPort?: number, name?: string, env?: string, isProxied?: boolean): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Adds an HTTP endpoint","h":"/reference/api/typescript/aspire.hosting/withhttpendpoint/","v":"13.4.0"},{"n":"withHttpEndpointCallback","f":"withHttpEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Updates an HTTP endpoint via callback","h":"/reference/api/typescript/aspire.hosting/withhttpendpointcallback/","v":"13.4.0"},{"n":"withHttpHealthCheck","f":"withHttpHealthCheck(path?: string, statusCode?: number, endpointName?: string): ExternalServiceResource","k":"method","p":"Aspire.Hosting","s":"Adds an HTTP health check to the external service for polyglot app hosts.","h":"/reference/api/typescript/aspire.hosting/withhttphealthcheck-aspire-hosting-externalserviceresource-string-number-string/","v":"13.4.0"},{"n":"withHttpHealthCheck","f":"withHttpHealthCheck(path?: string, statusCode?: number, endpointName?: string): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Adds a health check to the resource which is mapped to a specific endpoint.","h":"/reference/api/typescript/aspire.hosting/withhttphealthcheck-aspire-hosting-applicationmodel-containerresource-string-number-string/","v":"13.4.0"},{"n":"withHttpProbe","f":"withHttpProbe(probeType: ProbeType, path?: string, initialDelaySeconds?: number, periodSeconds?: number, timeoutSeconds?: number, failureThreshold?: number, successThreshold?: number, endpointName?: string): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Adds an HTTP health probe to the resource","h":"/reference/api/typescript/aspire.hosting/withhttpprobe/","v":"13.4.0"},{"n":"withHttpsCertificateConfig","f":"withHttpsCertificateConfig(configContextFactory: (arg: HttpsCertificateInfo) => Promise): IExecutionConfigurationBuilder","k":"method","p":"Aspire.Hosting","s":"Adds an HTTPS certificate configuration gatherer using certificate metadata instead of a raw X509 certificate.","h":"/reference/api/typescript/aspire.hosting/withhttpscertificateconfig/","v":"13.4.0"},{"n":"withHttpsDeveloperCertificate","f":"withHttpsDeveloperCertificate(password?: ParameterResource): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Indicates that a resource should use the developer certificate key pair for HTTPS endpoints at run time. Currently this indicates use of the ASP.NET Core developer certificate. The developer certificate will only be used when running in local development scenarios; in publish mode resources will use their default certificate configuration.","h":"/reference/api/typescript/aspire.hosting/withhttpsdevelopercertificate/","v":"13.4.0"},{"n":"withHttpsEndpoint","f":"withHttpsEndpoint(port?: number, targetPort?: number, name?: string, env?: string, isProxied?: boolean): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Adds an HTTPS endpoint","h":"/reference/api/typescript/aspire.hosting/withhttpsendpoint/","v":"13.4.0"},{"n":"withHttpsEndpointCallback","f":"withHttpsEndpointCallback(callback: (obj: EndpointUpdateContext) => Promise, name?: string, createIfNotExists?: boolean): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Updates an HTTPS endpoint via callback","h":"/reference/api/typescript/aspire.hosting/withhttpsendpointcallback/","v":"13.4.0"},{"n":"withIconName","f":"withIconName(iconName: string, iconVariant?: IconVariant): IResource","k":"method","p":"Aspire.Hosting","s":"Specifies the icon to use when displaying the resource in the dashboard.","h":"/reference/api/typescript/aspire.hosting/withiconname/","v":"13.4.0"},{"n":"withImage","f":"withImage(image: string, tag?: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Allows overriding the image on a container.","h":"/reference/api/typescript/aspire.hosting/withimage/","v":"13.4.0"},{"n":"withImagePullPolicy","f":"withImagePullPolicy(pullPolicy: ImagePullPolicy): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Sets the pull policy for the container resource.","h":"/reference/api/typescript/aspire.hosting/withimagepullpolicy/","v":"13.4.0"},{"n":"withImagePushOptions","f":"withImagePushOptions(callback: (arg: ContainerImagePushOptionsCallbackContext) => Promise): IComputeResource","k":"method","p":"Aspire.Hosting","s":"Adds an asynchronous callback to configure container image push options for the resource.","h":"/reference/api/typescript/aspire.hosting/withimagepushoptions/","v":"13.4.0"},{"n":"withImageRegistry","f":"withImageRegistry(registry: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Allows overriding the image registry on a container.","h":"/reference/api/typescript/aspire.hosting/withimageregistry/","v":"13.4.0"},{"n":"withImageSHA256","f":"withImageSHA256(sha256: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Allows setting the image to a specific sha256 on a container.","h":"/reference/api/typescript/aspire.hosting/withimagesha256/","v":"13.4.0"},{"n":"withImageTag","f":"withImageTag(tag: string): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Allows overriding the image tag on a container.","h":"/reference/api/typescript/aspire.hosting/withimagetag/","v":"13.4.0"},{"n":"withLifetime","f":"withLifetime(lifetime: ContainerLifetime): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Sets the lifetime behavior of the container resource.","h":"/reference/api/typescript/aspire.hosting/withlifetime/","v":"13.4.0"},{"n":"withLifetimeOf","f":"withLifetimeOf(sourceBuilder: IResource): IResource","k":"method","p":"Aspire.Hosting","s":"Configures a resource to match the lifetime of another resource.","h":"/reference/api/typescript/aspire.hosting/withlifetimeof/","v":"13.4.0"},{"n":"withMcpServer","f":"withMcpServer(path?: string, endpointName?: string): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting","s":"Marks the resource as hosting a Model Context Protocol (MCP) server on the specified endpoint.","h":"/reference/api/typescript/aspire.hosting/withmcpserver/","v":"13.4.0"},{"n":"withOtlpExporter","f":"withOtlpExporter(protocol?: OtlpProtocol): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Configures OTLP telemetry export","h":"/reference/api/typescript/aspire.hosting/withotlpexporter/","v":"13.4.0"},{"n":"withoutHttpsCertificate","f":"withoutHttpsCertificate(): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Disable HTTPS/TLS server certificate configuration for the resource. No HTTPS/TLS termination configuration will be applied.","h":"/reference/api/typescript/aspire.hosting/withouthttpscertificate/","v":"13.4.0"},{"n":"withParentProcessLifetime","f":"withParentProcessLifetime(parentProcessId: number): IResource","k":"method","p":"Aspire.Hosting","s":"Configures a resource to use a persistent lifetime that ends when a parent process exits.","h":"/reference/api/typescript/aspire.hosting/withparentprocesslifetime/","v":"13.4.0"},{"n":"withParentRelationship","f":"withParentRelationship(parent: IResource): IResource","k":"method","p":"Aspire.Hosting","s":"Sets the parent relationship","h":"/reference/api/typescript/aspire.hosting/withparentrelationship/","v":"13.4.0"},{"n":"withPersistentLifetime","f":"withPersistentLifetime(): IResource","k":"method","p":"Aspire.Hosting","s":"Configures a resource to use a persistent lifetime.","h":"/reference/api/typescript/aspire.hosting/withpersistentlifetime/","v":"13.4.0"},{"n":"withPipelineConfiguration","f":"withPipelineConfiguration(callback: (obj: PipelineConfigurationContext) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.","h":"/reference/api/typescript/aspire.hosting/withpipelineconfiguration/","v":"13.4.0"},{"n":"withPipelineStepFactory","f":"withPipelineStepFactory(stepName: string, callback: (arg: PipelineStepContext) => Promise, dependsOn?: string[], requiredBy?: string[], tags?: string[], description?: string): IResource","k":"method","p":"Aspire.Hosting","s":"Adds a pipeline step to the resource that will be executed during deployment.","h":"/reference/api/typescript/aspire.hosting/withpipelinestepfactory/","v":"13.4.0"},{"n":"withProcessCommand","f":"withProcessCommand(commandName: string, displayName: string, options: ProcessCommandExportOptions): IResource","k":"method","p":"Aspire.Hosting","s":"Adds a command to the resource that starts a local process when invoked.","h":"/reference/api/typescript/aspire.hosting/withprocesscommand/","v":"13.4.0"},{"n":"withProcessCommandFactory","f":"withProcessCommandFactory(commandName: string, displayName: string, createProcessSpec: (arg: ExecuteCommandContext) => Promise, options?: ProcessCommandResultExportOptions): IResource","k":"method","p":"Aspire.Hosting","s":"Adds a command to the resource that starts a local process created by a callback when invoked.","h":"/reference/api/typescript/aspire.hosting/withprocesscommandfactory/","v":"13.4.0"},{"n":"withReference","f":"withReference(source: EndpointReference|string|uri, connectionName?: string, optional?: boolean, name?: string): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Adds a reference to another resource","h":"/reference/api/typescript/aspire.hosting/withreference/","v":"13.4.0"},{"n":"withReferenceEnvironment","f":"withReferenceEnvironment(options: ReferenceEnvironmentInjectionOptions): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting","s":"Configures how information is injected into environment variables when the resource references other resources.","h":"/reference/api/typescript/aspire.hosting/withreferenceenvironment/","v":"13.4.0"},{"n":"withRelationship","f":"withRelationship(resourceBuilder: IResource, type: string): IResource","k":"method","p":"Aspire.Hosting","s":"Adds a relationship to another resource using its builder.","h":"/reference/api/typescript/aspire.hosting/withrelationship/","v":"13.4.0"},{"n":"withRemoteImageName","f":"withRemoteImageName(remoteImageName: string): IComputeResource","k":"method","p":"Aspire.Hosting","s":"Sets the remote image name (without registry endpoint or tag) for container push operations.","h":"/reference/api/typescript/aspire.hosting/withremoteimagename/","v":"13.4.0"},{"n":"withRemoteImageTag","f":"withRemoteImageTag(remoteImageTag: string): IComputeResource","k":"method","p":"Aspire.Hosting","s":"Sets the remote image tag for container push operations.","h":"/reference/api/typescript/aspire.hosting/withremoteimagetag/","v":"13.4.0"},{"n":"withReplicas","f":"withReplicas(replicas: number): ProjectResource","k":"method","p":"Aspire.Hosting","s":"Configures how many replicas of the project should be created for the project.","h":"/reference/api/typescript/aspire.hosting/withreplicas/","v":"13.4.0"},{"n":"withRequiredCommand","f":"withRequiredCommand(command: string, helpLink?: string): IResource","k":"method","p":"Aspire.Hosting","s":"Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.","h":"/reference/api/typescript/aspire.hosting/withrequiredcommand/","v":"13.4.0"},{"n":"withSessionLifetime","f":"withSessionLifetime(): IResource","k":"method","p":"Aspire.Hosting","s":"Configures a resource to use a session lifetime.","h":"/reference/api/typescript/aspire.hosting/withsessionlifetime/","v":"13.4.0"},{"n":"withToolIgnoreExistingFeeds","f":"withToolIgnoreExistingFeeds(): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Configures the tool to use only the specified package sources, ignoring existing NuGet configuration.","h":"/reference/api/typescript/aspire.hosting/withtoolignoreexistingfeeds/","v":"13.4.0"},{"n":"withToolIgnoreFailedSources","f":"withToolIgnoreFailedSources(): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Configures the resource to treat package source failures as warnings.","h":"/reference/api/typescript/aspire.hosting/withtoolignorefailedsources/","v":"13.4.0"},{"n":"withToolPackage","f":"withToolPackage(packageId: string): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Sets the package identifier for the tool configuration associated with the resource builder.","h":"/reference/api/typescript/aspire.hosting/withtoolpackage/","v":"13.4.0"},{"n":"withToolPrerelease","f":"withToolPrerelease(): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Allows prerelease versions of the tool to be used","h":"/reference/api/typescript/aspire.hosting/withtoolprerelease/","v":"13.4.0"},{"n":"withToolSource","f":"withToolSource(source: string): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Adds a NuGet package source for tool acquisition.","h":"/reference/api/typescript/aspire.hosting/withtoolsource/","v":"13.4.0"},{"n":"withToolVersion","f":"withToolVersion(version: string): DotnetToolResource","k":"method","p":"Aspire.Hosting","s":"Sets the package version for a tool to use.","h":"/reference/api/typescript/aspire.hosting/withtoolversion/","v":"13.4.0"},{"n":"withUrl","f":"withUrl(url: ReferenceExpression, displayText?: string): IResource","k":"method","p":"Aspire.Hosting","s":"Adds or modifies displayed URLs","h":"/reference/api/typescript/aspire.hosting/withurl/","v":"13.4.0"},{"n":"withUrlForEndpoint","f":"withUrlForEndpoint(endpointName: string, callback: (obj: ResourceUrlAnnotation) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Registers a callback to update the URL displayed for the endpoint with the specified name.","h":"/reference/api/typescript/aspire.hosting/withurlforendpoint/","v":"13.4.0"},{"n":"withUrls","f":"withUrls(callback: (obj: ResourceUrlsCallbackContext) => Promise): IResource","k":"method","p":"Aspire.Hosting","s":"Registers a callback to customize the URLs displayed for the resource.","h":"/reference/api/typescript/aspire.hosting/withurls/","v":"13.4.0"},{"n":"withVolume","f":"withVolume(target: string, name?: string, isReadOnly?: boolean): ContainerResource","k":"method","p":"Aspire.Hosting","s":"Adds a volume to a container resource.","h":"/reference/api/typescript/aspire.hosting/withvolume/","v":"13.4.0"},{"n":"withWorkingDirectory","f":"withWorkingDirectory(workingDirectory: string): ExecutableResource","k":"method","p":"Aspire.Hosting","s":"Sets the working directory for the executable resource.","h":"/reference/api/typescript/aspire.hosting/withworkingdirectory/","v":"13.4.0"},{"n":"workDir","f":"workDir(path: string): DockerfileStage","k":"method","p":"Aspire.Hosting","s":"Adds a WORKDIR statement to a Dockerfile stage","h":"/reference/api/typescript/aspire.hosting/workdir/","v":"13.4.0"},{"n":"AfterResourcesCreatedEvent","f":"Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent","k":"handle","p":"Aspire.Hosting","s":"This event is published after all resources have been created.","h":"/reference/api/typescript/aspire.hosting/afterresourcescreatedevent/","v":"13.4.0"},{"n":"model","f":"AfterResourcesCreatedEvent.model(): DistributedApplicationModel","k":"property","p":"Aspire.Hosting","s":"The `DistributedApplicationModel` instance.","t":"AfterResourcesCreatedEvent","h":"/reference/api/typescript/aspire.hosting/afterresourcescreatedevent/#model","m":true,"v":"13.4.0"},{"n":"services","f":"AfterResourcesCreatedEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"The `IServiceProvider` instance.","t":"AfterResourcesCreatedEvent","h":"/reference/api/typescript/aspire.hosting/afterresourcescreatedevent/#services","m":true,"v":"13.4.0"},{"n":"BeforeResourceStartedEvent","f":"Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent","k":"handle","p":"Aspire.Hosting","s":"This event is raised by orchestrators before they have started a new resource.","h":"/reference/api/typescript/aspire.hosting/beforeresourcestartedevent/","v":"13.4.0"},{"n":"resource","f":"BeforeResourceStartedEvent.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the Resource property","t":"BeforeResourceStartedEvent","h":"/reference/api/typescript/aspire.hosting/beforeresourcestartedevent/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"BeforeResourceStartedEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the Services property","t":"BeforeResourceStartedEvent","h":"/reference/api/typescript/aspire.hosting/beforeresourcestartedevent/#services","m":true,"v":"13.4.0"},{"n":"BeforeStartEvent","f":"Aspire.Hosting.ApplicationModel.BeforeStartEvent","k":"handle","p":"Aspire.Hosting","s":"This event is published before the application starts.","h":"/reference/api/typescript/aspire.hosting/beforestartevent/","v":"13.4.0"},{"n":"model","f":"BeforeStartEvent.model(): DistributedApplicationModel","k":"property","p":"Aspire.Hosting","s":"The `DistributedApplicationModel` instance.","t":"BeforeStartEvent","h":"/reference/api/typescript/aspire.hosting/beforestartevent/#model","m":true,"v":"13.4.0"},{"n":"services","f":"BeforeStartEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"The `IServiceProvider` instance.","t":"BeforeStartEvent","h":"/reference/api/typescript/aspire.hosting/beforestartevent/#services","m":true,"v":"13.4.0"},{"n":"CommandLineArgsCallbackContext","f":"Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext","k":"handle","p":"Aspire.Hosting","s":"Represents a callback context for the list of command-line arguments associated with an executable resource.","h":"/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext/","v":"13.4.0"},{"n":"args","f":"CommandLineArgsCallbackContext.args(): CommandLineArgsEditor","k":"property","p":"Aspire.Hosting","s":"Gets the editor used to manipulate command-line arguments in polyglot callbacks.","t":"CommandLineArgsCallbackContext","h":"/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext/#args","m":true,"v":"13.4.0"},{"n":"executionContext","f":"CommandLineArgsCallbackContext.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Gets the execution context associated with this callback.","t":"CommandLineArgsCallbackContext","h":"/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext/#executioncontext","m":true,"v":"13.4.0"},{"n":"log","f":"CommandLineArgsCallbackContext.log(): LogFacade","k":"property","p":"Aspire.Hosting","s":"Gets the logger facade used by polyglot callbacks.","t":"CommandLineArgsCallbackContext","h":"/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext/#log","m":true,"v":"13.4.0"},{"n":"resource","f":"CommandLineArgsCallbackContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"The resource associated with this callback context.","t":"CommandLineArgsCallbackContext","h":"/reference/api/typescript/aspire.hosting/commandlineargscallbackcontext/#resource","m":true,"v":"13.4.0"},{"n":"CommandLineArgsEditor","f":"Aspire.Hosting.ApplicationModel.CommandLineArgsEditor","k":"handle","p":"Aspire.Hosting","s":"Provides an ATS-first editor for command-line arguments within polyglot callbacks.","h":"/reference/api/typescript/aspire.hosting/commandlineargseditor/","v":"13.4.0"},{"n":"add","f":"CommandLineArgsEditor.add(value: IExpressionValue): void","k":"method","p":"Aspire.Hosting","s":"Adds a command-line argument.","t":"CommandLineArgsEditor","h":"/reference/api/typescript/aspire.hosting/commandlineargseditor/add/","m":true,"v":"13.4.0"},{"n":"ConnectionStringAvailableEvent","f":"Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent","k":"handle","p":"Aspire.Hosting","s":"The {@ats-ref type:ConnectionStringAvailableEvent} is raised when a connection string becomes available for a resource.","h":"/reference/api/typescript/aspire.hosting/connectionstringavailableevent/","v":"13.4.0"},{"n":"resource","f":"ConnectionStringAvailableEvent.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the Resource property","t":"ConnectionStringAvailableEvent","h":"/reference/api/typescript/aspire.hosting/connectionstringavailableevent/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"ConnectionStringAvailableEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the Services property","t":"ConnectionStringAvailableEvent","h":"/reference/api/typescript/aspire.hosting/connectionstringavailableevent/#services","m":true,"v":"13.4.0"},{"n":"ContainerImagePushOptions","f":"Aspire.Hosting.ApplicationModel.ContainerImagePushOptions","k":"handle","p":"Aspire.Hosting","s":"Represents options for pushing container images to a registry.","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptions/","v":"13.4.0"},{"n":"remoteImageName","f":"ContainerImagePushOptions.remoteImageName(): string","k":"property","p":"Aspire.Hosting","s":"Gets or sets the remote image name (repository path without registry endpoint or tag).","t":"ContainerImagePushOptions","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptions/#remoteimagename","m":true,"v":"13.4.0"},{"n":"remoteImageTag","f":"ContainerImagePushOptions.remoteImageTag(): string","k":"property","p":"Aspire.Hosting","s":"Gets or sets the remote image tag.","t":"ContainerImagePushOptions","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptions/#remoteimagetag","m":true,"v":"13.4.0"},{"n":"ContainerImagePushOptionsCallbackContext","f":"Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext","k":"handle","p":"Aspire.Hosting","s":"Provides context information for container image push options callbacks.","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptionscallbackcontext/","v":"13.4.0"},{"n":"cancellationToken","f":"ContainerImagePushOptionsCallbackContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"Gets the cancellation token to observe while configuring image push options.","t":"ContainerImagePushOptionsCallbackContext","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptionscallbackcontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"options","f":"ContainerImagePushOptionsCallbackContext.options(): ContainerImagePushOptions","k":"property","p":"Aspire.Hosting","s":"Gets the container image push options that can be modified by the callback.","t":"ContainerImagePushOptionsCallbackContext","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptionscallbackcontext/#options","m":true,"v":"13.4.0"},{"n":"resource","f":"ContainerImagePushOptionsCallbackContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource being configured for container image push operations.","t":"ContainerImagePushOptionsCallbackContext","h":"/reference/api/typescript/aspire.hosting/containerimagepushoptionscallbackcontext/#resource","m":true,"v":"13.4.0"},{"n":"ContainerImageReference","f":"Aspire.Hosting.ApplicationModel.ContainerImageReference","k":"handle","p":"Aspire.Hosting","s":"Represents the fully‑qualified container image reference that should be deployed.","h":"/reference/api/typescript/aspire.hosting/containerimagereference/","v":"13.4.0"},{"n":"resource","f":"ContainerImageReference.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource that this container image is associated with.","t":"ContainerImageReference","h":"/reference/api/typescript/aspire.hosting/containerimagereference/#resource","m":true,"v":"13.4.0"},{"n":"valueExpression","f":"ContainerImageReference.valueExpression(): string","k":"property","p":"Aspire.Hosting","s":"Gets the ValueExpression property","t":"ContainerImageReference","h":"/reference/api/typescript/aspire.hosting/containerimagereference/#valueexpression","m":true,"v":"13.4.0"},{"n":"ContainerMountAnnotation","f":"Aspire.Hosting.ApplicationModel.ContainerMountAnnotation","k":"handle","p":"Aspire.Hosting","s":"Represents a mount annotation for a container resource.","h":"/reference/api/typescript/aspire.hosting/containermountannotation/","v":"13.4.0"},{"n":"isReadOnly","f":"ContainerMountAnnotation.isReadOnly(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether the volume mount is read-only.","t":"ContainerMountAnnotation","h":"/reference/api/typescript/aspire.hosting/containermountannotation/#isreadonly","m":true,"v":"13.4.0"},{"n":"source","f":"ContainerMountAnnotation.source(): string","k":"property","p":"Aspire.Hosting","s":"Gets the source of the bind mount or name if a volume. Can be `null` if the mount is an anonymous volume.","t":"ContainerMountAnnotation","h":"/reference/api/typescript/aspire.hosting/containermountannotation/#source","m":true,"v":"13.4.0"},{"n":"target","f":"ContainerMountAnnotation.target(): string","k":"property","p":"Aspire.Hosting","s":"Gets the target of the mount.","t":"ContainerMountAnnotation","h":"/reference/api/typescript/aspire.hosting/containermountannotation/#target","m":true,"v":"13.4.0"},{"n":"type","f":"ContainerMountAnnotation.type(): ContainerMountType","k":"property","p":"Aspire.Hosting","s":"Gets the type of the mount.","t":"ContainerMountAnnotation","h":"/reference/api/typescript/aspire.hosting/containermountannotation/#type","m":true,"v":"13.4.0"},{"n":"ContainerPortReference","f":"Aspire.Hosting.ApplicationModel.ContainerPortReference","k":"handle","p":"Aspire.Hosting","s":"Represents a TCP/UDP port that a container can expose.","h":"/reference/api/typescript/aspire.hosting/containerportreference/","v":"13.4.0"},{"n":"resource","f":"ContainerPortReference.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource that this container port is associated with.","t":"ContainerPortReference","h":"/reference/api/typescript/aspire.hosting/containerportreference/#resource","m":true,"v":"13.4.0"},{"n":"valueExpression","f":"ContainerPortReference.valueExpression(): string","k":"property","p":"Aspire.Hosting","s":"Gets the ValueExpression property","t":"ContainerPortReference","h":"/reference/api/typescript/aspire.hosting/containerportreference/#valueexpression","m":true,"v":"13.4.0"},{"n":"ContainerRegistryResource","f":"Aspire.Hosting.ApplicationModel.ContainerRegistryResource","k":"handle","p":"Aspire.Hosting","s":"Handle type","h":"/reference/api/typescript/aspire.hosting/containerregistryresource/","v":"13.4.0"},{"n":"ContainerResource","f":"Aspire.Hosting.ApplicationModel.ContainerResource","k":"handle","p":"Aspire.Hosting","s":"A resource that represents a specified container.","h":"/reference/api/typescript/aspire.hosting/containerresource/","v":"13.4.0"},{"n":"CSharpAppResource","f":"Aspire.Hosting.ApplicationModel.CSharpAppResource","k":"handle","p":"Aspire.Hosting","s":"Handle type","h":"/reference/api/typescript/aspire.hosting/csharpappresource/","v":"13.4.0"},{"n":"DistributedApplicationModel","f":"Aspire.Hosting.ApplicationModel.DistributedApplicationModel","k":"handle","p":"Aspire.Hosting","s":"Represents a distributed application.","h":"/reference/api/typescript/aspire.hosting/distributedapplicationmodel/","v":"13.4.0"},{"n":"DockerfileBuilder","f":"Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder","k":"handle","p":"Aspire.Hosting","s":"Builder for creating Dockerfiles programmatically.","h":"/reference/api/typescript/aspire.hosting/dockerfilebuilder/","v":"13.4.0"},{"n":"DockerfileStage","f":"Aspire.Hosting.ApplicationModel.Docker.DockerfileStage","k":"handle","p":"Aspire.Hosting","s":"Represents a stage within a multi-stage Dockerfile.","h":"/reference/api/typescript/aspire.hosting/dockerfilestage/","v":"13.4.0"},{"n":"DockerfileBuilderCallbackContext","f":"Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext","k":"handle","p":"Aspire.Hosting","s":"Provides context information for Dockerfile build callbacks.","h":"/reference/api/typescript/aspire.hosting/dockerfilebuildercallbackcontext/","v":"13.4.0"},{"n":"builder","f":"DockerfileBuilderCallbackContext.builder(): DockerfileBuilder","k":"property","p":"Aspire.Hosting","s":"Gets the Dockerfile builder instance.","t":"DockerfileBuilderCallbackContext","h":"/reference/api/typescript/aspire.hosting/dockerfilebuildercallbackcontext/#builder","m":true,"v":"13.4.0"},{"n":"cancellationToken","f":"DockerfileBuilderCallbackContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"Gets the cancellation token to observe while waiting for the task to complete.","t":"DockerfileBuilderCallbackContext","h":"/reference/api/typescript/aspire.hosting/dockerfilebuildercallbackcontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"resource","f":"DockerfileBuilderCallbackContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource being built.","t":"DockerfileBuilderCallbackContext","h":"/reference/api/typescript/aspire.hosting/dockerfilebuildercallbackcontext/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"DockerfileBuilderCallbackContext.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the service provider for dependency injection.","t":"DockerfileBuilderCallbackContext","h":"/reference/api/typescript/aspire.hosting/dockerfilebuildercallbackcontext/#services","m":true,"v":"13.4.0"},{"n":"DockerfileFactoryContext","f":"Aspire.Hosting.ApplicationModel.DockerfileFactoryContext","k":"handle","p":"Aspire.Hosting","s":"Provides context for Dockerfile factory functions.","h":"/reference/api/typescript/aspire.hosting/dockerfilefactorycontext/","v":"13.4.0"},{"n":"resource","f":"DockerfileFactoryContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource for which the Dockerfile is being generated. This allows factory functions to query resource annotations and properties to customize the generated Dockerfile. ``` var containerAnnotation = context.Resource.Annotations.OfType().FirstOrDefault(); var baseImage = containerAnnotation?.Image ?? \"alpine:latest\"; ```","t":"DockerfileFactoryContext","h":"/reference/api/typescript/aspire.hosting/dockerfilefactorycontext/#resource","m":true,"v":"13.4.0"},{"n":"DotnetToolResource","f":"Aspire.Hosting.ApplicationModel.DotnetToolResource","k":"handle","p":"Aspire.Hosting","s":"Handle type","h":"/reference/api/typescript/aspire.hosting/dotnettoolresource/","v":"13.4.0"},{"n":"EndpointReference","f":"Aspire.Hosting.ApplicationModel.EndpointReference","k":"handle","p":"Aspire.Hosting","s":"Represents an endpoint reference for a resource with endpoints.","h":"/reference/api/typescript/aspire.hosting/endpointreference/","v":"13.4.0"},{"n":"endpointName","f":"EndpointReference.endpointName(): string","k":"property","p":"Aspire.Hosting","s":"Gets the name of the endpoint associated with the endpoint reference.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#endpointname","m":true,"v":"13.4.0"},{"n":"errorMessage","f":"EndpointReference.errorMessage(): string","k":"property","p":"Aspire.Hosting","s":"Gets or sets a custom error message to be thrown when the endpoint annotation is not found.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#errormessage","m":true,"v":"13.4.0"},{"n":"excludeReferenceEndpoint","f":"EndpointReference.excludeReferenceEndpoint(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether this endpoint is excluded from the default set when referencing the resource's endpoints.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#excludereferenceendpoint","m":true,"v":"13.4.0"},{"n":"exists","f":"EndpointReference.exists(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether the endpoint exists.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#exists","m":true,"v":"13.4.0"},{"n":"host","f":"EndpointReference.host(): string","k":"property","p":"Aspire.Hosting","s":"Gets the host for this endpoint.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#host","m":true,"v":"13.4.0"},{"n":"isAllocated","f":"EndpointReference.isAllocated(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether the endpoint is allocated.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#isallocated","m":true,"v":"13.4.0"},{"n":"isHttp","f":"EndpointReference.isHttp(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether the endpoint uses HTTP scheme.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#ishttp","m":true,"v":"13.4.0"},{"n":"isHttps","f":"EndpointReference.isHttps(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether the endpoint uses HTTPS scheme.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#ishttps","m":true,"v":"13.4.0"},{"n":"isHttpSchemeNamedEndpoint","f":"EndpointReference.isHttpSchemeNamedEndpoint(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether the endpoint name is \"http\" or \"https\", ignoring case. This is a convention used to identify endpoints that will be resolved based on the scheme of the endpoint in service discovery rather than by the specific endpoint name. This is done to allow http endpoints that are dynamically updated to https to be mapped correctly despite the endpoint name no longer matching the scheme.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#ishttpschemenamedendpoint","m":true,"v":"13.4.0"},{"n":"port","f":"EndpointReference.port(): number","k":"property","p":"Aspire.Hosting","s":"Gets the port for this endpoint.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#port","m":true,"v":"13.4.0"},{"n":"resource","f":"EndpointReference.resource(): IResourceWithEndpoints","k":"property","p":"Aspire.Hosting","s":"Gets the resource owner of the endpoint reference.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#resource","m":true,"v":"13.4.0"},{"n":"scheme","f":"EndpointReference.scheme(): string","k":"property","p":"Aspire.Hosting","s":"Gets the scheme for this endpoint.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#scheme","m":true,"v":"13.4.0"},{"n":"targetPort","f":"EndpointReference.targetPort(): number","k":"property","p":"Aspire.Hosting","s":"Gets the target port for this endpoint. If the port is dynamically allocated, this will return `null`.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#targetport","m":true,"v":"13.4.0"},{"n":"tlsEnabled","f":"EndpointReference.tlsEnabled(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether TLS is enabled for this endpoint.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#tlsenabled","m":true,"v":"13.4.0"},{"n":"url","f":"EndpointReference.url(): string","k":"property","p":"Aspire.Hosting","s":"Gets the URL for this endpoint.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/#url","m":true,"v":"13.4.0"},{"n":"getTlsValue","f":"EndpointReference.getTlsValue(enabledValue: ReferenceExpression, disabledValue: ReferenceExpression): ReferenceExpression","k":"method","p":"Aspire.Hosting","s":"Gets a conditional expression that resolves to the enabledValue when TLS is enabled on the endpoint, or to the disabledValue otherwise.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/gettlsvalue/","m":true,"v":"13.4.0"},{"n":"getValueAsync","f":"EndpointReference.getValueAsync(cancellationToken?: cancellationToken): string","k":"method","p":"Aspire.Hosting","s":"Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/getvalueasync/","m":true,"v":"13.4.0"},{"n":"property","f":"EndpointReference.property(property: EndpointProperty): EndpointReferenceExpression","k":"method","p":"Aspire.Hosting","s":"Gets the specified property expression of the endpoint.","t":"EndpointReference","h":"/reference/api/typescript/aspire.hosting/endpointreference/property/","m":true,"v":"13.4.0"},{"n":"EndpointReferenceExpression","f":"Aspire.Hosting.ApplicationModel.EndpointReferenceExpression","k":"handle","p":"Aspire.Hosting","s":"Represents a property expression for an endpoint reference.","h":"/reference/api/typescript/aspire.hosting/endpointreferenceexpression/","v":"13.4.0"},{"n":"endpoint","f":"EndpointReferenceExpression.endpoint(): EndpointReference","k":"property","p":"Aspire.Hosting","s":"Gets the `EndpointReference`.","t":"EndpointReferenceExpression","h":"/reference/api/typescript/aspire.hosting/endpointreferenceexpression/#endpoint","m":true,"v":"13.4.0"},{"n":"property","f":"EndpointReferenceExpression.property(): EndpointProperty","k":"property","p":"Aspire.Hosting","s":"Gets the `EndpointProperty` for the property expression.","t":"EndpointReferenceExpression","h":"/reference/api/typescript/aspire.hosting/endpointreferenceexpression/#property","m":true,"v":"13.4.0"},{"n":"valueExpression","f":"EndpointReferenceExpression.valueExpression(): string","k":"property","p":"Aspire.Hosting","s":"Gets the expression of the property of the endpoint.","t":"EndpointReferenceExpression","h":"/reference/api/typescript/aspire.hosting/endpointreferenceexpression/#valueexpression","m":true,"v":"13.4.0"},{"n":"EndpointUpdateContext","f":"Aspire.Hosting.ApplicationModel.EndpointUpdateContext","k":"handle","p":"Aspire.Hosting","s":"Provides a mutable callback context for updating an endpoint in polyglot app hosts.","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/","v":"13.4.0"},{"n":"excludeReferenceEndpoint","f":"EndpointUpdateContext.excludeReferenceEndpoint(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets or sets a value indicating whether the endpoint is excluded from the default reference set.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#excludereferenceendpoint","m":true,"v":"13.4.0"},{"n":"isExternal","f":"EndpointUpdateContext.isExternal(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets or sets a value indicating whether the endpoint is external.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#isexternal","m":true,"v":"13.4.0"},{"n":"isProxied","f":"EndpointUpdateContext.isProxied(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets or sets a value indicating whether the endpoint is proxied.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#isproxied","m":true,"v":"13.4.0"},{"n":"name","f":"EndpointUpdateContext.name(): string","k":"property","p":"Aspire.Hosting","s":"Gets the endpoint name.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#name","m":true,"v":"13.4.0"},{"n":"port","f":"EndpointUpdateContext.port(): number","k":"property","p":"Aspire.Hosting","s":"Gets or sets the desired host port.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#port","m":true,"v":"13.4.0"},{"n":"protocol","f":"EndpointUpdateContext.protocol(): ProtocolType","k":"property","p":"Aspire.Hosting","s":"Gets or sets the network protocol.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#protocol","m":true,"v":"13.4.0"},{"n":"targetHost","f":"EndpointUpdateContext.targetHost(): string","k":"property","p":"Aspire.Hosting","s":"Gets or sets the target host.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#targethost","m":true,"v":"13.4.0"},{"n":"targetPort","f":"EndpointUpdateContext.targetPort(): number","k":"property","p":"Aspire.Hosting","s":"Gets or sets the target port.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#targetport","m":true,"v":"13.4.0"},{"n":"tlsEnabled","f":"EndpointUpdateContext.tlsEnabled(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets or sets a value indicating whether TLS is enabled.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#tlsenabled","m":true,"v":"13.4.0"},{"n":"transport","f":"EndpointUpdateContext.transport(): string","k":"property","p":"Aspire.Hosting","s":"Gets or sets the transport.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#transport","m":true,"v":"13.4.0"},{"n":"uriScheme","f":"EndpointUpdateContext.uriScheme(): string","k":"property","p":"Aspire.Hosting","s":"Gets or sets the URI scheme.","t":"EndpointUpdateContext","h":"/reference/api/typescript/aspire.hosting/endpointupdatecontext/#urischeme","m":true,"v":"13.4.0"},{"n":"EnvironmentCallbackContext","f":"Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext","k":"handle","p":"Aspire.Hosting","s":"Represents a callback context for environment variables associated with a publisher.","h":"/reference/api/typescript/aspire.hosting/environmentcallbackcontext/","v":"13.4.0"},{"n":"environment","f":"EnvironmentCallbackContext.environment(): EnvironmentEditor","k":"property","p":"Aspire.Hosting","s":"Gets the editor used to set environment variables in polyglot callbacks.","t":"EnvironmentCallbackContext","h":"/reference/api/typescript/aspire.hosting/environmentcallbackcontext/#environment","m":true,"v":"13.4.0"},{"n":"executionContext","f":"EnvironmentCallbackContext.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Gets the execution context associated with this invocation of the AppHost.","t":"EnvironmentCallbackContext","h":"/reference/api/typescript/aspire.hosting/environmentcallbackcontext/#executioncontext","m":true,"v":"13.4.0"},{"n":"log","f":"EnvironmentCallbackContext.log(): LogFacade","k":"property","p":"Aspire.Hosting","s":"Gets the logger facade used by polyglot callbacks.","t":"EnvironmentCallbackContext","h":"/reference/api/typescript/aspire.hosting/environmentcallbackcontext/#log","m":true,"v":"13.4.0"},{"n":"resource","f":"EnvironmentCallbackContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"The resource associated with this callback context.","t":"EnvironmentCallbackContext","h":"/reference/api/typescript/aspire.hosting/environmentcallbackcontext/#resource","m":true,"v":"13.4.0"},{"n":"EnvironmentEditor","f":"Aspire.Hosting.ApplicationModel.EnvironmentEditor","k":"handle","p":"Aspire.Hosting","s":"Provides an ATS-first editor for environment variables within polyglot callbacks.","h":"/reference/api/typescript/aspire.hosting/environmenteditor/","v":"13.4.0"},{"n":"set","f":"EnvironmentEditor.set(name: string, value: IExpressionValue): void","k":"method","p":"Aspire.Hosting","s":"Sets an environment variable.","t":"EnvironmentEditor","h":"/reference/api/typescript/aspire.hosting/environmenteditor/set/","m":true,"v":"13.4.0"},{"n":"ExecutableResource","f":"Aspire.Hosting.ApplicationModel.ExecutableResource","k":"handle","p":"Aspire.Hosting","s":"A resource that represents a specified executable process.","h":"/reference/api/typescript/aspire.hosting/executableresource/","v":"13.4.0"},{"n":"ExecuteCommandContext","f":"Aspire.Hosting.ApplicationModel.ExecuteCommandContext","k":"handle","p":"Aspire.Hosting","s":"Context for {@ats-ref method:ResourceCommandAnnotation.ExecuteCommand}.","h":"/reference/api/typescript/aspire.hosting/executecommandcontext/","v":"13.4.0"},{"n":"arguments","f":"ExecuteCommandContext.arguments(): InteractionInputCollection","k":"property","p":"Aspire.Hosting","s":"Gets the invocation arguments supplied by the client when the command is executed.","t":"ExecuteCommandContext","h":"/reference/api/typescript/aspire.hosting/executecommandcontext/#arguments","m":true,"v":"13.4.0"},{"n":"cancellationToken","f":"ExecuteCommandContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"The cancellation token.","t":"ExecuteCommandContext","h":"/reference/api/typescript/aspire.hosting/executecommandcontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"logger","f":"ExecuteCommandContext.logger(): ILogger","k":"property","p":"Aspire.Hosting","s":"The logger for the resource.","t":"ExecuteCommandContext","h":"/reference/api/typescript/aspire.hosting/executecommandcontext/#logger","m":true,"v":"13.4.0"},{"n":"resourceName","f":"ExecuteCommandContext.resourceName(): string","k":"property","p":"Aspire.Hosting","s":"The resource name.","t":"ExecuteCommandContext","h":"/reference/api/typescript/aspire.hosting/executecommandcontext/#resourcename","m":true,"v":"13.4.0"},{"n":"IAspireStore","f":"Aspire.Hosting.ApplicationModel.IAspireStore","k":"interface","p":"Aspire.Hosting","s":"Represents a store for managing files in the Aspire hosting environment that can be reused across runs.","h":"/reference/api/typescript/aspire.hosting/iaspirestore/","v":"13.4.0"},{"n":"basePath","f":"IAspireStore.basePath(): string","k":"property","p":"Aspire.Hosting","s":"Gets the base path of this store.","t":"IAspireStore","h":"/reference/api/typescript/aspire.hosting/iaspirestore/#basepath","m":true,"v":"13.4.0"},{"n":"IComputeEnvironmentResource","f":"Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource","k":"interface","p":"Aspire.Hosting","s":"Handle type (interface)","h":"/reference/api/typescript/aspire.hosting/icomputeenvironmentresource/","v":"13.4.0"},{"n":"IExecutionConfigurationBuilder","f":"Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder","k":"interface","p":"Aspire.Hosting","s":"Builder for gathering and resolving the execution configuration (arguments and environment variables) for a specific resource.","h":"/reference/api/typescript/aspire.hosting/iexecutionconfigurationbuilder/","v":"13.4.0"},{"n":"IExecutionConfigurationResult","f":"Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult","k":"interface","p":"Aspire.Hosting","s":"Configuration (arguments and environment variables) to apply to a specific resource.","h":"/reference/api/typescript/aspire.hosting/iexecutionconfigurationresult/","v":"13.4.0"},{"n":"IExpressionValue","f":"Aspire.Hosting.ApplicationModel.IExpressionValue","k":"interface","p":"Aspire.Hosting","s":"Represents a value that provides both a runtime value and a manifest expression.","h":"/reference/api/typescript/aspire.hosting/iexpressionvalue/","v":"13.4.0"},{"n":"InitializeResourceEvent","f":"Aspire.Hosting.ApplicationModel.InitializeResourceEvent","k":"handle","p":"Aspire.Hosting","s":"This event is raised by orchestrators to signal to resources that they should initialize themselves.","h":"/reference/api/typescript/aspire.hosting/initializeresourceevent/","v":"13.4.0"},{"n":"eventing","f":"InitializeResourceEvent.eventing(): IDistributedApplicationEventing","k":"property","p":"Aspire.Hosting","s":"The `IDistributedApplicationEventing` service for the app host.","t":"InitializeResourceEvent","h":"/reference/api/typescript/aspire.hosting/initializeresourceevent/#eventing","m":true,"v":"13.4.0"},{"n":"logger","f":"InitializeResourceEvent.logger(): ILogger","k":"property","p":"Aspire.Hosting","s":"An instance of `ILogger` that can be used to log messages for the resource.","t":"InitializeResourceEvent","h":"/reference/api/typescript/aspire.hosting/initializeresourceevent/#logger","m":true,"v":"13.4.0"},{"n":"notifications","f":"InitializeResourceEvent.notifications(): ResourceNotificationService","k":"property","p":"Aspire.Hosting","s":"The `ResourceNotificationService` for the app host.","t":"InitializeResourceEvent","h":"/reference/api/typescript/aspire.hosting/initializeresourceevent/#notifications","m":true,"v":"13.4.0"},{"n":"resource","f":"InitializeResourceEvent.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the Resource property","t":"InitializeResourceEvent","h":"/reference/api/typescript/aspire.hosting/initializeresourceevent/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"InitializeResourceEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"The `IServiceProvider` for the app host.","t":"InitializeResourceEvent","h":"/reference/api/typescript/aspire.hosting/initializeresourceevent/#services","m":true,"v":"13.4.0"},{"n":"IResource","f":"Aspire.Hosting.ApplicationModel.IResource","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that can be hosted by an application.","h":"/reference/api/typescript/aspire.hosting/iresource/","v":"13.4.0"},{"n":"IResourceWithArgs","f":"Aspire.Hosting.ApplicationModel.IResourceWithArgs","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that is associated with commandline arguments.","h":"/reference/api/typescript/aspire.hosting/iresourcewithargs/","v":"13.4.0"},{"n":"IResourceWithConnectionString","f":"Aspire.Hosting.ApplicationModel.IResourceWithConnectionString","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that has a connection string associated with it.","h":"/reference/api/typescript/aspire.hosting/iresourcewithconnectionstring/","v":"13.4.0"},{"n":"IResourceWithEndpoints","f":"Aspire.Hosting.ApplicationModel.IResourceWithEndpoints","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that has endpoints associated with it.","h":"/reference/api/typescript/aspire.hosting/iresourcewithendpoints/","v":"13.4.0"},{"n":"IResourceWithEnvironment","f":"Aspire.Hosting.ApplicationModel.IResourceWithEnvironment","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that is associated with an environment.","h":"/reference/api/typescript/aspire.hosting/iresourcewithenvironment/","v":"13.4.0"},{"n":"IResourceWithParent","f":"Aspire.Hosting.ApplicationModel.IResourceWithParent","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that has a parent resource.","h":"/reference/api/typescript/aspire.hosting/iresourcewithparent/","v":"13.4.0"},{"n":"IResourceWithWaitSupport","f":"Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport","k":"interface","p":"Aspire.Hosting","s":"Represents a resource that can wait for other resources to be running, health, and/or completed.","h":"/reference/api/typescript/aspire.hosting/iresourcewithwaitsupport/","v":"13.4.0"},{"n":"LogFacade","f":"Aspire.Hosting.ApplicationModel.LogFacade","k":"handle","p":"Aspire.Hosting","s":"Provides a narrow logging surface for polyglot callback contexts.","h":"/reference/api/typescript/aspire.hosting/logfacade/","v":"13.4.0"},{"n":"debug","f":"LogFacade.debug(message: string): void","k":"method","p":"Aspire.Hosting","s":"Writes a debug log message.","t":"LogFacade","h":"/reference/api/typescript/aspire.hosting/logfacade/debug/","m":true,"v":"13.4.0"},{"n":"error","f":"LogFacade.error(message: string): void","k":"method","p":"Aspire.Hosting","s":"Writes an error log message.","t":"LogFacade","h":"/reference/api/typescript/aspire.hosting/logfacade/error/","m":true,"v":"13.4.0"},{"n":"info","f":"LogFacade.info(message: string): void","k":"method","p":"Aspire.Hosting","s":"Writes an informational log message.","t":"LogFacade","h":"/reference/api/typescript/aspire.hosting/logfacade/info/","m":true,"v":"13.4.0"},{"n":"warning","f":"LogFacade.warning(message: string): void","k":"method","p":"Aspire.Hosting","s":"Writes a warning log message.","t":"LogFacade","h":"/reference/api/typescript/aspire.hosting/logfacade/warning/","m":true,"v":"13.4.0"},{"n":"ParameterResource","f":"Aspire.Hosting.ApplicationModel.ParameterResource","k":"handle","p":"Aspire.Hosting","s":"Represents a parameter resource.","h":"/reference/api/typescript/aspire.hosting/parameterresource/","v":"13.4.0"},{"n":"ProjectResource","f":"Aspire.Hosting.ApplicationModel.ProjectResource","k":"handle","p":"Aspire.Hosting","s":"A resource that represents a specified .NET project.","h":"/reference/api/typescript/aspire.hosting/projectresource/","v":"13.4.0"},{"n":"ReferenceExpression","f":"Aspire.Hosting.ApplicationModel.ReferenceExpression","k":"handle","p":"Aspire.Hosting","s":"Represents an expression that might be made up of multiple resource properties. For example, a connection string might be made up of a host, port, and password from different endpoints.","h":"/reference/api/typescript/aspire.hosting/referenceexpression/","v":"13.4.0"},{"n":"getValueAsync","f":"ReferenceExpression.getValueAsync(cancellationToken: cancellationToken): string","k":"method","p":"Aspire.Hosting","s":"Gets the value of the expression. The final string value after evaluating the format string and its parameters.","t":"ReferenceExpression","h":"/reference/api/typescript/aspire.hosting/referenceexpression/getvalueasync/","m":true,"v":"13.4.0"},{"n":"ReferenceExpressionBuilder","f":"Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder","k":"handle","p":"Aspire.Hosting","s":"A builder for creating {@ats-ref type:ReferenceExpression} instances.","h":"/reference/api/typescript/aspire.hosting/referenceexpressionbuilder/","v":"13.4.0"},{"n":"isEmpty","f":"ReferenceExpressionBuilder.isEmpty(): boolean","k":"property","p":"Aspire.Hosting","s":"Indicates whether the expression is empty.","t":"ReferenceExpressionBuilder","h":"/reference/api/typescript/aspire.hosting/referenceexpressionbuilder/#isempty","m":true,"v":"13.4.0"},{"n":"appendFormatted","f":"ReferenceExpressionBuilder.appendFormatted(value: string, format?: string): void","k":"method","p":"Aspire.Hosting","s":"Appends a formatted value to the expression.","t":"ReferenceExpressionBuilder","h":"/reference/api/typescript/aspire.hosting/referenceexpressionbuilder/appendformatted/","m":true,"v":"13.4.0"},{"n":"appendLiteral","f":"ReferenceExpressionBuilder.appendLiteral(value: string): void","k":"method","p":"Aspire.Hosting","s":"Appends a literal value to the expression.","t":"ReferenceExpressionBuilder","h":"/reference/api/typescript/aspire.hosting/referenceexpressionbuilder/appendliteral/","m":true,"v":"13.4.0"},{"n":"appendValueProvider","f":"ReferenceExpressionBuilder.appendValueProvider(valueProvider: any, format?: string): void","k":"method","p":"Aspire.Hosting","s":"Appends a value provider to the reference expression","t":"ReferenceExpressionBuilder","h":"/reference/api/typescript/aspire.hosting/referenceexpressionbuilder/appendvalueprovider/","m":true,"v":"13.4.0"},{"n":"build","f":"ReferenceExpressionBuilder.build(): ReferenceExpression","k":"method","p":"Aspire.Hosting","s":"Builds the reference expression","t":"ReferenceExpressionBuilder","h":"/reference/api/typescript/aspire.hosting/referenceexpressionbuilder/build/","m":true,"v":"13.4.0"},{"n":"ResourceCommandService","f":"Aspire.Hosting.ApplicationModel.ResourceCommandService","k":"handle","p":"Aspire.Hosting","s":"A service to execute resource commands.","h":"/reference/api/typescript/aspire.hosting/resourcecommandservice/","v":"13.4.0"},{"n":"ResourceEndpointsAllocatedEvent","f":"Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent","k":"handle","p":"Aspire.Hosting","s":"This event is raised by orchestrators to signal to resources that their endpoints have been allocated.","h":"/reference/api/typescript/aspire.hosting/resourceendpointsallocatedevent/","v":"13.4.0"},{"n":"resource","f":"ResourceEndpointsAllocatedEvent.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the Resource property","t":"ResourceEndpointsAllocatedEvent","h":"/reference/api/typescript/aspire.hosting/resourceendpointsallocatedevent/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"ResourceEndpointsAllocatedEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the Services property","t":"ResourceEndpointsAllocatedEvent","h":"/reference/api/typescript/aspire.hosting/resourceendpointsallocatedevent/#services","m":true,"v":"13.4.0"},{"n":"ResourceLoggerService","f":"Aspire.Hosting.ApplicationModel.ResourceLoggerService","k":"handle","p":"Aspire.Hosting","s":"A service that provides loggers for resources to write to.","h":"/reference/api/typescript/aspire.hosting/resourceloggerservice/","v":"13.4.0"},{"n":"ResourceNotificationService","f":"Aspire.Hosting.ApplicationModel.ResourceNotificationService","k":"handle","p":"Aspire.Hosting","s":"A service that allows publishing and subscribing to changes in the state of a resource.","h":"/reference/api/typescript/aspire.hosting/resourcenotificationservice/","v":"13.4.0"},{"n":"ResourceReadyEvent","f":"Aspire.Hosting.ApplicationModel.ResourceReadyEvent","k":"handle","p":"Aspire.Hosting","s":"Event that is raised when a resource initially transitions to a ready state.","h":"/reference/api/typescript/aspire.hosting/resourcereadyevent/","v":"13.4.0"},{"n":"resource","f":"ResourceReadyEvent.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"The resource that is in a healthy state.","t":"ResourceReadyEvent","h":"/reference/api/typescript/aspire.hosting/resourcereadyevent/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"ResourceReadyEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the Services property","t":"ResourceReadyEvent","h":"/reference/api/typescript/aspire.hosting/resourcereadyevent/#services","m":true,"v":"13.4.0"},{"n":"ResourceStoppedEvent","f":"Aspire.Hosting.ApplicationModel.ResourceStoppedEvent","k":"handle","p":"Aspire.Hosting","s":"This event is raised after a resource has stopped.","h":"/reference/api/typescript/aspire.hosting/resourcestoppedevent/","v":"13.4.0"},{"n":"resource","f":"ResourceStoppedEvent.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the Resource property","t":"ResourceStoppedEvent","h":"/reference/api/typescript/aspire.hosting/resourcestoppedevent/#resource","m":true,"v":"13.4.0"},{"n":"services","f":"ResourceStoppedEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the Services property","t":"ResourceStoppedEvent","h":"/reference/api/typescript/aspire.hosting/resourcestoppedevent/#services","m":true,"v":"13.4.0"},{"n":"ResourceUrlsCallbackContext","f":"Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext","k":"handle","p":"Aspire.Hosting","s":"Represents a callback context for resource URLs.","h":"/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext/","v":"13.4.0"},{"n":"executionContext","f":"ResourceUrlsCallbackContext.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Gets the execution context associated with this invocation of the AppHost.","t":"ResourceUrlsCallbackContext","h":"/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext/#executioncontext","m":true,"v":"13.4.0"},{"n":"log","f":"ResourceUrlsCallbackContext.log(): LogFacade","k":"property","p":"Aspire.Hosting","s":"Gets the logger facade used by polyglot callbacks.","t":"ResourceUrlsCallbackContext","h":"/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext/#log","m":true,"v":"13.4.0"},{"n":"resource","f":"ResourceUrlsCallbackContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource this the URLs are associated with.","t":"ResourceUrlsCallbackContext","h":"/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext/#resource","m":true,"v":"13.4.0"},{"n":"urls","f":"ResourceUrlsCallbackContext.urls(): ResourceUrlsEditor","k":"property","p":"Aspire.Hosting","s":"Gets the editor used to manipulate displayed URLs in polyglot callbacks.","t":"ResourceUrlsCallbackContext","h":"/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext/#urls","m":true,"v":"13.4.0"},{"n":"getEndpoint","f":"ResourceUrlsCallbackContext.getEndpoint(name: string): EndpointReference","k":"method","p":"Aspire.Hosting","s":"Gets an endpoint reference from the associated resource","t":"ResourceUrlsCallbackContext","h":"/reference/api/typescript/aspire.hosting/resourceurlscallbackcontext/getendpoint/","m":true,"v":"13.4.0"},{"n":"ResourceUrlsEditor","f":"Aspire.Hosting.ApplicationModel.ResourceUrlsEditor","k":"handle","p":"Aspire.Hosting","s":"Provides an ATS-first editor for resource URLs within polyglot callbacks.","h":"/reference/api/typescript/aspire.hosting/resourceurlseditor/","v":"13.4.0"},{"n":"executionContext","f":"ResourceUrlsEditor.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Gets the execution context associated with this editor.","t":"ResourceUrlsEditor","h":"/reference/api/typescript/aspire.hosting/resourceurlseditor/#executioncontext","m":true,"v":"13.4.0"},{"n":"add","f":"ResourceUrlsEditor.add(url: ReferenceExpression, displayText?: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a displayed URL.","t":"ResourceUrlsEditor","h":"/reference/api/typescript/aspire.hosting/resourceurlseditor/add/","m":true,"v":"13.4.0"},{"n":"addForEndpoint","f":"ResourceUrlsEditor.addForEndpoint(endpoint: EndpointReference, url: ReferenceExpression, displayText?: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a displayed URL for a specific endpoint.","t":"ResourceUrlsEditor","h":"/reference/api/typescript/aspire.hosting/resourceurlseditor/addforendpoint/","m":true,"v":"13.4.0"},{"n":"UpdateCommandStateContext","f":"Aspire.Hosting.ApplicationModel.UpdateCommandStateContext","k":"handle","p":"Aspire.Hosting","s":"Context for {@ats-ref method:ResourceCommandAnnotation.UpdateState}.","h":"/reference/api/typescript/aspire.hosting/updatecommandstatecontext/","v":"13.4.0"},{"n":"resourceSnapshot","f":"UpdateCommandStateContext.resourceSnapshot(): UpdateCommandStateResourceSnapshot","k":"property","p":"Aspire.Hosting","s":"Gets the resource snapshot data available to polyglot command state callbacks.","t":"UpdateCommandStateContext","h":"/reference/api/typescript/aspire.hosting/updatecommandstatecontext/#resourcesnapshot","m":true,"v":"13.4.0"},{"n":"EventingSubscriberRegistrationContext","f":"Aspire.Hosting.Ats.EventingSubscriberRegistrationContext","k":"handle","p":"Aspire.Hosting","s":"Context passed to ATS-friendly eventing subscriber registrations.","h":"/reference/api/typescript/aspire.hosting/eventingsubscriberregistrationcontext/","v":"13.4.0"},{"n":"cancellationToken","f":"EventingSubscriberRegistrationContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"The cancellation token associated with the subscriber registration.","t":"EventingSubscriberRegistrationContext","h":"/reference/api/typescript/aspire.hosting/eventingsubscriberregistrationcontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"executionContext","f":"EventingSubscriberRegistrationContext.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"The execution context for the AppHost invocation.","t":"EventingSubscriberRegistrationContext","h":"/reference/api/typescript/aspire.hosting/eventingsubscriberregistrationcontext/#executioncontext","m":true,"v":"13.4.0"},{"n":"DistributedApplication","f":"Aspire.Hosting.DistributedApplication","k":"handle","p":"Aspire.Hosting","s":"Represents a distributed application that implements the {@ats-ref type:IHost} and {@ats-ref type:IAsyncDisposable} interfaces.","h":"/reference/api/typescript/aspire.hosting/distributedapplication/","v":"13.4.0"},{"n":"run","f":"DistributedApplication.run(cancellationToken?: cancellationToken): void","k":"method","p":"Aspire.Hosting","s":"Runs the distributed application","t":"DistributedApplication","h":"/reference/api/typescript/aspire.hosting/distributedapplication/run/","m":true,"v":"13.4.0"},{"n":"DistributedApplicationExecutionContext","f":"Aspire.Hosting.DistributedApplicationExecutionContext","k":"handle","p":"Aspire.Hosting","s":"Exposes the global contextual information for this invocation of the AppHost.","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext/","v":"13.4.0"},{"n":"isPublishMode","f":"DistributedApplicationExecutionContext.isPublishMode(): boolean","k":"property","p":"Aspire.Hosting","s":"Returns true if the current operation is publishing.","t":"DistributedApplicationExecutionContext","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext/#ispublishmode","m":true,"v":"13.4.0"},{"n":"isRunMode","f":"DistributedApplicationExecutionContext.isRunMode(): boolean","k":"property","p":"Aspire.Hosting","s":"Returns true if the current operation is running.","t":"DistributedApplicationExecutionContext","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext/#isrunmode","m":true,"v":"13.4.0"},{"n":"operation","f":"DistributedApplicationExecutionContext.operation(): DistributedApplicationOperation","k":"property","p":"Aspire.Hosting","s":"The operation currently being performed by the AppHost.","t":"DistributedApplicationExecutionContext","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext/#operation","m":true,"v":"13.4.0"},{"n":"publisherName","f":"DistributedApplicationExecutionContext.publisherName(): string","k":"property","p":"Aspire.Hosting","s":"The name of the publisher that is being used if `Operation` is set to `Publish`.","t":"DistributedApplicationExecutionContext","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext/#publishername","m":true,"v":"13.4.0"},{"n":"serviceProvider","f":"DistributedApplicationExecutionContext.serviceProvider(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"The `IServiceProvider` for the AppHost.","t":"DistributedApplicationExecutionContext","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontext/#serviceprovider","m":true,"v":"13.4.0"},{"n":"DistributedApplicationExecutionContextOptions","f":"Aspire.Hosting.DistributedApplicationExecutionContextOptions","k":"handle","p":"Aspire.Hosting","s":"Configuration options and references that need to be exposed to the {@ats-ref type:DistributedApplicationExecutionContext}.","h":"/reference/api/typescript/aspire.hosting/distributedapplicationexecutioncontextoptions/","v":"13.4.0"},{"n":"DistributedApplicationEventSubscription","f":"Aspire.Hosting.Eventing.DistributedApplicationEventSubscription","k":"handle","p":"Aspire.Hosting","s":"Represents a subscription to an event that is published during the lifecycle of the AppHost.","h":"/reference/api/typescript/aspire.hosting/distributedapplicationeventsubscription/","v":"13.4.0"},{"n":"DistributedApplicationResourceEventSubscription","f":"Aspire.Hosting.Eventing.DistributedApplicationResourceEventSubscription","k":"handle","p":"Aspire.Hosting","s":"Represents a subscription to an event that is published during the lifecycle of the AppHost for a specific resource.","h":"/reference/api/typescript/aspire.hosting/distributedapplicationresourceeventsubscription/","v":"13.4.0"},{"n":"IDistributedApplicationEvent","f":"Aspire.Hosting.Eventing.IDistributedApplicationEvent","k":"interface","p":"Aspire.Hosting","s":"Represents an event that is published during the lifecycle of the AppHost.","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationevent/","v":"13.4.0"},{"n":"IDistributedApplicationEventing","f":"Aspire.Hosting.Eventing.IDistributedApplicationEventing","k":"interface","p":"Aspire.Hosting","s":"Supports publishing and subscribing to events which are executed during the AppHost lifecycle.","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationeventing/","v":"13.4.0"},{"n":"unsubscribe","f":"IDistributedApplicationEventing.unsubscribe(subscription: DistributedApplicationEventSubscription): void","k":"method","p":"Aspire.Hosting","s":"Unsubscribe from an event.","t":"IDistributedApplicationEventing","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationeventing/unsubscribe/","m":true,"v":"13.4.0"},{"n":"IDistributedApplicationResourceEvent","f":"Aspire.Hosting.Eventing.IDistributedApplicationResourceEvent","k":"interface","p":"Aspire.Hosting","s":"Represents an event that is published during the lifecycle of the AppHost for a specific resource.","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationresourceevent/","v":"13.4.0"},{"n":"ExternalServiceResource","f":"Aspire.Hosting.ExternalServiceResource","k":"handle","p":"Aspire.Hosting","s":"Handle type","h":"/reference/api/typescript/aspire.hosting/externalserviceresource/","v":"13.4.0"},{"n":"IDistributedApplicationBuilder","f":"Aspire.Hosting.IDistributedApplicationBuilder","k":"interface","p":"Aspire.Hosting","s":"A builder for creating instances of {@ats-ref type:DistributedApplication}.","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/","v":"13.4.0"},{"n":"appHostDirectory","f":"IDistributedApplicationBuilder.appHostDirectory(): string","k":"property","p":"Aspire.Hosting","s":"Directory of the project where the app host is located. Defaults to the content root if there's no project.","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/#apphostdirectory","m":true,"v":"13.4.0"},{"n":"environment","f":"IDistributedApplicationBuilder.environment(): IHostEnvironment","k":"property","p":"Aspire.Hosting","s":"Gets the Environment property","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/#environment","m":true,"v":"13.4.0"},{"n":"eventing","f":"IDistributedApplicationBuilder.eventing(): IDistributedApplicationEventing","k":"property","p":"Aspire.Hosting","s":"Eventing infrastructure for AppHost lifecycle.","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/#eventing","m":true,"v":"13.4.0"},{"n":"executionContext","f":"IDistributedApplicationBuilder.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Execution context for this invocation of the AppHost.","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/#executioncontext","m":true,"v":"13.4.0"},{"n":"pipeline","f":"IDistributedApplicationBuilder.pipeline(): IDistributedApplicationPipeline","k":"property","p":"Aspire.Hosting","s":"Gets the deployment pipeline for this distributed application.","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/#pipeline","m":true,"v":"13.4.0"},{"n":"userSecretsManager","f":"IDistributedApplicationBuilder.userSecretsManager(): IUserSecretsManager","k":"property","p":"Aspire.Hosting","s":"Gets the service for managing user secrets.","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/#usersecretsmanager","m":true,"v":"13.4.0"},{"n":"build","f":"IDistributedApplicationBuilder.build(): DistributedApplication","k":"method","p":"Aspire.Hosting","s":"Builds the distributed application","t":"IDistributedApplicationBuilder","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/build/","m":true,"v":"13.4.0"},{"n":"InputsDialogValidationContext","f":"Aspire.Hosting.InputsDialogValidationContext","k":"handle","p":"Aspire.Hosting","s":"Represents the context for validating inputs in an inputs dialog interaction.","h":"/reference/api/typescript/aspire.hosting/inputsdialogvalidationcontext/","v":"13.4.0"},{"n":"cancellationToken","f":"InputsDialogValidationContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"Gets the cancellation token for the validation operation.","t":"InputsDialogValidationContext","h":"/reference/api/typescript/aspire.hosting/inputsdialogvalidationcontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"inputs","f":"InputsDialogValidationContext.inputs(): InteractionInputCollection","k":"property","p":"Aspire.Hosting","s":"Gets the inputs that are being validated.","t":"InputsDialogValidationContext","h":"/reference/api/typescript/aspire.hosting/inputsdialogvalidationcontext/#inputs","m":true,"v":"13.4.0"},{"n":"addValidationError","f":"InputsDialogValidationContext.addValidationError(inputName: string, errorMessage: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a validation error for the input with the specified name.","t":"InputsDialogValidationContext","h":"/reference/api/typescript/aspire.hosting/inputsdialogvalidationcontext/addvalidationerror/","m":true,"v":"13.4.0"},{"n":"InteractionInputCollection","f":"Aspire.Hosting.InteractionInputCollection","k":"handle","p":"Aspire.Hosting","s":"A collection of interaction inputs that supports both indexed and name-based access.","h":"/reference/api/typescript/aspire.hosting/interactioninputcollection/","v":"13.4.0"},{"n":"toArray","f":"InteractionInputCollection.toArray(): InteractionInput[]","k":"method","p":"Aspire.Hosting","s":"Gets all inputs in declaration order.","t":"InteractionInputCollection","h":"/reference/api/typescript/aspire.hosting/interactioninputcollection/toarray/","m":true,"v":"13.4.0"},{"n":"IResourceWithContainerFiles","f":"Aspire.Hosting.IResourceWithContainerFiles","k":"interface","p":"Aspire.Hosting","s":"Handle type (interface)","h":"/reference/api/typescript/aspire.hosting/iresourcewithcontainerfiles/","v":"13.4.0"},{"n":"IUserSecretsManager","f":"Aspire.Hosting.IUserSecretsManager","k":"interface","p":"Aspire.Hosting","s":"Defines an interface for managing user secrets with support for read and write operations.","h":"/reference/api/typescript/aspire.hosting/iusersecretsmanager/","v":"13.4.0"},{"n":"filePath","f":"IUserSecretsManager.filePath(): string","k":"property","p":"Aspire.Hosting","s":"Gets the path to the user secrets file.","t":"IUserSecretsManager","h":"/reference/api/typescript/aspire.hosting/iusersecretsmanager/#filepath","m":true,"v":"13.4.0"},{"n":"isAvailable","f":"IUserSecretsManager.isAvailable(): boolean","k":"property","p":"Aspire.Hosting","s":"Gets a value indicating whether user secrets are available.","t":"IUserSecretsManager","h":"/reference/api/typescript/aspire.hosting/iusersecretsmanager/#isavailable","m":true,"v":"13.4.0"},{"n":"tryDeleteSecret","f":"IUserSecretsManager.tryDeleteSecret(name: string): boolean","k":"method","p":"Aspire.Hosting","s":"Attempts to delete a user secret value synchronously.","t":"IUserSecretsManager","h":"/reference/api/typescript/aspire.hosting/iusersecretsmanager/trydeletesecret/","m":true,"v":"13.4.0"},{"n":"trySetSecret","f":"IUserSecretsManager.trySetSecret(name: string, value: string): boolean","k":"method","p":"Aspire.Hosting","s":"Attempts to set a user secret value synchronously.","t":"IUserSecretsManager","h":"/reference/api/typescript/aspire.hosting/iusersecretsmanager/trysetsecret/","m":true,"v":"13.4.0"},{"n":"IDistributedApplicationPipeline","f":"Aspire.Hosting.Pipelines.IDistributedApplicationPipeline","k":"interface","p":"Aspire.Hosting","s":"Represents a pipeline for executing deployment steps in a distributed application.","h":"/reference/api/typescript/aspire.hosting/idistributedapplicationpipeline/","v":"13.4.0"},{"n":"IReportingStep","f":"Aspire.Hosting.Pipelines.IReportingStep","k":"interface","p":"Aspire.Hosting","s":"Represents a publishing step, which can contain multiple tasks.","h":"/reference/api/typescript/aspire.hosting/ireportingstep/","v":"13.4.0"},{"n":"IReportingTask","f":"Aspire.Hosting.Pipelines.IReportingTask","k":"interface","p":"Aspire.Hosting","s":"Represents a publishing task, which belongs to a step.","h":"/reference/api/typescript/aspire.hosting/ireportingtask/","v":"13.4.0"},{"n":"PipelineConfigurationContext","f":"Aspire.Hosting.Pipelines.PipelineConfigurationContext","k":"handle","p":"Aspire.Hosting","s":"Provides contextual information for pipeline configuration callbacks.","h":"/reference/api/typescript/aspire.hosting/pipelineconfigurationcontext/","v":"13.4.0"},{"n":"log","f":"PipelineConfigurationContext.log(): LogFacade","k":"property","p":"Aspire.Hosting","s":"Gets the logger facade used by polyglot callbacks.","t":"PipelineConfigurationContext","h":"/reference/api/typescript/aspire.hosting/pipelineconfigurationcontext/#log","m":true,"v":"13.4.0"},{"n":"pipeline","f":"PipelineConfigurationContext.pipeline(): PipelineEditor","k":"property","p":"Aspire.Hosting","s":"Gets the pipeline editor used by polyglot callbacks.","t":"PipelineConfigurationContext","h":"/reference/api/typescript/aspire.hosting/pipelineconfigurationcontext/#pipeline","m":true,"v":"13.4.0"},{"n":"getSteps","f":"PipelineConfigurationContext.getSteps(tag: string): PipelineStep[]","k":"method","p":"Aspire.Hosting","s":"Gets all pipeline steps with the specified tag.","t":"PipelineConfigurationContext","h":"/reference/api/typescript/aspire.hosting/pipelineconfigurationcontext/getsteps/","m":true,"v":"13.4.0"},{"n":"PipelineContext","f":"Aspire.Hosting.Pipelines.PipelineContext","k":"handle","p":"Aspire.Hosting","s":"Provides contextual information and services for the pipeline execution process of a distributed application.","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/","v":"13.4.0"},{"n":"cancellationToken","f":"PipelineContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"Gets the cancellation token for the pipeline operation.","t":"PipelineContext","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"executionContext","f":"PipelineContext.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Gets the execution context for the distributed application.","t":"PipelineContext","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/#executioncontext","m":true,"v":"13.4.0"},{"n":"logger","f":"PipelineContext.logger(): ILogger","k":"property","p":"Aspire.Hosting","s":"Gets the logger for pipeline operations.","t":"PipelineContext","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/#logger","m":true,"v":"13.4.0"},{"n":"model","f":"PipelineContext.model(): DistributedApplicationModel","k":"property","p":"Aspire.Hosting","s":"Gets the distributed application model to be deployed.","t":"PipelineContext","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/#model","m":true,"v":"13.4.0"},{"n":"services","f":"PipelineContext.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the service provider for dependency resolution.","t":"PipelineContext","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/#services","m":true,"v":"13.4.0"},{"n":"summary","f":"PipelineContext.summary(): PipelineSummary","k":"property","p":"Aspire.Hosting","s":"Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes.","t":"PipelineContext","h":"/reference/api/typescript/aspire.hosting/pipelinecontext/#summary","m":true,"v":"13.4.0"},{"n":"PipelineEditor","f":"Aspire.Hosting.Pipelines.PipelineEditor","k":"handle","p":"Aspire.Hosting","s":"Provides an ATS-first editor for pipeline configuration callbacks.","h":"/reference/api/typescript/aspire.hosting/pipelineeditor/","v":"13.4.0"},{"n":"steps","f":"PipelineEditor.steps(): PipelineStep[]","k":"method","p":"Aspire.Hosting","s":"Gets all configured pipeline steps.","t":"PipelineEditor","h":"/reference/api/typescript/aspire.hosting/pipelineeditor/steps/","m":true,"v":"13.4.0"},{"n":"stepsByTag","f":"PipelineEditor.stepsByTag(tag: string): PipelineStep[]","k":"method","p":"Aspire.Hosting","s":"Gets all pipeline steps that have the specified tag.","t":"PipelineEditor","h":"/reference/api/typescript/aspire.hosting/pipelineeditor/stepsbytag/","m":true,"v":"13.4.0"},{"n":"PipelineStep","f":"Aspire.Hosting.Pipelines.PipelineStep","k":"handle","p":"Aspire.Hosting","s":"Represents a step in the deployment pipeline.","h":"/reference/api/typescript/aspire.hosting/pipelinestep/","v":"13.4.0"},{"n":"dependsOnSteps","f":"PipelineStep.dependsOnSteps(): List","k":"property","p":"Aspire.Hosting","s":"Gets or initializes the list of step names that this step depends on.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/#dependsonsteps","m":true,"v":"13.4.0"},{"n":"description","f":"PipelineStep.description(): string","k":"property","p":"Aspire.Hosting","s":"Gets or initializes the description of the step.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/#description","m":true,"v":"13.4.0"},{"n":"name","f":"PipelineStep.name(): string","k":"property","p":"Aspire.Hosting","s":"Gets or initializes the unique name of the step.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/#name","m":true,"v":"13.4.0"},{"n":"requiredBySteps","f":"PipelineStep.requiredBySteps(): List","k":"property","p":"Aspire.Hosting","s":"Gets or initializes the list of step names that require this step to complete before they can finish. This is used internally during pipeline construction and is converted to DependsOn relationships.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/#requiredbysteps","m":true,"v":"13.4.0"},{"n":"tags","f":"PipelineStep.tags(): List","k":"property","p":"Aspire.Hosting","s":"Gets or initializes the list of tags that categorize this step.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/#tags","m":true,"v":"13.4.0"},{"n":"addTag","f":"PipelineStep.addTag(tag: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a tag to the step.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/addtag/","m":true,"v":"13.4.0"},{"n":"dependsOn","f":"PipelineStep.dependsOn(stepName: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a dependency on another step.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/dependson/","m":true,"v":"13.4.0"},{"n":"requiredBy","f":"PipelineStep.requiredBy(stepName: string): void","k":"method","p":"Aspire.Hosting","s":"Specifies that this step is required by another step. This creates the inverse relationship where the other step will depend on this step.","t":"PipelineStep","h":"/reference/api/typescript/aspire.hosting/pipelinestep/requiredby/","m":true,"v":"13.4.0"},{"n":"PipelineStepContext","f":"Aspire.Hosting.Pipelines.PipelineStepContext","k":"handle","p":"Aspire.Hosting","s":"Provides contextual information for a specific pipeline step execution.","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/","v":"13.4.0"},{"n":"cancellationToken","f":"PipelineStepContext.cancellationToken(): cancellationToken","k":"property","p":"Aspire.Hosting","s":"Gets the cancellation token for the pipeline operation.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#cancellationtoken","m":true,"v":"13.4.0"},{"n":"executionContext","f":"PipelineStepContext.executionContext(): DistributedApplicationExecutionContext","k":"property","p":"Aspire.Hosting","s":"Gets the execution context for the distributed application.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#executioncontext","m":true,"v":"13.4.0"},{"n":"logger","f":"PipelineStepContext.logger(): ILogger","k":"property","p":"Aspire.Hosting","s":"Gets the logger for pipeline operations that writes to both the pipeline logger and the step logger.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#logger","m":true,"v":"13.4.0"},{"n":"model","f":"PipelineStepContext.model(): DistributedApplicationModel","k":"property","p":"Aspire.Hosting","s":"Gets the distributed application model to be deployed.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#model","m":true,"v":"13.4.0"},{"n":"pipelineContext","f":"PipelineStepContext.pipelineContext(): PipelineContext","k":"property","p":"Aspire.Hosting","s":"Gets the pipeline context shared across all steps.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#pipelinecontext","m":true,"v":"13.4.0"},{"n":"reportingStep","f":"PipelineStepContext.reportingStep(): IReportingStep","k":"property","p":"Aspire.Hosting","s":"Gets the publishing step associated with this specific step execution.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#reportingstep","m":true,"v":"13.4.0"},{"n":"services","f":"PipelineStepContext.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"Gets the service provider for dependency resolution.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#services","m":true,"v":"13.4.0"},{"n":"summary","f":"PipelineStepContext.summary(): PipelineSummary","k":"property","p":"Aspire.Hosting","s":"Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes.","t":"PipelineStepContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepcontext/#summary","m":true,"v":"13.4.0"},{"n":"PipelineStepFactoryContext","f":"Aspire.Hosting.Pipelines.PipelineStepFactoryContext","k":"handle","p":"Aspire.Hosting","s":"Provides contextual information for creating pipeline steps from a {@ats-ref type:PipelineStepAnnotation}.","h":"/reference/api/typescript/aspire.hosting/pipelinestepfactorycontext/","v":"13.4.0"},{"n":"pipelineContext","f":"PipelineStepFactoryContext.pipelineContext(): PipelineContext","k":"property","p":"Aspire.Hosting","s":"Gets the pipeline context that has the model and other properties.","t":"PipelineStepFactoryContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepfactorycontext/#pipelinecontext","m":true,"v":"13.4.0"},{"n":"resource","f":"PipelineStepFactoryContext.resource(): IResource","k":"property","p":"Aspire.Hosting","s":"Gets the resource that this factory is associated with.","t":"PipelineStepFactoryContext","h":"/reference/api/typescript/aspire.hosting/pipelinestepfactorycontext/#resource","m":true,"v":"13.4.0"},{"n":"PipelineSummary","f":"Aspire.Hosting.Pipelines.PipelineSummary","k":"handle","p":"Aspire.Hosting","s":"Represents pipeline summary information to be displayed after pipeline completion. This is a general-purpose key-value collection that pipeline steps can contribute to.","h":"/reference/api/typescript/aspire.hosting/pipelinesummary/","v":"13.4.0"},{"n":"add","f":"PipelineSummary.add(key: string, value: string): void","k":"method","p":"Aspire.Hosting","s":"Adds a key-value pair to the pipeline summary with a plain-text value.","t":"PipelineSummary","h":"/reference/api/typescript/aspire.hosting/pipelinesummary/add/","m":true,"v":"13.4.0"},{"n":"ProjectResourceOptions","f":"Aspire.Hosting.ProjectResourceOptions","k":"handle","p":"Aspire.Hosting","s":"Various properties to modify the behavior of the project resource.","h":"/reference/api/typescript/aspire.hosting/projectresourceoptions/","v":"13.4.0"},{"n":"excludeKestrelEndpoints","f":"ProjectResourceOptions.excludeKestrelEndpoints(): boolean","k":"property","p":"Aspire.Hosting","s":"If set, ignore endpoints coming from Kestrel configuration.","t":"ProjectResourceOptions","h":"/reference/api/typescript/aspire.hosting/projectresourceoptions/#excludekestrelendpoints","m":true,"v":"13.4.0"},{"n":"excludeLaunchProfile","f":"ProjectResourceOptions.excludeLaunchProfile(): boolean","k":"property","p":"Aspire.Hosting","s":"If set, no launch profile will be used, and LaunchProfileName will be ignored.","t":"ProjectResourceOptions","h":"/reference/api/typescript/aspire.hosting/projectresourceoptions/#excludelaunchprofile","m":true,"v":"13.4.0"},{"n":"launchProfileName","f":"ProjectResourceOptions.launchProfileName(): string","k":"property","p":"Aspire.Hosting","s":"The launch profile to use. If `null` then the default launch profile will be used.","t":"ProjectResourceOptions","h":"/reference/api/typescript/aspire.hosting/projectresourceoptions/#launchprofilename","m":true,"v":"13.4.0"},{"n":"AfterPublishEvent","f":"Aspire.Hosting.Publishing.AfterPublishEvent","k":"handle","p":"Aspire.Hosting","s":"This event is published after the distributed application is published.","h":"/reference/api/typescript/aspire.hosting/afterpublishevent/","v":"13.4.0"},{"n":"model","f":"AfterPublishEvent.model(): DistributedApplicationModel","k":"property","p":"Aspire.Hosting","s":"The `DistributedApplicationModel` instance.","t":"AfterPublishEvent","h":"/reference/api/typescript/aspire.hosting/afterpublishevent/#model","m":true,"v":"13.4.0"},{"n":"services","f":"AfterPublishEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"The `IServiceProvider` for the app host.","t":"AfterPublishEvent","h":"/reference/api/typescript/aspire.hosting/afterpublishevent/#services","m":true,"v":"13.4.0"},{"n":"BeforePublishEvent","f":"Aspire.Hosting.Publishing.BeforePublishEvent","k":"handle","p":"Aspire.Hosting","s":"This event is published before the distributed application is published.","h":"/reference/api/typescript/aspire.hosting/beforepublishevent/","v":"13.4.0"},{"n":"model","f":"BeforePublishEvent.model(): DistributedApplicationModel","k":"property","p":"Aspire.Hosting","s":"The `DistributedApplicationModel` instance.","t":"BeforePublishEvent","h":"/reference/api/typescript/aspire.hosting/beforepublishevent/#model","m":true,"v":"13.4.0"},{"n":"services","f":"BeforePublishEvent.services(): IServiceProvider","k":"property","p":"Aspire.Hosting","s":"The `IServiceProvider` for the app host.","t":"BeforePublishEvent","h":"/reference/api/typescript/aspire.hosting/beforepublishevent/#services","m":true,"v":"13.4.0"},{"n":"CertificateTrustExecutionConfigurationContext","f":"Aspire.Hosting.ApplicationModel.CertificateTrustExecutionConfigurationContext","k":"type","p":"Aspire.Hosting","s":"Context for configuring certificate trust configuration properties.","h":"/reference/api/typescript/aspire.hosting/certificatetrustexecutionconfigurationcontext/","v":"13.4.0"},{"n":"CommandOptions","f":"Aspire.Hosting.ApplicationModel.CommandOptions","k":"type","p":"Aspire.Hosting","s":"Optional configuration for resource commands.","h":"/reference/api/typescript/aspire.hosting/commandoptions/","v":"13.4.0"},{"n":"CommandResultData","f":"Aspire.Hosting.ApplicationModel.CommandResultData","k":"type","p":"Aspire.Hosting","s":"Represents a value produced by a command.","h":"/reference/api/typescript/aspire.hosting/commandresultdata/","v":"13.4.0"},{"n":"ExecuteCommandResult","f":"Aspire.Hosting.ApplicationModel.ExecuteCommandResult","k":"type","p":"Aspire.Hosting","s":"The result of executing a command. Returned from `ExecuteCommand`.","h":"/reference/api/typescript/aspire.hosting/executecommandresult/","v":"13.4.0"},{"n":"GenerateParameterDefault","f":"Aspire.Hosting.ApplicationModel.GenerateParameterDefault","k":"type","p":"Aspire.Hosting","s":"Represents that a default value should be generated.","h":"/reference/api/typescript/aspire.hosting/generateparameterdefault/","v":"13.4.0"},{"n":"HttpCommandExportOptions","f":"Aspire.Hosting.ApplicationModel.HttpCommandExportOptions","k":"type","p":"Aspire.Hosting","s":"ATS-friendly configuration for resource HTTP commands.","h":"/reference/api/typescript/aspire.hosting/httpcommandexportoptions/","v":"13.4.0"},{"n":"HttpsCertificateExecutionConfigurationContext","f":"Aspire.Hosting.ApplicationModel.HttpsCertificateExecutionConfigurationContext","k":"type","p":"Aspire.Hosting","s":"Configuration context for server authentication certificate configuration.","h":"/reference/api/typescript/aspire.hosting/httpscertificateexecutionconfigurationcontext/","v":"13.4.0"},{"n":"ProcessCommandExportOptions","f":"Aspire.Hosting.ApplicationModel.ProcessCommandExportOptions","k":"type","p":"Aspire.Hosting","s":"ATS-friendly configuration for resource process commands.","h":"/reference/api/typescript/aspire.hosting/processcommandexportoptions/","v":"13.4.0"},{"n":"ProcessCommandResultExportOptions","f":"Aspire.Hosting.ApplicationModel.ProcessCommandResultExportOptions","k":"type","p":"Aspire.Hosting","s":"ATS-friendly result and command configuration for resource process commands.","h":"/reference/api/typescript/aspire.hosting/processcommandresultexportoptions/","v":"13.4.0"},{"n":"ProcessCommandSpecExportData","f":"Aspire.Hosting.ApplicationModel.ProcessCommandSpecExportData","k":"type","p":"Aspire.Hosting","s":"ATS-friendly process specification for resource process command callbacks.","h":"/reference/api/typescript/aspire.hosting/processcommandspecexportdata/","v":"13.4.0"},{"n":"ResourceUrlAnnotation","f":"Aspire.Hosting.ApplicationModel.ResourceUrlAnnotation","k":"type","p":"Aspire.Hosting","s":"A URL that should be displayed for a resource.","h":"/reference/api/typescript/aspire.hosting/resourceurlannotation/","v":"13.4.0"},{"n":"UpdateCommandStateResourceSnapshot","f":"Aspire.Hosting.ApplicationModel.UpdateCommandStateResourceSnapshot","k":"type","p":"Aspire.Hosting","s":"Resource snapshot data exposed to polyglot command state callbacks.","h":"/reference/api/typescript/aspire.hosting/updatecommandstateresourcesnapshot/","v":"13.4.0"},{"n":"AddContainerOptions","f":"Aspire.Hosting.Ats.AddContainerOptions","k":"type","p":"Aspire.Hosting","s":"Options for configuring a container image in polyglot apphosts.","h":"/reference/api/typescript/aspire.hosting/addcontaineroptions/","v":"13.4.0"},{"n":"CertificateTrustExecutionConfigurationExportData","f":"Aspire.Hosting.Ats.CertificateTrustExecutionConfigurationExportData","k":"type","p":"Aspire.Hosting","s":"ATS-friendly certificate trust data returned from an execution-configuration result.","h":"/reference/api/typescript/aspire.hosting/certificatetrustexecutionconfigurationexportdata/","v":"13.4.0"},{"n":"CreateBuilderOptions","f":"Aspire.Hosting.Ats.CreateBuilderOptions","k":"type","p":"Aspire.Hosting","s":"Options for creating a distributed application builder from polyglot apphosts.","h":"/reference/api/typescript/aspire.hosting/createbuilderoptions/","v":"13.4.0"},{"n":"HttpsCertificateExecutionConfigurationExportData","f":"Aspire.Hosting.Ats.HttpsCertificateExecutionConfigurationExportData","k":"type","p":"Aspire.Hosting","s":"ATS-friendly HTTPS certificate data returned from an execution-configuration result.","h":"/reference/api/typescript/aspire.hosting/httpscertificateexecutionconfigurationexportdata/","v":"13.4.0"},{"n":"HttpsCertificateInfo","f":"Aspire.Hosting.Ats.HttpsCertificateInfo","k":"type","p":"Aspire.Hosting","s":"ATS-friendly certificate metadata supplied to HTTPS certificate configuration callbacks.","h":"/reference/api/typescript/aspire.hosting/httpscertificateinfo/","v":"13.4.0"},{"n":"ParameterCustomInputOptions","f":"Aspire.Hosting.Ats.ParameterCustomInputOptions","k":"type","p":"Aspire.Hosting","s":"Options for customizing parameter inputs from polyglot app hosts.","h":"/reference/api/typescript/aspire.hosting/parametercustominputoptions/","v":"13.4.0"},{"n":"ReferenceEnvironmentInjectionOptions","f":"Aspire.Hosting.Ats.ReferenceEnvironmentInjectionOptions","k":"type","p":"Aspire.Hosting","s":"Options that control which reference information is injected into environment variables.","h":"/reference/api/typescript/aspire.hosting/referenceenvironmentinjectionoptions/","v":"13.4.0"},{"n":"ResourceEventDto","f":"Aspire.Hosting.Ats.ResourceEventDto","k":"type","p":"Aspire.Hosting","s":"DTO for resource events returned from notification service.","h":"/reference/api/typescript/aspire.hosting/resourceeventdto/","v":"13.4.0"},{"n":"InteractionInput","f":"Aspire.Hosting.InteractionInput","k":"type","p":"Aspire.Hosting","s":"Represents an input for an interaction.","h":"/reference/api/typescript/aspire.hosting/interactioninput/","v":"13.4.0"},{"n":"CertificateTrustScope","f":"Aspire.Hosting.ApplicationModel.CertificateTrustScope","k":"enum","p":"Aspire.Hosting","s":"Defines the scope of custom certificate authorities for a resource. The default scope for most resources is `Append`, but some resources may choose to override this default behavior.","h":"/reference/api/typescript/aspire.hosting/certificatetrustscope/","v":"13.4.0"},{"n":"CommandResultFormat","f":"Aspire.Hosting.ApplicationModel.CommandResultFormat","k":"enum","p":"Aspire.Hosting","s":"Specifies the format of a command result.","h":"/reference/api/typescript/aspire.hosting/commandresultformat/","v":"13.4.0"},{"n":"ContainerLifetime","f":"Aspire.Hosting.ApplicationModel.ContainerLifetime","k":"enum","p":"Aspire.Hosting","s":"Lifetime modes for container resources.","h":"/reference/api/typescript/aspire.hosting/containerlifetime/","v":"13.4.0"},{"n":"ContainerMountType","f":"Aspire.Hosting.ApplicationModel.ContainerMountType","k":"enum","p":"Aspire.Hosting","s":"Represents the type of a container mount.","h":"/reference/api/typescript/aspire.hosting/containermounttype/","v":"13.4.0"},{"n":"EndpointProperty","f":"Aspire.Hosting.ApplicationModel.EndpointProperty","k":"enum","p":"Aspire.Hosting","s":"Represents the properties of an endpoint that can be referenced.","h":"/reference/api/typescript/aspire.hosting/endpointproperty/","v":"13.4.0"},{"n":"HttpCommandResultMode","f":"Aspire.Hosting.ApplicationModel.HttpCommandResultMode","k":"enum","p":"Aspire.Hosting","s":"Specifies how an HTTP command should surface the HTTP response body as command result data.","h":"/reference/api/typescript/aspire.hosting/httpcommandresultmode/","v":"13.4.0"},{"n":"IconVariant","f":"Aspire.Hosting.ApplicationModel.IconVariant","k":"enum","p":"Aspire.Hosting","s":"The icon variant.","h":"/reference/api/typescript/aspire.hosting/iconvariant/","v":"13.4.0"},{"n":"ImagePullPolicy","f":"Aspire.Hosting.ApplicationModel.ImagePullPolicy","k":"enum","p":"Aspire.Hosting","s":"Image pull policies for container resources.","h":"/reference/api/typescript/aspire.hosting/imagepullpolicy/","v":"13.4.0"},{"n":"ProbeType","f":"Aspire.Hosting.ApplicationModel.ProbeType","k":"enum","p":"Aspire.Hosting","s":"Enum representing the type of probe.","h":"/reference/api/typescript/aspire.hosting/probetype/","v":"13.4.0"},{"n":"ResourceCommandState","f":"Aspire.Hosting.ApplicationModel.ResourceCommandState","k":"enum","p":"Aspire.Hosting","s":"The state of a resource command.","h":"/reference/api/typescript/aspire.hosting/resourcecommandstate/","v":"13.4.0"},{"n":"ResourceCommandVisibility","f":"Aspire.Hosting.ApplicationModel.ResourceCommandVisibility","k":"enum","p":"Aspire.Hosting","s":"Describes where a resource command is visible.","h":"/reference/api/typescript/aspire.hosting/resourcecommandvisibility/","v":"13.4.0"},{"n":"UrlDisplayLocation","f":"Aspire.Hosting.ApplicationModel.UrlDisplayLocation","k":"enum","p":"Aspire.Hosting","s":"Specifies where the URL should be displayed.","h":"/reference/api/typescript/aspire.hosting/urldisplaylocation/","v":"13.4.0"},{"n":"WaitBehavior","f":"Aspire.Hosting.ApplicationModel.WaitBehavior","k":"enum","p":"Aspire.Hosting","s":"Specifies the behavior of the wait.","h":"/reference/api/typescript/aspire.hosting/waitbehavior/","v":"13.4.0"},{"n":"DistributedApplicationOperation","f":"Aspire.Hosting.DistributedApplicationOperation","k":"enum","p":"Aspire.Hosting","s":"Describes the context in which the AppHost is being executed.","h":"/reference/api/typescript/aspire.hosting/distributedapplicationoperation/","v":"13.4.0"},{"n":"InputType","f":"Aspire.Hosting.InputType","k":"enum","p":"Aspire.Hosting","s":"Specifies the type of input for an `InteractionInput`.","h":"/reference/api/typescript/aspire.hosting/inputtype/","v":"13.4.0"},{"n":"OtlpProtocol","f":"Aspire.Hosting.OtlpProtocol","k":"enum","p":"Aspire.Hosting","s":"Protocols available for OTLP exporters.","h":"/reference/api/typescript/aspire.hosting/otlpprotocol/","v":"13.4.0"},{"n":"addAzureEnvironment","f":"addAzureEnvironment(): AzureEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure","s":"Adds an Azure environment resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure/addazureenvironment/","v":"13.4.0"},{"n":"addAzureInfrastructure","f":"addAzureInfrastructure(name: string, configureInfrastructure: (obj: AzureResourceInfrastructure) => Promise): AzureProvisioningResource","k":"method","p":"Aspire.Hosting.Azure","s":"Adds an Azure provisioning resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure/addazureinfrastructure/","v":"13.4.0"},{"n":"addAzureProvisioning","f":"addAzureProvisioning(): IDistributedApplicationBuilder","k":"method","p":"Aspire.Hosting.Azure","s":"Adds support for generating Azure resources dynamically during application startup. The application must configure the appropriate Azure subscription and location before resources can be provisioned.","h":"/reference/api/typescript/aspire.hosting.azure/addazureprovisioning/","v":"13.4.0"},{"n":"addAzureUserAssignedIdentity","f":"addAzureUserAssignedIdentity(name: string): AzureUserAssignedIdentityResource","k":"method","p":"Aspire.Hosting.Azure","s":"Adds an Azure user‑assigned identity resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure/addazureuserassignedidentity/","v":"13.4.0"},{"n":"addBicepTemplate","f":"addBicepTemplate(name: string, bicepFile: string): AzureBicepResource","k":"method","p":"Aspire.Hosting.Azure","s":"Adds an Azure Bicep resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure/addbiceptemplate/","v":"13.4.0"},{"n":"addBicepTemplateString","f":"addBicepTemplateString(name: string, bicepContent: string): AzureBicepResource","k":"method","p":"Aspire.Hosting.Azure","s":"Adds an Azure Bicep resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure/addbiceptemplatestring/","v":"13.4.0"},{"n":"asExisting","f":"asExisting(name: ParameterResource, resourceGroup?: ParameterResource): IAzureResource","k":"method","p":"Aspire.Hosting.Azure","s":"Marks the resource as an existing resource in both run and publish modes.","h":"/reference/api/typescript/aspire.hosting.azure/asexisting/","v":"13.4.0"},{"n":"clearDefaultRoleAssignments","f":"clearDefaultRoleAssignments(): IAzureResource","k":"method","p":"Aspire.Hosting.Azure","s":"Clears all default role assignments for the specified Azure resource.","h":"/reference/api/typescript/aspire.hosting.azure/cleardefaultroleassignments/","v":"13.4.0"},{"n":"configureInfrastructure","f":"configureInfrastructure(configure: (obj: AzureResourceInfrastructure) => Promise): AzureProvisioningResource","k":"method","p":"Aspire.Hosting.Azure","s":"Configures the Azure provisioning infrastructure callback","h":"/reference/api/typescript/aspire.hosting.azure/configureinfrastructure/","v":"13.4.0"},{"n":"getBicepIdentifier","f":"getBicepIdentifier(): string","k":"method","p":"Aspire.Hosting.Azure","s":"Gets the Bicep identifier for the Azure resource.","h":"/reference/api/typescript/aspire.hosting.azure/getbicepidentifier/","v":"13.4.0"},{"n":"getOutput","f":"getOutput(name: string): BicepOutputReference","k":"method","p":"Aspire.Hosting.Azure","s":"Gets a reference to an output from a bicep template.","h":"/reference/api/typescript/aspire.hosting.azure/getoutput/","v":"13.4.0"},{"n":"isExisting","f":"isExisting(): boolean","k":"method","p":"Aspire.Hosting.Azure","s":"Determines whether the Azure resource is marked as existing.","h":"/reference/api/typescript/aspire.hosting.azure/isexisting/","v":"13.4.0"},{"n":"publishAsConnectionString","f":"publishAsConnectionString(): IAzureResource","k":"method","p":"Aspire.Hosting.Azure","s":"Changes the resource to be published as a connection string reference in the manifest.","h":"/reference/api/typescript/aspire.hosting.azure/publishasconnectionstring/","v":"13.4.0"},{"n":"publishAsExisting","f":"publishAsExisting(name: ParameterResource, resourceGroup?: ParameterResource): IAzureResource","k":"method","p":"Aspire.Hosting.Azure","s":"Marks the resource as an existing resource when the application is deployed.","h":"/reference/api/typescript/aspire.hosting.azure/publishasexisting/","v":"13.4.0"},{"n":"runAsExisting","f":"runAsExisting(name: ParameterResource, resourceGroup?: ParameterResource): IAzureResource","k":"method","p":"Aspire.Hosting.Azure","s":"Marks the resource as an existing resource when the application is running.","h":"/reference/api/typescript/aspire.hosting.azure/runasexisting/","v":"13.4.0"},{"n":"withAzureUserAssignedIdentity","f":"withAzureUserAssignedIdentity(identityResourceBuilder: AzureUserAssignedIdentityResource): IComputeResource","k":"method","p":"Aspire.Hosting.Azure","s":"Associates an Azure user-assigned identity with a compute resource","h":"/reference/api/typescript/aspire.hosting.azure/withazureuserassignedidentity/","v":"13.4.0"},{"n":"withLocation","f":"withLocation(location: ParameterResource): AzureEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure","s":"Sets the location of the Azure environment resource.","h":"/reference/api/typescript/aspire.hosting.azure/withlocation/","v":"13.4.0"},{"n":"withParameter","f":"withParameter(name: string, value?: EndpointReference): AzureBicepResource","k":"method","p":"Aspire.Hosting.Azure","s":"Adds a Bicep parameter","h":"/reference/api/typescript/aspire.hosting.azure/withparameter/","v":"13.4.0"},{"n":"withResourceGroup","f":"withResourceGroup(resourceGroup: ParameterResource): AzureEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure","s":"Sets the resource group name of the Azure environment resource.","h":"/reference/api/typescript/aspire.hosting.azure/withresourcegroup/","v":"13.4.0"},{"n":"IAzureResource","f":"Aspire.Hosting.ApplicationModel.IAzureResource","k":"interface","p":"Aspire.Hosting.Azure","s":"Represents an Azure resource, as a marker interface for {@ats-ref type:IResource}'s that can be deployed to an Azure resource group.","h":"/reference/api/typescript/aspire.hosting.azure/iazureresource/","v":"13.4.0"},{"n":"AzureBicepResource","f":"Aspire.Hosting.Azure.AzureBicepResource","k":"handle","p":"Aspire.Hosting.Azure","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure/azurebicepresource/","v":"13.4.0"},{"n":"AzureEnvironmentResource","f":"Aspire.Hosting.Azure.AzureEnvironmentResource","k":"handle","p":"Aspire.Hosting.Azure","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure/azureenvironmentresource/","v":"13.4.0"},{"n":"AzureProvisioningResource","f":"Aspire.Hosting.Azure.AzureProvisioningResource","k":"handle","p":"Aspire.Hosting.Azure","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure/azureprovisioningresource/","v":"13.4.0"},{"n":"AzureResourceInfrastructure","f":"Aspire.Hosting.Azure.AzureResourceInfrastructure","k":"handle","p":"Aspire.Hosting.Azure","s":"An Azure Provisioning {@ats-ref type:Infrastructure} which represents the root Bicep module that is generated for an Azure resource.","h":"/reference/api/typescript/aspire.hosting.azure/azureresourceinfrastructure/","v":"13.4.0"},{"n":"AzureUserAssignedIdentityResource","f":"Aspire.Hosting.Azure.AzureUserAssignedIdentityResource","k":"handle","p":"Aspire.Hosting.Azure","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure/azureuserassignedidentityresource/","v":"13.4.0"},{"n":"BicepOutputReference","f":"Aspire.Hosting.Azure.BicepOutputReference","k":"handle","p":"Aspire.Hosting.Azure","s":"A reference to an output from a bicep template.","h":"/reference/api/typescript/aspire.hosting.azure/bicepoutputreference/","v":"13.4.0"},{"n":"name","f":"BicepOutputReference.name(): string","k":"property","p":"Aspire.Hosting.Azure","s":"Name of the output.","t":"BicepOutputReference","h":"/reference/api/typescript/aspire.hosting.azure/bicepoutputreference/#name","m":true,"v":"13.4.0"},{"n":"value","f":"BicepOutputReference.value(): string","k":"property","p":"Aspire.Hosting.Azure","s":"The value of the output.","t":"BicepOutputReference","h":"/reference/api/typescript/aspire.hosting.azure/bicepoutputreference/#value","m":true,"v":"13.4.0"},{"n":"valueExpression","f":"BicepOutputReference.valueExpression(): string","k":"property","p":"Aspire.Hosting.Azure","s":"The expression used in the manifest to reference the value of the output.","t":"BicepOutputReference","h":"/reference/api/typescript/aspire.hosting.azure/bicepoutputreference/#valueexpression","m":true,"v":"13.4.0"},{"n":"IAzureKeyVaultResource","f":"Aspire.Hosting.Azure.IAzureKeyVaultResource","k":"interface","p":"Aspire.Hosting.Azure","s":"Represents a resource that represents an Azure Key Vault.","h":"/reference/api/typescript/aspire.hosting.azure/iazurekeyvaultresource/","v":"13.4.0"},{"n":"IAzureKeyVaultSecretReference","f":"Aspire.Hosting.Azure.IAzureKeyVaultSecretReference","k":"interface","p":"Aspire.Hosting.Azure","s":"Represents a reference to a secret in an Azure Key Vault resource.","h":"/reference/api/typescript/aspire.hosting.azure/iazurekeyvaultsecretreference/","v":"13.4.0"},{"n":"addAzureAppConfiguration","f":"addAzureAppConfiguration(name: string): AzureAppConfigurationResource","k":"method","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Adds an Azure App Configuration resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/addazureappconfiguration/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureEmulator?: (obj: AzureAppConfigurationEmulatorResource) => Promise): AzureAppConfigurationResource","k":"method","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Configures Azure App Configuration to run with the local emulator","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/runasemulator/","v":"13.4.0"},{"n":"withAppConfigurationRoleAssignments","f":"withAppConfigurationRoleAssignments(target: AzureAppConfigurationResource, roles: AzureAppConfigurationRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure App Configuration resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/withappconfigurationroleassignments/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(path?: string): AzureAppConfigurationEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Adds a bind mount for the storage of an Azure App Configuration emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): AzureAppConfigurationEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Adds a named volume for the data folder to an Azure App Configuration emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): AzureAppConfigurationEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Configures the host port for the Azure App Configuration emulator is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/withhostport/","v":"13.4.0"},{"n":"AzureAppConfigurationEmulatorResource","f":"Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/azureappconfigurationemulatorresource/","v":"13.4.0"},{"n":"AzureAppConfigurationResource","f":"Aspire.Hosting.Azure.AzureAppConfigurationResource","k":"handle","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/azureappconfigurationresource/","v":"13.4.0"},{"n":"AzureAppConfigurationRole","f":"Aspire.Hosting.AzureAppConfigurationRole","k":"enum","p":"Aspire.Hosting.Azure.AppConfiguration","s":"Represents Azure App Configuration roles that are compatible with the Aspire Type System (ATS).","h":"/reference/api/typescript/aspire.hosting.azure.appconfiguration/azureappconfigurationrole/","v":"13.4.0"},{"n":"addAzureContainerAppEnvironment","f":"addAzureContainerAppEnvironment(name: string): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Adds a container app environment resource to the distributed application builder.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/addazurecontainerappenvironment/","v":"13.4.0"},{"n":"configureCustomDomain","f":"configureCustomDomain(customDomain: ParameterResource, certificateName: ParameterResource): void","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the custom domain for the container app.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/configurecustomdomain/","v":"13.4.0"},{"n":"configureScale","f":"configureScale(scale: AzureContainerAppScaleConfig): void","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures supported Azure Container App scale settings.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/configurescale/","v":"13.4.0"},{"n":"publishAsAzureContainerApp","f":"publishAsAzureContainerApp(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerApp) => Promise): ContainerResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Publishes the specified container resource as a container app.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/publishasazurecontainerapp-aspire-hosting-applicationmodel-containerresource-arg1-azureresourceinfrastructure-arg2-containerapp-promise-void/","v":"13.4.0"},{"n":"publishAsAzureContainerApp","f":"publishAsAzureContainerApp(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerApp) => Promise): ExecutableResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Publishes the specified container resource as a container app.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/publishasazurecontainerapp-aspire-hosting-applicationmodel-executableresource-arg1-azureresourceinfrastructure-arg2-containerapp-promise-void/","v":"13.4.0"},{"n":"publishAsAzureContainerApp","f":"publishAsAzureContainerApp(configure: (arg1: AzureResourceInfrastructure, arg2: ContainerApp) => Promise): ProjectResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Allows configuring the specified project resource as a container app.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/publishasazurecontainerapp-aspire-hosting-applicationmodel-projectresource-arg1-azureresourceinfrastructure-arg2-containerapp-promise-void/","v":"13.4.0"},{"n":"publishAsAzureContainerAppJob","f":"publishAsAzureContainerAppJob(configure?: (arg1: AzureResourceInfrastructure, arg2: ContainerAppJob) => Promise): IComputeResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the compute resource as an Azure Container App Job","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/publishasazurecontainerappjob/","v":"13.4.0"},{"n":"publishAsScheduledAzureContainerAppJob","f":"publishAsScheduledAzureContainerAppJob(cronExpression: string, configure?: (arg1: AzureResourceInfrastructure, arg2: ContainerAppJob) => Promise): IComputeResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the compute resource as a scheduled Azure Container App Job","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/publishasscheduledazurecontainerappjob/","v":"13.4.0"},{"n":"withAcrPullIdentity","f":"withAcrPullIdentity(identityBuilder: AzureUserAssignedIdentityResource): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the container app environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that container apps in the environment use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/withacrpullidentity/","v":"13.4.0"},{"n":"withAzdResourceNaming","f":"withAzdResourceNaming(): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the container app environment resources to use the same naming conventions as azd.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/withazdresourcenaming/","v":"13.4.0"},{"n":"withAzureLogAnalyticsWorkspace","f":"withAzureLogAnalyticsWorkspace(workspaceBuilder: AzureLogAnalyticsWorkspaceResource): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the container app environment resource to use the specified Log Analytics Workspace.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/withazureloganalyticsworkspace/","v":"13.4.0"},{"n":"withCompactResourceNaming","f":"withCompactResourceNaming(): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures the container app environment to use compact resource naming that maximally preserves the `uniqueString` suffix for length-constrained Azure resources such as storage accounts.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/withcompactresourcenaming/","v":"13.4.0"},{"n":"withDashboard","f":"withDashboard(enable?: boolean): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures whether the Aspire dashboard should be included in the container app environment.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/withdashboard/","v":"13.4.0"},{"n":"withHttpsUpgrade","f":"withHttpsUpgrade(upgrade?: boolean): AzureContainerAppEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppContainers","s":"Configures whether HTTP endpoints should be upgraded to HTTPS in Azure Container Apps. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/withhttpsupgrade/","v":"13.4.0"},{"n":"AzureContainerAppEnvironmentResource","f":"Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource","k":"handle","p":"Aspire.Hosting.Azure.AppContainers","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/azurecontainerappenvironmentresource/","v":"13.4.0"},{"n":"AzureContainerAppScaleConfig","f":"Aspire.Hosting.Azure.AzureContainerAppScaleConfig","k":"type","p":"Aspire.Hosting.Azure.AppContainers","s":"Polyglot-friendly subset of Azure Container App scale configuration.","h":"/reference/api/typescript/aspire.hosting.azure.appcontainers/azurecontainerappscaleconfig/","v":"13.4.0"},{"n":"addAzureApplicationInsights","f":"addAzureApplicationInsights(name: string): AzureApplicationInsightsResource","k":"method","p":"Aspire.Hosting.Azure.ApplicationInsights","s":"Adds an Azure Application Insights resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.applicationinsights/addazureapplicationinsights/","v":"13.4.0"},{"n":"withLogAnalyticsWorkspace","f":"withLogAnalyticsWorkspace(logAnalyticsWorkspace: AzureLogAnalyticsWorkspaceResource): AzureApplicationInsightsResource","k":"method","p":"Aspire.Hosting.Azure.ApplicationInsights","s":"Configures the Application Insights resource to use the specified Log Analytics Workspace resource.","h":"/reference/api/typescript/aspire.hosting.azure.applicationinsights/withloganalyticsworkspace/","v":"13.4.0"},{"n":"AzureApplicationInsightsResource","f":"Aspire.Hosting.Azure.AzureApplicationInsightsResource","k":"handle","p":"Aspire.Hosting.Azure.ApplicationInsights","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.applicationinsights/azureapplicationinsightsresource/","v":"13.4.0"},{"n":"addAzureAppServiceEnvironment","f":"addAzureAppServiceEnvironment(name: string): AzureAppServiceEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Adds a azure app service environment resource to the distributed application builder.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/addazureappserviceenvironment/","v":"13.4.0"},{"n":"configureSiteConfig","f":"configureSiteConfig(siteConfig: AzureAppServiceSiteConfig): void","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Configures supported Azure App Service site settings.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/configuresiteconfig/","v":"13.4.0"},{"n":"configureSlotSiteConfig","f":"configureSlotSiteConfig(siteConfig: AzureAppServiceSiteConfig): void","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Configures supported Azure App Service deployment slot site settings.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/configureslotsiteconfig/","v":"13.4.0"},{"n":"publishAsAzureAppServiceWebsite","f":"publishAsAzureAppServiceWebsite(configure?: (arg1: AzureResourceInfrastructure, arg2: WebSite) => Promise, configureSlot?: (arg1: AzureResourceInfrastructure, arg2: WebSiteSlot) => Promise): IComputeResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Publishes the specified compute resource as an Azure App Service or Azure App Service Slot.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/publishasazureappservicewebsite/","v":"13.4.0"},{"n":"skipEnvironmentVariableNameChecks","f":"skipEnvironmentVariableNameChecks(): IComputeResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Skips validation for environment variable names that Azure App Service may not support.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/skipenvironmentvariablenamechecks/","v":"13.4.0"},{"n":"withAcrPullIdentity","f":"withAcrPullIdentity(identityBuilder: AzureUserAssignedIdentityResource): AzureAppServiceEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Configures the Azure App Service environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that App Service apps use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/withacrpullidentity/","v":"13.4.0"},{"n":"withAzureApplicationInsights","f":"withAzureApplicationInsights(applicationInsights?: AzureApplicationInsightsResource): AzureAppServiceEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Enables Azure Application Insights for the Azure App Service environment","h":"/reference/api/typescript/aspire.hosting.azure.appservice/withazureapplicationinsights/","v":"13.4.0"},{"n":"withDashboard","f":"withDashboard(enable?: boolean): AzureAppServiceEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Configures whether the Aspire dashboard should be included in the Azure App Service environment.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/withdashboard/","v":"13.4.0"},{"n":"withDeploymentSlot","f":"withDeploymentSlot(deploymentSlot: ParameterResource): AzureAppServiceEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Configures the deployment slot for all Azure App Services in the environment","h":"/reference/api/typescript/aspire.hosting.azure.appservice/withdeploymentslot/","v":"13.4.0"},{"n":"withHttpsUpgrade","f":"withHttpsUpgrade(upgrade?: boolean): AzureAppServiceEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.AppService","s":"Configures whether HTTP endpoints should be automatically upgraded to HTTPS for the Azure App Service environment. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/withhttpsupgrade/","v":"13.4.0"},{"n":"AzureAppServiceEnvironmentResource","f":"Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource","k":"handle","p":"Aspire.Hosting.Azure.AppService","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.appservice/azureappserviceenvironmentresource/","v":"13.4.0"},{"n":"AzureAppServiceSiteConfig","f":"Aspire.Hosting.Azure.AzureAppServiceSiteConfig","k":"type","p":"Aspire.Hosting.Azure.AppService","s":"Polyglot-friendly subset of Azure App Service site configuration.","h":"/reference/api/typescript/aspire.hosting.azure.appservice/azureappservicesiteconfig/","v":"13.4.0"},{"n":"addAzureOpenAI","f":"addAzureOpenAI(name: string): AzureOpenAIResource","k":"method","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Adds an Azure OpenAI resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/addazureopenai/","v":"13.4.0"},{"n":"addDeployment","f":"addDeployment(name: string, modelName: string, modelVersion: string): AzureOpenAIDeploymentResource","k":"method","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Adds an Azure OpenAI deployment resource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/adddeployment/","v":"13.4.0"},{"n":"withCognitiveServicesRoleAssignments","f":"withCognitiveServicesRoleAssignments(target: AzureOpenAIResource, roles: AzureOpenAIRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure OpenAI resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/withcognitiveservicesroleassignments/","v":"13.4.0"},{"n":"withProperties","f":"withProperties(configure: (obj: AzureOpenAIDeploymentResource) => Promise): AzureOpenAIDeploymentResource","k":"method","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Allows setting the properties of an Azure OpenAI Deployment resource.","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/withproperties/","v":"13.4.0"},{"n":"AzureOpenAIDeploymentResource","f":"Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource","k":"handle","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Represents an Azure OpenAI Deployment resource.","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureOpenAIDeploymentResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets the connection string expression for the Azure OpenAI Deployment resource.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"deploymentName","f":"AzureOpenAIDeploymentResource.deploymentName(): string","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets or sets the name of the deployment.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#deploymentname","m":true,"v":"13.4.0"},{"n":"modelName","f":"AzureOpenAIDeploymentResource.modelName(): string","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets the name of the model.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#modelname","m":true,"v":"13.4.0"},{"n":"modelVersion","f":"AzureOpenAIDeploymentResource.modelVersion(): string","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets the version of the model.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#modelversion","m":true,"v":"13.4.0"},{"n":"parent","f":"AzureOpenAIDeploymentResource.parent(): AzureOpenAIResource","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets the parent Azure OpenAI resource.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#parent","m":true,"v":"13.4.0"},{"n":"skuCapacity","f":"AzureOpenAIDeploymentResource.skuCapacity(): number","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets the capacity of the SKU.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#skucapacity","m":true,"v":"13.4.0"},{"n":"skuName","f":"AzureOpenAIDeploymentResource.skuName(): string","k":"property","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Gets the name of the SKU.","t":"AzureOpenAIDeploymentResource","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenaideploymentresource/#skuname","m":true,"v":"13.4.0"},{"n":"AzureOpenAIResource","f":"Aspire.Hosting.ApplicationModel.AzureOpenAIResource","k":"handle","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Represents an Azure OpenAI resource.","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenairesource/","v":"13.4.0"},{"n":"AzureOpenAIRole","f":"Aspire.Hosting.Azure.CognitiveServices.AzureOpenAIRole","k":"enum","p":"Aspire.Hosting.Azure.CognitiveServices","s":"Represents ATS-compatible Azure OpenAI roles.","h":"/reference/api/typescript/aspire.hosting.azure.cognitiveservices/azureopenairole/","v":"13.4.0"},{"n":"addAzureContainerRegistry","f":"addAzureContainerRegistry(name: string): AzureContainerRegistryResource","k":"method","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Adds an Azure Container Registry resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/addazurecontainerregistry/","v":"13.4.0"},{"n":"getAzureContainerRegistry","f":"getAzureContainerRegistry(): AzureContainerRegistryResource","k":"method","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Gets the Azure Container Registry associated with a compute environment resource.","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/getazurecontainerregistry/","v":"13.4.0"},{"n":"withAzureContainerRegistry","f":"withAzureContainerRegistry(registryBuilder: AzureContainerRegistryResource): IResource","k":"method","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Configures a compute environment resource to use an Azure Container Registry.","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/withazurecontainerregistry/","v":"13.4.0"},{"n":"withContainerRegistryRoleAssignments","f":"withContainerRegistryRoleAssignments(target: AzureContainerRegistryResource, roles: AzureContainerRegistryRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Adds role assignments to the specified Azure Container Registry resource.","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/withcontainerregistryroleassignments/","v":"13.4.0"},{"n":"withPurgeTask","f":"withPurgeTask(schedule: string, filter?: string, ago?: timespan, keep?: number, taskName?: string): AzureContainerRegistryResource","k":"method","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Adds a scheduled ACR purge task to remove old or unused container images from the registry.","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/withpurgetask/","v":"13.4.0"},{"n":"AzureContainerRegistryResource","f":"Aspire.Hosting.Azure.AzureContainerRegistryResource","k":"handle","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/azurecontainerregistryresource/","v":"13.4.0"},{"n":"AzureContainerRegistryRole","f":"Aspire.Hosting.AzureContainerRegistryRole","k":"enum","p":"Aspire.Hosting.Azure.ContainerRegistry","s":"Represents ATS-compatible Azure Container Registry roles.","h":"/reference/api/typescript/aspire.hosting.azure.containerregistry/azurecontainerregistryrole/","v":"13.4.0"},{"n":"addAzureCosmosDB","f":"addAzureCosmosDB(name: string): AzureCosmosDBResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Adds an Azure Cosmos DB connection to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/addazurecosmosdb/","v":"13.4.0"},{"n":"addContainer","f":"addContainer(name: string, partitionKeyPaths: string|string[], containerName?: string): AzureCosmosDBContainerResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Adds an Azure Cosmos DB container resource","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/addcontainer/","v":"13.4.0"},{"n":"addCosmosDatabase","f":"addCosmosDatabase(name: string, databaseName?: string): AzureCosmosDBDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Adds a database to the associated Cosmos DB account resource.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/addcosmosdatabase/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise): AzureCosmosDBResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures the Azure Cosmos DB resource to run using the local emulator","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/runasemulator/","v":"13.4.0"},{"n":"runAsPreviewEmulator","f":"runAsPreviewEmulator(configureContainer?: (obj: AzureCosmosDBEmulatorResource) => Promise): AzureCosmosDBResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures the Azure Cosmos DB resource to run using the preview emulator","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/runaspreviewemulator/","v":"13.4.0"},{"n":"withAccessKeyAuthentication","f":"withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureCosmosDBResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures Azure Cosmos DB to use access key authentication","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/withaccesskeyauthentication/","v":"13.4.0"},{"n":"withDataExplorer","f":"withDataExplorer(port?: number): AzureCosmosDBEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures the Azure Cosmos DB preview emulator to expose the Data Explorer endpoint.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/withdataexplorer/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): AzureCosmosDBEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Adds a named volume for the data folder to an Azure Cosmos DB emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/withdatavolume/","v":"13.4.0"},{"n":"withDefaultAzureSku","f":"withDefaultAzureSku(): AzureCosmosDBResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/withdefaultazuresku/","v":"13.4.0"},{"n":"withGatewayPort","f":"withGatewayPort(port: number): AzureCosmosDBEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures the gateway port for the Azure Cosmos DB emulator.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/withgatewayport/","v":"13.4.0"},{"n":"withPartitionCount","f":"withPartitionCount(count: number): AzureCosmosDBEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.CosmosDB","s":"Configures the partition count for the Azure Cosmos DB emulator.","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/withpartitioncount/","v":"13.4.0"},{"n":"AzureCosmosDBContainerResource","f":"Aspire.Hosting.Azure.AzureCosmosDBContainerResource","k":"handle","p":"Aspire.Hosting.Azure.CosmosDB","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/azurecosmosdbcontainerresource/","v":"13.4.0"},{"n":"AzureCosmosDBDatabaseResource","f":"Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource","k":"handle","p":"Aspire.Hosting.Azure.CosmosDB","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/azurecosmosdbdatabaseresource/","v":"13.4.0"},{"n":"AzureCosmosDBEmulatorResource","f":"Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.CosmosDB","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/azurecosmosdbemulatorresource/","v":"13.4.0"},{"n":"AzureCosmosDBResource","f":"Aspire.Hosting.AzureCosmosDBResource","k":"handle","p":"Aspire.Hosting.Azure.CosmosDB","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.cosmosdb/azurecosmosdbresource/","v":"13.4.0"},{"n":"addAzureEventHubs","f":"addAzureEventHubs(name: string): AzureEventHubsResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Adds an Azure Event Hubs Namespace resource to the application model. This resource can be used to create Event Hub resources.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/addazureeventhubs/","v":"13.4.0"},{"n":"addConsumerGroup","f":"addConsumerGroup(name: string, groupName?: string): AzureEventHubConsumerGroupResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Adds an Azure Event Hub Consumer Group resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/addconsumergroup/","v":"13.4.0"},{"n":"addHub","f":"addHub(name: string, hubName?: string): AzureEventHubResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Adds an Azure Event Hubs hub resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/addhub/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: AzureEventHubsEmulatorResource) => Promise): AzureEventHubsResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Configures the Azure Event Hubs resource to run with the local emulator","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/runasemulator/","v":"13.4.0"},{"n":"withConfigurationFile","f":"withConfigurationFile(path: string): AzureEventHubsEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Adds a bind mount for the configuration file of an Azure Event Hubs emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/withconfigurationfile/","v":"13.4.0"},{"n":"withEventHubsRoleAssignments","f":"withEventHubsRoleAssignments(target: AzureEventHubsResource, roles: AzureEventHubsRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Event Hubs Namespace resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/witheventhubsroleassignments/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): AzureEventHubsEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Configures the host port for the Azure Event Hubs emulator is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/withhostport/","v":"13.4.0"},{"n":"withProperties","f":"withProperties(configure: (obj: AzureEventHubResource) => Promise): AzureEventHubResource","k":"method","p":"Aspire.Hosting.Azure.EventHubs","s":"Allows setting the properties of an Azure Event Hub resource.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/withproperties/","v":"13.4.0"},{"n":"AzureEventHubConsumerGroupResource","f":"Aspire.Hosting.Azure.AzureEventHubConsumerGroupResource","k":"handle","p":"Aspire.Hosting.Azure.EventHubs","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubconsumergroupresource/","v":"13.4.0"},{"n":"AzureEventHubResource","f":"Aspire.Hosting.Azure.AzureEventHubResource","k":"handle","p":"Aspire.Hosting.Azure.EventHubs","s":"Represents an Azure Event Hub. Initializes a new instance of the {@ats-ref type:AzureEventHubResource} class.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureEventHubResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.EventHubs","s":"Gets the connection string expression for the Azure Event Hub.","t":"AzureEventHubResource","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"hubName","f":"AzureEventHubResource.hubName(): string","k":"property","p":"Aspire.Hosting.Azure.EventHubs","s":"The event hub name.","t":"AzureEventHubResource","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource/#hubname","m":true,"v":"13.4.0"},{"n":"parent","f":"AzureEventHubResource.parent(): AzureEventHubsResource","k":"property","p":"Aspire.Hosting.Azure.EventHubs","s":"Gets the parent Azure Event Hubs resource.","t":"AzureEventHubResource","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource/#parent","m":true,"v":"13.4.0"},{"n":"partitionCount","f":"AzureEventHubResource.partitionCount(): number","k":"property","p":"Aspire.Hosting.Azure.EventHubs","s":"Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.","t":"AzureEventHubResource","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubresource/#partitioncount","m":true,"v":"13.4.0"},{"n":"AzureEventHubsEmulatorResource","f":"Aspire.Hosting.Azure.AzureEventHubsEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.EventHubs","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsemulatorresource/","v":"13.4.0"},{"n":"AzureEventHubsResource","f":"Aspire.Hosting.Azure.AzureEventHubsResource","k":"handle","p":"Aspire.Hosting.Azure.EventHubs","s":"Represents an Azure Event Hubs resource.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsresource/","v":"13.4.0"},{"n":"AzureEventHubsRole","f":"Aspire.Hosting.AzureEventHubsRole","k":"enum","p":"Aspire.Hosting.Azure.EventHubs","s":"Represents ATS-compatible Azure Event Hubs roles.","h":"/reference/api/typescript/aspire.hosting.azure.eventhubs/azureeventhubsrole/","v":"13.4.0"},{"n":"addAzureFrontDoor","f":"addAzureFrontDoor(name: string): AzureFrontDoorResource","k":"method","p":"Aspire.Hosting.Azure.FrontDoor","s":"Adds an Azure Front Door resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.frontdoor/addazurefrontdoor/","v":"13.4.0-preview.1.26281.18"},{"n":"withOrigin","f":"withOrigin(resource: IComputeResource): AzureFrontDoorResource","k":"method","p":"Aspire.Hosting.Azure.FrontDoor","s":"Adds an origin (backend) to the Azure Front Door resource. Each origin gets its own Front Door endpoint with a distinct `*.azurefd.net` hostname, its own origin group, and a default route.","h":"/reference/api/typescript/aspire.hosting.azure.frontdoor/withorigin/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureFrontDoorResource","f":"Aspire.Hosting.Azure.AzureFrontDoorResource","k":"handle","p":"Aspire.Hosting.Azure.FrontDoor","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.frontdoor/azurefrontdoorresource/","v":"13.4.0-preview.1.26281.18"},{"n":"addAzureFunctionsProject","f":"addAzureFunctionsProject(name: string, projectPath: string): AzureFunctionsProjectResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Adds an Azure Functions project to the distributed application.","h":"/reference/api/typescript/aspire.hosting.azure.functions/addazurefunctionsproject/","v":"13.4.0"},{"n":"addDurableTaskScheduler","f":"addDurableTaskScheduler(name: string): DurableTaskSchedulerResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Adds a Durable Task scheduler resource to the distributed application.","h":"/reference/api/typescript/aspire.hosting.azure.functions/adddurabletaskscheduler/","v":"13.4.0"},{"n":"addTaskHub","f":"addTaskHub(name: string): DurableTaskHubResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Adds a Durable Task hub resource associated with the specified scheduler.","h":"/reference/api/typescript/aspire.hosting.azure.functions/addtaskhub/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: DurableTaskSchedulerEmulatorResource) => Promise): DurableTaskSchedulerResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Configures the Durable Task scheduler to run using the local emulator (only in non-publish modes).","h":"/reference/api/typescript/aspire.hosting.azure.functions/runasemulator/","v":"13.4.0"},{"n":"runAsExisting","f":"runAsExisting(connectionString: ParameterResource): DurableTaskSchedulerResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Configures the Durable Task scheduler to use an existing scheduler instance from a connection string or parameter resource.","h":"/reference/api/typescript/aspire.hosting.azure.functions/runasexisting/","v":"13.4.0"},{"n":"withHostStorage","f":"withHostStorage(storage: AzureStorageResource): AzureFunctionsProjectResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Configures the Azure Functions project resource to use the specified Azure Storage resource as its host storage.","h":"/reference/api/typescript/aspire.hosting.azure.functions/withhoststorage/","v":"13.4.0"},{"n":"withTaskHubName","f":"withTaskHubName(taskHubName: ParameterResource): DurableTaskHubResource","k":"method","p":"Aspire.Hosting.Azure.Functions","s":"Sets the Durable Task hub name from a string or parameter resource.","h":"/reference/api/typescript/aspire.hosting.azure.functions/withtaskhubname/","v":"13.4.0"},{"n":"AzureFunctionsProjectResource","f":"Aspire.Hosting.Azure.AzureFunctionsProjectResource","k":"handle","p":"Aspire.Hosting.Azure.Functions","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.functions/azurefunctionsprojectresource/","v":"13.4.0"},{"n":"DurableTaskHubResource","f":"Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource","k":"handle","p":"Aspire.Hosting.Azure.Functions","s":"Represents a Durable Task hub resource. A Task Hub groups durable orchestrations and activities. This resource extends the scheduler connection string with the TaskHub name so that clients can connect to the correct hub.","h":"/reference/api/typescript/aspire.hosting.azure.functions/durabletaskhubresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"DurableTaskHubResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Functions","s":"Gets the connection string expression composed of the scheduler connection string and the TaskHub name.","t":"DurableTaskHubResource","h":"/reference/api/typescript/aspire.hosting.azure.functions/durabletaskhubresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"taskHubName","f":"DurableTaskHubResource.taskHubName(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Functions","s":"Gets the name of the Task Hub. If not provided, the logical name of this resource is returned.","t":"DurableTaskHubResource","h":"/reference/api/typescript/aspire.hosting.azure.functions/durabletaskhubresource/#taskhubname","m":true,"v":"13.4.0"},{"n":"DurableTaskSchedulerEmulatorResource","f":"Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.Functions","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.functions/durabletaskscheduleremulatorresource/","v":"13.4.0"},{"n":"DurableTaskSchedulerResource","f":"Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource","k":"handle","p":"Aspire.Hosting.Azure.Functions","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.functions/durabletaskschedulerresource/","v":"13.4.0"},{"n":"addAzureKeyVault","f":"addAzureKeyVault(name: string): AzureKeyVaultResource","k":"method","p":"Aspire.Hosting.Azure.KeyVault","s":"Adds an Azure Key Vault resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/addazurekeyvault/","v":"13.4.0"},{"n":"addSecret","f":"addSecret(name: string, value: ReferenceExpression, secretName?: string): AzureKeyVaultSecretResource","k":"method","p":"Aspire.Hosting.Azure.KeyVault","s":"Adds a secret to the Azure Key Vault","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/addsecret/","v":"13.4.0"},{"n":"getSecret","f":"getSecret(secretName: string): IAzureKeyVaultSecretReference","k":"method","p":"Aspire.Hosting.Azure.KeyVault","s":"Gets a secret reference for the specified secret name from the Azure Key Vault resource.","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/getsecret/","v":"13.4.0"},{"n":"withKeyVaultRoleAssignments","f":"withKeyVaultRoleAssignments(target: AzureKeyVaultResource, roles: AzureKeyVaultRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.KeyVault","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Key Vault resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/withkeyvaultroleassignments/","v":"13.4.0"},{"n":"AzureKeyVaultResource","f":"Aspire.Hosting.Azure.AzureKeyVaultResource","k":"handle","p":"Aspire.Hosting.Azure.KeyVault","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/azurekeyvaultresource/","v":"13.4.0"},{"n":"AzureKeyVaultSecretResource","f":"Aspire.Hosting.Azure.AzureKeyVaultSecretResource","k":"handle","p":"Aspire.Hosting.Azure.KeyVault","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/azurekeyvaultsecretresource/","v":"13.4.0"},{"n":"AzureKeyVaultRole","f":"Aspire.Hosting.AzureKeyVaultRole","k":"enum","p":"Aspire.Hosting.Azure.KeyVault","s":"Represents ATS-compatible Key Vault roles.","h":"/reference/api/typescript/aspire.hosting.azure.keyvault/azurekeyvaultrole/","v":"13.4.0"},{"n":"addAzureKubernetesEnvironment","f":"addAzureKubernetesEnvironment(name: string): AzureKubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Adds an Azure Kubernetes Service (AKS) environment to the distributed application. This provisions an AKS cluster and configures it as a Kubernetes compute environment.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addazurekubernetesenvironment/","v":"13.4.0-preview.1.26281.18"},{"n":"addCertManager","f":"addCertManager(name: string, chartVersion?: string): CertManagerResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Installs cert-manager into an AKS environment","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addcertmanager/","v":"13.4.0-preview.1.26281.18"},{"n":"addGateway","f":"addGateway(name: string): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Adds a Kubernetes Gateway API Gateway resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addgateway/","v":"13.4.0-preview.1.26281.18"},{"n":"addHelmChart","f":"addHelmChart(name: string, chartReference: string, chartVersion: string): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Adds an external Helm chart to be installed in the AKS environment's inner Kubernetes environment. The chart is installed via `helm upgrade --install` as a pipeline step after the main application Helm chart is deployed.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addhelmchart/","v":"13.4.0-preview.1.26281.18"},{"n":"addIngress","f":"addIngress(name: string): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Adds a Kubernetes Ingress resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment. The ingress generates a `networking.k8s.io/v1 Ingress` resource in the Helm chart output at publish time.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addingress/","v":"13.4.0-preview.1.26281.18"},{"n":"addLoadBalancer","f":"addLoadBalancer(name: string, subnet: AzureSubnetResource): AzureKubernetesLoadBalancerResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Adds an Azure Application Gateway for Containers (AGC) `ApplicationLoadBalancer` to this AKS environment, bound to the supplied delegated subnet. Returns a resource builder that can be passed to `gateway.WithLoadBalancer(lb)` / `ingress.WithLoadBalancer(lb)` to route traffic through this load balancer.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addloadbalancer/","v":"13.4.0-preview.1.26281.18"},{"n":"addNodePool","f":"addNodePool(name: string, vmSize?: string, minCount?: number, maxCount?: number): AksNodePoolResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Adds a node pool to the AKS cluster.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/addnodepool/","v":"13.4.0-preview.1.26281.18"},{"n":"withContainerRegistry","f":"withContainerRegistry(registry: AzureContainerRegistryResource): AzureKubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Configures the AKS environment to use a specific Azure Container Registry for image storage. When set, this replaces the auto-created default container registry.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withcontainerregistry/","v":"13.4.0-preview.1.26281.18"},{"n":"withLoadBalancer","f":"withLoadBalancer(loadBalancer: AzureKubernetesLoadBalancerResource): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Routes a Kubernetes Gateway through an AGC ApplicationLoadBalancer","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withloadbalancer-aspire-hosting-kubernetes-kubernetesgatewayresource-azurekubernetesloadbalancerresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withLoadBalancer","f":"withLoadBalancer(loadBalancer: AzureKubernetesLoadBalancerResource): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Routes a Kubernetes Ingress through an AGC ApplicationLoadBalancer","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withloadbalancer-aspire-hosting-kubernetes-kubernetesingressresource-azurekubernetesloadbalancerresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withSubnet","f":"withSubnet(subnet: AzureSubnetResource): AzureKubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Configures the AKS cluster to use a VNet subnet","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withsubnet-aspire-hosting-azure-kubernetes-azurekubernetesenvironmentresource-azuresubnetresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withSubnet","f":"withSubnet(subnet: AzureSubnetResource): AksNodePoolResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Configures an AKS node pool to use a specific VNet subnet","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withsubnet-aspire-hosting-azure-kubernetes-aksnodepoolresource-azuresubnetresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withSystemNodePool","f":"withSystemNodePool(vmSize?: string, minCount?: number, maxCount?: number): AzureKubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Replaces the default system node pool with a customized configuration.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withsystemnodepool/","v":"13.4.0-preview.1.26281.18"},{"n":"withWorkloadIdentity","f":"withWorkloadIdentity(enabled?: boolean): AzureKubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Azure.Kubernetes","s":"Enables or disables workload identity on the AKS environment, allowing pods to authenticate to Azure services using federated credentials.","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/withworkloadidentity/","v":"13.4.0-preview.1.26281.18"},{"n":"AksNodePoolResource","f":"Aspire.Hosting.Azure.Kubernetes.AksNodePoolResource","k":"handle","p":"Aspire.Hosting.Azure.Kubernetes","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/aksnodepoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureKubernetesEnvironmentResource","f":"Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource","k":"handle","p":"Aspire.Hosting.Azure.Kubernetes","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/azurekubernetesenvironmentresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureKubernetesLoadBalancerResource","f":"Aspire.Hosting.Azure.Kubernetes.AzureKubernetesLoadBalancerResource","k":"handle","p":"Aspire.Hosting.Azure.Kubernetes","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.kubernetes/azurekubernetesloadbalancerresource/","v":"13.4.0-preview.1.26281.18"},{"n":"addAzureKustoCluster","f":"addAzureKustoCluster(name: string): AzureKustoClusterResource","k":"method","p":"Aspire.Hosting.Azure.Kusto","s":"Adds an Azure Data Explorer (Kusto) cluster resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/addazurekustocluster/","v":"13.4.0-preview.1.26281.18"},{"n":"addReadWriteDatabase","f":"addReadWriteDatabase(name: string, databaseName?: string): AzureKustoReadWriteDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.Kusto","s":"Adds a Kusto read-write database to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/addreadwritedatabase/","v":"13.4.0-preview.1.26281.18"},{"n":"getDatabaseCreationScript","f":"getDatabaseCreationScript(): string","k":"method","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the database creation script from the resource annotation if it exists. If not, creates the default database creation script.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/getdatabasecreationscript/","v":"13.4.0-preview.1.26281.18"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: AzureKustoEmulatorResource) => Promise): AzureKustoClusterResource","k":"method","p":"Aspire.Hosting.Azure.Kusto","s":"Configures the Kusto resource to run as an emulator using the Kustainer container.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/runasemulator/","v":"13.4.0-preview.1.26281.18"},{"n":"withCreationScript","f":"withCreationScript(script: string): AzureKustoReadWriteDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.Kusto","s":"Defines the script used to create the database.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/withcreationscript/","v":"13.4.0-preview.1.26281.18"},{"n":"withHostPort","f":"withHostPort(port: number): AzureKustoEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Kusto","s":"Configures the host port that the Kusto emulator listens on for HTTP query requests.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/withhostport/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureKustoClusterResource","f":"Aspire.Hosting.Azure.AzureKustoClusterResource","k":"handle","p":"Aspire.Hosting.Azure.Kusto","s":"A resource that represents a Kusto cluster.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoclusterresource/","v":"13.4.0-preview.1.26281.18"},{"n":"clusterUri","f":"AzureKustoClusterResource.clusterUri(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the cluster URI output reference for the Azure Kusto cluster.","t":"AzureKustoClusterResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoclusterresource/#clusteruri","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"connectionStringExpression","f":"AzureKustoClusterResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the ConnectionStringExpression property","t":"AzureKustoClusterResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoclusterresource/#connectionstringexpression","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"isEmulator","f":"AzureKustoClusterResource.isEmulator(): boolean","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets whether the resource is running the local emulator.","t":"AzureKustoClusterResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoclusterresource/#isemulator","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"nameOutputReference","f":"AzureKustoClusterResource.nameOutputReference(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the \"name\" output reference for the resource.","t":"AzureKustoClusterResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoclusterresource/#nameoutputreference","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"uriExpression","f":"AzureKustoClusterResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the connection URI expression for the Kusto cluster.","t":"AzureKustoClusterResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoclusterresource/#uriexpression","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"AzureKustoEmulatorResource","f":"Aspire.Hosting.Azure.AzureKustoEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.Kusto","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoemulatorresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureKustoReadWriteDatabaseResource","f":"Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource","k":"handle","p":"Aspire.Hosting.Azure.Kusto","s":"Represents an Azure Kusto read-write database resource, which is a child resource of a {@ats-ref type:AzureKustoClusterResource}.","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoreadwritedatabaseresource/","v":"13.4.0-preview.1.26281.18"},{"n":"connectionStringExpression","f":"AzureKustoReadWriteDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the connection string expression for the Kusto database.","t":"AzureKustoReadWriteDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoreadwritedatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"databaseName","f":"AzureKustoReadWriteDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the database name.","t":"AzureKustoReadWriteDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoreadwritedatabaseresource/#databasename","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"parent","f":"AzureKustoReadWriteDatabaseResource.parent(): AzureKustoClusterResource","k":"property","p":"Aspire.Hosting.Azure.Kusto","s":"Gets the parent Kusto resource.","t":"AzureKustoReadWriteDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.kusto/azurekustoreadwritedatabaseresource/#parent","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"addAzureVirtualNetwork","f":"addAzureVirtualNetwork(name: string, addressPrefix?: ParameterResource): AzureVirtualNetworkResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure Virtual Network resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.network/addazurevirtualnetwork/","v":"13.4.0"},{"n":"addNatGateway","f":"addNatGateway(name: string): AzureNatGatewayResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure NAT Gateway resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.network/addnatgateway/","v":"13.4.0"},{"n":"addNetworkSecurityGroup","f":"addNetworkSecurityGroup(name: string): AzureNetworkSecurityGroupResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure Network Security Group to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.network/addnetworksecuritygroup/","v":"13.4.0"},{"n":"addNetworkSecurityPerimeter","f":"addNetworkSecurityPerimeter(name: string): AzureNetworkSecurityPerimeterResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure Network Security Perimeter to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.network/addnetworksecurityperimeter/","v":"13.4.0"},{"n":"addPrivateEndpoint","f":"addPrivateEndpoint(target: IAzurePrivateEndpointTarget): AzurePrivateEndpointResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure Private Endpoint resource to the subnet.","h":"/reference/api/typescript/aspire.hosting.azure.network/addprivateendpoint/","v":"13.4.0"},{"n":"addPublicIPAddress","f":"addPublicIPAddress(name: string): AzurePublicIPAddressResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure Public IP Address resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.network/addpublicipaddress/","v":"13.4.0"},{"n":"addSubnet","f":"addSubnet(name: string, addressPrefix: ParameterResource, subnetName?: string): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an Azure subnet resource to an Azure Virtual Network resource.","h":"/reference/api/typescript/aspire.hosting.azure.network/addsubnet/","v":"13.4.0"},{"n":"allowInbound","f":"allowInbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an inbound allow rule to the subnet's Network Security Group.","h":"/reference/api/typescript/aspire.hosting.azure.network/allowinbound/","v":"13.4.0"},{"n":"allowOutbound","f":"allowOutbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an outbound allow rule to the subnet's Network Security Group.","h":"/reference/api/typescript/aspire.hosting.azure.network/allowoutbound/","v":"13.4.0"},{"n":"denyInbound","f":"denyInbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an inbound deny rule to the subnet's Network Security Group.","h":"/reference/api/typescript/aspire.hosting.azure.network/denyinbound/","v":"13.4.0"},{"n":"denyOutbound","f":"denyOutbound(port?: string, from?: string, to?: string, protocol?: SecurityRuleProtocol, priority?: number, name?: string): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an outbound deny rule to the subnet's Network Security Group.","h":"/reference/api/typescript/aspire.hosting.azure.network/denyoutbound/","v":"13.4.0"},{"n":"withAccessRule","f":"withAccessRule(rule: AzureNspAccessRule): AzureNetworkSecurityPerimeterResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds an access rule to the Network Security Perimeter.","h":"/reference/api/typescript/aspire.hosting.azure.network/withaccessrule/","v":"13.4.0"},{"n":"withDelegatedSubnet","f":"withDelegatedSubnet(subnet: AzureSubnetResource): IAzureDelegatedSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Configures the resource to use the specified subnet with appropriate service delegation.","h":"/reference/api/typescript/aspire.hosting.azure.network/withdelegatedsubnet/","v":"13.4.0"},{"n":"withNatGateway","f":"withNatGateway(natGateway: AzureNatGatewayResource): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Associates a NAT Gateway with the subnet.","h":"/reference/api/typescript/aspire.hosting.azure.network/withnatgateway/","v":"13.4.0"},{"n":"withNetworkSecurityGroup","f":"withNetworkSecurityGroup(nsg: AzureNetworkSecurityGroupResource): AzureSubnetResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Associates a Network Security Group with the subnet.","h":"/reference/api/typescript/aspire.hosting.azure.network/withnetworksecuritygroup/","v":"13.4.0"},{"n":"withNetworkSecurityPerimeter","f":"withNetworkSecurityPerimeter(nsp: AzureNetworkSecurityPerimeterResource, accessMode?: NetworkSecurityPerimeterAssociationAccessMode, associationName?: string): IResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Associates an Azure PaaS resource with a Network Security Perimeter.","h":"/reference/api/typescript/aspire.hosting.azure.network/withnetworksecurityperimeter/","v":"13.4.0"},{"n":"withPublicIPAddress","f":"withPublicIPAddress(publicIPAddress: AzurePublicIPAddressResource): AzureNatGatewayResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Associates an explicit Public IP Address resource with the NAT Gateway.","h":"/reference/api/typescript/aspire.hosting.azure.network/withpublicipaddress/","v":"13.4.0"},{"n":"withSecurityRule","f":"withSecurityRule(rule: AzureSecurityRule): AzureNetworkSecurityGroupResource","k":"method","p":"Aspire.Hosting.Azure.Network","s":"Adds a security rule to the Network Security Group.","h":"/reference/api/typescript/aspire.hosting.azure.network/withsecurityrule/","v":"13.4.0"},{"n":"AzureNatGatewayResource","f":"Aspire.Hosting.Azure.AzureNatGatewayResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.network/azurenatgatewayresource/","v":"13.4.0"},{"n":"AzureNetworkSecurityGroupResource","f":"Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.network/azurenetworksecuritygroupresource/","v":"13.4.0"},{"n":"AzureNetworkSecurityPerimeterResource","f":"Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.network/azurenetworksecurityperimeterresource/","v":"13.4.0"},{"n":"AzurePrivateEndpointResource","f":"Aspire.Hosting.Azure.AzurePrivateEndpointResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.network/azureprivateendpointresource/","v":"13.4.0"},{"n":"AzurePublicIPAddressResource","f":"Aspire.Hosting.Azure.AzurePublicIPAddressResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.network/azurepublicipaddressresource/","v":"13.4.0"},{"n":"AzureSubnetResource","f":"Aspire.Hosting.Azure.AzureSubnetResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Represents an Azure Subnet resource.","h":"/reference/api/typescript/aspire.hosting.azure.network/azuresubnetresource/","v":"13.4.0"},{"n":"AzureVirtualNetworkResource","f":"Aspire.Hosting.Azure.AzureVirtualNetworkResource","k":"handle","p":"Aspire.Hosting.Azure.Network","s":"Represents an Azure Virtual Network resource.","h":"/reference/api/typescript/aspire.hosting.azure.network/azurevirtualnetworkresource/","v":"13.4.0"},{"n":"AzureNspAccessRule","f":"Aspire.Hosting.Azure.AzureNspAccessRule","k":"type","p":"Aspire.Hosting.Azure.Network","s":"Represents an access rule configuration for an Azure Network Security Perimeter.","h":"/reference/api/typescript/aspire.hosting.azure.network/azurenspaccessrule/","v":"13.4.0"},{"n":"AzureSecurityRule","f":"Aspire.Hosting.Azure.AzureSecurityRule","k":"type","p":"Aspire.Hosting.Azure.Network","s":"Represents a security rule configuration for an Azure Network Security Group.","h":"/reference/api/typescript/aspire.hosting.azure.network/azuresecurityrule/","v":"13.4.0"},{"n":"addAzureLogAnalyticsWorkspace","f":"addAzureLogAnalyticsWorkspace(name: string): AzureLogAnalyticsWorkspaceResource","k":"method","p":"Aspire.Hosting.Azure.OperationalInsights","s":"Adds an Azure Log Analytics Workspace resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.operationalinsights/addazureloganalyticsworkspace/","v":"13.4.0"},{"n":"AzureLogAnalyticsWorkspaceResource","f":"Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceResource","k":"handle","p":"Aspire.Hosting.Azure.OperationalInsights","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.operationalinsights/azureloganalyticsworkspaceresource/","v":"13.4.0"},{"n":"addAzurePostgresFlexibleServer","f":"addAzurePostgresFlexibleServer(name: string): AzurePostgresFlexibleServerResource","k":"method","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Adds an Azure PostgreSQL Flexible Server resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/addazurepostgresflexibleserver/","v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): AzurePostgresFlexibleServerDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Adds an Azure PostgreSQL database to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/adddatabase/","v":"13.4.0"},{"n":"runAsContainer","f":"runAsContainer(configureContainer?: (obj: PostgresServerResource) => Promise): AzurePostgresFlexibleServerResource","k":"method","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Configures an Azure PostgreSQL Flexible Server resource to run locally in a container.","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/runascontainer/","v":"13.4.0"},{"n":"withPasswordAuthentication","f":"withPasswordAuthentication(keyVaultBuilder?: IAzureKeyVaultResource, userName?: ParameterResource, password?: ParameterResource): AzurePostgresFlexibleServerResource","k":"method","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Configures password authentication for Azure PostgreSQL Flexible Server","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/withpasswordauthentication/","v":"13.4.0"},{"n":"withPostgresMcp","f":"withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => Promise, containerName?: string): AzurePostgresFlexibleServerDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Adds a Postgres MCP server container and configures it to connect to the database represented by `builder`.","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/withpostgresmcp/","v":"13.4.0"},{"n":"AzurePostgresFlexibleServerDatabaseResource","f":"Aspire.Hosting.Azure.AzurePostgresFlexibleServerDatabaseResource","k":"handle","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/azurepostgresflexibleserverdatabaseresource/","v":"13.4.0"},{"n":"AzurePostgresFlexibleServerResource","f":"Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource","k":"handle","p":"Aspire.Hosting.Azure.PostgreSQL","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.postgresql/azurepostgresflexibleserverresource/","v":"13.4.0"},{"n":"addAzureManagedRedis","f":"addAzureManagedRedis(name: string): AzureManagedRedisResource","k":"method","p":"Aspire.Hosting.Azure.Redis","s":"Adds an Azure Managed Redis resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.redis/addazuremanagedredis/","v":"13.4.0"},{"n":"runAsContainer","f":"runAsContainer(configureContainer?: (obj: RedisResource) => Promise): AzureManagedRedisResource","k":"method","p":"Aspire.Hosting.Azure.Redis","s":"Configures an Azure Managed Redis resource to run locally in a container.","h":"/reference/api/typescript/aspire.hosting.azure.redis/runascontainer/","v":"13.4.0"},{"n":"withAccessKeyAuthentication","f":"withAccessKeyAuthentication(keyVaultBuilder?: IAzureKeyVaultResource): AzureManagedRedisResource","k":"method","p":"Aspire.Hosting.Azure.Redis","s":"Configures Azure Managed Redis to use access key authentication","h":"/reference/api/typescript/aspire.hosting.azure.redis/withaccesskeyauthentication/","v":"13.4.0"},{"n":"AzureManagedRedisResource","f":"Aspire.Hosting.Azure.AzureManagedRedisResource","k":"handle","p":"Aspire.Hosting.Azure.Redis","s":"Represents an Azure Managed Redis resource.","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureManagedRedisResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the connection string template for the manifest for the Azure Managed Redis resource.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"hostName","f":"AzureManagedRedisResource.hostName(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the host name for the Redis server.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#hostname","m":true,"v":"13.4.0"},{"n":"id","f":"AzureManagedRedisResource.id(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the \"id\" output reference for the resource.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#id","m":true,"v":"13.4.0"},{"n":"nameOutputReference","f":"AzureManagedRedisResource.nameOutputReference(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the \"name\" output reference for the resource.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#nameoutputreference","m":true,"v":"13.4.0"},{"n":"password","f":"AzureManagedRedisResource.password(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the password/access key for the Redis server.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#password","m":true,"v":"13.4.0"},{"n":"port","f":"AzureManagedRedisResource.port(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the port for the Redis server.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#port","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"AzureManagedRedisResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets the connection URI expression for the Redis server.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"useAccessKeyAuthentication","f":"AzureManagedRedisResource.useAccessKeyAuthentication(): boolean","k":"property","p":"Aspire.Hosting.Azure.Redis","s":"Gets a value indicating whether the resource uses access key authentication.","t":"AzureManagedRedisResource","h":"/reference/api/typescript/aspire.hosting.azure.redis/azuremanagedredisresource/#useaccesskeyauthentication","m":true,"v":"13.4.0"},{"n":"addAzureSearch","f":"addAzureSearch(name: string): AzureSearchResource","k":"method","p":"Aspire.Hosting.Azure.Search","s":"Adds an Azure AI Search service resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.search/addazuresearch/","v":"13.4.0"},{"n":"withSearchRoleAssignments","f":"withSearchRoleAssignments(target: AzureSearchResource, roles: AzureSearchRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.Search","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure AI Search service resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.search/withsearchroleassignments/","v":"13.4.0"},{"n":"AzureSearchResource","f":"Aspire.Hosting.Azure.AzureSearchResource","k":"handle","p":"Aspire.Hosting.Azure.Search","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.search/azuresearchresource/","v":"13.4.0"},{"n":"AzureSearchRole","f":"Aspire.Hosting.AzureSearchRole","k":"enum","p":"Aspire.Hosting.Azure.Search","s":"Represents ATS-compatible Azure AI Search roles.","h":"/reference/api/typescript/aspire.hosting.azure.search/azuresearchrole/","v":"13.4.0"},{"n":"addAzureServiceBus","f":"addAzureServiceBus(name: string): AzureServiceBusResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Adds an Azure Service Bus Namespace resource to the application model. This resource can be used to create queue, topic, and subscription resources.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/addazureservicebus/","v":"13.4.0"},{"n":"addServiceBusQueue","f":"addServiceBusQueue(name: string, queueName?: string): AzureServiceBusQueueResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Adds an Azure Service Bus Queue resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebusqueue/","v":"13.4.0"},{"n":"addServiceBusSubscription","f":"addServiceBusSubscription(name: string, subscriptionName?: string): AzureServiceBusSubscriptionResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Adds an Azure Service Bus Subscription resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebussubscription/","v":"13.4.0"},{"n":"addServiceBusTopic","f":"addServiceBusTopic(name: string, topicName?: string): AzureServiceBusTopicResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Adds an Azure Service Bus Topic resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/addservicebustopic/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: AzureServiceBusEmulatorResource) => Promise): AzureServiceBusResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Configures the Azure Service Bus resource to run with the local emulator","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/runasemulator/","v":"13.4.0"},{"n":"withConfigurationFile","f":"withConfigurationFile(path: string): AzureServiceBusEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Copies the configuration file into an Azure Service Bus emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/withconfigurationfile/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): AzureServiceBusEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/withhostport/","v":"13.4.0"},{"n":"withProperties","f":"withProperties(configure: (obj: AzureServiceBusQueueResource) => Promise): AzureServiceBusQueueResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Allows setting the properties of an Azure Service Bus Queue resource.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties-aspire-hosting-azure-azureservicebusqueueresource-obj-azureservicebusqueueresource-promise-void/","v":"13.4.0"},{"n":"withProperties","f":"withProperties(configure: (obj: AzureServiceBusTopicResource) => Promise): AzureServiceBusTopicResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Allows setting the properties of an Azure Service Bus Topic resource.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties-aspire-hosting-azure-azureservicebustopicresource-obj-azureservicebustopicresource-promise-void/","v":"13.4.0"},{"n":"withProperties","f":"withProperties(configure: (obj: AzureServiceBusSubscriptionResource) => Promise): AzureServiceBusSubscriptionResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Allows setting the properties of an Azure Service Bus Subscription resource.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/withproperties-aspire-hosting-azure-azureservicebussubscriptionresource-obj-azureservicebussubscriptionresource-promise-void/","v":"13.4.0"},{"n":"withServiceBusRoleAssignments","f":"withServiceBusRoleAssignments(target: AzureServiceBusResource, roles: AzureServiceBusRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.ServiceBus","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Service Bus namespace. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/withservicebusroleassignments/","v":"13.4.0"},{"n":"AzureServiceBusEmulatorResource","f":"Aspire.Hosting.Azure.AzureServiceBusEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.ServiceBus","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusemulatorresource/","v":"13.4.0"},{"n":"AzureServiceBusQueueResource","f":"Aspire.Hosting.Azure.AzureServiceBusQueueResource","k":"handle","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents a Service Bus Queue. Initializes a new instance of the {@ats-ref type:AzureServiceBusQueueResource} class.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureServiceBusQueueResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Gets the connection string expression for the Azure Service Bus Queue.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"deadLetteringOnMessageExpiration","f":"AzureServiceBusQueueResource.deadLetteringOnMessageExpiration(): boolean","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"A value that indicates whether this queue has dead letter support when a message expires.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#deadletteringonmessageexpiration","m":true,"v":"13.4.0"},{"n":"defaultMessageTimeToLive","f":"AzureServiceBusQueueResource.defaultMessageTimeToLive(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#defaultmessagetimetolive","m":true,"v":"13.4.0"},{"n":"duplicateDetectionHistoryTimeWindow","f":"AzureServiceBusQueueResource.duplicateDetectionHistoryTimeWindow(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#duplicatedetectionhistorytimewindow","m":true,"v":"13.4.0"},{"n":"forwardDeadLetteredMessagesTo","f":"AzureServiceBusQueueResource.forwardDeadLetteredMessagesTo(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Queue/Topic name to forward the Dead Letter message.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#forwarddeadletteredmessagesto","m":true,"v":"13.4.0"},{"n":"forwardTo","f":"AzureServiceBusQueueResource.forwardTo(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Queue/Topic name to forward the messages.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#forwardto","m":true,"v":"13.4.0"},{"n":"lockDuration","f":"AzureServiceBusQueueResource.lockDuration(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#lockduration","m":true,"v":"13.4.0"},{"n":"maxDeliveryCount","f":"AzureServiceBusQueueResource.maxDeliveryCount(): number","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#maxdeliverycount","m":true,"v":"13.4.0"},{"n":"parent","f":"AzureServiceBusQueueResource.parent(): AzureServiceBusResource","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Gets the parent Azure Service Bus resource.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#parent","m":true,"v":"13.4.0"},{"n":"queueName","f":"AzureServiceBusQueueResource.queueName(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"The queue name.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#queuename","m":true,"v":"13.4.0"},{"n":"requiresDuplicateDetection","f":"AzureServiceBusQueueResource.requiresDuplicateDetection(): boolean","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"A value indicating if this queue requires duplicate detection.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#requiresduplicatedetection","m":true,"v":"13.4.0"},{"n":"requiresSession","f":"AzureServiceBusQueueResource.requiresSession(): boolean","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"A value that indicates whether the queue supports the concept of sessions.","t":"AzureServiceBusQueueResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusqueueresource/#requiressession","m":true,"v":"13.4.0"},{"n":"AzureServiceBusResource","f":"Aspire.Hosting.Azure.AzureServiceBusResource","k":"handle","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents an Azure Service Bus resource.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusresource/","v":"13.4.0"},{"n":"AzureServiceBusSubscriptionResource","f":"Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource","k":"handle","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents a Service Bus Subscription. Initializes a new instance of the {@ats-ref type:AzureServiceBusSubscriptionResource} class.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureServiceBusSubscriptionResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Gets the connection string expression for the Azure Service Bus Subscription.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"deadLetteringOnMessageExpiration","f":"AzureServiceBusSubscriptionResource.deadLetteringOnMessageExpiration(): boolean","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"A value that indicates whether this queue has dead letter support when a message expires.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#deadletteringonmessageexpiration","m":true,"v":"13.4.0"},{"n":"defaultMessageTimeToLive","f":"AzureServiceBusSubscriptionResource.defaultMessageTimeToLive(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#defaultmessagetimetolive","m":true,"v":"13.4.0"},{"n":"forwardDeadLetteredMessagesTo","f":"AzureServiceBusSubscriptionResource.forwardDeadLetteredMessagesTo(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Queue/Topic name to forward the Dead Letter message.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#forwarddeadletteredmessagesto","m":true,"v":"13.4.0"},{"n":"forwardTo","f":"AzureServiceBusSubscriptionResource.forwardTo(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Queue/Topic name to forward the messages.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#forwardto","m":true,"v":"13.4.0"},{"n":"lockDuration","f":"AzureServiceBusSubscriptionResource.lockDuration(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#lockduration","m":true,"v":"13.4.0"},{"n":"maxDeliveryCount","f":"AzureServiceBusSubscriptionResource.maxDeliveryCount(): number","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#maxdeliverycount","m":true,"v":"13.4.0"},{"n":"parent","f":"AzureServiceBusSubscriptionResource.parent(): AzureServiceBusTopicResource","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Gets the parent Azure Service Bus Topic resource.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#parent","m":true,"v":"13.4.0"},{"n":"requiresSession","f":"AzureServiceBusSubscriptionResource.requiresSession(): boolean","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"A value that indicates whether the queue supports the concept of sessions.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#requiressession","m":true,"v":"13.4.0"},{"n":"rules","f":"AzureServiceBusSubscriptionResource.rules(): List","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"The rules for this subscription.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#rules","m":true,"v":"13.4.0"},{"n":"subscriptionName","f":"AzureServiceBusSubscriptionResource.subscriptionName(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"The subscription name.","t":"AzureServiceBusSubscriptionResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebussubscriptionresource/#subscriptionname","m":true,"v":"13.4.0"},{"n":"AzureServiceBusTopicResource","f":"Aspire.Hosting.Azure.AzureServiceBusTopicResource","k":"handle","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents a Service Bus Topic. Initializes a new instance of the {@ats-ref type:AzureServiceBusTopicResource} class.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureServiceBusTopicResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Gets the connection string expression for the Azure Service Bus Topic.","t":"AzureServiceBusTopicResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"defaultMessageTimeToLive","f":"AzureServiceBusTopicResource.defaultMessageTimeToLive(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.","t":"AzureServiceBusTopicResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/#defaultmessagetimetolive","m":true,"v":"13.4.0"},{"n":"duplicateDetectionHistoryTimeWindow","f":"AzureServiceBusTopicResource.duplicateDetectionHistoryTimeWindow(): timespan","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.","t":"AzureServiceBusTopicResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/#duplicatedetectionhistorytimewindow","m":true,"v":"13.4.0"},{"n":"parent","f":"AzureServiceBusTopicResource.parent(): AzureServiceBusResource","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"Gets the parent Azure Service Bus resource.","t":"AzureServiceBusTopicResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/#parent","m":true,"v":"13.4.0"},{"n":"requiresDuplicateDetection","f":"AzureServiceBusTopicResource.requiresDuplicateDetection(): boolean","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"A value indicating if this topic requires duplicate detection.","t":"AzureServiceBusTopicResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/#requiresduplicatedetection","m":true,"v":"13.4.0"},{"n":"topicName","f":"AzureServiceBusTopicResource.topicName(): string","k":"property","p":"Aspire.Hosting.Azure.ServiceBus","s":"The topic name.","t":"AzureServiceBusTopicResource","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebustopicresource/#topicname","m":true,"v":"13.4.0"},{"n":"AzureServiceBusCorrelationFilter","f":"Aspire.Hosting.Azure.AzureServiceBusCorrelationFilter","k":"type","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents the correlation filter expression.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebuscorrelationfilter/","v":"13.4.0"},{"n":"AzureServiceBusRule","f":"Aspire.Hosting.Azure.AzureServiceBusRule","k":"type","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents a Service Bus Rule. Initializes a new instance of the `AzureServiceBusRule` class.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusrule/","v":"13.4.0"},{"n":"AzureServiceBusFilterType","f":"Aspire.Hosting.Azure.AzureServiceBusFilterType","k":"enum","p":"Aspire.Hosting.Azure.ServiceBus","s":"Rule filter types.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusfiltertype/","v":"13.4.0"},{"n":"AzureServiceBusRole","f":"Aspire.Hosting.AzureServiceBusRole","k":"enum","p":"Aspire.Hosting.Azure.ServiceBus","s":"Represents ATS-compatible Azure Service Bus roles.","h":"/reference/api/typescript/aspire.hosting.azure.servicebus/azureservicebusrole/","v":"13.4.0"},{"n":"addAzureSignalR","f":"addAzureSignalR(name: string): AzureSignalRResource","k":"method","p":"Aspire.Hosting.Azure.SignalR","s":"Adds an Azure SignalR resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.signalr/addazuresignalr/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: AzureSignalREmulatorResource) => Promise): AzureSignalRResource","k":"method","p":"Aspire.Hosting.Azure.SignalR","s":"Configures an Azure SignalR resource to be emulated. This resource requires an Azure SignalR resource to be added to the application model. Please note that the resource will be emulated in Serverless mode.","h":"/reference/api/typescript/aspire.hosting.azure.signalr/runasemulator/","v":"13.4.0"},{"n":"withSignalRRoleAssignments","f":"withSignalRRoleAssignments(target: AzureSignalRResource, roles: AzureSignalRRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.SignalR","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure SignalR resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.signalr/withsignalrroleassignments/","v":"13.4.0"},{"n":"AzureSignalRResource","f":"Aspire.Hosting.ApplicationModel.AzureSignalRResource","k":"handle","p":"Aspire.Hosting.Azure.SignalR","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.signalr/azuresignalrresource/","v":"13.4.0"},{"n":"AzureSignalREmulatorResource","f":"Aspire.Hosting.Azure.AzureSignalREmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.SignalR","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.signalr/azuresignalremulatorresource/","v":"13.4.0"},{"n":"AzureSignalRRole","f":"Aspire.Hosting.AzureSignalRRole","k":"enum","p":"Aspire.Hosting.Azure.SignalR","s":"Represents ATS-compatible Azure SignalR roles.","h":"/reference/api/typescript/aspire.hosting.azure.signalr/azuresignalrrole/","v":"13.4.0"},{"n":"addAzureSqlServer","f":"addAzureSqlServer(name: string): AzureSqlServerResource","k":"method","p":"Aspire.Hosting.Azure.Sql","s":"Adds an Azure SQL Database (server) resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.sql/addazuresqlserver/","v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): AzureSqlDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.Sql","s":"Adds an Azure SQL Database to the application model. The Free Offer option will be used when deploying the resource in Azure","h":"/reference/api/typescript/aspire.hosting.azure.sql/adddatabase/","v":"13.4.0"},{"n":"runAsContainer","f":"runAsContainer(configureContainer?: (obj: SqlServerServerResource) => Promise): AzureSqlServerResource","k":"method","p":"Aspire.Hosting.Azure.Sql","s":"Configures an Azure SQL Database (server) resource to run locally in a container.","h":"/reference/api/typescript/aspire.hosting.azure.sql/runascontainer/","v":"13.4.0"},{"n":"withAdminDeploymentScriptStorage","f":"withAdminDeploymentScriptStorage(storage: AzureStorageResource): AzureSqlServerResource","k":"method","p":"Aspire.Hosting.Azure.Sql","s":"Configures the Azure SQL Server to use the specified storage account for deployment script execution.","h":"/reference/api/typescript/aspire.hosting.azure.sql/withadmindeploymentscriptstorage/","v":"13.4.0"},{"n":"withAdminDeploymentScriptSubnet","f":"withAdminDeploymentScriptSubnet(subnet: AzureSubnetResource): AzureSqlServerResource","k":"method","p":"Aspire.Hosting.Azure.Sql","s":"Configures the Azure SQL Server to use the specified subnet for deployment script execution.","h":"/reference/api/typescript/aspire.hosting.azure.sql/withadmindeploymentscriptsubnet/","v":"13.4.0"},{"n":"withDefaultAzureSku","f":"withDefaultAzureSku(): AzureSqlDatabaseResource","k":"method","p":"Aspire.Hosting.Azure.Sql","s":"Configures the Azure SQL Database to be deployed use the default SKU provided by Azure. Please be aware that the Azure default Sku might not take advantage of the free offer.","h":"/reference/api/typescript/aspire.hosting.azure.sql/withdefaultazuresku/","v":"13.4.0"},{"n":"AzureSqlDatabaseResource","f":"Aspire.Hosting.Azure.AzureSqlDatabaseResource","k":"handle","p":"Aspire.Hosting.Azure.Sql","s":"A resource that represents an Azure SQL database. This is a child resource of an {@ats-ref type:AzureSqlServerResource}.","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureSqlDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the connection string expression for the Azure SQL database.","t":"AzureSqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"AzureSqlDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the database name.","t":"AzureSqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"isContainer","f":"AzureSqlDatabaseResource.isContainer(): boolean","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets a value indicating whether the current resource represents a container. If so the actual resource is not running in Azure.","t":"AzureSqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/#iscontainer","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"AzureSqlDatabaseResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the JDBC connection string for the Azure SQL database.","t":"AzureSqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"parent","f":"AzureSqlDatabaseResource.parent(): AzureSqlServerResource","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the parent Azure SQL Database (server) resource.","t":"AzureSqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"AzureSqlDatabaseResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the connection URI expression for the Azure SQL database.","t":"AzureSqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqldatabaseresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"AzureSqlServerResource","f":"Aspire.Hosting.Azure.AzureSqlServerResource","k":"handle","p":"Aspire.Hosting.Azure.Sql","s":"Represents an Azure Sql Server resource.","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/","v":"13.4.0"},{"n":"azureSqlDatabases","f":"AzureSqlServerResource.azureSqlDatabases(): Dict","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"A dictionary where the key is the resource name and the value is the Azure SQL database resource.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#azuresqldatabases","m":true,"v":"13.4.0"},{"n":"connectionStringExpression","f":"AzureSqlServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the connection template for the manifest for the Azure SQL Server resource.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"AzureSqlServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"A dictionary where the key is the resource name and the value is the Azure SQL database name.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#databases","m":true,"v":"13.4.0"},{"n":"fullyQualifiedDomainName","f":"AzureSqlServerResource.fullyQualifiedDomainName(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the fully qualified domain name (FQDN) output reference from the bicep template for the Azure SQL Server resource.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#fullyqualifieddomainname","m":true,"v":"13.4.0"},{"n":"hostName","f":"AzureSqlServerResource.hostName(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the host name for the SQL Server.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#hostname","m":true,"v":"13.4.0"},{"n":"id","f":"AzureSqlServerResource.id(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the \"id\" output reference for the resource.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#id","m":true,"v":"13.4.0"},{"n":"isContainer","f":"AzureSqlServerResource.isContainer(): boolean","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets a value indicating whether the current resource represents a container. If so the actual resource is not running in Azure.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#iscontainer","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"AzureSqlServerResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the JDBC connection string for the server.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"nameOutputReference","f":"AzureSqlServerResource.nameOutputReference(): BicepOutputReference","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the \"name\" output reference for the resource.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#nameoutputreference","m":true,"v":"13.4.0"},{"n":"port","f":"AzureSqlServerResource.port(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the port for the PostgreSQL server.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#port","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"AzureSqlServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Azure.Sql","s":"Gets the connection URI expression for the SQL Server.","t":"AzureSqlServerResource","h":"/reference/api/typescript/aspire.hosting.azure.sql/azuresqlserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addAzureStorage","f":"addAzureStorage(name: string): AzureStorageResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Storage resource to the application model. This resource can be used to create Azure blob, table, and queue resources.","h":"/reference/api/typescript/aspire.hosting.azure.storage/addazurestorage/","v":"13.4.0"},{"n":"addBlobContainer","f":"addBlobContainer(name: string, blobContainerName?: string): AzureBlobStorageContainerResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Blob Storage container resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/addblobcontainer/","v":"13.4.0"},{"n":"addBlobs","f":"addBlobs(name: string): AzureBlobStorageResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Blob Storage resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/addblobs/","v":"13.4.0"},{"n":"addDataLake","f":"addDataLake(name: string): AzureDataLakeStorageResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Data Lake Storage resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/adddatalake/","v":"13.4.0"},{"n":"addDataLakeFileSystem","f":"addDataLakeFileSystem(name: string, dataLakeFileSystemName?: string): AzureDataLakeStorageFileSystemResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Data Lake Storage file system resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/adddatalakefilesystem/","v":"13.4.0"},{"n":"addQueue","f":"addQueue(name: string, queueName?: string): AzureQueueStorageQueueResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Storage queue resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/addqueue/","v":"13.4.0"},{"n":"addQueues","f":"addQueues(name: string): AzureQueueStorageResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Queue Storage resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/addqueues/","v":"13.4.0"},{"n":"addTables","f":"addTables(name: string): AzureTableStorageResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds an Azure Table Storage resource","h":"/reference/api/typescript/aspire.hosting.azure.storage/addtables/","v":"13.4.0"},{"n":"runAsEmulator","f":"runAsEmulator(configureContainer?: (obj: AzureStorageEmulatorResource) => Promise): AzureStorageResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Configures the Azure Storage resource to be emulated using Azurite","h":"/reference/api/typescript/aspire.hosting.azure.storage/runasemulator/","v":"13.4.0"},{"n":"withApiVersionCheck","f":"withApiVersionCheck(enable?: boolean): AzureStorageEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Ensures the emulator checks that the requested API version is valid.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withapiversioncheck/","v":"13.4.0"},{"n":"withBlobPort","f":"withBlobPort(port: number): AzureStorageEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Modifies the host port that the storage emulator listens on for blob requests.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withblobport/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(path?: string, isReadOnly?: boolean): AzureStorageEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds a bind mount for the data folder to an Azure Storage emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): AzureStorageEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Adds a named volume for the data folder to an Azure Storage emulator resource.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withdatavolume/","v":"13.4.0"},{"n":"withQueuePort","f":"withQueuePort(port: number): AzureStorageEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Modifies the host port that the storage emulator listens on for queue requests.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withqueueport/","v":"13.4.0"},{"n":"withStorageRoleAssignments","f":"withStorageRoleAssignments(target: AzureStorageResource, roles: AzureStorageRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Storage account. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withstorageroleassignments/","v":"13.4.0"},{"n":"withTablePort","f":"withTablePort(port: number): AzureStorageEmulatorResource","k":"method","p":"Aspire.Hosting.Azure.Storage","s":"Modifies the host port that the storage emulator listens on for table requests.","h":"/reference/api/typescript/aspire.hosting.azure.storage/withtableport/","v":"13.4.0"},{"n":"AzureBlobStorageContainerResource","f":"Aspire.Hosting.Azure.AzureBlobStorageContainerResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azureblobstoragecontainerresource/","v":"13.4.0"},{"n":"AzureBlobStorageResource","f":"Aspire.Hosting.Azure.AzureBlobStorageResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azureblobstorageresource/","v":"13.4.0"},{"n":"AzureDataLakeStorageFileSystemResource","f":"Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azuredatalakestoragefilesystemresource/","v":"13.4.0"},{"n":"AzureDataLakeStorageResource","f":"Aspire.Hosting.Azure.AzureDataLakeStorageResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azuredatalakestorageresource/","v":"13.4.0"},{"n":"AzureQueueStorageQueueResource","f":"Aspire.Hosting.Azure.AzureQueueStorageQueueResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azurequeuestoragequeueresource/","v":"13.4.0"},{"n":"AzureQueueStorageResource","f":"Aspire.Hosting.Azure.AzureQueueStorageResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azurequeuestorageresource/","v":"13.4.0"},{"n":"AzureStorageEmulatorResource","f":"Aspire.Hosting.Azure.AzureStorageEmulatorResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azurestorageemulatorresource/","v":"13.4.0"},{"n":"AzureStorageResource","f":"Aspire.Hosting.Azure.AzureStorageResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azurestorageresource/","v":"13.4.0"},{"n":"AzureTableStorageResource","f":"Aspire.Hosting.Azure.AzureTableStorageResource","k":"handle","p":"Aspire.Hosting.Azure.Storage","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.storage/azuretablestorageresource/","v":"13.4.0"},{"n":"AzureStorageRole","f":"Aspire.Hosting.AzureStorageRole","k":"enum","p":"Aspire.Hosting.Azure.Storage","s":"Represents ATS-compatible Azure Storage roles.","h":"/reference/api/typescript/aspire.hosting.azure.storage/azurestoragerole/","v":"13.4.0"},{"n":"addAzureWebPubSub","f":"addAzureWebPubSub(name: string): AzureWebPubSubResource","k":"method","p":"Aspire.Hosting.Azure.WebPubSub","s":"Adds an Azure Web PubSub resource to the application model. Change sku: WithParameter(\"sku\", \"Standard_S1\") Change capacity: WithParameter(\"capacity\", 2)","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/addazurewebpubsub/","v":"13.4.0"},{"n":"addEventHandler","f":"addEventHandler(urlExpression: ReferenceExpression, userEventPattern?: string, systemEvents?: string[]): AzureWebPubSubHubResource","k":"method","p":"Aspire.Hosting.Azure.WebPubSub","s":"Adds an event handler to an Azure Web PubSub hub.","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/addeventhandler/","v":"13.4.0"},{"n":"addHub","f":"addHub(name: string, hubName?: string): AzureWebPubSubHubResource","k":"method","p":"Aspire.Hosting.Azure.WebPubSub","s":"Adds an Azure Web Pub Sub hub resource to the application model.","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/addhub/","v":"13.4.0"},{"n":"withWebPubSubRoleAssignments","f":"withWebPubSubRoleAssignments(target: AzureWebPubSubResource, roles: AzureWebPubSubRole[]): IResource","k":"method","p":"Aspire.Hosting.Azure.WebPubSub","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Web PubSub resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/withwebpubsubroleassignments/","v":"13.4.0"},{"n":"AzureWebPubSubHubResource","f":"Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource","k":"handle","p":"Aspire.Hosting.Azure.WebPubSub","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/azurewebpubsubhubresource/","v":"13.4.0"},{"n":"AzureWebPubSubResource","f":"Aspire.Hosting.ApplicationModel.AzureWebPubSubResource","k":"handle","p":"Aspire.Hosting.Azure.WebPubSub","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/azurewebpubsubresource/","v":"13.4.0"},{"n":"AzureWebPubSubRole","f":"Aspire.Hosting.AzureWebPubSubRole","k":"enum","p":"Aspire.Hosting.Azure.WebPubSub","s":"Represents ATS-compatible Azure Web PubSub roles.","h":"/reference/api/typescript/aspire.hosting.azure.webpubsub/azurewebpubsubrole/","v":"13.4.0"},{"n":"addBlazorGateway","f":"addBlazorGateway(name: string): ProjectResource","k":"method","p":"Aspire.Hosting.Blazor","s":"Registers the built-in Blazor Gateway as a file-based C# app. The gateway is shipped as Gateway.cs alongside this library and launched via `AddCSharpApp`. No separate project is needed.","h":"/reference/api/typescript/aspire.hosting.blazor/addblazorgateway/","v":"13.4.0-preview.1.26281.18"},{"n":"addBlazorWasmProject","f":"addBlazorWasmProject(name: string, projectPath: string): BlazorWasmAppResource","k":"method","p":"Aspire.Hosting.Blazor","s":"Registers a Blazor WebAssembly project as a resource without launching it as a process. Prefer AddBlazorWasmProject which uses IProjectMetadata for path discovery.","h":"/reference/api/typescript/aspire.hosting.blazor/addblazorwasmproject/","v":"13.4.0-preview.1.26281.18"},{"n":"withBlazorClientApp","f":"withBlazorClientApp(wasmApp: BlazorWasmAppResource, apiPrefix?: string, otlpPrefix?: string, proxyTelemetry?: boolean): ProjectResource","k":"method","p":"Aspire.Hosting.Blazor","s":"Attaches a Blazor WebAssembly app to the Gateway. The resource name is used as the URL path prefix (e.g., resource \"store\" → /store/). Service names are derived from WithReference() annotations on the WASM resource. Service references from the WASM app are automatically forwarded to the gateway so the gateway can resolve service endpoints for YARP proxying.","h":"/reference/api/typescript/aspire.hosting.blazor/withblazorclientapp/","v":"13.4.0-preview.1.26281.18"},{"n":"BlazorWasmAppResource","f":"Aspire.Hosting.BlazorWasmAppResource","k":"handle","p":"Aspire.Hosting.Blazor","s":"A resource representing a Blazor WebAssembly application project. This is not a running process — it's metadata about a WASM project whose static web assets are served through a Gateway. Implements IResourceWithEnvironment so that WithReference() can be used to declare service dependencies (the annotations are read at orchestration time). Implements IResourceWithParent so that the orchestrator mirrors the gateway's lifecycle state (Running, Stopped, etc.) to this child resource automatically.","h":"/reference/api/typescript/aspire.hosting.blazor/blazorwasmappresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withBrowserLogs","f":"withBrowserLogs(browser?: string, profile?: string, userDataMode?: BrowserUserDataMode): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting.Browsers","s":"Adds a child resource that can open the application's primary browser endpoint in a tracked browser session, surface browser diagnostics, and capture screenshots.","h":"/reference/api/typescript/aspire.hosting.browsers/withbrowserlogs/","v":"13.4.0-preview.1.26281.18"},{"n":"BrowserUserDataMode","f":"Aspire.Hosting.BrowserUserDataMode","k":"enum","p":"Aspire.Hosting.Browsers","s":"Selects the Chromium user data directory used by tracked browser sessions.","h":"/reference/api/typescript/aspire.hosting.browsers/browseruserdatamode/","v":"13.4.0-preview.1.26281.18"},{"n":"addDevTunnel","f":"addDevTunnel(name: string, tunnelId?: string, allowAnonymous?: boolean, description?: string, labels?: string[]): DevTunnelResource","k":"method","p":"Aspire.Hosting.DevTunnels","s":"Adds a Dev Tunnel resource to the distributed application model.","h":"/reference/api/typescript/aspire.hosting.devtunnels/adddevtunnel/","v":"13.4.0"},{"n":"getTunnelEndpoint","f":"getTunnelEndpoint(targetEndpointReference: EndpointReference): EndpointReference","k":"method","p":"Aspire.Hosting.DevTunnels","s":"Gets the tunnel endpoint reference for the specified target endpoint.","h":"/reference/api/typescript/aspire.hosting.devtunnels/gettunnelendpoint/","v":"13.4.0"},{"n":"withAnonymousAccess","f":"withAnonymousAccess(): DevTunnelResource","k":"method","p":"Aspire.Hosting.DevTunnels","s":"Allows the tunnel to be publicly accessed without authentication.","h":"/reference/api/typescript/aspire.hosting.devtunnels/withanonymousaccess/","v":"13.4.0"},{"n":"withTunnelReference","f":"withTunnelReference(targetEndpoint: EndpointReference): DevTunnelResource","k":"method","p":"Aspire.Hosting.DevTunnels","s":"Exposes the specified endpoint via the dev tunnel.","h":"/reference/api/typescript/aspire.hosting.devtunnels/withtunnelreference/","v":"13.4.0"},{"n":"withTunnelReferenceAll","f":"withTunnelReferenceAll(resourceBuilder: IResourceWithEndpoints, allowAnonymous: boolean): DevTunnelResource","k":"method","p":"Aspire.Hosting.DevTunnels","s":"Adds ports on the dev tunnel for all endpoints found on the referenced resource and sets whether anonymous access is allowed.","h":"/reference/api/typescript/aspire.hosting.devtunnels/withtunnelreferenceall/","v":"13.4.0"},{"n":"withTunnelReferenceAnonymous","f":"withTunnelReferenceAnonymous(targetEndpoint: EndpointReference, allowAnonymous: boolean): DevTunnelResource","k":"method","p":"Aspire.Hosting.DevTunnels","s":"Exposes the specified endpoint via the dev tunnel and sets whether anonymous access is allowed.","h":"/reference/api/typescript/aspire.hosting.devtunnels/withtunnelreferenceanonymous/","v":"13.4.0"},{"n":"DevTunnelResource","f":"Aspire.Hosting.DevTunnels.DevTunnelResource","k":"handle","p":"Aspire.Hosting.DevTunnels","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.devtunnels/devtunnelresource/","v":"13.4.0"},{"n":"addConfig","f":"addConfig(name: string, file?: string, content?: string, external?: boolean, configure?: (obj: Config) => Promise): ComposeFile","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a top-level config definition to the Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/addconfig/","v":"13.4.0"},{"n":"addDockerComposeEnvironment","f":"addDockerComposeEnvironment(name: string): DockerComposeEnvironmentResource","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a Docker Compose environment to the application model.","h":"/reference/api/typescript/aspire.hosting.docker/adddockercomposeenvironment/","v":"13.4.0"},{"n":"addNetwork","f":"addNetwork(name: string, driver?: string, external?: boolean, configure?: (obj: Network) => Promise): ComposeFile","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a top-level network definition to the Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/addnetwork/","v":"13.4.0"},{"n":"addSecret","f":"addSecret(name: string, file?: string, external?: boolean, configure?: (obj: Secret) => Promise): ComposeFile","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a top-level secret definition to the Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/addsecret/","v":"13.4.0"},{"n":"addService","f":"addService(name: string, image?: string, configure?: (obj: Service) => Promise): ComposeFile","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a service definition to the Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/addservice/","v":"13.4.0"},{"n":"addVolume","f":"addVolume(name: string, driver?: string, external?: boolean, configure?: (obj: Volume) => Promise): ComposeFile","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a top-level volume definition to the Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/addvolume-aspire-hosting-docker-resources-composefile-string-string-boolean-obj-volume-promise-void/","v":"13.4.0"},{"n":"addVolume","f":"addVolume(source: string, target: string, type?: string, isReadOnly?: boolean, configure?: (obj: Volume) => Promise): Service","k":"method","p":"Aspire.Hosting.Docker","s":"Adds a volume mount to a generated Docker Compose service.","h":"/reference/api/typescript/aspire.hosting.docker/addvolume-aspire-hosting-docker-resources-composenodes-service-string-string-string-boolean-obj-volume-promise-void/","v":"13.4.0"},{"n":"asEnvironmentPlaceholder","f":"asEnvironmentPlaceholder(dockerComposeService: DockerComposeServiceResource): string","k":"method","p":"Aspire.Hosting.Docker","s":"Creates a Docker Compose environment variable placeholder from a parameter builder","h":"/reference/api/typescript/aspire.hosting.docker/asenvironmentplaceholder/","v":"13.4.0"},{"n":"configureComposeFile","f":"configureComposeFile(configure: (obj: ComposeFile) => Promise): DockerComposeEnvironmentResource","k":"method","p":"Aspire.Hosting.Docker","s":"Configures the Docker Compose file for the environment resource.","h":"/reference/api/typescript/aspire.hosting.docker/configurecomposefile/","v":"13.4.0"},{"n":"configureDashboard","f":"configureDashboard(configure: (obj: DockerComposeAspireDashboardResource) => Promise): DockerComposeEnvironmentResource","k":"method","p":"Aspire.Hosting.Docker","s":"Configures the dashboard properties for this Docker Compose environment.","h":"/reference/api/typescript/aspire.hosting.docker/configuredashboard/","v":"13.4.0"},{"n":"configureEnvFile","f":"configureEnvFile(configure: (obj: Dict) => Promise): DockerComposeEnvironmentResource","k":"method","p":"Aspire.Hosting.Docker","s":"Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.","h":"/reference/api/typescript/aspire.hosting.docker/configureenvfile/","v":"13.4.0"},{"n":"publishAsDockerComposeService","f":"publishAsDockerComposeService(configure: (arg1: DockerComposeServiceResource, arg2: Service) => Promise): IComputeResource","k":"method","p":"Aspire.Hosting.Docker","s":"Publishes the specified resource as a Docker Compose service.","h":"/reference/api/typescript/aspire.hosting.docker/publishasdockercomposeservice/","v":"13.4.0"},{"n":"withDashboard","f":"withDashboard(enabled?: boolean): DockerComposeEnvironmentResource","k":"method","p":"Aspire.Hosting.Docker","s":"Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.","h":"/reference/api/typescript/aspire.hosting.docker/withdashboard/","v":"13.4.0"},{"n":"withForwardedHeaders","f":"withForwardedHeaders(enabled?: boolean): DockerComposeAspireDashboardResource","k":"method","p":"Aspire.Hosting.Docker","s":"Configures whether forwarded headers processing is enabled for the Aspire dashboard container.","h":"/reference/api/typescript/aspire.hosting.docker/withforwardedheaders/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port?: number): DockerComposeAspireDashboardResource","k":"method","p":"Aspire.Hosting.Docker","s":"Configures the port used to access the Aspire Dashboard from a browser.","h":"/reference/api/typescript/aspire.hosting.docker/withhostport/","v":"13.4.0"},{"n":"withProperties","f":"withProperties(configure: (obj: DockerComposeEnvironmentResource) => Promise): DockerComposeEnvironmentResource","k":"method","p":"Aspire.Hosting.Docker","s":"Allows setting the properties of a Docker Compose environment resource.","h":"/reference/api/typescript/aspire.hosting.docker/withproperties/","v":"13.4.0"},{"n":"CapturedEnvironmentVariable","f":"Aspire.Hosting.Docker.CapturedEnvironmentVariable","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a captured environment variable that will be written to the .env file adjacent to the Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/capturedenvironmentvariable/","v":"13.4.0"},{"n":"defaultValue","f":"CapturedEnvironmentVariable.defaultValue(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the default value for the environment variable.","t":"CapturedEnvironmentVariable","h":"/reference/api/typescript/aspire.hosting.docker/capturedenvironmentvariable/#defaultvalue","m":true,"v":"13.4.0"},{"n":"description","f":"CapturedEnvironmentVariable.description(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the description for the environment variable.","t":"CapturedEnvironmentVariable","h":"/reference/api/typescript/aspire.hosting.docker/capturedenvironmentvariable/#description","m":true,"v":"13.4.0"},{"n":"source","f":"CapturedEnvironmentVariable.source(): ContainerPortReference","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`.","t":"CapturedEnvironmentVariable","h":"/reference/api/typescript/aspire.hosting.docker/capturedenvironmentvariable/#source","m":true,"v":"13.4.0"},{"n":"DockerComposeAspireDashboardResource","f":"Aspire.Hosting.Docker.DockerComposeAspireDashboardResource","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeaspiredashboardresource/","v":"13.4.0"},{"n":"otlpGrpcEndpoint","f":"DockerComposeAspireDashboardResource.otlpGrpcEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Docker","s":"Gets the OTLP gRPC endpoint for telemetry data.","t":"DockerComposeAspireDashboardResource","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeaspiredashboardresource/#otlpgrpcendpoint","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"DockerComposeAspireDashboardResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Docker","s":"Gets the primary endpoint of the Aspire Dashboard.","t":"DockerComposeAspireDashboardResource","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeaspiredashboardresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"DockerComposeEnvironmentResource","f":"Aspire.Hosting.Docker.DockerComposeEnvironmentResource","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a Docker Compose environment resource that can host application resources.","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/","v":"13.4.0"},{"n":"dashboardEnabled","f":"DockerComposeEnvironmentResource.dashboardEnabled(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Determines whether to include an Aspire dashboard for telemetry visualization in this environment.","t":"DockerComposeEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/#dashboardenabled","m":true,"v":"13.4.0"},{"n":"defaultNetworkName","f":"DockerComposeEnvironmentResource.defaultNetworkName(): string","k":"property","p":"Aspire.Hosting.Docker","s":"The name of an existing network to be used.","t":"DockerComposeEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/#defaultnetworkname","m":true,"v":"13.4.0"},{"n":"getHostAddressExpression","f":"DockerComposeEnvironmentResource.getHostAddressExpression(endpointReference: EndpointReference): ReferenceExpression","k":"method","p":"Aspire.Hosting.Docker","s":"Invokes the GetHostAddressExpression method","t":"DockerComposeEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeenvironmentresource/gethostaddressexpression/","m":true,"v":"13.4.0"},{"n":"DockerComposeServiceResource","f":"Aspire.Hosting.Docker.DockerComposeServiceResource","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a compute resource for Docker Compose with strongly-typed properties.","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeserviceresource/","v":"13.4.0"},{"n":"parent","f":"DockerComposeServiceResource.parent(): DockerComposeEnvironmentResource","k":"property","p":"Aspire.Hosting.Docker","s":"Gets the Parent property","t":"DockerComposeServiceResource","h":"/reference/api/typescript/aspire.hosting.docker/dockercomposeserviceresource/#parent","m":true,"v":"13.4.0"},{"n":"ComposeFile","f":"Aspire.Hosting.Docker.Resources.ComposeFile","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a Docker Compose file with properties and configurations for services, networks, volumes, secrets, configs, and custom extensions.","h":"/reference/api/typescript/aspire.hosting.docker/composefile/","v":"13.4.0"},{"n":"configs","f":"ComposeFile.configs(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#configs","m":true,"v":"13.4.0"},{"n":"extensions","f":"ComposeFile.extensions(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#extensions","m":true,"v":"13.4.0"},{"n":"name","f":"ComposeFile.name(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the name of the Docker Compose file or project.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#name","m":true,"v":"13.4.0"},{"n":"networks","f":"ComposeFile.networks(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the collection of networks defined in a Docker Compose file.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#networks","m":true,"v":"13.4.0"},{"n":"secrets","f":"ComposeFile.secrets(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#secrets","m":true,"v":"13.4.0"},{"n":"services","f":"ComposeFile.services(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#services","m":true,"v":"13.4.0"},{"n":"version","f":"ComposeFile.version(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#version","m":true,"v":"13.4.0"},{"n":"volumes","f":"ComposeFile.volumes(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of volume definitions within a Docker Compose file.","t":"ComposeFile","h":"/reference/api/typescript/aspire.hosting.docker/composefile/#volumes","m":true,"v":"13.4.0"},{"n":"Config","f":"Aspire.Hosting.Docker.Resources.ComposeNodes.Config","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a configuration object in a Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/config/","v":"13.4.0"},{"n":"content","f":"Config.content(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file.","t":"Config","h":"/reference/api/typescript/aspire.hosting.docker/config/#content","m":true,"v":"13.4.0"},{"n":"external","f":"Config.external(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified.","t":"Config","h":"/reference/api/typescript/aspire.hosting.docker/config/#external","m":true,"v":"13.4.0"},{"n":"file","f":"Config.file(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component.","t":"Config","h":"/reference/api/typescript/aspire.hosting.docker/config/#file","m":true,"v":"13.4.0"},{"n":"labels","f":"Config.labels(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes.","t":"Config","h":"/reference/api/typescript/aspire.hosting.docker/config/#labels","m":true,"v":"13.4.0"},{"n":"name","f":"Config.name(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the Docker Compose member.","t":"Config","h":"/reference/api/typescript/aspire.hosting.docker/config/#name","m":true,"v":"13.4.0"},{"n":"Network","f":"Aspire.Hosting.Docker.Resources.ComposeNodes.Network","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a Docker network configuration as part of a Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/network/","v":"13.4.0"},{"n":"attachable","f":"Network.attachable(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#attachable","m":true,"v":"13.4.0"},{"n":"driver","f":"Network.driver(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#driver","m":true,"v":"13.4.0"},{"n":"driverOpts","f":"Network.driverOpts(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a dictionary of driver-specific options for the network configuration in a Docker service node.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#driveropts","m":true,"v":"13.4.0"},{"n":"external","f":"Network.external(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#external","m":true,"v":"13.4.0"},{"n":"ingress","f":"Network.ingress(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#ingress","m":true,"v":"13.4.0"},{"n":"internal","f":"Network.internal(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#internal","m":true,"v":"13.4.0"},{"n":"labels","f":"Network.labels(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#labels","m":true,"v":"13.4.0"},{"n":"name","f":"Network.name(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the Docker Compose member.","t":"Network","h":"/reference/api/typescript/aspire.hosting.docker/network/#name","m":true,"v":"13.4.0"},{"n":"Secret","f":"Aspire.Hosting.Docker.Resources.ComposeNodes.Secret","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a Secret object in a Docker Compose configuration file.","h":"/reference/api/typescript/aspire.hosting.docker/secret/","v":"13.4.0"},{"n":"external","f":"Secret.external(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified.","t":"Secret","h":"/reference/api/typescript/aspire.hosting.docker/secret/#external","m":true,"v":"13.4.0"},{"n":"file","f":"Secret.file(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container.","t":"Secret","h":"/reference/api/typescript/aspire.hosting.docker/secret/#file","m":true,"v":"13.4.0"},{"n":"labels","f":"Secret.labels(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user.","t":"Secret","h":"/reference/api/typescript/aspire.hosting.docker/secret/#labels","m":true,"v":"13.4.0"},{"n":"name","f":"Secret.name(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the secret in the Docker Compose configuration.","t":"Secret","h":"/reference/api/typescript/aspire.hosting.docker/secret/#name","m":true,"v":"13.4.0"},{"n":"Service","f":"Aspire.Hosting.Docker.Resources.ComposeNodes.Service","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a Docker Compose service definition.","h":"/reference/api/typescript/aspire.hosting.docker/service/","v":"13.4.0"},{"n":"capAdd","f":"Service.capAdd(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies a list of Linux capabilities to add to the container.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#capadd","m":true,"v":"13.4.0"},{"n":"capDrop","f":"Service.capDrop(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#capdrop","m":true,"v":"13.4.0"},{"n":"cgroupParent","f":"Service.cgroupParent(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#cgroupparent","m":true,"v":"13.4.0"},{"n":"command","f":"Service.command(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#command","m":true,"v":"13.4.0"},{"n":"configs","f":"Service.configs(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#configs","m":true,"v":"13.4.0"},{"n":"containerName","f":"Service.containerName(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#containername","m":true,"v":"13.4.0"},{"n":"dependsOn","f":"Service.dependsOn(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#dependson","m":true,"v":"13.4.0"},{"n":"devices","f":"Service.devices(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#devices","m":true,"v":"13.4.0"},{"n":"dns","f":"Service.dns(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a list of custom DNS server IP addresses to be used by the service container.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#dns","m":true,"v":"13.4.0"},{"n":"dnsSearch","f":"Service.dnsSearch(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#dnssearch","m":true,"v":"13.4.0"},{"n":"domainName","f":"Service.domainName(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the domain name of a service container.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#domainname","m":true,"v":"13.4.0"},{"n":"entrypoint","f":"Service.entrypoint(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#entrypoint","m":true,"v":"13.4.0"},{"n":"envFile","f":"Service.envFile(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#envfile","m":true,"v":"13.4.0"},{"n":"environment","f":"Service.environment(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of environment variables for the service container.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#environment","m":true,"v":"13.4.0"},{"n":"expose","f":"Service.expose(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#expose","m":true,"v":"13.4.0"},{"n":"externalLinks","f":"Service.externalLinks(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#externallinks","m":true,"v":"13.4.0"},{"n":"extraHosts","f":"Service.extraHosts(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#extrahosts","m":true,"v":"13.4.0"},{"n":"groupAdd","f":"Service.groupAdd(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#groupadd","m":true,"v":"13.4.0"},{"n":"hostname","f":"Service.hostname(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#hostname","m":true,"v":"13.4.0"},{"n":"image","f":"Service.image(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the Docker image to be used for the service.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#image","m":true,"v":"13.4.0"},{"n":"init","f":"Service.init(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#init","m":true,"v":"13.4.0"},{"n":"ipc","f":"Service.ipc(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#ipc","m":true,"v":"13.4.0"},{"n":"isolation","f":"Service.isolation(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#isolation","m":true,"v":"13.4.0"},{"n":"labels","f":"Service.labels(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#labels","m":true,"v":"13.4.0"},{"n":"links","f":"Service.links(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a service definition in a Docker Compose configuration file.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#links","m":true,"v":"13.4.0"},{"n":"macAddress","f":"Service.macAddress(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies a custom MAC (Media Access Control) address for the container's network interface.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#macaddress","m":true,"v":"13.4.0"},{"n":"name","f":"Service.name(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the Docker Compose member.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#name","m":true,"v":"13.4.0"},{"n":"networkMode","f":"Service.networkMode(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#networkmode","m":true,"v":"13.4.0"},{"n":"networks","f":"Service.networks(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#networks","m":true,"v":"13.4.0"},{"n":"pid","f":"Service.pid(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#pid","m":true,"v":"13.4.0"},{"n":"ports","f":"Service.ports(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#ports","m":true,"v":"13.4.0"},{"n":"privileged","f":"Service.privileged(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#privileged","m":true,"v":"13.4.0"},{"n":"profiles","f":"Service.profiles(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#profiles","m":true,"v":"13.4.0"},{"n":"pullPolicy","f":"Service.pullPolicy(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the policy for pulling the Docker image.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#pullpolicy","m":true,"v":"13.4.0"},{"n":"readOnly","f":"Service.readOnly(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#readonly","m":true,"v":"13.4.0"},{"n":"restart","f":"Service.restart(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\".","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#restart","m":true,"v":"13.4.0"},{"n":"secrets","f":"Service.secrets(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of secret references used by the service.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#secrets","m":true,"v":"13.4.0"},{"n":"securityOpt","f":"Service.securityOpt(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#securityopt","m":true,"v":"13.4.0"},{"n":"stdinOpen","f":"Service.stdinOpen(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#stdinopen","m":true,"v":"13.4.0"},{"n":"stopGracePeriod","f":"Service.stopGracePeriod(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#stopgraceperiod","m":true,"v":"13.4.0"},{"n":"stopSignal","f":"Service.stopSignal(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#stopsignal","m":true,"v":"13.4.0"},{"n":"sysctls","f":"Service.sysctls(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#sysctls","m":true,"v":"13.4.0"},{"n":"tmpfs","f":"Service.tmpfs(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#tmpfs","m":true,"v":"13.4.0"},{"n":"tty","f":"Service.tty(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#tty","m":true,"v":"13.4.0"},{"n":"ulimits","f":"Service.ulimits(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#ulimits","m":true,"v":"13.4.0"},{"n":"user","f":"Service.user(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\").","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#user","m":true,"v":"13.4.0"},{"n":"volumes","f":"Service.volumes(): List","k":"property","p":"Aspire.Hosting.Docker","s":"Defines the list of volumes to be mounted into the service's container.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#volumes","m":true,"v":"13.4.0"},{"n":"workingDir","f":"Service.workingDir(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file.","t":"Service","h":"/reference/api/typescript/aspire.hosting.docker/service/#workingdir","m":true,"v":"13.4.0"},{"n":"ServiceDependency","f":"Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a service dependency in a Docker Compose file.","h":"/reference/api/typescript/aspire.hosting.docker/servicedependency/","v":"13.4.0"},{"n":"condition","f":"ServiceDependency.condition(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the condition under which the service should be started.","t":"ServiceDependency","h":"/reference/api/typescript/aspire.hosting.docker/servicedependency/#condition","m":true,"v":"13.4.0"},{"n":"ConfigReference","f":"Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a reference to a configuration used within a service resource.","h":"/reference/api/typescript/aspire.hosting.docker/configreference/","v":"13.4.0"},{"n":"gid","f":"ConfigReference.gid(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the group ID (GID) used to identify the group of the referenced configuration.","t":"ConfigReference","h":"/reference/api/typescript/aspire.hosting.docker/configreference/#gid","m":true,"v":"13.4.0"},{"n":"mode","f":"ConfigReference.mode(): UnixFileMode","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes.","t":"ConfigReference","h":"/reference/api/typescript/aspire.hosting.docker/configreference/#mode","m":true,"v":"13.4.0"},{"n":"source","f":"ConfigReference.source(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node.","t":"ConfigReference","h":"/reference/api/typescript/aspire.hosting.docker/configreference/#source","m":true,"v":"13.4.0"},{"n":"target","f":"ConfigReference.target(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service.","t":"ConfigReference","h":"/reference/api/typescript/aspire.hosting.docker/configreference/#target","m":true,"v":"13.4.0"},{"n":"uid","f":"ConfigReference.uid(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target.","t":"ConfigReference","h":"/reference/api/typescript/aspire.hosting.docker/configreference/#uid","m":true,"v":"13.4.0"},{"n":"SecretReference","f":"Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a reference to a secret within a Docker service configuration.","h":"/reference/api/typescript/aspire.hosting.docker/secretreference/","v":"13.4.0"},{"n":"gid","f":"SecretReference.gid(): number","k":"property","p":"Aspire.Hosting.Docker","s":"Represents the group ID (GID) associated with the secret reference in a Docker service node.","t":"SecretReference","h":"/reference/api/typescript/aspire.hosting.docker/secretreference/#gid","m":true,"v":"13.4.0"},{"n":"mode","f":"SecretReference.mode(): number","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value.","t":"SecretReference","h":"/reference/api/typescript/aspire.hosting.docker/secretreference/#mode","m":true,"v":"13.4.0"},{"n":"source","f":"SecretReference.source(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived.","t":"SecretReference","h":"/reference/api/typescript/aspire.hosting.docker/secretreference/#source","m":true,"v":"13.4.0"},{"n":"target","f":"SecretReference.target(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system.","t":"SecretReference","h":"/reference/api/typescript/aspire.hosting.docker/secretreference/#target","m":true,"v":"13.4.0"},{"n":"uid","f":"SecretReference.uid(): number","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container.","t":"SecretReference","h":"/reference/api/typescript/aspire.hosting.docker/secretreference/#uid","m":true,"v":"13.4.0"},{"n":"Ulimit","f":"Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents the configuration for system resource limits (ulimits) for a container.","h":"/reference/api/typescript/aspire.hosting.docker/ulimit/","v":"13.4.0"},{"n":"hard","f":"Ulimit.hard(): number","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the hard limit for the resource control.","t":"Ulimit","h":"/reference/api/typescript/aspire.hosting.docker/ulimit/#hard","m":true,"v":"13.4.0"},{"n":"soft","f":"Ulimit.soft(): number","k":"property","p":"Aspire.Hosting.Docker","s":"Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set.","t":"Ulimit","h":"/reference/api/typescript/aspire.hosting.docker/ulimit/#soft","m":true,"v":"13.4.0"},{"n":"Volume","f":"Aspire.Hosting.Docker.Resources.ServiceNodes.Volume","k":"handle","p":"Aspire.Hosting.Docker","s":"Represents a volume definition in a Docker Compose configuration file.","h":"/reference/api/typescript/aspire.hosting.docker/volume/","v":"13.4.0"},{"n":"driver","f":"Volume.driver(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#driver","m":true,"v":"13.4.0"},{"n":"driverOpts","f":"Volume.driverOpts(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#driveropts","m":true,"v":"13.4.0"},{"n":"external","f":"Volume.external(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#external","m":true,"v":"13.4.0"},{"n":"labels","f":"Volume.labels(): Dict","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#labels","m":true,"v":"13.4.0"},{"n":"name","f":"Volume.name(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the name of the Docker Compose member.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#name","m":true,"v":"13.4.0"},{"n":"readOnly","f":"Volume.readOnly(): boolean","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets a value indicating whether the volume is mounted as read-only.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#readonly","m":true,"v":"13.4.0"},{"n":"source","f":"Volume.source(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#source","m":true,"v":"13.4.0"},{"n":"target","f":"Volume.target(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#target","m":true,"v":"13.4.0"},{"n":"type","f":"Volume.type(): string","k":"property","p":"Aspire.Hosting.Docker","s":"Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker.","t":"Volume","h":"/reference/api/typescript/aspire.hosting.docker/volume/#type","m":true,"v":"13.4.0"},{"n":"addEFMigrations","f":"addEFMigrations(name: string, dbContextTypeName?: string): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Adds EF Core migration management for polyglot app hosts.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/addefmigrations/","v":"13.4.0-preview.1.26281.18"},{"n":"publishAsMigrationBundle","f":"publishAsMigrationBundle(targetRuntime?: string, selfContained?: boolean, publishContainer?: boolean, baseImage?: string): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Configures the EF migration resource to generate a migration bundle during publishing.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/publishasmigrationbundle/","v":"13.4.0-preview.1.26281.18"},{"n":"publishAsMigrationScript","f":"publishAsMigrationScript(idempotent?: boolean, noTransactions?: boolean): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Configures the EF migration resource to generate a migration script during publishing.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/publishasmigrationscript/","v":"13.4.0-preview.1.26281.18"},{"n":"runDatabaseUpdateOnStart","f":"runDatabaseUpdateOnStart(): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Configures the EF migration resource to run database update when the AppHost starts.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/rundatabaseupdateonstart/","v":"13.4.0-preview.1.26281.18"},{"n":"withMigrationNamespace","f":"withMigrationNamespace(namespace: string): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Configures the namespace for new migrations created with the Add Migration command.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/withmigrationnamespace/","v":"13.4.0-preview.1.26281.18"},{"n":"withMigrationOutputDirectory","f":"withMigrationOutputDirectory(outputDirectory: string): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Configures the output directory for new migrations created with the Add Migration command.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/withmigrationoutputdirectory/","v":"13.4.0-preview.1.26281.18"},{"n":"withMigrationsProject","f":"withMigrationsProject(migrationsProject?: ProjectResource): EFMigrationResource","k":"method","p":"Aspire.Hosting.EntityFrameworkCore","s":"Configures a separate project containing migrations for polyglot app hosts.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/withmigrationsproject/","v":"13.4.0-preview.1.26281.18"},{"n":"EFMigrationResource","f":"Aspire.Hosting.EntityFrameworkCore.EFMigrationResource","k":"handle","p":"Aspire.Hosting.EntityFrameworkCore","s":"Represents an EF Core migration resource associated with a project.","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/","v":"13.4.0-preview.1.26281.18"},{"n":"bundleBaseImage","f":"EFMigrationResource.bundleBaseImage(): string","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets the base container image for the migration bundle container.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#bundlebaseimage","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"bundleSelfContained","f":"EFMigrationResource.bundleSelfContained(): boolean","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets whether the migration bundle should be self-contained.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#bundleselfcontained","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"bundleTargetRuntime","f":"EFMigrationResource.bundleTargetRuntime(): string","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\").","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#bundletargetruntime","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"dbContextTypeName","f":"EFMigrationResource.dbContextTypeName(): string","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets the fully qualified name of the DbContext type to use for migrations, or null to auto-detect.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#dbcontexttypename","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"migrationNamespace","f":"EFMigrationResource.migrationNamespace(): string","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets the namespace for new migrations. Used by the Add Migration command.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#migrationnamespace","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"migrationOutputDirectory","f":"EFMigrationResource.migrationOutputDirectory(): string","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets the output directory for new migrations. Used by the Add Migration command.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#migrationoutputdirectory","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"migrationsProjectPath","f":"EFMigrationResource.migrationsProjectPath(): string","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets the path to the project containing the migrations, when it's not the same as the startup project.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#migrationsprojectpath","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"projectResource","f":"EFMigrationResource.projectResource(): ProjectResource","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets the parent project resource that contains the DbContext.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#projectresource","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"publishBundleContainer","f":"EFMigrationResource.publishBundleContainer(): boolean","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#publishbundlecontainer","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"scriptIdempotent","f":"EFMigrationResource.scriptIdempotent(): boolean","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks).","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#scriptidempotent","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"scriptNoTransactions","f":"EFMigrationResource.scriptNoTransactions(): boolean","k":"property","p":"Aspire.Hosting.EntityFrameworkCore","s":"Gets or sets whether to omit transaction statements from the migration script.","t":"EFMigrationResource","h":"/reference/api/typescript/aspire.hosting.entityframeworkcore/efmigrationresource/#scriptnotransactions","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"addAISearchTool","f":"addAISearchTool(name: string, indexName?: string): AzureAISearchToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds an Azure AI Search tool to a Microsoft Foundry project, enabling agents to ground their responses using data from an Azure AI Search index.","h":"/reference/api/typescript/aspire.hosting.foundry/addaisearchtool/","v":"13.4.0-preview.1.26281.18"},{"n":"addAzureFunctionTool","f":"addAzureFunctionTool(name: string, functionName: string, description: string, parametersJson: string, inputQueueEndpoint: string, inputQueueName: string, outputQueueEndpoint: string, outputQueueName: string): AzureFunctionToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds an Azure Function tool to a Microsoft Foundry project, enabling agents to invoke a serverless Azure Function with queue-based input/output bindings.","h":"/reference/api/typescript/aspire.hosting.foundry/addazurefunctiontool/","v":"13.4.0-preview.1.26281.18"},{"n":"addBingGroundingConnection","f":"addBingGroundingConnection(name: string, bingResourceId: string): BingGroundingConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Grounding with Bing Search connection to a Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/addbinggroundingconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addBingGroundingConnectionFromParameter","f":"addBingGroundingConnectionFromParameter(name: string, bingResourceId: ParameterResource): BingGroundingConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Grounding with Bing Search connection to a Microsoft Foundry project using a parameter resource for the Bing resource ID.","h":"/reference/api/typescript/aspire.hosting.foundry/addbinggroundingconnectionfromparameter/","v":"13.4.0-preview.1.26281.18"},{"n":"addBingGroundingTool","f":"addBingGroundingTool(name: string): BingGroundingToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Bing Grounding tool to a Microsoft Foundry project, enabling agents to ground their responses using Bing Search results.","h":"/reference/api/typescript/aspire.hosting.foundry/addbinggroundingtool/","v":"13.4.0-preview.1.26281.18"},{"n":"addCapabilityHost","f":"addCapabilityHost(name: string): AzureCognitiveServicesProjectResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a capability host to the Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/addcapabilityhost/","v":"13.4.0-preview.1.26281.18"},{"n":"addCodeInterpreterTool","f":"addCodeInterpreterTool(name: string): CodeInterpreterToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Code Interpreter tool to a Microsoft Foundry project, enabling agents to write and run Python code in a sandboxed environment for data analysis, math, and chart generation.","h":"/reference/api/typescript/aspire.hosting.foundry/addcodeinterpretertool/","v":"13.4.0-preview.1.26281.18"},{"n":"addComputerUseTool","f":"addComputerUseTool(name: string, displayWidth?: number, displayHeight?: number, environment?: string): ComputerToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Computer Use tool to a Microsoft Foundry project, enabling agents to interact with a computer desktop by taking screenshots, moving the mouse, clicking, and typing.","h":"/reference/api/typescript/aspire.hosting.foundry/addcomputerusetool/","v":"13.4.0-preview.1.26281.18"},{"n":"addConnection","f":"addConnection(resource: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a connection to a Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/addconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addContainerRegistryConnection","f":"addContainerRegistryConnection(registry: AzureContainerRegistryResource): AzureCognitiveServicesProjectConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a container registry connection to the Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/addcontainerregistryconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addCosmosConnection","f":"addCosmosConnection(db: AzureCosmosDBResource): AzureCognitiveServicesProjectConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds CosmosDB to a project as a connection","h":"/reference/api/typescript/aspire.hosting.foundry/addcosmosconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addDeployment","f":"addDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.","h":"/reference/api/typescript/aspire.hosting.foundry/adddeployment/","v":"13.4.0-preview.1.26281.18"},{"n":"addFabricTool","f":"addFabricTool(name: string, projectConnectionIds: string[]): FabricToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Microsoft Fabric data agent tool to a Microsoft Foundry project, enabling agents to query data through Fabric data agents.","h":"/reference/api/typescript/aspire.hosting.foundry/addfabrictool/","v":"13.4.0-preview.1.26281.18"},{"n":"addFileSearchTool","f":"addFileSearchTool(name: string, vectorStoreIds: string[]): FileSearchToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a File Search tool to a Microsoft Foundry project, enabling agents to search uploaded files and proprietary documents using vector search.","h":"/reference/api/typescript/aspire.hosting.foundry/addfilesearchtool/","v":"13.4.0-preview.1.26281.18"},{"n":"addFoundry","f":"addFoundry(name: string): FoundryResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Microsoft Foundry resource to the application model.","h":"/reference/api/typescript/aspire.hosting.foundry/addfoundry/","v":"13.4.0-preview.1.26281.18"},{"n":"addFunctionTool","f":"addFunctionTool(name: string, functionName: string, parametersJson: string, description?: string, strictModeEnabled?: boolean): FunctionToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a function calling tool to a Microsoft Foundry project, enabling agents to call application-defined functions with structured parameters.","h":"/reference/api/typescript/aspire.hosting.foundry/addfunctiontool/","v":"13.4.0-preview.1.26281.18"},{"n":"addImageGenerationTool","f":"addImageGenerationTool(name: string): ImageGenerationToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds an Image Generation tool to a Microsoft Foundry project, enabling agents to generate and edit images.","h":"/reference/api/typescript/aspire.hosting.foundry/addimagegenerationtool/","v":"13.4.0-preview.1.26281.18"},{"n":"addKeyVaultConnection","f":"addKeyVaultConnection(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Key Vault connection to the Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/addkeyvaultconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addModelDeployment","f":"addModelDeployment(name: string, model: FoundryModel|string, modelVersion?: string, format?: string): FoundryDeploymentResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a model deployment to the parent Microsoft Foundry resource.","h":"/reference/api/typescript/aspire.hosting.foundry/addmodeldeployment/","v":"13.4.0-preview.1.26281.18"},{"n":"addProject","f":"addProject(name: string): AzureCognitiveServicesProjectResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Microsoft Foundry project resource to the application model. This will also attach the project as a deployment target for agents.","h":"/reference/api/typescript/aspire.hosting.foundry/addproject/","v":"13.4.0-preview.1.26281.18"},{"n":"addPromptAgent","f":"addPromptAgent(name: string, model: FoundryDeploymentResource, instructions?: string): AzurePromptAgentResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a prompt agent to a Microsoft Foundry project with the specified tools.","h":"/reference/api/typescript/aspire.hosting.foundry/addpromptagent/","v":"13.4.0-preview.1.26281.18"},{"n":"addSearchConnection","f":"addSearchConnection(search: AzureSearchResource): AzureCognitiveServicesProjectConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds an Azure AI Search connection to a Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/addsearchconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addSharePointTool","f":"addSharePointTool(name: string, projectConnectionIds: string[]): SharePointToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a SharePoint grounding tool to a Microsoft Foundry project, enabling agents to search data from SharePoint sites configured as Foundry project connections.","h":"/reference/api/typescript/aspire.hosting.foundry/addsharepointtool/","v":"13.4.0-preview.1.26281.18"},{"n":"addStorageConnection","f":"addStorageConnection(storage: AzureStorageResource): AzureCognitiveServicesProjectConnectionResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds an Azure Storage account to a project as a connection.","h":"/reference/api/typescript/aspire.hosting.foundry/addstorageconnection/","v":"13.4.0-preview.1.26281.18"},{"n":"addWebSearchTool","f":"addWebSearchTool(name: string): WebSearchToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Web Search tool to a Microsoft Foundry project, enabling agents to retrieve real-time information from the public web and return answers with inline citations.","h":"/reference/api/typescript/aspire.hosting.foundry/addwebsearchtool/","v":"13.4.0-preview.1.26281.18"},{"n":"asHostedAgent","f":"asHostedAgent(project: AzureCognitiveServicesProjectResource, options?: HostedAgentOptions): IResourceWithEndpoints","k":"method","p":"Aspire.Hosting.Foundry","s":"Configures the resource to run and publish as a hosted agent in Microsoft Foundry, targeting the specified Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/ashostedagent/","v":"13.4.0-preview.1.26281.18"},{"n":"runAsFoundryLocal","f":"runAsFoundryLocal(): FoundryResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Foundry Local resource to the distributed application builder.","h":"/reference/api/typescript/aspire.hosting.foundry/runasfoundrylocal/","v":"13.4.0-preview.1.26281.18"},{"n":"withAppInsights","f":"withAppInsights(appInsights: AzureApplicationInsightsResource): AzureCognitiveServicesProjectResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds an Application Insights resource to the Microsoft Foundry project, overriding the default (which is to create a new Application Insights resource).","h":"/reference/api/typescript/aspire.hosting.foundry/withappinsights/","v":"13.4.0-preview.1.26281.18"},{"n":"withCapabilityHost","f":"withCapabilityHost(resource: FoundryResource): AzureCognitiveServicesProjectResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Associates a supported resource with a capability host on a Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/withcapabilityhost/","v":"13.4.0-preview.1.26281.18"},{"n":"withFoundryRoleAssignments","f":"withFoundryRoleAssignments(target: FoundryResource, roles: FoundryRole[]): IResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Assigns the specified roles to the given resource, granting it the necessary permissions on the target Microsoft Foundry resource. This replaces the default role assignments for the resource.","h":"/reference/api/typescript/aspire.hosting.foundry/withfoundryroleassignments/","v":"13.4.0-preview.1.26281.18"},{"n":"withKeyVault","f":"withKeyVault(keyVault: AzureKeyVaultResource): AzureCognitiveServicesProjectResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a Key Vault connection to the Microsoft Foundry project.","h":"/reference/api/typescript/aspire.hosting.foundry/withkeyvault/","v":"13.4.0-preview.1.26281.18"},{"n":"withProperties","f":"withProperties(configure: (obj: FoundryDeploymentResource) => Promise): FoundryDeploymentResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Allows setting the properties of a Microsoft Foundry Deployment resource.","h":"/reference/api/typescript/aspire.hosting.foundry/withproperties/","v":"13.4.0-preview.1.26281.18"},{"n":"withReference","f":"withReference(search: AzureSearchResource): AzureAISearchToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Links an Azure AI Search tool to a backing search resource.","h":"/reference/api/typescript/aspire.hosting.foundry/withreference-aspire-hosting-foundry-azureaisearchtoolresource-azuresearchresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withReference","f":"withReference(bingReference: ParameterResource): BingGroundingToolResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Links a Bing Grounding tool to a Bing Search resource or connection.","h":"/reference/api/typescript/aspire.hosting.foundry/withreference-aspire-hosting-foundry-binggroundingtoolresource-parameterresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withTool","f":"withTool(tool: FoundryToolResource): AzurePromptAgentResource","k":"method","p":"Aspire.Hosting.Foundry","s":"Adds a tool to a prompt agent.","h":"/reference/api/typescript/aspire.hosting.foundry/withtool/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureAISearchToolResource","f":"Aspire.Hosting.Foundry.AzureAISearchToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that grounds an agent's responses using data from an Azure AI Search index.","h":"/reference/api/typescript/aspire.hosting.foundry/azureaisearchtoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureCognitiveServicesProjectConnectionResource","f":"Aspire.Hosting.Foundry.AzureCognitiveServicesProjectConnectionResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.foundry/azurecognitiveservicesprojectconnectionresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureCognitiveServicesProjectResource","f":"Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.foundry/azurecognitiveservicesprojectresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzureFunctionToolResource","f":"Aspire.Hosting.Foundry.AzureFunctionToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to invoke an Azure Function.","h":"/reference/api/typescript/aspire.hosting.foundry/azurefunctiontoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"AzurePromptAgentResource","f":"Aspire.Hosting.Foundry.AzurePromptAgentResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"Represents a Microsoft Foundry prompt agent resource that is provisioned on Azure.","h":"/reference/api/typescript/aspire.hosting.foundry/azurepromptagentresource/","v":"13.4.0-preview.1.26281.18"},{"n":"connectionStringExpression","f":"AzurePromptAgentResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets the ConnectionStringExpression property","t":"AzurePromptAgentResource","h":"/reference/api/typescript/aspire.hosting.foundry/azurepromptagentresource/#connectionstringexpression","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"description","f":"AzurePromptAgentResource.description(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets a description of the agent.","t":"AzurePromptAgentResource","h":"/reference/api/typescript/aspire.hosting.foundry/azurepromptagentresource/#description","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"instructions","f":"AzurePromptAgentResource.instructions(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the system instructions for the agent.","t":"AzurePromptAgentResource","h":"/reference/api/typescript/aspire.hosting.foundry/azurepromptagentresource/#instructions","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"metadata","f":"AzurePromptAgentResource.metadata(): Dict","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets the metadata to associate with the agent.","t":"AzurePromptAgentResource","h":"/reference/api/typescript/aspire.hosting.foundry/azurepromptagentresource/#metadata","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"model","f":"AzurePromptAgentResource.model(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the model deployment name used by this agent.","t":"AzurePromptAgentResource","h":"/reference/api/typescript/aspire.hosting.foundry/azurepromptagentresource/#model","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"BingGroundingConnectionResource","f":"Aspire.Hosting.Foundry.BingGroundingConnectionResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry project connection resource specifically for Grounding with Bing Search connections.","h":"/reference/api/typescript/aspire.hosting.foundry/binggroundingconnectionresource/","v":"13.4.0-preview.1.26281.18"},{"n":"BingGroundingToolResource","f":"Aspire.Hosting.Foundry.BingGroundingToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that grounds an agent's responses using Bing Search.","h":"/reference/api/typescript/aspire.hosting.foundry/binggroundingtoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"CodeInterpreterToolResource","f":"Aspire.Hosting.Foundry.CodeInterpreterToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to write and run Python code in a sandboxed environment for data analysis, math, and chart generation.","h":"/reference/api/typescript/aspire.hosting.foundry/codeinterpretertoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"ComputerToolResource","f":"Aspire.Hosting.Foundry.ComputerToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to interact with a computer desktop by taking screenshots, moving the mouse, clicking, and typing.","h":"/reference/api/typescript/aspire.hosting.foundry/computertoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"FabricToolResource","f":"Aspire.Hosting.Foundry.FabricToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to query data using a Microsoft Fabric data agent.","h":"/reference/api/typescript/aspire.hosting.foundry/fabrictoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"FileSearchToolResource","f":"Aspire.Hosting.Foundry.FileSearchToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to search uploaded files and proprietary documents using vector search.","h":"/reference/api/typescript/aspire.hosting.foundry/filesearchtoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"FoundryDeploymentResource","f":"Aspire.Hosting.Foundry.FoundryDeploymentResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"Represents a Microsoft Foundry Deployment.","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/","v":"13.4.0-preview.1.26281.18"},{"n":"connectionStringExpression","f":"FoundryDeploymentResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets the connection string expression for the Microsoft Foundry resource with model/deployment information.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#connectionstringexpression","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"deploymentName","f":"FoundryDeploymentResource.deploymentName(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the name of the deployment.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#deploymentname","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"format","f":"FoundryDeploymentResource.format(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the format of deployment model.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#format","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"modelName","f":"FoundryDeploymentResource.modelName(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the name of the model.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#modelname","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"modelVersion","f":"FoundryDeploymentResource.modelVersion(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the version of the model.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#modelversion","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"parent","f":"FoundryDeploymentResource.parent(): FoundryResource","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets the parent Microsoft Foundry resource.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#parent","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"skuCapacity","f":"FoundryDeploymentResource.skuCapacity(): number","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM).","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#skucapacity","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"skuName","f":"FoundryDeploymentResource.skuName(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"Gets or sets the name of the SKU.","t":"FoundryDeploymentResource","h":"/reference/api/typescript/aspire.hosting.foundry/foundrydeploymentresource/#skuname","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"FoundryResource","f":"Aspire.Hosting.Foundry.FoundryResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"Represents a Microsoft Foundry resource. This corresponds to the Azure Cognitive Services account with Microsoft Foundry capabilities enabled.","h":"/reference/api/typescript/aspire.hosting.foundry/foundryresource/","v":"13.4.0-preview.1.26281.18"},{"n":"FoundryToolResource","f":"Aspire.Hosting.Foundry.FoundryToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"Base class for Foundry tool resources that participate in the Aspire application model.","h":"/reference/api/typescript/aspire.hosting.foundry/foundrytoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"FunctionToolResource","f":"Aspire.Hosting.Foundry.FunctionToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to call a user-defined function.","h":"/reference/api/typescript/aspire.hosting.foundry/functiontoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"HostedAgentConfiguration","f":"Aspire.Hosting.Foundry.HostedAgentConfiguration","k":"handle","p":"Aspire.Hosting.Foundry","s":"A configuration helper for hosted agents.","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentconfiguration/","v":"13.4.0-preview.1.26281.18"},{"n":"cpu","f":"HostedAgentConfiguration.cpu(): number","k":"property","p":"Aspire.Hosting.Foundry","s":"CPU allocation for each hosted agent instance, in vCPU cores.","t":"HostedAgentConfiguration","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentconfiguration/#cpu","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"description","f":"HostedAgentConfiguration.description(): string","k":"property","p":"Aspire.Hosting.Foundry","s":"The description of the hosted agent.","t":"HostedAgentConfiguration","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentconfiguration/#description","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"environmentVariables","f":"HostedAgentConfiguration.environmentVariables(): Dict","k":"property","p":"Aspire.Hosting.Foundry","s":"Environment variables to set in the hosted agent container.","t":"HostedAgentConfiguration","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentconfiguration/#environmentvariables","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"memory","f":"HostedAgentConfiguration.memory(): number","k":"property","p":"Aspire.Hosting.Foundry","s":"Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation.","t":"HostedAgentConfiguration","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentconfiguration/#memory","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"metadata","f":"HostedAgentConfiguration.metadata(): Dict","k":"property","p":"Aspire.Hosting.Foundry","s":"Additional metadata to associate with the hosted agent.","t":"HostedAgentConfiguration","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentconfiguration/#metadata","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"ImageGenerationToolResource","f":"Aspire.Hosting.Foundry.ImageGenerationToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that enables an agent to generate and edit images.","h":"/reference/api/typescript/aspire.hosting.foundry/imagegenerationtoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"SharePointToolResource","f":"Aspire.Hosting.Foundry.SharePointToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that grounds an agent's responses using SharePoint data.","h":"/reference/api/typescript/aspire.hosting.foundry/sharepointtoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"WebSearchToolResource","f":"Aspire.Hosting.Foundry.WebSearchToolResource","k":"handle","p":"Aspire.Hosting.Foundry","s":"A Foundry tool resource that retrieves real-time information from the public web and returns answers with inline citations.","h":"/reference/api/typescript/aspire.hosting.foundry/websearchtoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"FoundryModel","f":"Aspire.Hosting.Foundry.FoundryModel","k":"type","p":"Aspire.Hosting.Foundry","s":"Describes a model that can be deployed to Microsoft Foundry.","h":"/reference/api/typescript/aspire.hosting.foundry/foundrymodel/","v":"13.4.0-preview.1.26281.18"},{"n":"HostedAgentOptions","f":"Aspire.Hosting.Foundry.HostedAgentOptions","k":"type","p":"Aspire.Hosting.Foundry","s":"Options that control how a compute resource is deployed as a Microsoft Foundry hosted agent. All properties are optional; unset properties fall back to the Foundry hosted agent defaults.","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentoptions/","v":"13.4.0-preview.1.26281.18"},{"n":"HostedAgentProtocolVersion","f":"Aspire.Hosting.Foundry.HostedAgentProtocolVersion","k":"type","p":"Aspire.Hosting.Foundry","s":"A protocol and version supported by a Microsoft Foundry hosted agent container.","h":"/reference/api/typescript/aspire.hosting.foundry/hostedagentprotocolversion/","v":"13.4.0-preview.1.26281.18"},{"n":"FoundryRole","f":"Aspire.Hosting.FoundryRole","k":"enum","p":"Aspire.Hosting.Foundry","s":"Represents ATS-compatible Microsoft Foundry roles.","h":"/reference/api/typescript/aspire.hosting.foundry/foundryrole/","v":"13.4.0-preview.1.26281.18"},{"n":"addGarnet","f":"addGarnet(name: string, port?: number, password?: ParameterResource): GarnetResource","k":"method","p":"Aspire.Hosting.Garnet","s":"Adds a Garnet container resource to the application model.","h":"/reference/api/typescript/aspire.hosting.garnet/addgarnet/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): GarnetResource","k":"method","p":"Aspire.Hosting.Garnet","s":"Adds a bind mount for the data folder to a Garnet container resource and enables Garnet persistence.","h":"/reference/api/typescript/aspire.hosting.garnet/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): GarnetResource","k":"method","p":"Aspire.Hosting.Garnet","s":"Adds a named volume for the data folder to a Garnet container resource and enables Garnet persistence.","h":"/reference/api/typescript/aspire.hosting.garnet/withdatavolume/","v":"13.4.0"},{"n":"withPersistence","f":"withPersistence(interval?: timespan): GarnetResource","k":"method","p":"Aspire.Hosting.Garnet","s":"Configures a Garnet container resource for persistence.","h":"/reference/api/typescript/aspire.hosting.garnet/withpersistence/","v":"13.4.0"},{"n":"GarnetResource","f":"Aspire.Hosting.ApplicationModel.GarnetResource","k":"handle","p":"Aspire.Hosting.Garnet","s":"A resource that represents a Garnet resource independent of the hosting model.","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"GarnetResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Garnet","s":"Gets the connection string expression for the Garnet server.","t":"GarnetResource","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"GarnetResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Garnet","s":"Gets the host endpoint reference for this resource.","t":"GarnetResource","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"GarnetResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Garnet","s":"Gets the parameter that contains the Garnet server password.","t":"GarnetResource","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"GarnetResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Garnet","s":"Gets the port endpoint reference for this resource.","t":"GarnetResource","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"GarnetResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Garnet","s":"Gets the primary endpoint for the Garnet server.","t":"GarnetResource","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"GarnetResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Garnet","s":"Gets the connection URI expression for the Garnet server.","t":"GarnetResource","h":"/reference/api/typescript/aspire.hosting.garnet/garnetresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addGitHubModel","f":"addGitHubModel(name: string, model: GitHubModelName, organization?: ParameterResource): GitHubModelResource","k":"method","p":"Aspire.Hosting.GitHub.Models","s":"Adds a GitHub Model resource to the distributed application model.","h":"/reference/api/typescript/aspire.hosting.github.models/addgithubmodel/","v":"13.4.0"},{"n":"addGitHubModelById","f":"addGitHubModelById(name: string, modelId: string, organization?: ParameterResource): GitHubModelResource","k":"method","p":"Aspire.Hosting.GitHub.Models","s":"Adds a GitHub Model resource to the application model using a model identifier string.","h":"/reference/api/typescript/aspire.hosting.github.models/addgithubmodelbyid/","v":"13.4.0"},{"n":"enableHealthCheck","f":"enableHealthCheck(): GitHubModelResource","k":"method","p":"Aspire.Hosting.GitHub.Models","s":"Adds a health check to the GitHub Model resource.","h":"/reference/api/typescript/aspire.hosting.github.models/enablehealthcheck/","v":"13.4.0"},{"n":"withApiKey","f":"withApiKey(apiKey: ParameterResource): GitHubModelResource","k":"method","p":"Aspire.Hosting.GitHub.Models","s":"Configures the API key for the GitHub Model resource from a parameter.","h":"/reference/api/typescript/aspire.hosting.github.models/withapikey/","v":"13.4.0"},{"n":"GitHubModelResource","f":"Aspire.Hosting.GitHub.Models.GitHubModelResource","k":"handle","p":"Aspire.Hosting.GitHub.Models","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.github.models/githubmodelresource/","v":"13.4.0"},{"n":"GitHubModelName","f":"Aspire.Hosting.GitHub.GitHubModelName","k":"enum","p":"Aspire.Hosting.GitHub.Models","s":"Enumerates known GitHub model names for polyglot app host support.","h":"/reference/api/typescript/aspire.hosting.github.models/githubmodelname/","v":"13.4.0"},{"n":"addGoApp","f":"addGoApp(name: string, appDirectory: string, packagePath?: string, buildTags?: string[], ldFlags?: string, gcFlags?: string, raceDetector?: boolean): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Adds a Go application to the application model. The Go toolchain must be available on the PATH.","h":"/reference/api/typescript/aspire.hosting.go/addgoapp/","v":"13.4.0-preview.1.26281.18"},{"n":"withAppArgs","f":"withAppArgs(args: any[]): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Passes extra arguments to the Go program at runtime. In normal run mode they appear after `go run .`; in Delve mode after the `--` separator.","h":"/reference/api/typescript/aspire.hosting.go/withappargs/","v":"13.4.0-preview.1.26281.18"},{"n":"withDelveServer","f":"withDelveServer(port?: number): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Starts a headless Delve debug server so that any DAP-compatible client can attach remotely. The application is launched as `dlv --headless=true --listen=127.0.0.1: --api-version=2 debug .` instead of `go run .`. Delve must be available on the PATH.","h":"/reference/api/typescript/aspire.hosting.go/withdelveserver/","v":"13.4.0-preview.1.26281.18"},{"n":"withGoPrivate","f":"withGoPrivate(privatePatterns: string[], authHost: string, usernameArgName?: string, tokenSecretId?: string): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Configures private Go module authentication for publish-time Dockerfile generation.","h":"/reference/api/typescript/aspire.hosting.go/withgoprivate/","v":"13.4.0-preview.1.26281.18"},{"n":"withModDownload","f":"withModDownload(): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Runs `go mod download` before starting the application, pre-fetching all module dependencies into the local module cache without modifying `go.sum`. The main application waits for the download step to complete successfully before launching.","h":"/reference/api/typescript/aspire.hosting.go/withmoddownload/","v":"13.4.0-preview.1.26281.18"},{"n":"withModTidy","f":"withModTidy(): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Runs `go mod tidy` before starting the application, ensuring `go.sum` is up to date. The main application waits for the tidy step to complete successfully before launching.","h":"/reference/api/typescript/aspire.hosting.go/withmodtidy/","v":"13.4.0-preview.1.26281.18"},{"n":"withModVendor","f":"withModVendor(): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Runs `go mod vendor` before starting the application, caching all module dependencies in the local `vendor/` directory. The main application waits for the vendor step to complete successfully before launching.","h":"/reference/api/typescript/aspire.hosting.go/withmodvendor/","v":"13.4.0-preview.1.26281.18"},{"n":"withVetTool","f":"withVetTool(): GoAppResource","k":"method","p":"Aspire.Hosting.Go","s":"Runs `go vet ./...` before starting the application to catch static analysis issues. The main application waits for the vet step to complete successfully before launching.","h":"/reference/api/typescript/aspire.hosting.go/withvettool/","v":"13.4.0-preview.1.26281.18"},{"n":"GoAppResource","f":"Aspire.Hosting.Go.GoAppResource","k":"handle","p":"Aspire.Hosting.Go","s":"Represents a Go application resource in the distributed application model.","h":"/reference/api/typescript/aspire.hosting.go/goappresource/","v":"13.4.0-preview.1.26281.18"},{"n":"addBunApp","f":"addBunApp(name: string, appDirectory: string, scriptPath: string): BunAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a Bun application to the application model. Bun should be available on the PATH.","h":"/reference/api/typescript/aspire.hosting.javascript/addbunapp/","v":"13.4.0"},{"n":"addJavaScriptApp","f":"addJavaScriptApp(name: string, appDirectory: string, runScriptName?: string): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a JavaScript application resource to the distributed application using the specified app directory and run script.","h":"/reference/api/typescript/aspire.hosting.javascript/addjavascriptapp/","v":"13.4.0"},{"n":"addNextJsApp","f":"addNextJsApp(name: string, appDirectory: string, runScriptName?: string): NextJsAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a Next.js app to the distributed application builder.","h":"/reference/api/typescript/aspire.hosting.javascript/addnextjsapp/","v":"13.4.0"},{"n":"addNodeApp","f":"addNodeApp(name: string, appDirectory: string, scriptPath: string): NodeAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a node application to the application model. Node should be available on the PATH.","h":"/reference/api/typescript/aspire.hosting.javascript/addnodeapp/","v":"13.4.0"},{"n":"addViteApp","f":"addViteApp(name: string, appDirectory: string, runScriptName?: string): ViteAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a Vite app to the distributed application builder.","h":"/reference/api/typescript/aspire.hosting.javascript/addviteapp/","v":"13.4.0"},{"n":"disableBuildValidation","f":"disableBuildValidation(): NextJsAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Disables deploy-time build validation checks for the Next.js application.","h":"/reference/api/typescript/aspire.hosting.javascript/disablebuildvalidation/","v":"13.4.0"},{"n":"publishAsNodeServer","f":"publishAsNodeServer(entryPoint: string, outputPath?: string): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the JavaScript application to publish as a standalone Node.js server that runs a built artifact directly.","h":"/reference/api/typescript/aspire.hosting.javascript/publishasnodeserver/","v":"13.4.0"},{"n":"publishAsPackageScript","f":"publishAsPackageScript(scriptName?: string, runScriptArguments?: string): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the JavaScript application to publish as a Node.js server that uses a `package.json` script at runtime.","h":"/reference/api/typescript/aspire.hosting.javascript/publishaspackagescript/","v":"13.4.0"},{"n":"publishAsStaticWebsite","f":"publishAsStaticWebsite(apiPath?: string, apiTarget?: IResourceWithServiceDiscovery, outputPath?: string, stripPrefix?: boolean, targetEndpointName?: string): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Publishes the JavaScript application as a standalone static website using YARP.","h":"/reference/api/typescript/aspire.hosting.javascript/publishasstaticwebsite/","v":"13.4.0"},{"n":"withBrowserDebugger","f":"withBrowserDebugger(browser?: string): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures a browser debugger for the JavaScript application resource, enabling browser-based debugging through a child resource that launches when the parent application is ready.","h":"/reference/api/typescript/aspire.hosting.javascript/withbrowserdebugger/","v":"13.4.0"},{"n":"withBuildScript","f":"withBuildScript(scriptName: string, args?: string[]): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a build script annotation to the resource builder using the specified command-line arguments.","h":"/reference/api/typescript/aspire.hosting.javascript/withbuildscript/","v":"13.4.0"},{"n":"withBun","f":"withBun(install?: boolean, installArgs?: string[]): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the JavaScript resource to use Bun as the package manager and optionally installs packages before the application starts.","h":"/reference/api/typescript/aspire.hosting.javascript/withbun/","v":"13.4.0"},{"n":"withNpm","f":"withNpm(install?: boolean, installCommand?: string, installArgs?: string[]): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the Node.js resource to use npm as the package manager and optionally installs packages before the application starts.","h":"/reference/api/typescript/aspire.hosting.javascript/withnpm/","v":"13.4.0"},{"n":"withPnpm","f":"withPnpm(install?: boolean, installArgs?: string[]): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the Node.js resource to use pnpm as the package manager and optionally installs packages before the application starts.","h":"/reference/api/typescript/aspire.hosting.javascript/withpnpm/","v":"13.4.0"},{"n":"withRunScript","f":"withRunScript(scriptName: string, args?: string[]): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Adds a run script annotation to the specified JavaScript application resource builder, specifying the script to execute and its arguments during run mode.","h":"/reference/api/typescript/aspire.hosting.javascript/withrunscript/","v":"13.4.0"},{"n":"withViteConfig","f":"withViteConfig(configPath: string): ViteAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the Vite app to use the specified Vite configuration file instead of the default resolution behavior.","h":"/reference/api/typescript/aspire.hosting.javascript/withviteconfig/","v":"13.4.0"},{"n":"withYarn","f":"withYarn(install?: boolean, installArgs?: string[]): JavaScriptAppResource","k":"method","p":"Aspire.Hosting.JavaScript","s":"Configures the Node.js resource to use yarn as the package manager and optionally installs packages before the application starts.","h":"/reference/api/typescript/aspire.hosting.javascript/withyarn/","v":"13.4.0"},{"n":"BunAppResource","f":"Aspire.Hosting.JavaScript.BunAppResource","k":"handle","p":"Aspire.Hosting.JavaScript","s":"A resource that represents a Bun application.","h":"/reference/api/typescript/aspire.hosting.javascript/bunappresource/","v":"13.4.0"},{"n":"JavaScriptAppResource","f":"Aspire.Hosting.JavaScript.JavaScriptAppResource","k":"handle","p":"Aspire.Hosting.JavaScript","s":"A resource that represents a JavaScript application.","h":"/reference/api/typescript/aspire.hosting.javascript/javascriptappresource/","v":"13.4.0"},{"n":"NextJsAppResource","f":"Aspire.Hosting.JavaScript.NextJsAppResource","k":"handle","p":"Aspire.Hosting.JavaScript","s":"Represents a Next.js application resource.","h":"/reference/api/typescript/aspire.hosting.javascript/nextjsappresource/","v":"13.4.0"},{"n":"NodeAppResource","f":"Aspire.Hosting.JavaScript.NodeAppResource","k":"handle","p":"Aspire.Hosting.JavaScript","s":"A resource that represents a node application.","h":"/reference/api/typescript/aspire.hosting.javascript/nodeappresource/","v":"13.4.0"},{"n":"ViteAppResource","f":"Aspire.Hosting.JavaScript.ViteAppResource","k":"handle","p":"Aspire.Hosting.JavaScript","s":"Represents a Vite application resource that can be managed and executed within a Node.js environment.","h":"/reference/api/typescript/aspire.hosting.javascript/viteappresource/","v":"13.4.0"},{"n":"addKafka","f":"addKafka(name: string, port?: number): KafkaServerResource","k":"method","p":"Aspire.Hosting.Kafka","s":"Adds a Kafka resource to the application. A container is used for local development.","h":"/reference/api/typescript/aspire.hosting.kafka/addkafka/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): KafkaServerResource","k":"method","p":"Aspire.Hosting.Kafka","s":"Adds a bind mount for the data folder to a Kafka container resource.","h":"/reference/api/typescript/aspire.hosting.kafka/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): KafkaServerResource","k":"method","p":"Aspire.Hosting.Kafka","s":"Adds a named volume for the data folder to a Kafka container resource.","h":"/reference/api/typescript/aspire.hosting.kafka/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): KafkaUIContainerResource","k":"method","p":"Aspire.Hosting.Kafka","s":"Configures the host port that the KafkaUI resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.kafka/withhostport/","v":"13.4.0"},{"n":"withKafkaUI","f":"withKafkaUI(configureContainer?: (obj: KafkaUIContainerResource) => Promise, containerName?: string): KafkaServerResource","k":"method","p":"Aspire.Hosting.Kafka","s":"Adds a Kafka UI container to the application.","h":"/reference/api/typescript/aspire.hosting.kafka/withkafkaui/","v":"13.4.0"},{"n":"KafkaServerResource","f":"Aspire.Hosting.KafkaServerResource","k":"handle","p":"Aspire.Hosting.Kafka","s":"A resource that represents a Kafka broker.","h":"/reference/api/typescript/aspire.hosting.kafka/kafkaserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"KafkaServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Kafka","s":"Gets the connection string expression for the Kafka broker.","t":"KafkaServerResource","h":"/reference/api/typescript/aspire.hosting.kafka/kafkaserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"KafkaServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Kafka","s":"Gets the host endpoint reference for the primary endpoint.","t":"KafkaServerResource","h":"/reference/api/typescript/aspire.hosting.kafka/kafkaserverresource/#host","m":true,"v":"13.4.0"},{"n":"internalEndpoint","f":"KafkaServerResource.internalEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Kafka","s":"Gets the internal endpoint for the Kafka broker. This endpoint is used for container to broker communication. To connect to the Kafka broker from a host process, use `PrimaryEndpoint`.","t":"KafkaServerResource","h":"/reference/api/typescript/aspire.hosting.kafka/kafkaserverresource/#internalendpoint","m":true,"v":"13.4.0"},{"n":"port","f":"KafkaServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Kafka","s":"Gets the port endpoint reference for the primary endpoint.","t":"KafkaServerResource","h":"/reference/api/typescript/aspire.hosting.kafka/kafkaserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"KafkaServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Kafka","s":"Gets the primary endpoint for the Kafka broker. This endpoint is used for host processes to Kafka broker communication. To connect to the Kafka broker from a container, use `InternalEndpoint`.","t":"KafkaServerResource","h":"/reference/api/typescript/aspire.hosting.kafka/kafkaserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"KafkaUIContainerResource","f":"Aspire.Hosting.KafkaUIContainerResource","k":"handle","p":"Aspire.Hosting.Kafka","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.kafka/kafkauicontainerresource/","v":"13.4.0"},{"n":"addKeycloak","f":"addKeycloak(name: string, port?: number, adminUsername?: ParameterResource, adminPassword?: ParameterResource): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Adds a Keycloak container to the application model.","h":"/reference/api/typescript/aspire.hosting.keycloak/addkeycloak/","v":"13.4.0-preview.1.26281.18"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Adds a bind mount for the data folder to a Keycloak container resource.","h":"/reference/api/typescript/aspire.hosting.keycloak/withdatabindmount/","v":"13.4.0-preview.1.26281.18"},{"n":"withDataVolume","f":"withDataVolume(name?: string): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Adds a named volume for the data folder to a Keycloak container resource.","h":"/reference/api/typescript/aspire.hosting.keycloak/withdatavolume/","v":"13.4.0-preview.1.26281.18"},{"n":"withDisabledFeatures","f":"withDisabledFeatures(features: string[]): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Additional feature names to disable for the keycloak resource","h":"/reference/api/typescript/aspire.hosting.keycloak/withdisabledfeatures/","v":"13.4.0-preview.1.26281.18"},{"n":"withEnabledFeatures","f":"withEnabledFeatures(features: string[]): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Additional feature names to enable for the keycloak resource","h":"/reference/api/typescript/aspire.hosting.keycloak/withenabledfeatures/","v":"13.4.0-preview.1.26281.18"},{"n":"withOtlpExporter","f":"withOtlpExporter(protocol?: OtlpProtocol): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Configures the OTLP exporter for Keycloak","h":"/reference/api/typescript/aspire.hosting.keycloak/withotlpexporter/","v":"13.4.0-preview.1.26281.18"},{"n":"withRealmImport","f":"withRealmImport(importPath: string): KeycloakResource","k":"method","p":"Aspire.Hosting.Keycloak","s":"Adds a realm import to a Keycloak container resource.","h":"/reference/api/typescript/aspire.hosting.keycloak/withrealmimport/","v":"13.4.0-preview.1.26281.18"},{"n":"KeycloakResource","f":"Aspire.Hosting.ApplicationModel.KeycloakResource","k":"handle","p":"Aspire.Hosting.Keycloak","s":"A resource that represents a Keycloak resource.","h":"/reference/api/typescript/aspire.hosting.keycloak/keycloakresource/","v":"13.4.0-preview.1.26281.18"},{"n":"adminPasswordParameter","f":"KeycloakResource.adminPasswordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Keycloak","s":"Gets the parameter that contains the Keycloak admin password.","t":"KeycloakResource","h":"/reference/api/typescript/aspire.hosting.keycloak/keycloakresource/#adminpasswordparameter","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"adminUserNameParameter","f":"KeycloakResource.adminUserNameParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Keycloak","s":"Gets the parameter that contains the Keycloak admin.","t":"KeycloakResource","h":"/reference/api/typescript/aspire.hosting.keycloak/keycloakresource/#adminusernameparameter","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"addCertManager","f":"addCertManager(name: string, chartVersion?: string): CertManagerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Installs cert-manager into a Kubernetes environment","h":"/reference/api/typescript/aspire.hosting.kubernetes/addcertmanager/","v":"13.4.0-preview.1.26281.18"},{"n":"addGateway","f":"addGateway(name: string): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes Gateway API Gateway resource to the application model as a child of the specified Kubernetes environment. The gateway generates a `gateway.networking.k8s.io/v1 Gateway` resource and one or more `HTTPRoute` resources in the Helm chart output at publish time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/addgateway/","v":"13.4.0-preview.1.26281.18"},{"n":"addHelmChart","f":"addHelmChart(name: string, chartReference: string, chartVersion: string): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds an external Helm chart to be installed in the Kubernetes environment. The chart is installed via `helm upgrade --install` as a pipeline step after the main application Helm chart is deployed.","h":"/reference/api/typescript/aspire.hosting.kubernetes/addhelmchart/","v":"13.4.0-preview.1.26281.18"},{"n":"addIngress","f":"addIngress(name: string): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes Ingress resource to the application model as a child of the specified Kubernetes environment. The ingress generates a `networking.k8s.io/v1 Ingress` resource in the Helm chart output at publish time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/addingress/","v":"13.4.0-preview.1.26281.18"},{"n":"addIssuer","f":"addIssuer(name: string): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a cert-manager `ClusterIssuer` to this cert-manager installation.","h":"/reference/api/typescript/aspire.hosting.kubernetes/addissuer/","v":"13.4.0-preview.1.26281.18"},{"n":"addKubernetesEnvironment","f":"addKubernetesEnvironment(name: string): KubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes environment to the application model.","h":"/reference/api/typescript/aspire.hosting.kubernetes/addkubernetesenvironment/","v":"13.4.0-preview.1.26281.18"},{"n":"addNodePool","f":"addNodePool(name: string): KubernetesNodePoolResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a named node pool to the Kubernetes environment.","h":"/reference/api/typescript/aspire.hosting.kubernetes/addnodepool/","v":"13.4.0-preview.1.26281.18"},{"n":"configureDashboard","f":"configureDashboard(configure: (obj: KubernetesAspireDashboardResource) => Promise): KubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the dashboard properties for this Kubernetes environment.","h":"/reference/api/typescript/aspire.hosting.kubernetes/configuredashboard/","v":"13.4.0-preview.1.26281.18"},{"n":"publishAsKubernetesService","f":"publishAsKubernetesService(configure: (obj: KubernetesResource) => Promise): IComputeResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Publishes the specified resource as a Kubernetes service.","h":"/reference/api/typescript/aspire.hosting.kubernetes/publishaskubernetesservice/","v":"13.4.0-preview.1.26281.18"},{"n":"withAcmeServer","f":"withAcmeServer(serverUrl: string, email: string): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the issuer to use a custom ACME directory endpoint (e.g., a private ACME server such as ZeroSSL or step-ca).","h":"/reference/api/typescript/aspire.hosting.kubernetes/withacmeserver/","v":"13.4.0-preview.1.26281.18"},{"n":"withAcmeServerParam","f":"withAcmeServerParam(serverUrl: string, email: ParameterResource): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the issuer to use a custom ACME directory endpoint with a parameterized email.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withacmeserverparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withDashboard","f":"withDashboard(enabled?: boolean): KubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Enables the Aspire dashboard for telemetry visualization in this Kubernetes environment.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withdashboard/","v":"13.4.0-preview.1.26281.18"},{"n":"withDefaultBackend","f":"withDefaultBackend(endpoint: EndpointReference): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the default backend for the ingress. The default backend handles requests that do not match any of the defined routing rules.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withdefaultbackend/","v":"13.4.0-preview.1.26281.18"},{"n":"withForwardedHeaders","f":"withForwardedHeaders(enabled?: boolean): KubernetesAspireDashboardResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures whether forwarded headers processing is enabled for the Aspire dashboard container.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withforwardedheaders/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayAnnotation","f":"withGatewayAnnotation(key: string, value: string): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes metadata annotation to the generated Gateway resource.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewayannotation/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayAnnotationParam","f":"withGatewayAnnotationParam(key: string, value: ParameterResource): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes metadata annotation with a parameter value that will be resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewayannotationparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayClass","f":"withGatewayClass(className: string): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the GatewayClass name that selects which controller implementation handles this gateway.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewayclass/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayClassParam","f":"withGatewayClassParam(className: ParameterResource): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the GatewayClass name using a parameter that will be resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewayclassparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayHostnameParam","f":"withGatewayHostnameParam(hostname: ParameterResource): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a hostname using a parameter that will be resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewayhostnameparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayHostRoute","f":"withGatewayHostRoute(host: string, path: string, endpoint: EndpointReference, pathType?: GatewayPathMatchType): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a host-and-path-based routing rule to the gateway. The rule matches traffic for the specified host and path, routing it to the given endpoint's backing Kubernetes service. This generates an `HTTPRoute` resource with a `hostnames` filter.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewayhostroute/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayPathRoute","f":"withGatewayPathRoute(path: string, endpoint: EndpointReference, pathType?: GatewayPathMatchType): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a path-based routing rule to the gateway. The rule matches all hosts and routes traffic matching the specified path to the given endpoint's backing Kubernetes service. This generates an `HTTPRoute` resource attached to the Gateway.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewaypathroute/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayTlsAuto","f":"withGatewayTlsAuto(): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures TLS termination with an auto-generated secret name derived from the gateway name.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewaytlsauto/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayTlsIssuer","f":"withGatewayTlsIssuer(issuer: CertManagerIssuerResource): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds an HTTPS listener to the gateway and wires it to the supplied cert-manager `ClusterIssuer`. This adds the `cert-manager.io/cluster-issuer` annotation to the generated Gateway resource, causing cert-manager to provision and renew a certificate for each gateway listener hostname.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewaytlsissuer/","v":"13.4.0-preview.1.26281.18"},{"n":"withGatewayTlsParam","f":"withGatewayTlsParam(secretName: ParameterResource): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures TLS termination using a parameter for the secret name.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withgatewaytlsparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withHelm","f":"withHelm(configure?: (obj: HelmChartOptions) => Promise): KubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the Kubernetes environment to deploy using Helm charts.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhelm/","v":"13.4.0-preview.1.26281.18"},{"n":"withHelmChartDestroy","f":"withHelmChartDestroy(): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Opts the Helm chart in to destroy-time uninstall. When set, `aspire destroy` will run `helm uninstall` for this release as part of the destroy pipeline.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhelmchartdestroy/","v":"13.4.0-preview.1.26281.18"},{"n":"withHelmChartForceConflicts","f":"withHelmChartForceConflicts(): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Opts the Helm chart in to `helm upgrade --install --force-conflicts`. When set, Helm's server-side apply forcibly takes over any fields owned by another field manager instead of failing with a conflict.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhelmchartforceconflicts/","v":"13.4.0-preview.1.26281.18"},{"n":"withHelmChartNamespace","f":"withHelmChartNamespace(namespace: string): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Kubernetes namespace for the Helm chart installation. If not set, the namespace defaults to the chart resource name.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhelmchartnamespace/","v":"13.4.0-preview.1.26281.18"},{"n":"withHelmChartReleaseName","f":"withHelmChartReleaseName(releaseName: string): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Helm release name for the chart installation. If not set, the release name defaults to the resource name.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhelmchartreleasename/","v":"13.4.0-preview.1.26281.18"},{"n":"withHelmValue","f":"withHelmValue(key: string, value: string): KubernetesHelmChartResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets a Helm value for the chart installation. Values are passed to `helm upgrade --install` via `--set` flags.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhelmvalue/","v":"13.4.0-preview.1.26281.18"},{"n":"withHostname","f":"withHostname(hostname: string): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a hostname that this gateway's routes match. Multiple hostnames can be added by calling this method repeatedly. Hostnames are used as `hostnames` in generated `HTTPRoute` resources and as HTTPS listener hostnames when TLS is configured.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhostname-aspire-hosting-kubernetes-kubernetesgatewayresource-string/","v":"13.4.0-preview.1.26281.18"},{"n":"withHostname","f":"withHostname(hostname: string): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a hostname that this ingress matches. Multiple hostnames can be added by calling this method repeatedly. If no hostnames are configured, the ingress matches all hosts.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhostname-aspire-hosting-kubernetes-kubernetesingressresource-string/","v":"13.4.0-preview.1.26281.18"},{"n":"withHttp01Solver","f":"withHttp01Solver(): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds an HTTP-01 ACME challenge solver to the issuer. cert-manager will satisfy the challenge by provisioning a temporary HTTP route at `/.well-known/acme-challenge/{token}` on the same hostname being validated. This requires the hostname to be publicly reachable on port 80.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withhttp01solver/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressAnnotation","f":"withIngressAnnotation(key: string, value: string): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes metadata annotation to the generated Ingress resource. These are key-value pairs in the `metadata.annotations` field of the K8S Ingress, commonly used to configure ingress controller-specific behavior.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingressannotation/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressAnnotationParam","f":"withIngressAnnotationParam(key: string, value: ParameterResource): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a Kubernetes metadata annotation with a parameter value that will be resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingressannotationparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressClass","f":"withIngressClass(className: string): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Kubernetes ingress class name that selects which ingress controller handles this ingress resource.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingressclass/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressClassParam","f":"withIngressClassParam(className: ParameterResource): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Kubernetes ingress class name using a parameter that will be resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingressclassparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressHostAndPath","f":"withIngressHostAndPath(host: string, path: string, endpoint: EndpointReference, pathType?: IngressPathType): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a host-scoped path rule to the ingress. The rule matches traffic for the specified host and path, forwarding it to the given endpoint's backing Kubernetes service.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingresshostandpath/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressHostnameParam","f":"withIngressHostnameParam(hostname: ParameterResource): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a hostname using a parameter that will be resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingresshostnameparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressPath","f":"withIngressPath(path: string, endpoint: EndpointReference, pathType?: IngressPathType): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds a path-based rule to the ingress. The rule matches all hosts and forwards traffic matching the specified path to the given endpoint's backing Kubernetes service.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingresspath/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressTlsAuto","f":"withIngressTlsAuto(): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures TLS termination with an auto-generated secret name derived from the ingress name.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingresstlsauto/","v":"13.4.0-preview.1.26281.18"},{"n":"withIngressTlsParam","f":"withIngressTlsParam(secretName: ParameterResource): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures TLS termination using a parameter for the secret name.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withingresstlsparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withLetsEncryptProduction","f":"withLetsEncryptProduction(email: string): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the issuer to use the Let's Encrypt production ACME endpoint.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withletsencryptproduction/","v":"13.4.0-preview.1.26281.18"},{"n":"withLetsEncryptProductionParam","f":"withLetsEncryptProductionParam(email: ParameterResource): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the issuer to use the Let's Encrypt production ACME endpoint, with the contact email supplied via a parameter resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withletsencryptproductionparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withLetsEncryptStaging","f":"withLetsEncryptStaging(email: string): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the issuer to use the Let's Encrypt staging ACME endpoint. Certificates issued from staging are not trusted by browsers, but the endpoint has much higher rate limits, making it the right choice for development and CI workflows.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withletsencryptstaging/","v":"13.4.0-preview.1.26281.18"},{"n":"withLetsEncryptStagingParam","f":"withLetsEncryptStagingParam(email: ParameterResource): CertManagerIssuerResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures the issuer to use the Let's Encrypt staging ACME endpoint, with the contact email supplied via a parameter resolved at deploy time.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withletsencryptstagingparam/","v":"13.4.0-preview.1.26281.18"},{"n":"withNodePool","f":"withNodePool(nodePool: KubernetesNodePoolResource): IResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Schedules a compute resource's workload on the specified Kubernetes node pool. This translates to a Kubernetes `nodeSelector` in the pod specification targeting the named node pool.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withnodepool/","v":"13.4.0-preview.1.26281.18"},{"n":"withOtlpServicePort","f":"withOtlpServicePort(grpcPort?: number, httpPort?: number): KubernetesAspireDashboardResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Kubernetes Service ports for the Aspire Dashboard OTLP endpoints.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withotlpserviceport/","v":"13.4.0-preview.1.26281.18"},{"n":"withProperties","f":"withProperties(configure: (obj: KubernetesEnvironmentResource) => Promise): KubernetesEnvironmentResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Allows setting the properties of a Kubernetes environment resource.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withproperties/","v":"13.4.0-preview.1.26281.18"},{"n":"withServicePort","f":"withServicePort(port?: number): KubernetesAspireDashboardResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Kubernetes Service port for the Aspire Dashboard HTTP endpoint.","h":"/reference/api/typescript/aspire.hosting.kubernetes/withserviceport/","v":"13.4.0-preview.1.26281.18"},{"n":"withTls","f":"withTls(secretName: string): KubernetesGatewayResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures TLS on a Kubernetes Gateway listener","h":"/reference/api/typescript/aspire.hosting.kubernetes/withtls-aspire-hosting-kubernetes-kubernetesgatewayresource-string/","v":"13.4.0-preview.1.26281.18"},{"n":"withTls","f":"withTls(secretName: string): KubernetesIngressResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Configures TLS for a Kubernetes Ingress using a K8S secret","h":"/reference/api/typescript/aspire.hosting.kubernetes/withtls-aspire-hosting-kubernetes-kubernetesingressresource-string/","v":"13.4.0-preview.1.26281.18"},{"n":"CertManagerIssuerResource","f":"Aspire.Hosting.Kubernetes.CertManagerIssuerResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a cert-manager `ClusterIssuer` resource in the Aspire application model.","h":"/reference/api/typescript/aspire.hosting.kubernetes/certmanagerissuerresource/","v":"13.4.0-preview.1.26281.18"},{"n":"CertManagerResource","f":"Aspire.Hosting.Kubernetes.CertManagerResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a cert-manager installation on a Kubernetes environment.","h":"/reference/api/typescript/aspire.hosting.kubernetes/certmanagerresource/","v":"13.4.0-preview.1.26281.18"},{"n":"HelmChartOptions","f":"Aspire.Hosting.Kubernetes.HelmChartOptions","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Provides options for configuring Helm chart deployment settings on a {@ats-ref type:KubernetesEnvironmentResource}.","h":"/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions/","v":"13.4.0-preview.1.26281.18"},{"n":"withChartDescription","f":"HelmChartOptions.withChartDescription(description: ParameterResource): HelmChartOptions","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Helm chart description written to the generated Chart.yaml.","t":"HelmChartOptions","h":"/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions/withchartdescription/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withChartName","f":"HelmChartOptions.withChartName(name: ParameterResource): HelmChartOptions","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Helm chart name written to the generated Chart.yaml.","t":"HelmChartOptions","h":"/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions/withchartname/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withChartVersion","f":"HelmChartOptions.withChartVersion(version: ParameterResource): HelmChartOptions","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Helm chart version for deployment.","t":"HelmChartOptions","h":"/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions/withchartversion/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withNamespace","f":"HelmChartOptions.withNamespace(namespace: ParameterResource): HelmChartOptions","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the target Kubernetes namespace for deployment.","t":"HelmChartOptions","h":"/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions/withnamespace/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withReleaseName","f":"HelmChartOptions.withReleaseName(releaseName: ParameterResource): HelmChartOptions","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the Helm release name for deployment.","t":"HelmChartOptions","h":"/reference/api/typescript/aspire.hosting.kubernetes/helmchartoptions/withreleasename/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesAspireDashboardResource","f":"Aspire.Hosting.Kubernetes.KubernetesAspireDashboardResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a resource for the Aspire Dashboard deployed into a Kubernetes environment. This resource is used to visualize telemetry data from resources running in the cluster.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesaspiredashboardresource/","v":"13.4.0-preview.1.26281.18"},{"n":"otlpGrpcEndpoint","f":"KubernetesAspireDashboardResource.otlpGrpcEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets the OTLP gRPC endpoint for receiving telemetry data.","t":"KubernetesAspireDashboardResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesaspiredashboardresource/#otlpgrpcendpoint","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"primaryEndpoint","f":"KubernetesAspireDashboardResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets the primary HTTP endpoint of the Aspire Dashboard UI.","t":"KubernetesAspireDashboardResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesaspiredashboardresource/#primaryendpoint","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesEnvironmentResource","f":"Aspire.Hosting.Kubernetes.KubernetesEnvironmentResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a Kubernetes environment resource that can host application resources.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/","v":"13.4.0-preview.1.26281.18"},{"n":"dashboardEnabled","f":"KubernetesEnvironmentResource.dashboardEnabled(): boolean","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Determines whether to include an Aspire dashboard for telemetry visualization in this environment.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#dashboardenabled","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"defaultImagePullPolicy","f":"KubernetesEnvironmentResource.defaultImagePullPolicy(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets or sets the default policy that determines how Docker images are pulled during deployment. Possible values are: \"Always\" - Always attempt to pull the image from the registry. \"IfNotPresent\" - Pull the image only if it is not already present locally. \"Never\" - Never pull the image, use only the local image. The default value is \"IfNotPresent\".","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#defaultimagepullpolicy","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"defaultServiceType","f":"KubernetesEnvironmentResource.defaultServiceType(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets or sets the default Kubernetes service type to be used when generating artifacts.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#defaultservicetype","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"defaultStorageClassName","f":"KubernetesEnvironmentResource.defaultStorageClassName(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Specifies the default name of the storage class to be used for persistent volume claims in Kubernetes. This property allows customization of the storage class for specifying storage requirements such as performance, retention policies, and provisioning parameters. If set to null, the default storage class for the cluster will be used.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#defaultstorageclassname","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"defaultStorageReadWritePolicy","f":"KubernetesEnvironmentResource.defaultStorageReadWritePolicy(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets or sets the default access policy for reading and writing to the storage.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#defaultstoragereadwritepolicy","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"defaultStorageSize","f":"KubernetesEnvironmentResource.defaultStorageSize(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets or sets the default storage size for persistent volumes.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#defaultstoragesize","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"defaultStorageType","f":"KubernetesEnvironmentResource.defaultStorageType(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Specifies the default type of storage used for Kubernetes deployments.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#defaultstoragetype","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"kubeConfigPath","f":"KubernetesEnvironmentResource.kubeConfigPath(): string","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets or sets the path to an explicit kubeconfig file for Helm and kubectl commands. When set, all Helm and kubectl commands will use `--kubeconfig` to target this file instead of the default `~/.kube/config`.","t":"KubernetesEnvironmentResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesenvironmentresource/#kubeconfigpath","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesGatewayResource","f":"Aspire.Hosting.Kubernetes.KubernetesGatewayResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a Kubernetes Gateway API Gateway as a first-class resource in the Aspire application model. A Gateway defines listeners (ports, protocols, TLS) and HTTPRoutes attach to it for routing.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesgatewayresource/","v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesHelmChartResource","f":"Aspire.Hosting.Kubernetes.KubernetesHelmChartResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents an external Helm chart to be installed into a Kubernetes environment. This resource models a Helm chart from a repository (OCI or HTTP) that will be installed as a pipeline step after the main application Helm chart is deployed.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kuberneteshelmchartresource/","v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesIngressResource","f":"Aspire.Hosting.Kubernetes.KubernetesIngressResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a Kubernetes Ingress as a first-class resource in the Aspire application model. An Ingress defines HTTP routing rules that direct external traffic to services in the cluster.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesingressresource/","v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesManifestResource","f":"Aspire.Hosting.Kubernetes.KubernetesManifestResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents an arbitrary Kubernetes manifest that is emitted with a Kubernetes service.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesmanifestresource/","v":"13.4.0-preview.1.26281.18"},{"n":"withAnnotation","f":"KubernetesManifestResource.withAnnotation(key: string, value: string): KubernetesManifestResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds or updates a Kubernetes annotation on this manifest.","t":"KubernetesManifestResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesmanifestresource/withannotation/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withField","f":"KubernetesManifestResource.withField(path: string, value: string|number|boolean): KubernetesManifestResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds or updates a manifest field using a dot-separated path.","t":"KubernetesManifestResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesmanifestresource/withfield/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withLabel","f":"KubernetesManifestResource.withLabel(key: string, value: string): KubernetesManifestResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds or updates a Kubernetes label on this manifest.","t":"KubernetesManifestResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesmanifestresource/withlabel/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"withNamespace","f":"KubernetesManifestResource.withNamespace(namespace: string): KubernetesManifestResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Sets the namespace for this manifest.","t":"KubernetesManifestResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesmanifestresource/withnamespace/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesNodePoolResource","f":"Aspire.Hosting.Kubernetes.KubernetesNodePoolResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a Kubernetes node pool as a child resource of a {@ats-ref type:KubernetesEnvironmentResource}. Node pools can be referenced by compute resources to schedule workloads on specific node pools using {@ats-ref method:KubernetesEnvironmentExtensions.withNodePool}.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesnodepoolresource/","v":"13.4.0-preview.1.26281.18"},{"n":"KubernetesResource","f":"Aspire.Hosting.Kubernetes.KubernetesResource","k":"handle","p":"Aspire.Hosting.Kubernetes","s":"Represents a compute resource for Kubernetes.","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesresource/","v":"13.4.0-preview.1.26281.18"},{"n":"parent","f":"KubernetesResource.parent(): KubernetesEnvironmentResource","k":"property","p":"Aspire.Hosting.Kubernetes","s":"Gets the Parent property","t":"KubernetesResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesresource/#parent","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"addManifest","f":"KubernetesResource.addManifest(apiVersion: string, kind: string, name: string, configure?: (obj: KubernetesManifestResource) => Promise): KubernetesManifestResource","k":"method","p":"Aspire.Hosting.Kubernetes","s":"Adds an arbitrary Kubernetes manifest to this service's generated Helm chart for polyglot callers.","t":"KubernetesResource","h":"/reference/api/typescript/aspire.hosting.kubernetes/kubernetesresource/addmanifest/","m":true,"v":"13.4.0-preview.1.26281.18"},{"n":"GatewayPathMatchType","f":"Aspire.Hosting.Kubernetes.GatewayPathMatchType","k":"enum","p":"Aspire.Hosting.Kubernetes","s":"Specifies the type of path matching used in a Kubernetes Gateway API `HTTPRoute` rule. The values map directly to the `matches[].path.type` field defined by the Gateway API (see ) and are distinct from the Ingress-flavoured `IngressPathType` because the two specs use different vocabularies (Ingress: `Prefix`, Gateway: `PathPrefix`).","h":"/reference/api/typescript/aspire.hosting.kubernetes/gatewaypathmatchtype/","v":"13.4.0-preview.1.26281.18"},{"n":"IngressPathType","f":"Aspire.Hosting.Kubernetes.IngressPathType","k":"enum","p":"Aspire.Hosting.Kubernetes","s":"Specifies the type of path matching used in a Kubernetes Ingress rule.","h":"/reference/api/typescript/aspire.hosting.kubernetes/ingresspathtype/","v":"13.4.0-preview.1.26281.18"},{"n":"addAndroidDevice","f":"addAndroidDevice(name: string, deviceId?: string): MauiAndroidDeviceResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds an Android physical device resource to run the MAUI application on an Android device with a specific name and device ID.","h":"/reference/api/typescript/aspire.hosting.maui/addandroiddevice/","v":"13.4.0-preview.1.26281.18"},{"n":"addAndroidEmulator","f":"addAndroidEmulator(name: string, emulatorId?: string): MauiAndroidEmulatorResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds an Android emulator resource to run the MAUI application on an Android emulator with a specific name.","h":"/reference/api/typescript/aspire.hosting.maui/addandroidemulator/","v":"13.4.0-preview.1.26281.18"},{"n":"addiOSDevice","f":"addiOSDevice(name: string, deviceId?: string): MauiiOSDeviceResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds an iOS physical device resource to run the MAUI application on an iOS device with a specific name and device UDID.","h":"/reference/api/typescript/aspire.hosting.maui/addiosdevice/","v":"13.4.0-preview.1.26281.18"},{"n":"addiOSSimulator","f":"addiOSSimulator(name: string, simulatorId?: string): MauiiOSSimulatorResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds an iOS simulator resource to run the MAUI application on an iOS simulator with a specific name and simulator UDID.","h":"/reference/api/typescript/aspire.hosting.maui/addiossimulator/","v":"13.4.0-preview.1.26281.18"},{"n":"addMacCatalystDevice","f":"addMacCatalystDevice(name: string): MauiMacCatalystPlatformResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds a Mac Catalyst device resource to run the MAUI application on the macOS platform with a specific name.","h":"/reference/api/typescript/aspire.hosting.maui/addmaccatalystdevice/","v":"13.4.0-preview.1.26281.18"},{"n":"addMauiProject","f":"addMauiProject(name: string, projectPath: string): MauiProjectResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds a .NET MAUI project to the application model. This resource can be used to create platform-specific resources.","h":"/reference/api/typescript/aspire.hosting.maui/addmauiproject/","v":"13.4.0-preview.1.26281.18"},{"n":"addWindowsDevice","f":"addWindowsDevice(name: string): MauiWindowsPlatformResource","k":"method","p":"Aspire.Hosting.Maui","s":"Adds a Windows device resource to run the MAUI application on the Windows platform with a specific name.","h":"/reference/api/typescript/aspire.hosting.maui/addwindowsdevice/","v":"13.4.0-preview.1.26281.18"},{"n":"withOtlpDevTunnel","f":"withOtlpDevTunnel(): IMauiPlatformResource","k":"method","p":"Aspire.Hosting.Maui","s":"Configures the MAUI platform resource to send OpenTelemetry data through an automatically created dev tunnel. This is the easiest option for most scenarios, as it handles tunnel creation, configuration, and endpoint injection automatically.","h":"/reference/api/typescript/aspire.hosting.maui/withotlpdevtunnel/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiAndroidDeviceResource","f":"Aspire.Hosting.Maui.MauiAndroidDeviceResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauiandroiddeviceresource/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiAndroidEmulatorResource","f":"Aspire.Hosting.Maui.MauiAndroidEmulatorResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauiandroidemulatorresource/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiiOSDeviceResource","f":"Aspire.Hosting.Maui.MauiiOSDeviceResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauiiosdeviceresource/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiiOSSimulatorResource","f":"Aspire.Hosting.Maui.MauiiOSSimulatorResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauiiossimulatorresource/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiMacCatalystPlatformResource","f":"Aspire.Hosting.Maui.MauiMacCatalystPlatformResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauimaccatalystplatformresource/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiProjectResource","f":"Aspire.Hosting.Maui.MauiProjectResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauiprojectresource/","v":"13.4.0-preview.1.26281.18"},{"n":"MauiWindowsPlatformResource","f":"Aspire.Hosting.Maui.MauiWindowsPlatformResource","k":"handle","p":"Aspire.Hosting.Maui","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.maui/mauiwindowsplatformresource/","v":"13.4.0-preview.1.26281.18"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): MilvusDatabaseResource","k":"method","p":"Aspire.Hosting.Milvus","s":"Adds a Milvus database to the application model.","h":"/reference/api/typescript/aspire.hosting.milvus/adddatabase/","v":"13.4.0"},{"n":"addMilvus","f":"addMilvus(name: string, apiKey?: ParameterResource, grpcPort?: number): MilvusServerResource","k":"method","p":"Aspire.Hosting.Milvus","s":"Adds a Milvus container resource to the application model.","h":"/reference/api/typescript/aspire.hosting.milvus/addmilvus/","v":"13.4.0"},{"n":"withAttu","f":"withAttu(configureContainer?: (obj: AttuResource) => Promise, containerName?: string): MilvusServerResource","k":"method","p":"Aspire.Hosting.Milvus","s":"Adds an administration and development platform for Milvus to the application model using Attu.","h":"/reference/api/typescript/aspire.hosting.milvus/withattu/","v":"13.4.0"},{"n":"withConfigurationFile","f":"withConfigurationFile(configurationFilePath: string): MilvusServerResource","k":"method","p":"Aspire.Hosting.Milvus","s":"Copies a configuration file into a Milvus container resource.","h":"/reference/api/typescript/aspire.hosting.milvus/withconfigurationfile/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): MilvusServerResource","k":"method","p":"Aspire.Hosting.Milvus","s":"Adds a bind mount for the data folder to a Milvus container resource.","h":"/reference/api/typescript/aspire.hosting.milvus/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): MilvusServerResource","k":"method","p":"Aspire.Hosting.Milvus","s":"Adds a named volume for the data folder to a Milvus container resource.","h":"/reference/api/typescript/aspire.hosting.milvus/withdatavolume/","v":"13.4.0"},{"n":"MilvusDatabaseResource","f":"Aspire.Hosting.ApplicationModel.MilvusDatabaseResource","k":"handle","p":"Aspire.Hosting.Milvus","s":"A resource that represents a Milvus database. This is a child resource of a {@ats-ref type:MilvusServerResource}.","h":"/reference/api/typescript/aspire.hosting.milvus/milvusdatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MilvusDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the connection string expression for the Milvus database.","t":"MilvusDatabaseResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusdatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"MilvusDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the database name.","t":"MilvusDatabaseResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusdatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"parent","f":"MilvusDatabaseResource.parent(): MilvusServerResource","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the parent Milvus container resource.","t":"MilvusDatabaseResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusdatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"AttuResource","f":"Aspire.Hosting.Milvus.AttuResource","k":"handle","p":"Aspire.Hosting.Milvus","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.milvus/atturesource/","v":"13.4.0"},{"n":"MilvusServerResource","f":"Aspire.Hosting.Milvus.MilvusServerResource","k":"handle","p":"Aspire.Hosting.Milvus","s":"A resource that represents a Milvus database.","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/","v":"13.4.0"},{"n":"apiKeyParameter","f":"MilvusServerResource.apiKeyParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the parameter that contains the Milvus API key.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#apikeyparameter","m":true,"v":"13.4.0"},{"n":"connectionStringExpression","f":"MilvusServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the connection string expression for the Milvus gRPC endpoint.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"MilvusServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.Milvus","s":"A dictionary where the key is the resource name and the value is the database name.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"MilvusServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the host endpoint reference for this resource.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"MilvusServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the port endpoint reference for this resource.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"MilvusServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets the gRPC endpoint for the Milvus database.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"token","f":"MilvusServerResource.token(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets a valid access token to access the Milvus instance.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#token","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MilvusServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Milvus","s":"Gets URI expression for the Milvus instance.","t":"MilvusServerResource","h":"/reference/api/typescript/aspire.hosting.milvus/milvusserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): MongoDBDatabaseResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Adds a MongoDB database to the application model.","h":"/reference/api/typescript/aspire.hosting.mongodb/adddatabase/","v":"13.4.0"},{"n":"addMongoDB","f":"addMongoDB(name: string, port?: number, userName?: ParameterResource, password?: ParameterResource): MongoDBServerResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Adds a MongoDB container resource","h":"/reference/api/typescript/aspire.hosting.mongodb/addmongodb/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): MongoDBServerResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Adds a bind mount for the data folder to a MongoDB container resource.","h":"/reference/api/typescript/aspire.hosting.mongodb/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): MongoDBServerResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Adds a named volume for the data folder to a MongoDB container resource.","h":"/reference/api/typescript/aspire.hosting.mongodb/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): MongoExpressContainerResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Configures the host port that the Mongo Express resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.mongodb/withhostport/","v":"13.4.0"},{"n":"withInitFiles","f":"withInitFiles(source: string): MongoDBServerResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Copies init files into a MongoDB container resource.","h":"/reference/api/typescript/aspire.hosting.mongodb/withinitfiles/","v":"13.4.0"},{"n":"withMongoExpress","f":"withMongoExpress(configureContainer?: (obj: MongoExpressContainerResource) => Promise, containerName?: string): MongoDBServerResource","k":"method","p":"Aspire.Hosting.MongoDB","s":"Adds a MongoExpress administration and development platform for MongoDB to the application model.","h":"/reference/api/typescript/aspire.hosting.mongodb/withmongoexpress/","v":"13.4.0"},{"n":"MongoDBDatabaseResource","f":"Aspire.Hosting.ApplicationModel.MongoDBDatabaseResource","k":"handle","p":"Aspire.Hosting.MongoDB","s":"A resource that represents a MongoDB database. This is a child resource of a {@ats-ref type:MongoDBServerResource}.","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbdatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MongoDBDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the connection string expression for the MongoDB database.","t":"MongoDBDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbdatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"MongoDBDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the database name.","t":"MongoDBDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbdatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"parent","f":"MongoDBDatabaseResource.parent(): MongoDBServerResource","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the parent MongoDB container resource.","t":"MongoDBDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbdatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MongoDBDatabaseResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the connection URI expression for the MongoDB database.","t":"MongoDBDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbdatabaseresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"MongoDBServerResource","f":"Aspire.Hosting.ApplicationModel.MongoDBServerResource","k":"handle","p":"Aspire.Hosting.MongoDB","s":"A resource that represents a MongoDB container.","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MongoDBServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the connection string for the MongoDB server.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"MongoDBServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.MongoDB","s":"A dictionary where the key is the resource name and the value is the database name.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"MongoDBServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the host endpoint reference for this resource.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"MongoDBServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the parameter that contains the MongoDb server password.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"MongoDBServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the port endpoint reference for this resource.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"MongoDBServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the primary endpoint for the MongoDB server.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MongoDBServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the connection URI expression for the MongoDB server.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameParameter","f":"MongoDBServerResource.userNameParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets the parameter that contains the MongoDb server username.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#usernameparameter","m":true,"v":"13.4.0"},{"n":"userNameReference","f":"MongoDBServerResource.userNameReference(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MongoDB","s":"Gets a reference to the user name for the MongoDB server.","t":"MongoDBServerResource","h":"/reference/api/typescript/aspire.hosting.mongodb/mongodbserverresource/#usernamereference","m":true,"v":"13.4.0"},{"n":"MongoExpressContainerResource","f":"Aspire.Hosting.MongoDB.MongoExpressContainerResource","k":"handle","p":"Aspire.Hosting.MongoDB","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.mongodb/mongoexpresscontainerresource/","v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): MySqlDatabaseResource","k":"method","p":"Aspire.Hosting.MySql","s":"Adds a MySQL database to the application model.","h":"/reference/api/typescript/aspire.hosting.mysql/adddatabase/","v":"13.4.0"},{"n":"addMySql","f":"addMySql(name: string, password?: ParameterResource, port?: number): MySqlServerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Adds a MySQL server resource to the application model. For local development a container is used.","h":"/reference/api/typescript/aspire.hosting.mysql/addmysql/","v":"13.4.0"},{"n":"withCreationScript","f":"withCreationScript(script: string): MySqlDatabaseResource","k":"method","p":"Aspire.Hosting.MySql","s":"Defines the SQL script used to create the database.","h":"/reference/api/typescript/aspire.hosting.mysql/withcreationscript/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): MySqlServerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Adds a bind mount for the data folder to a MySql container resource.","h":"/reference/api/typescript/aspire.hosting.mysql/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): MySqlServerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Adds a named volume for the data folder to a MySql container resource.","h":"/reference/api/typescript/aspire.hosting.mysql/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): PhpMyAdminContainerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Configures the host port that the PGAdmin resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.mysql/withhostport/","v":"13.4.0"},{"n":"withInitFiles","f":"withInitFiles(source: string): MySqlServerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Copies init files into a MySql container resource.","h":"/reference/api/typescript/aspire.hosting.mysql/withinitfiles/","v":"13.4.0"},{"n":"withPassword","f":"withPassword(password: ParameterResource): MySqlServerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Configures the password that the MySQL resource uses.","h":"/reference/api/typescript/aspire.hosting.mysql/withpassword/","v":"13.4.0"},{"n":"withPhpMyAdmin","f":"withPhpMyAdmin(configureContainer?: (obj: PhpMyAdminContainerResource) => Promise, containerName?: string): MySqlServerResource","k":"method","p":"Aspire.Hosting.MySql","s":"Adds a phpMyAdmin administration and development platform for MySql to the application model.","h":"/reference/api/typescript/aspire.hosting.mysql/withphpmyadmin/","v":"13.4.0"},{"n":"MySqlDatabaseResource","f":"Aspire.Hosting.ApplicationModel.MySqlDatabaseResource","k":"handle","p":"Aspire.Hosting.MySql","s":"A resource that represents a MySQL database. This is a child resource of a {@ats-ref type:MySqlServerResource}.","h":"/reference/api/typescript/aspire.hosting.mysql/mysqldatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MySqlDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the connection string expression for the MySQL database.","t":"MySqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqldatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"MySqlDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the database name.","t":"MySqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqldatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"MySqlDatabaseResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the JDBC connection string for the MySQL database.","t":"MySqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqldatabaseresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"parent","f":"MySqlDatabaseResource.parent(): MySqlServerResource","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the parent MySQL container resource.","t":"MySqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqldatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MySqlDatabaseResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the connection URI expression for the MySQL database.","t":"MySqlDatabaseResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqldatabaseresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"MySqlServerResource","f":"Aspire.Hosting.ApplicationModel.MySqlServerResource","k":"handle","p":"Aspire.Hosting.MySql","s":"A resource that represents a MySQL container.","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MySqlServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the connection string expression for the MySQL server.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"MySqlServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.MySql","s":"A dictionary where the key is the resource name and the value is the database name.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"MySqlServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the host endpoint reference for this resource.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#host","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"MySqlServerResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the JDBC connection string for the MySQL server.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"MySqlServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.MySql","s":"Gets or sets the parameter that contains the MySQL server password.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"MySqlServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the port endpoint reference for this resource.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"MySqlServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the primary endpoint for the MySQL server.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MySqlServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.MySql","s":"Gets the connection URI expression for the MySQL server.","t":"MySqlServerResource","h":"/reference/api/typescript/aspire.hosting.mysql/mysqlserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"PhpMyAdminContainerResource","f":"Aspire.Hosting.MySql.PhpMyAdminContainerResource","k":"handle","p":"Aspire.Hosting.MySql","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.mysql/phpmyadmincontainerresource/","v":"13.4.0"},{"n":"addNats","f":"addNats(name: string, port?: number, userName?: ParameterResource, password?: ParameterResource): NatsServerResource","k":"method","p":"Aspire.Hosting.Nats","s":"Adds a NATS server resource to the application model.","h":"/reference/api/typescript/aspire.hosting.nats/addnats/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): NatsServerResource","k":"method","p":"Aspire.Hosting.Nats","s":"Adds a bind mount for the data folder to a NATS container resource.","h":"/reference/api/typescript/aspire.hosting.nats/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): NatsServerResource","k":"method","p":"Aspire.Hosting.Nats","s":"Adds a named volume for the data folder to a NATS container resource.","h":"/reference/api/typescript/aspire.hosting.nats/withdatavolume/","v":"13.4.0"},{"n":"withJetStream","f":"withJetStream(): NatsServerResource","k":"method","p":"Aspire.Hosting.Nats","s":"Adds JetStream support to the NATS server resource.","h":"/reference/api/typescript/aspire.hosting.nats/withjetstream/","v":"13.4.0"},{"n":"NatsServerResource","f":"Aspire.Hosting.ApplicationModel.NatsServerResource","k":"handle","p":"Aspire.Hosting.Nats","s":"A resource that represents a NATS server container.","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"NatsServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Nats","s":"Gets the connection string expression for the NATS server.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"NatsServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Nats","s":"Gets the host endpoint reference for this resource.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"NatsServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Nats","s":"Gets or sets the password for the NATS server.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"NatsServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Nats","s":"Gets the port endpoint reference for this resource.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"NatsServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Nats","s":"Gets the primary endpoint for the NATS server.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"NatsServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Nats","s":"Gets the connection URI expression for the NATS server.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameParameter","f":"NatsServerResource.userNameParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Nats","s":"Gets or sets the user name for the NATS server.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#usernameparameter","m":true,"v":"13.4.0"},{"n":"userNameReference","f":"NatsServerResource.userNameReference(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Nats","s":"Gets a reference to the user name for the NATS server.","t":"NatsServerResource","h":"/reference/api/typescript/aspire.hosting.nats/natsserverresource/#usernamereference","m":true,"v":"13.4.0"},{"n":"addModel","f":"addModel(name: string, model: string): OpenAIModelResource","k":"method","p":"Aspire.Hosting.OpenAI","s":"Adds an OpenAI Model child to the provided OpenAI resource.","h":"/reference/api/typescript/aspire.hosting.openai/addmodel/","v":"13.4.0"},{"n":"addOpenAI","f":"addOpenAI(name: string): OpenAIResource","k":"method","p":"Aspire.Hosting.OpenAI","s":"Adds an OpenAI parent resource that can host multiple models.","h":"/reference/api/typescript/aspire.hosting.openai/addopenai/","v":"13.4.0"},{"n":"withApiKey","f":"withApiKey(apiKey: ParameterResource): OpenAIResource","k":"method","p":"Aspire.Hosting.OpenAI","s":"Configures the API key for the OpenAI parent resource from a parameter.","h":"/reference/api/typescript/aspire.hosting.openai/withapikey/","v":"13.4.0"},{"n":"withEndpoint","f":"withEndpoint(endpoint: string): OpenAIResource","k":"method","p":"Aspire.Hosting.OpenAI","s":"Sets a custom OpenAI-compatible service endpoint URI on the parent resource.","h":"/reference/api/typescript/aspire.hosting.openai/withendpoint/","v":"13.4.0"},{"n":"withHealthCheck","f":"withHealthCheck(): OpenAIModelResource","k":"method","p":"Aspire.Hosting.OpenAI","s":"Adds a health check to the OpenAI Model resource.","h":"/reference/api/typescript/aspire.hosting.openai/withhealthcheck/","v":"13.4.0"},{"n":"OpenAIModelResource","f":"Aspire.Hosting.OpenAI.OpenAIModelResource","k":"handle","p":"Aspire.Hosting.OpenAI","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.openai/openaimodelresource/","v":"13.4.0"},{"n":"OpenAIResource","f":"Aspire.Hosting.OpenAI.OpenAIResource","k":"handle","p":"Aspire.Hosting.OpenAI","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.openai/openairesource/","v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): OracleDatabaseResource","k":"method","p":"Aspire.Hosting.Oracle","s":"Adds a Oracle Database database to the application model.","h":"/reference/api/typescript/aspire.hosting.oracle/adddatabase/","v":"13.4.0"},{"n":"addOracle","f":"addOracle(name: string, password?: ParameterResource, port?: number): OracleDatabaseServerResource","k":"method","p":"Aspire.Hosting.Oracle","s":"Adds a Oracle Server resource to the application model. A container is used for local development.","h":"/reference/api/typescript/aspire.hosting.oracle/addoracle/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): OracleDatabaseServerResource","k":"method","p":"Aspire.Hosting.Oracle","s":"Adds a bind mount for the data folder to a Oracle Database server container resource.","h":"/reference/api/typescript/aspire.hosting.oracle/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): OracleDatabaseServerResource","k":"method","p":"Aspire.Hosting.Oracle","s":"Adds a named volume for the data folder to a Oracle Database server container resource.","h":"/reference/api/typescript/aspire.hosting.oracle/withdatavolume/","v":"13.4.0"},{"n":"withDbSetupBindMount","f":"withDbSetupBindMount(source: string): OracleDatabaseServerResource","k":"method","p":"Aspire.Hosting.Oracle","s":"Adds a bind mount for the database setup folder to a Oracle Database server container resource.","h":"/reference/api/typescript/aspire.hosting.oracle/withdbsetupbindmount/","v":"13.4.0"},{"n":"withInitFiles","f":"withInitFiles(source: string): OracleDatabaseServerResource","k":"method","p":"Aspire.Hosting.Oracle","s":"Copies init files into a Oracle Database server container resource.","h":"/reference/api/typescript/aspire.hosting.oracle/withinitfiles/","v":"13.4.0"},{"n":"OracleDatabaseResource","f":"Aspire.Hosting.ApplicationModel.OracleDatabaseResource","k":"handle","p":"Aspire.Hosting.Oracle","s":"A resource that represents an Oracle Database database. This is a child resource of a {@ats-ref type:OracleDatabaseServerResource}.","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"OracleDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the connection string expression for the Oracle Database.","t":"OracleDatabaseResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"OracleDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the database name.","t":"OracleDatabaseResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"OracleDatabaseResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the JDBC connection string for the Oracle Database.","t":"OracleDatabaseResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"parent","f":"OracleDatabaseResource.parent(): OracleDatabaseServerResource","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the parent Oracle container resource.","t":"OracleDatabaseResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"OracleDatabaseResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the connection URI expression for the Oracle database.","t":"OracleDatabaseResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"OracleDatabaseServerResource","f":"Aspire.Hosting.ApplicationModel.OracleDatabaseServerResource","k":"handle","p":"Aspire.Hosting.Oracle","s":"A resource that represents an Oracle Database container.","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"OracleDatabaseServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the connection string expression for the Oracle Database server.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"OracleDatabaseServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.Oracle","s":"A dictionary where the key is the resource name and the value is the database name.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"OracleDatabaseServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the host endpoint reference for this resource.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#host","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"OracleDatabaseServerResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the JDBC connection string for the Oracle Database server.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"OracleDatabaseServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the parameter that contains the Oracle Database server password.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"OracleDatabaseServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the port endpoint reference for this resource.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"OracleDatabaseServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the primary endpoint for the Oracle server.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"OracleDatabaseServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets the connection URI expression for the Oracle server.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameReference","f":"OracleDatabaseServerResource.userNameReference(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Oracle","s":"Gets a reference to the user name for the Oracle server.","t":"OracleDatabaseServerResource","h":"/reference/api/typescript/aspire.hosting.oracle/oracledatabaseserverresource/#usernamereference","m":true,"v":"13.4.0"},{"n":"addOrleans","f":"addOrleans(name: string): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds an Orleans service to the application.","h":"/reference/api/typescript/aspire.hosting.orleans/addorleans/","v":"13.4.0"},{"n":"asClient","f":"asClient(): OrleansServiceClient","k":"method","p":"Aspire.Hosting.Orleans","s":"Returns a model of the clients of an Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/asclient/","v":"13.4.0"},{"n":"withBroadcastChannel","f":"withBroadcastChannel(name: string): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds a broadcast channel provider to the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withbroadcastchannel/","v":"13.4.0"},{"n":"withClusterId","f":"withClusterId(clusterId: string): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Sets the ClusterId of the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withclusterid/","v":"13.4.0"},{"n":"withClustering","f":"withClustering(provider: IResourceWithConnectionString): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Configures the Orleans service to use the provided clustering provider.","h":"/reference/api/typescript/aspire.hosting.orleans/withclustering/","v":"13.4.0"},{"n":"withDevelopmentClustering","f":"withDevelopmentClustering(): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Configures the Orleans service to use development-only clustering.","h":"/reference/api/typescript/aspire.hosting.orleans/withdevelopmentclustering/","v":"13.4.0"},{"n":"withGrainDirectory","f":"withGrainDirectory(name: string, provider: IResourceWithConnectionString): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds a grain directory provider to the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withgraindirectory/","v":"13.4.0"},{"n":"withGrainStorage","f":"withGrainStorage(name: string, provider: IResourceWithConnectionString): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds a grain storage provider to the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withgrainstorage/","v":"13.4.0"},{"n":"withMemoryGrainStorage","f":"withMemoryGrainStorage(name: string): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds an in-memory grain storage to the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withmemorygrainstorage/","v":"13.4.0"},{"n":"withMemoryReminders","f":"withMemoryReminders(): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Configures in-memory reminder storage for the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withmemoryreminders/","v":"13.4.0"},{"n":"withMemoryStreaming","f":"withMemoryStreaming(name: string): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds an in-memory stream provider to the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withmemorystreaming/","v":"13.4.0"},{"n":"withOrleansClientReference","f":"withOrleansClientReference(orleansServiceClient: OrleansServiceClient): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds an Orleans client to the resource.","h":"/reference/api/typescript/aspire.hosting.orleans/withorleansclientreference/","v":"13.4.0"},{"n":"withOrleansReference","f":"withOrleansReference(orleansService: OrleansService): IResourceWithEnvironment","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds Orleans to the resource.","h":"/reference/api/typescript/aspire.hosting.orleans/withorleansreference/","v":"13.4.0"},{"n":"withReminders","f":"withReminders(provider: IResourceWithConnectionString): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Configures reminder storage for the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withreminders/","v":"13.4.0"},{"n":"withServiceId","f":"withServiceId(serviceId: string): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Sets the ServiceId of the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withserviceid/","v":"13.4.0"},{"n":"withStreaming","f":"withStreaming(name: string, provider: IResourceWithConnectionString): OrleansService","k":"method","p":"Aspire.Hosting.Orleans","s":"Adds a stream provider to the Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/withstreaming/","v":"13.4.0"},{"n":"OrleansService","f":"Aspire.Hosting.Orleans.OrleansService","k":"handle","p":"Aspire.Hosting.Orleans","s":"Describes an Orleans service.","h":"/reference/api/typescript/aspire.hosting.orleans/orleansservice/","v":"13.4.0"},{"n":"OrleansServiceClient","f":"Aspire.Hosting.Orleans.OrleansServiceClient","k":"handle","p":"Aspire.Hosting.Orleans","s":"Represents an Orleans client configuration that can be referenced by application resources.","h":"/reference/api/typescript/aspire.hosting.orleans/orleansserviceclient/","v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): PostgresDatabaseResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds a PostgreSQL database to the application model.","h":"/reference/api/typescript/aspire.hosting.postgresql/adddatabase/","v":"13.4.0"},{"n":"addPostgres","f":"addPostgres(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds a PostgreSQL resource to the application model. A container is used for local development.","h":"/reference/api/typescript/aspire.hosting.postgresql/addpostgres/","v":"13.4.0"},{"n":"withCreationScript","f":"withCreationScript(script: string): PostgresDatabaseResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Defines the SQL script used to create the database.","h":"/reference/api/typescript/aspire.hosting.postgresql/withcreationscript/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds a bind mount for the data folder to a PostgreSQL container resource.","h":"/reference/api/typescript/aspire.hosting.postgresql/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds a named volume for the data folder to a PostgreSQL container resource.","h":"/reference/api/typescript/aspire.hosting.postgresql/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): PgAdminContainerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Configures the host port that the PGAdmin resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.postgresql/withhostport-aspire-hosting-postgres-pgadmincontainerresource-number/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): PgWebContainerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Configures the host port that the pgweb resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.postgresql/withhostport-aspire-hosting-postgres-pgwebcontainerresource-number/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Configures the host port that the PostgreSQL resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.postgresql/withhostport-aspire-hosting-applicationmodel-postgresserverresource-number/","v":"13.4.0"},{"n":"withInitFiles","f":"withInitFiles(source: string): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Copies init files to a PostgreSQL container resource.","h":"/reference/api/typescript/aspire.hosting.postgresql/withinitfiles/","v":"13.4.0"},{"n":"withPassword","f":"withPassword(password: ParameterResource): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Configures the password that the PostgreSQL resource is used.","h":"/reference/api/typescript/aspire.hosting.postgresql/withpassword/","v":"13.4.0"},{"n":"withPgAdmin","f":"withPgAdmin(configureContainer?: (obj: PgAdminContainerResource) => Promise, containerName?: string): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds a pgAdmin 4 administration and development platform for PostgreSQL to the application model.","h":"/reference/api/typescript/aspire.hosting.postgresql/withpgadmin/","v":"13.4.0"},{"n":"withPgWeb","f":"withPgWeb(configureContainer?: (obj: PgWebContainerResource) => Promise, containerName?: string): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds an administration and development platform for PostgreSQL to the application model using pgweb.","h":"/reference/api/typescript/aspire.hosting.postgresql/withpgweb/","v":"13.4.0"},{"n":"withPostgresMcp","f":"withPostgresMcp(configureContainer?: (obj: PostgresMcpContainerResource) => Promise, containerName?: string): PostgresDatabaseResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Adds a Postgres MCP server container and configures it to connect to the database represented by `builder`.","h":"/reference/api/typescript/aspire.hosting.postgresql/withpostgresmcp/","v":"13.4.0"},{"n":"withUserName","f":"withUserName(userName: ParameterResource): PostgresServerResource","k":"method","p":"Aspire.Hosting.PostgreSQL","s":"Configures the user name that the PostgreSQL resource is used.","h":"/reference/api/typescript/aspire.hosting.postgresql/withusername/","v":"13.4.0"},{"n":"PostgresDatabaseResource","f":"Aspire.Hosting.ApplicationModel.PostgresDatabaseResource","k":"handle","p":"Aspire.Hosting.PostgreSQL","s":"A resource that represents a PostgreSQL database. This is a child resource of a {@ats-ref type:PostgresServerResource}.","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresdatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"PostgresDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the connection string expression for the Postgres database.","t":"PostgresDatabaseResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresdatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"PostgresDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the database name.","t":"PostgresDatabaseResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresdatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"PostgresDatabaseResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the JDBC connection string for the PostgreSQL database.","t":"PostgresDatabaseResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresdatabaseresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"parent","f":"PostgresDatabaseResource.parent(): PostgresServerResource","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the parent PostgresSQL container resource.","t":"PostgresDatabaseResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresdatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"PostgresDatabaseResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the connection URI expression for the PostgreSQL database.","t":"PostgresDatabaseResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresdatabaseresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"PostgresServerResource","f":"Aspire.Hosting.ApplicationModel.PostgresServerResource","k":"handle","p":"Aspire.Hosting.PostgreSQL","s":"A resource that represents a PostgreSQL container.","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"PostgresServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the connection string expression for the PostgreSQL server.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"PostgresServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"A dictionary where the key is the resource name and the value is the database name.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"PostgresServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the host endpoint reference for this service.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#host","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"PostgresServerResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the JDBC connection string for the PostgreSQL server.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"PostgresServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets or sets the parameter that contains the PostgreSQL server password.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"PostgresServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the endpoint reference expression that identifies the port for this endpoint.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"PostgresServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the primary endpoint for the PostgreSQL server.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"PostgresServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets the connection URI expression for the PostgreSQL server.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameParameter","f":"PostgresServerResource.userNameParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets or sets the parameter that contains the PostgreSQL server user name.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#usernameparameter","m":true,"v":"13.4.0"},{"n":"userNameReference","f":"PostgresServerResource.userNameReference(): ReferenceExpression","k":"property","p":"Aspire.Hosting.PostgreSQL","s":"Gets a reference to the user name for the PostgreSQL server.","t":"PostgresServerResource","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresserverresource/#usernamereference","m":true,"v":"13.4.0"},{"n":"PgAdminContainerResource","f":"Aspire.Hosting.Postgres.PgAdminContainerResource","k":"handle","p":"Aspire.Hosting.PostgreSQL","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.postgresql/pgadmincontainerresource/","v":"13.4.0"},{"n":"PgWebContainerResource","f":"Aspire.Hosting.Postgres.PgWebContainerResource","k":"handle","p":"Aspire.Hosting.PostgreSQL","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.postgresql/pgwebcontainerresource/","v":"13.4.0"},{"n":"PostgresMcpContainerResource","f":"Aspire.Hosting.Postgres.PostgresMcpContainerResource","k":"handle","p":"Aspire.Hosting.PostgreSQL","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.postgresql/postgresmcpcontainerresource/","v":"13.4.0"},{"n":"addPythonApp","f":"addPythonApp(name: string, appDirectory: string, scriptPath: string): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Adds a Python application to the application model.","h":"/reference/api/typescript/aspire.hosting.python/addpythonapp/","v":"13.4.0"},{"n":"addPythonExecutable","f":"addPythonExecutable(name: string, appDirectory: string, executableName: string): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Adds a Python executable to the application model.","h":"/reference/api/typescript/aspire.hosting.python/addpythonexecutable/","v":"13.4.0"},{"n":"addPythonModule","f":"addPythonModule(name: string, appDirectory: string, moduleName: string): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Adds a Python module to the application model.","h":"/reference/api/typescript/aspire.hosting.python/addpythonmodule/","v":"13.4.0"},{"n":"addUvicornApp","f":"addUvicornApp(name: string, appDirectory: string, app: string): UvicornAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Adds a Uvicorn-based Python application to the distributed application builder with HTTP endpoint configuration.","h":"/reference/api/typescript/aspire.hosting.python/adduvicornapp/","v":"13.4.0"},{"n":"withDebugging","f":"withDebugging(): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Enables debugging support for the Python application.","h":"/reference/api/typescript/aspire.hosting.python/withdebugging/","v":"13.4.0"},{"n":"withEntrypoint","f":"withEntrypoint(entrypointType: EntrypointType, entrypoint: string): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Configures the entrypoint for the Python application.","h":"/reference/api/typescript/aspire.hosting.python/withentrypoint/","v":"13.4.0"},{"n":"withPip","f":"withPip(install?: boolean, installArgs?: string[]): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Configures the Python resource to use pip as the package manager and optionally installs packages before the application starts.","h":"/reference/api/typescript/aspire.hosting.python/withpip/","v":"13.4.0"},{"n":"withUv","f":"withUv(install?: boolean, args?: string[]): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Adds a UV environment setup task to ensure the virtual environment exists before running the Python application.","h":"/reference/api/typescript/aspire.hosting.python/withuv/","v":"13.4.0"},{"n":"withVirtualEnvironment","f":"withVirtualEnvironment(virtualEnvironmentPath: string, createIfNotExists?: boolean): PythonAppResource","k":"method","p":"Aspire.Hosting.Python","s":"Configures a custom virtual environment path for the Python application.","h":"/reference/api/typescript/aspire.hosting.python/withvirtualenvironment/","v":"13.4.0"},{"n":"PythonAppResource","f":"Aspire.Hosting.Python.PythonAppResource","k":"handle","p":"Aspire.Hosting.Python","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.python/pythonappresource/","v":"13.4.0"},{"n":"UvicornAppResource","f":"Aspire.Hosting.Python.UvicornAppResource","k":"handle","p":"Aspire.Hosting.Python","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.python/uvicornappresource/","v":"13.4.0"},{"n":"EntrypointType","f":"Aspire.Hosting.Python.EntrypointType","k":"enum","p":"Aspire.Hosting.Python","s":"Specifies the type of entrypoint for a Python application.","h":"/reference/api/typescript/aspire.hosting.python/entrypointtype/","v":"13.4.0"},{"n":"addQdrant","f":"addQdrant(name: string, apiKey?: ParameterResource, grpcPort?: number, httpPort?: number): QdrantServerResource","k":"method","p":"Aspire.Hosting.Qdrant","s":"Adds a Qdrant resource to the application. A container is used for local development.","h":"/reference/api/typescript/aspire.hosting.qdrant/addqdrant/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): QdrantServerResource","k":"method","p":"Aspire.Hosting.Qdrant","s":"Adds a bind mount for the data folder to a Qdrant container resource.","h":"/reference/api/typescript/aspire.hosting.qdrant/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): QdrantServerResource","k":"method","p":"Aspire.Hosting.Qdrant","s":"Adds a named volume for the data folder to a Qdrant container resource.","h":"/reference/api/typescript/aspire.hosting.qdrant/withdatavolume/","v":"13.4.0"},{"n":"QdrantServerResource","f":"Aspire.Hosting.ApplicationModel.QdrantServerResource","k":"handle","p":"Aspire.Hosting.Qdrant","s":"A resource that represents a Qdrant database.","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/","v":"13.4.0"},{"n":"apiKeyParameter","f":"QdrantServerResource.apiKeyParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the parameter that contains the Qdrant API key.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#apikeyparameter","m":true,"v":"13.4.0"},{"n":"connectionStringExpression","f":"QdrantServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the connection string expression for the Qdrant gRPC endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"grpcHost","f":"QdrantServerResource.grpcHost(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the host endpoint reference for the gRPC endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#grpchost","m":true,"v":"13.4.0"},{"n":"grpcPort","f":"QdrantServerResource.grpcPort(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the port endpoint reference for the gRPC endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#grpcport","m":true,"v":"13.4.0"},{"n":"httpConnectionStringExpression","f":"QdrantServerResource.httpConnectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the connection string expression for the Qdrant HTTP endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#httpconnectionstringexpression","m":true,"v":"13.4.0"},{"n":"httpEndpoint","f":"QdrantServerResource.httpEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the HTTP endpoint for the Qdrant database.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#httpendpoint","m":true,"v":"13.4.0"},{"n":"httpHost","f":"QdrantServerResource.httpHost(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the host endpoint reference for the HTTP endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#httphost","m":true,"v":"13.4.0"},{"n":"httpPort","f":"QdrantServerResource.httpPort(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the port endpoint reference for the HTTP endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#httpport","m":true,"v":"13.4.0"},{"n":"httpUriExpression","f":"QdrantServerResource.httpUriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the connection URI expression for the Qdrant HTTP endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#httpuriexpression","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"QdrantServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the gRPC endpoint for the Qdrant database.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"QdrantServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Qdrant","s":"Gets the connection URI expression for the Qdrant gRPC endpoint.","t":"QdrantServerResource","h":"/reference/api/typescript/aspire.hosting.qdrant/qdrantserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addRabbitMQ","f":"addRabbitMQ(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number): RabbitMQServerResource","k":"method","p":"Aspire.Hosting.RabbitMQ","s":"Adds a RabbitMQ container to the application model.","h":"/reference/api/typescript/aspire.hosting.rabbitmq/addrabbitmq/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): RabbitMQServerResource","k":"method","p":"Aspire.Hosting.RabbitMQ","s":"Adds a bind mount for the data folder to a RabbitMQ container resource.","h":"/reference/api/typescript/aspire.hosting.rabbitmq/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): RabbitMQServerResource","k":"method","p":"Aspire.Hosting.RabbitMQ","s":"Adds a named volume for the data folder to a RabbitMQ container resource.","h":"/reference/api/typescript/aspire.hosting.rabbitmq/withdatavolume/","v":"13.4.0"},{"n":"withManagementPlugin","f":"withManagementPlugin(port?: number): RabbitMQServerResource","k":"method","p":"Aspire.Hosting.RabbitMQ","s":"Enables the RabbitMQ management plugin","h":"/reference/api/typescript/aspire.hosting.rabbitmq/withmanagementplugin/","v":"13.4.0"},{"n":"RabbitMQServerResource","f":"Aspire.Hosting.ApplicationModel.RabbitMQServerResource","k":"handle","p":"Aspire.Hosting.RabbitMQ","s":"A resource that represents a RabbitMQ resource.","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"RabbitMQServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the connection string expression for the RabbitMQ server.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"RabbitMQServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the host endpoint reference for this resource.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#host","m":true,"v":"13.4.0"},{"n":"managementEndpoint","f":"RabbitMQServerResource.managementEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the management endpoint for the RabbitMQ server.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#managementendpoint","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"RabbitMQServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the parameter that contains the RabbitMQ server password.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"RabbitMQServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the port endpoint reference for this resource.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"RabbitMQServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the primary endpoint for the RabbitMQ server.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"RabbitMQServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the connection URI expression for the RabbitMQ server.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameParameter","f":"RabbitMQServerResource.userNameParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets the parameter that contains the RabbitMQ server user name.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#usernameparameter","m":true,"v":"13.4.0"},{"n":"userNameReference","f":"RabbitMQServerResource.userNameReference(): ReferenceExpression","k":"property","p":"Aspire.Hosting.RabbitMQ","s":"Gets a reference to the user name for the RabbitMQ server.","t":"RabbitMQServerResource","h":"/reference/api/typescript/aspire.hosting.rabbitmq/rabbitmqserverresource/#usernamereference","m":true,"v":"13.4.0"},{"n":"addRedis","f":"addRedis(name: string, port?: number, password?: ParameterResource): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds a Redis container to the application model.","h":"/reference/api/typescript/aspire.hosting.redis/addredis/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds a bind mount for the data folder to a Redis container resource and enables Redis persistence.","h":"/reference/api/typescript/aspire.hosting.redis/withdatabindmount-aspire-hosting-applicationmodel-redisresource-string-boolean/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): RedisInsightResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds a bind mount for the data folder to a Redis Insight container resource.","h":"/reference/api/typescript/aspire.hosting.redis/withdatabindmount-aspire-hosting-redis-redisinsightresource-string/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds a named volume for the data folder to a Redis container resource and enables Redis persistence.","h":"/reference/api/typescript/aspire.hosting.redis/withdatavolume-aspire-hosting-applicationmodel-redisresource-string-boolean/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): RedisInsightResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds a named volume for the data folder to a Redis Insight container resource.","h":"/reference/api/typescript/aspire.hosting.redis/withdatavolume-aspire-hosting-redis-redisinsightresource-string/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): RedisCommanderResource","k":"method","p":"Aspire.Hosting.Redis","s":"Configures the host port that the Redis Commander resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.redis/withhostport-aspire-hosting-redis-rediscommanderresource-number/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): RedisInsightResource","k":"method","p":"Aspire.Hosting.Redis","s":"Configures the host port that the Redis Insight resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.redis/withhostport-aspire-hosting-redis-redisinsightresource-number/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Configures the host port that the Redis resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.redis/withhostport-aspire-hosting-applicationmodel-redisresource-number/","v":"13.4.0"},{"n":"withPassword","f":"withPassword(password: ParameterResource): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Configures the password that the Redis resource is used.","h":"/reference/api/typescript/aspire.hosting.redis/withpassword/","v":"13.4.0"},{"n":"withPersistence","f":"withPersistence(interval?: timespan, keysChangedThreshold?: number): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Configures a Redis container resource for persistence.","h":"/reference/api/typescript/aspire.hosting.redis/withpersistence/","v":"13.4.0"},{"n":"withRedisCommander","f":"withRedisCommander(configureContainer?: (obj: RedisCommanderResource) => Promise, containerName?: string): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds Redis Commander management UI","h":"/reference/api/typescript/aspire.hosting.redis/withrediscommander/","v":"13.4.0"},{"n":"withRedisInsight","f":"withRedisInsight(configureContainer?: (obj: RedisInsightResource) => Promise, containerName?: string): RedisResource","k":"method","p":"Aspire.Hosting.Redis","s":"Adds Redis Insight management UI","h":"/reference/api/typescript/aspire.hosting.redis/withredisinsight/","v":"13.4.0"},{"n":"RedisResource","f":"Aspire.Hosting.ApplicationModel.RedisResource","k":"handle","p":"Aspire.Hosting.Redis","s":"A resource that represents a Redis resource independent of the hosting model.","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"RedisResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Redis","s":"Gets the connection string expression for the Redis server.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"RedisResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Redis","s":"Gets the host endpoint reference for this resource.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"RedisResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Redis","s":"Gets the parameter that contains the Redis server password.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"RedisResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Redis","s":"Gets the port endpoint reference for this resource.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"RedisResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Redis","s":"Gets the primary endpoint for the Redis server.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"tlsEnabled","f":"RedisResource.tlsEnabled(): boolean","k":"property","p":"Aspire.Hosting.Redis","s":"Indicates whether TLS is enabled for the Redis server.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#tlsenabled","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"RedisResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Redis","s":"Gets the connection URI expression for the Redis server.","t":"RedisResource","h":"/reference/api/typescript/aspire.hosting.redis/redisresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"RedisCommanderResource","f":"Aspire.Hosting.Redis.RedisCommanderResource","k":"handle","p":"Aspire.Hosting.Redis","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.redis/rediscommanderresource/","v":"13.4.0"},{"n":"RedisInsightResource","f":"Aspire.Hosting.Redis.RedisInsightResource","k":"handle","p":"Aspire.Hosting.Redis","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.redis/redisinsightresource/","v":"13.4.0"},{"n":"addSeq","f":"addSeq(name: string, adminPassword: ParameterResource, port?: number): SeqResource","k":"method","p":"Aspire.Hosting.Seq","s":"Adds a Seq server resource to the application model with authentication enabled. A container is used for local development.","h":"/reference/api/typescript/aspire.hosting.seq/addseq/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): SeqResource","k":"method","p":"Aspire.Hosting.Seq","s":"Adds a bind mount for the data folder to a Seq container resource.","h":"/reference/api/typescript/aspire.hosting.seq/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): SeqResource","k":"method","p":"Aspire.Hosting.Seq","s":"Adds a named volume for the data folder to a Seq container resource.","h":"/reference/api/typescript/aspire.hosting.seq/withdatavolume/","v":"13.4.0"},{"n":"SeqResource","f":"Aspire.Hosting.ApplicationModel.SeqResource","k":"handle","p":"Aspire.Hosting.Seq","s":"An Aspire resource that is a Seq server.","h":"/reference/api/typescript/aspire.hosting.seq/seqresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SeqResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Seq","s":"Gets the connection string expression for the Seq server.","t":"SeqResource","h":"/reference/api/typescript/aspire.hosting.seq/seqresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"SeqResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Seq","s":"Gets the host endpoint reference for this resource.","t":"SeqResource","h":"/reference/api/typescript/aspire.hosting.seq/seqresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"SeqResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Seq","s":"Gets the port endpoint reference for this resource.","t":"SeqResource","h":"/reference/api/typescript/aspire.hosting.seq/seqresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"SeqResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Seq","s":"Gets the primary endpoint for the Seq server.","t":"SeqResource","h":"/reference/api/typescript/aspire.hosting.seq/seqresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SeqResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Seq","s":"Gets the connection URI expression for the Seq server.","t":"SeqResource","h":"/reference/api/typescript/aspire.hosting.seq/seqresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): SqlServerDatabaseResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Adds a SQL Server database resource","h":"/reference/api/typescript/aspire.hosting.sqlserver/adddatabase/","v":"13.4.0"},{"n":"addSqlServer","f":"addSqlServer(name: string, password?: ParameterResource, port?: number): SqlServerServerResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Adds a SQL Server resource to the application model. A container is used for local development.","h":"/reference/api/typescript/aspire.hosting.sqlserver/addsqlserver/","v":"13.4.0"},{"n":"withCreationScript","f":"withCreationScript(script: string): SqlServerDatabaseResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Defines the SQL script used to create the database.","h":"/reference/api/typescript/aspire.hosting.sqlserver/withcreationscript/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): SqlServerServerResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Adds a bind mount for the data folder to a SQL Server resource.","h":"/reference/api/typescript/aspire.hosting.sqlserver/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): SqlServerServerResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Adds a named volume for the data folder to a SQL Server resource.","h":"/reference/api/typescript/aspire.hosting.sqlserver/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): SqlServerServerResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Configures the host port that the SqlServer resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.sqlserver/withhostport/","v":"13.4.0"},{"n":"withPassword","f":"withPassword(password: ParameterResource): SqlServerServerResource","k":"method","p":"Aspire.Hosting.SqlServer","s":"Configures the password that the SqlServer resource is used.","h":"/reference/api/typescript/aspire.hosting.sqlserver/withpassword/","v":"13.4.0"},{"n":"SqlServerDatabaseResource","f":"Aspire.Hosting.ApplicationModel.SqlServerDatabaseResource","k":"handle","p":"Aspire.Hosting.SqlServer","s":"A resource that represents a SQL Server database that is a child of a SQL Server container resource.","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverdatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SqlServerDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the connection string expression for the SQL Server database.","t":"SqlServerDatabaseResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverdatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"SqlServerDatabaseResource.databaseName(): string","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the database name.","t":"SqlServerDatabaseResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverdatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"SqlServerDatabaseResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the JDBC connection string for the SQL Server database.","t":"SqlServerDatabaseResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverdatabaseresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"parent","f":"SqlServerDatabaseResource.parent(): SqlServerServerResource","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the parent SQL Server container resource.","t":"SqlServerDatabaseResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverdatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SqlServerDatabaseResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the connection URI expression for the SQL Server database.","t":"SqlServerDatabaseResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverdatabaseresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"SqlServerServerResource","f":"Aspire.Hosting.ApplicationModel.SqlServerServerResource","k":"handle","p":"Aspire.Hosting.SqlServer","s":"A resource that represents a SQL Server container.","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SqlServerServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the connection string expression for the SQL Server.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"SqlServerServerResource.databases(): Dict","k":"property","p":"Aspire.Hosting.SqlServer","s":"A dictionary where the key is the resource name and the value is the database name.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"SqlServerServerResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the host endpoint reference for this resource.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#host","m":true,"v":"13.4.0"},{"n":"jdbcConnectionString","f":"SqlServerServerResource.jdbcConnectionString(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the JDBC connection string for the SQL Server.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#jdbcconnectionstring","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"SqlServerServerResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the parameter that contains the SQL Server password.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"SqlServerServerResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the port endpoint reference for this resource.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"SqlServerServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the primary endpoint for the SQL Server.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SqlServerServerResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets the connection URI expression for the SQL Server.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameReference","f":"SqlServerServerResource.userNameReference(): ReferenceExpression","k":"property","p":"Aspire.Hosting.SqlServer","s":"Gets a reference to the user name for the SQL Server.","t":"SqlServerServerResource","h":"/reference/api/typescript/aspire.hosting.sqlserver/sqlserverserverresource/#usernamereference","m":true,"v":"13.4.0"},{"n":"addValkey","f":"addValkey(name: string, port?: number, password?: ParameterResource): ValkeyResource","k":"method","p":"Aspire.Hosting.Valkey","s":"Adds a Valkey container to the application model.","h":"/reference/api/typescript/aspire.hosting.valkey/addvalkey/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): ValkeyResource","k":"method","p":"Aspire.Hosting.Valkey","s":"Adds a bind mount for the data folder to a Valkey container resource and enables Valkey persistence.","h":"/reference/api/typescript/aspire.hosting.valkey/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): ValkeyResource","k":"method","p":"Aspire.Hosting.Valkey","s":"Adds a named volume for the data folder to a Valkey container resource and enables Valkey persistence.","h":"/reference/api/typescript/aspire.hosting.valkey/withdatavolume/","v":"13.4.0"},{"n":"withPersistence","f":"withPersistence(interval?: timespan, keysChangedThreshold?: number): ValkeyResource","k":"method","p":"Aspire.Hosting.Valkey","s":"Configures a Valkey container resource for persistence.","h":"/reference/api/typescript/aspire.hosting.valkey/withpersistence/","v":"13.4.0"},{"n":"ValkeyResource","f":"Aspire.Hosting.ApplicationModel.ValkeyResource","k":"handle","p":"Aspire.Hosting.Valkey","s":"A resource that represents a Valkey resource independent of the hosting model.","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"ValkeyResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Valkey","s":"Gets the connection string expression for the Valkey server.","t":"ValkeyResource","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"ValkeyResource.host(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Valkey","s":"Gets the host endpoint reference for this resource.","t":"ValkeyResource","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"ValkeyResource.passwordParameter(): ParameterResource","k":"property","p":"Aspire.Hosting.Valkey","s":"Gets the parameter that contains the Valkey server password.","t":"ValkeyResource","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"ValkeyResource.port(): EndpointReferenceExpression","k":"property","p":"Aspire.Hosting.Valkey","s":"Gets the port endpoint reference for this resource.","t":"ValkeyResource","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"ValkeyResource.primaryEndpoint(): EndpointReference","k":"property","p":"Aspire.Hosting.Valkey","s":"Gets the primary endpoint for the Valkey server.","t":"ValkeyResource","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"ValkeyResource.uriExpression(): ReferenceExpression","k":"property","p":"Aspire.Hosting.Valkey","s":"Gets the connection URI expression for the Valkey server.","t":"ValkeyResource","h":"/reference/api/typescript/aspire.hosting.valkey/valkeyresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addCatchAllRoute","f":"addCatchAllRoute(target: ExternalServiceResource|string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a catch-all route for a cluster, endpoint, resource, or string destination target.","h":"/reference/api/typescript/aspire.hosting.yarp/addcatchallroute/","v":"13.4.0"},{"n":"addClusterFromEndpoint","f":"addClusterFromEndpoint(endpoint: EndpointReference): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a cluster for an endpoint reference.","h":"/reference/api/typescript/aspire.hosting.yarp/addclusterfromendpoint/","v":"13.4.0"},{"n":"addClusterFromExternalService","f":"addClusterFromExternalService(externalService: ExternalServiceResource): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a cluster for an external service resource.","h":"/reference/api/typescript/aspire.hosting.yarp/addclusterfromexternalservice/","v":"13.4.0"},{"n":"addClusterFromResource","f":"addClusterFromResource(resource: IResourceWithServiceDiscovery): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a cluster for a resource that supports service discovery.","h":"/reference/api/typescript/aspire.hosting.yarp/addclusterfromresource/","v":"13.4.0"},{"n":"addClusterWithDestination","f":"addClusterWithDestination(clusterName: string, destination: any): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a cluster from a single destination.","h":"/reference/api/typescript/aspire.hosting.yarp/addclusterwithdestination/","v":"13.4.0"},{"n":"addClusterWithDestinations","f":"addClusterWithDestinations(clusterName: string, destinations: any[]): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a cluster from multiple destinations.","h":"/reference/api/typescript/aspire.hosting.yarp/addclusterwithdestinations/","v":"13.4.0"},{"n":"addRoute","f":"addRoute(path: string, target: ExternalServiceResource|string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a route for a cluster, endpoint, resource, or string destination target.","h":"/reference/api/typescript/aspire.hosting.yarp/addroute/","v":"13.4.0"},{"n":"addYarp","f":"addYarp(name: string): YarpResource","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds a YARP container to the application model.","h":"/reference/api/typescript/aspire.hosting.yarp/addyarp/","v":"13.4.0"},{"n":"publishWithStaticFiles","f":"publishWithStaticFiles(resourceWithFiles: IResourceWithContainerFiles): YarpResource","k":"method","p":"Aspire.Hosting.Yarp","s":"In publish mode, generates a Dockerfile that copies static files from the specified resource into /app/wwwroot.","h":"/reference/api/typescript/aspire.hosting.yarp/publishwithstaticfiles/","v":"13.4.0"},{"n":"withConfiguration","f":"withConfiguration(configurationBuilder: (obj: IYarpConfigurationBuilder) => Promise): YarpResource","k":"method","p":"Aspire.Hosting.Yarp","s":"Configure the YARP resource.","h":"/reference/api/typescript/aspire.hosting.yarp/withconfiguration/","v":"13.4.0"},{"n":"withForwarderRequestConfig","f":"withForwarderRequestConfig(config: YarpForwarderRequestConfig): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the forwarder request configuration for the cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/withforwarderrequestconfig/","v":"13.4.0"},{"n":"withHealthCheckConfig","f":"withHealthCheckConfig(config: YarpHealthCheckConfig): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the health check configuration for the cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/withhealthcheckconfig/","v":"13.4.0"},{"n":"withHostHttpsPort","f":"withHostHttpsPort(port: number): YarpResource","k":"method","p":"Aspire.Hosting.Yarp","s":"Configures the host HTTPS port that the YARP resource is exposed on instead of using randomly assigned port. This will only have effect if an HTTPS endpoint is configured on the YARP resource due to TLS termination being enabled.","h":"/reference/api/typescript/aspire.hosting.yarp/withhosthttpsport/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): YarpResource","k":"method","p":"Aspire.Hosting.Yarp","s":"Configures the host port that the YARP resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/aspire.hosting.yarp/withhostport/","v":"13.4.0"},{"n":"withHttpClientConfig","f":"withHttpClientConfig(config: YarpHttpClientConfig): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the HTTP client configuration for the cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/withhttpclientconfig/","v":"13.4.0"},{"n":"withLoadBalancingPolicy","f":"withLoadBalancingPolicy(policy: string): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the LoadBalancingPolicy for the cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/withloadbalancingpolicy/","v":"13.4.0"},{"n":"withMatch","f":"withMatch(match: YarpRouteMatch): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the parameters used to match requests.","h":"/reference/api/typescript/aspire.hosting.yarp/withmatch/","v":"13.4.0"},{"n":"withMatchHeaders","f":"withMatchHeaders(headers: YarpRouteHeaderMatch[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Only match requests that contain all of these headers.","h":"/reference/api/typescript/aspire.hosting.yarp/withmatchheaders/","v":"13.4.0"},{"n":"withMatchHosts","f":"withMatchHosts(hosts: string[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Only match requests with the given Host header. Supports wildcards and ports. For unicode host names, do not use punycode.","h":"/reference/api/typescript/aspire.hosting.yarp/withmatchhosts/","v":"13.4.0"},{"n":"withMatchMethods","f":"withMatchMethods(methods: string[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Only match requests that use these optional HTTP methods. E.g. GET, POST.","h":"/reference/api/typescript/aspire.hosting.yarp/withmatchmethods/","v":"13.4.0"},{"n":"withMatchPath","f":"withMatchPath(path: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Only match requests with the given Path pattern.","h":"/reference/api/typescript/aspire.hosting.yarp/withmatchpath/","v":"13.4.0"},{"n":"withMatchRouteQueryParameter","f":"withMatchRouteQueryParameter(queryParameters: YarpRouteQueryParameterMatch[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Only match requests that contain all of these query parameters.","h":"/reference/api/typescript/aspire.hosting.yarp/withmatchroutequeryparameter/","v":"13.4.0"},{"n":"withMaxRequestBodySize","f":"withMaxRequestBodySize(maxRequestBodySize: number): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the MaxRequestBodySize for the destination","h":"/reference/api/typescript/aspire.hosting.yarp/withmaxrequestbodysize/","v":"13.4.0"},{"n":"withMetadata","f":"withMetadata(metadata: Dict): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the Metadata for the cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/withmetadata-aspire-hosting-yarp-yarpcluster-dict-string-string/","v":"13.4.0"},{"n":"withMetadata","f":"withMetadata(metadata: Dict): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the Metadata of the destination","h":"/reference/api/typescript/aspire.hosting.yarp/withmetadata-aspire-hosting-yarp-yarproute-dict-string-string/","v":"13.4.0"},{"n":"withOrder","f":"withOrder(order: number): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the order for the destination","h":"/reference/api/typescript/aspire.hosting.yarp/withorder/","v":"13.4.0"},{"n":"withSessionAffinityConfig","f":"withSessionAffinityConfig(config: YarpSessionAffinityConfig): YarpCluster","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the session affinity configuration for the cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/withsessionaffinityconfig/","v":"13.4.0"},{"n":"withStaticFiles","f":"withStaticFiles(sourcePath?: string): YarpResource","k":"method","p":"Aspire.Hosting.Yarp","s":"Enables static file serving in the YARP resource.","h":"/reference/api/typescript/aspire.hosting.yarp/withstaticfiles/","v":"13.4.0"},{"n":"withTransform","f":"withTransform(transform: Dict): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Add a new transform to the destination.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransform/","v":"13.4.0"},{"n":"withTransformClientCertHeader","f":"withTransformClientCertHeader(headerName: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will set the given header with the Base64 encoded client certificate.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformclientcertheader/","v":"13.4.0"},{"n":"withTransformCopyRequestHeaders","f":"withTransformCopyRequestHeaders(copy?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will enable or suppress copying request headers to the proxy request.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformcopyrequestheaders/","v":"13.4.0"},{"n":"withTransformCopyResponseHeaders","f":"withTransformCopyResponseHeaders(copy?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will enable or suppress copying response headers to the client response.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformcopyresponseheaders/","v":"13.4.0"},{"n":"withTransformCopyResponseTrailers","f":"withTransformCopyResponseTrailers(copy?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will enable or suppress copying response trailers to the client response.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformcopyresponsetrailers/","v":"13.4.0"},{"n":"withTransformForwarded","f":"withTransformForwarded(useHost?: boolean, useProto?: boolean, forFormat?: NodeFormat, byFormat?: NodeFormat, action?: ForwardedTransformActions): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will add the Forwarded header as defined by [RFC 7239](https://tools.ietf.org/html/rfc7239).","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformforwarded/","v":"13.4.0"},{"n":"withTransformHttpMethodChange","f":"withTransformHttpMethodChange(fromHttpMethod: string, toHttpMethod: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform that will replace the HTTP method if it matches.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformhttpmethodchange/","v":"13.4.0"},{"n":"withTransformPathPrefix","f":"withTransformPathPrefix(prefix: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will prefix the request path with the given value.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformpathprefix/","v":"13.4.0"},{"n":"withTransformPathRemovePrefix","f":"withTransformPathRemovePrefix(prefix: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will remove the matching prefix from the request path.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformpathremoveprefix/","v":"13.4.0"},{"n":"withTransformPathRouteValues","f":"withTransformPathRouteValues(pattern: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will set the request path with route values.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformpathroutevalues/","v":"13.4.0"},{"n":"withTransformPathSet","f":"withTransformPathSet(path: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which sets the request path with the given value.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformpathset/","v":"13.4.0"},{"n":"withTransformQueryRemoveKey","f":"withTransformQueryRemoveKey(queryKey: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform that will remove the given query key.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformqueryremovekey/","v":"13.4.0"},{"n":"withTransformQueryRouteValue","f":"withTransformQueryRouteValue(queryKey: string, routeValueKey: string, append?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform that will append or set the query parameter from a route value.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformqueryroutevalue/","v":"13.4.0"},{"n":"withTransformQueryValue","f":"withTransformQueryValue(queryKey: string, value: string, append?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform that will append or set the query parameter from the given value.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformqueryvalue/","v":"13.4.0"},{"n":"withTransformRequestHeader","f":"withTransformRequestHeader(headerName: string, value: string, append?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will append or set the request header.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformrequestheader/","v":"13.4.0"},{"n":"withTransformRequestHeaderRemove","f":"withTransformRequestHeaderRemove(headerName: string): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will remove the request header.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformrequestheaderremove/","v":"13.4.0"},{"n":"withTransformRequestHeaderRouteValue","f":"withTransformRequestHeaderRouteValue(headerName: string, routeValueKey: string, append?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will append or set the request header from a route value.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformrequestheaderroutevalue/","v":"13.4.0"},{"n":"withTransformRequestHeadersAllowed","f":"withTransformRequestHeadersAllowed(allowedHeaders: string[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will only copy the allowed request headers. Other transforms that modify or append to existing headers may be affected if not included in the allow list.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformrequestheadersallowed/","v":"13.4.0"},{"n":"withTransformResponseHeader","f":"withTransformResponseHeader(headerName: string, value: string, append?: boolean, condition?: ResponseCondition): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will append or set the response header.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformresponseheader/","v":"13.4.0"},{"n":"withTransformResponseHeaderRemove","f":"withTransformResponseHeaderRemove(headerName: string, condition?: ResponseCondition): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will remove the response header.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformresponseheaderremove/","v":"13.4.0"},{"n":"withTransformResponseHeadersAllowed","f":"withTransformResponseHeadersAllowed(allowedHeaders: string[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will only copy the allowed response headers. Other transforms that modify or append to existing headers may be affected if not included in the allow list.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformresponseheadersallowed/","v":"13.4.0"},{"n":"withTransformResponseTrailer","f":"withTransformResponseTrailer(headerName: string, value: string, append?: boolean, condition?: ResponseCondition): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will append or set the response trailer.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformresponsetrailer/","v":"13.4.0"},{"n":"withTransformResponseTrailerRemove","f":"withTransformResponseTrailerRemove(headerName: string, condition?: ResponseCondition): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will remove the response trailer.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformresponsetrailerremove/","v":"13.4.0"},{"n":"withTransformResponseTrailersAllowed","f":"withTransformResponseTrailersAllowed(allowedHeaders: string[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will only copy the allowed response trailers. Other transforms that modify or append to existing trailers may be affected if not included in the allow list.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformresponsetrailersallowed/","v":"13.4.0"},{"n":"withTransforms","f":"withTransforms(transforms: Dict[]): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Set the Transforms of the destination","h":"/reference/api/typescript/aspire.hosting.yarp/withtransforms/","v":"13.4.0"},{"n":"withTransformUseOriginalHostHeader","f":"withTransformUseOriginalHostHeader(useOriginal?: boolean): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will copy the incoming request Host header to the proxy request.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformuseoriginalhostheader/","v":"13.4.0"},{"n":"withTransformXForwarded","f":"withTransformXForwarded(headerPrefix?: string, xDefault?: ForwardedTransformActions, xFor?: ForwardedTransformActions, xHost?: ForwardedTransformActions, xProto?: ForwardedTransformActions, xPrefix?: ForwardedTransformActions): YarpRoute","k":"method","p":"Aspire.Hosting.Yarp","s":"Adds the transform which will add X-Forwarded-* headers.","h":"/reference/api/typescript/aspire.hosting.yarp/withtransformxforwarded/","v":"13.4.0"},{"n":"IYarpConfigurationBuilder","f":"Aspire.Hosting.IYarpConfigurationBuilder","k":"interface","p":"Aspire.Hosting.Yarp","s":"Interface to build a configuration file for YARP","h":"/reference/api/typescript/aspire.hosting.yarp/iyarpconfigurationbuilder/","v":"13.4.0"},{"n":"YarpCluster","f":"Aspire.Hosting.Yarp.YarpCluster","k":"handle","p":"Aspire.Hosting.Yarp","s":"Represents a cluster for YARP routes","h":"/reference/api/typescript/aspire.hosting.yarp/yarpcluster/","v":"13.4.0"},{"n":"YarpResource","f":"Aspire.Hosting.Yarp.YarpResource","k":"handle","p":"Aspire.Hosting.Yarp","s":"Handle type","h":"/reference/api/typescript/aspire.hosting.yarp/yarpresource/","v":"13.4.0"},{"n":"YarpRoute","f":"Aspire.Hosting.Yarp.YarpRoute","k":"handle","p":"Aspire.Hosting.Yarp","s":"Represents a route for YARP","h":"/reference/api/typescript/aspire.hosting.yarp/yarproute/","v":"13.4.0"},{"n":"YarpActiveHealthCheckConfig","f":"Aspire.Hosting.Yarp.YarpActiveHealthCheckConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents active health check configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarpactivehealthcheckconfig/","v":"13.4.0"},{"n":"YarpForwarderRequestConfig","f":"Aspire.Hosting.Yarp.YarpForwarderRequestConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents forwarder request configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarpforwarderrequestconfig/","v":"13.4.0"},{"n":"YarpHealthCheckConfig","f":"Aspire.Hosting.Yarp.YarpHealthCheckConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents health check configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarphealthcheckconfig/","v":"13.4.0"},{"n":"YarpHttpClientConfig","f":"Aspire.Hosting.Yarp.YarpHttpClientConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents HTTP client configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarphttpclientconfig/","v":"13.4.0"},{"n":"YarpPassiveHealthCheckConfig","f":"Aspire.Hosting.Yarp.YarpPassiveHealthCheckConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents passive health check configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarppassivehealthcheckconfig/","v":"13.4.0"},{"n":"YarpRouteHeaderMatch","f":"Aspire.Hosting.Yarp.YarpRouteHeaderMatch","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents a header-based route match for a YARP route.","h":"/reference/api/typescript/aspire.hosting.yarp/yarprouteheadermatch/","v":"13.4.0"},{"n":"YarpRouteMatch","f":"Aspire.Hosting.Yarp.YarpRouteMatch","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents route match criteria for a YARP route.","h":"/reference/api/typescript/aspire.hosting.yarp/yarproutematch/","v":"13.4.0"},{"n":"YarpRouteQueryParameterMatch","f":"Aspire.Hosting.Yarp.YarpRouteQueryParameterMatch","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents a query-parameter-based route match for a YARP route.","h":"/reference/api/typescript/aspire.hosting.yarp/yarproutequeryparametermatch/","v":"13.4.0"},{"n":"YarpSessionAffinityConfig","f":"Aspire.Hosting.Yarp.YarpSessionAffinityConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents session affinity configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarpsessionaffinityconfig/","v":"13.4.0"},{"n":"YarpSessionAffinityCookieConfig","f":"Aspire.Hosting.Yarp.YarpSessionAffinityCookieConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents session affinity cookie configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarpsessionaffinitycookieconfig/","v":"13.4.0"},{"n":"YarpWebProxyConfig","f":"Aspire.Hosting.Yarp.YarpWebProxyConfig","k":"type","p":"Aspire.Hosting.Yarp","s":"Represents web proxy configuration for a YARP cluster.","h":"/reference/api/typescript/aspire.hosting.yarp/yarpwebproxyconfig/","v":"13.4.0"},{"n":"YarpSslProtocol","f":"Aspire.Hosting.Yarp.YarpSslProtocol","k":"enum","p":"Aspire.Hosting.Yarp","s":"Specifies the SSL protocols to enable for a YARP cluster. This enum exists because `SslProtocols` includes obsolete members and values that YARP does not accept.","h":"/reference/api/typescript/aspire.hosting.yarp/yarpsslprotocol/","v":"13.4.0"},{"n":"addActiveMQ","f":"addActiveMQ(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number, scheme?: string, webPort?: number): ActiveMQServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Adds a ActiveMQ container to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/addactivemq/","v":"13.4.0"},{"n":"addActiveMQArtemis","f":"addActiveMQArtemis(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number, scheme?: string, webPort?: number): ActiveMQArtemisServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Adds a ActiveMQ Artemis container to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/addactivemqartemis/","v":"13.4.0"},{"n":"withConfBindMount","f":"withConfBindMount(source: string, isReadOnly?: boolean): ActiveMQServerResourceBase","k":"method","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Adds a bind mount for the conf folder to a ActiveMQ container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/withconfbindmount/","v":"13.4.0"},{"n":"withConfVolume","f":"withConfVolume(name?: string, isReadOnly?: boolean): ActiveMQServerResourceBase","k":"method","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Adds a named volume for the config folder to a ActiveMQ container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/withconfvolume/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): ActiveMQServerResourceBase","k":"method","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Adds a bind mount for the data folder to a ActiveMQ container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): ActiveMQServerResourceBase","k":"method","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Adds a named volume for the data folder to a ActiveMQ container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/withdatavolume/","v":"13.4.0"},{"n":"ActiveMQArtemisServerResource","f":"Aspire.Hosting.ApplicationModel.ActiveMQArtemisServerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqartemisserverresource/","v":"13.4.0"},{"n":"ActiveMQServerResource","f":"Aspire.Hosting.ApplicationModel.ActiveMQServerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresource/","v":"13.4.0"},{"n":"ActiveMQServerResourceBase","f":"Aspire.Hosting.ApplicationModel.ActiveMQServerResourceBase","k":"handle","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Base class form ActiveMQ Classic and Artemis server resources.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/","v":"13.4.0"},{"n":"connectionStringExpression","f":"ActiveMQServerResourceBase.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the ConnectionStringExpression property","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"ActiveMQServerResourceBase.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the host endpoint reference for this resource.","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"ActiveMQServerResourceBase.passwordParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the parameter that contains the ActiveMQ server password.","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"ActiveMQServerResourceBase.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the port endpoint reference for this resource.","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"ActiveMQServerResourceBase.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the primary endpoint for the ActiveMQ server.","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"ActiveMQServerResourceBase.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the connection URI expression for the ActiveMQ server.","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameParameter","f":"ActiveMQServerResourceBase.userNameParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.ActiveMQ","s":"Gets the parameter that contains the ActiveMQ server username.","t":"ActiveMQServerResourceBase","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.activemq/activemqserverresourcebase/#usernameparameter","m":true,"v":"13.4.0"},{"n":"addAdminer","f":"addAdminer(name: string, port?: number): AdminerContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Adminer","s":"Adds a Adminer container resource to the application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.adminer/addadminer/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): AdminerContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Adminer","s":"Configures the host port that the Adminer resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.adminer/withhostport/","v":"13.4.0"},{"n":"AdminerContainerResource","f":"Aspire.Hosting.ApplicationModel.AdminerContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Adminer","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.adminer/adminercontainerresource/","v":"13.4.0"},{"n":"addDataAPIBuilder","f":"addDataAPIBuilder(name: string, configFilePaths?: string[], httpPort?: number): DataApiBuilderContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder","s":"Adds a DataAPIBuilder application to the application model. Executes the pre-built containerized DataAPIBuilder engine.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.dataapibuilder/adddataapibuilder/","v":"13.4.0"},{"n":"DataApiBuilderContainerResource","f":"Aspire.Hosting.ApplicationModel.DataApiBuilderContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder","s":"A resource that represents Data Api Builder.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.dataapibuilder/dataapibuildercontainerresource/","v":"13.4.0"},{"n":"host","f":"DataApiBuilderContainerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder","s":"Gets the host endpoint reference for this resource.","t":"DataApiBuilderContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.dataapibuilder/dataapibuildercontainerresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"DataApiBuilderContainerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder","s":"Gets the port endpoint reference for this resource.","t":"DataApiBuilderContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.dataapibuilder/dataapibuildercontainerresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"DataApiBuilderContainerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder","s":"Gets the primary HTTP endpoint for the Data API Builder resource.","t":"DataApiBuilderContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.dataapibuilder/dataapibuildercontainerresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"DataApiBuilderContainerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder","s":"Gets the HTTP URI expression for the Data API Builder resource.","t":"DataApiBuilderContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.dataapibuilder/dataapibuildercontainerresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"withAzureStorageExplorer","f":"withAzureStorageExplorer(configureContainer?: (obj: AzureStorageExplorerResource) => Promise, name?: string): AzureBlobStorageResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Adds an Azure Storage Explorer instance to a Blob storage resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/withazurestorageexplorer-aspire-hosting-azure-azureblobstorageresource-obj-azurestorageexplorerresource-promise-void-string/","v":"13.4.0"},{"n":"withAzureStorageExplorer","f":"withAzureStorageExplorer(configureContainer?: (obj: AzureStorageExplorerResource) => Promise, name?: string): AzureQueueStorageResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Adds an Azure Storage Explorer instance to a Queue storage resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/withazurestorageexplorer-aspire-hosting-azure-azurequeuestorageresource-obj-azurestorageexplorerresource-promise-void-string/","v":"13.4.0"},{"n":"withAzureStorageExplorer","f":"withAzureStorageExplorer(configureContainer?: (obj: AzureStorageExplorerResource) => Promise, name?: string): AzureTableStorageResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Adds an Azure Storage Explorer instance to a Table storage resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/withazurestorageexplorer-aspire-hosting-azure-azuretablestorageresource-obj-azurestorageexplorerresource-promise-void-string/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): AzureStorageExplorerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Configures the host port that the Azure Storage Explorer resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/withhostport/","v":"13.4.0"},{"n":"AzureStorageExplorerResource","f":"Aspire.Hosting.ApplicationModel.AzureStorageExplorerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"A resource that represents an Azure Storage Explorer container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/azurestorageexplorerresource/","v":"13.4.0"},{"n":"host","f":"AzureStorageExplorerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Gets the host endpoint reference for this resource.","t":"AzureStorageExplorerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/azurestorageexplorerresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"AzureStorageExplorerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Gets the port endpoint reference for this resource.","t":"AzureStorageExplorerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/azurestorageexplorerresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"AzureStorageExplorerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Azure.Extensions","s":"Gets the primary endpoint for the Azure Storage Explorer instance.","t":"AzureStorageExplorerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.azure.extensions/azurestorageexplorerresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"addDbGate","f":"addDbGate(name?: string, port?: number): DbGateContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.DbGate","s":"Adds a DbGate container resource to the application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.dbgate/adddbgate/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): DbGateContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.DbGate","s":"Adds a bind mount for the data folder to a DbGate container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.dbgate/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): DbGateContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.DbGate","s":"Adds a named volume for the data folder to a DbGate container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.dbgate/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): DbGateContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.DbGate","s":"Configures the host port that the DbGate resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.dbgate/withhostport/","v":"13.4.0"},{"n":"DbGateContainerResource","f":"Aspire.Hosting.ApplicationModel.DbGateContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.DbGate","s":"Represents a container resource for DbGate.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.dbgate/dbgatecontainerresource/","v":"13.4.0"},{"n":"primaryEndpoint","f":"DbGateContainerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.DbGate","s":"Gets the primary endpoint for the DbGate.","t":"DbGateContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.dbgate/dbgatecontainerresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"addDenoApp","f":"addDenoApp(name: string, scriptPath: string, workingDirectory?: string, permissionFlags?: string[], args?: string[]): DenoAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Deno","s":"Adds a Deno application to the application model. Deno should available on the PATH.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.deno/adddenoapp/","v":"13.4.0"},{"n":"addDenoTask","f":"addDenoTask(name: string, workingDirectory?: string, taskName?: string, args?: string[]): DenoAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Deno","s":"Adds a Deno task to the distributed application builder","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.deno/adddenotask/","v":"13.4.0"},{"n":"withDenoPackageInstallation","f":"withDenoPackageInstallation(): DenoAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Deno","s":"Ensures the Deno packages are installed before the application starts using Deno as the package manager.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.deno/withdenopackageinstallation/","v":"13.4.0"},{"n":"DenoAppResource","f":"Aspire.Hosting.ApplicationModel.DenoAppResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Deno","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.deno/denoappresource/","v":"13.4.0"},{"n":"withElasticvue","f":"withElasticvue(configureContainer?: (obj: ElasticvueContainerResource) => Promise, containerName?: string): ElasticsearchResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Elasticsearch.Extensions","s":"Adds an administration and development platform for Elasticsearch to the application model using Elasticvue.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.elasticsearch.extensions/withelasticvue/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): ElasticvueContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Elasticsearch.Extensions","s":"Configures the host port that the Elasticvue resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.elasticsearch.extensions/withhostport/","v":"13.4.0"},{"n":"ElasticvueContainerResource","f":"Aspire.Hosting.ApplicationModel.ElasticvueContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Elasticsearch.Extensions","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.elasticsearch.extensions/elasticvuecontainerresource/","v":"13.4.0"},{"n":"addFlagd","f":"addFlagd(name: string, port?: number, ofrepPort?: number): FlagdResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Adds a flagd container to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/addflagd/","v":"13.4.0"},{"n":"withBindFileSync","f":"withBindFileSync(fileSource: string, filename?: string): FlagdResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Configures flagd to use a bind mount as the source of flags.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/withbindfilesync/","v":"13.4.0"},{"n":"FlagdResource","f":"Aspire.Hosting.ApplicationModel.FlagdResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"A resource that represents a flagd container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"FlagdResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the connection string expression for the flagd server.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"healthCheckEndpoint","f":"FlagdResource.healthCheckEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the health check HTTP endpoint for the flagd server.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#healthcheckendpoint","m":true,"v":"13.4.0"},{"n":"host","f":"FlagdResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the host endpoint reference for this resource.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#host","m":true,"v":"13.4.0"},{"n":"ofrepEndpoint","f":"FlagdResource.ofrepEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the OFREP endpoint for the flagd server.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#ofrependpoint","m":true,"v":"13.4.0"},{"n":"port","f":"FlagdResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the port endpoint reference for this resource.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"FlagdResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the primary HTTP endpoint for the flagd server.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"FlagdResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Flagd","s":"Gets the connection URI expression for the flagd server.","t":"FlagdResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flagd/flagdresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addFlyway","f":"addFlyway(name: string, migrationScriptsPath: string): FlywayResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Flyway","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flyway/addflyway/","v":"13.4.0"},{"n":"withTelemetryOptIn","f":"withTelemetryOptIn(): FlywayResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Flyway","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flyway/withtelemetryoptin/","v":"13.4.0"},{"n":"FlywayResource","f":"Aspire.Hosting.ApplicationModel.FlywayResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Flyway","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.flyway/flywayresource/","v":"13.4.0"},{"n":"addGoFeatureFlag","f":"addGoFeatureFlag(name: string, pathToConfigFile?: string, port?: number): GoFeatureFlagResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Adds an GO Feature Flag container resource to the application model. The default image is and the tag is .","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/addgofeatureflag/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): GoFeatureFlagResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Adds a named volume for the data folder to a GO Feature flag container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/withdatavolume/","v":"13.4.0"},{"n":"withGoffBindMount","f":"withGoffBindMount(source: string): GoFeatureFlagResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Adds a bind mount for the goff configuration folder to a GO Feature flag container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/withgoffbindmount/","v":"13.4.0"},{"n":"withLogLevel","f":"withLogLevel(logLevel: GoFeatureFlagLogLevel): GoFeatureFlagResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/withloglevel/","v":"13.4.0"},{"n":"GoFeatureFlagResource","f":"Aspire.Hosting.ApplicationModel.GoFeatureFlagResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"A resource that represents a GO Feature Flag instance","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"GoFeatureFlagResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Gets the connection string expression for the GO Feature Flag instance.","t":"GoFeatureFlagResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"GoFeatureFlagResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Gets the host endpoint reference for this resource.","t":"GoFeatureFlagResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"GoFeatureFlagResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Gets the port endpoint reference for this resource.","t":"GoFeatureFlagResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"GoFeatureFlagResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Gets the primary endpoint for the GO Feature Flag instance. This endpoint is used for all API calls over HTTP.","t":"GoFeatureFlagResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"GoFeatureFlagResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Gets the connection URI expression for the GO Feature Flag instance.","t":"GoFeatureFlagResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"GoFeatureFlagLogLevel","f":"Aspire.Hosting.GoFeatureFlagLogLevel","k":"enum","p":"CommunityToolkit.Aspire.Hosting.GoFeatureFlag","s":"Enum: Debug, Information, Warning, Error","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.gofeatureflag/gofeatureflagloglevel/","v":"13.4.0"},{"n":"addJavaApp","f":"addJavaApp(name: string, workingDirectory: string): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Adds a Java application to the application model. Executes the executable Java app.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/addjavaapp/","v":"13.4.0"},{"n":"addJavaAppWithJar","f":"addJavaAppWithJar(name: string, workingDirectory: string, jarPath: string, args?: string[]): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Adds a Java application to the application model. Executes the executable Java app.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/addjavaappwithjar/","v":"13.4.0"},{"n":"addJavaContainerApp","f":"addJavaContainerApp(name: string, image: string, imageTag?: string): JavaAppContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Adds a Java application to the application model. Executes the containerized Java app.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/addjavacontainerapp/","v":"13.4.0"},{"n":"withGradleBuild","f":"withGradleBuild(args: string[]): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Adds a Gradle build step to the Java application","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withgradlebuild/","v":"13.4.0"},{"n":"withGradleTask","f":"withGradleTask(task: string, args: string[]): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Configures the Java application to run using a Gradle task","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withgradletask/","v":"13.4.0"},{"n":"withJvmArgs","f":"withJvmArgs(args: string[]): IResourceWithEnvironment","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Configures the Java Virtual Machine arguments for the Java application. The arguments are set via the `JAVA_TOOL_OPTIONS` environment variable, which is recognized by the JVM regardless of how the application is launched (e.g., `java -jar`, Maven wrapper, or Gradle wrapper).","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withjvmargs/","v":"13.4.0"},{"n":"withMavenBuild","f":"withMavenBuild(args: string[]): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Adds a Maven build step to the Java application","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withmavenbuild/","v":"13.4.0"},{"n":"withMavenGoal","f":"withMavenGoal(goal: string, args: string[]): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Configures the Java application to run using a Maven goal","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withmavengoal/","v":"13.4.0"},{"n":"withOtelAgent","f":"withOtelAgent(agentPath?: string): IResourceWithEnvironment","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Configures the OpenTelemetry Java Agent for the Java application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withotelagent/","v":"13.4.0"},{"n":"withWrapperPath","f":"withWrapperPath(wrapperScript: string): JavaAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Configures a custom build tool wrapper script path. This is useful when the wrapper script is not in the default location or has a non-standard name.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/withwrapperpath/","v":"13.4.0"},{"n":"JavaAppContainerResource","f":"Aspire.Hosting.ApplicationModel.JavaAppContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Java","s":"A resource that represents a Java application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/javaappcontainerresource/","v":"13.4.0"},{"n":"JavaAppExecutableResource","f":"Aspire.Hosting.ApplicationModel.JavaAppExecutableResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Java","s":"A resource that represents a Java application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/javaappexecutableresource/","v":"13.4.0"},{"n":"jarPath","f":"JavaAppExecutableResource.jarPath(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.Java","s":"Gets or sets the path to the JAR file to execute.","t":"JavaAppExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.java/javaappexecutableresource/#jarpath","m":true,"v":"13.4.0"},{"n":"addApp","f":"addApp(name: string, appName?: string): NxAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/addapp-aspire-hosting-applicationmodel-nxresource-string-string/","v":"13.4.0"},{"n":"addApp","f":"addApp(name: string, filter?: string): TurborepoAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/addapp-aspire-hosting-applicationmodel-turboreporesource-string-string/","v":"13.4.0"},{"n":"addNxApp","f":"addNxApp(name: string, workingDirectory?: string): NxResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Adds an Nx monorepo workspace to the distributed application builder.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/addnxapp/","v":"13.4.0"},{"n":"addTurborepoApp","f":"addTurborepoApp(name: string, workingDirectory?: string): TurborepoResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Adds a Turborepo monorepo workspace to the distributed application builder.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/addturborepoapp/","v":"13.4.0"},{"n":"withBun","f":"withBun(install?: boolean): NxResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withbun-aspire-hosting-applicationmodel-nxresource-boolean/","v":"13.4.0"},{"n":"withBun","f":"withBun(install?: boolean): TurborepoResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withbun-aspire-hosting-applicationmodel-turboreporesource-boolean/","v":"13.4.0"},{"n":"withMappedEndpointPort","f":"withMappedEndpointPort(endpointName?: string): JavaScriptAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Maps the endpoint port for the JavaScript app resource to the appropriate command line argument","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withmappedendpointport/","v":"13.4.0"},{"n":"withNpm","f":"withNpm(install?: boolean): NxResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withnpm-aspire-hosting-applicationmodel-nxresource-boolean/","v":"13.4.0"},{"n":"withNpm","f":"withNpm(install?: boolean): TurborepoResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withnpm-aspire-hosting-applicationmodel-turboreporesource-boolean/","v":"13.4.0"},{"n":"withPackageManagerLaunch","f":"withPackageManagerLaunch(packageManager?: string): NxResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Configures the Nx workspace to use the specified JavaScript package manager when starting apps.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withpackagemanagerlaunch-aspire-hosting-applicationmodel-nxresource-string/","v":"13.4.0"},{"n":"withPackageManagerLaunch","f":"withPackageManagerLaunch(packageManager?: string): TurborepoResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Configures the Turborepo workspace to use the specified JavaScript package manager when starting apps.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withpackagemanagerlaunch-aspire-hosting-applicationmodel-turboreporesource-string/","v":"13.4.0"},{"n":"withPnpm","f":"withPnpm(install?: boolean): NxResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withpnpm-aspire-hosting-applicationmodel-nxresource-boolean/","v":"13.4.0"},{"n":"withPnpm","f":"withPnpm(install?: boolean): TurborepoResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withpnpm-aspire-hosting-applicationmodel-turboreporesource-boolean/","v":"13.4.0"},{"n":"withYarn","f":"withYarn(install?: boolean): NxResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withyarn-aspire-hosting-applicationmodel-nxresource-boolean/","v":"13.4.0"},{"n":"withYarn","f":"withYarn(install?: boolean): TurborepoResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/withyarn-aspire-hosting-applicationmodel-turboreporesource-boolean/","v":"13.4.0"},{"n":"NxAppResource","f":"Aspire.Hosting.ApplicationModel.NxAppResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/nxappresource/","v":"13.4.0"},{"n":"NxResource","f":"Aspire.Hosting.ApplicationModel.NxResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/nxresource/","v":"13.4.0"},{"n":"TurborepoAppResource","f":"Aspire.Hosting.ApplicationModel.TurborepoAppResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/turborepoappresource/","v":"13.4.0"},{"n":"TurborepoResource","f":"Aspire.Hosting.ApplicationModel.TurborepoResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.JavaScript.Extensions","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.javascript.extensions/turboreporesource/","v":"13.4.0"},{"n":"addK6","f":"addK6(name: string, enableBrowserExtensions?: boolean, port?: number): K6Resource","k":"method","p":"CommunityToolkit.Aspire.Hosting.k6","s":"Adds a Grafana k6 container resource to the application model. The default image is and the tag is .","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.k6/addk6/","v":"13.4.0"},{"n":"withK6OtlpEnvironment","f":"withK6OtlpEnvironment(): K6Resource","k":"method","p":"CommunityToolkit.Aspire.Hosting.k6","s":"Set K6 environment variables from the existing OTEL environment set for this resource. See https://grafana.com/docs/k6/latest/results-output/real-time/opentelemetry/#configuration.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.k6/withk6otlpenvironment/","v":"13.4.0"},{"n":"withScript","f":"withScript(scriptPath: string, virtualUsers?: number, duration?: string): K6Resource","k":"method","p":"CommunityToolkit.Aspire.Hosting.k6","s":"Runs a k6 JS script when starting the Grafana k6 container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.k6/withscript/","v":"13.4.0"},{"n":"K6Resource","f":"Aspire.Hosting.ApplicationModel.K6Resource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.k6","s":"A resource that represents a Grafana k6 instance","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.k6/k6resource/","v":"13.4.0"},{"n":"primaryEndpoint","f":"K6Resource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.k6","s":"Gets the primary endpoint for the Grafana k6 instance. This endpoint is used for all API calls over HTTP.","t":"K6Resource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.k6/k6resource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"withPostgres","f":"withPostgres(database: PostgresDatabaseResource, username?: ParameterResource, password?: ParameterResource, xaEnabled?: boolean): KeycloakResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Keycloak.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.keycloak.extensions/withpostgres/","v":"13.4.0-preview.1.260602-0230"},{"n":"addKurrentDB","f":"addKurrentDB(name: string, port?: number): KurrentDBResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Adds a KurrentDB resource to the application model. A container is used for local development. The default image is and the tag is .","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/addkurrentdb/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): KurrentDBResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Adds a bind mount for the data folder to a KurrentDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): KurrentDBResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Adds a named volume for the data folder to a KurrentDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/withdatavolume/","v":"13.4.0"},{"n":"KurrentDBResource","f":"Aspire.Hosting.ApplicationModel.KurrentDBResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"A resource that represents a KurrentDB container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/kurrentdbresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"KurrentDBResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Gets the connection string for the KurrentDB server.","t":"KurrentDBResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/kurrentdbresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"KurrentDBResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Gets the host endpoint reference for this resource.","t":"KurrentDBResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/kurrentdbresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"KurrentDBResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Gets the port endpoint reference for this resource.","t":"KurrentDBResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/kurrentdbresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"KurrentDBResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Gets the primary endpoint for the KurrentDB server.","t":"KurrentDBResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/kurrentdbresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"KurrentDBResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.KurrentDB","s":"Gets the connection URI expression for the KurrentDB server.","t":"KurrentDBResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.kurrentdb/kurrentdbresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addLavinMQ","f":"addLavinMQ(name: string, amqpPort?: number, managementPort?: number): LavinMQContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Adds a LavinMQ container resource to the distributed application builder. Configures the resource with specified parameters and sets up health checks for the resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/addlavinmq/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): LavinMQContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Configures a bind mount for the LavinMQ container resource to allow data persistence. The method mounts a specified source path on the host to the container's data directory.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name: string, isReadOnly?: boolean): LavinMQContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Configures a data volume for the LavinMQ container resource by specifying its name and read-only status.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/withdatavolume/","v":"13.4.0"},{"n":"LavinMQContainerResource","f":"Aspire.Hosting.ApplicationModel.LavinMQContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Represents a container resource for LavinMQ with configurable authentication parameters and connection endpoint details, implementing the IResourceWithConnectionString interface.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/lavinmqcontainerresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"LavinMQContainerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"ConnectionString for the LavinMQ server in the form of amqp://guest:guest@host:port/.","t":"LavinMQContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/lavinmqcontainerresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"LavinMQContainerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Gets the host endpoint reference for this resource.","t":"LavinMQContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/lavinmqcontainerresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"LavinMQContainerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Gets the port endpoint reference for this resource.","t":"LavinMQContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/lavinmqcontainerresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"LavinMQContainerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Gets the primary AMQP endpoint for the LavinMQ resource.","t":"LavinMQContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/lavinmqcontainerresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"LavinMQContainerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.LavinMQ","s":"Gets the connection URI expression for the LavinMQ server.","t":"LavinMQContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.lavinmq/lavinmqcontainerresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addMailPit","f":"addMailPit(name: string, httpPort?: number, smtpPort?: number): MailPitContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Adds a MailPit container resource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/addmailpit/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): MailPitContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Configures a bind mount for the data directory of the MailPit container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name: string, isReadOnly?: boolean): MailPitContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Configures a data volume for the MailPit container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/withdatavolume/","v":"13.4.0"},{"n":"MailPitContainerResource","f":"Aspire.Hosting.ApplicationModel.MailPitContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Resource for the MailPit server.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/mailpitcontainerresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MailPitContainerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"ConnectionString for MailPit smtp endpoint in the form of smtp://host:port.","t":"MailPitContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/mailpitcontainerresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"MailPitContainerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Gets the host endpoint reference for the SMTP endpoint.","t":"MailPitContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/mailpitcontainerresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"MailPitContainerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Gets the port endpoint reference for the SMTP endpoint.","t":"MailPitContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/mailpitcontainerresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"MailPitContainerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Gets the primary SMTP endpoint for the MailPit server.","t":"MailPitContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/mailpitcontainerresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MailPitContainerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.MailPit","s":"Gets the connection URI expression for the MailPit SMTP endpoint.","t":"MailPitContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mailpit/mailpitcontainerresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addMcpInspector","f":"addMcpInspector(name: string, clientPort?: number, serverPort?: number, inspectorVersion?: string, proxyToken?: ParameterResource): McpInspectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Adds a MCP Inspector container resource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/addmcpinspector/","v":"13.4.0"},{"n":"withBun","f":"withBun(): McpInspectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Configures the MCP Inspector to use bun as the package manager.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/withbun/","v":"13.4.0"},{"n":"withInspectedMcpServer","f":"withInspectedMcpServer(mcpServer: IResourceWithEndpoints, isDefault?: boolean, transportType?: McpTransportType, path?: string): McpInspectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Configures the MCP Inspector resource to use a specified MCP server resource that uses SSE as the transport type.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/withinspectedmcpserver/","v":"13.4.0"},{"n":"withPnpm","f":"withPnpm(): McpInspectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Configures the MCP Inspector to use pnpm as the package manager.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/withpnpm/","v":"13.4.0"},{"n":"withYarn","f":"withYarn(): McpInspectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Configures the MCP Inspector to use yarn as the package manager.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/withyarn/","v":"13.4.0"},{"n":"McpInspectorResource","f":"Aspire.Hosting.ApplicationModel.McpInspectorResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/mcpinspectorresource/","v":"13.4.0"},{"n":"McpTransportType","f":"Aspire.Hosting.McpTransportType","k":"enum","p":"CommunityToolkit.Aspire.Hosting.McpInspector","s":"Represents the type of transport used by the MCP server.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mcpinspector/mcptransporttype/","v":"13.4.0"},{"n":"addMeilisearch","f":"addMeilisearch(name: string, masterKey?: ParameterResource, port?: number): MeilisearchResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Adds an Meilisearch container resource to the application model. The default image is and the tag is .","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/addmeilisearch/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): MeilisearchResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Adds a bind mount for the data folder to a Meilisearch container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): MeilisearchResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Adds a named volume for the data folder to a Meilisearch container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/withdatavolume/","v":"13.4.0"},{"n":"MeilisearchResource","f":"Aspire.Hosting.ApplicationModel.MeilisearchResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"A resource that represents a Meilisearch","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MeilisearchResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Gets the connection string expression for the Meilisearch","t":"MeilisearchResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"MeilisearchResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Gets the host endpoint reference for this resource.","t":"MeilisearchResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/#host","m":true,"v":"13.4.0"},{"n":"masterKeyParameter","f":"MeilisearchResource.masterKeyParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Gets the parameter that contains the Meilisearch superuser password.","t":"MeilisearchResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/#masterkeyparameter","m":true,"v":"13.4.0"},{"n":"port","f":"MeilisearchResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Gets the port endpoint reference for this resource.","t":"MeilisearchResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"MeilisearchResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Gets the primary endpoint for the Meilisearch. This endpoint is used for all API calls over HTTP.","t":"MeilisearchResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MeilisearchResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Meilisearch","s":"Gets the connection URI expression for the Meilisearch server.","t":"MeilisearchResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.meilisearch/meilisearchresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addMinioContainer","f":"addMinioContainer(name: string, rootUser?: ParameterResource, rootPassword?: ParameterResource, port?: number): MinioContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Adds a MinIO container to the application model. The default image is \"minio/minio\" and the tag is \"latest\".","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/addminiocontainer/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): MinioContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Adds a bind mount for the data folder to a MinIO container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): MinioContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Adds a named volume for the data folder to a MinIO container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/withdatavolume/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): MinioContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Configures the host port that the MinIO resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/withhostport/","v":"13.4.0"},{"n":"withPassword","f":"withPassword(password: ParameterResource): MinioContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Configures the password that the MinIO resource uses.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/withpassword/","v":"13.4.0"},{"n":"withUserName","f":"withUserName(userName: ParameterResource): MinioContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Configures the user name that the MinIO resource uses.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/withusername/","v":"13.4.0"},{"n":"MinioContainerResource","f":"Aspire.Hosting.ApplicationModel.MinioContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"A resource that represents a MinIO storage","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"MinioContainerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Gets the connection string expression for the Minio","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"MinioContainerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Gets the host endpoint reference for this resource.","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#host","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"MinioContainerResource.passwordParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"The MinIO root password.","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"MinioContainerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Gets the port endpoint reference for this resource.","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"MinioContainerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Gets the primary endpoint for the MinIO. This endpoint is used for all API calls over HTTP.","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"rootUser","f":"MinioContainerResource.rootUser(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"The MinIO root user.","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#rootuser","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"MinioContainerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Minio","s":"Gets the connection URI expression for the MinIO server.","t":"MinioContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.minio/miniocontainerresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"withDbGate","f":"withDbGate(containerName?: string): MongoDBServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.MongoDB.Extensions","s":"Adds an administration and development platform for MongoDB to the application model using DbGate.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mongodb.extensions/withdbgate/","v":"13.4.0"},{"n":"withAdminer","f":"withAdminer(configureContainer?: (obj: AdminerContainerResource) => Promise, containerName?: string): MySqlServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.MySql.Extensions","s":"Adds an administration and development platform for MySql to the application model using Adminer.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mysql.extensions/withadminer/","v":"13.4.0"},{"n":"withDbGate","f":"withDbGate(configureContainer?: (obj: DbGateContainerResource) => Promise, containerName?: string): MySqlServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.MySql.Extensions","s":"Adds an administration and development platform for MySql to the application model using DbGate.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.mysql.extensions/withdbgate/","v":"13.4.0"},{"n":"addNgrok","f":"addNgrok(name: string, configurationFolder?: string, endpointPort?: number, endpointName?: string, configurationVersion?: number): NgrokResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ngrok","s":"Configures a container resource for grok which is pre-configured to connect to the resource that this method is used on.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/addngrok/","v":"13.4.0"},{"n":"withAuthToken","f":"withAuthToken(ngrokAuthToken: ParameterResource): NgrokResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ngrok","s":"Adds a ngrok auth token to a ngrok resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/withauthtoken/","v":"13.4.0"},{"n":"withAuthTokenValue","f":"withAuthTokenValue(ngrokAuthToken: string): NgrokResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ngrok","s":"Adds a ngrok auth token to a ngrok resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/withauthtokenvalue/","v":"13.4.0"},{"n":"withTunnelEndpoint","f":"withTunnelEndpoint(resource: IResourceWithEndpoints, endpointName: string, ngrokUrl?: string, labels?: Dict): NgrokResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ngrok","s":"Configures a resource with endpoints as a ngrok tunnel endpoint.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/withtunnelendpoint/","v":"13.4.0"},{"n":"NgrokResource","f":"Aspire.Hosting.ApplicationModel.NgrokResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Ngrok","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ngrok/ngrokresource/","v":"13.4.0"},{"n":"addHuggingFaceModel","f":"addHuggingFaceModel(name: string, modelName: string): OllamaModelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds a model from Hugging Face to the Ollama resource. Only models in GGUF format are supported.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/addhuggingfacemodel/","v":"13.4.0"},{"n":"addModel","f":"addModel(modelName: string): OllamaModelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds a model to the Ollama resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/addmodel/","v":"13.4.0"},{"n":"addNamedModel","f":"addNamedModel(name: string, modelName: string): OllamaModelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds a model to the Ollama resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/addnamedmodel/","v":"13.4.0"},{"n":"addOllama","f":"addOllama(name: string, port?: number): OllamaResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds an Ollama container resource to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/addollama/","v":"13.4.0"},{"n":"addOllamaLocal","f":"addOllamaLocal(name: string, port?: number, targetPort?: number): OllamaExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds an Ollama executable resource to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/addollamalocal/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): OllamaResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds a data volume to the Ollama container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/withdatavolume-aspire-hosting-applicationmodel-ollamaresource-string-boolean/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): OpenWebUIResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds a data volume to the Open WebUI container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/withdatavolume-aspire-hosting-applicationmodel-openwebuiresource-string-boolean/","v":"13.4.0"},{"n":"withGPUSupport","f":"withGPUSupport(vendor?: OllamaGpuVendor): OllamaResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds GPU support to the Ollama container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/withgpusupport/","v":"13.4.0"},{"n":"withHostPort","f":"withHostPort(port: number): OpenWebUIResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Configures the host port that the Open WebUI resource is exposed on instead of using randomly assigned port.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/withhostport/","v":"13.4.0"},{"n":"withOpenWebUI","f":"withOpenWebUI(configureContainer?: (obj: OpenWebUIResource) => Promise, containerName?: string): IOllamaResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Adds an Open WebUI container to the application model for administering Ollama. This version of the package defaults to the main tag of the Open WebUI container image.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/withopenwebui/","v":"13.4.0"},{"n":"IOllamaResource","f":"Aspire.Hosting.ApplicationModel.IOllamaResource","k":"interface","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Represents an Ollama resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/iollamaresource/","v":"13.4.0"},{"n":"OllamaExecutableResource","f":"Aspire.Hosting.ApplicationModel.OllamaExecutableResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"A resource that represents an Ollama executable resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"OllamaExecutableResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the connection string expression for the Ollama server.","t":"OllamaExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"OllamaExecutableResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the Host property","t":"OllamaExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/#host","m":true,"v":"13.4.0"},{"n":"models","f":"OllamaExecutableResource.models(): string[]","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the Models property","t":"OllamaExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/#models","m":true,"v":"13.4.0"},{"n":"port","f":"OllamaExecutableResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the Port property","t":"OllamaExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"OllamaExecutableResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the PrimaryEndpoint property","t":"OllamaExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"OllamaExecutableResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the UriExpression property","t":"OllamaExecutableResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaexecutableresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"OllamaModelResource","f":"Aspire.Hosting.ApplicationModel.OllamaModelResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"A resource that represents an ollama model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamamodelresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"OllamaModelResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the connection string expression for the Ollama model.","t":"OllamaModelResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamamodelresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"modelName","f":"OllamaModelResource.modelName(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the model name.","t":"OllamaModelResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamamodelresource/#modelname","m":true,"v":"13.4.0"},{"n":"parent","f":"OllamaModelResource.parent(): IOllamaResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the parent Ollama resource.","t":"OllamaModelResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamamodelresource/#parent","m":true,"v":"13.4.0"},{"n":"OllamaResource","f":"Aspire.Hosting.ApplicationModel.OllamaResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"A resource that represents an Ollama container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"OllamaResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the connection string expression for the Ollama server.","t":"OllamaResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"OllamaResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the Host property","t":"OllamaResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/#host","m":true,"v":"13.4.0"},{"n":"models","f":"OllamaResource.models(): string[]","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the Models property","t":"OllamaResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/#models","m":true,"v":"13.4.0"},{"n":"port","f":"OllamaResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the Port property","t":"OllamaResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"OllamaResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the PrimaryEndpoint property","t":"OllamaResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"OllamaResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the UriExpression property","t":"OllamaResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamaresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"OpenWebUIResource","f":"Aspire.Hosting.ApplicationModel.OpenWebUIResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"A resource that represents an Open WebUI resource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"OpenWebUIResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the connection string expression for the Open WebUI endpoint.","t":"OpenWebUIResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"OpenWebUIResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the host endpoint reference for this resource.","t":"OpenWebUIResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/#host","m":true,"v":"13.4.0"},{"n":"ollamaResources","f":"OpenWebUIResource.ollamaResources(): IOllamaResource[]","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the list of Ollama resources that are associated with this Open WebUI resource.","t":"OpenWebUIResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/#ollamaresources","m":true,"v":"13.4.0"},{"n":"port","f":"OpenWebUIResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the port endpoint reference for this resource.","t":"OpenWebUIResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"OpenWebUIResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the http endpoint for the Open WebUI resource.","t":"OpenWebUIResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"OpenWebUIResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Gets the connection URI expression for the Open WebUI endpoint.","t":"OpenWebUIResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/openwebuiresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"OllamaGpuVendor","f":"Aspire.Hosting.OllamaGpuVendor","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Represents the GPU vendors supported by the application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamagpuvendor-aspire-hosting-ollamagpuvendor/","v":"13.4.0"},{"n":"OllamaGpuVendor","f":"Aspire.Hosting.OllamaGpuVendor","k":"enum","p":"CommunityToolkit.Aspire.Hosting.Ollama","s":"Represents the GPU vendors supported by the application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ollama/ollamagpuvendor-aspire-hosting-ollamagpuvendor-2/","v":"13.4.0"},{"n":"addOpenTelemetryCollector","f":"addOpenTelemetryCollector(name: string, configureSettings?: (obj: OpenTelemetryCollectorSettings) => Promise): OpenTelemetryCollectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Adds an OpenTelemetry Collector container resource to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/addopentelemetrycollector/","v":"13.4.0"},{"n":"withAppForwarding","f":"withAppForwarding(): OpenTelemetryCollectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Configures all compatible resources in the application to forward telemetry to this collector.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/withappforwarding/","v":"13.4.0"},{"n":"withConfig","f":"withConfig(configPath: string): OpenTelemetryCollectorResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Adds a configuration file to the collector resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/withconfig/","v":"13.4.0"},{"n":"withOpenTelemetryCollectorRouting","f":"withOpenTelemetryCollectorRouting(collectorBuilder: OpenTelemetryCollectorResource): IResourceWithEnvironment","k":"method","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Routes telemetry for the resource through the specified OpenTelemetry Collector.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/withopentelemetrycollectorrouting/","v":"13.4.0"},{"n":"OpenTelemetryCollectorResource","f":"Aspire.Hosting.OpenTelemetryCollectorResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Represents an OpenTelemetry Collector container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorresource/","v":"13.4.0"},{"n":"grpcEndpoint","f":"OpenTelemetryCollectorResource.grpcEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets the gRPC endpoint for the collector.","t":"OpenTelemetryCollectorResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorresource/#grpcendpoint","m":true,"v":"13.4.0"},{"n":"httpEndpoint","f":"OpenTelemetryCollectorResource.httpEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets the HTTP endpoint for the collector.","t":"OpenTelemetryCollectorResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorresource/#httpendpoint","m":true,"v":"13.4.0"},{"n":"OpenTelemetryCollectorSettings","f":"Aspire.Hosting.OpenTelemetryCollectorSettings","k":"handle","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Settings for configuring an OpenTelemetry Collector resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/","v":"13.4.0"},{"n":"collectorImage","f":"OpenTelemetryCollectorSettings.collectorImage(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets the full collector image reference.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#collectorimage","m":true,"v":"13.4.0"},{"n":"collectorTag","f":"OpenTelemetryCollectorSettings.collectorTag(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets the tag to use for the collector image.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#collectortag","m":true,"v":"13.4.0"},{"n":"disableHealthcheck","f":"OpenTelemetryCollectorSettings.disableHealthcheck(): boolean","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets a value indicating whether the collector health check is disabled.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#disablehealthcheck","m":true,"v":"13.4.0"},{"n":"enableGrpcEndpoint","f":"OpenTelemetryCollectorSettings.enableGrpcEndpoint(): boolean","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets a value indicating whether the gRPC endpoint is enabled on the collector container. Note: this also configures TLS when Aspire is configured for HTTPS.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#enablegrpcendpoint","m":true,"v":"13.4.0"},{"n":"enableHttpEndpoint","f":"OpenTelemetryCollectorSettings.enableHttpEndpoint(): boolean","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets a value indicating whether the HTTP endpoint is enabled on the collector container. Note: this also configures TLS when Aspire is configured for HTTPS.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#enablehttpendpoint","m":true,"v":"13.4.0"},{"n":"forceNonSecureReceiver","f":"OpenTelemetryCollectorSettings.forceNonSecureReceiver(): boolean","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets a value indicating whether the default OTLP receivers should use HTTP even when Aspire is configured for HTTPS.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#forcenonsecurereceiver","m":true,"v":"13.4.0"},{"n":"image","f":"OpenTelemetryCollectorSettings.image(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets the collector image path.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#image","m":true,"v":"13.4.0"},{"n":"registry","f":"OpenTelemetryCollectorSettings.registry(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.OpenTelemetryCollector","s":"Gets or sets the container registry for the image.","t":"OpenTelemetryCollectorSettings","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.opentelemetrycollector/opentelemetrycollectorsettings/#registry","m":true,"v":"13.4.0"},{"n":"addPapercutSmtp","f":"addPapercutSmtp(name: string, httpPort?: number, smtpPort?: number): PapercutSmtpContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PapercutSmtp","s":"Adds Papercut SMTP to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.papercutsmtp/addpapercutsmtp/","v":"13.4.0"},{"n":"PapercutSmtpContainerResource","f":"Aspire.Hosting.ApplicationModel.PapercutSmtpContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.PapercutSmtp","s":"Resource for the Papercut SMTP server.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.papercutsmtp/papercutsmtpcontainerresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"PapercutSmtpContainerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.PapercutSmtp","s":"ConnectionString for the Papercut SMTP server in the form of smtp://host:port.","t":"PapercutSmtpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.papercutsmtp/papercutsmtpcontainerresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"PapercutSmtpContainerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.PapercutSmtp","s":"Gets the host endpoint reference for the SMTP endpoint.","t":"PapercutSmtpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.papercutsmtp/papercutsmtpcontainerresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"PapercutSmtpContainerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.PapercutSmtp","s":"Gets the port endpoint reference for the SMTP endpoint.","t":"PapercutSmtpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.papercutsmtp/papercutsmtpcontainerresource/#port","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"PapercutSmtpContainerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.PapercutSmtp","s":"Gets the connection URI expression for the Papercut SMTP endpoint.","t":"PapercutSmtpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.papercutsmtp/papercutsmtpcontainerresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addPerlApi","f":"addPerlApi(resourceName: string, appDirectory: string, scriptName: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Adds a Perl API server resource (e.g., Mojolicious, Dancer2) to the application model. Passes the `daemon` subcommand so HTTP frameworks start a listener.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/addperlapi/","v":"13.4.0"},{"n":"addPerlExecutable","f":"addPerlExecutable(resourceName: string, appDirectory: string, executablePath: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Adds a Perl executable (compiled binary or PAR-packed application) to the application model. The executable is run directly rather than through the `perl` interpreter.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/addperlexecutable/","v":"13.4.0"},{"n":"addPerlModule","f":"addPerlModule(resourceName: string, appDirectory: string, moduleName: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Adds a Perl module to the application model. The module is executed using `perl -MModule::Name -e \"Module::Name->run()\"`.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/addperlmodule/","v":"13.4.0"},{"n":"addPerlScript","f":"addPerlScript(resourceName: string, appDirectory: string, scriptName: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Adds a Perl script resource (worker, CLI tool, background service) to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/addperlscript/","v":"13.4.0"},{"n":"withCarton","f":"withCarton(): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures the Perl application to use Carton as its package manager. Carton manages dependencies via `cpanfile` and a lock file (`cpanfile.snapshot`), enabling reproducible builds. Use `WithProjectDependencies``1` to run `carton install` at startup.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withcarton/","v":"13.4.0"},{"n":"withCpanMinus","f":"withCpanMinus(): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures the Perl application to use cpanm (App::cpanminus) as its package manager instead of the default cpan. Call this before `WithPackage``1` to change how packages are installed.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withcpanminus/","v":"13.4.0"},{"n":"withLocalLib","f":"withLocalLib(path?: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures the Perl application to use a local::lib directory for module isolation. Sets `PERL5LIB`, `PERL_LOCAL_LIB_ROOT`, `PERL_MM_OPT`, and `PERL_MB_OPT` environment variables so that modules are resolved from and installed into the local directory.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withlocallib/","v":"13.4.0"},{"n":"withPackage","f":"withPackage(packageName: string, force?: boolean, skipTest?: boolean): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Adds a Perl package (module) to be installed before the application starts. Uses the configured package manager: cpan by default, or cpanm if `WithCpanMinus``1` was called.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withpackage/","v":"13.4.0"},{"n":"withPerlbrew","f":"withPerlbrew(version: string, perlbrewRoot?: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures the Perl application to use a specific perlbrew-managed Perl version.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withperlbrew/","v":"13.4.0"},{"n":"withPerlbrewEnvironment","f":"withPerlbrewEnvironment(version: string, perlbrewRoot?: string): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures the Perl application to use a specific perlbrew-managed Perl version. This resolves the Perl executable from the perlbrew installation and updates the resource's command and environment variables so that all subsequent operations use the specified Perl version.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withperlbrewenvironment/","v":"13.4.0"},{"n":"withPerlCertificateTrust","f":"withPerlCertificateTrust(): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures certificate trust for the Perl application by setting SSL/TLS environment variables that common Perl HTTP libraries respect. Sets `SSL_CERT_FILE` (IO::Socket::SSL / LWP), `PERL_LWP_SSL_CA_FILE` (LWP::UserAgent), and `MOJO_CA_FILE` (Mojolicious) to the certificate bundle path provided by Aspire.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withperlcertificatetrust/","v":"13.4.0"},{"n":"withProjectDependencies","f":"withProjectDependencies(cartonDeployment?: boolean): PerlAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Configures project-level dependency installation for the Perl application. Runs the appropriate install command based on the active package manager: - - If the active package manager is `cpan` (the default), it is automatically switched to `cpanm` since `cpan` does not support `--installdeps`.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/withprojectdependencies/","v":"13.4.0"},{"n":"PerlAppResource","f":"Aspire.Hosting.ApplicationModel.PerlAppResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Perl","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.perl/perlappresource/","v":"13.4.0"},{"n":"withAdminer","f":"withAdminer(containerName?: string): PostgresServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.postgresql.extensions/withadminer/","v":"13.4.0"},{"n":"withDbGate","f":"withDbGate(containerName?: string): PostgresServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.postgresql.extensions/withdbgate/","v":"13.4.0"},{"n":"withFlywayMigration","f":"withFlywayMigration(flywayName: string, migrationScriptsPath: string): PostgresDatabaseResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.postgresql.extensions/withflywaymigration/","v":"13.4.0"},{"n":"withFlywayRepair","f":"withFlywayRepair(flywayName: string, migrationScriptsPath: string): PostgresDatabaseResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PostgreSQL.Extensions","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.postgresql.extensions/withflywayrepair/","v":"13.4.0"},{"n":"addPowerShell","f":"addPowerShell(name: string, languageMode?: string, minRunspaces?: number, maxRunspaces?: number): PowerShellRunspacePoolResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PowerShell","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.powershell/addpowershell/","v":"13.4.0"},{"n":"addScript","f":"addScript(name: string, script: string): PowerShellScriptResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PowerShell","s":"Adds a PowerShell script resource to the distributed application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.powershell/addscript/","v":"13.4.0"},{"n":"withArgs","f":"withArgs(args: string[]): PowerShellScriptResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.PowerShell","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.powershell/withargs/","v":"13.4.0"},{"n":"PowerShellRunspacePoolResource","f":"CommunityToolkit.Aspire.Hosting.PowerShell.PowerShellRunspacePoolResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.PowerShell","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.powershell/powershellrunspacepoolresource/","v":"13.4.0"},{"n":"PowerShellScriptResource","f":"CommunityToolkit.Aspire.Hosting.PowerShell.PowerShellScriptResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.PowerShell","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.powershell/powershellscriptresource/","v":"13.4.0"},{"n":"addStreamlitApp","f":"addStreamlitApp(name: string, appDirectory: string, scriptPath: string): StreamlitAppResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Python.Extensions","s":"Adds a Streamlit application to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.python.extensions/addstreamlitapp/","v":"13.4.0"},{"n":"StreamlitAppResource","f":"Aspire.Hosting.ApplicationModel.StreamlitAppResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Python.Extensions","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.python.extensions/streamlitappresource/","v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string, ensureCreated?: boolean): RavenDBDatabaseResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Adds a database resource to an existing RavenDB server resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/adddatabase/","v":"13.4.0"},{"n":"addRavenDB","f":"addRavenDB(name: string): RavenDBServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Adds a RavenDB server resource to the application model. A container is used for local development. This overload simplifies the configuration by creating an unsecured RavenDB server resource with default settings.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/addravendb/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): RavenDBServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Adds a bind mount for the data folder to a RavenDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): RavenDBServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Adds a named volume for the data folder to a RavenDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/withdatavolume/","v":"13.4.0"},{"n":"withLogBindMount","f":"withLogBindMount(source: string, isReadOnly?: boolean): RavenDBServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Adds a bind mount for the logs folder to a RavenDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/withlogbindmount/","v":"13.4.0"},{"n":"withLogVolume","f":"withLogVolume(name?: string, isReadOnly?: boolean): RavenDBServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Adds a named volume for the logs folder to a RavenDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/withlogvolume/","v":"13.4.0"},{"n":"RavenDBDatabaseResource","f":"Aspire.Hosting.ApplicationModel.RavenDBDatabaseResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"A resource that represents a RavenDB database. This is a child resource of a `RavenDBServerResource`.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbdatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"RavenDBDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the connection string expression for the RavenDB database, derived from the parent server's connection string.","t":"RavenDBDatabaseResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbdatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"RavenDBDatabaseResource.databaseName(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the name of the database.","t":"RavenDBDatabaseResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbdatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"parent","f":"RavenDBDatabaseResource.parent(): RavenDBServerResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the parent RavenDB server resource associated with this database.","t":"RavenDBDatabaseResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbdatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"RavenDBServerResource","f":"Aspire.Hosting.ApplicationModel.RavenDBServerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"A resource that represents a RavenDB container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"RavenDBServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the connection string expression for the RavenDB server, formatted as \"http(s)://{Host}:{Port}\" depending on the security setting.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"RavenDBServerResource.databases(): Dict","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets a read-only dictionary of databases associated with this server resource. The key represents the resource name, and the value represents the database name.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#databases","m":true,"v":"13.4.0"},{"n":"host","f":"RavenDBServerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the host endpoint reference for this resource.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"RavenDBServerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the port endpoint reference for this resource.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"RavenDBServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the primary endpoint for the RavenDB server.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"tcpEndpoint","f":"RavenDBServerResource.tcpEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the TCP endpoint for the RavenDB server.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#tcpendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"RavenDBServerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.RavenDB","s":"Gets the connection URI expression for the RavenDB server.","t":"RavenDBServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.ravendb/ravendbserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"withDbGate","f":"withDbGate(configureContainer?: (obj: DbGateContainerResource) => Promise, containerName?: string): RedisResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Redis.Extensions","s":"Adds an administration and development platform for Redis to the application model using DbGate.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.redis.extensions/withdbgate/","v":"13.4.0"},{"n":"addBaconApp","f":"addBaconApp(name: string, workingDirectory: string, args?: string[]): RustAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Rust","s":"Adds a Rust application to the application model, using the bacon cli.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.rust/addbaconapp/","v":"13.4.0"},{"n":"addRustApp","f":"addRustApp(name: string, workingDirectory: string, args?: string[]): RustAppExecutableResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Rust","s":"Adds a Rust application to the application model, using the cargo cli.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.rust/addrustapp/","v":"13.4.0"},{"n":"RustAppExecutableResource","f":"Aspire.Hosting.ApplicationModel.RustAppExecutableResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Rust","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.rust/rustappexecutableresource/","v":"13.4.0"},{"n":"addSftp","f":"addSftp(name: string, port?: number): SftpContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Adds atmoz SFTP to the application model.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/addsftp/","v":"13.4.0"},{"n":"withHostKeyFile","f":"withHostKeyFile(keyFile: string, keyType: KeyType): SftpContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Adds a bind mount for the specified host key file to an SFTP container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/withhostkeyfile/","v":"13.4.0"},{"n":"withUserKeyFile","f":"withUserKeyFile(username: string, keyFile: string, keyType: KeyType): SftpContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Adds a bind mount for the public key file of the specified user to an SFTP container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/withuserkeyfile/","v":"13.4.0"},{"n":"withUsersFile","f":"withUsersFile(usersFile: string): SftpContainerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Adds a bind mount for the users.conf file to an SFTP container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/withusersfile/","v":"13.4.0"},{"n":"SftpContainerResource","f":"Aspire.Hosting.ApplicationModel.SftpContainerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"A resource that represents an SFTP container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/sftpcontainerresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SftpContainerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"ConnectionString for the atmoz SFTP server in the form of sftp://host:port.","t":"SftpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/sftpcontainerresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"SftpContainerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Gets the host endpoint reference for this resource.","t":"SftpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/sftpcontainerresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"SftpContainerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Gets the port endpoint reference for this resource.","t":"SftpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/sftpcontainerresource/#port","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SftpContainerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Gets the connection URI expression for the atmoz SFTP endpoint.","t":"SftpContainerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/sftpcontainerresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"KeyType","f":"Aspire.Hosting.KeyType","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Specifies the types of cryptographic keys supported for digital signatures.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/keytype-aspire-hosting-keytype/","v":"13.4.0"},{"n":"KeyType","f":"Aspire.Hosting.KeyType","k":"enum","p":"CommunityToolkit.Aspire.Hosting.Sftp","s":"Specifies the types of cryptographic keys supported for digital signatures.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sftp/keytype-aspire-hosting-keytype-2/","v":"13.4.0"},{"n":"addSolr","f":"addSolr(name: string, port?: number, coreName?: string): SolrResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Adds an Apache Solr container resource to the distributed application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/addsolr/","v":"13.4.0"},{"n":"withConfigset","f":"withConfigset(configSetName: string, configSetPath: string): SolrResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Specifies the path to the config set directory.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/withconfigset/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string, isReadOnly?: boolean): SolrResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Adds a bind mount for the data folder to a Solr container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string, isReadOnly?: boolean): SolrResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Adds a named volume for the data folder to a Solr container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/withdatavolume/","v":"13.4.0"},{"n":"SolrResource","f":"Aspire.Hosting.ApplicationModel.SolrResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Represents an Apache Solr container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SolrResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Gets the connection string expression for the Solr server.","t":"SolrResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"coreName","f":"SolrResource.coreName(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"The Solr core name.","t":"SolrResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/#corename","m":true,"v":"13.4.0"},{"n":"host","f":"SolrResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Gets the host endpoint reference for this resource.","t":"SolrResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"SolrResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Gets the port endpoint reference for this resource.","t":"SolrResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"SolrResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Gets the primary endpoint for the Solr server.","t":"SolrResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SolrResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Solr","s":"Gets the connection URI expression for the Solr server.","t":"SolrResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.solr/solrresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"addSqlProject","f":"addSqlProject(name: string): SqlProjectResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Adds a SQL Server Database Project resource to the application.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/addsqlproject/","v":"13.4.0"},{"n":"withConnectionReference","f":"withConnectionReference(target: IResourceWithConnectionString): SqlProjectResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Publishes the SQL Server database project to a connection string resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/withconnectionreference/","v":"13.4.0"},{"n":"withDacDeployOptions","f":"withDacDeployOptions(optionsPath: string): SqlProjectResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Sets the publish profile path used for DAC deployment options.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/withdacdeployoptions/","v":"13.4.0"},{"n":"withDacpac","f":"withDacpac(dacpacPath: string): SqlProjectResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Specifies the path to the .dacpac file.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/withdacpac/","v":"13.4.0"},{"n":"withReference","f":"withReference(target: SqlServerDatabaseResource): SqlProjectResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Publishes the SQL Server database project to a SQL Server database resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/withreference/","v":"13.4.0"},{"n":"withSkipWhenDeployed","f":"withSkipWhenDeployed(): SqlProjectResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Specifies that .dacpac deployment should be skipped if metadata in the target database indicates that the .dacpac has already been deployed in its current state.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/withskipwhendeployed/","v":"13.4.0"},{"n":"SqlProjectResource","f":"Aspire.Hosting.ApplicationModel.SqlProjectResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Represents a SQL Server Database project resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/sqlprojectresource/","v":"13.4.0"},{"n":"dacDeployOptionsPath","f":"SqlProjectResource.dacDeployOptionsPath(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Gets the configured path to the deployment options publish profile.","t":"SqlProjectResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/sqlprojectresource/#dacdeployoptionspath","m":true,"v":"13.4.0"},{"n":"dacpacPath","f":"SqlProjectResource.dacpacPath(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Gets the configured path to the .dacpac file.","t":"SqlProjectResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/sqlprojectresource/#dacpacpath","m":true,"v":"13.4.0"},{"n":"skipWhenDeployed","f":"SqlProjectResource.skipWhenDeployed(): boolean","k":"property","p":"CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects","s":"Gets a value indicating whether deployment should be skipped when the dacpac has already been deployed.","t":"SqlProjectResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqldatabaseprojects/sqlprojectresource/#skipwhendeployed","m":true,"v":"13.4.0"},{"n":"addSqlite","f":"addSqlite(name: string, databasePath?: string, databaseFileName?: string): SqliteResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Adds an Sqlite resource to the application builder.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/addsqlite/","v":"13.4.0"},{"n":"withSqliteWeb","f":"withSqliteWeb(containerName?: string): SqliteResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/withsqliteweb/","v":"13.4.0"},{"n":"SqliteResource","f":"Aspire.Hosting.ApplicationModel.SqliteResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Represents a resource for Sqlite database with a specified name and database path.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqliteresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SqliteResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Gets the ConnectionStringExpression property","t":"SqliteResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqliteresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"SqliteWebResource","f":"Aspire.Hosting.ApplicationModel.SqliteWebResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Represents a resource for Sqlite Web with a specified name.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqlitewebresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SqliteWebResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Gets the connection string expression for the Open WebUI endpoint.","t":"SqliteWebResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqlitewebresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"SqliteWebResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Gets the host endpoint reference for this resource.","t":"SqliteWebResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqlitewebresource/#host","m":true,"v":"13.4.0"},{"n":"port","f":"SqliteWebResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Gets the port endpoint reference for this resource.","t":"SqliteWebResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqlitewebresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"SqliteWebResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Gets the http endpoint for the Open WebUI resource.","t":"SqliteWebResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqlitewebresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SqliteWebResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.Sqlite","s":"Gets the connection URI expression for the Sqlite Web endpoint.","t":"SqliteWebResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlite/sqlitewebresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"withAdminer","f":"withAdminer(containerName?: string, imageTag?: string): SqlServerServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlServer.Extensions","s":"Adds an administration and development platform for SqlServer to the application model using Adminer.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlserver.extensions/withadminer/","v":"13.4.0"},{"n":"withDbGate","f":"withDbGate(containerName?: string, imageTag?: string): SqlServerServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SqlServer.Extensions","s":"Adds an administration and development platform for SqlServer to the application model using DbGate.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.sqlserver.extensions/withdbgate/","v":"13.4.0"},{"n":"addStripe","f":"addStripe(name: string, apiKey: ParameterResource): StripeResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Adds the Stripe CLI to the application model for local webhook forwarding.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/addstripe/","v":"13.4.0"},{"n":"withApiKey","f":"withApiKey(apiKey: ParameterResource): StripeResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Configures the Stripe CLI to use a specific API key from a parameter.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/withapikey/","v":"13.4.0"},{"n":"withListen","f":"withListen(forwardTo: IResourceWithEndpoints, webhookPath?: string, events?: string[]): StripeResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/withlisten/","v":"13.4.0"},{"n":"withListenExternalService","f":"withListenExternalService(forwardTo: ExternalServiceResource, webhookPath?: string, events?: string[]): StripeResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/withlistenexternalservice/","v":"13.4.0"},{"n":"withStripeReference","f":"withStripeReference(source: StripeResource, webhookSigningSecretEnvVarName?: string): IResourceWithEnvironment","k":"method","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Adds a reference to a Stripe CLI resource for accessing its webhook signing secret.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/withstripereference/","v":"13.4.0"},{"n":"StripeResource","f":"Aspire.Hosting.ApplicationModel.StripeResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Represents a Stripe CLI container resource for local webhook forwarding and testing.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/striperesource/","v":"13.4.0"},{"n":"webhookSigningSecret","f":"StripeResource.webhookSigningSecret(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.Stripe","s":"Gets the webhook signing secret retrieved from the Stripe CLI.","t":"StripeResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.stripe/striperesource/#webhooksigningsecret","m":true,"v":"13.4.0"},{"n":"addDatabase","f":"addDatabase(name: string, databaseName?: string): SurrealDbDatabaseResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Adds a SurrealDB database resource to the application model","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/adddatabase/","v":"13.4.0"},{"n":"addNamespace","f":"addNamespace(name: string, namespaceName?: string): SurrealDbNamespaceResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Adds a SurrealDB namespace resource to the application model","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/addnamespace/","v":"13.4.0"},{"n":"addSurrealServer","f":"addSurrealServer(name: string, userName?: ParameterResource, password?: ParameterResource, port?: number, path?: string, strictMode?: boolean): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Adds a SurrealDB resource to the application model. A container is used for local development. The default image is and the tag is .","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/addsurrealserver/","v":"13.4.0"},{"n":"withCreationScript","f":"withCreationScript(script: string): SurrealDbNamespaceResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Defines the SQL script used to create the namespace.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withcreationscript-aspire-hosting-applicationmodel-surrealdbnamespaceresource-string/","v":"13.4.0"},{"n":"withCreationScript","f":"withCreationScript(script: string): SurrealDbDatabaseResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Defines the SQL script used to create the database.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withcreationscript-aspire-hosting-applicationmodel-surrealdbdatabaseresource-string/","v":"13.4.0"},{"n":"withDataBindMount","f":"withDataBindMount(source: string): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Adds a bind mount for the data folder to a SurrealDB resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withdatabindmount/","v":"13.4.0"},{"n":"withDataVolume","f":"withDataVolume(name?: string): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Adds a named volume for the data folder to a SurrealDB resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withdatavolume/","v":"13.4.0"},{"n":"withInitFiles","f":"withInitFiles(source: string): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Copies init files into a SurrealDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withinitfiles/","v":"13.4.0"},{"n":"withLogLevel","f":"withLogLevel(logLevel: string): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withloglevel/","v":"13.4.0"},{"n":"withSurrealDbOtlpExporter","f":"withSurrealDbOtlpExporter(): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Injects the appropriate environment variables to allow the resource to enable sending telemetry to the dashboard. 1. It sets the OTLP endpoint to the value of the DOTNET_DASHBOARD_OTLP_ENDPOINT_URL environment variable. 2. It sets the service name and instance id to the resource name and UID. Values are injected by the orchestrator. 3. It sets a small batch schedule delay in development. This reduces the delay that OTLP exporter waits to sends telemetry and makes the dashboard telemetry pages responsive.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withsurrealdbotlpexporter/","v":"13.4.0"},{"n":"withSurrealist","f":"withSurrealist(containerName?: string): SurrealDbServerResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/withsurrealist/","v":"13.4.0"},{"n":"SurrealDbDatabaseResource","f":"Aspire.Hosting.ApplicationModel.SurrealDbDatabaseResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"A resource that represents a SurrealDB database that is a child of a SurrealDB namespace resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbdatabaseresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SurrealDbDatabaseResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the connection string expression for the SurrealDB database.","t":"SurrealDbDatabaseResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbdatabaseresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databaseName","f":"SurrealDbDatabaseResource.databaseName(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the database name.","t":"SurrealDbDatabaseResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbdatabaseresource/#databasename","m":true,"v":"13.4.0"},{"n":"parent","f":"SurrealDbDatabaseResource.parent(): SurrealDbNamespaceResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the parent SurrealDB namespace resource.","t":"SurrealDbDatabaseResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbdatabaseresource/#parent","m":true,"v":"13.4.0"},{"n":"SurrealDbNamespaceResource","f":"Aspire.Hosting.ApplicationModel.SurrealDbNamespaceResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"A resource that represents a SurrealDB namespace that is a child of a SurrealDB container resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbnamespaceresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SurrealDbNamespaceResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the connection string expression for the SurrealDB database.","t":"SurrealDbNamespaceResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbnamespaceresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"databases","f":"SurrealDbNamespaceResource.databases(): Dict","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"A dictionary where the key is the resource name and the value is the database name.","t":"SurrealDbNamespaceResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbnamespaceresource/#databases","m":true,"v":"13.4.0"},{"n":"namespaceName","f":"SurrealDbNamespaceResource.namespaceName(): string","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the namespace name.","t":"SurrealDbNamespaceResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbnamespaceresource/#namespacename","m":true,"v":"13.4.0"},{"n":"parent","f":"SurrealDbNamespaceResource.parent(): SurrealDbServerResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the parent SurrealDB container resource.","t":"SurrealDbNamespaceResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbnamespaceresource/#parent","m":true,"v":"13.4.0"},{"n":"SurrealDbServerResource","f":"Aspire.Hosting.ApplicationModel.SurrealDbServerResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"A resource that represents a SurrealDB container.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/","v":"13.4.0"},{"n":"connectionStringExpression","f":"SurrealDbServerResource.connectionStringExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the connection string expression for the SurrealDB instance.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#connectionstringexpression","m":true,"v":"13.4.0"},{"n":"host","f":"SurrealDbServerResource.host(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the host endpoint reference for this resource.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#host","m":true,"v":"13.4.0"},{"n":"namespaces","f":"SurrealDbServerResource.namespaces(): Dict","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"A dictionary where the key is the resource name and the value is the namespace name.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#namespaces","m":true,"v":"13.4.0"},{"n":"passwordParameter","f":"SurrealDbServerResource.passwordParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the parameter that contains the SurrealDB password.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#passwordparameter","m":true,"v":"13.4.0"},{"n":"port","f":"SurrealDbServerResource.port(): EndpointReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the port endpoint reference for this resource.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#port","m":true,"v":"13.4.0"},{"n":"primaryEndpoint","f":"SurrealDbServerResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the primary endpoint for the SurrealDB instance.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"uriExpression","f":"SurrealDbServerResource.uriExpression(): ReferenceExpression","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the connection URI expression for the SurrealDB instance.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#uriexpression","m":true,"v":"13.4.0"},{"n":"userNameParameter","f":"SurrealDbServerResource.userNameParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.SurrealDb","s":"Gets the parameter that contains the SurrealDB username.","t":"SurrealDbServerResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.surrealdb/surrealdbserverresource/#usernameparameter","m":true,"v":"13.4.0"},{"n":"addUmami","f":"addUmami(name: string, secret?: ParameterResource, port?: number): UmamiResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Umami","s":"Adds a Umami resource to the application model. A container is used for local development. The default image is and the tag is .","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.umami/addumami/","v":"13.4.0"},{"n":"withPostgreSQL","f":"withPostgreSQL(database: PostgresDatabaseResource): UmamiResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Umami","s":"Configures PostgreSQL as the storage backend for Umami","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.umami/withpostgresql/","v":"13.4.0"},{"n":"UmamiResource","f":"Aspire.Hosting.ApplicationModel.UmamiResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Umami","s":"A resource that represents a Umami instance resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.umami/umamiresource/","v":"13.4.0"},{"n":"primaryEndpoint","f":"UmamiResource.primaryEndpoint(): EndpointReference","k":"property","p":"CommunityToolkit.Aspire.Hosting.Umami","s":"Gets the primary endpoint for the Umami instance.","t":"UmamiResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.umami/umamiresource/#primaryendpoint","m":true,"v":"13.4.0"},{"n":"secretParameter","f":"UmamiResource.secretParameter(): ParameterResource","k":"property","p":"CommunityToolkit.Aspire.Hosting.Umami","s":"Gets the parameter that contains the Umami app secret.","t":"UmamiResource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.umami/umamiresource/#secretparameter","m":true,"v":"13.4.0"},{"n":"addZitadel","f":"addZitadel(name: string, port?: number, username?: ParameterResource, password?: ParameterResource, masterKey?: ParameterResource): ZitadelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Zitadel","s":"Adds a Zitadel container resource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.zitadel/addzitadel/","v":"13.4.0"},{"n":"withDatabase","f":"withDatabase(server: PostgresServerResource, databaseName?: string): ZitadelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Zitadel","s":"Adds database support to the Zitadel resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.zitadel/withdatabase/","v":"13.4.0"},{"n":"withExistingDatabase","f":"withExistingDatabase(database: PostgresDatabaseResource): ZitadelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Zitadel","s":"Adds database support to the Zitadel resource.","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.zitadel/withexistingdatabase/","v":"13.4.0"},{"n":"withExternalDomain","f":"withExternalDomain(externalDomain: string): ZitadelResource","k":"method","p":"CommunityToolkit.Aspire.Hosting.Zitadel","s":"Configures the external domain for the Zitadel resource","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.zitadel/withexternaldomain/","v":"13.4.0"},{"n":"ZitadelResource","f":"CommunityToolkit.Aspire.Hosting.Zitadel.ZitadelResource","k":"handle","p":"CommunityToolkit.Aspire.Hosting.Zitadel","s":"Handle type","h":"/reference/api/typescript/communitytoolkit.aspire.hosting.zitadel/zitadelresource/","v":"13.4.0"}]