Watch Aspire live streamsDocsTry Aspire

addNetwork

Method
📦 Aspire.Hosting.Docker v13.6.5
interface ComposeFile {
// ... omitted for brevity
addNetwork(
name: string,
driver?: string,
external?: boolean,
configure?: callback): ComposeFile;
}

Signature

methodaddNetwork
Adds a top-level network definition to the Docker Compose file.
addNetwork(name: string, driver?: string, external?: boolean, configure?: (obj: Network) => Promise<void>): ComposeFile
namestringThe name of the network.
driverstringoptionalThe network driver to use.
externalbooleanoptionalA value indicating whether the network is managed outside the generated Compose file.
configure(obj: Network) => Promise<void>optionalAn optional callback for further network customization.
ComposeFile

Applies to

This method applies to the following types: