Skip to content
DocsTry Aspire
DocsTry

TerminalOptions Properties

ClassProperties3 members
Options for configuring a terminal session.
Gets or sets the initial number of columns for the terminal. The value must be greater than zero. Defaults to 120.
public int Columns { get; set; }
ArgumentOutOfRangeExceptionThrown when set to zero or a negative value.
Gets or sets the initial number of rows for the terminal. The value must be greater than zero. Defaults to 30.
public int Rows { get; set; }
ArgumentOutOfRangeExceptionThrown when set to zero or a negative value.
Gets or sets a value indicating whether the per-replica terminal host resources (named {parent}-terminalhost-{index}) should appear in the resource list.
public bool ShowTerminalHost { get; set; }
Defaults to false: terminal host resources are hidden from the dashboard and CLI resource list because they are an implementation detail of the TerminalResourceBuilderExtensions.WithTerminal feature, not something the user explicitly added to their app model.

Set to true when diagnosing terminal-host startup / connectivity issues so the host's state, exit code, logs, and (eventually) telemetry are visible alongside the parent resource. This is useful when investigating cases like "DCP never dialed the producer UDS" or "the host crashed during recycle".