IDeploymentTarget Target { get; }
Source
Gets the provider target.
Aspire
Namespaces
AppSurfaceDeploymentTargetResource
SourceRepresents one artifact-only deployment target in the evaluated Aspire resource graph.
Remarks
The resource has no runtime lifetime or endpoint. It carries provider inputs and a per-pipeline render cache.
GetHostAddressExpression
ReferenceExpression GetHostAddressExpression(EndpointReference endpointReference)
Source
Rejects endpoint projection because artifact-only targets do not expose deployed addresses.
Target
BindingProfile
ParameterResource BindingProfile { get; }
Source
Gets the non-secret binding-profile parameter.
SourceRevision
ParameterResource SourceRevision { get; }
Source
Gets the non-secret source-revision parameter.
AppHostDirectory
string AppHostDirectory { get; }
Source
Gets the trusted AppHost directory.
EnvironmentName
string EnvironmentName { get; }
Source
Gets the Aspire-selected environment name.
LastRenderResult
DeploymentRenderResult? LastRenderResult { get; set; }
Source
Gets or sets the render result produced by the publish dependency in the current pipeline process.
Remarks
Verification reuses this value only after its declared publish dependency completes; a new AppHost process starts without cached evidence.
AppSurfaceMigrationJobAnnotation
SourceImmutable Aspire annotation projected into one provider-neutral migration-job intent.
Parameters
ResourceNameCanonical logical resource name.PhaseExplicit deployment phase.ImageNon-secret immutable image parameter.CommandExecutable without shell parsing.ArgumentsOrdered executable arguments.ExecutionBounded run-to-completion policy.ConnectionSecretSecret-classified parameter retained only by logical name.ConfigurationKeyApplication configuration key populated by the provider secret reference.RequirePrivateNetworkWhether the required v1 private-network declaration was made.
AspireDeploymentPipelineAdapter
SourceIsolates the repository-pinned Aspire 13.4.4 experimental deployment-pipeline API.
Register
void Register(IResourceBuilder<IComputeEnvironmentResource> builder, AppSurfaceDeploymentTargetResource resource)
Source
Registers publish and verification factories with their native Aspire dependency relationships.
Parameters
builderTarget resource builder receiving pipeline annotations.resourceConcrete target resource captured by the step actions.
BuildIntentAsync
Task<DeploymentIntent> BuildIntentAsync(AppSurfaceDeploymentTargetResource targetResource, DistributedApplicationModel model, CancellationToken cancellationToken)
Source
Projects explicitly annotated resources assigned to one target into canonical neutral intent.
Parameters
targetResourceTarget whose assigned annotations are selected.modelEvaluated Aspire model.cancellationTokenCancellation observed during non-secret parameter resolution.
Returns
Validated, sorted deployment intent.
CompletePublishAsync
Task CompletePublishAsync(AppSurfaceDeploymentTargetResource resource, DeploymentRenderResult result, Action<string, string> addSummary, IReportingStep reportingStep, CancellationToken cancellationToken)
Source
Reports publish evidence and the no-mutation assurance through Aspire.
VerifyRenderedAsync
Task VerifyRenderedAsync(AppSurfaceDeploymentTargetResource resource, DeploymentRenderResult renderResult, Action<string, string> addSummary, IReportingStep reportingStep, CancellationToken cancellationToken)
Source
Runs shadow parity verification and reports a read-only success or typed failure.
RenderAndWriteAsync
Task<DeploymentRenderResult> RenderAndWriteAsync(AppSurfaceDeploymentTargetResource resource, DistributedApplicationModel model, IServiceProvider services, CancellationToken cancellationToken)
Source
Builds intent, confines the profile, invokes the pure provider renderer, and atomically writes one complete bundle.
Returns
The provider result plus any adapter-owned neutral-intent artifact.
ResolveBindingProfilePath
string ResolveBindingProfilePath(string appHostDirectory, string bindingProfilePath)
Source
Resolves a relative profile path lexically beneath the trusted AppHost directory.
Remarks
The provider loader performs the filesystem-level symbolic-link check before reading.
AspireAppStartup<TModule>
SourceStarts an Aspire AppHost with an AppSurface root module that implements IAppSurfaceHostModule.
Type Parameters
TModuleThe root AppSurface host module type for the Aspire AppHost.
Remarks
AspireAppStartup{TModule} is the Aspire-specific bootstrapper behind AspireApp{TModule}.RunAsync(string[]). The new() constraint activates the root module with a parameterless constructor before dependency injection is available, so module constructors should avoid service resolution, blocking work, and disposable ownership. Host-module service registrations run through ConsoleStartup{TModule} before ConfigureAdditionalServices discovers Aspire components.
ConfigureAdditionalServices
void ConfigureAdditionalServices(StartupContext context, IServiceCollection services)
Source
Discovers IAspireComponent types from the entry assembly and registers each concrete type as a singleton.
Parameters
contextThe AppSurface startup context that supplies the entry assembly to scan.servicesThe service collection receiving discovered Aspire component registrations.
Remarks
ConfigureAdditionalServices runs after the root IAppSurfaceHostModule and dependency modules have registered services. Components are registered by concrete type only, not by implemented interfaces, so consumers should resolve concrete component types directly. The registration is startup-only and does not transfer disposal ownership beyond normal container ownership.
AspireExceptionUtilities
SourceClassifies the process-fatal exception families used by Aspire profile activation and testing cleanup paths.
Remarks
This deliberately narrow helper recognizes OutOfMemoryException, StackOverflowException, and AccessViolationException. It is not a general exception-handling policy for AppSurface callers.
IsProcessFatal
bool IsProcessFatal(Exception exception)
Source
Determines whether an exception is an OutOfMemoryException, StackOverflowException, or AccessViolationException that should propagate immediately.
Parameters
exceptionThe exception to classify.
Returns
true for process-fatal exception types; otherwise false.
AspireApp
SourceEntry point for running an Aspire application with no specific root module.
Remarks
Use AspireApp.RunAsync(string[]) when the AppHost should use the framework-default NoHostModule and discover Aspire components from the calling assembly. If the caller has a concrete root module type that should participate in compile-time dependency and configuration registration, prefer AspireApp{TModule}.RunAsync(string[]) instead.
RunAsync
Task RunAsync(string[] args)
Source
Runs the Aspire application asynchronously.
Parameters
argsCommand-line arguments.
Returns
A task representing the run operation.
AspireApp<TModule>
SourceEntry point for running an Aspire application with a specific root module.
Type Parameters
TModuleThe type of the root module.
Remarks
Use AspireApp{TModule}.RunAsync(string[]) when the root module is known at compile time and should participate in AppSurface dependency discovery, configuration registration, and host hooks. The new() constraint means TModule is activated by parameterless constructor rather than dependency injection, so keep constructors cheap, deterministic, and free of external side effects. Use AspireApp.RunAsync(string[]) when no root module is needed or module selection is driven by framework defaults. The call delegates to AspireAppStartup{TModule} for host activation.
RunAsync
Task RunAsync(string[] args)
Source
Runs the Aspire application asynchronously with the specified root module.
Parameters
argsCommand-line arguments.
Returns
A task representing the run operation.
AspireProfileActivationLease<TProfile>
SourceOwns the unstarted AppSurface host used to activate one typed Aspire profile.
Type Parameters
TProfileThe activated profile type.
Remarks
Construction transfers ownership of the supplied host to the lease. Callers may use Profile and Services only while the lease is active; profile dependencies may come from the owned service provider. Disposal is idempotent, chooses asynchronous host disposal when available, and invalidates service access. Callers must not dispose the owned host separately or use the profile after lease disposal begins.
DisposeHostAsync
Task DisposeHostAsync(IHost host)
Source
Disposes a host asynchronously when its concrete implementation supports asynchronous cleanup.
Parameters
hostThe host to dispose.
Returns
A task that completes after host cleanup.
Profile
TProfile Profile { get; }
Source
Gets the activated profile while the lease and its constructor-injected services remain valid.
Services
IServiceProvider Services { get; }
Source
Gets the owned activation host's service provider before disposal begins.
Exceptions
ObjectDisposedExceptionThe lease is disposing or has been disposed.
AspireProfileActivator
SourceActivates Aspire profiles through the same AppSurface host composition used at runtime.
ActivateAsync
Task<AspireProfileActivationLease<TProfile>> ActivateAsync<TAppHost, TModule, TProfile>(CancellationToken cancellationToken)
Source
Builds an unstarted AppSurface host for TAppHost and resolves one typed Aspire profile.
Type Parameters
TAppHostThe public generated AppHost marker type whose assembly supplies activation identity.TModuleThe public AppSurface module used to compose the activation host.TProfileThe public concrete Aspire profile resolved from the activation host.
Parameters
cancellationTokenA token observed before host creation and around profile resolution.
Returns
A lease that owns the unstarted host, profile, and service provider. The caller must dispose the returned lease.
Exceptions
OperationCanceledExceptionCancellation is requested before activation completes.
Remarks
Activation uses empty command-line arguments and pins the entry-point assembly to TAppHost. The host is never started. If activation or cancellation prevents ownership from being returned, the method disposes the host before propagating the primary failure.
AspireStartupContext
SourceProvides context and helper methods during the Aspire application startup process.
Resolve
IResourceBuilder<TResource> Resolve<TResource>(IAspireComponent<TResource> dependency)
Source
Resolves an Aspire resource from a component, ensuring each component is only generated once.
Type Parameters
TResourceThe type of the resource.
Parameters
dependencyThe component providing the resource.
Returns
A resource builder for the resolved resource.
GetPathFromRoot
string GetPathFromRoot(string relativePath)
Source
Computes an absolute path from a path relative to the application root.
Parameters
relativePathThe relative path.
Returns
The computed absolute path.
AppSurfaceDeploymentBuilderExtensions
SourceExtends an Aspire resource graph with explicit AppSurface deployment intent.
AddAppSurfaceDeploymentTarget
IResourceBuilder<IComputeEnvironmentResource> AddAppSurfaceDeploymentTarget(this IDistributedApplicationBuilder builder, string name, IDeploymentTarget target, IResourceBuilder<ParameterResource> bindingProfile, IResourceBuilder<ParameterResource> sourceRevision)
Source
Adds one artifact-only deployment target to the native Aspire deployment pipeline.
Parameters
builderThe native Aspire application builder.nameThe unique Aspire compute-environment resource name.targetThe provider compiler and read-only verifier.bindingProfileA non-secret parameter containing the provider binding-profile path.sourceRevisionA non-secret parameter containing a full lowercase source commit.
Returns
The compute environment used with Aspire's WithComputeEnvironment extension.
Remarks
The publish step writes artifacts only. It does not call a cloud API, apply infrastructure, resolve secret values, execute a job, or change traffic. Verification is exposed as the separately named appsurface-gcp-verify step, performs shadow parity for pre-cutover adoption, and is required to remain read-only. After writer cutover, the application-owned release workflow may call the provider target directly with DeploymentParityMode.Owned.
WithAppSurfaceMigrationJob
IResourceBuilder<ProjectResource> WithAppSurfaceMigrationJob(this IResourceBuilder<ProjectResource> builder, Action<AppSurfaceMigrationJobOptions> configure)
Source
Annotates an existing Aspire project as one explicit migration-job intent.
Parameters
builderThe existing project resource builder; no second project resource is created.configureConfigures immutable image, command, secret reference, and execution bounds.
Returns
The original project builder for chaining.
Remarks
This annotation never reads the connection parameter value. Assign the returned project explicitly with Aspire's WithComputeEnvironment; unassigned annotations are rejected during publish rather than inferred. Calling this method twice for the same resource is an error.
AppSurfaceMigrationJobOptions
SourceBuilds the provider-neutral intent annotation for one existing Aspire project resource.
WithImage
AppSurfaceMigrationJobOptions WithImage(IResourceBuilder<ParameterResource> image)
Source
Uses a non-secret parameter containing a full immutable container image identity.
WithPhase
AppSurfaceMigrationJobOptions WithPhase(DeploymentPhase phase)
Source
Sets the deployment phase. Version 1 supports candidate preparation.
WithCommand
AppSurfaceMigrationJobOptions WithCommand(string command, params string[] arguments)
Source
Sets the executable and ordered arguments without parsing a shell command line.
WithConnectionSecret
AppSurfaceMigrationJobOptions WithConnectionSecret(IResourceBuilder<ParameterResource> secret, string configurationKey)
Source
Records a secret parameter by logical name without resolving its value.
Parameters
secretAn Aspire secret parameter used only as a logical reference.configurationKeyThe application configuration key populated by the provider reference.
RequirePrivateNetwork
AppSurfaceMigrationJobOptions RequirePrivateNetwork()
Source
Requires the provider target to supply private networking. Version 1 supports candidate preparation and requires every migration-job configuration to call this method; otherwise building the annotation throws ASDEPLOY207.
WithExecutionPolicy
AppSurfaceMigrationJobOptions WithExecutionPolicy(int tasks, int parallelism, int retries, TimeSpan timeout)
Source
Sets explicit task, parallelism, retry, and timeout bounds.
AspireProfile
SourceA base class for defining an Aspire profile as a CLI command.
GetDependencies
IEnumerable<AspireProfile> GetDependencies()
Source
Gets the dependencies (other profiles) that this profile requires.
Returns
An enumerable of dependent profiles.
GetComponents
IEnumerable<IAspireComponent> GetComponents()
Source
Gets the Aspire components that compose this profile.
Returns
An enumerable of Aspire components.
Compose
void Compose(IDistributedApplicationBuilder appBuilder, CancellationToken cancellationToken)
Source
Composes this profile into an Aspire distributed application builder.
Parameters
appBuilderThe builder that receives the profile graph.cancellationTokenA token checked before profile enumeration begins and between synchronous composition steps.
Remarks
Components from each profile returned by GetDependencies are resolved in dependency and component enumeration order before this profile's direct GetComponents results. Composition includes only those direct dependencies; it does not recursively traverse their dependencies. Values that do not implement IAspireComponent{TResource} for IResource are ignored. Cancellation is cooperative at the documented checkpoints, and cancellation or another failure does not roll back resources already added to appBuilder.
PassThroughArgs
string[] PassThroughArgs { get; }
Source
Gets the command-line arguments to pass through to the Aspire host.
Remarks
Profiles default to an empty argument set so AppSurface command selection remains owned by CliFx. Override this property when a profile intentionally needs to pass known AppHost arguments into DistributedApplicationBuilder. Unknown command-line arguments are not forwarded automatically.
IAspireComponent<T>
SourceIndicates that the implementing class is an Aspire component that can generate resources for the application. Classes implementing this interface are responsible for generating resources of type T,
Type Parameters
TThe type of resource the component generates.
Generate
IResourceBuilder<T> Generate(AspireStartupContext context, IDistributedApplicationBuilder appBuilder)
Source
Generates and adds a resource to the Aspire distributed application builder.
Parameters
contextThe Aspire startup context.appBuilderThe distributed application builder.
Returns
A resource builder for the generated resource.
IAspireComponent
SourceThe base interface for Aspire components. For now this interface does not define any members, but it serves as a marker interface to identify classes that are Aspire components. This allows for future expansion and additional functionality to be added to all Aspire components if needed.