AppSurface Search
Section API Reference
API Reference Language: C# Component: Deployment Audience: developer

GcpCloudRun

Type

GcpCloudRunBindingProfile

Source

Represents the closed, non-secret schema that maps AppSurface logical deployment ids to externally provisioned GCP resources.

Parameters

  • EnvironmentExact Aspire environment selected for rendering.
  • ProjectExisting 6-30 character lowercase Google Cloud project id.
  • RegionExisting canonical Cloud Run region, such as us-central1.
  • JobsLogical job ids mapped to distinct lowercase Cloud Run Job names of at most 63 characters.
  • CloudSqlInstanceConnectionNameExisting canonical Cloud SQL project:region:instance name.
  • NetworkExisting Direct VPC network and regional subnetwork resource references with an explicit supported egress mode.
  • ServiceAccountsLogical identity ids mapped to canonical user-managed service-account emails.
  • SecretsLogical secret ids mapped only to Secret Manager identifiers and the supported explicit version mode; no secret values are stored.

Remarks

Map keys are canonical lowercase AppSurface logical ids. Values are physical resource identifiers only; secret values and unknown properties are rejected by the profile loader.

Method

LoadAsync

2 overloads
Task<GcpCloudRunBindingProfile> LoadAsync(string path, string expectedEnvironment, CancellationToken cancellationToken = default) Source

Loads and strictly validates a profile without resolving any secret value.

Parameters

  • pathPath to a regular JSON file. The file and every ancestor to the filesystem root must not be symbolic links or reparse points, except the standard macOS /var, /tmp, and /etc aliases.
  • expectedEnvironmentAspire environment selected for publishing.
  • cancellationTokenCancellation observed while reading and parsing the profile.
Task<GcpCloudRunBindingProfile> LoadAsync(string path, string expectedEnvironment, string trustedRoot, CancellationToken cancellationToken = default) Source

Loads a profile and rejects symbolic links in every path component beneath a trusted root.

Parameters

  • pathPath to the profile file.
  • expectedEnvironmentAspire environment selected for publishing.
  • trustedRootTrusted AppHost root that must lexically contain the profile.
  • cancellationTokenCancellation observed while reading and parsing the profile.
Type

GcpCloudRunNetworkBinding

Source

Externally provisioned Direct VPC binding.

Parameters

  • NetworkFull global VPC network resource reference.
  • SubnetworkFull regional subnetwork resource reference.
  • Egress`PRIVATE_RANGES_ONLY` or `ALL_TRAFFIC`.
Type

GcpCloudRunSecretBinding

Source

Physical Secret Manager reference and explicit rotation mode.

Parameters

  • SecretIdExisting Secret Manager secret id.
  • VersionModeExplicit version mode; version 1 supports `latest`.
Type

GcpCloudRunDeploymentTarget

Source

Compiles migration-job intent to GCP Cloud Run v2 artifacts and performs read-only deployed parity checks.

Method

Create

GcpCloudRunDeploymentTarget Create() Source

Creates the standard GCP Cloud Run deployment target.

Type

GcpCloudRunMigrationParity

Source

Safe normalized Cloud Run migration-job configuration used for shadow and owned parity.

Type

IGcloudCommandRunner

Source

Executes one read-only gcloud invocation expressed as an argument array.

Method

RunAsync

Task<GcloudCommandResult> RunAsync(IReadOnlyList<string> arguments, TimeSpan timeout, CancellationToken cancellationToken) Source

Runs gcloud with bounded time and cancellation.

Type

GcloudCommandResult

Source

Captured process result. Callers must not log raw output without provider sanitization.

Parameters

  • ExitCodeProcess exit code.
  • StandardOutputCaptured standard output consumed only by safe provider parsing.
  • StandardErrorCaptured standard error consumed only by safe classification.
Type

GcloudCommandException

Source

Safe classified process-launch or timeout failure.

Property

Code

string Code { get; } Source

Gets the stable diagnostic code.

Property

Problem

string Problem { get; } Source

Gets the safe problem.

Property

Cause

string Cause { get; } Source

Gets the safe cause.

Property

Fix

string Fix { get; } Source

Gets the remediation.

Type

GcloudCommandRunner

Source

Production gcloud process runner. It launches the executable directly except on Windows, where the Cloud SDK's gcloud.cmd launcher requires cmd.exe; that path rejects whitespace and shell metacharacters before dispatch. The runner kills the process tree on timeout or cancellation.

Method

CreateStartInfo

ProcessStartInfo CreateStartInfo(IReadOnlyList<string> arguments) Source

Builds the non-shell or bounded Windows process-start contract without launching a process.

Parameters

  • argumentsOrdered provider arguments.

Returns

A fully configured process start description.

Method

BuildWindowsCommand

string BuildWindowsCommand(string command, IReadOnlyList<string> arguments) Source

Builds a metacharacter-free Windows command line for the fixed Cloud SDK launcher.

Parameters

  • commandThe fixed executable command name.
  • argumentsOrdered gcloud arguments.

Returns

A command string safe for the bounded cmd.exe /d /c dispatch path.

Property

Command

string Command { get; } Source

Gets the selected gcloud command for platform-contract tests.

Property

RequiresWindowsCommandInterpreter

bool RequiresWindowsCommandInterpreter { get; } Source

Gets whether the selected command requires the bounded Windows command-interpreter path.