string Value { get; }
Source
Gets the canonical identifier value.
Deployment
Namespaces
DeploymentLogicalId
SourceA validated logical identifier used by deployment resources and bindings.
Value
ImmutableImageReference
SourceAn immutable container image reference pinned to a SHA-256 digest.
Value
string Value { get; }
Source
Gets the full immutable image identity.
SourceRevision
SourceA full lowercase source-control commit used only for traceability.
Value
string Value { get; }
Source
Gets the full source revision.
DeploymentExecutionPolicy
SourceDefines explicit, provider-neutral run-to-completion bounds.
Tasks
int Tasks { get; }
Source
Gets the number of tasks.
Parallelism
int Parallelism { get; }
Source
Gets maximum concurrent tasks.
Retries
int Retries { get; }
Source
Gets the retry count.
Timeout
TimeSpan Timeout { get; }
Source
Gets the task timeout.
SecretBinding
SourceDescribes a logical secret reference without carrying or resolving its value.
Id
DeploymentLogicalId Id { get; }
Source
Gets the logical binding id.
Parameter
DeploymentLogicalId Parameter { get; }
Source
Gets the logical Aspire parameter id; its value must never be evaluated by deployment publishing.
EnvironmentVariable
string EnvironmentVariable { get; }
Source
Gets the environment variable used for reference delivery.
Delivery
SecretDeliveryKind Delivery { get; }
Source
Gets the only secret-delivery mode supported in v1.
DatabaseBinding
SourceDescribes a relational database requirement and its connection-secret reference.
Id
DeploymentLogicalId Id { get; }
Source
Gets the logical database id.
ConfigurationKey
string ConfigurationKey { get; }
Source
Gets the application configuration key.
ConnectionSecret
DeploymentLogicalId ConnectionSecret { get; }
Source
Gets the referenced logical secret binding.
RequireUnixSocket
bool RequireUnixSocket { get; }
Source
Gets whether Unix-socket delivery is required.
MigrationOwner
bool MigrationOwner { get; }
Source
Gets whether the job owns migrations for this database.
MigrationJobIntent
SourcePortable intent for one explicitly bounded migration job.
Id
DeploymentLogicalId Id { get; }
Source
Gets the logical job id.
Phase
DeploymentPhase Phase { get; }
Source
Gets the deployment phase.
Image
ImmutableImageReference Image { get; }
Source
Gets the immutable image.
Command
string Command { get; }
Source
Gets the executable command.
Arguments
IReadOnlyList<string> Arguments { get; }
Source
Gets ordered command arguments.
Execution
DeploymentExecutionPolicy Execution { get; }
Source
Gets execution bounds.
ConnectionSecret
SecretBinding ConnectionSecret { get; }
Source
Gets the connection-secret reference.
Database
DatabaseBinding Database { get; }
Source
Gets the database binding.
ServiceIdentity
DeploymentLogicalId ServiceIdentity { get; }
Source
Gets the logical runtime service identity.
RequiredCapabilities
IReadOnlyList<DeploymentCapability> RequiredCapabilities { get; }
Source
Gets required target capabilities in canonical order.
RequirePrivateNetwork
bool RequirePrivateNetwork { get; }
Source
Gets whether private networking is required.
Environment
IReadOnlyDictionary<string, string> Environment { get; }
Source
Gets sorted artifact-visible environment settings after secret-shaped names are rejected.
DeploymentIntent
SourceThe schema-versioned provider-neutral deployment artifact.
Schema
string Schema { get; }
Source
Gets the schema identifier.
SchemaVersion
string SchemaVersion { get; }
Source
Gets the schema version.
Environment
string Environment { get; }
Source
Gets the Aspire environment.
SourceRevision
SourceRevision SourceRevision { get; }
Source
Gets the explicit source revision.
MigrationJobs
IReadOnlyList<MigrationJobIntent> MigrationJobs { get; }
Source
Gets migration jobs in canonical logical-id order.
DeploymentDiagnostic
SourceA stable safe deployment diagnostic with problem, cause, fix, and documentation.
Parameters
CodeStable `ASDEPLOY` code.ProblemSafe one-line failure description.CauseSafe explanation without secret values or raw provider output.FixConcrete remediation.DocumentationVersioned troubleshooting link.
Create
DeploymentDiagnostic Create(string code, string problem, string cause, string fix)
Source
Creates a diagnostic linked to the deployment troubleshooting reference.
DeploymentValidationException
SourceThrown when deployment intent or provider inputs violate a stable deployment contract.
Diagnostic
DeploymentDiagnostic Diagnostic { get; }
Source
Gets the structured diagnostic.
DeploymentCanonicalJson
SourceSerializes portable deployment intent to deterministic UTF-8 JSON and hashes artifact bytes.
Serialize
byte[] Serialize<T>(T value)
Source
Serializes a value as UTF-8 without a BOM, with stable indentation and one trailing LF.
Hash
string Hash(ReadOnlySpan<byte> bytes)
Source
Computes a lowercase SHA-256 hash for exact artifact bytes.
DeploymentArtifact
SourceA named deterministic deployment artifact whose content cannot be mutated after creation.
Create
DeploymentArtifact Create(string fileName, byte[] content)
Source
Creates an artifact and computes its content hash.
Parameters
fileNamePortable single-segment artifact name.contentExact bytes copied into the immutable artifact.
Returns
An artifact with defensively copied content and its lowercase SHA-256 hash.
FileName
string FileName { get; }
Source
Gets the safe single-segment artifact file name.
Content
byte[] Content { get; }
Source
Gets a defensive copy of the exact artifact bytes.
Sha256
string Sha256 { get; }
Source
Gets the lowercase SHA-256 hash of the exact artifact bytes.
DeploymentArtifactBundleWriter
SourceWrites a complete target-owned artifact directory through a staged same-parent directory swap.
Remarks
The writer refuses non-empty directories that do not contain its ownership marker and refuses unexpected files in an owned directory. It stages every artifact before replacing the directory, so validation, serialization, and cancellation failures do not expose a partial new bundle. The marker is internal bookkeeping and is not a release evidence artifact.
WriteAsync
Task WriteAsync(string outputDirectory, string target, IEnumerable<DeploymentArtifact> artifacts, CancellationToken cancellationToken = default)
Source
Writes a complete deterministic artifact bundle.
Parameters
outputDirectoryDedicated output directory owned by one deployment target.targetStable target identifier stored in the ownership marker.artifactsComplete artifact set; file names must be unique.cancellationTokenCancels before the staged directory replaces the current bundle.
Exceptions
DeploymentValidationExceptionThrown for unsafe paths, non-owned files, or duplicate names.
DeploymentRenderRequest
SourceInputs passed to an Aspire-independent deployment target renderer.
Parameters
IntentValidated provider-neutral deployment intent.BindingProfilePathResolved provider binding-profile path.OutputDirectoryDedicated target output directory.GeneratorVersionAppSurface generator package version recorded in evidence.BindingProfileRootOptional trusted authoring-host root used to reject symlink escapes before reading.
DeploymentRenderResult
SourceDeterministic artifacts produced by a deployment target.
Parameters
TargetStable target identifier.ArtifactsComplete deterministic artifact set.
DeploymentVerifyRequest
SourceInputs passed to a read-only deployment verifier.
Parameters
RenderResultValidated render result to verify.ParityModeShadow or owned comparison policy.
DeploymentVerifyResult
SourceResult of read-only deployment verification.
Parameters
IsMatchWhether all required fields and public-principal checks matched.ComparedFieldsNumber of normalized field checks performed.DiagnosticsSafe drift diagnostics.AuthorizationStatusExplicit limitation or authorization evidence status.
IDeploymentTarget
SourceCompiles portable deployment intent and optionally verifies deployed state without mutation.
RenderAsync
Task<DeploymentRenderResult> RenderAsync(DeploymentRenderRequest request, CancellationToken cancellationToken = default)
Source
Renders deterministic artifacts without cloud calls or infrastructure mutation.
VerifyAsync
Task<DeploymentVerifyResult> VerifyAsync(DeploymentVerifyRequest request, CancellationToken cancellationToken = default)
Source
Performs read-only deployed-state verification; it must not accept or execute a job.
Name
string Name { get; }
Source
Gets the stable target identifier.
Capabilities
IReadOnlySet<DeploymentCapability> Capabilities { get; }
Source
Gets target capabilities used for fail-fast intent validation.
DeploymentPhase
SourceIdentifies the phase in which a deployment resource participates.
DeploymentCapability
SourceIdentifies a capability that a deployment target must support.
DeploymentParityMode
SourceIdentifies whether parity is evaluated before or after the generated configuration becomes authoritative.
SecretDeliveryKind
SourceIdentifies how a secret reference is delivered to a workload.