MilvusServerResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Milvus / MilvusServerResource

MilvusServerResource

Docs Reference TypeScript APIs Aspire.Hosting.Milvus MilvusServerResource

Handle TypeScript

📦 Aspire.Hosting.Milvus v13.2.0-preview.1.26159.1

interface MilvusServerResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly databases: Dict<string,string>;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  readonly token: ReferenceExpression;
  readonly uriExpression: ReferenceExpression;
  addDatabase(
      name: string,
      databaseName?: string): MilvusDatabaseResource;
  withAttu(configureContainer?: (obj: AttuResource) => void, containerName?: string): MilvusServerResource;
  withConfigurationFile(configurationFilePath: string): MilvusServerResource;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): MilvusServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): MilvusServerResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of MilvusServerResource…

method property

17 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property databases Dict<string,string> get

Gets the Databases property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

property token ReferenceExpression get

Gets the Token property

property uriExpression ReferenceExpression get

Gets the UriExpression property

Methods

method addDatabase builder

Adds a Milvus database resource to a Milvus server resource.

addDatabase(
    name: string,
    databaseName?: string): MilvusDatabaseResource

Parameters

name string

databaseName string optional

Returns

MilvusDatabaseResource

method withAttu builder

Adds the Attu administration tool for Milvus.

withAttu(configureContainer?: (obj: AttuResource) => void, containerName?: string): MilvusServerResource

Parameters

configureContainer (obj: AttuResource) => void optional

containerName string optional

Returns

MilvusServerResource

method withConfigurationFile builder

Copies a Milvus configuration file into the container.

withConfigurationFile(configurationFilePath: string): MilvusServerResource

Parameters

configurationFilePath string

Returns

MilvusServerResource

method withDataBindMount builder

Mounts a host directory as the Milvus data directory.

withDataBindMount(
    source: string,
    isReadOnly?: boolean): MilvusServerResource

Parameters

source string

isReadOnly boolean optional = False

Returns

MilvusServerResource

method withDataVolume builder

Adds a persistent data volume to the Milvus server resource.

withDataVolume(
    name?: string,
    isReadOnly?: boolean): MilvusServerResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

MilvusServerResource