diff --git a/.agents/skills/update-integrations/SKILL.md b/.agents/skills/update-integrations/SKILL.md index 4fff347d8f..f4442e7620 100644 --- a/.agents/skills/update-integrations/SKILL.md +++ b/.agents/skills/update-integrations/SKILL.md @@ -7,7 +7,7 @@ description: Update integration documentation links and API reference data by sy This skill synchronizes the integration package catalog with documentation URL mappings and generates per-package API reference schemas. It ensures every NuGet package listed in the integrations data file has a corresponding documentation link and an up-to-date API reference JSON file. -> **Automation note:** The scheduled `update-integration-data` workflow (`.github/workflows/update-integration-data.yml`) runs this update deterministically — no agent/LLM. It executes `src/frontend/scripts/update-integration-data.ps1`, which runs `pnpm update:all`, detects `"version":` changes in `src/frontend/src/data/aspire-integrations.json`, and — only when a version actually moves — runs the C# and TypeScript API regeneration (and the twoslash bundle) before opening a PR via the Aspire bot GitHub App. You can reproduce the full flow locally with `pwsh src/frontend/scripts/update-integration-data.ps1` (add `-SkipRegen` for a fast data-only run). Use this skill for **manual or one-off runs that need judgment** — for example: adding a new integration, reconciling `integration-docs.json`, validating release-branch feed resolution, troubleshooting a regen failure flagged by the workflow's PR, or regenerating data outside the scheduled cadence. +> **Automation note:** The scheduled `update-integration-data` workflow (`.github/workflows/update-integration-data.yml`) runs this update deterministically — no agent/LLM. It executes `src/frontend/scripts/update-integration-data.ps1`, which runs `pnpm update:all`, detects `"version":` changes in `src/frontend/src/data/aspire-integrations.json`, and — only when a version actually moves — runs the C#, TypeScript, and Go API regeneration (and the twoslash bundle) before opening a PR via the Aspire bot GitHub App. You can reproduce the full flow locally with `pwsh src/frontend/scripts/update-integration-data.ps1` (add `-SkipRegen` for a fast data-only run). Use this skill for **manual or one-off runs that need judgment** — for example: adding a new integration, reconciling `integration-docs.json`, validating release-branch feed resolution, troubleshooting a regen failure flagged by the workflow's PR, or regenerating data outside the scheduled cadence. ## Overview @@ -19,9 +19,10 @@ The aspire.dev site maintains three key data locations: - **`src/frontend/src/data/integration-docs.json`** — Mappings from package names to site-relative documentation URLs. - **`src/frontend/src/data/pkgs/`** — Per-package API reference JSON files (e.g. `Aspire.Hosting.Redis.13.1.2.json`) generated by the `PackageJsonGenerator` tool. These feed the auto-generated API reference pages at `/reference/api/`. - **`src/frontend/src/data/ts-modules/`** — Per-package TypeScript API reference JSON files (e.g. `Aspire.Hosting.Redis.13.2.0.json`) generated by the `AtsJsonGenerator` tool. These feed the auto-generated TypeScript API reference pages at `/reference/api/typescript/`. +- **`src/frontend/src/data/go-modules/`** — Per-package Go API reference JSON files (e.g. `Aspire.Hosting.Redis.13.2.0.json`) generated by the `AtsJsonGenerator` tool in Go mode. These feed the auto-generated Go API reference pages at `/reference/api/go/`. - **`src/frontend/src/data/twoslash/aspire.d.ts`** — A single consolidated TypeScript declaration bundle generated from the `ts-modules` JSON by `scripts/generate-twoslash-types.ts`. Consumed by `expressive-code-twoslash` to provide hover tooltips for TypeScript code samples in the docs. **Source-controlled** — commit the diff whenever `ts-modules` changes. -This skill keeps the documentation mappings in sync with the package catalog and regenerates both the C# and TypeScript API reference data. +This skill keeps the documentation mappings in sync with the package catalog and regenerates the C#, TypeScript, and Go API reference data. ## Prerequisites @@ -290,6 +291,18 @@ After the JSON is refreshed, `update-ts-api` automatically chains `generate-twos cd src/frontend && pnpm twoslash-types ``` +### 5b. Generate Go API reference data + +After the TypeScript data is refreshed, regenerate the Go API reference JSON files from the same package set: + +```bash +pnpm --filter ./src/frontend run update:go-api +``` + +`update-go-api.ts` runs the same `generate-ts-api-json.ps1` script as `update:ts-api`, with `-Language go`. Each package is dumped with `aspire sdk dump` exactly as for TypeScript, and the `AtsJsonGenerator` Go mode then renders the dump with the names and signatures that `aspire sdk generate --language go` produces: a flat `aspire` package, `...*Options` structs for optional parameters, and `(T, error)` returns. Package selection, parallelism, retries, tolerated scanner diagnostics, and stale-version cleanup behave as described in 5a. Set `ASPIRE_API_GO_MODULES_DIR` to redirect the output; the orchestrator uses it to stage the output before publishing. Capabilities that have no concrete Go type are skipped, and the generator output lists them. There is no twoslash bundle for Go. + +The generated Go JSON is normalized with `normalize-generated-api-data.ts`, like the other generated API data. See the `AtsJsonGenerator` README for the Go output format and its known limitations. + ### 6. Verify all links For every entry in the updated `integration-docs.json`: diff --git a/.github/instructions/astro.instructions.md b/.github/instructions/astro.instructions.md index 36e8ae9060..3e82f4d68f 100644 --- a/.github/instructions/astro.instructions.md +++ b/.github/instructions/astro.instructions.md @@ -148,6 +148,7 @@ Defined in `src/content.config.ts`: - **i18n** — Starlight i18n loader for 15 locales - **packages** — auto-generated API reference JSON from `src/data/pkgs/` - **tsModules** — auto-generated TypeScript API reference JSON from `src/data/ts-modules/` +- **goModules** — auto-generated Go API reference JSON from `src/data/go-modules/` Preserve Starlight's `docsLoader()`, `i18nLoader()`, `docsSchema()`, and `i18nSchema()` when extending content. Use `glob()` or `file()` from `astro/loaders` for additional file-backed collections, and query entries with type-safe `getCollection()` and `getEntry()` from `astro:content`. Import `z` from `astro/zod`, not `astro:content`; use Zod 4 helpers such as `z.email()` and `z.url()` for new email and URL schemas. diff --git a/.github/workflows/update-integration-data.yml b/.github/workflows/update-integration-data.yml index 2a017b333b..12aa8d2179 100644 --- a/.github/workflows/update-integration-data.yml +++ b/.github/workflows/update-integration-data.yml @@ -24,7 +24,10 @@ jobs: update: name: Update integration data runs-on: ubuntu-latest - timeout-minutes: 45 + # Three generation passes (C#, TypeScript, Go) each scan every package, so + # the runtime scales with the number of languages. The TypeScript pass alone + # takes about ten minutes on a hosted runner. + timeout-minutes: 75 permissions: contents: read steps: @@ -132,6 +135,7 @@ jobs: src/frontend/src/assets/samples \ src/frontend/src/data/pkgs \ src/frontend/src/data/ts-modules \ + src/frontend/src/data/go-modules \ src/frontend/src/data/twoslash/aspire.d.ts if git diff --cached --quiet; then diff --git a/src/frontend/config/sidebar/community.topics.ts b/src/frontend/config/sidebar/community.topics.ts index 49c15e5566..167162ffc8 100644 --- a/src/frontend/config/sidebar/community.topics.ts +++ b/src/frontend/config/sidebar/community.topics.ts @@ -22,11 +22,11 @@ export const communityTopics: StarlightSidebarTopicsUserConfig = { icon: 'heart', items: [ { - label: 'Aspire Community', + label: 'Aspire community', translations: { da: 'Aspire-fællesskab', de: 'Aspire-Gemeinschaft', - en: 'Aspire Community', + en: 'Aspire community', es: 'Comunidad de Aspire', fr: 'Communauté Aspire', hi: 'Aspire समुदाय', diff --git a/src/frontend/config/sidebar/deployment.topics.ts b/src/frontend/config/sidebar/deployment.topics.ts index 5826b9a6cf..59b6aa0b00 100644 --- a/src/frontend/config/sidebar/deployment.topics.ts +++ b/src/frontend/config/sidebar/deployment.topics.ts @@ -23,11 +23,11 @@ export const deploymentTopics: StarlightSidebarTopicsUserConfig = { icon: 'rocket', items: [ { - label: 'Aspire Deployment', + label: 'Aspire deployment', translations: { da: 'Aspire-udrulning', de: 'Aspire-Bereitstellung', - en: 'Aspire Deployment', + en: 'Aspire deployment', es: 'Despliegue de Aspire', fr: 'Déploiement Aspire', hi: 'Aspire तैनाती', diff --git a/src/frontend/config/sidebar/reference.topics.ts b/src/frontend/config/sidebar/reference.topics.ts index 5b692b24fb..e93e30c950 100644 --- a/src/frontend/config/sidebar/reference.topics.ts +++ b/src/frontend/config/sidebar/reference.topics.ts @@ -23,11 +23,11 @@ export const referenceTopics: StarlightSidebarTopicsUserConfig[number] = { icon: 'seti:json', items: [ { - label: 'Aspire Reference', + label: 'Aspire reference', translations: { da: 'Aspire-reference', de: 'Aspire-Referenz', - en: 'Aspire Reference', + en: 'Aspire reference', es: 'Referencia de Aspire', fr: 'Référence Aspire', hi: 'Aspire संदर्भ', @@ -170,6 +170,27 @@ export const referenceTopics: StarlightSidebarTopicsUserConfig[number] = { }, link: '/reference/api/typescript/', }, + { + label: 'Search Go APIs', + translations: { + da: "Søg i Go API'er", + de: 'Go APIs durchsuchen', + en: 'Search Go APIs', + es: 'Buscar API de Go', + fr: 'Rechercher les API Go', + hi: 'Go एपीआई खोजें', + id: 'Cari API Go', + it: 'Cerca API Go', + ja: 'Go APIを検索する', + ko: 'Go API 검색', + 'pt-BR': 'Pesquisar APIs Go', + ru: 'Поиск Go API', + tr: "Go API'leri Arayın", + uk: 'Пошук Go API', + 'zh-CN': '搜索 Go API', + }, + link: '/reference/api/go/', + }, ], }, { diff --git a/src/frontend/package.json b/src/frontend/package.json index fc2fe3f489..b08189923c 100644 --- a/src/frontend/package.json +++ b/src/frontend/package.json @@ -37,6 +37,7 @@ "test:unit:api-reference": "vitest run --config vitest.config.ts tests/unit/api-reference.vitest.test.ts", "test:unit:api-markdown": "vitest run --config vitest.config.ts tests/unit/api-markdown.vitest.test.ts", "test:unit:ts-api": "vitest run --config vitest.config.ts tests/unit/api-reference-routes.vitest.test.ts tests/unit/browser-storage.vitest.test.ts tests/unit/locale-routes.vitest.test.ts tests/unit/ts-api-routes.vitest.test.ts tests/unit/ts-api-search.vitest.test.ts tests/unit/ts-api-sidebar.vitest.test.ts", + "test:unit:go-api": "vitest run --config vitest.config.ts tests/unit/api-reference-routes.vitest.test.ts tests/unit/browser-storage.vitest.test.ts tests/unit/locale-routes.vitest.test.ts tests/unit/go-api-routes.vitest.test.ts tests/unit/go-api-route-catalog.vitest.test.ts tests/unit/go-api-search.vitest.test.ts tests/unit/go-api-sidebar.vitest.test.ts tests/unit/go-api-markdown.vitest.test.ts tests/unit/go-modules.vitest.test.ts tests/unit/go-modules-cache.vitest.test.ts tests/unit/go-member-card.vitest.test.ts tests/unit/go-doc-text.vitest.test.ts tests/unit/go-doc-refs.vitest.test.ts tests/unit/go-doc-text-component.vitest.test.ts", "test:unit:twoslash-types": "vitest run --config vitest.config.ts tests/unit/twoslash-types-generator.vitest.test.ts", "test:unit:twoslash-blocks": "vitest run --config vitest.config.ts tests/unit/twoslash-blocks.vitest.test.ts", "test:unit:contracts": "vitest run --config vitest.config.ts tests/unit/analytics-script-contracts.vitest.test.ts tests/unit/redirects.vitest.test.ts", @@ -57,6 +58,7 @@ "update:schemas": "tsx ./scripts/update-schemas.ts", "update:integrations": "tsx ./scripts/update-integrations.ts", "update:ts-api": "tsx ./scripts/update-ts-api.ts", + "update:go-api": "tsx ./scripts/update-go-api.ts", "update:github-stats": "tsx ./scripts/update-github-stats.ts", "update:release-contributors": "tsx ./scripts/update-release-contributors.ts", "update:samples": "tsx ./scripts/update-samples.ts", diff --git a/src/frontend/scripts/normalize-generated-api-data.ts b/src/frontend/scripts/normalize-generated-api-data.ts index 10332bdbf2..a4ab2c8616 100644 --- a/src/frontend/scripts/normalize-generated-api-data.ts +++ b/src/frontend/scripts/normalize-generated-api-data.ts @@ -1,9 +1,10 @@ /** * normalize-generated-api-data.ts — Enforces Aspire terminology in the generated - * C#/TypeScript API reference JSON (`src/data/pkgs/*.json`, `src/data/ts-modules/*.json`). + * C#/TypeScript/Go API reference JSON (`src/data/pkgs/*.json`, `src/data/ts-modules/*.json`, + * `src/data/go-modules/*.json`). * - * The C# API JSON is produced by the .NET `PackageJsonGenerator`; the TS API JSON - * by `AtsJsonGenerator`. Both copy XML/JSDoc documentation text verbatim from the + * The C# API JSON is produced by the .NET `PackageJsonGenerator`; the TS and Go API + * JSON by `AtsJsonGenerator`. All copy XML/JSDoc documentation text verbatim from the * upstream packages, so deprecated Aspire terminology leaks into the committed * data and trips the Forbidden Words CI check (see `.github/forbidden-words.json`). * This pass rewrites only prose fields, reusing the single source of truth in @@ -18,9 +19,10 @@ * escaped string content yields exactly the correctly-escaped normalized value. * * Usage: - * tsx ./scripts/normalize-generated-api-data.ts # both areas + * tsx ./scripts/normalize-generated-api-data.ts # all areas * tsx ./scripts/normalize-generated-api-data.ts --pkgs # C# API only * tsx ./scripts/normalize-generated-api-data.ts --ts-modules # TS API only + * tsx ./scripts/normalize-generated-api-data.ts --go-modules # Go API only */ import fs from 'fs'; @@ -33,6 +35,7 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url)); const DATA_DIR = path.resolve(__dirname, '..', 'src', 'data'); export const PKGS_DIR = path.join(DATA_DIR, 'pkgs'); export const TS_MODULES_DIR = path.join(DATA_DIR, 'ts-modules'); +export const GO_MODULES_DIR = path.join(DATA_DIR, 'go-modules'); // Per-line matcher (multiline) for EITHER a documentation node's `kind` marker // OR a prose string field. Groups: @@ -133,7 +136,8 @@ export function normalizeApiDir(dir: string): { function main(): void { const args = process.argv.slice(2); - const explicit = args.includes('--pkgs') || args.includes('--ts-modules'); + const explicit = + args.includes('--pkgs') || args.includes('--ts-modules') || args.includes('--go-modules'); const targets: Array<{ label: string; dir: string }> = []; if (!explicit || args.includes('--pkgs')) { targets.push({ @@ -151,6 +155,14 @@ function main(): void { : TS_MODULES_DIR, }); } + if (!explicit || args.includes('--go-modules')) { + targets.push({ + label: 'go-modules', + dir: process.env.ASPIRE_API_GO_MODULES_DIR + ? path.resolve(process.env.ASPIRE_API_GO_MODULES_DIR) + : GO_MODULES_DIR, + }); + } let total = 0; for (const { label, dir } of targets) { diff --git a/src/frontend/scripts/update-go-api.ts b/src/frontend/scripts/update-go-api.ts new file mode 100644 index 0000000000..8cdf20fde8 --- /dev/null +++ b/src/frontend/scripts/update-go-api.ts @@ -0,0 +1,107 @@ +/** + * update-go-api.ts — Regenerates Go API reference data. + * + * Runs the AtsJsonGenerator tool in Go mode against the aspire sdk dump output. + * Requires: dotnet SDK and aspire CLI. + * Set ASPIRE_CLI_PATH to use an installed Aspire CLI that is not on PATH. + * + * By default, reads the generated C# package JSON files and generates + * data for the matching Aspire.Hosting* and CommunityToolkit.Aspire.Hosting* + * package/version sets, the same sets that update-ts-api.ts generates. + * + * Optionally pass an Aspire repo clone path to discover packages from source: + * tsx ./scripts/update-go-api.ts /path/to/aspire + * ASPIRE_REPO_PATH=../../../aspire tsx ./scripts/update-go-api.ts + * + * Usage: + * tsx ./scripts/update-go-api.ts # auto-detect from C# package JSON + * tsx ./scripts/update-go-api.ts /path/aspire # from repo clone + */ + +import { execFileSync } from 'child_process'; +import { existsSync } from 'fs'; +import { dirname, resolve } from 'path'; +import { fileURLToPath } from 'url'; + +import { GO_MODULES_DIR, normalizeApiDir } from './normalize-generated-api-data'; + +const __dirname = dirname(fileURLToPath(import.meta.url)); +// The generator script serves both languages; -Language selects the output. +const SCRIPT_PATH = resolve( + __dirname, + '..', + '..', + 'tools', + 'AtsJsonGenerator', + 'generate-ts-api-json.ps1' +); + +function getErrorMessage(error: unknown): string { + return error instanceof Error ? error.message : String(error); +} + +function checkPrerequisite(cmd: string, args: string[], name: string): boolean { + try { + execFileSync(cmd, args, { stdio: 'pipe' }); + return true; + } catch { + console.error(`❌ ${name} not found. Please install it first.`); + return false; + } +} + +function main(): void { + const aspireRepoPath = process.argv[2] ?? process.env.ASPIRE_REPO_PATH; + const aspireCliPath = process.env.ASPIRE_CLI_PATH?.trim() || 'aspire'; + + if (!checkPrerequisite('dotnet', ['--version'], 'dotnet SDK')) { + process.exit(1); + } + if (!checkPrerequisite(aspireCliPath, ['--version'], 'Aspire CLI')) { + process.exit(1); + } + + const psArgs = [ + '-NoProfile', + '-ExecutionPolicy', + 'Bypass', + '-File', + SCRIPT_PATH, + '-Language', + 'go', + ]; + if (aspireRepoPath) { + const resolvedPath = resolve(aspireRepoPath); + if (!existsSync(resolvedPath)) { + console.error(`❌ Aspire repo not found at: ${resolvedPath}`); + process.exit(1); + } + console.log(`🔄 Generating Go API reference data from ${resolvedPath}...`); + psArgs.push('-AspireRepoPath', resolvedPath); + } else { + console.log('🔄 Generating Go API reference data from installed Aspire CLI...'); + } + + const outputDir = process.env.ASPIRE_API_GO_MODULES_DIR + ? resolve(process.env.ASPIRE_API_GO_MODULES_DIR) + : GO_MODULES_DIR; + if (process.env.ASPIRE_API_GO_MODULES_DIR) { + psArgs.push('-OutputDir', outputDir); + } + + try { + execFileSync('pwsh', psArgs, { stdio: 'inherit', cwd: resolve(__dirname, '..') }); + console.log('✅ Go API reference data updated.'); + } catch (error: unknown) { + console.error('❌ Generation failed:', getErrorMessage(error)); + process.exit(1); + } + + // The generated JSON copies upstream XML documentation verbatim, so enforce + // Aspire terminology before it is committed (see normalize-generated-api-data.ts). + console.log('🔄 Normalizing Aspire terminology in go-modules JSON...'); + const { changes } = normalizeApiDir(outputDir); + console.log(`✅ Normalized ${changes} occurrence(s) in go-modules JSON.`); +} + +main(); diff --git a/src/frontend/scripts/update-integration-data.ps1 b/src/frontend/scripts/update-integration-data.ps1 index 223557dcd1..227130a053 100644 --- a/src/frontend/scripts/update-integration-data.ps1 +++ b/src/frontend/scripts/update-integration-data.ps1 @@ -5,7 +5,7 @@ .DESCRIPTION Refreshes the aspire.dev integration data and, when integration package - versions change, regenerates the C#/TypeScript API reference JSON and the + versions change, regenerates the C#/TypeScript/Go API reference JSON and the twoslash bundle. Replaces the former `gh aw` agentic workflow with plain, reliable scripting that runs identically in CI and locally. @@ -21,6 +21,7 @@ a. generate-package-json.ps1 -> src/data/pkgs/*.json (C# API) b. pnpm update:ts-api -> src/data/ts-modules/*.json (TS API) + chains twoslash aspire.d.ts bundle + c. pnpm update:go-api -> src/data/go-modules/*.json (Go API) 4. Semantic validation — cross-checks generated identities, provenance, DTO optionality, inheritance, options shapes, and attribute payloads. 5. Scope check — the working tree must only contain allowed data files. @@ -29,7 +30,7 @@ Exit codes: 0 success (whether or not there were changes) - 1 a required phase failed (data update/validation, TS API regen, out-of-scope diff). + 1 a required phase failed (data update/validation, TS/Go API regen, out-of-scope diff). The caller must NOT open a PR on a non-zero exit. Packages without a public API surface are reported as explicit skips. Any @@ -81,6 +82,7 @@ $AllowedPaths = @( 'src/frontend/src/assets/samples/', 'src/frontend/src/data/pkgs/', 'src/frontend/src/data/ts-modules/', + 'src/frontend/src/data/go-modules/', 'src/frontend/src/data/twoslash/aspire.d.ts' ) @@ -137,6 +139,7 @@ function Restore-ApiEnvironment { foreach ($name in @( 'ASPIRE_API_PKGS_DIR', 'ASPIRE_API_TS_MODULES_DIR', + 'ASPIRE_API_GO_MODULES_DIR', 'ASPIRE_API_TWOSLASH_FILE' )) { $previousValue = $script:PreviousApiEnvironment[$name] @@ -175,6 +178,7 @@ function Publish-GeneratedApiData { param( [Parameter(Mandatory)][string]$PackageSource, [Parameter(Mandatory)][string]$ModuleSource, + [Parameter(Mandatory)][string]$GoModuleSource, [Parameter(Mandatory)][string]$TwoslashSource ) @@ -189,6 +193,11 @@ function Publish-GeneratedApiData { Destination = Join-Path $DataDir 'ts-modules' Backup = Join-Path $script:ApiStageRoot 'backup-ts-modules' }, + [PSCustomObject]@{ + Source = $GoModuleSource + Destination = Join-Path $DataDir 'go-modules' + Backup = Join-Path $script:ApiStageRoot 'backup-go-modules' + }, [PSCustomObject]@{ Source = $TwoslashSource Destination = Join-Path $DataDir 'twoslash' 'aspire.d.ts' @@ -372,6 +381,9 @@ $tsApiSummary = '' $tsSkippedPackages = '' $tsToleratedPackages = '' $tsToleratedDiagnostics = [System.Collections.Generic.List[string]]::new() +$goApiSummary = '' +$goSkippedPackages = '' +$goToleratedPackages = '' $twoslashSummary = '' $semanticSummary = '' @@ -382,16 +394,19 @@ if ($versionsChanged -and -not $SkipRegen) { New-Item -ItemType Directory -Path $script:ApiStageRoot -Force | Out-Null $pkgStageDir = Join-Path $script:ApiStageRoot 'pkgs' $tsStageDir = Join-Path $script:ApiStageRoot 'ts-modules' + $goStageDir = Join-Path $script:ApiStageRoot 'go-modules' $twoslashStageFile = Join-Path $script:ApiStageRoot 'twoslash' 'aspire.d.ts' foreach ($name in @( 'ASPIRE_API_PKGS_DIR', 'ASPIRE_API_TS_MODULES_DIR', + 'ASPIRE_API_GO_MODULES_DIR', 'ASPIRE_API_TWOSLASH_FILE' )) { $script:PreviousApiEnvironment[$name] = [Environment]::GetEnvironmentVariable($name, 'Process') } $env:ASPIRE_API_PKGS_DIR = $pkgStageDir $env:ASPIRE_API_TS_MODULES_DIR = $tsStageDir + $env:ASPIRE_API_GO_MODULES_DIR = $goStageDir $env:ASPIRE_API_TWOSLASH_FILE = $twoslashStageFile # 3a. C# API JSON. @@ -512,7 +527,54 @@ if ($versionsChanged -and -not $SkipRegen) { $twoslashSummary = 'succeeded' - # 3c. Cross-artifact semantic validation. This runs only after every + # 3c. Go API JSON. The Go projection reads the same Aspire CLI dumps as the + # TS pass and only changes how they are rendered, so a failure here is fatal + # for the same reason: never publish a partially regenerated API reference. + Write-Host "→ pnpm update:go-api (Go API → go-modules/)" -ForegroundColor Cyan + Push-Location $FrontendDir + try { + $goLog = & pnpm run update:go-api 2>&1 | Tee-Object -Variable goTeed | Out-String + $goExit = $LASTEXITCODE + } + finally { + Pop-Location + } + if ($goExit -ne 0) { + Stop-ApiRegeneration "Go API generation failed.`n$goLog`nAborting; no PR will be opened." + } + + $goApiDone = ($goLog -split "`n" | + Where-Object { $_ -match 'Complete:\s+\d+\s+succeeded,\s+\d+\s+failed,\s+\d+\s+skipped' } | + Select-Object -First 1) + if (-not $goApiDone -or + $goApiDone -notmatch 'Complete:\s+(?\d+)\s+succeeded,\s+(?\d+)\s+failed,\s+(?\d+)\s+skipped') { + Stop-ApiRegeneration "Go API generation did not emit a valid completion summary. Aborting; no PR will be opened." + } + $goApiSummary = "$($Matches.Succeeded) succeeded, $($Matches.Failed) failed, $($Matches.Skipped) skipped" + if ([int]$Matches.Failed -gt 0) { + Stop-ApiRegeneration "Go API generation reported $($Matches.Failed) package failure(s). Aborting; no PR will be opened." + } + $goSkippedLine = ($goLog -split "`n" | + Where-Object { $_ -match '^\s*Skipped packages:' } | + Select-Object -First 1) + $goSkippedPackages = if ($goSkippedLine) { + ($goSkippedLine -replace '^\s*Skipped packages:\s*', '').Trim() + } + else { '' } + $goToleratedLine = ($goLog -split "`n" | + Where-Object { $_ -match '^\s*Packages with tolerated ATS diagnostics:' } | + Select-Object -First 1) + if ($goToleratedLine) { + $goToleratedPackages = ($goToleratedLine -replace '^\s*Packages with tolerated ATS diagnostics:\s*', '').Trim() + $goToleratedWarning = "Go modules were generated despite known ATS scanner diagnostics for: $goToleratedPackages. " + + "Their APIs may be incomplete until the Aspire CLI includes microsoft/aspire#20443; review them before merging." + Write-Warning $goToleratedWarning + if ($IsCI) { + Write-Host "::warning title=Tolerated ATS scanner diagnostics (Go)::$goToleratedWarning" + } + } + + # 3d. Cross-artifact semantic validation. This runs only after every # generator has completed and must pass before the workflow can publish. Write-Host "→ pnpm validate:api-data (semantic regression gate)" -ForegroundColor Cyan Push-Location $FrontendDir @@ -532,6 +594,7 @@ if ($versionsChanged -and -not $SkipRegen) { Publish-GeneratedApiData ` -PackageSource $pkgStageDir ` -ModuleSource $tsStageDir ` + -GoModuleSource $goStageDir ` -TwoslashSource $twoslashStageFile } catch { @@ -601,6 +664,7 @@ function Get-AreaCounts { $pkgsCounts = Get-AreaCounts -Prefix 'src/frontend/src/data/pkgs/' $tsModulesCounts = Get-AreaCounts -Prefix 'src/frontend/src/data/ts-modules/' +$goModulesCounts = Get-AreaCounts -Prefix 'src/frontend/src/data/go-modules/' $twoslashChanged = @(Invoke-Git @('diff', '--name-only', 'HEAD', '--', 'src/frontend/src/data/twoslash/aspire.d.ts') | Where-Object { $_ -and $_.Trim().Length -gt 0 }).Count -gt 0 @@ -625,7 +689,7 @@ $sb = [System.Text.StringBuilder]::new() [void]$sb.AppendLine("### API reference regeneration") [void]$sb.AppendLine("") if ($regenRan) { - [void]$sb.AppendLine("Versions changed for the following packages, so the C# and TypeScript API reference data and the twoslash bundle were regenerated:") + [void]$sb.AppendLine("Versions changed for the following packages, so the C#, TypeScript, and Go API reference data and the twoslash bundle were regenerated:") [void]$sb.AppendLine("") $shown = 0 foreach ($change in $versionChanges) { @@ -641,12 +705,14 @@ if ($regenRan) { [void]$sb.AppendLine("|---|---|---|---|") [void]$sb.AppendLine("| ``src/frontend/src/data/pkgs/**`` | $($pkgsCounts.Added) | $($pkgsCounts.Modified) | $($pkgsCounts.Removed) |") [void]$sb.AppendLine("| ``src/frontend/src/data/ts-modules/**`` | $($tsModulesCounts.Added) | $($tsModulesCounts.Modified) | $($tsModulesCounts.Removed) |") + [void]$sb.AppendLine("| ``src/frontend/src/data/go-modules/**`` | $($goModulesCounts.Added) | $($goModulesCounts.Modified) | $($goModulesCounts.Removed) |") [void]$sb.AppendLine("| ``src/frontend/src/data/twoslash/aspire.d.ts`` | — | $(if ($twoslashChanged) { 'yes' } else { 'no' }) | — |") [void]$sb.AppendLine("") [void]$sb.AppendLine("Generator summary:") [void]$sb.AppendLine("") [void]$sb.AppendLine("- C# API JSON (``generate-package-json.ps1`` → ``pkgs/``): $pkgSummary") [void]$sb.AppendLine("- TS API JSON (``update:ts-api`` → ``ts-modules/``): $tsApiSummary") + [void]$sb.AppendLine("- Go API JSON (``update:go-api`` → ``go-modules/``): $goApiSummary") [void]$sb.AppendLine("- Twoslash bundle (``twoslash/aspire.d.ts``): $twoslashSummary") [void]$sb.AppendLine("- Semantic generated-data validation: $semanticSummary") if ($pkgSkippedPackages) { @@ -655,6 +721,12 @@ if ($regenRan) { if ($tsSkippedPackages) { [void]$sb.AppendLine("- TypeScript packages skipped because they export no ATS functions: ``$tsSkippedPackages``") } + if ($goSkippedPackages) { + [void]$sb.AppendLine("- Go packages skipped because they export no ATS functions: ``$goSkippedPackages``") + } + if ($goToleratedPackages) { + [void]$sb.AppendLine("- :warning: Go modules were generated despite tolerated ATS scanner diagnostics for: ``$goToleratedPackages``") + } if ($tsToleratedPackages) { [void]$sb.AppendLine("") [void]$sb.AppendLine("### :warning: Tolerated ATS scanner diagnostics") @@ -695,11 +767,14 @@ if ($iconWarnings) { [void]$sb.AppendLine("- [ ] Package counts and versions updated appropriately") [void]$sb.AppendLine("- [ ] Official Aspire package icons still use package-specific NuGet icon URLs") if ($regenRan) { - [void]$sb.AppendLine("- [ ] New/removed ``pkgs/`` and ``ts-modules/`` files match the version changes") + [void]$sb.AppendLine("- [ ] New/removed ``pkgs/``, ``ts-modules/``, and ``go-modules/`` files match the version changes") [void]$sb.AppendLine("- [ ] ``src/frontend/src/data/twoslash/aspire.d.ts`` is included in the diff") if ($tsToleratedPackages) { [void]$sb.AppendLine("- [ ] TypeScript modules generated with tolerated ATS scanner diagnostics were reviewed") } + if ($goToleratedPackages) { + [void]$sb.AppendLine("- [ ] Go modules generated with tolerated ATS scanner diagnostics were reviewed") + } } $prBody = $sb.ToString() diff --git a/src/frontend/src/components/api-reference/GoDocText.astro b/src/frontend/src/components/api-reference/GoDocText.astro new file mode 100644 index 0000000000..4bbbf90316 --- /dev/null +++ b/src/frontend/src/components/api-reference/GoDocText.astro @@ -0,0 +1,77 @@ +--- +/** + * GoDocText — renders a Go API description with its inline markup: `code` spans, + * references to other API items and external links. The accepted markup is + * documented in go-doc-text.ts. + * + * Text segments carry their own whitespace, so the map below must stay the only + * expression: the Astro compiler trims whitespace between an expression and the text + * beside it, which would join the words around each code span. + */ +import ReadableText from '@components/ReadableText.astro'; +import { resolveGoDocRef } from '@utils/go-doc-refs'; +import { parseGoDocText } from '@utils/go-doc-text'; +import { goModuleHref, type GoApiDocument } from '@utils/go-modules'; + +interface Props { + text: string; + /** Module whose pages references resolve against; without it references render as plain code. */ + module?: GoApiDocument; + base?: string; + /** Turn off inside another link, where a nested anchor is invalid; references keep their Go name. */ + link?: boolean; +} + +const { text, module, base = '', link = true } = Astro.props; + +const nodes = parseGoDocText(text).map((segment) => { + if (segment.kind !== 'ref') { + return segment; + } + + const target = module ? resolveGoDocRef(module, segment.refKind, segment.target) : undefined; + return { + kind: 'ref' as const, + label: target?.label ?? segment.label, + href: + link && module && target + ? `${goModuleHref(base, module.package.name)}${target.path}` + : undefined, + }; +}); +--- + +{ + nodes.map((node) => { + switch (node.kind) { + case 'text': + return node.text; + case 'code': + return ( + + + + ); + case 'ref': + return node.href ? ( + + + + + + ) : ( + + + + ); + case 'link': + return link ? ( + + {node.text} + + ) : ( + node.text + ); + } + }) +} diff --git a/src/frontend/src/components/api-reference/GoMemberCard.astro b/src/frontend/src/components/api-reference/GoMemberCard.astro new file mode 100644 index 0000000000..a731747525 --- /dev/null +++ b/src/frontend/src/components/api-reference/GoMemberCard.astro @@ -0,0 +1,308 @@ +--- +/** + * GoMemberCard — renders a single Go callable, property or struct field. + * + * Mirrors the MemberCardBase layout (header, description, signature, parameters, + * returns) and adds the two pieces only Go has: the trailing options struct and the + * error model. MemberCardBase is shared by the C# and TypeScript references, so the + * Go card lives beside it instead of widening that component. + */ +import { Code } from '@astrojs/starlight/components'; +import ReadableText from '@components/ReadableText.astro'; +import { + describeGoErrorModel, + formatGoSignature, + getGoOptionsParameterName, + type GoApiDocument, + type GoCallableOptions, + type GoFunctionParameter, +} from '@utils/go-modules'; +import GoDocText from './GoDocText.astro'; + +interface CardMember { + name: string; + description?: string | null; + signature?: string | null; + parameters?: GoFunctionParameter[]; + options?: GoCallableOptions | null; + /** Result type of a callable, or the value type of a property or field. */ + returnType?: string | null; + returns?: string | null; + errorModel?: string; + returnsBuilder?: boolean; +} + +interface Props { + member: CardMember; + variant?: 'method' | 'function' | 'property' | 'field'; + /** Replaces the kind pill text, e.g. `method` or `function` on a standalone function page. */ + kindLabel?: string; + /** Makes the member name a link. */ + href?: string | null; + /** Modifier badges such as `get · set`, `optional` or `callback`. */ + badges?: string[]; + /** Further signatures shown under the primary one, such as a property's setter. */ + relatedSignatures?: string[]; + /** Module whose pages references in descriptions link to. */ + module?: GoApiDocument; + base?: string; +} + +const { + member, + variant = 'method', + kindLabel: kindLabelOverride, + href, + badges: extraBadges = [], + relatedSignatures = [], + module, + base, +} = Astro.props; + +/** Simple string hash → 0–3 for type color assignment. */ +function typeColorIndex(s: string): number { + let h = 0; + for (const c of s) h = (h * 31 + c.charCodeAt(0)) | 0; + return Math.abs(h) % 4; +} + +const isCallable = variant === 'method' || variant === 'function'; +const kindLabel = variant === 'field' ? undefined : (kindLabelOverride ?? variant); +const kindClass = + variant === 'property' ? 'kind-property' : variant === 'field' ? 'kind-field' : 'kind-method'; +const badges = [...(member.returnsBuilder ? ['builder'] : []), ...extraBadges]; + +// A property is a getter plus an optional setter in Go, so show both accessor signatures. +const signatureCode = + variant === 'field' + ? '' + : [member.signature, ...relatedSignatures] + .filter((signature): signature is string => Boolean(signature)) + .map(formatGoSignature) + .join('\n'); + +const parameters: { name: string; type: string; description?: string | null; isCallback?: boolean }[] = isCallable + ? (member.parameters ?? []).map((parameter) => ({ + name: parameter.name, + type: parameter.type ?? 'any', + description: parameter.description, + isCallback: parameter.isCallback, + })) + : []; +const options = isCallable ? member.options : undefined; +if (options?.typeName) { + parameters.push({ + name: getGoOptionsParameterName({ signature: member.signature ?? undefined, options }), + type: `...*${options.typeName}`, + description: 'Optional settings, described under Options.', + }); +} + +const optionFields = options?.fields ?? []; +const returnType = member.returnType?.trim() || undefined; +const returnTypeColorIdx = returnType ? typeColorIndex(returnType) : 0; +const showReturnInHeader = !isCallable && returnType !== undefined; +const hasReturnSection = isCallable && (returnType !== undefined || member.errorModel !== undefined); + +// describeGoErrorModel quotes code with backticks; odd segments after splitting are code. +const errorModelSegments = + hasReturnSection && member.errorModel !== undefined + ? describeGoErrorModel({ errorModel: member.errorModel, returnType }).split('`') + : []; +--- + +
+ {/* Header */} +
+ {kindLabel && {kindLabel}} + { + href ? ( + + + + ) : ( + + ) + } + { + showReturnInHeader && returnType && ( + + + + ) + } + {badges.map((badge) => {badge})} +
+ + {/* Description */} + {member.description &&
} + + {/* Signature, in Go syntax without the `func` keyword */} + { + signatureCode && ( +
+ +
+ ) + } + + {/* Parameters: required parameters plus the trailing options struct */} + { + parameters.length > 0 && ( +
+ +
+ {parameters.map((parameter) => ( +
+ + + + + + {parameter.isCallback && callback} + + {parameter.description && ( + + )} +
+ ))} +
+
+ ) + } + + {/* Options: fields of the trailing options struct */} + { + options?.typeName && ( +
+ + {options.isDirect ? ( +

+ Optional parameters are passed as the existing *{options.typeName} struct. +

+ ) : ( +

+ Optional parameters are passed in a trailing{' '} + {getGoOptionsParameterName({ signature: member.signature ?? undefined, options })} ...*{options.typeName}{' '} + argument. +

+ )} + {optionFields.length > 0 && ( +
+ {optionFields.map((field) => { + const fieldType = field.isCallback && field.callbackSignature ? field.callbackSignature : (field.type ?? 'any'); + return ( +
+ + + + + + {field.isCallback && callback} + + {field.description && ( + + )} +
+ ); + })} +
+ )} +
+ ) + } + + {/* Returns: result type, its description and the error model */} + { + hasReturnSection && ( +
+ +
+ {returnType && ( + + + + )} + {member.returns &&

} + {errorModelSegments.length > 0 && ( +

+ {errorModelSegments.map((segment, index) => (index % 2 === 1 ? {segment} : segment))} +

+ )} +
+
+ ) + } +
+ + diff --git a/src/frontend/src/components/api-reference/search-lifecycle.ts b/src/frontend/src/components/api-reference/search-lifecycle.ts index a0a0856c39..0156a02f88 100644 --- a/src/frontend/src/components/api-reference/search-lifecycle.ts +++ b/src/frontend/src/components/api-reference/search-lifecycle.ts @@ -1,4 +1,4 @@ -type ApiSearchLanguage = 'csharp' | 'typescript'; +type ApiSearchLanguage = 'csharp' | 'typescript' | 'go'; type ApiSearchPageKind = 'landing' | 'package' | 'module' | 'type' | 'item'; /** diff --git a/src/frontend/src/components/starlight/Search.astro b/src/frontend/src/components/starlight/Search.astro index 0ee3da93cc..c940f254eb 100644 --- a/src/frontend/src/components/starlight/Search.astro +++ b/src/frontend/src/components/starlight/Search.astro @@ -3,6 +3,7 @@ import DefaultSearch from "@astrojs/starlight/components/Search.astro"; import { Image } from 'astro:assets'; import csharpIcon from '@assets/icons/csharp.svg'; import typescriptIcon from '@assets/icons/typescript.svg'; +import goIcon from '@assets/icons/go.svg'; import '../../styles/search-controls.css'; const routeData = Astro.locals.starlightRoute; @@ -12,6 +13,7 @@ const hideSearch = isApiRefPage; const base = import.meta.env.BASE_URL.replace(/\/$/, ''); const csharpHref = `${base}/reference/api/csharp/`; const typescriptHref = `${base}/reference/api/typescript/`; +const goHref = `${base}/reference/api/go/`; --- { hideSearch ? <> : } @@ -40,6 +42,16 @@ const typescriptHref = `${base}/reference/api/typescript/`; TypeScript API Reference + + + Go API Reference + diff --git a/src/frontend/src/components/starlight/Sidebar.astro b/src/frontend/src/components/starlight/Sidebar.astro index b6f3eaeffe..6e3c74f42e 100644 --- a/src/frontend/src/components/starlight/Sidebar.astro +++ b/src/frontend/src/components/starlight/Sidebar.astro @@ -17,7 +17,9 @@ const apiLang = pageId.startsWith('reference/api/typescript') ? 'ts' : pageId.startsWith('reference/api/csharp') ? 'csharp' - : undefined; + : pageId.startsWith('reference/api/go') + ? 'go' + : undefined; const sidebar = routeData?.sidebar ?? []; const topics = topicState?.topics ?? []; diff --git a/src/frontend/src/content.config.ts b/src/frontend/src/content.config.ts index b978059d15..47cc487198 100644 --- a/src/frontend/src/content.config.ts +++ b/src/frontend/src/content.config.ts @@ -150,4 +150,30 @@ export const collections = { }) .passthrough(), }), + + /** + * Go API module schemas — drop `{Package}.{version}.json` files into + * `src/data/go-modules/` and the Go API reference pages are generated + * automatically. + */ + goModules: defineCollection({ + loader: glob({ pattern: '**/*.json', base: './src/data/go-modules' }), + schema: z + .object({ + package: z.object({ + name: z.string(), + version: z.string().optional(), + language: z.string().optional(), + importPath: z.string().optional(), + sourceRepository: z.string().optional(), + sourceCommit: z.string().optional(), + }), + functions: z.array(z.any()).default([]), + handleTypes: z.array(z.any()).default([]), + dtoTypes: z.array(z.any()).default([]), + enumTypes: z.array(z.any()).default([]), + exportedValues: z.array(z.any()).default([]), + }) + .passthrough(), + }), }; diff --git a/src/frontend/src/content/docs/reference/overview.mdx b/src/frontend/src/content/docs/reference/overview.mdx index f528bc29f9..ba79126158 100644 --- a/src/frontend/src/content/docs/reference/overview.mdx +++ b/src/frontend/src/content/docs/reference/overview.mdx @@ -1,5 +1,5 @@ --- -title: Aspire Reference +title: Aspire reference seoTitle: 'Aspire reference: APIs, CLI, and packages' prev: link: /deployment/ @@ -237,6 +237,15 @@ Use the `aspire docs` and `aspire docs api` command groups to browse, search, an label: 'Search TypeScript APIs', accent: 'blue', }, + { + icon: 'seti:go', + title: 'Search Go APIs', + description: + 'Explore the Go AppHost API surface for Aspire — modules, functions, resource handles, DTOs, and enums. Searchable and cross-referenced for easy discovery.', + href: '/reference/api/go/', + label: 'Search Go APIs', + accent: 'green', + }, { icon: 'setting', title: 'CLI configuration', diff --git a/src/frontend/src/data/dev-hub.ts b/src/frontend/src/data/dev-hub.ts index 9c66a78117..9e2f9bd775 100644 --- a/src/frontend/src/data/dev-hub.ts +++ b/src/frontend/src/data/dev-hub.ts @@ -34,6 +34,7 @@ export const languages = [ export const referenceLinks = [ { title: 'CLI commands', description: 'Create, run, deploy, and troubleshoot from your terminal.', href: '/reference/cli/overview/', icon: 'seti:powershell' }, { title: 'TypeScript API', description: 'Explore the AppHost modules, functions, and resource types.', href: '/reference/api/typescript/', icon: 'seti:typescript' }, + { title: 'Go API', description: 'Explore the Go AppHost modules, functions, and resource types.', href: '/reference/api/go/', icon: 'seti:go' }, { title: 'C# API', description: 'Find packages, types, methods, and extension APIs.', href: '/reference/api/csharp/', icon: 'seti:c-sharp' }, { title: 'Container images', description: 'Find the images and tags used by Aspire integrations.', href: '/reference/container-images/', icon: 'seti:docker' }, { title: 'Diagnostics', description: 'Look up a diagnostic code and how to resolve it.', href: '/diagnostics/overview/', icon: 'seti:config' }, diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.13.6.0.json new file mode 100644 index 0000000000..b234322df0 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.13.6.0.json @@ -0,0 +1,30201 @@ +{ + "package": { + "name": "Aspire.Hosting", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Publishing/AfterPublishEvent.model", + "qualifiedName": "AfterPublishEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "AfterPublishEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.AfterPublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.AfterPublishEvent" + ], + "appliesTo": [ + "AfterPublishEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Publishing/AfterPublishEvent.services", + "qualifiedName": "AfterPublishEvent.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "AfterPublishEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.AfterPublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.AfterPublishEvent" + ], + "appliesTo": [ + "AfterPublishEvent" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/AfterResourcesCreatedEvent.model", + "qualifiedName": "AfterResourcesCreatedEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "AfterResourcesCreatedEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent" + ], + "appliesTo": [ + "AfterResourcesCreatedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/AfterResourcesCreatedEvent.services", + "qualifiedName": "AfterResourcesCreatedEvent.services", + "description": "The `IServiceProvider` instance.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "AfterResourcesCreatedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent" + ], + "appliesTo": [ + "AfterResourcesCreatedEvent" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Publishing/BeforePublishEvent.model", + "qualifiedName": "BeforePublishEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "BeforePublishEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.BeforePublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.BeforePublishEvent" + ], + "appliesTo": [ + "BeforePublishEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Publishing/BeforePublishEvent.services", + "qualifiedName": "BeforePublishEvent.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "BeforePublishEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.BeforePublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.BeforePublishEvent" + ], + "appliesTo": [ + "BeforePublishEvent" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeResourceStartedEvent.resource", + "qualifiedName": "BeforeResourceStartedEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "BeforeResourceStartedEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent" + ], + "appliesTo": [ + "BeforeResourceStartedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeResourceStartedEvent.services", + "qualifiedName": "BeforeResourceStartedEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "BeforeResourceStartedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent" + ], + "appliesTo": [ + "BeforeResourceStartedEvent" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeStartEvent.model", + "qualifiedName": "BeforeStartEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "BeforeStartEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeStartEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeStartEvent" + ], + "appliesTo": [ + "BeforeStartEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeStartEvent.services", + "qualifiedName": "BeforeStartEvent.services", + "description": "The `IServiceProvider` instance.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "BeforeStartEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeStartEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeStartEvent" + ], + "appliesTo": [ + "BeforeStartEvent" + ] + }, + { + "name": "Args", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.args", + "qualifiedName": "CommandLineArgsCallbackContext.args", + "description": "Gets the editor used to manipulate command-line arguments in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Args() CommandLineArgsEditor", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "CommandLineArgsEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.executionContext", + "qualifiedName": "CommandLineArgsCallbackContext.executionContext", + "description": "Gets the execution context associated with this callback.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.log", + "qualifiedName": "CommandLineArgsCallbackContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.resource", + "qualifiedName": "CommandLineArgsCallbackContext.resource", + "description": "The resource associated with this callback context.", + "remarks": "This will be set to the resource in all cases where Aspire invokes the callback.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "Add", + "capabilityId": "Aspire.Hosting.ApplicationModel/add", + "qualifiedName": "CommandLineArgsEditor.add", + "description": "Adds a command-line argument.", + "kind": "InstanceMethod", + "signature": "Add(value any) error", + "receiver": "CommandLineArgsEditor", + "parameters": [ + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression", + "EndpointReference", + "ParameterResource", + "ResourceWithConnectionString", + "ExpressionValue" + ], + "description": "The argument to add." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsEditor" + ], + "appliesTo": [ + "CommandLineArgsEditor" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ConnectionStringAvailableEvent.resource", + "qualifiedName": "ConnectionStringAvailableEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ConnectionStringAvailableEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent" + ], + "appliesTo": [ + "ConnectionStringAvailableEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ConnectionStringAvailableEvent.services", + "qualifiedName": "ConnectionStringAvailableEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ConnectionStringAvailableEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent" + ], + "appliesTo": [ + "ConnectionStringAvailableEvent" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.cancellationToken", + "qualifiedName": "ContainerBuildOptionsCallbackContext.cancellationToken", + "description": "Gets the cancellation token.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Destination", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.destination", + "qualifiedName": "ContainerBuildOptionsCallbackContext.destination", + "description": "Gets or sets the destination for the container image.", + "kind": "PropertyGetter", + "signature": "Destination() (*ContainerImageDestination, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*ContainerImageDestination, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.executionContext", + "qualifiedName": "ContainerBuildOptionsCallbackContext.executionContext", + "description": "Gets the distributed application execution context.", + "remarks": "Use `IsPublishMode` or\n`IsRunMode` to vary build options\n(for example `TargetPlatform`) between local run and publish operations.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "ImageFormat", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.imageFormat", + "qualifiedName": "ContainerBuildOptionsCallbackContext.imageFormat", + "description": "Gets or sets the container image format.", + "kind": "PropertyGetter", + "signature": "ImageFormat() (*ContainerImageFormat, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*ContainerImageFormat, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "LocalImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.localImageName", + "qualifiedName": "ContainerBuildOptionsCallbackContext.localImageName", + "description": "Gets or sets the local image name for the built container.", + "kind": "PropertyGetter", + "signature": "LocalImageName() (*string, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "LocalImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.localImageTag", + "qualifiedName": "ContainerBuildOptionsCallbackContext.localImageTag", + "description": "Gets or sets the local image tag for the built container.", + "kind": "PropertyGetter", + "signature": "LocalImageTag() (*string, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.logger", + "qualifiedName": "ContainerBuildOptionsCallbackContext.logger", + "description": "Gets the logger instance.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "OutputPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.outputPath", + "qualifiedName": "ContainerBuildOptionsCallbackContext.outputPath", + "description": "Gets or sets the output path for the container archive.", + "remarks": "For .NET SDK publishing, a non-existent path with any filename extension is an archive filename.\nEnd a directory path with the platform's directory separator to make directory intent explicit,\nespecially when its name contains a period. Prefer an explicit archive filename to avoid ambiguity.\nOther container image builders may interpret this path as an output directory.", + "kind": "PropertyGetter", + "signature": "OutputPath() (*string, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.resource", + "qualifiedName": "ContainerBuildOptionsCallbackContext.resource", + "description": "Gets the resource being built.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.services", + "qualifiedName": "ContainerBuildOptionsCallbackContext.services", + "description": "Gets the service provider.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetDestination", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setDestination", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setDestination", + "description": "Gets or sets the destination for the container image.", + "kind": "PropertySetter", + "signature": "SetDestination(value *ContainerImageDestination) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*ContainerImageDestination", + "description": "Gets or sets the destination for the container image." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetImageFormat", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setImageFormat", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setImageFormat", + "description": "Gets or sets the container image format.", + "kind": "PropertySetter", + "signature": "SetImageFormat(value *ContainerImageFormat) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*ContainerImageFormat", + "description": "Gets or sets the container image format." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetLocalImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setLocalImageName", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setLocalImageName", + "description": "Gets or sets the local image name for the built container.", + "kind": "PropertySetter", + "signature": "SetLocalImageName(value *string) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the local image name for the built container." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetLocalImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setLocalImageTag", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setLocalImageTag", + "description": "Gets or sets the local image tag for the built container.", + "kind": "PropertySetter", + "signature": "SetLocalImageTag(value *string) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the local image tag for the built container." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetOutputPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setOutputPath", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setOutputPath", + "description": "Gets or sets the output path for the container archive.", + "remarks": "For .NET SDK publishing, a non-existent path with any filename extension is an archive filename.\nEnd a directory path with the platform's directory separator to make directory intent explicit,\nespecially when its name contains a period. Prefer an explicit archive filename to avoid ambiguity.\nOther container image builders may interpret this path as an output directory.", + "kind": "PropertySetter", + "signature": "SetOutputPath(value *string) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the output path for the container archive." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetTargetPlatform", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setTargetPlatform", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setTargetPlatform", + "description": "Gets or sets the target platform for the container.", + "kind": "PropertySetter", + "signature": "SetTargetPlatform(value *ContainerTargetPlatform) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*ContainerTargetPlatform", + "description": "Gets or sets the target platform for the container." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "TargetPlatform", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.targetPlatform", + "qualifiedName": "ContainerBuildOptionsCallbackContext.targetPlatform", + "description": "Gets or sets the target platform for the container.", + "kind": "PropertyGetter", + "signature": "TargetPlatform() (*ContainerTargetPlatform, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*ContainerTargetPlatform, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerFileSystemCallbackContext.model", + "qualifiedName": "ContainerFileSystemCallbackContext.model", + "description": "The app model resource the callback is associated with.", + "kind": "PropertyGetter", + "signature": "Model() Resource", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerFileSystemCallbackContext.services", + "qualifiedName": "ContainerFileSystemCallbackContext.services", + "description": "A `IServiceProvider` that can be used to resolve services in the callback.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "RemoteImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.remoteImageName", + "qualifiedName": "ContainerImagePushOptions.remoteImageName", + "description": "Gets or sets the remote image name (repository path without registry endpoint or tag).", + "kind": "PropertyGetter", + "signature": "RemoteImageName() (*string, error)", + "receiver": "ContainerImagePushOptions", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "RemoteImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.remoteImageTag", + "qualifiedName": "ContainerImagePushOptions.remoteImageTag", + "description": "Gets or sets the remote image tag.", + "kind": "PropertyGetter", + "signature": "RemoteImageTag() (*string, error)", + "receiver": "ContainerImagePushOptions", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "SetRemoteImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.setRemoteImageName", + "qualifiedName": "ContainerImagePushOptions.setRemoteImageName", + "description": "Gets or sets the remote image name (repository path without registry endpoint or tag).", + "kind": "PropertySetter", + "signature": "SetRemoteImageName(value *string) ContainerImagePushOptions", + "receiver": "ContainerImagePushOptions", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the remote image name (repository path without registry endpoint or tag)." + } + ], + "returnType": "ContainerImagePushOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "SetRemoteImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.setRemoteImageTag", + "qualifiedName": "ContainerImagePushOptions.setRemoteImageTag", + "description": "Gets or sets the remote image tag.", + "kind": "PropertySetter", + "signature": "SetRemoteImageTag(value *string) ContainerImagePushOptions", + "receiver": "ContainerImagePushOptions", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the remote image tag." + } + ], + "returnType": "ContainerImagePushOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptionsCallbackContext.cancellationToken", + "qualifiedName": "ContainerImagePushOptionsCallbackContext.cancellationToken", + "description": "Gets the cancellation token to observe while configuring image push options.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ContainerImagePushOptionsCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerImagePushOptionsCallbackContext" + ] + }, + { + "name": "Options", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptionsCallbackContext.options", + "qualifiedName": "ContainerImagePushOptionsCallbackContext.options", + "description": "Gets the container image push options that can be modified by the callback.", + "kind": "PropertyGetter", + "signature": "Options() ContainerImagePushOptions", + "receiver": "ContainerImagePushOptionsCallbackContext", + "parameters": [], + "returnType": "ContainerImagePushOptions", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerImagePushOptionsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptionsCallbackContext.resource", + "qualifiedName": "ContainerImagePushOptionsCallbackContext.resource", + "description": "Gets the resource being configured for container image push operations.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerImagePushOptionsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerImagePushOptionsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImageReference.resource", + "qualifiedName": "ContainerImageReference.resource", + "description": "Gets the resource that this container image is associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerImageReference", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImageReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImageReference" + ], + "appliesTo": [ + "ContainerImageReference" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImageReference.valueExpression", + "qualifiedName": "ContainerImageReference.valueExpression", + "description": "Gets the ValueExpression property", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "ContainerImageReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImageReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImageReference" + ], + "appliesTo": [ + "ContainerImageReference" + ] + }, + { + "name": "IsReadOnly", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.isReadOnly", + "qualifiedName": "ContainerMountAnnotation.isReadOnly", + "description": "Gets a value indicating whether the volume mount is read-only.", + "kind": "PropertyGetter", + "signature": "IsReadOnly() (bool, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.source", + "qualifiedName": "ContainerMountAnnotation.source", + "description": "Gets the source of the bind mount or name if a volume. Can be `null` if the mount is an anonymous volume.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.target", + "qualifiedName": "ContainerMountAnnotation.target", + "description": "Gets the target of the mount.", + "kind": "PropertyGetter", + "signature": "Target() (string, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Type", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.type", + "qualifiedName": "ContainerMountAnnotation.type", + "description": "Gets the type of the mount.", + "kind": "PropertyGetter", + "signature": "Type() (ContainerMountType, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(ContainerMountType, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerPortReference.resource", + "qualifiedName": "ContainerPortReference.resource", + "description": "Gets the resource that this container port is associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerPortReference", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerPortReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerPortReference" + ], + "appliesTo": [ + "ContainerPortReference" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerPortReference.valueExpression", + "qualifiedName": "ContainerPortReference.valueExpression", + "description": "Gets the ValueExpression property", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "ContainerPortReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerPortReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerPortReference" + ], + "appliesTo": [ + "ContainerPortReference" + ] + }, + { + "name": "Run", + "capabilityId": "Aspire.Hosting/run", + "qualifiedName": "DistributedApplication.run", + "description": "Runs the distributed application", + "remarks": "When the Aspire AppHost is launched via `RunAsync` there are\ntwo possible modes that it is running in:\n-\n-\nDevelopers extending the Aspire application model should consider the lifetime\nof `IHostedService` instances which are added to the dependency injection\ncontainer. For more information on determining the mode that the AppHost is running\nin refer to `DistributedApplicationExecutionContext`.", + "returns": "The `Task` that represents the asynchronous operation.", + "kind": "InstanceMethod", + "signature": "Run(options ...*RunOptions) error", + "receiver": "DistributedApplication", + "parameters": [], + "options": { + "typeName": "RunOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The token to trigger shutdown." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplication", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplication" + ], + "appliesTo": [ + "DistributedApplication" + ] + }, + { + "name": "IsPublishMode", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.isPublishMode", + "qualifiedName": "DistributedApplicationExecutionContext.isPublishMode", + "description": "Returns true if the current operation is publishing.", + "kind": "PropertyGetter", + "signature": "IsPublishMode() (bool, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "IsRunMode", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.isRunMode", + "qualifiedName": "DistributedApplicationExecutionContext.isRunMode", + "description": "Returns true if the current operation is running.", + "kind": "PropertyGetter", + "signature": "IsRunMode() (bool, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "Operation", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.operation", + "qualifiedName": "DistributedApplicationExecutionContext.operation", + "description": "The operation currently being performed by the AppHost.", + "kind": "PropertyGetter", + "signature": "Operation() (DistributedApplicationOperation, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(DistributedApplicationOperation, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "PublisherName", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.publisherName", + "qualifiedName": "DistributedApplicationExecutionContext.publisherName", + "description": "The name of the publisher that is being used if `Operation` is set to `Publish`.", + "kind": "PropertyGetter", + "signature": "PublisherName() (string, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "RunConfiguration", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.runConfiguration", + "qualifiedName": "DistributedApplicationExecutionContext.runConfiguration", + "description": "Describes how the AppHost is being run. Only meaningful when `Operation` is `Run`; otherwise every aspect holds its default value.", + "kind": "PropertyGetter", + "signature": "RunConfiguration() (*RunConfiguration, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(*RunConfiguration, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "ServiceProvider", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.serviceProvider", + "qualifiedName": "DistributedApplicationExecutionContext.serviceProvider", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "ServiceProvider() ServiceProvider", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.services", + "qualifiedName": "DistributedApplicationExecutionContext.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "SetPublisherName", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.setPublisherName", + "qualifiedName": "DistributedApplicationExecutionContext.setPublisherName", + "description": "The name of the publisher that is being used if `Operation` is set to `Publish`.", + "kind": "PropertySetter", + "signature": "SetPublisherName(value string) DistributedApplicationExecutionContext", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The name of the publisher that is being used if `Operation` is set to `Publish`." + } + ], + "returnType": "DistributedApplicationExecutionContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "Builder", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.builder", + "qualifiedName": "DockerfileBuilderCallbackContext.builder", + "description": "Gets the Dockerfile builder instance.", + "kind": "PropertyGetter", + "signature": "Builder() DockerfileBuilder", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "DockerfileBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.cancellationToken", + "qualifiedName": "DockerfileBuilderCallbackContext.cancellationToken", + "description": "Gets the cancellation token to observe while waiting for the task to complete.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.resource", + "qualifiedName": "DockerfileBuilderCallbackContext.resource", + "description": "Gets the resource being built.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.services", + "qualifiedName": "DockerfileBuilderCallbackContext.services", + "description": "Gets the service provider for dependency injection.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileFactoryContext.resource", + "qualifiedName": "DockerfileFactoryContext.resource", + "description": "Gets the resource for which the Dockerfile is being generated. This allows factory functions to query resource annotations and properties to customize the generated Dockerfile. ``` var containerAnnotation = context.Resource.Annotations.OfType().FirstOrDefault(); var baseImage = containerAnnotation?.Image ?? \"alpine:latest\"; ```", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "DockerfileFactoryContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileFactoryContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileFactoryContext" + ], + "appliesTo": [ + "DockerfileFactoryContext" + ] + }, + { + "name": "EndpointName", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.endpointName", + "qualifiedName": "EndpointReference.endpointName", + "description": "Gets the name of the endpoint associated with the endpoint reference.", + "kind": "PropertyGetter", + "signature": "EndpointName() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "ErrorMessage", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.errorMessage", + "qualifiedName": "EndpointReference.errorMessage", + "description": "Gets or sets a custom error message to be thrown when the endpoint annotation is not found.", + "kind": "PropertyGetter", + "signature": "ErrorMessage() (*string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "ExcludeReferenceEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.excludeReferenceEndpoint", + "qualifiedName": "EndpointReference.excludeReferenceEndpoint", + "description": "Gets a value indicating whether this endpoint is excluded from the default set when referencing the resource's endpoints.", + "remarks": "Returns `false` if the endpoint annotation has not been added to the resource yet.\nOnce the annotation exists, this property delegates to `ExcludeReferenceEndpoint`.", + "kind": "PropertyGetter", + "signature": "ExcludeReferenceEndpoint() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Exists", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.exists", + "qualifiedName": "EndpointReference.exists", + "description": "Gets a value indicating whether the endpoint exists.", + "kind": "PropertyGetter", + "signature": "Exists() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "GetTlsValue", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.getTlsValue", + "qualifiedName": "EndpointReference.getTlsValue", + "description": "Gets a conditional expression that resolves to the enabledValue when TLS is enabled on the endpoint, or to the disabledValue otherwise.", + "remarks": "The returned expression evaluates the TLS state lazily each time its value is resolved, making it\nsafe to embed in a `ReferenceExpression` that is built before TLS is configured\n(e.g., before `BeforeStartEvent` fires). Because the condition and branches are declarative,\npolyglot code generators can translate this into native conditional constructs in any target language.", + "returns": "A conditional `ReferenceExpression` whose value tracks the TLS state of this endpoint.", + "kind": "InstanceMethod", + "signature": "GetTlsValue(enabledValue *ReferenceExpression, disabledValue *ReferenceExpression) *ReferenceExpression", + "receiver": "EndpointReference", + "parameters": [ + { + "name": "enabledValue", + "type": "*ReferenceExpression", + "description": "The expression to evaluate when TLS is enabled (e.g., `\",ssl=true\"`)." + }, + { + "name": "disabledValue", + "type": "*ReferenceExpression", + "description": "The expression to evaluate when TLS is not enabled." + } + ], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "GetValueAsync", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.getValueAsync", + "qualifiedName": "EndpointReference.getValueAsync", + "description": "Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.", + "returns": "The URL of the endpoint.", + "kind": "InstanceMethod", + "signature": "GetValueAsync(options ...*GetValueAsyncOptions) (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "options": { + "typeName": "GetValueAsyncOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The cancellation token." + } + ] + }, + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Host", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.host", + "qualifiedName": "EndpointReference.host", + "description": "Gets the host for this endpoint.", + "kind": "PropertyGetter", + "signature": "Host() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsAllocated", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isAllocated", + "qualifiedName": "EndpointReference.isAllocated", + "description": "Gets a value indicating whether the endpoint is allocated.", + "kind": "PropertyGetter", + "signature": "IsAllocated() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsHttp", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isHttp", + "qualifiedName": "EndpointReference.isHttp", + "description": "Gets a value indicating whether the endpoint uses HTTP scheme.", + "kind": "PropertyGetter", + "signature": "IsHttp() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsHttpSchemeNamedEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isHttpSchemeNamedEndpoint", + "qualifiedName": "EndpointReference.isHttpSchemeNamedEndpoint", + "description": "Gets a value indicating whether the endpoint name is \"http\" or \"https\", ignoring case. This is a convention used to identify endpoints that will be resolved based on the scheme of the endpoint in service discovery rather than by the specific endpoint name. This is done to allow http endpoints that are dynamically updated to https to be mapped correctly despite the endpoint name no longer matching the scheme.", + "kind": "PropertyGetter", + "signature": "IsHttpSchemeNamedEndpoint() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsHttps", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isHttps", + "qualifiedName": "EndpointReference.isHttps", + "description": "Gets a value indicating whether the endpoint uses HTTPS scheme.", + "kind": "PropertyGetter", + "signature": "IsHttps() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.port", + "qualifiedName": "EndpointReference.port", + "description": "Gets the port for this endpoint.", + "kind": "PropertyGetter", + "signature": "Port() (float64, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Property", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.property", + "qualifiedName": "EndpointReference.property", + "description": "Gets the specified property expression of the endpoint.", + "returns": "An `EndpointReferenceExpression` representing the specified `EndpointProperty`.", + "kind": "InstanceMethod", + "signature": "Property(property EndpointProperty) EndpointReferenceExpression", + "receiver": "EndpointReference", + "parameters": [ + { + "name": "property", + "type": "EndpointProperty", + "description": "The `EndpointProperty` enum value to use in the reference." + } + ], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.resource", + "qualifiedName": "EndpointReference.resource", + "description": "Gets the resource owner of the endpoint reference.", + "kind": "PropertyGetter", + "signature": "Resource() ResourceWithEndpoints", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "ResourceWithEndpoints", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Scheme", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.scheme", + "qualifiedName": "EndpointReference.scheme", + "description": "Gets the scheme for this endpoint.", + "kind": "PropertyGetter", + "signature": "Scheme() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "TargetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.targetPort", + "qualifiedName": "EndpointReference.targetPort", + "description": "Gets the target port for this endpoint. If the port is dynamically allocated, this will return `null`.", + "kind": "PropertyGetter", + "signature": "TargetPort() (*float64, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "TlsEnabled", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.tlsEnabled", + "qualifiedName": "EndpointReference.tlsEnabled", + "description": "Gets a value indicating whether TLS is enabled for this endpoint.", + "remarks": "Returns `false` if the endpoint annotation has not been added to the resource yet.\nOnce the annotation exists, this property delegates to `TlsEnabled`.", + "kind": "PropertyGetter", + "signature": "TlsEnabled() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Url", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.url", + "qualifiedName": "EndpointReference.url", + "description": "Gets the URL for this endpoint.", + "kind": "PropertyGetter", + "signature": "Url() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Endpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReferenceExpression.endpoint", + "qualifiedName": "EndpointReferenceExpression.endpoint", + "description": "Gets the `EndpointReference`.", + "kind": "PropertyGetter", + "signature": "Endpoint() EndpointReference", + "receiver": "EndpointReferenceExpression", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression" + ], + "appliesTo": [ + "EndpointReferenceExpression" + ] + }, + { + "name": "Property", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReferenceExpression.property", + "qualifiedName": "EndpointReferenceExpression.property", + "description": "Gets the `EndpointProperty` for the property expression.", + "kind": "PropertyGetter", + "signature": "Property() (EndpointProperty, error)", + "receiver": "EndpointReferenceExpression", + "parameters": [], + "returnType": "(EndpointProperty, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression" + ], + "appliesTo": [ + "EndpointReferenceExpression" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReferenceExpression.valueExpression", + "qualifiedName": "EndpointReferenceExpression.valueExpression", + "description": "Gets the expression of the property of the endpoint.", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "EndpointReferenceExpression", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression" + ], + "appliesTo": [ + "EndpointReferenceExpression" + ] + }, + { + "name": "ExcludeReferenceEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.excludeReferenceEndpoint", + "qualifiedName": "EndpointUpdateContext.excludeReferenceEndpoint", + "description": "Gets or sets a value indicating whether the endpoint is excluded from the default reference set.", + "kind": "PropertyGetter", + "signature": "ExcludeReferenceEndpoint() (bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "IsExternal", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.isExternal", + "qualifiedName": "EndpointUpdateContext.isExternal", + "description": "Gets or sets a value indicating whether the endpoint is external.", + "kind": "PropertyGetter", + "signature": "IsExternal() (bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "IsProxied", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.isProxied", + "qualifiedName": "EndpointUpdateContext.isProxied", + "description": "Gets or sets a value indicating whether the endpoint is proxied.", + "kind": "PropertyGetter", + "signature": "IsProxied() (*bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.name", + "qualifiedName": "EndpointUpdateContext.name", + "description": "Gets the endpoint name.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.port", + "qualifiedName": "EndpointUpdateContext.port", + "description": "Gets or sets the desired host port.", + "kind": "PropertyGetter", + "signature": "Port() (*float64, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Protocol", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.protocol", + "qualifiedName": "EndpointUpdateContext.protocol", + "description": "Gets or sets the network protocol.", + "kind": "PropertyGetter", + "signature": "Protocol() (ProtocolType, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(ProtocolType, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetExcludeReferenceEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setExcludeReferenceEndpoint", + "qualifiedName": "EndpointUpdateContext.setExcludeReferenceEndpoint", + "description": "Gets or sets a value indicating whether the endpoint is excluded from the default reference set.", + "kind": "PropertySetter", + "signature": "SetExcludeReferenceEndpoint(value bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets a value indicating whether the endpoint is excluded from the default reference set." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetIsExternal", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setIsExternal", + "qualifiedName": "EndpointUpdateContext.setIsExternal", + "description": "Gets or sets a value indicating whether the endpoint is external.", + "kind": "PropertySetter", + "signature": "SetIsExternal(value bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets a value indicating whether the endpoint is external." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetIsProxied", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setIsProxied", + "qualifiedName": "EndpointUpdateContext.setIsProxied", + "description": "Gets or sets a value indicating whether the endpoint is proxied.", + "kind": "PropertySetter", + "signature": "SetIsProxied(value *bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Gets or sets a value indicating whether the endpoint is proxied." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setPort", + "qualifiedName": "EndpointUpdateContext.setPort", + "description": "Gets or sets the desired host port.", + "kind": "PropertySetter", + "signature": "SetPort(value *float64) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the desired host port." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetProtocol", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setProtocol", + "qualifiedName": "EndpointUpdateContext.setProtocol", + "description": "Gets or sets the network protocol.", + "kind": "PropertySetter", + "signature": "SetProtocol(value ProtocolType) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "ProtocolType", + "description": "Gets or sets the network protocol." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTargetHost", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTargetHost", + "qualifiedName": "EndpointUpdateContext.setTargetHost", + "description": "Gets or sets the target host.", + "kind": "PropertySetter", + "signature": "SetTargetHost(value string) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the target host." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTargetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTargetPort", + "qualifiedName": "EndpointUpdateContext.setTargetPort", + "description": "Gets or sets the target port.", + "kind": "PropertySetter", + "signature": "SetTargetPort(value *float64) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the target port." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTlsEnabled", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTlsEnabled", + "qualifiedName": "EndpointUpdateContext.setTlsEnabled", + "description": "Gets or sets a value indicating whether TLS is enabled.", + "kind": "PropertySetter", + "signature": "SetTlsEnabled(value bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets a value indicating whether TLS is enabled." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTransport", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTransport", + "qualifiedName": "EndpointUpdateContext.setTransport", + "description": "Gets or sets the transport.", + "kind": "PropertySetter", + "signature": "SetTransport(value string) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the transport." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetUriScheme", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setUriScheme", + "qualifiedName": "EndpointUpdateContext.setUriScheme", + "description": "Gets or sets the URI scheme.", + "kind": "PropertySetter", + "signature": "SetUriScheme(value string) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the URI scheme." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "TargetHost", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.targetHost", + "qualifiedName": "EndpointUpdateContext.targetHost", + "description": "Gets or sets the target host.", + "kind": "PropertyGetter", + "signature": "TargetHost() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "TargetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.targetPort", + "qualifiedName": "EndpointUpdateContext.targetPort", + "description": "Gets or sets the target port.", + "kind": "PropertyGetter", + "signature": "TargetPort() (*float64, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "TlsEnabled", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.tlsEnabled", + "qualifiedName": "EndpointUpdateContext.tlsEnabled", + "description": "Gets or sets a value indicating whether TLS is enabled.", + "kind": "PropertyGetter", + "signature": "TlsEnabled() (bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Transport", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.transport", + "qualifiedName": "EndpointUpdateContext.transport", + "description": "Gets or sets the transport.", + "kind": "PropertyGetter", + "signature": "Transport() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "UriScheme", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.uriScheme", + "qualifiedName": "EndpointUpdateContext.uriScheme", + "description": "Gets or sets the URI scheme.", + "kind": "PropertyGetter", + "signature": "UriScheme() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.environment", + "qualifiedName": "EnvironmentCallbackContext.environment", + "description": "Gets the editor used to set environment variables in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Environment() EnvironmentEditor", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "EnvironmentEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.executionContext", + "qualifiedName": "EnvironmentCallbackContext.executionContext", + "description": "Gets the execution context associated with this invocation of the AppHost.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.log", + "qualifiedName": "EnvironmentCallbackContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.resource", + "qualifiedName": "EnvironmentCallbackContext.resource", + "description": "The resource associated with this callback context.", + "remarks": "This will be set to the resource in all cases where Aspire invokes the callback.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "Set", + "capabilityId": "Aspire.Hosting.ApplicationModel/set", + "qualifiedName": "EnvironmentEditor.set", + "description": "Sets an environment variable.", + "kind": "InstanceMethod", + "signature": "Set(name string, value any) error", + "receiver": "EnvironmentEditor", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the environment variable." + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression", + "EndpointReference", + "ParameterResource", + "ResourceWithConnectionString", + "ExpressionValue" + ], + "description": "The value to assign to the environment variable." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentEditor" + ], + "appliesTo": [ + "EnvironmentEditor" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.Ats/EventingSubscriberRegistrationContext.cancellationToken", + "qualifiedName": "EventingSubscriberRegistrationContext.cancellationToken", + "description": "The cancellation token associated with the subscriber registration.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.Ats/EventingSubscriberRegistrationContext.executionContext", + "qualifiedName": "EventingSubscriberRegistrationContext.executionContext", + "description": "The execution context for the AppHost invocation.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "Arguments", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.arguments", + "qualifiedName": "ExecuteCommandContext.arguments", + "description": "Gets the invocation arguments supplied by the client when the command is executed.", + "remarks": "The collection contains the arguments described by `Arguments` with their\nsubmitted values populated. CLI positional arguments are mapped by declaration order. Dashboard, MCP, and other\nnamed-payload clients are mapped by `Name`.", + "kind": "PropertyGetter", + "signature": "Arguments() InteractionInputCollection", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.cancellationToken", + "qualifiedName": "ExecuteCommandContext.cancellationToken", + "description": "The cancellation token.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.logger", + "qualifiedName": "ExecuteCommandContext.logger", + "description": "The logger for the resource.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "ResourceName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.resourceName", + "qualifiedName": "ExecuteCommandContext.resourceName", + "description": "The resource name.", + "kind": "PropertyGetter", + "signature": "ResourceName() (string, error)", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.services", + "qualifiedName": "ExecuteCommandContext.services", + "description": "The service provider.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "Arguments", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.arguments", + "qualifiedName": "HttpCommandPrepareRequestContext.arguments", + "description": "Gets the invocation arguments supplied by the client when the command is executed.", + "kind": "PropertyGetter", + "signature": "Arguments() InteractionInputCollection", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.cancellationToken", + "qualifiedName": "HttpCommandPrepareRequestContext.cancellationToken", + "description": "The cancellation token.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "Endpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.endpoint", + "qualifiedName": "HttpCommandPrepareRequestContext.endpoint", + "description": "The endpoint the request is targeting.", + "kind": "PropertyGetter", + "signature": "Endpoint() EndpointReference", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "ResourceName", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.resourceName", + "qualifiedName": "HttpCommandPrepareRequestContext.resourceName", + "description": "The name of the resource the command was configured on.", + "kind": "PropertyGetter", + "signature": "ResourceName() (string, error)", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "Arguments", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.arguments", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.arguments", + "description": "Gets the editor used to manipulate the command-line arguments in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Arguments() CommandLineArgsEditor", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "CommandLineArgsEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.cancellationToken", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.cancellationToken", + "description": "Gets the `CancellationToken` that can be used to cancel the operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CertificatePath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.certificatePath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.certificatePath", + "description": "A value provider that will resolve to a path to the certificate file.", + "kind": "PropertyGetter", + "signature": "CertificatePath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CertificateWithKeyPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.certificateWithKeyPath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.certificateWithKeyPath", + "description": "A value provider that will resolve to a path to the certificate and key concatenated together in PEM format.", + "kind": "PropertyGetter", + "signature": "CertificateWithKeyPath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.environment", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.environment", + "description": "Gets the editor used to set environment variables in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Environment() EnvironmentEditor", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "EnvironmentEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.executionContext", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.executionContext", + "description": "Gets the `DistributedApplicationExecutionContext` for this session.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "KeyPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.keyPath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.keyPath", + "description": "A value provider that will resolve to a path to the private key for the certificate.", + "kind": "PropertyGetter", + "signature": "KeyPath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "PfxPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.pfxPath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.pfxPath", + "description": "A value provider that will resolve to a path to a PFX file for the key pair.", + "kind": "PropertyGetter", + "signature": "PfxPath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.resource", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.resource", + "description": "Gets the resource to which the annotation is applied.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.cancellationToken", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.cancellationToken", + "description": "Gets the `CancellationToken` for the operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.model", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.model", + "description": "Gets the `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.resource", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.resource", + "description": "Gets the `IResource` that is being configured for HTTPS.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.services", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.services", + "description": "Gets the `IServiceProvider` instance from the application.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "BasePath", + "capabilityId": "Aspire.Hosting.ApplicationModel/IAspireStore.basePath", + "qualifiedName": "IAspireStore.basePath", + "description": "Gets the base path of this store.", + "kind": "PropertyGetter", + "signature": "BasePath() (string, error)", + "receiver": "AspireStore", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IAspireStore", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IAspireStore" + ], + "appliesTo": [ + "AspireStore" + ] + }, + { + "name": "AppHostDirectory", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.appHostDirectory", + "qualifiedName": "IDistributedApplicationBuilder.appHostDirectory", + "description": "Directory of the project where the AppHost is located. Defaults to the content root if there's no project.", + "kind": "PropertyGetter", + "signature": "AppHostDirectory() (string, error)", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting/build", + "qualifiedName": "IDistributedApplicationBuilder.build", + "description": "Builds the distributed application", + "remarks": "Callers of the `Build` method should only call it once. are responsible for the lifecycle of the\n`DistributedApplication` instance that is returned. Note that the `DistributedApplication`\ntype implements `IDisposable` and should be disposed of when it is no longer needed. Note that in\nmany templates and samples Dispose is omitted for brevity because in those cases the instance is destroyed\nwhen the process exists.", + "returns": "A new `DistributedApplication` instance.", + "kind": "InstanceMethod", + "signature": "Build() (DistributedApplication, error)", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "(DistributedApplication, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.environment", + "qualifiedName": "IDistributedApplicationBuilder.environment", + "description": "Gets the Environment property", + "kind": "PropertyGetter", + "signature": "Environment() HostEnvironment", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "HostEnvironment", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Eventing", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.eventing", + "qualifiedName": "IDistributedApplicationBuilder.eventing", + "description": "Eventing infrastructure for AppHost lifecycle.", + "kind": "PropertyGetter", + "signature": "Eventing() DistributedApplicationEventing", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationEventing", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.executionContext", + "qualifiedName": "IDistributedApplicationBuilder.executionContext", + "description": "Execution context for this invocation of the AppHost.", + "remarks": "Use this property to determine whether the AppHost is running locally or publishing\ndeployment artifacts, and adjust the application model accordingly.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Pipeline", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.pipeline", + "qualifiedName": "IDistributedApplicationBuilder.pipeline", + "description": "Gets the deployment pipeline for this distributed application.", + "remarks": "The pipeline allows adding custom deployment steps that execute during the deploy process.\nSteps can declare dependencies on other steps to control execution order.", + "kind": "PropertyGetter", + "signature": "Pipeline() DistributedApplicationPipeline", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationPipeline", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "UserSecretsManager", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.userSecretsManager", + "qualifiedName": "IDistributedApplicationBuilder.userSecretsManager", + "description": "Gets the service for managing user secrets.", + "remarks": "The `UserSecretsManager` provides a centralized way to manage user secrets\nused by Aspire, enabling testability and consistent secret management.", + "kind": "PropertyGetter", + "signature": "UserSecretsManager() UserSecretsManager", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "UserSecretsManager", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Unsubscribe", + "capabilityId": "Aspire.Hosting.Eventing/IDistributedApplicationEventing.unsubscribe", + "qualifiedName": "IDistributedApplicationEventing.unsubscribe", + "description": "Unsubscribe from an event.", + "kind": "InstanceMethod", + "signature": "Unsubscribe(subscription DistributedApplicationEventSubscription) error", + "receiver": "DistributedApplicationEventing", + "parameters": [ + { + "name": "subscription", + "type": "DistributedApplicationEventSubscription", + "description": "The specific subscription to unsubscribe." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Eventing.IDistributedApplicationEventing", + "expandedTargetTypes": [ + "Aspire.Hosting.Eventing.IDistributedApplicationEventing" + ], + "appliesTo": [ + "DistributedApplicationEventing" + ] + }, + { + "name": "FilePath", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.filePath", + "qualifiedName": "IUserSecretsManager.filePath", + "description": "Gets the path to the user secrets file.", + "kind": "PropertyGetter", + "signature": "FilePath() (string, error)", + "receiver": "UserSecretsManager", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "IsAvailable", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.isAvailable", + "qualifiedName": "IUserSecretsManager.isAvailable", + "description": "Gets a value indicating whether user secrets are available.", + "remarks": "Returns `true` if the project has a user secrets ID configured; otherwise, `false`.", + "kind": "PropertyGetter", + "signature": "IsAvailable() (bool, error)", + "receiver": "UserSecretsManager", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "TryDeleteSecret", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.tryDeleteSecret", + "qualifiedName": "IUserSecretsManager.tryDeleteSecret", + "description": "Attempts to delete a user secret value synchronously.", + "remarks": "The default implementation returns `false` so existing implementations remain compatible.", + "returns": "True if the secret was deleted successfully; otherwise, false.", + "kind": "InstanceMethod", + "signature": "TryDeleteSecret(name string) (bool, error)", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "TrySetSecret", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.trySetSecret", + "qualifiedName": "IUserSecretsManager.trySetSecret", + "description": "Attempts to set a user secret value synchronously.", + "returns": "True if the secret was set successfully; otherwise, false.", + "kind": "InstanceMethod", + "signature": "TrySetSecret(name string, value string) (bool, error)", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret." + }, + { + "name": "value", + "type": "string", + "description": "The value of the secret." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "Eventing", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.eventing", + "qualifiedName": "InitializeResourceEvent.eventing", + "description": "The `IDistributedApplicationEventing` service for the AppHost.", + "kind": "PropertyGetter", + "signature": "Eventing() DistributedApplicationEventing", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "DistributedApplicationEventing", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.logger", + "qualifiedName": "InitializeResourceEvent.logger", + "description": "An instance of `ILogger` that can be used to log messages for the resource.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Notifications", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.notifications", + "qualifiedName": "InitializeResourceEvent.notifications", + "description": "The `ResourceNotificationService` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Notifications() ResourceNotificationService", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "ResourceNotificationService", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.resource", + "qualifiedName": "InitializeResourceEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.services", + "qualifiedName": "InitializeResourceEvent.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "AddValidationError", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.addValidationError", + "qualifiedName": "InputsDialogValidationContext.addValidationError", + "description": "Adds a validation error for the input with the specified name.", + "kind": "InstanceMethod", + "signature": "AddValidationError(inputName string, errorMessage string) error", + "receiver": "InputsDialogValidationContext", + "parameters": [ + { + "name": "inputName", + "type": "string", + "description": "The name of the input to add a validation error for." + }, + { + "name": "errorMessage", + "type": "string", + "description": "The error message to add." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.cancellationToken", + "qualifiedName": "InputsDialogValidationContext.cancellationToken", + "description": "Gets the cancellation token for the validation operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "InputsDialogValidationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "Inputs", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.inputs", + "qualifiedName": "InputsDialogValidationContext.inputs", + "description": "Gets the inputs that are being validated.", + "kind": "PropertyGetter", + "signature": "Inputs() InteractionInputCollection", + "receiver": "InputsDialogValidationContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.services", + "qualifiedName": "InputsDialogValidationContext.services", + "description": "Gets the service provider for resolving services during validation.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "InputsDialogValidationContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "Canceled", + "capabilityId": "Aspire.Hosting.Ats/InputsInteractionResult.canceled", + "qualifiedName": "InputsInteractionResult.canceled", + "description": "Gets a value indicating whether the interaction was canceled by the user.", + "kind": "PropertyGetter", + "signature": "Canceled() (bool, error)", + "receiver": "InputsInteractionResult", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InputsInteractionResult", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InputsInteractionResult" + ], + "appliesTo": [ + "InputsInteractionResult" + ] + }, + { + "name": "Inputs", + "capabilityId": "Aspire.Hosting.Ats/InputsInteractionResult.inputs", + "qualifiedName": "InputsInteractionResult.inputs", + "description": "Gets the inputs returned from the interaction. Empty when `Canceled` is `true`.", + "kind": "PropertyGetter", + "signature": "Inputs() InteractionInputCollection", + "receiver": "InputsInteractionResult", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InputsInteractionResult", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InputsInteractionResult" + ], + "appliesTo": [ + "InputsInteractionResult" + ] + }, + { + "name": "ReleaseFiles", + "capabilityId": "Aspire.Hosting.Ats/releaseFiles", + "qualifiedName": "InteractionInputBuilder.releaseFiles", + "description": "Releases uploaded files associated with the input.", + "remarks": "Call this after processing the file paths returned by the prompt. Releasing the files deletes the\nserver-side temporary files before AppHost shutdown and is idempotent. Files that are not released are\ndeleted when the AppHost shuts down.", + "kind": "InstanceMethod", + "signature": "ReleaseFiles() error", + "receiver": "InteractionInputBuilder", + "parameters": [], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "WithChoiceOptions", + "capabilityId": "Aspire.Hosting.Ats/withChoiceOptions", + "qualifiedName": "InteractionInputBuilder.withChoiceOptions", + "description": "Sets the choice options for the input.", + "returns": "The same builder handle.", + "kind": "InstanceMethod", + "signature": "WithChoiceOptions(choices []*InteractionChoiceOption) InteractionInputBuilder", + "receiver": "InteractionInputBuilder", + "parameters": [ + { + "name": "choices", + "type": "[]*InteractionChoiceOption", + "description": "The available choices, in display order. Each option pairs a submitted value with a display label." + } + ], + "returnType": "InteractionInputBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "WithDynamicLoading", + "capabilityId": "Aspire.Hosting.Ats/withDynamicLoading", + "qualifiedName": "InteractionInputBuilder.withDynamicLoading", + "description": "Attaches a callback that dynamically loads or updates the input after the prompt starts.", + "returns": "The same builder handle.", + "kind": "InstanceMethod", + "signature": "WithDynamicLoading(callback func(arg InteractionInputLoadContext), options ...*DynamicLoadingOptions) InteractionInputBuilder", + "receiver": "InteractionInputBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg InteractionInputLoadContext)", + "isCallback": true, + "callbackSignature": "func(arg InteractionInputLoadContext)", + "description": "The callback invoked to load the input. Use the supplied context to read other inputs and update this input." + } + ], + "options": { + "typeName": "DynamicLoadingOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "WithValue", + "capabilityId": "Aspire.Hosting.Ats/withValue", + "qualifiedName": "InteractionInputBuilder.withValue", + "description": "Sets the value of the input.", + "returns": "The same builder handle.", + "kind": "InstanceMethod", + "signature": "WithValue(value string) InteractionInputBuilder", + "receiver": "InteractionInputBuilder", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The value to assign." + } + ], + "returnType": "InteractionInputBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "ToArray", + "capabilityId": "Aspire.Hosting/InteractionInputCollection.toArray", + "qualifiedName": "InteractionInputCollection.toArray", + "description": "Gets all inputs in declaration order.", + "returns": "A copy of the inputs in declaration order.", + "kind": "InstanceMethod", + "signature": "ToArray() ([]*InteractionInput, error)", + "receiver": "InteractionInputCollection", + "parameters": [], + "returnType": "([]*InteractionInput, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InteractionInputCollection", + "expandedTargetTypes": [ + "Aspire.Hosting.InteractionInputCollection" + ], + "appliesTo": [ + "InteractionInputCollection" + ] + }, + { + "name": "Input", + "capabilityId": "Aspire.Hosting.Ats/input", + "qualifiedName": "InteractionInputLoadContext.input", + "description": "Gets a handle to the input that is loading. Mutate the input through this handle.", + "remarks": "Mirrors the native `LoadInputContext.Input`: the callback updates the live input it is loading, rather than\nthe context itself. The input is a handle (not a by-value DTO) so guarded setters route back to the server-side\ninput across the ATS boundary.", + "returns": "A handle to the loading input.", + "kind": "InstanceMethod", + "signature": "Input() InteractionLoadingInput", + "receiver": "InteractionInputLoadContext", + "parameters": [], + "returnType": "InteractionLoadingInput", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputLoadContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputLoadContext" + ], + "appliesTo": [ + "InteractionInputLoadContext" + ] + }, + { + "name": "Inputs", + "capabilityId": "Aspire.Hosting.Ats/InteractionInputLoadContext.inputs", + "qualifiedName": "InteractionInputLoadContext.inputs", + "description": "Gets all inputs in the prompt, including the one currently loading.", + "remarks": "Mirrors the native `LoadInputContext.AllInputs`. Use the collection's by-name accessors (for example\n`value` or `requiredValue`) to read the dependency inputs declared via\n`DependsOnInputs`. This is the same `InteractionInputCollection`\nidiom used by the validation callback and prompt results, so reading inputs by name is consistent across every\ncallback context. This is exposed as a property (rather than a method) so it routes through the generated\ncollection accessor, matching the other contexts that surface an `InteractionInputCollection`.", + "kind": "PropertyGetter", + "signature": "Inputs() InteractionInputCollection", + "receiver": "InteractionInputLoadContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputLoadContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputLoadContext" + ], + "appliesTo": [ + "InteractionInputLoadContext" + ] + }, + { + "name": "GetName", + "capabilityId": "Aspire.Hosting.Ats/getName", + "qualifiedName": "InteractionLoadingInput.getName", + "description": "Gets the name of the input.", + "returns": "The input name.", + "kind": "InstanceMethod", + "signature": "GetName() (string, error)", + "receiver": "InteractionLoadingInput", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionLoadingInput", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionLoadingInput" + ], + "appliesTo": [ + "InteractionLoadingInput" + ] + }, + { + "name": "SetChoiceOptions", + "capabilityId": "Aspire.Hosting.Ats/setChoiceOptions", + "qualifiedName": "InteractionLoadingInput.setChoiceOptions", + "description": "Sets the choice options for the input.", + "kind": "InstanceMethod", + "signature": "SetChoiceOptions(choices []*InteractionChoiceOption) error", + "receiver": "InteractionLoadingInput", + "parameters": [ + { + "name": "choices", + "type": "[]*InteractionChoiceOption", + "description": "The available choices, in display order. Each option pairs a submitted value with a display label." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionLoadingInput", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionLoadingInput" + ], + "appliesTo": [ + "InteractionLoadingInput" + ] + }, + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting.Ats/setValue", + "qualifiedName": "InteractionLoadingInput.setValue", + "description": "Sets the value of the input.", + "kind": "InstanceMethod", + "signature": "SetValue(value string) error", + "receiver": "InteractionLoadingInput", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The value to assign." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionLoadingInput", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionLoadingInput" + ], + "appliesTo": [ + "InteractionLoadingInput" + ] + }, + { + "name": "Debug", + "capabilityId": "Aspire.Hosting.ApplicationModel/debug", + "qualifiedName": "LogFacade.debug", + "description": "Writes a debug log message.", + "kind": "InstanceMethod", + "signature": "Debug(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "Error", + "capabilityId": "Aspire.Hosting.ApplicationModel/error", + "qualifiedName": "LogFacade.error", + "description": "Writes an error log message.", + "kind": "InstanceMethod", + "signature": "Error(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "Info", + "capabilityId": "Aspire.Hosting.ApplicationModel/info", + "qualifiedName": "LogFacade.info", + "description": "Writes an informational log message.", + "kind": "InstanceMethod", + "signature": "Info(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "Warning", + "capabilityId": "Aspire.Hosting.ApplicationModel/warning", + "qualifiedName": "LogFacade.warning", + "description": "Writes a warning log message.", + "kind": "InstanceMethod", + "signature": "Warning(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "GetSteps", + "capabilityId": "Aspire.Hosting.Pipelines/getSteps", + "qualifiedName": "PipelineConfigurationContext.getSteps", + "description": "Gets all pipeline steps with the specified tag.", + "returns": "A collection of steps that have the specified tag.", + "kind": "InstanceMethod", + "signature": "GetSteps(tag string) ([]PipelineStep, error)", + "receiver": "PipelineConfigurationContext", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "The tag to search for." + } + ], + "returnType": "([]PipelineStep, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineConfigurationContext" + ], + "appliesTo": [ + "PipelineConfigurationContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineConfigurationContext.log", + "qualifiedName": "PipelineConfigurationContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "PipelineConfigurationContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineConfigurationContext" + ], + "appliesTo": [ + "PipelineConfigurationContext" + ] + }, + { + "name": "Pipeline", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineConfigurationContext.pipeline", + "qualifiedName": "PipelineConfigurationContext.pipeline", + "description": "Gets the pipeline editor used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Pipeline() PipelineEditor", + "receiver": "PipelineConfigurationContext", + "parameters": [], + "returnType": "PipelineEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineConfigurationContext" + ], + "appliesTo": [ + "PipelineConfigurationContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.cancellationToken", + "qualifiedName": "PipelineContext.cancellationToken", + "description": "Gets the cancellation token for the pipeline operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.executionContext", + "qualifiedName": "PipelineContext.executionContext", + "description": "Gets the execution context for the distributed application.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.logger", + "qualifiedName": "PipelineContext.logger", + "description": "Gets the logger for pipeline operations.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.model", + "qualifiedName": "PipelineContext.model", + "description": "Gets the distributed application model to be deployed.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.services", + "qualifiedName": "PipelineContext.services", + "description": "Gets the service provider for dependency resolution.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "SetCancellationToken", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.setCancellationToken", + "qualifiedName": "PipelineContext.setCancellationToken", + "description": "Gets the cancellation token for the pipeline operation.", + "kind": "PropertySetter", + "signature": "SetCancellationToken(options ...*SetCancellationTokenOptions) PipelineContext", + "receiver": "PipelineContext", + "parameters": [], + "options": { + "typeName": "SetCancellationTokenOptions", + "fields": [ + { + "name": "Value", + "type": "*CancellationToken", + "description": "Gets the cancellation token for the pipeline operation." + } + ] + }, + "returnType": "PipelineContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Summary", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.summary", + "qualifiedName": "PipelineContext.summary", + "description": "Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes.", + "remarks": "Pipeline steps can add key-value pairs to the summary to provide useful information\nabout the pipeline execution, such as deployment targets, resource names, URLs, etc.", + "kind": "PropertyGetter", + "signature": "Summary() PipelineSummary", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "PipelineSummary", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Steps", + "capabilityId": "Aspire.Hosting.Pipelines/steps", + "qualifiedName": "PipelineEditor.steps", + "description": "Gets all configured pipeline steps.", + "returns": "The configured pipeline steps.", + "kind": "InstanceMethod", + "signature": "Steps() ([]PipelineStep, error)", + "receiver": "PipelineEditor", + "parameters": [], + "returnType": "([]PipelineStep, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineEditor" + ], + "appliesTo": [ + "PipelineEditor" + ] + }, + { + "name": "StepsByTag", + "capabilityId": "Aspire.Hosting.Pipelines/stepsByTag", + "qualifiedName": "PipelineEditor.stepsByTag", + "description": "Gets all pipeline steps that have the specified tag.", + "returns": "The matching pipeline steps.", + "kind": "InstanceMethod", + "signature": "StepsByTag(tag string) ([]PipelineStep, error)", + "receiver": "PipelineEditor", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "The tag to search for." + } + ], + "returnType": "([]PipelineStep, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineEditor" + ], + "appliesTo": [ + "PipelineEditor" + ] + }, + { + "name": "AddTag", + "capabilityId": "Aspire.Hosting.Pipelines/addTag", + "qualifiedName": "PipelineStep.addTag", + "description": "Adds a tag to the step.", + "kind": "InstanceMethod", + "signature": "AddTag(tag string) error", + "receiver": "PipelineStep", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "The tag to add." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "DependsOn", + "capabilityId": "Aspire.Hosting.Pipelines/dependsOn", + "qualifiedName": "PipelineStep.dependsOn", + "description": "Adds a dependency on another step.", + "kind": "InstanceMethod", + "signature": "DependsOn(stepName string) error", + "receiver": "PipelineStep", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The name of the step to depend on." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "DependsOnSteps", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.dependsOnSteps", + "qualifiedName": "PipelineStep.dependsOnSteps", + "description": "Gets or initializes the list of step names that this step depends on.", + "kind": "PropertyGetter", + "signature": "DependsOnSteps() *List[string]", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.description", + "qualifiedName": "PipelineStep.description", + "description": "Gets or initializes the description of the step.", + "remarks": "The description provides human-readable context about what the step does,\nhelping users and tools understand the purpose of the step.", + "kind": "PropertyGetter", + "signature": "Description() (*string, error)", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.name", + "qualifiedName": "PipelineStep.name", + "description": "Gets or initializes the unique name of the step.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "RequiredBy", + "capabilityId": "Aspire.Hosting.Pipelines/requiredBy", + "qualifiedName": "PipelineStep.requiredBy", + "description": "Specifies that this step is required by another step. This creates the inverse relationship where the other step will depend on this step.", + "kind": "InstanceMethod", + "signature": "RequiredBy(stepName string) error", + "receiver": "PipelineStep", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The name of the step that requires this step." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "RequiredBySteps", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.requiredBySteps", + "qualifiedName": "PipelineStep.requiredBySteps", + "description": "Gets or initializes the list of step names that require this step to complete before they can finish. This is used internally during pipeline construction and is converted to DependsOn relationships.", + "kind": "PropertyGetter", + "signature": "RequiredBySteps() *List[string]", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "Tags", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.tags", + "qualifiedName": "PipelineStep.tags", + "description": "Gets or initializes the list of tags that categorize this step.", + "kind": "PropertyGetter", + "signature": "Tags() *List[string]", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.cancellationToken", + "qualifiedName": "PipelineStepContext.cancellationToken", + "description": "Gets the cancellation token for the pipeline operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.executionContext", + "qualifiedName": "PipelineStepContext.executionContext", + "description": "Gets the execution context for the distributed application.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.logger", + "qualifiedName": "PipelineStepContext.logger", + "description": "Gets the logger for pipeline operations that writes to both the pipeline logger and the step logger.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.model", + "qualifiedName": "PipelineStepContext.model", + "description": "Gets the distributed application model to be deployed.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "PipelineContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.pipelineContext", + "qualifiedName": "PipelineStepContext.pipelineContext", + "description": "Gets the pipeline context shared across all steps.", + "kind": "PropertyGetter", + "signature": "PipelineContext() PipelineContext", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "PipelineContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "ReportingStep", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.reportingStep", + "qualifiedName": "PipelineStepContext.reportingStep", + "description": "Gets the publishing step associated with this specific step execution.", + "kind": "PropertyGetter", + "signature": "ReportingStep() ReportingStep", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "ReportingStep", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.services", + "qualifiedName": "PipelineStepContext.services", + "description": "Gets the service provider for dependency resolution.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Summary", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.summary", + "qualifiedName": "PipelineStepContext.summary", + "description": "Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes.", + "remarks": "Pipeline steps can add key-value pairs to the summary to provide useful information\nabout the pipeline execution, such as deployment targets, resource names, URLs, etc.", + "kind": "PropertyGetter", + "signature": "Summary() PipelineSummary", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "PipelineSummary", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "PipelineContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepFactoryContext.pipelineContext", + "qualifiedName": "PipelineStepFactoryContext.pipelineContext", + "description": "Gets the pipeline context that has the model and other properties.", + "kind": "PropertyGetter", + "signature": "PipelineContext() PipelineContext", + "receiver": "PipelineStepFactoryContext", + "parameters": [], + "returnType": "PipelineContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepFactoryContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepFactoryContext" + ], + "appliesTo": [ + "PipelineStepFactoryContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepFactoryContext.resource", + "qualifiedName": "PipelineStepFactoryContext.resource", + "description": "Gets the resource that this factory is associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "PipelineStepFactoryContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepFactoryContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepFactoryContext" + ], + "appliesTo": [ + "PipelineStepFactoryContext" + ] + }, + { + "name": "Add", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineSummary.add", + "qualifiedName": "PipelineSummary.add", + "description": "Adds a key-value pair to the pipeline summary with a plain-text value.", + "kind": "InstanceMethod", + "signature": "Add(key string, value string) error", + "receiver": "PipelineSummary", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key or label for the item (e.g., \"Namespace\", \"URL\")." + }, + { + "name": "value", + "type": "string", + "description": "The plain-text value for the item." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineSummary", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineSummary" + ], + "appliesTo": [ + "PipelineSummary" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting/ProgressContext.cancellationToken", + "qualifiedName": "ProgressContext.cancellationToken", + "description": "Gets the `CancellationToken` that is triggered when the user clicks the cancel button or the operation is externally canceled.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ProgressContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProgressContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ProgressContext" + ], + "appliesTo": [ + "ProgressContext" + ] + }, + { + "name": "ExcludeKestrelEndpoints", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.excludeKestrelEndpoints", + "qualifiedName": "ProjectResourceOptions.excludeKestrelEndpoints", + "description": "If set, ignore endpoints coming from Kestrel configuration.", + "kind": "PropertyGetter", + "signature": "ExcludeKestrelEndpoints() (bool, error)", + "receiver": "ProjectResourceOptions", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "ExcludeLaunchProfile", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.excludeLaunchProfile", + "qualifiedName": "ProjectResourceOptions.excludeLaunchProfile", + "description": "If set, no launch profile will be used, and LaunchProfileName will be ignored.", + "kind": "PropertyGetter", + "signature": "ExcludeLaunchProfile() (bool, error)", + "receiver": "ProjectResourceOptions", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "LaunchProfileName", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.launchProfileName", + "qualifiedName": "ProjectResourceOptions.launchProfileName", + "description": "The launch profile to use. If `null` then the default launch profile will be used.", + "kind": "PropertyGetter", + "signature": "LaunchProfileName() (*string, error)", + "receiver": "ProjectResourceOptions", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "SetExcludeKestrelEndpoints", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.setExcludeKestrelEndpoints", + "qualifiedName": "ProjectResourceOptions.setExcludeKestrelEndpoints", + "description": "If set, ignore endpoints coming from Kestrel configuration.", + "kind": "PropertySetter", + "signature": "SetExcludeKestrelEndpoints(value bool) ProjectResourceOptions", + "receiver": "ProjectResourceOptions", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "If set, ignore endpoints coming from Kestrel configuration." + } + ], + "returnType": "ProjectResourceOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "SetExcludeLaunchProfile", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.setExcludeLaunchProfile", + "qualifiedName": "ProjectResourceOptions.setExcludeLaunchProfile", + "description": "If set, no launch profile will be used, and LaunchProfileName will be ignored.", + "kind": "PropertySetter", + "signature": "SetExcludeLaunchProfile(value bool) ProjectResourceOptions", + "receiver": "ProjectResourceOptions", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "If set, no launch profile will be used, and LaunchProfileName will be ignored." + } + ], + "returnType": "ProjectResourceOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "SetLaunchProfileName", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.setLaunchProfileName", + "qualifiedName": "ProjectResourceOptions.setLaunchProfileName", + "description": "The launch profile to use. If `null` then the default launch profile will be used.", + "kind": "PropertySetter", + "signature": "SetLaunchProfileName(value *string) ProjectResourceOptions", + "receiver": "ProjectResourceOptions", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "The launch profile to use. If `null` then the default launch profile will be used." + } + ], + "returnType": "ProjectResourceOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "AppendFormatted", + "capabilityId": "Aspire.Hosting.ApplicationModel/appendFormatted", + "qualifiedName": "ReferenceExpressionBuilder.appendFormatted", + "description": "Appends a formatted value to the expression.", + "kind": "InstanceMethod", + "signature": "AppendFormatted(value string, options ...*AppendFormattedOptions) error", + "receiver": "ReferenceExpressionBuilder", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The formatted string to be appended to the interpolated string." + } + ], + "options": { + "typeName": "AppendFormattedOptions", + "fields": [ + { + "name": "Format", + "jsonName": "format", + "type": "*string", + "description": "The format to be applied to the value. e.g., \"uri\"" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "AppendLiteral", + "capabilityId": "Aspire.Hosting.ApplicationModel/appendLiteral", + "qualifiedName": "ReferenceExpressionBuilder.appendLiteral", + "description": "Appends a literal value to the expression.", + "kind": "InstanceMethod", + "signature": "AppendLiteral(value string) error", + "receiver": "ReferenceExpressionBuilder", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The literal string value to be appended to the interpolated string." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "AppendValueProvider", + "capabilityId": "Aspire.Hosting.ApplicationModel/appendValueProvider", + "qualifiedName": "ReferenceExpressionBuilder.appendValueProvider", + "description": "Appends a value provider to the reference expression", + "kind": "InstanceMethod", + "signature": "AppendValueProvider(valueProvider any, options ...*AppendValueProviderOptions) error", + "receiver": "ReferenceExpressionBuilder", + "parameters": [ + { + "name": "valueProvider", + "type": "any", + "description": "The value provider to append." + } + ], + "options": { + "typeName": "AppendValueProviderOptions", + "fields": [ + { + "name": "Format", + "jsonName": "format", + "type": "*string", + "description": "Optional format specifier." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting.ApplicationModel/build", + "qualifiedName": "ReferenceExpressionBuilder.build", + "description": "Builds the reference expression", + "kind": "InstanceMethod", + "signature": "Build() *ReferenceExpression", + "receiver": "ReferenceExpressionBuilder", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "IsEmpty", + "capabilityId": "Aspire.Hosting.ApplicationModel/ReferenceExpressionBuilder.isEmpty", + "qualifiedName": "ReferenceExpressionBuilder.isEmpty", + "description": "Indicates whether the expression is empty.", + "kind": "PropertyGetter", + "signature": "IsEmpty() (bool, error)", + "receiver": "ReferenceExpressionBuilder", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.cancellationToken", + "qualifiedName": "RequiredCommandValidationContext.cancellationToken", + "description": "Gets a cancellation token that can be used to cancel the validation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "Failure", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.failure", + "qualifiedName": "RequiredCommandValidationContext.failure", + "description": "Creates a failed validation result with the specified message.", + "returns": "A `RequiredCommandValidationResult` indicating the command is invalid.", + "kind": "InstanceMethod", + "signature": "Failure(validationMessage string) RequiredCommandValidationResult", + "receiver": "RequiredCommandValidationContext", + "parameters": [ + { + "name": "validationMessage", + "type": "string", + "description": "A message describing why validation failed." + } + ], + "returnType": "RequiredCommandValidationResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "ResolvedPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.resolvedPath", + "qualifiedName": "RequiredCommandValidationContext.resolvedPath", + "description": "Gets the resolved full path to the command executable.", + "kind": "PropertyGetter", + "signature": "ResolvedPath() (string, error)", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.services", + "qualifiedName": "RequiredCommandValidationContext.services", + "description": "Gets the service provider for accessing application services.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "Success", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.success", + "qualifiedName": "RequiredCommandValidationContext.success", + "description": "Creates a successful validation result.", + "returns": "A `RequiredCommandValidationResult` indicating the command is valid.", + "kind": "InstanceMethod", + "signature": "Success() RequiredCommandValidationResult", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "RequiredCommandValidationResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "IsValid", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationResult.isValid", + "qualifiedName": "RequiredCommandValidationResult.isValid", + "description": "Gets a value indicating whether the command validation succeeded.", + "kind": "PropertyGetter", + "signature": "IsValid() (bool, error)", + "receiver": "RequiredCommandValidationResult", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult" + ], + "appliesTo": [ + "RequiredCommandValidationResult" + ] + }, + { + "name": "ValidationMessage", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationResult.validationMessage", + "qualifiedName": "RequiredCommandValidationResult.validationMessage", + "description": "Gets an optional validation message describing why validation failed.", + "kind": "PropertyGetter", + "signature": "ValidationMessage() (*string, error)", + "receiver": "RequiredCommandValidationResult", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult" + ], + "appliesTo": [ + "RequiredCommandValidationResult" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceEndpointsAllocatedEvent.resource", + "qualifiedName": "ResourceEndpointsAllocatedEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceEndpointsAllocatedEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent" + ], + "appliesTo": [ + "ResourceEndpointsAllocatedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceEndpointsAllocatedEvent.services", + "qualifiedName": "ResourceEndpointsAllocatedEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ResourceEndpointsAllocatedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent" + ], + "appliesTo": [ + "ResourceEndpointsAllocatedEvent" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceReadyEvent.resource", + "qualifiedName": "ResourceReadyEvent.resource", + "description": "The resource that is in a healthy state.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceReadyEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceReadyEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceReadyEvent" + ], + "appliesTo": [ + "ResourceReadyEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceReadyEvent.services", + "qualifiedName": "ResourceReadyEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ResourceReadyEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceReadyEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceReadyEvent" + ], + "appliesTo": [ + "ResourceReadyEvent" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceStoppedEvent.resource", + "qualifiedName": "ResourceStoppedEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceStoppedEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceStoppedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceStoppedEvent" + ], + "appliesTo": [ + "ResourceStoppedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceStoppedEvent.services", + "qualifiedName": "ResourceStoppedEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ResourceStoppedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceStoppedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceStoppedEvent" + ], + "appliesTo": [ + "ResourceStoppedEvent" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.executionContext", + "qualifiedName": "ResourceUrlsCallbackContext.executionContext", + "description": "Gets the execution context associated with this invocation of the AppHost.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "GetEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/getEndpoint", + "qualifiedName": "ResourceUrlsCallbackContext.getEndpoint", + "description": "Gets an endpoint reference from the associated resource", + "kind": "InstanceMethod", + "signature": "GetEndpoint(name string) EndpointReference", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the endpoint." + } + ], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.log", + "qualifiedName": "ResourceUrlsCallbackContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.resource", + "qualifiedName": "ResourceUrlsCallbackContext.resource", + "description": "Gets the resource this the URLs are associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Urls", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.urls", + "qualifiedName": "ResourceUrlsCallbackContext.urls", + "description": "Gets the editor used to manipulate displayed URLs in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Urls() ResourceUrlsEditor", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "ResourceUrlsEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Add", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsEditor.add", + "qualifiedName": "ResourceUrlsEditor.add", + "description": "Adds a displayed URL.", + "kind": "InstanceMethod", + "signature": "Add(url any, options ...*AddOptions) error", + "receiver": "ResourceUrlsEditor", + "parameters": [ + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ], + "description": "The URL to add, specified as a string or reference expression." + } + ], + "options": { + "typeName": "AddOptions", + "fields": [ + { + "name": "DisplayText", + "jsonName": "displayText", + "type": "*string", + "description": "The optional display text to show for the URL." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor" + ], + "appliesTo": [ + "ResourceUrlsEditor" + ] + }, + { + "name": "AddForEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsEditor.addForEndpoint", + "qualifiedName": "ResourceUrlsEditor.addForEndpoint", + "description": "Adds a displayed URL for a specific endpoint.", + "kind": "InstanceMethod", + "signature": "AddForEndpoint(endpoint EndpointReference, url any, options ...*AddForEndpointOptions) error", + "receiver": "ResourceUrlsEditor", + "parameters": [ + { + "name": "endpoint", + "type": "EndpointReference", + "description": "The endpoint the URL is associated with." + }, + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ], + "description": "The URL to add, specified as a string or reference expression." + } + ], + "options": { + "typeName": "AddForEndpointOptions", + "fields": [ + { + "name": "DisplayText", + "jsonName": "displayText", + "type": "*string", + "description": "The optional display text to show for the URL." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor" + ], + "appliesTo": [ + "ResourceUrlsEditor" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsEditor.executionContext", + "qualifiedName": "ResourceUrlsEditor.executionContext", + "description": "Gets the execution context associated with this editor.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "ResourceUrlsEditor", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor" + ], + "appliesTo": [ + "ResourceUrlsEditor" + ] + }, + { + "name": "ResourceSnapshot", + "capabilityId": "Aspire.Hosting.ApplicationModel/UpdateCommandStateContext.resourceSnapshot", + "qualifiedName": "UpdateCommandStateContext.resourceSnapshot", + "description": "Gets the resource snapshot data available to polyglot command state callbacks.", + "kind": "PropertyGetter", + "signature": "ResourceSnapshot() (*UpdateCommandStateResourceSnapshot, error)", + "receiver": "UpdateCommandStateContext", + "parameters": [], + "returnType": "(*UpdateCommandStateResourceSnapshot, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.UpdateCommandStateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.UpdateCommandStateContext" + ], + "appliesTo": [ + "UpdateCommandStateContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/UpdateCommandStateContext.services", + "qualifiedName": "UpdateCommandStateContext.services", + "description": "The service provider.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "UpdateCommandStateContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.UpdateCommandStateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.UpdateCommandStateContext" + ], + "appliesTo": [ + "UpdateCommandStateContext" + ] + }, + { + "name": "AddCSharpApp", + "capabilityId": "Aspire.Hosting/addCSharpApp", + "qualifiedName": "addCSharpApp", + "description": "Adds a C# application resource", + "kind": "Method", + "signature": "AddCSharpApp(name string, path string, options ...*AddCSharpAppOptions) CSharpAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "path", + "type": "string" + } + ], + "options": { + "typeName": "AddCSharpAppOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*ProjectResourceOptions" + } + ] + }, + "returnType": "CSharpAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddConnectionString", + "capabilityId": "Aspire.Hosting/addConnectionString", + "qualifiedName": "addConnectionString", + "description": "Adds a connection string resource", + "kind": "Method", + "signature": "AddConnectionString(name string, options ...*AddConnectionStringOptions) ResourceWithConnectionString", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddConnectionStringOptions", + "fields": [ + { + "name": "EnvironmentVariableNameOrExpression", + "jsonName": "environmentVariableNameOrExpression", + "type": "any" + } + ] + }, + "returnType": "ResourceWithConnectionString", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddContainer", + "capabilityId": "Aspire.Hosting/addContainer", + "qualifiedName": "addContainer", + "description": "Adds a container resource to the application.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddContainer(name string, image any) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "image", + "type": "any", + "allowedTypes": [ + "string", + "*AddContainerOptions" + ], + "description": "The image name or image options for the container." + } + ], + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddContainerFiles", + "capabilityId": "Aspire.Hosting/dockerfileStageAddContainerFiles", + "qualifiedName": "addContainerFiles", + "description": "Adds COPY --from statements for published container files", + "kind": "Method", + "signature": "AddContainerFiles(resource Resource, rootDestinationPath string, options ...*AddContainerFilesOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "resource", + "type": "Resource" + }, + { + "name": "rootDestinationPath", + "type": "string" + } + ], + "options": { + "typeName": "AddContainerFilesOptions", + "fields": [ + { + "name": "Logger", + "jsonName": "logger", + "type": "*Logger" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "AddContainerFilesStages", + "capabilityId": "Aspire.Hosting/dockerfileBuilderAddContainerFilesStages", + "qualifiedName": "addContainerFilesStages", + "description": "Adds Dockerfile stages for published container files", + "kind": "Method", + "signature": "AddContainerFilesStages(resource Resource, options ...*AddContainerFilesStagesOptions) DockerfileBuilder", + "receiver": "DockerfileBuilder", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "options": { + "typeName": "AddContainerFilesStagesOptions", + "fields": [ + { + "name": "Logger", + "jsonName": "logger", + "type": "*Logger" + } + ] + }, + "returnType": "DockerfileBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder" + ], + "appliesTo": [ + "DockerfileBuilder" + ] + }, + { + "name": "AddContainerRegistry", + "capabilityId": "Aspire.Hosting/addContainerRegistry", + "qualifiedName": "addContainerRegistry", + "description": "Adds a container registry resource", + "kind": "Method", + "signature": "AddContainerRegistry(name string, endpoint any, options ...*AddContainerRegistryOptions) ContainerRegistryResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "endpoint", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "options": { + "typeName": "AddContainerRegistryOptions", + "fields": [ + { + "name": "Repository", + "jsonName": "repository", + "type": "any" + } + ] + }, + "returnType": "ContainerRegistryResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDockerfile", + "capabilityId": "Aspire.Hosting/addDockerfile", + "qualifiedName": "addDockerfile", + "description": "Adds a Dockerfile to the application model that can be treated like a container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerfile(name string, contextPath string, options ...*AddDockerfileOptions) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + } + ], + "options": { + "typeName": "AddDockerfileOptions", + "fields": [ + { + "name": "DockerfilePath", + "jsonName": "dockerfilePath", + "type": "*string", + "description": "Path to the Dockerfile relative to the `contextPath`. Defaults to \"Dockerfile\" if not specified." + }, + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDockerfileBuilder", + "capabilityId": "Aspire.Hosting/addDockerfileBuilder", + "qualifiedName": "addDockerfileBuilder", + "description": "Adds a container resource built from a programmatically generated Dockerfile", + "remarks": "This method provides a programmatic way to build Dockerfiles using the `DockerfileBuilder` API\ninstead of string manipulation.\nThe `contextPath` is relative to the AppHost directory unless it is fully qualified.\nCreates a container with a programmatically built Dockerfile:\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddDockerfileBuilder(\"mycontainer\", \"path/to/context\", context =>\n{\ncontext.Builder.From(\"alpine:latest\")\n.WorkDir(\"/app\")\n.Copy(\".\", \".\")\n.Cmd([\"./myapp\"]);\nreturn Task.CompletedTask;\n});\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerfileBuilder(name string, contextPath string, callback func(arg DockerfileBuilderCallbackContext), options ...*AddDockerfileBuilderOptions) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "callback", + "type": "func(arg DockerfileBuilderCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg DockerfileBuilderCallbackContext)", + "description": "A callback that uses the `DockerfileBuilder` API to construct the Dockerfile." + } + ], + "options": { + "typeName": "AddDockerfileBuilderOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDockerfileFactory", + "capabilityId": "Aspire.Hosting/addDockerfileFactory", + "qualifiedName": "addDockerfileFactory", + "description": "Adds a Dockerfile to the application model that can be treated like a container resource, with the Dockerfile content generated by an asynchronous factory function.", + "remarks": "The `contextPath` is relative to the AppHost directory unless it is fully qualified.\nThe factory function is invoked once during the build process to generate the Dockerfile content.\nThe output is trusted and not validated.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerfileFactory(name string, contextPath string, dockerfileFactory func(arg DockerfileFactoryContext) string, options ...*AddDockerfileFactoryOptions) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "dockerfileFactory", + "type": "func(arg DockerfileFactoryContext) string", + "isCallback": true, + "callbackSignature": "func(arg DockerfileFactoryContext) string", + "description": "An asynchronous function that returns the Dockerfile content as a string." + } + ], + "options": { + "typeName": "AddDockerfileFactoryOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDotnetTool", + "capabilityId": "Aspire.Hosting/addDotnetTool", + "qualifiedName": "addDotnetTool", + "description": "Adds a .NET tool resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDotnetTool(name string, packageId string) DotnetToolResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "packageId", + "type": "string", + "description": "The package id of the tool." + } + ], + "returnType": "DotnetToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddEventingSubscriber", + "capabilityId": "Aspire.Hosting/addEventingSubscriber", + "qualifiedName": "addEventingSubscriber", + "description": "Adds an ATS-friendly eventing subscriber callback to the distributed-application builder.", + "kind": "Method", + "signature": "AddEventingSubscriber(subscribe func(arg EventingSubscriberRegistrationContext)) error", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "subscribe", + "type": "func(arg EventingSubscriberRegistrationContext)", + "isCallback": true, + "callbackSignature": "func(arg EventingSubscriberRegistrationContext)", + "description": "The callback that registers the event subscriptions." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddExecutable", + "capabilityId": "Aspire.Hosting/addExecutable", + "qualifiedName": "addExecutable", + "description": "Adds an executable resource to the application model.", + "remarks": "You can run any executable command using its full path.\nAs a security feature, Aspire doesn't run executable unless the command is located in a path listed in the PATH environment variable.\nTo run an executable file that's in the current directory, specify the full path or use the relative path `./` to represent the current directory.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddExecutable(name string, command string, workingDirectory string, args []string) ExecutableResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "command", + "type": "string", + "description": "The executable path. This can be a fully qualified path or a executable to run from the shell/command line." + }, + { + "name": "workingDirectory", + "type": "string", + "description": "The working directory of the executable." + }, + { + "name": "args", + "type": "[]string", + "description": "The arguments to the executable." + } + ], + "returnType": "ExecutableResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddExternalService", + "capabilityId": "Aspire.Hosting/addExternalService", + "qualifiedName": "addExternalService", + "description": "Adds an external service resource", + "kind": "Method", + "signature": "AddExternalService(name string, url any) ExternalServiceResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "ExternalServiceResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddHealthCheck", + "capabilityId": "Aspire.Hosting/addHealthCheck", + "qualifiedName": "addHealthCheck", + "description": "Adds a custom health check callback to the distributed-application builder.", + "kind": "Method", + "signature": "AddHealthCheck(name string, check func(...any) *HealthCheckResult) error", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The health check registration name." + }, + { + "name": "check", + "type": "func(...any) *HealthCheckResult", + "isCallback": true, + "callbackSignature": "func(...any) *HealthCheckResult", + "description": "The callback that evaluates the health check." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddMarkdown", + "capabilityId": "Aspire.Hosting/addMarkdown", + "qualifiedName": "addMarkdown", + "description": "Adds a key-value pair to the pipeline summary with a Markdown-formatted value.", + "kind": "Method", + "signature": "AddMarkdown(key string, markdownString string) error", + "receiver": "PipelineSummary", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key or label for the item." + }, + { + "name": "markdownString", + "type": "string", + "description": "The Markdown-formatted value for the item." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineSummary", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineSummary" + ], + "appliesTo": [ + "PipelineSummary" + ] + }, + { + "name": "AddParameter", + "capabilityId": "Aspire.Hosting/addParameter", + "qualifiedName": "addParameter", + "description": "Adds a parameter resource", + "kind": "Method", + "signature": "AddParameter(name string, options ...*AddParameterOptions) ParameterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddParameterOptions", + "fields": [ + { + "name": "Value", + "jsonName": "value", + "type": "*string" + }, + { + "name": "PublishValueAsDefault", + "jsonName": "publishValueAsDefault", + "type": "*bool" + }, + { + "name": "Secret", + "jsonName": "secret", + "type": "*bool" + } + ] + }, + "returnType": "ParameterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddParameterFromConfiguration", + "capabilityId": "Aspire.Hosting/addParameterFromConfiguration", + "qualifiedName": "addParameterFromConfiguration", + "description": "Adds a parameter resource to the application, with a value coming from configuration.", + "returns": "Resource builder for the parameter.", + "kind": "Method", + "signature": "AddParameterFromConfiguration(name string, configurationKey string, options ...*AddParameterFromConfigurationOptions) ParameterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "Name of parameter resource" + }, + { + "name": "configurationKey", + "type": "string", + "description": "Configuration key used to get the value of the parameter" + } + ], + "options": { + "typeName": "AddParameterFromConfigurationOptions", + "fields": [ + { + "name": "Secret", + "jsonName": "secret", + "type": "*bool", + "description": "Optional flag indicating whether the parameter should be regarded as secret." + } + ] + }, + "returnType": "ParameterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddParameterWithGeneratedValue", + "capabilityId": "Aspire.Hosting/addParameterWithGeneratedValue", + "qualifiedName": "addParameterWithGeneratedValue", + "description": "Adds a parameter with a generated default value", + "kind": "Method", + "signature": "AddParameterWithGeneratedValue(name string, value *GenerateParameterDefault, options ...*AddParameterWithGeneratedValueOptions) ParameterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "*GenerateParameterDefault" + } + ], + "options": { + "typeName": "AddParameterWithGeneratedValueOptions", + "fields": [ + { + "name": "Secret", + "jsonName": "secret", + "type": "*bool" + }, + { + "name": "Persist", + "jsonName": "persist", + "type": "*bool" + } + ] + }, + "returnType": "ParameterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddProject", + "capabilityId": "Aspire.Hosting/addProject", + "qualifiedName": "addProject", + "description": "Adds a .NET project resource", + "kind": "Method", + "signature": "AddProject(name string, projectPath string, options ...*AddProjectOptions) ProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "projectPath", + "type": "string" + } + ], + "options": { + "typeName": "AddProjectOptions", + "fields": [ + { + "name": "LaunchProfileOrOptions", + "jsonName": "launchProfileOrOptions", + "type": "any" + } + ] + }, + "returnType": "ProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddStep", + "capabilityId": "Aspire.Hosting/addStep", + "qualifiedName": "addStep", + "description": "Adds an application-level pipeline step in a TypeScript-friendly shape.", + "kind": "Method", + "signature": "AddStep(stepName string, callback func(arg PipelineStepContext), options ...*AddStepOptions) error", + "receiver": "DistributedApplicationPipeline", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The unique name of the pipeline step." + }, + { + "name": "callback", + "type": "func(arg PipelineStepContext)", + "isCallback": true, + "callbackSignature": "func(arg PipelineStepContext)", + "description": "The callback to execute when the step runs." + } + ], + "options": { + "typeName": "AddStepOptions", + "fields": [ + { + "name": "DependsOn", + "jsonName": "dependsOn", + "type": "[]string", + "description": "Optional step names that this step depends on." + }, + { + "name": "RequiredBy", + "jsonName": "requiredBy", + "type": "[]string", + "description": "Optional step names that require this step." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline" + ], + "appliesTo": [ + "DistributedApplicationPipeline" + ] + }, + { + "name": "Arg", + "capabilityId": "Aspire.Hosting/dockerfileBuilderArg", + "qualifiedName": "arg", + "description": "Adds a global ARG statement to the Dockerfile", + "kind": "Method", + "signature": "Arg(name string, options ...*ArgOptions) DockerfileBuilder", + "receiver": "DockerfileBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "ArgOptions", + "fields": [ + { + "name": "DefaultValue", + "jsonName": "defaultValue", + "type": "*string" + } + ] + }, + "returnType": "DockerfileBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder" + ], + "appliesTo": [ + "DockerfileBuilder" + ] + }, + { + "name": "Arg", + "capabilityId": "Aspire.Hosting/dockerfileStageArg", + "qualifiedName": "arg", + "description": "Adds an ARG statement to a Dockerfile stage", + "kind": "Method", + "signature": "Arg(name string, options ...*ArgOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "ArgOptions", + "fields": [ + { + "name": "DefaultValue", + "jsonName": "defaultValue", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "AsHttp2Service", + "capabilityId": "Aspire.Hosting/asHttp2Service", + "qualifiedName": "asHttp2Service", + "description": "Configures a resource to mark all endpoints' transport as HTTP/2. This is useful for HTTP/2 services that need prior knowledge.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsHttp2Service() ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting/buildExecutionConfiguration", + "qualifiedName": "build", + "description": "Builds the execution configuration for the specified builder.", + "returns": "The resolved execution configuration.", + "kind": "Method", + "signature": "Build(executionContext DistributedApplicationExecutionContext, options ...*BuildOptions) ExecutionConfigurationResult", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [ + { + "name": "executionContext", + "type": "DistributedApplicationExecutionContext", + "description": "The execution context used while building the configuration." + } + ], + "options": { + "typeName": "BuildOptions", + "fields": [ + { + "name": "ResourceLogger", + "jsonName": "resourceLogger", + "type": "*Logger", + "description": "The logger used while resolving values." + }, + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "A cancellation token." + } + ] + }, + "returnType": "ExecutionConfigurationResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "ClearContainerFilesSources", + "capabilityId": "Aspire.Hosting/clearContainerFilesSources", + "qualifiedName": "clearContainerFilesSources", + "description": "Removes any container files source annotation from the resource being built.", + "returns": "The resource builder instance with the container files source annotation applied.", + "kind": "Method", + "signature": "ClearContainerFilesSources() ResourceWithContainerFiles", + "receiver": "ResourceWithContainerFiles", + "parameters": [], + "returnType": "ResourceWithContainerFiles", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IResourceWithContainerFiles", + "expandedTargetTypes": [ + "Aspire.Hosting.IResourceWithContainerFiles" + ], + "appliesTo": [ + "ResourceWithContainerFiles" + ] + }, + { + "name": "Cmd", + "capabilityId": "Aspire.Hosting/cmd", + "qualifiedName": "cmd", + "description": "Adds a CMD statement to a Dockerfile stage", + "kind": "Method", + "signature": "Cmd(command []string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "[]string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Comment", + "capabilityId": "Aspire.Hosting/comment", + "qualifiedName": "comment", + "description": "Adds a comment to a Dockerfile stage", + "kind": "Method", + "signature": "Comment(comment string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "comment", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "CompleteLog", + "capabilityId": "Aspire.Hosting/completeLog", + "qualifiedName": "completeLog", + "description": "Completes the log stream for a resource.", + "kind": "Method", + "signature": "CompleteLog(resource Resource) error", + "receiver": "ResourceLoggerService", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceLoggerService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceLoggerService" + ], + "appliesTo": [ + "ResourceLoggerService" + ] + }, + { + "name": "CompleteLogByName", + "capabilityId": "Aspire.Hosting/completeLogByName", + "qualifiedName": "completeLogByName", + "description": "Completes the log stream by resource name.", + "kind": "Method", + "signature": "CompleteLogByName(resourceName string) error", + "receiver": "ResourceLoggerService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceLoggerService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceLoggerService" + ], + "appliesTo": [ + "ResourceLoggerService" + ] + }, + { + "name": "CompleteStep", + "capabilityId": "Aspire.Hosting/completeStep", + "qualifiedName": "completeStep", + "description": "Completes the reporting step with plain-text completion text.", + "kind": "Method", + "signature": "CompleteStep(completionText string, options ...*CompleteStepOptions) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "completionText", + "type": "string" + } + ], + "options": { + "typeName": "CompleteStepOptions", + "fields": [ + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CompleteStepMarkdown", + "capabilityId": "Aspire.Hosting/completeStepMarkdown", + "qualifiedName": "completeStepMarkdown", + "description": "Completes the reporting step with Markdown-formatted completion text.", + "kind": "Method", + "signature": "CompleteStepMarkdown(markdownString string, options ...*CompleteStepMarkdownOptions) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "CompleteStepMarkdownOptions", + "fields": [ + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CompleteTask", + "capabilityId": "Aspire.Hosting/completeTask", + "qualifiedName": "completeTask", + "description": "Completes the reporting task with plain-text completion text.", + "kind": "Method", + "signature": "CompleteTask(options ...*CompleteTaskOptions) error", + "receiver": "ReportingTask", + "parameters": [], + "options": { + "typeName": "CompleteTaskOptions", + "fields": [ + { + "name": "CompletionMessage", + "jsonName": "completionMessage", + "type": "*string" + }, + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "CompleteTaskMarkdown", + "capabilityId": "Aspire.Hosting/completeTaskMarkdown", + "qualifiedName": "completeTaskMarkdown", + "description": "Completes the reporting task with Markdown-formatted completion text.", + "kind": "Method", + "signature": "CompleteTaskMarkdown(markdownString string, options ...*CompleteTaskMarkdownOptions) error", + "receiver": "ReportingTask", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "CompleteTaskMarkdownOptions", + "fields": [ + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "Configure", + "capabilityId": "Aspire.Hosting/configure", + "qualifiedName": "configure", + "description": "Registers a pipeline configuration callback in a TypeScript-friendly shape.", + "kind": "Method", + "signature": "Configure(callback func(arg PipelineConfigurationContext)) error", + "receiver": "DistributedApplicationPipeline", + "parameters": [ + { + "name": "callback", + "type": "func(arg PipelineConfigurationContext)", + "isCallback": true, + "callbackSignature": "func(arg PipelineConfigurationContext)", + "description": "The callback to execute during pipeline configuration." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline" + ], + "appliesTo": [ + "DistributedApplicationPipeline" + ] + }, + { + "name": "Copy", + "capabilityId": "Aspire.Hosting/dockerfileStageCopy", + "qualifiedName": "copy", + "description": "Adds a COPY statement to a Dockerfile stage", + "kind": "Method", + "signature": "Copy(source string, destination string, options ...*CopyOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "source", + "type": "string" + }, + { + "name": "destination", + "type": "string" + } + ], + "options": { + "typeName": "CopyOptions", + "fields": [ + { + "name": "Chown", + "jsonName": "chown", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "CopyFrom", + "capabilityId": "Aspire.Hosting/dockerfileStageCopyFrom", + "qualifiedName": "copyFrom", + "description": "Adds a COPY --from statement to a Dockerfile stage", + "kind": "Method", + "signature": "CopyFrom(from string, source string, destination string, options ...*CopyFromOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "from", + "type": "string" + }, + { + "name": "source", + "type": "string" + }, + { + "name": "destination", + "type": "string" + } + ], + "options": { + "typeName": "CopyFromOptions", + "fields": [ + { + "name": "Chown", + "jsonName": "chown", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "CreateBooleanInput", + "capabilityId": "Aspire.Hosting/createBooleanInput", + "qualifiedName": "createBooleanInput", + "description": "Creates a boolean (checkbox) input.", + "kind": "Method", + "signature": "CreateBooleanInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateBuilder", + "capabilityId": "Aspire.Hosting/createBuilder", + "qualifiedName": "createBuilder", + "description": "Creates a new distributed application builder", + "kind": "Method", + "signature": "CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)", + "parameters": [], + "options": { + "typeName": "CreateBuilderOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "(DistributedApplicationBuilder, error)", + "errorModel": "returned", + "targetTypeId": "any", + "expandedTargetTypes": [ + "any" + ], + "appliesTo": [] + }, + { + "name": "CreateCertificateFile", + "capabilityId": "Aspire.Hosting/createCertificateFile", + "qualifiedName": "createCertificateFile", + "description": "Creates a PEM container certificate file entry with the OpenSSL subject-hash symlink.", + "returns": "The created certificate file entry.", + "kind": "Method", + "signature": "CreateCertificateFile(name string, options ...*CreateCertificateFileOptions) ContainerFileSystemItem", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The simple file name (no path separators)." + } + ], + "options": { + "typeName": "CreateCertificateFileOptions", + "fields": [ + { + "name": "Contents", + "jsonName": "contents", + "type": "*string", + "description": "The inline PEM-encoded contents of the certificate. Mutually exclusive with `sourcePath`." + }, + { + "name": "SourcePath", + "jsonName": "sourcePath", + "type": "*string", + "description": "An absolute path to a PEM file on the host to copy. Mutually exclusive with `contents`." + }, + { + "name": "Owner", + "jsonName": "owner", + "type": "*float64", + "description": "The owner UID, or `null` to inherit." + }, + { + "name": "Group", + "jsonName": "group", + "type": "*float64", + "description": "The group GID, or `null` to inherit." + }, + { + "name": "Mode", + "jsonName": "mode", + "type": "*float64", + "description": "The Unix file mode as an integer (for example `0o644`), or `null` to inherit." + }, + { + "name": "ContinueOnError", + "jsonName": "continueOnError", + "type": "*bool", + "description": "Whether to ignore errors creating this file." + } + ] + }, + "returnType": "ContainerFileSystemItem", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "CreateChoiceInput", + "capabilityId": "Aspire.Hosting/createChoiceInput", + "qualifiedName": "createChoiceInput", + "description": "Creates a choice input that selects from a list of options.", + "kind": "Method", + "signature": "CreateChoiceInput(name string, options ...*CreateChoiceInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the input." + } + ], + "options": { + "typeName": "CreateChoiceInputOptions", + "fields": [ + { + "name": "Choices", + "jsonName": "choices", + "type": "[]*InteractionChoiceOption", + "description": "The available choices, in display order. Each option pairs a submitted value with a display label." + }, + { + "name": "Options", + "jsonName": "options", + "type": "*CreateInteractionInputOptions", + "description": "Optional configuration for the input." + } + ] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateDirectory", + "capabilityId": "Aspire.Hosting/createDirectory", + "qualifiedName": "createDirectory", + "description": "Creates a container directory entry containing the specified child entries.", + "returns": "The created directory entry.", + "kind": "Method", + "signature": "CreateDirectory(name string, entries []ContainerFileSystemItem, options ...*CreateDirectoryOptions) ContainerFileSystemItem", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The simple directory name (no path separators)." + }, + { + "name": "entries", + "type": "[]ContainerFileSystemItem", + "description": "The child entries (files and/or directories) created via this context." + } + ], + "options": { + "typeName": "CreateDirectoryOptions", + "fields": [ + { + "name": "Owner", + "jsonName": "owner", + "type": "*float64", + "description": "The owner UID, or `null` to inherit." + }, + { + "name": "Group", + "jsonName": "group", + "type": "*float64", + "description": "The group GID, or `null` to inherit." + }, + { + "name": "Mode", + "jsonName": "mode", + "type": "*float64", + "description": "The Unix file mode as an integer (for example `0o755`), or `null` to inherit." + } + ] + }, + "returnType": "ContainerFileSystemItem", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "CreateExecutionConfiguration", + "capabilityId": "Aspire.Hosting/createExecutionConfiguration", + "qualifiedName": "createExecutionConfiguration", + "description": "Creates an execution configuration builder for the specified resource.", + "returns": "The execution configuration builder.", + "kind": "Method", + "signature": "CreateExecutionConfiguration() ExecutionConfigurationBuilder", + "receiver": "Resource", + "parameters": [], + "returnType": "ExecutionConfigurationBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "CreateFile", + "capabilityId": "Aspire.Hosting/createFile", + "qualifiedName": "createFile", + "description": "Creates a container file entry with inline contents or a host source path.", + "returns": "The created file entry.", + "kind": "Method", + "signature": "CreateFile(name string, options ...*CreateFileOptions) ContainerFileSystemItem", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The simple file name (no path separators)." + } + ], + "options": { + "typeName": "CreateFileOptions", + "fields": [ + { + "name": "Contents", + "jsonName": "contents", + "type": "*string", + "description": "The inline UTF-8 contents of the file. Mutually exclusive with `sourcePath`." + }, + { + "name": "SourcePath", + "jsonName": "sourcePath", + "type": "*string", + "description": "An absolute path to a file on the host to copy. Mutually exclusive with `contents`." + }, + { + "name": "Owner", + "jsonName": "owner", + "type": "*float64", + "description": "The owner UID, or `null` to inherit." + }, + { + "name": "Group", + "jsonName": "group", + "type": "*float64", + "description": "The group GID, or `null` to inherit." + }, + { + "name": "Mode", + "jsonName": "mode", + "type": "*float64", + "description": "The Unix file mode as an integer (for example `0o644`), or `null` to inherit." + }, + { + "name": "ContinueOnError", + "jsonName": "continueOnError", + "type": "*bool", + "description": "Whether to ignore errors creating this file." + } + ] + }, + "returnType": "ContainerFileSystemItem", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "CreateFileInput", + "capabilityId": "Aspire.Hosting/createFileInput", + "qualifiedName": "createFileInput", + "description": "Creates a file input.", + "kind": "Method", + "signature": "CreateFileInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateLogger", + "capabilityId": "Aspire.Hosting/createLogger", + "qualifiedName": "createLogger", + "description": "Creates a logger for the specified category name.", + "returns": "A logger handle.", + "kind": "Method", + "signature": "CreateLogger(categoryName string) Logger", + "receiver": "LoggerFactory", + "parameters": [ + { + "name": "categoryName", + "type": "string", + "description": "The category name." + } + ], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILoggerFactory", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILoggerFactory" + ], + "appliesTo": [ + "LoggerFactory" + ] + }, + { + "name": "CreateMarkdownTask", + "capabilityId": "Aspire.Hosting/createMarkdownTask", + "qualifiedName": "createMarkdownTask", + "description": "Creates a reporting task with Markdown-formatted status text.", + "kind": "Method", + "signature": "CreateMarkdownTask(markdownString string, options ...*CreateMarkdownTaskOptions) ReportingTask", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "CreateMarkdownTaskOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "ReportingTask", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CreateNumberInput", + "capabilityId": "Aspire.Hosting/createNumberInput", + "qualifiedName": "createNumberInput", + "description": "Creates a numeric input.", + "kind": "Method", + "signature": "CreateNumberInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateSecretInput", + "capabilityId": "Aspire.Hosting/createSecretInput", + "qualifiedName": "createSecretInput", + "description": "Creates a secret (masked) text input.", + "kind": "Method", + "signature": "CreateSecretInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateTask", + "capabilityId": "Aspire.Hosting/createTask", + "qualifiedName": "createTask", + "description": "Creates a reporting task with plain-text status text.", + "kind": "Method", + "signature": "CreateTask(statusText string, options ...*CreateTaskOptions) ReportingTask", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "statusText", + "type": "string" + } + ], + "options": { + "typeName": "CreateTaskOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "ReportingTask", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CreateTextInput", + "capabilityId": "Aspire.Hosting/createTextInput", + "qualifiedName": "createTextInput", + "description": "Creates a single-line text input.", + "kind": "Method", + "signature": "CreateTextInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "DisableBuildOnlyContainerValidation", + "capabilityId": "Aspire.Hosting/disableBuildOnlyContainerValidation", + "qualifiedName": "disableBuildOnlyContainerValidation", + "description": "Disables the publish and deploy validation that requires build-only containers to be consumed by another resource.", + "remarks": "This is an application-wide escape hatch for scenarios where the build-only container validation is too restrictive\nfor a particular app. Prefer wiring build-only containers through `PublishWithContainerFiles` or\n`PublishWithStaticFiles` when possible.", + "returns": "The distributed application pipeline for chaining.", + "kind": "Method", + "signature": "DisableBuildOnlyContainerValidation() DistributedApplicationPipeline", + "receiver": "DistributedApplicationPipeline", + "parameters": [], + "returnType": "DistributedApplicationPipeline", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline" + ], + "appliesTo": [ + "DistributedApplicationPipeline" + ] + }, + { + "name": "DisableForwardedHeaders", + "capabilityId": "Aspire.Hosting/disableForwardedHeaders", + "qualifiedName": "disableForwardedHeaders", + "description": "Configures the project to disable forwarded headers when being published.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "DisableForwardedHeaders() ProjectResource", + "receiver": "ProjectResource", + "parameters": [], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "EmptyLine", + "capabilityId": "Aspire.Hosting/emptyLine", + "qualifiedName": "emptyLine", + "description": "Adds an empty line to a Dockerfile stage", + "kind": "Method", + "signature": "EmptyLine() DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Entrypoint", + "capabilityId": "Aspire.Hosting/entrypoint", + "qualifiedName": "entrypoint", + "description": "Adds an ENTRYPOINT statement to a Dockerfile stage", + "kind": "Method", + "signature": "Entrypoint(command []string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "[]string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Env", + "capabilityId": "Aspire.Hosting/env", + "qualifiedName": "env", + "description": "Adds an ENV statement to a Dockerfile stage", + "kind": "Method", + "signature": "Env(name string, value string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "ExcludeFromManifest", + "capabilityId": "Aspire.Hosting/excludeFromManifest", + "qualifiedName": "excludeFromManifest", + "description": "Excludes a resource from being published to the manifest.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ExcludeFromManifest() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "ExcludeFromMcp", + "capabilityId": "Aspire.Hosting/excludeFromMcp", + "qualifiedName": "excludeFromMcp", + "description": "Exclude the resource from MCP operations using the Aspire MCP server. The resource is excluded from results that return resources, console logs and telemetry.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ExcludeFromMcp() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "ExecuteCommandAsync", + "capabilityId": "Aspire.Hosting/executeResourceCommand", + "qualifiedName": "executeCommandAsync", + "description": "Executes a command for the specified resource.", + "returns": "The command execution result.", + "kind": "Method", + "signature": "ExecuteCommandAsync(resource any, commandName string, options ...*ExecuteCommandAsyncOptions) (*ExecuteCommandResult, error)", + "receiver": "ResourceCommandService", + "parameters": [ + { + "name": "resource", + "type": "any", + "allowedTypes": [ + "string", + "Resource" + ], + "description": "The resource id or resource handle. A resource id can either exactly match the unique id of the resource or the displayed resource name if the resource name doesn't have duplicates." + }, + { + "name": "commandName", + "type": "string", + "description": "The command name." + } + ], + "options": { + "typeName": "ExecuteCommandAsyncOptions", + "fields": [ + { + "name": "Arguments", + "jsonName": "arguments", + "type": "map[string]string", + "description": "The optional invocation arguments supplied to the command callback." + }, + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The cancellation token." + } + ] + }, + "returnType": "(*ExecuteCommandResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceCommandService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceCommandService" + ], + "appliesTo": [ + "ResourceCommandService" + ] + }, + { + "name": "Exists", + "capabilityId": "Aspire.Hosting/exists", + "qualifiedName": "exists", + "description": "Checks whether a configuration section exists.", + "returns": "`true` when the section exists; otherwise, `false`.", + "kind": "Method", + "signature": "Exists(key string) (bool, error)", + "receiver": "Configuration", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The configuration key." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "Expose", + "capabilityId": "Aspire.Hosting/expose", + "qualifiedName": "expose", + "description": "Adds an EXPOSE statement to a Dockerfile stage", + "kind": "Method", + "signature": "Expose(port float64) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "port", + "type": "float64" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "FindResourceByName", + "capabilityId": "Aspire.Hosting/findResourceByName", + "qualifiedName": "findResourceByName", + "description": "Finds a resource by name.", + "returns": "The matching resource, or `null` when not found.", + "kind": "Method", + "signature": "FindResourceByName(name string) Resource", + "receiver": "DistributedApplicationModel", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The resource name." + } + ], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DistributedApplicationModel", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DistributedApplicationModel" + ], + "appliesTo": [ + "DistributedApplicationModel" + ] + }, + { + "name": "From", + "capabilityId": "Aspire.Hosting/dockerfileBuilderFrom", + "qualifiedName": "from", + "description": "Adds a FROM statement to start a Dockerfile stage", + "kind": "Method", + "signature": "From(image string, options ...*FromOptions) DockerfileStage", + "receiver": "DockerfileBuilder", + "parameters": [ + { + "name": "image", + "type": "string" + } + ], + "options": { + "typeName": "FromOptions", + "fields": [ + { + "name": "StageName", + "jsonName": "stageName", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder" + ], + "appliesTo": [ + "DockerfileBuilder" + ] + }, + { + "name": "GetAspireStore", + "capabilityId": "Aspire.Hosting/getAspireStore", + "qualifiedName": "getAspireStore", + "description": "Gets the Aspire store from the service provider.", + "returns": "The Aspire store.", + "kind": "Method", + "signature": "GetAspireStore() AspireStore", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "AspireStore", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetCertificateTrustData", + "capabilityId": "Aspire.Hosting/getCertificateTrustData", + "qualifiedName": "getCertificateTrustData", + "description": "Gets certificate trust execution-configuration data when present.", + "returns": "The certificate trust data. When no additional data is present, an empty DTO is returned.", + "kind": "Method", + "signature": "GetCertificateTrustData() (*CertificateTrustExecutionConfigurationExportData, error)", + "receiver": "ExecutionConfigurationResult", + "parameters": [], + "returnType": "(*CertificateTrustExecutionConfigurationExportData, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult" + ], + "appliesTo": [ + "ExecutionConfigurationResult" + ] + }, + { + "name": "GetChildren", + "capabilityId": "Aspire.Hosting/getChildren", + "qualifiedName": "getChildren", + "description": "Gets the child sections of a configuration handle.", + "returns": "The child sections.", + "kind": "Method", + "signature": "GetChildren() ([]ConfigurationSection, error)", + "receiver": "Configuration", + "parameters": [], + "returnType": "([]ConfigurationSection, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetConfigValue", + "capabilityId": "Aspire.Hosting/getConfigValue", + "qualifiedName": "getConfigValue", + "description": "Gets a configuration value by key.", + "returns": "The configuration value, or null if not found.", + "kind": "Method", + "signature": "GetConfigValue(key string) (string, error)", + "receiver": "Configuration", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The configuration key (e.g., \"ConnectionStrings:Default\")." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetConfiguration", + "capabilityId": "Aspire.Hosting/getConfiguration", + "qualifiedName": "getConfiguration", + "description": "Gets the application configuration.", + "returns": "The configuration handle.", + "kind": "Method", + "signature": "GetConfiguration() Configuration", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "Configuration", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "GetConnectionProperty", + "capabilityId": "Aspire.Hosting/getConnectionProperty", + "qualifiedName": "getConnectionProperty", + "description": "Retrieves the value of a specified connection property from the resource's connection properties.", + "remarks": "Throws a KeyNotFoundException if the specified key does not exist in the resource's\nconnection properties.", + "returns": "The value associated with the specified connection property key.", + "kind": "Method", + "signature": "GetConnectionProperty(key string) *ReferenceExpression", + "receiver": "ResourceWithConnectionString", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key of the connection property to retrieve. Cannot be null." + } + ], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString" + ], + "appliesTo": [ + "ResourceWithConnectionString" + ] + }, + { + "name": "GetConnectionString", + "capabilityId": "Aspire.Hosting/getConnectionString", + "qualifiedName": "getConnectionString", + "description": "Gets a connection string by name.", + "returns": "The connection string value, or null if not found.", + "kind": "Method", + "signature": "GetConnectionString(name string) (string, error)", + "receiver": "Configuration", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The connection string name." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetDistributedApplicationModel", + "capabilityId": "Aspire.Hosting/getDistributedApplicationModel", + "qualifiedName": "getDistributedApplicationModel", + "description": "Gets the distributed application model from the service provider.", + "returns": "The distributed application model handle.", + "kind": "Method", + "signature": "GetDistributedApplicationModel() DistributedApplicationModel", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetEndpoint", + "capabilityId": "Aspire.Hosting/getEndpoint", + "qualifiedName": "getEndpoint", + "description": "Gets an endpoint reference", + "returns": "An `EndpointReference` that can be used to resolve the address of the endpoint after resource allocation has occurred.", + "kind": "Method", + "signature": "GetEndpoint(name string) EndpointReference", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the endpoint." + } + ], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "GetEventing", + "capabilityId": "Aspire.Hosting/getEventing", + "qualifiedName": "getEventing", + "description": "Gets the distributed application eventing service from the service provider.", + "returns": "The distributed application eventing handle.", + "kind": "Method", + "signature": "GetEventing() DistributedApplicationEventing", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "DistributedApplicationEventing", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetFileNameWithContent", + "capabilityId": "Aspire.Hosting/getFileNameWithContent", + "qualifiedName": "getFileNameWithContent", + "description": "Gets a deterministic file path that is a copy of the `sourceFilename`. The resulting file name will depend on the content of the file.", + "returns": "A deterministic file path with the same content as `sourceFilename`.", + "kind": "Method", + "signature": "GetFileNameWithContent(filenameTemplate string, sourceFilename string) (string, error)", + "receiver": "AspireStore", + "parameters": [ + { + "name": "filenameTemplate", + "type": "string", + "description": "A file name to base the result on." + }, + { + "name": "sourceFilename", + "type": "string", + "description": "An existing file." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IAspireStore", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IAspireStore" + ], + "appliesTo": [ + "AspireStore" + ] + }, + { + "name": "GetHttpsCertificateData", + "capabilityId": "Aspire.Hosting/getHttpsCertificateData", + "qualifiedName": "getHttpsCertificateData", + "description": "Gets HTTPS certificate execution-configuration data when present.", + "returns": "The HTTPS certificate data. When no additional data is present, an empty DTO is returned.", + "kind": "Method", + "signature": "GetHttpsCertificateData() (*HttpsCertificateExecutionConfigurationExportData, error)", + "receiver": "ExecutionConfigurationResult", + "parameters": [], + "returnType": "(*HttpsCertificateExecutionConfigurationExportData, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult" + ], + "appliesTo": [ + "ExecutionConfigurationResult" + ] + }, + { + "name": "GetInteractionService", + "capabilityId": "Aspire.Hosting/getInteractionService", + "qualifiedName": "getInteractionService", + "description": "Gets the interaction service from the service provider.", + "returns": "An interaction service handle.", + "kind": "Method", + "signature": "GetInteractionService() InteractionService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "InteractionService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetLoggerFactory", + "capabilityId": "Aspire.Hosting/getLoggerFactory", + "qualifiedName": "getLoggerFactory", + "description": "Gets the logger factory from the service provider.", + "returns": "A logger factory handle.", + "kind": "Method", + "signature": "GetLoggerFactory() LoggerFactory", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "LoggerFactory", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetOrSetSecret", + "capabilityId": "Aspire.Hosting/getOrSetSecret", + "qualifiedName": "getOrSetSecret", + "description": "Gets a secret value if it exists in configuration, or sets it to the provided value if it does not.", + "kind": "Method", + "signature": "GetOrSetSecret(resourceBuilder Resource, name string, value string) error", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "resourceBuilder", + "type": "Resource", + "description": "A resource builder from the target application." + }, + { + "name": "name", + "type": "string", + "description": "The secret name." + }, + { + "name": "value", + "type": "string", + "description": "The value to persist when the secret is missing." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "GetResourceCommandService", + "capabilityId": "Aspire.Hosting/getResourceCommandService", + "qualifiedName": "getResourceCommandService", + "description": "Gets the resource command service from the service provider.", + "returns": "A resource command service handle.", + "kind": "Method", + "signature": "GetResourceCommandService() ResourceCommandService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "ResourceCommandService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetResourceLoggerService", + "capabilityId": "Aspire.Hosting/getResourceLoggerService", + "qualifiedName": "getResourceLoggerService", + "description": "Gets the resource logger service from the service provider.", + "returns": "A resource logger service handle.", + "kind": "Method", + "signature": "GetResourceLoggerService() ResourceLoggerService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "ResourceLoggerService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetResourceName", + "capabilityId": "Aspire.Hosting/getResourceName", + "qualifiedName": "getResourceName", + "description": "Gets the name of the resource from a builder.", + "remarks": "Why this wrapper exists: This capability accesses a nested property\n(`resource.Resource.Name`) which requires a wrapper method. There is no single\n.NET method that returns just the resource name that could be annotated directly.", + "returns": "The resource name.", + "kind": "Method", + "signature": "GetResourceName() (string, error)", + "receiver": "Resource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "GetResourceNotificationService", + "capabilityId": "Aspire.Hosting/getResourceNotificationService", + "qualifiedName": "getResourceNotificationService", + "description": "Gets the resource notification service from the service provider.", + "returns": "A resource notification service handle.", + "kind": "Method", + "signature": "GetResourceNotificationService() ResourceNotificationService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "ResourceNotificationService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetResources", + "capabilityId": "Aspire.Hosting/getResources", + "qualifiedName": "getResources", + "description": "Gets all resources in the distributed application model.", + "returns": "The resources in the model.", + "kind": "Method", + "signature": "GetResources() ([]Resource, error)", + "receiver": "DistributedApplicationModel", + "parameters": [], + "returnType": "([]Resource, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DistributedApplicationModel", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DistributedApplicationModel" + ], + "appliesTo": [ + "DistributedApplicationModel" + ] + }, + { + "name": "GetSection", + "capabilityId": "Aspire.Hosting/getSection", + "qualifiedName": "getSection", + "description": "Gets a configuration section by key.", + "returns": "The configuration section handle.", + "kind": "Method", + "signature": "GetSection(key string) ConfigurationSection", + "receiver": "Configuration", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The configuration key." + } + ], + "returnType": "ConfigurationSection", + "errorModel": "deferred", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetUserSecretsManager", + "capabilityId": "Aspire.Hosting/getUserSecretsManager", + "qualifiedName": "getUserSecretsManager", + "description": "Gets the user secrets manager from the service provider.", + "returns": "A user secrets manager handle.", + "kind": "Method", + "signature": "GetUserSecretsManager() UserSecretsManager", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "UserSecretsManager", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "IsAvailable", + "capabilityId": "Aspire.Hosting/isAvailable", + "qualifiedName": "isAvailable", + "description": "Gets a value indicating whether the interaction service is available to prompt the user.", + "returns": "`true` when the service can prompt the user; otherwise `false`.", + "kind": "Method", + "signature": "IsAvailable() (bool, error)", + "receiver": "InteractionService", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "IsDevelopment", + "capabilityId": "Aspire.Hosting/isDevelopment", + "qualifiedName": "isDevelopment", + "description": "Checks if the environment is Development.", + "returns": "True if running in Development environment.", + "kind": "Method", + "signature": "IsDevelopment() (bool, error)", + "receiver": "HostEnvironment", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "IsEnvironment", + "capabilityId": "Aspire.Hosting/isEnvironment", + "qualifiedName": "isEnvironment", + "description": "Checks if the environment matches the specified name.", + "returns": "True if the environment matches the specified name.", + "kind": "Method", + "signature": "IsEnvironment(environmentName string) (bool, error)", + "receiver": "HostEnvironment", + "parameters": [ + { + "name": "environmentName", + "type": "string", + "description": "The environment name to compare against." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "IsProduction", + "capabilityId": "Aspire.Hosting/isProduction", + "qualifiedName": "isProduction", + "description": "Checks if the environment is Production.", + "returns": "True if running in Production environment.", + "kind": "Method", + "signature": "IsProduction() (bool, error)", + "receiver": "HostEnvironment", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "IsStaging", + "capabilityId": "Aspire.Hosting/isStaging", + "qualifiedName": "isStaging", + "description": "Checks if the environment is Staging.", + "returns": "True if running in Staging environment.", + "kind": "Method", + "signature": "IsStaging() (bool, error)", + "receiver": "HostEnvironment", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting/log", + "qualifiedName": "log", + "description": "Logs a message with a specified log level.", + "kind": "Method", + "signature": "Log(level string, message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "level", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogDebug", + "capabilityId": "Aspire.Hosting/logDebug", + "qualifiedName": "logDebug", + "description": "Logs a debug message.", + "kind": "Method", + "signature": "LogDebug(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogError", + "capabilityId": "Aspire.Hosting/logError", + "qualifiedName": "logError", + "description": "Logs an error message.", + "kind": "Method", + "signature": "LogError(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogInformation", + "capabilityId": "Aspire.Hosting/logInformation", + "qualifiedName": "logInformation", + "description": "Logs an information message.", + "kind": "Method", + "signature": "LogInformation(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogStep", + "capabilityId": "Aspire.Hosting/logStep", + "qualifiedName": "logStep", + "description": "Logs a plain-text message for the reporting step.", + "kind": "Method", + "signature": "LogStep(level string, message string) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "level", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "LogStepMarkdown", + "capabilityId": "Aspire.Hosting/logStepMarkdown", + "qualifiedName": "logStepMarkdown", + "description": "Logs a Markdown-formatted message for the reporting step.", + "kind": "Method", + "signature": "LogStepMarkdown(level string, markdownString string) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "level", + "type": "string" + }, + { + "name": "markdownString", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "LogWarning", + "capabilityId": "Aspire.Hosting/logWarning", + "qualifiedName": "logWarning", + "description": "Logs a warning message.", + "kind": "Method", + "signature": "LogWarning(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "OnAfterPublish", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnAfterPublish", + "qualifiedName": "onAfterPublish", + "description": "Subscribes to the AfterPublish event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnAfterPublish(callback func(arg AfterPublishEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterPublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterPublishEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnAfterResourcesCreated", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnAfterResourcesCreated", + "qualifiedName": "onAfterResourcesCreated", + "description": "Subscribes to the AfterResourcesCreated event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnAfterResourcesCreated(callback func(arg AfterResourcesCreatedEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterResourcesCreatedEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterResourcesCreatedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnBeforePublish", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnBeforePublish", + "qualifiedName": "onBeforePublish", + "description": "Subscribes to the BeforePublish event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnBeforePublish(callback func(arg BeforePublishEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforePublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforePublishEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnBeforeResourceStarted", + "capabilityId": "Aspire.Hosting/onBeforeResourceStarted", + "qualifiedName": "onBeforeResourceStarted", + "description": "Subscribes to the BeforeResourceStarted event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnBeforeResourceStarted(callback func(arg BeforeResourceStartedEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforeResourceStartedEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforeResourceStartedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnBeforeStart", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnBeforeStart", + "qualifiedName": "onBeforeStart", + "description": "Subscribes to the BeforeStart event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnBeforeStart(callback func(arg BeforeStartEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforeStartEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforeStartEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnConnectionStringAvailable", + "capabilityId": "Aspire.Hosting/onConnectionStringAvailable", + "qualifiedName": "onConnectionStringAvailable", + "description": "Subscribes to the ConnectionStringAvailable event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnConnectionStringAvailable(callback func(arg ConnectionStringAvailableEvent)) ResourceWithConnectionString", + "receiver": "ResourceWithConnectionString", + "parameters": [ + { + "name": "callback", + "type": "func(arg ConnectionStringAvailableEvent)", + "isCallback": true, + "callbackSignature": "func(arg ConnectionStringAvailableEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "ResourceWithConnectionString", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString" + ], + "appliesTo": [ + "ResourceWithConnectionString" + ] + }, + { + "name": "OnInitializeResource", + "capabilityId": "Aspire.Hosting/onInitializeResource", + "qualifiedName": "onInitializeResource", + "description": "Subscribes to the InitializeResource event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnInitializeResource(callback func(arg InitializeResourceEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg InitializeResourceEvent)", + "isCallback": true, + "callbackSignature": "func(arg InitializeResourceEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnResourceEndpointsAllocated", + "capabilityId": "Aspire.Hosting/onResourceEndpointsAllocated", + "qualifiedName": "onResourceEndpointsAllocated", + "description": "Subscribes to the ResourceEndpointsAllocated event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnResourceEndpointsAllocated(callback func(arg ResourceEndpointsAllocatedEvent)) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "callback", + "type": "func(arg ResourceEndpointsAllocatedEvent)", + "isCallback": true, + "callbackSignature": "func(arg ResourceEndpointsAllocatedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "OnResourceReady", + "capabilityId": "Aspire.Hosting/onResourceReady", + "qualifiedName": "onResourceReady", + "description": "Subscribes to the ResourceReady event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnResourceReady(callback func(arg ResourceReadyEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ResourceReadyEvent)", + "isCallback": true, + "callbackSignature": "func(arg ResourceReadyEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnResourceStopped", + "capabilityId": "Aspire.Hosting/onResourceStopped", + "qualifiedName": "onResourceStopped", + "description": "Subscribes to the ResourceStopped event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnResourceStopped(callback func(arg ResourceStoppedEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ResourceStoppedEvent)", + "isCallback": true, + "callbackSignature": "func(arg ResourceStoppedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "PromptConfirmation", + "capabilityId": "Aspire.Hosting/promptConfirmation", + "qualifiedName": "promptConfirmation", + "description": "Prompts the user for confirmation with an OK/Cancel dialog.", + "kind": "Method", + "signature": "PromptConfirmation(title string, message string, options ...*PromptConfirmationOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptConfirmationOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionMessageBoxOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptInput", + "capabilityId": "Aspire.Hosting/promptInput", + "qualifiedName": "promptInput", + "description": "Prompts the user for a single input.", + "kind": "Method", + "signature": "PromptInput(title string, message string, input InteractionInputBuilder, options ...*PromptInputOptions) (*InputInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + }, + { + "name": "input", + "type": "InteractionInputBuilder" + } + ], + "options": { + "typeName": "PromptInputOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionInputsDialogOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*InputInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptInputs", + "capabilityId": "Aspire.Hosting/promptInputs", + "qualifiedName": "promptInputs", + "description": "Prompts the user for multiple inputs.", + "kind": "Method", + "signature": "PromptInputs(title string, message string, inputs []InteractionInputBuilder, options ...*PromptInputsOptions) InputsInteractionResult", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + }, + { + "name": "inputs", + "type": "[]InteractionInputBuilder" + } + ], + "options": { + "typeName": "PromptInputsOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionInputsDialogOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "InputsInteractionResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptMessageBox", + "capabilityId": "Aspire.Hosting/promptMessageBox", + "qualifiedName": "promptMessageBox", + "description": "Prompts the user with a message box dialog.", + "kind": "Method", + "signature": "PromptMessageBox(title string, message string, options ...*PromptMessageBoxOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptMessageBoxOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionMessageBoxOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptNotification", + "capabilityId": "Aspire.Hosting/promptNotification", + "qualifiedName": "promptNotification", + "description": "Prompts the user with a notification.", + "kind": "Method", + "signature": "PromptNotification(title string, message string, options ...*PromptNotificationOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptNotificationOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionNotificationOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptProgress", + "capabilityId": "Aspire.Hosting/promptProgress", + "qualifiedName": "promptProgress", + "description": "Displays a progress dialog with an indeterminate progress indicator.", + "kind": "Method", + "signature": "PromptProgress(message string, options ...*PromptProgressOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptProgressOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionProgressOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PublishAsConnectionString", + "capabilityId": "Aspire.Hosting/publishAsConnectionString", + "qualifiedName": "publishAsConnectionString", + "description": "Changes the resource to be published as a connection string reference in the manifest.", + "remarks": "This API only changes the manifest representation; it does not change the resource model used by other publishers.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsConnectionString() ContainerResource", + "receiver": "ContainerResource", + "parameters": [], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "PublishAsContainer", + "capabilityId": "Aspire.Hosting/publishAsContainer", + "qualifiedName": "publishAsContainer", + "description": "Changes the resource to be published as a container in the manifest.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsContainer() ContainerResource", + "receiver": "ContainerResource", + "parameters": [], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "PublishAsDockerFile", + "capabilityId": "Aspire.Hosting/publishAsDockerFile", + "qualifiedName": "publishAsDockerFile", + "description": "Publishes an executable as a Docker file", + "remarks": "When the executable resource is converted to a container resource, the arguments to the executable\nare not used. This is because arguments to the executable often contain physical paths that are not valid\nin the container. The container can be set up with the correct arguments using the `configure` action.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsDockerFile(configure func(obj ContainerResource)) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj ContainerResource)", + "isCallback": true, + "callbackSignature": "func(obj ContainerResource)", + "description": "Optional action to configure the container resource" + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "PublishAsDockerFile", + "capabilityId": "Aspire.Hosting/publishProjectAsDockerFileWithConfigure", + "qualifiedName": "publishAsDockerFile", + "description": "Publishes a project as a Docker file with optional container configuration", + "remarks": "When the executable resource is converted to a container resource, the arguments to the executable\nare not used. This is because arguments to the project often contain physical paths that are not valid\nin the container. The container can be set up with the correct arguments using the `configure` action.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsDockerFile(options ...*PublishAsDockerFileOptions) ProjectResource", + "receiver": "ProjectResource", + "parameters": [], + "options": { + "typeName": "PublishAsDockerFileOptions", + "fields": [ + { + "name": "Configure", + "type": "func(obj ContainerResource)", + "isCallback": true, + "callbackSignature": "func(obj ContainerResource)", + "description": "Optional action to configure the container resource" + } + ] + }, + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "PublishResourceUpdate", + "capabilityId": "Aspire.Hosting/publishResourceUpdate", + "qualifiedName": "publishResourceUpdate", + "description": "Publishes an update for a resource's state.", + "kind": "Method", + "signature": "PublishResourceUpdate(resource Resource, options ...*PublishResourceUpdateOptions) error", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "options": { + "typeName": "PublishResourceUpdateOptions", + "fields": [ + { + "name": "State", + "jsonName": "state", + "type": "*string" + }, + { + "name": "StateStyle", + "jsonName": "stateStyle", + "type": "*string" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "PublishWithContainerFiles", + "capabilityId": "Aspire.Hosting/publishWithContainerFilesFromResource", + "qualifiedName": "publishWithContainerFiles", + "description": "Configures the resource to copy container files from the specified source resource during publishing.", + "kind": "Method", + "signature": "PublishWithContainerFiles(source ResourceWithContainerFiles, destinationPath string) IContainerFilesDestinationResource", + "receiver": "IContainerFilesDestinationResource", + "parameters": [ + { + "name": "source", + "type": "ResourceWithContainerFiles", + "description": "The resource which contains the container files to be copied." + }, + { + "name": "destinationPath", + "type": "string", + "description": "The destination path within the resource's container where the files will be copied." + } + ], + "returnType": "IContainerFilesDestinationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IContainerFilesDestinationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "Run", + "capabilityId": "Aspire.Hosting/dockerfileStageRun", + "qualifiedName": "run", + "description": "Adds a RUN statement to a Dockerfile stage", + "kind": "Method", + "signature": "Run(command string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "RunWithMounts", + "capabilityId": "Aspire.Hosting/runWithMounts", + "qualifiedName": "runWithMounts", + "description": "Adds a RUN statement with mounts to a Dockerfile stage", + "kind": "Method", + "signature": "RunWithMounts(command string, mounts []string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "string" + }, + { + "name": "mounts", + "type": "[]string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "SaveStateJson", + "capabilityId": "Aspire.Hosting/saveStateJson", + "qualifiedName": "saveStateJson", + "description": "Saves state to user secrets from a JSON string.", + "returns": "A task that completes when the state is saved.", + "kind": "Method", + "signature": "SaveStateJson(json string, options ...*SaveStateJsonOptions) error", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "json", + "type": "string", + "description": "The JSON object payload to persist." + } + ], + "options": { + "typeName": "SaveStateJsonOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The cancellation token." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "SubscribeAfterPublish", + "capabilityId": "Aspire.Hosting/subscribeAfterPublish", + "qualifiedName": "subscribeAfterPublish", + "description": "Subscribes to the AfterPublish event, which fires after the application is published.", + "remarks": "This event provides access to the service provider and distributed application model,\nallowing you to inspect the model after publish pipeline steps complete.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeAfterPublish(callback func(arg AfterPublishEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterPublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterPublishEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeAfterResourcesCreated", + "capabilityId": "Aspire.Hosting/subscribeAfterResourcesCreated", + "qualifiedName": "subscribeAfterResourcesCreated", + "description": "Subscribes to the AfterResourcesCreated event, which fires after all resources are created.", + "remarks": "At this point, all resources have been instantiated but may not yet be running.\nThis is useful for performing cross-resource configuration.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeAfterResourcesCreated(callback func(arg AfterResourcesCreatedEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterResourcesCreatedEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterResourcesCreatedEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeBeforePublish", + "capabilityId": "Aspire.Hosting/subscribeBeforePublish", + "qualifiedName": "subscribeBeforePublish", + "description": "Subscribes to the BeforePublish event, which fires before the application is published.", + "remarks": "This event provides access to the service provider and distributed application model,\nallowing you to perform final configuration or validation before publish pipeline steps run.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeBeforePublish(callback func(arg BeforePublishEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforePublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforePublishEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeBeforeStart", + "capabilityId": "Aspire.Hosting/subscribeBeforeStart", + "qualifiedName": "subscribeBeforeStart", + "description": "Subscribes to the BeforeStart event, which fires before the application starts.", + "remarks": "This event provides access to the service provider and distributed application model,\nallowing you to perform final configuration or validation before resources start.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeBeforeStart(callback func(arg BeforeStartEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforeStartEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforeStartEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeHttpsEndpointsUpdate", + "capabilityId": "Aspire.Hosting/subscribeHttpsEndpointsUpdate", + "qualifiedName": "subscribeHttpsEndpointsUpdate", + "description": "Subscribes to the `BeforeStartEvent` and invokes the specified callback when an HTTPS certificate is determined to be available for the resource. This is used to conditionally update endpoint URI schemes or perform other HTTPS-related configuration at startup.", + "remarks": "The callback is invoked when either:\n-\n-\nSwitch an endpoint to HTTPS when a certificate is available:\n```\nbuilder.SubscribeHttpsEndpointsUpdate(ctx =>\n{\nbuilder.WithEndpoint(\"http\", ep => ep.UriScheme = \"https\");\n});\n```", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "SubscribeHttpsEndpointsUpdate(callback func(obj HttpsEndpointUpdateCallbackContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(obj HttpsEndpointUpdateCallbackContext)", + "isCallback": true, + "callbackSignature": "func(obj HttpsEndpointUpdateCallbackContext)", + "description": "The callback to invoke when HTTPS is enabled. Receives an `HttpsEndpointUpdateCallbackContext` providing access to the service provider, resource, and application model." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "TryAddEventingSubscriber", + "capabilityId": "Aspire.Hosting/tryAddEventingSubscriber", + "qualifiedName": "tryAddEventingSubscriber", + "description": "Attempts to add an ATS-friendly eventing subscriber callback to the distributed-application builder.", + "kind": "Method", + "signature": "TryAddEventingSubscriber(subscribe func(arg EventingSubscriberRegistrationContext)) error", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "subscribe", + "type": "func(arg EventingSubscriberRegistrationContext)", + "isCallback": true, + "callbackSignature": "func(arg EventingSubscriberRegistrationContext)", + "description": "The callback that registers the event subscriptions." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "TryGetResourceState", + "capabilityId": "Aspire.Hosting/tryGetResourceState", + "qualifiedName": "tryGetResourceState", + "description": "Tries to get the current state of a resource.", + "kind": "Method", + "signature": "TryGetResourceState(resourceName string) (*ResourceEventDto, error)", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "returnType": "(*ResourceEventDto, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "UpdateTask", + "capabilityId": "Aspire.Hosting/updateTask", + "qualifiedName": "updateTask", + "description": "Updates the reporting task with plain-text status text.", + "kind": "Method", + "signature": "UpdateTask(statusText string, options ...*UpdateTaskOptions) error", + "receiver": "ReportingTask", + "parameters": [ + { + "name": "statusText", + "type": "string" + } + ], + "options": { + "typeName": "UpdateTaskOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "UpdateTaskMarkdown", + "capabilityId": "Aspire.Hosting/updateTaskMarkdown", + "qualifiedName": "updateTaskMarkdown", + "description": "Updates the reporting task with Markdown-formatted status text.", + "kind": "Method", + "signature": "UpdateTaskMarkdown(markdownString string, options ...*UpdateTaskMarkdownOptions) error", + "receiver": "ReportingTask", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "UpdateTaskMarkdownOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "User", + "capabilityId": "Aspire.Hosting/user", + "qualifiedName": "user", + "description": "Adds a USER statement to a Dockerfile stage", + "kind": "Method", + "signature": "User(user string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "user", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "WaitFor", + "capabilityId": "Aspire.Hosting/waitFor", + "qualifiedName": "waitFor", + "description": "Waits for another resource to be ready", + "kind": "Method", + "signature": "WaitFor(dependency Resource, options ...*WaitForOptions) ResourceWithWaitSupport", + "receiver": "ResourceWithWaitSupport", + "parameters": [ + { + "name": "dependency", + "type": "Resource" + } + ], + "options": { + "typeName": "WaitForOptions", + "fields": [ + { + "name": "WaitBehavior", + "jsonName": "waitBehavior", + "type": "*WaitBehavior" + } + ] + }, + "returnType": "ResourceWithWaitSupport", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WaitForCompletion", + "capabilityId": "Aspire.Hosting/waitForResourceCompletion", + "qualifiedName": "waitForCompletion", + "description": "Waits for the dependency resource to enter the Exited or Finished state before starting the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WaitForCompletion(dependency Resource, options ...*WaitForCompletionOptions) ResourceWithWaitSupport", + "receiver": "ResourceWithWaitSupport", + "parameters": [ + { + "name": "dependency", + "type": "Resource", + "description": "The resource builder for the dependency resource." + } + ], + "options": { + "typeName": "WaitForCompletionOptions", + "fields": [ + { + "name": "ExitCode", + "jsonName": "exitCode", + "type": "*float64", + "description": "The exit code which is interpreted as successful." + } + ] + }, + "returnType": "ResourceWithWaitSupport", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WaitForDependencies", + "capabilityId": "Aspire.Hosting/waitForDependencies", + "qualifiedName": "waitForDependencies", + "description": "Waits for all dependencies of a resource to be ready.", + "kind": "Method", + "signature": "WaitForDependencies(resource Resource) error", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForResourceHealthy", + "capabilityId": "Aspire.Hosting/waitForResourceHealthy", + "qualifiedName": "waitForResourceHealthy", + "description": "Waits for a resource to become healthy.", + "kind": "Method", + "signature": "WaitForResourceHealthy(resourceName string) (*ResourceEventDto, error)", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "returnType": "(*ResourceEventDto, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForResourceState", + "capabilityId": "Aspire.Hosting/waitForResourceState", + "qualifiedName": "waitForResourceState", + "description": "Waits for a resource to reach a specified state.", + "kind": "Method", + "signature": "WaitForResourceState(resourceName string, options ...*WaitForResourceStateOptions) error", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "options": { + "typeName": "WaitForResourceStateOptions", + "fields": [ + { + "name": "TargetState", + "jsonName": "targetState", + "type": "*string" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForResourceStates", + "capabilityId": "Aspire.Hosting/waitForResourceStates", + "qualifiedName": "waitForResourceStates", + "description": "Waits for a resource to reach one of the specified states.", + "kind": "Method", + "signature": "WaitForResourceStates(resourceName string, targetStates []string) (string, error)", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + }, + { + "name": "targetStates", + "type": "[]string" + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForStart", + "capabilityId": "Aspire.Hosting/waitForStart", + "qualifiedName": "waitForStart", + "description": "Waits for another resource to start", + "kind": "Method", + "signature": "WaitForStart(dependency Resource, options ...*WaitForStartOptions) ResourceWithWaitSupport", + "receiver": "ResourceWithWaitSupport", + "parameters": [ + { + "name": "dependency", + "type": "Resource" + } + ], + "options": { + "typeName": "WaitForStartOptions", + "fields": [ + { + "name": "WaitBehavior", + "jsonName": "waitBehavior", + "type": "*WaitBehavior" + } + ] + }, + "returnType": "ResourceWithWaitSupport", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithArgs", + "capabilityId": "Aspire.Hosting/withArgs", + "qualifiedName": "withArgs", + "description": "Adds arguments to be passed to a resource that supports arguments when it is launched.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithArgs(args []string) ResourceWithArgs", + "receiver": "ResourceWithArgs", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "The arguments to be passed to the resource when it is started." + } + ], + "returnType": "ResourceWithArgs", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithArgs", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithArgsCallback", + "capabilityId": "Aspire.Hosting/withArgsCallback", + "qualifiedName": "withArgsCallback", + "description": "Adds a callback to be executed with a list of command-line arguments when a resource is started.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithArgsCallback(callback func(obj CommandLineArgsCallbackContext)) ResourceWithArgs", + "receiver": "ResourceWithArgs", + "parameters": [ + { + "name": "callback", + "type": "func(obj CommandLineArgsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(obj CommandLineArgsCallbackContext)", + "description": "A callback that allows for deferred execution for computing arguments. This runs after resources have been allocated by the orchestrator and allows access to other resources to resolve computed data, e.g. connection strings, ports." + } + ], + "returnType": "ResourceWithArgs", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithArgs", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithArgumentsConfig", + "capabilityId": "Aspire.Hosting/withArgumentsConfig", + "qualifiedName": "withArgumentsConfig", + "description": "Adds a command line arguments configuration gatherer to the builder.", + "returns": "The builder with the configuration gatherer added.", + "kind": "Method", + "signature": "WithArgumentsConfig() ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithBindMount", + "capabilityId": "Aspire.Hosting/withBindMount", + "qualifiedName": "withBindMount", + "description": "Adds a bind mount to a container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBindMount(source string, target string, options ...*WithBindMountOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source path of the mount. This is the path to the file or directory on the host, relative to the AppHost project directory." + }, + { + "name": "target", + "type": "string", + "description": "The target path where the file or directory is mounted in the container." + } + ], + "options": { + "typeName": "WithBindMountOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithBuildArg", + "capabilityId": "Aspire.Hosting/withBuildArg", + "qualifiedName": "withBuildArg", + "description": "Adds a build argument when the container is built from a Dockerfile.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBuildArg(name string, value any) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the build argument." + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The build argument value, either a string or a parameter resource." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithBuildSecret", + "capabilityId": "Aspire.Hosting/withParameterBuildSecret", + "qualifiedName": "withBuildSecret", + "description": "Adds a secret build argument when the container is built from a Dockerfile.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBuildSecret(name string, value ParameterResource) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret build argument." + }, + { + "name": "value", + "type": "ParameterResource", + "description": "The resource builder for a parameter resource." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithCertificateTrustConfig", + "capabilityId": "Aspire.Hosting/withCertificateTrustConfig", + "qualifiedName": "withCertificateTrustConfig", + "description": "Adds a certificate trust configuration gatherer to the builder.", + "returns": "The builder with the configuration gatherer added.", + "kind": "Method", + "signature": "WithCertificateTrustConfig(configContextFactory func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext) ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [ + { + "name": "configContextFactory", + "type": "func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext", + "isCallback": true, + "callbackSignature": "func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext", + "description": "A factory function to create the configuration context." + } + ], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithCertificateTrustScope", + "capabilityId": "Aspire.Hosting/withCertificateTrustScope", + "qualifiedName": "withCertificateTrustScope", + "description": "Sets the certificate trust scope", + "remarks": "The default scope if not overridden is `Append` which means that custom certificate\nauthorities should be appended to the default trusted certificate authorities for the resource. Setting the scope to\n`Override` indicates the set of certificates in referenced\n`CertificateAuthorityCollection` (and optionally Aspire developer certificiates) should be used as the\nexclusive source of trust for a resource.\nIn all cases, this is a best effort implementation as not all resources support full customization of certificate\ntrust.\nSet the scope for custom certificate authorities to override the default trusted certificate authorities for a container resource.\n```\nvar caCollection = builder.AddCertificateAuthorityCollection(\"my-cas\")\n.WithCertificate(new X509Certificate2(\"my-ca.pem\"));\nvar container = builder.AddContainer(\"my-service\", \"my-service:latest\")\n.WithCertificateAuthorityCollection(caCollection)\n.WithCertificateTrustScope(CertificateTrustScope.Override);\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCertificateTrustScope(scope CertificateTrustScope) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "scope", + "type": "CertificateTrustScope", + "description": "The scope to apply to custom certificate authorities associated with the resource." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithChildRelationship", + "capabilityId": "Aspire.Hosting/withBuilderChildRelationship", + "qualifiedName": "withChildRelationship", + "description": "Sets a child relationship", + "returns": "A resource builder.", + "kind": "Method", + "signature": "WithChildRelationship(child Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "child", + "type": "Resource", + "description": "The child of `builder`." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithCommand", + "capabilityId": "Aspire.Hosting/withCommand", + "qualifiedName": "withCommand", + "description": "Adds a resource command", + "remarks": "The `WithCommand` method is used to add commands to the resource. Commands are displayed in the dashboard\nand can be executed by a user using the dashboard UI.\nWhen a command is executed, the `executeCommand` callback is called and is run inside the Aspire host.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCommand(name string, displayName string, executeCommand func(arg ExecuteCommandContext) *ExecuteCommandResult, options ...*WithCommandOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the command. The name uniquely identifies the command." + }, + { + "name": "displayName", + "type": "string", + "description": "The display name visible in UI." + }, + { + "name": "executeCommand", + "type": "func(arg ExecuteCommandContext) *ExecuteCommandResult", + "isCallback": true, + "callbackSignature": "func(arg ExecuteCommandContext) *ExecuteCommandResult", + "description": "A callback that is executed when the command is executed. The callback is run inside the Aspire host. The callback result is used to indicate success or failure in the UI." + } + ], + "options": { + "typeName": "WithCommandOptions", + "fields": [ + { + "name": "CommandOptions", + "jsonName": "commandOptions", + "type": "*CommandOptions", + "description": "Optional configuration for the command." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithComputeEnvironment", + "capabilityId": "Aspire.Hosting/withComputeEnvironment", + "qualifiedName": "withComputeEnvironment", + "description": "Configures the compute environment for the compute resource.", + "remarks": "This method allows associating a specific compute environment with the compute resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithComputeEnvironment(computeEnvironmentResource ComputeEnvironmentResource) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "computeEnvironmentResource", + "type": "ComputeEnvironmentResource", + "description": "The compute environment resource to associate with the compute resource." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithConnectionProperty", + "capabilityId": "Aspire.Hosting/withConnectionProperty", + "qualifiedName": "withConnectionProperty", + "description": "Adds a connection property annotation to the resource being built.", + "returns": "The same resource builder instance with the specified connection property annotation applied.", + "kind": "Method", + "signature": "WithConnectionProperty(name string, value any) ResourceWithConnectionString", + "receiver": "ResourceWithConnectionString", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the connection property to add." + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ], + "description": "The value to assign to the connection property, specified as a string or reference expression." + } + ], + "returnType": "ResourceWithConnectionString", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString" + ], + "appliesTo": [ + "ResourceWithConnectionString" + ] + }, + { + "name": "WithContainerBuildOptions", + "capabilityId": "Aspire.Hosting/withContainerBuildOptions", + "qualifiedName": "withContainerBuildOptions", + "description": "Configures container build options for a compute resource using an async callback.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithContainerBuildOptions(callback func(arg ContainerBuildOptionsCallbackContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ContainerBuildOptionsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg ContainerBuildOptionsCallbackContext)", + "description": "An async callback to configure container build options." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithContainerCertificatePaths", + "capabilityId": "Aspire.Hosting/withContainerCertificatePaths", + "qualifiedName": "withContainerCertificatePaths", + "description": "Adds container certificate path overrides used for certificate trust at run time.", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "WithContainerCertificatePaths(options ...*WithContainerCertificatePathsOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [], + "options": { + "typeName": "WithContainerCertificatePathsOptions", + "fields": [ + { + "name": "CustomCertificatesDestination", + "jsonName": "customCertificatesDestination", + "type": "*string", + "description": "The destination path in the container where custom certificates will be copied." + }, + { + "name": "DefaultCertificateBundlePaths", + "jsonName": "defaultCertificateBundlePaths", + "type": "[]string", + "description": "Default certificate bundle paths in the container that will be replaced." + }, + { + "name": "DefaultCertificateDirectoryPaths", + "jsonName": "defaultCertificateDirectoryPaths", + "type": "[]string", + "description": "Default certificate directory paths in the container that may be appended." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerFiles", + "capabilityId": "Aspire.Hosting/withContainerFiles", + "qualifiedName": "withContainerFiles", + "description": "Creates or updates files and folders in a container by copying them from a source path on the host.", + "remarks": "In run mode, Aspire copies the files into the container and applies owner, group, and umask options.\nIn publish mode, Aspire creates a read-only bind mount and ignores those options.\nTo produce entries dynamically (including inline file contents and OpenSSL certificate files), polyglot AppHosts\nuse the `withContainerFilesCallback` overload and build the entries via the factory methods on\n`ContainerFileSystemCallbackContext`. Passing a pre-built `ContainerFileSystemItem` collection\nremains .NET-only.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerFiles(destinationPath string, sourcePath string, options ...*ContainerFilesOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "destinationPath", + "type": "string", + "description": "The destination absolute path in the container." + }, + { + "name": "sourcePath", + "type": "string", + "description": "The source path on the host to copy files from." + } + ], + "options": { + "typeName": "ContainerFilesOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerFilesCallback", + "capabilityId": "Aspire.Hosting/withContainerFilesCallback", + "qualifiedName": "withContainerFilesCallback", + "description": "Creates or updates files and/or folders at the destination path in the container using entries produced by a callback.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerFilesCallback(destinationPath string, callback func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem, options ...*ContainerFilesOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "destinationPath", + "type": "string", + "description": "The destination absolute path in the container." + }, + { + "name": "callback", + "type": "func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem", + "isCallback": true, + "callbackSignature": "func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem", + "description": "A callback that returns the file system entries to create or update. Use the factory methods on `ContainerFileSystemCallbackContext` (createFile, createDirectory, createCertificateFile) to build the entries." + } + ], + "options": { + "typeName": "ContainerFilesOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerFilesSource", + "capabilityId": "Aspire.Hosting/withContainerFilesSource", + "qualifiedName": "withContainerFilesSource", + "description": "Adds a container files source annotation to the resource being built, specifying the path to the container files source.", + "returns": "The resource builder instance with the container files source annotation applied.", + "kind": "Method", + "signature": "WithContainerFilesSource(sourcePath string) ResourceWithContainerFiles", + "receiver": "ResourceWithContainerFiles", + "parameters": [ + { + "name": "sourcePath", + "type": "string", + "description": "The path to the container files source to associate with the resource. Cannot be null." + } + ], + "returnType": "ResourceWithContainerFiles", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IResourceWithContainerFiles", + "expandedTargetTypes": [ + "Aspire.Hosting.IResourceWithContainerFiles" + ], + "appliesTo": [ + "ResourceWithContainerFiles" + ] + }, + { + "name": "WithContainerName", + "capabilityId": "Aspire.Hosting/withContainerName", + "qualifiedName": "withContainerName", + "description": "Overrides the default container name for this resource. By default Aspire generates a unique container name based on the resource name and a random postfix (or a postfix based on a hash of the AppHost project path for persistent container resources). This method allows you to override that behavior with a custom name, but could lead to naming conflicts if the specified name is not unique.", + "remarks": "Combining this with `Persistent` will allow Aspire to re-use an existing container that was not\ncreated by an Aspire AppHost.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerName(name string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The desired container name. Must be a valid container name or your runtime will report an error." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerNetworkAlias", + "capabilityId": "Aspire.Hosting/withContainerNetworkAlias", + "qualifiedName": "withContainerNetworkAlias", + "description": "Adds a network alias to container resource.", + "remarks": "Network aliases enable DNS resolution of the container on the network by custom names.\nBy default, containers are accessible on the network using their resource name as a DNS alias.\nThis method allows adding additional aliases for the same container.\nMultiple aliases can be added by calling this method multiple times.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerNetworkAlias(alias string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "alias", + "type": "string", + "description": "The network alias for the container." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerRegistry", + "capabilityId": "Aspire.Hosting/withContainerRegistry", + "qualifiedName": "withContainerRegistry", + "description": "Configures the resource to use the specified container registry for container image operations.", + "remarks": "This method adds a `ContainerRegistryReferenceAnnotation` to the resource,\nindicating that the resource should use the specified container registry for container image operations.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithContainerRegistry(registry Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "registry", + "type": "Resource", + "description": "The container registry resource builder." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithContainerRuntimeArgs", + "capabilityId": "Aspire.Hosting/withContainerRuntimeArgs", + "qualifiedName": "withContainerRuntimeArgs", + "description": "Adds a callback to be executed with a list of arguments to add to the container runtime run command when a container resource is started.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerRuntimeArgs(args []string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "The arguments to be passed to the container runtime run command when the container resource is started." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithCustomInput", + "capabilityId": "Aspire.Hosting/withCustomInput", + "qualifiedName": "withCustomInput", + "description": "Sets a custom input for the parameter resource from a polyglot AppHost.", + "returns": "Resource builder for the parameter.", + "kind": "Method", + "signature": "WithCustomInput(options *ParameterCustomInputOptions) ParameterResource", + "receiver": "ParameterResource", + "parameters": [ + { + "name": "options", + "type": "*ParameterCustomInputOptions", + "description": "Options used to customize the input for the parameter." + } + ], + "returnType": "ParameterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ParameterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ParameterResource" + ], + "appliesTo": [ + "ParameterResource" + ] + }, + { + "name": "WithDescription", + "capabilityId": "Aspire.Hosting/withDescription", + "qualifiedName": "withDescription", + "description": "Sets the description of the parameter resource.", + "returns": "Resource builder for the parameter.", + "kind": "Method", + "signature": "WithDescription(description string, options ...*WithDescriptionOptions) ParameterResource", + "receiver": "ParameterResource", + "parameters": [ + { + "name": "description", + "type": "string", + "description": "The parameter description." + } + ], + "options": { + "typeName": "WithDescriptionOptions", + "fields": [ + { + "name": "EnableMarkdown", + "jsonName": "enableMarkdown", + "type": "*bool", + "description": "A value indicating whether the description should be rendered as Markdown. `true` allows the description to contain Markdown elements such as links, text decoration and lists." + } + ] + }, + "returnType": "ParameterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ParameterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ParameterResource" + ], + "appliesTo": [ + "ParameterResource" + ] + }, + { + "name": "WithDeveloperCertificateTrust", + "capabilityId": "Aspire.Hosting/withDeveloperCertificateTrust", + "qualifiedName": "withDeveloperCertificateTrust", + "description": "Indicates whether developer certificates should be treated as trusted certificate authorities for the resource at run time. Currently this indicates trust for the ASP.NET Core developer certificate. The developer certificate will only be trusted when running in local development scenarios; in publish mode resources will use their default certificate trust.", + "remarks": "Disable trust for AppHost managed developer certificate(s) for a container resource.\n```\nvar container = builder.AddContainer(\"my-service\", \"my-service:latest\")\n.WithDeveloperCertificateTrust(false);\n```\nDisable automatic trust for AppHost managed developer certificate(s), but explicitly enable it for a specific resource.\n```\nvar builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions()\n{\nArgs = args,\nTrustDeveloperCertificate = false,\n});\nvar project = builder.AddProject(\"my-service\")\n.WithDeveloperCertificateTrust(true);\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDeveloperCertificateTrust(trust bool) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "trust", + "type": "bool", + "description": "Indicates whether the developer certificate should be treated as trusted." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithDockerfile", + "capabilityId": "Aspire.Hosting/withDockerfile", + "qualifiedName": "withDockerfile", + "description": "Causes Aspire to build the specified container image from a Dockerfile.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfile(contextPath string, options ...*WithDockerfileOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + } + ], + "options": { + "typeName": "WithDockerfileOptions", + "fields": [ + { + "name": "DockerfilePath", + "jsonName": "dockerfilePath", + "type": "*string", + "description": "Path to the Dockerfile relative to the `contextPath`. Defaults to \"Dockerfile\" if not specified." + }, + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithDockerfileBaseImage", + "capabilityId": "Aspire.Hosting/withDockerfileBaseImage", + "qualifiedName": "withDockerfileBaseImage", + "description": "Configures custom base images for generated Dockerfiles.", + "remarks": "This extension method allows customization of the base images used in generated Dockerfiles.\nFor multi-stage Dockerfiles (e.g., Python with UV), you can specify separate build and runtime images.\nSpecify custom base images for a Python application:\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddPythonApp(\"myapp\", \"path/to/app\", \"main.py\")\n.WithDockerfileBaseImage(\nbuildImage: \"ghcr.io/astral-sh/uv:python3.12-bookworm-slim\",\nruntimeImage: \"python:3.12-slim-bookworm\");\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfileBaseImage(options ...*WithDockerfileBaseImageOptions) Resource", + "receiver": "Resource", + "parameters": [], + "options": { + "typeName": "WithDockerfileBaseImageOptions", + "fields": [ + { + "name": "BuildImage", + "jsonName": "buildImage", + "type": "*string", + "description": "The base image to use for the build stage. If null, uses the default build image." + }, + { + "name": "RuntimeImage", + "jsonName": "runtimeImage", + "type": "*string", + "description": "The base image to use for the runtime stage. If null, uses the default runtime image." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithDockerfileBuilder", + "capabilityId": "Aspire.Hosting/withDockerfileBuilder", + "qualifiedName": "withDockerfileBuilder", + "description": "Configures the resource to use a programmatically generated Dockerfile", + "remarks": "This method provides a programmatic way to build Dockerfiles using the `DockerfileBuilder` API\ninstead of string manipulation. Callbacks can be composed by calling this method multiple times - each callback will be invoked\nin order to build up the final Dockerfile.\nThe `contextPath` is relative to the AppHost directory unless it is fully qualified.\nCreates a container with a programmatically built Dockerfile using fluent API:\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddContainer(\"mycontainer\", \"myimage\")\n.WithDockerfileBuilder(\"path/to/context\", context =>\n{\ncontext.Builder.From(\"alpine:latest\")\n.WorkDir(\"/app\")\n.Run(\"apk add curl\")\n.Copy(\".\", \".\")\n.Cmd([\"./myapp\"]);\nreturn Task.CompletedTask;\n});\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfileBuilder(contextPath string, callback func(arg DockerfileBuilderCallbackContext), options ...*WithDockerfileBuilderOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "callback", + "type": "func(arg DockerfileBuilderCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg DockerfileBuilderCallbackContext)", + "description": "A callback that uses the `DockerfileBuilder` API to construct the Dockerfile." + } + ], + "options": { + "typeName": "WithDockerfileBuilderOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithDockerfileFactory", + "capabilityId": "Aspire.Hosting/withDockerfileFactory", + "qualifiedName": "withDockerfileFactory", + "description": "Builds the specified container image from a Dockerfile generated by an asynchronous factory function.", + "remarks": "When this method is called, an annotation is added to the `ContainerResource` that specifies the context path\nand a factory function that generates Dockerfile content. The factory is invoked at build time to produce the Dockerfile,\nwhich is then written to a temporary file and used by the orchestrator to build the container image.\nThe `contextPath` is relative to the AppHost directory unless it is fully qualified.\nThe factory function is invoked once during the build process to generate the Dockerfile content.\nThe output is trusted and not validated.\nCreates a container called `mycontainer` with a dynamically generated Dockerfile.\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddContainer(\"mycontainer\", \"myimage\")\n.WithDockerfileFactory(\"path/to/context\", async context =>\n{\nvar template = await File.ReadAllTextAsync(\"template.dockerfile\", context.CancellationToken);\nreturn template.Replace(\"{{VERSION}}\", \"1.0\");\n});\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfileFactory(contextPath string, dockerfileFactory func(arg DockerfileFactoryContext) string, options ...*WithDockerfileFactoryOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "dockerfileFactory", + "type": "func(arg DockerfileFactoryContext) string", + "isCallback": true, + "callbackSignature": "func(arg DockerfileFactoryContext) string", + "description": "An asynchronous function that returns the Dockerfile content as a string." + } + ], + "options": { + "typeName": "WithDockerfileFactoryOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithEndpoint", + "capabilityId": "Aspire.Hosting/withEndpoint", + "qualifiedName": "withEndpoint", + "description": "Adds a network endpoint", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEndpoint(options ...*WithEndpointOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithEndpointOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "An optional port. This is the port that will be given to other resource to communicate with this resource." + }, + { + "name": "TargetPort", + "jsonName": "targetPort", + "type": "*float64", + "description": "This is the port the resource is listening on. If the endpoint is used for the container, it is the container port." + }, + { + "name": "Scheme", + "jsonName": "scheme", + "type": "*string", + "description": "An optional scheme e.g. (http/https). Defaults to the `protocol` argument if it is defined or \"tcp\" otherwise." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "An optional name of the endpoint. Defaults to the scheme name if not specified." + }, + { + "name": "Env", + "jsonName": "env", + "type": "*string", + "description": "An optional name of the environment variable that will be used to inject the `targetPort`. If the target port is null one will be dynamically generated and assigned to the environment variable." + }, + { + "name": "IsProxied", + "jsonName": "isProxied", + "type": "*bool", + "description": "Specifies if the endpoint will be proxied by DCP. Defaults to `null`." + }, + { + "name": "IsExternal", + "jsonName": "isExternal", + "type": "*bool", + "description": "Indicates that this endpoint should be exposed externally at publish time." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*ProtocolType", + "description": "Network protocol: TCP or UDP are supported today, others possibly in future." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpointCallback", + "capabilityId": "Aspire.Hosting/withEndpointCallback", + "qualifiedName": "withEndpointCallback", + "description": "Updates a named endpoint via callback", + "kind": "Method", + "signature": "WithEndpointCallback(endpointName string, callback func(obj EndpointUpdateContext), options ...*WithEndpointCallbackOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "endpointName", + "type": "string" + }, + { + "name": "callback", + "type": "func(obj EndpointUpdateContext)", + "isCallback": true, + "callbackSignature": "func(obj EndpointUpdateContext)" + } + ], + "options": { + "typeName": "WithEndpointCallbackOptions", + "fields": [ + { + "name": "CreateIfNotExists", + "jsonName": "createIfNotExists", + "type": "*bool" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpointProxySupport", + "capabilityId": "Aspire.Hosting/withEndpointProxySupport", + "qualifiedName": "withEndpointProxySupport", + "description": "Set whether a resource can use proxied endpoints or whether they should be disabled for all endpoints belonging to the resource. If set to `false`, endpoints belonging to the resource will ignore the configured proxy settings and run proxy-less.", + "remarks": "This method is intended to support scenarios with persistent lifetime resources where it is desirable for the resource to be accessible over the same\nport whether the Aspire application is running or not. Proxied endpoints bind ports that are only accessible while the Aspire application is running.\nThe user needs to be careful to ensure that endpoints are using unique ports when disabling proxy support as by default for proxy-less\nendpoints, Aspire will allocate the target port as the host port, which will increase the chance of port conflicts.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEndpointProxySupport(proxyEnabled bool) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "proxyEnabled", + "type": "bool", + "description": "Should endpoints for the resource support using a proxy?" + } + ], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpointsInEnvironment", + "capabilityId": "Aspire.Hosting/withEndpointsInEnvironment", + "qualifiedName": "withEndpointsInEnvironment", + "description": "Includes only the specified project endpoint names in environment-variable injection.", + "returns": "The same project resource builder handle for chaining.", + "kind": "Method", + "signature": "WithEndpointsInEnvironment(endpointNames []string) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "endpointNames", + "type": "[]string", + "description": "The endpoint names to include in environment variables." + } + ], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithEntrypoint", + "capabilityId": "Aspire.Hosting/withEntrypoint", + "qualifiedName": "withEntrypoint", + "description": "Sets the Entrypoint for the container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEntrypoint(entrypoint string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "entrypoint", + "type": "string", + "description": "The new entrypoint for the container." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithEnvironment", + "capabilityId": "Aspire.Hosting/withEnvironment", + "qualifiedName": "withEnvironment", + "description": "Sets an environment variable", + "kind": "Method", + "signature": "WithEnvironment(name string, value any) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression", + "EndpointReference", + "ParameterResource", + "ExternalServiceResource", + "ResourceWithConnectionString", + "ExpressionValue" + ] + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEnvironmentCallback", + "capabilityId": "Aspire.Hosting/withEnvironmentCallback", + "qualifiedName": "withEnvironmentCallback", + "description": "Allows for the population of environment variables on a resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEnvironmentCallback(callback func(arg EnvironmentCallbackContext)) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "callback", + "type": "func(arg EnvironmentCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg EnvironmentCallbackContext)", + "description": "A callback that allows for deferred execution for computing many environment variables. This runs after resources have been allocated by the orchestrator and allows access to other resources to resolve computed data, e.g. connection strings, ports." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEnvironmentVariablesConfig", + "capabilityId": "Aspire.Hosting/withEnvironmentVariablesConfig", + "qualifiedName": "withEnvironmentVariablesConfig", + "description": "Adds an environment variables configuration gatherer to the builder.", + "returns": "The builder with the configuration gatherer added.", + "kind": "Method", + "signature": "WithEnvironmentVariablesConfig() ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithExecutableCommand", + "capabilityId": "Aspire.Hosting/withExecutableCommand", + "qualifiedName": "withExecutableCommand", + "description": "Sets the command for the executable resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExecutableCommand(command string) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "command", + "type": "string", + "description": "Command." + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "WithExplicitStart", + "capabilityId": "Aspire.Hosting/withExplicitStart", + "qualifiedName": "withExplicitStart", + "description": "Prevents resource from starting automatically", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExplicitStart() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithExternalHttpEndpoints", + "capabilityId": "Aspire.Hosting/withExternalHttpEndpoints", + "qualifiedName": "withExternalHttpEndpoints", + "description": "Marks existing http or https endpoints on a resource as external.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExternalHttpEndpoints() ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHealthCheck", + "capabilityId": "Aspire.Hosting/withHealthCheck", + "qualifiedName": "withHealthCheck", + "description": "Adds a health check by key", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHealthCheck(key string) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key for the health check." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHidden", + "capabilityId": "Aspire.Hosting/withHidden", + "qualifiedName": "withHidden", + "description": "Hides the resource from default resource lists", + "remarks": "Use this method to hide resources that are implementation details and should never be displayed by default.\nHidden resources can still be accessed directly by their name, by using `Show hidden resources` toggle in the dashboard or by using `aspire describe --include-hidden` from the CLI.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHidden() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHiddenOnCompletion", + "capabilityId": "Aspire.Hosting/withHiddenOnCompletion", + "qualifiedName": "withHiddenOnCompletion", + "description": "Hides the resource from default resource lists after successful completion", + "remarks": "This method is useful for one-off resources such as setup scripts, migrations, or build steps that should remain visible while running\nand then be hidden after successful completion.\nHidden resources can still be accessed directly by their name, by using `Show hidden resources` toggle in the dashboard or by using `aspire describe --include-hidden` from the CLI.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHiddenOnCompletion(options ...*WithHiddenOnCompletionOptions) Resource", + "receiver": "Resource", + "parameters": [], + "options": { + "typeName": "WithHiddenOnCompletionOptions", + "fields": [ + { + "name": "ExitCode", + "jsonName": "exitCode", + "type": "*float64", + "description": "The completion exit code to treat as successful. Defaults to `0`." + }, + { + "name": "ExitCodes", + "jsonName": "exitCodes", + "type": "[]float64", + "description": "Completion exit codes to treat as successful. If no values are provided, `0` is used." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpCommand", + "capabilityId": "Aspire.Hosting/withHttpCommand", + "qualifiedName": "withHttpCommand", + "description": "Adds an HTTP resource command", + "kind": "Method", + "signature": "WithHttpCommand(path string, displayName string, options ...*HttpCommandExportOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "path", + "type": "string" + }, + { + "name": "displayName", + "type": "string" + } + ], + "options": { + "typeName": "HttpCommandExportOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpEndpoint", + "capabilityId": "Aspire.Hosting/withHttpEndpoint", + "qualifiedName": "withHttpEndpoint", + "description": "Adds an HTTP endpoint", + "remarks": "If an endpoint with the same name already exists on the resource, the existing endpoint is updated\nwith any non-null parameter values. Parameters left as `null` will not modify the existing endpoint's values.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpEndpoint(options ...*WithHttpEndpointOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithHttpEndpointOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "An optional port. This is the port that will be given to other resource to communicate with this resource." + }, + { + "name": "TargetPort", + "jsonName": "targetPort", + "type": "*float64", + "description": "This is the port the resource is listening on. If the endpoint is used for the container, it is the container port." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "An optional name of the endpoint. Defaults to \"http\" if not specified." + }, + { + "name": "Env", + "jsonName": "env", + "type": "*string", + "description": "An optional name of the environment variable to inject." + }, + { + "name": "IsProxied", + "jsonName": "isProxied", + "type": "*bool", + "description": "Specifies if the endpoint will be proxied by DCP. Defaults to `null`." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpEndpointCallback", + "capabilityId": "Aspire.Hosting/withHttpEndpointCallback", + "qualifiedName": "withHttpEndpointCallback", + "description": "Updates an HTTP endpoint via callback", + "kind": "Method", + "signature": "WithHttpEndpointCallback(callback func(obj EndpointUpdateContext), options ...*WithHttpEndpointCallbackOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "callback", + "type": "func(obj EndpointUpdateContext)", + "isCallback": true, + "callbackSignature": "func(obj EndpointUpdateContext)" + } + ], + "options": { + "typeName": "WithHttpEndpointCallbackOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string" + }, + { + "name": "CreateIfNotExists", + "jsonName": "createIfNotExists", + "type": "*bool" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpHealthCheck", + "capabilityId": "Aspire.Hosting/withExternalServiceHttpHealthCheck", + "qualifiedName": "withHttpHealthCheck", + "description": "Adds an HTTP health check to the external service for polyglot AppHosts.", + "kind": "Method", + "signature": "WithHttpHealthCheck(options ...*WithHttpHealthCheckOptions) ExternalServiceResource", + "receiver": "ExternalServiceResource", + "parameters": [], + "options": { + "typeName": "WithHttpHealthCheckOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string" + }, + { + "name": "StatusCode", + "jsonName": "statusCode", + "type": "*float64" + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string" + } + ] + }, + "returnType": "ExternalServiceResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ExternalServiceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ExternalServiceResource" + ], + "appliesTo": [ + "ExternalServiceResource" + ] + }, + { + "name": "WithHttpHealthCheck", + "capabilityId": "Aspire.Hosting/withHttpHealthCheck", + "qualifiedName": "withHttpHealthCheck", + "description": "Adds a health check to the resource which is mapped to a specific endpoint.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpHealthCheck(options ...*WithHttpHealthCheckOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithHttpHealthCheckOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "The relative path to test." + }, + { + "name": "StatusCode", + "jsonName": "statusCode", + "type": "*float64", + "description": "The result code to interpret as healthy." + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string", + "description": "The name of the endpoint to derive the base address from." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpProbe", + "capabilityId": "Aspire.Hosting/withHttpProbe", + "qualifiedName": "withHttpProbe", + "description": "Adds an HTTP health probe to the resource", + "kind": "Method", + "signature": "WithHttpProbe(probeType ProbeType, options ...*WithHttpProbeOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "probeType", + "type": "ProbeType" + } + ], + "options": { + "typeName": "WithHttpProbeOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string" + }, + { + "name": "InitialDelaySeconds", + "jsonName": "initialDelaySeconds", + "type": "*float64" + }, + { + "name": "PeriodSeconds", + "jsonName": "periodSeconds", + "type": "*float64" + }, + { + "name": "TimeoutSeconds", + "jsonName": "timeoutSeconds", + "type": "*float64" + }, + { + "name": "FailureThreshold", + "jsonName": "failureThreshold", + "type": "*float64" + }, + { + "name": "SuccessThreshold", + "jsonName": "successThreshold", + "type": "*float64" + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsCertificateConfig", + "capabilityId": "Aspire.Hosting/withHttpsCertificateConfigExport", + "qualifiedName": "withHttpsCertificateConfig", + "description": "Adds an HTTPS certificate configuration gatherer using certificate metadata instead of a raw X509 certificate.", + "returns": "The execution configuration builder.", + "kind": "Method", + "signature": "WithHttpsCertificateConfig(configContextFactory func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext) ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [ + { + "name": "configContextFactory", + "type": "func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext", + "isCallback": true, + "callbackSignature": "func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext", + "description": "The factory that creates the HTTPS certificate configuration context." + } + ], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithHttpsCertificateConfiguration", + "capabilityId": "Aspire.Hosting/withHttpsCertificateConfiguration", + "qualifiedName": "withHttpsCertificateConfiguration", + "description": "Adds a callback that allows configuring the resource to use a specific HTTPS/TLS certificate key pair for server authentication.", + "remarks": "Pass the path to the PFX certificate file to the container arguments.\n```\nbuilder.AddContainer(\"my-service\", \"my-image\")\n.WithHttpsCertificateConfiguration(ctx =>\n{\nctx.Arguments.Add(\"--https-certificate-path\");\nctx.Arguments.Add(ctx.PfxPath);\nreturn Task.CompletedTask;\n});\n```", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "WithHttpsCertificateConfiguration(callback func(arg HttpsCertificateConfigurationCallbackAnnotationContext)) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "callback", + "type": "func(arg HttpsCertificateConfigurationCallbackAnnotationContext)", + "isCallback": true, + "callbackSignature": "func(arg HttpsCertificateConfigurationCallbackAnnotationContext)", + "description": "The callback to configure the resource to use a certificate key pair." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsDeveloperCertificate", + "capabilityId": "Aspire.Hosting/withParameterHttpsDeveloperCertificate", + "qualifiedName": "withHttpsDeveloperCertificate", + "description": "Indicates that a resource should use the developer certificate key pair for HTTPS endpoints at run time. Currently this indicates use of the ASP.NET Core developer certificate. The developer certificate will only be used when running in local development scenarios; in publish mode resources will use their default certificate configuration.", + "remarks": "Use the developer certificate for HTTPS/TLS endpoints on a container resource:\n```\nbuilder.AddContainer(\"my-service\", \"my-image\")\n.WithHttpsDeveloperCertificate()\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsDeveloperCertificate(options ...*WithHttpsDeveloperCertificateOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [], + "options": { + "typeName": "WithHttpsDeveloperCertificateOptions", + "fields": [ + { + "name": "Password", + "jsonName": "password", + "type": "*ParameterResource", + "description": "A parameter specifying the password used to encrypt the certificate private key." + } + ] + }, + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsEndpoint", + "capabilityId": "Aspire.Hosting/withHttpsEndpoint", + "qualifiedName": "withHttpsEndpoint", + "description": "Adds an HTTPS endpoint", + "remarks": "If an endpoint with the same name already exists on the resource, the existing endpoint is updated\nwith any non-null parameter values. Parameters left as `null` will not modify the existing endpoint's values.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsEndpoint(options ...*WithHttpsEndpointOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithHttpsEndpointOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "An optional host port." + }, + { + "name": "TargetPort", + "jsonName": "targetPort", + "type": "*float64", + "description": "This is the port the resource is listening on. If the endpoint is used for the container, it is the container port." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "An optional name of the endpoint. Defaults to \"https\" if not specified." + }, + { + "name": "Env", + "jsonName": "env", + "type": "*string", + "description": "An optional name of the environment variable to inject." + }, + { + "name": "IsProxied", + "jsonName": "isProxied", + "type": "*bool", + "description": "Specifies if the endpoint will be proxied by DCP. Defaults to `null`." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsEndpointCallback", + "capabilityId": "Aspire.Hosting/withHttpsEndpointCallback", + "qualifiedName": "withHttpsEndpointCallback", + "description": "Updates an HTTPS endpoint via callback", + "kind": "Method", + "signature": "WithHttpsEndpointCallback(callback func(obj EndpointUpdateContext), options ...*WithHttpsEndpointCallbackOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "callback", + "type": "func(obj EndpointUpdateContext)", + "isCallback": true, + "callbackSignature": "func(obj EndpointUpdateContext)" + } + ], + "options": { + "typeName": "WithHttpsEndpointCallbackOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string" + }, + { + "name": "CreateIfNotExists", + "jsonName": "createIfNotExists", + "type": "*bool" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithIconName", + "capabilityId": "Aspire.Hosting/withIconName", + "qualifiedName": "withIconName", + "description": "Specifies the icon to use when displaying the resource in the dashboard.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithIconName(iconName string, options ...*WithIconNameOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "iconName", + "type": "string", + "description": "The name of the FluentUI icon to use. See https://aka.ms/fluentui-system-icons for available icons." + } + ], + "options": { + "typeName": "WithIconNameOptions", + "fields": [ + { + "name": "IconVariant", + "jsonName": "iconVariant", + "type": "*IconVariant", + "description": "The variant of the icon (Regular or Filled). Defaults to Filled." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithImage", + "capabilityId": "Aspire.Hosting/withImage", + "qualifiedName": "withImage", + "description": "Allows overriding the image on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImage(image string, options ...*WithImageOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "image", + "type": "string", + "description": "Image value." + } + ], + "options": { + "typeName": "WithImageOptions", + "fields": [ + { + "name": "Tag", + "jsonName": "tag", + "type": "*string", + "description": "Tag value." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImagePullPolicy", + "capabilityId": "Aspire.Hosting/withImagePullPolicy", + "qualifiedName": "withImagePullPolicy", + "description": "Sets the pull policy for the container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImagePullPolicy(pullPolicy ImagePullPolicy) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "pullPolicy", + "type": "ImagePullPolicy", + "description": "The pull policy behavior for the container resource." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImagePushOptions", + "capabilityId": "Aspire.Hosting/withImagePushOptions", + "qualifiedName": "withImagePushOptions", + "description": "Adds an asynchronous callback to configure container image push options for the resource.", + "remarks": "This method allows customization of how container images are named and tagged when pushed to a registry using an asynchronous callback.\nUse this overload when the callback needs to perform asynchronous operations such as retrieving configuration values from external sources.\nThe callback receives a `ContainerImagePushOptionsCallbackContext` that provides access to the resource\nand the `ContainerImagePushOptions` that can be modified.\nMultiple callbacks can be registered on the same resource, and they will be invoked in the order they were added.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImagePushOptions(callback func(arg ContainerImagePushOptionsCallbackContext)) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ContainerImagePushOptionsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg ContainerImagePushOptionsCallbackContext)", + "description": "The asynchronous callback to configure push options." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithImageRegistry", + "capabilityId": "Aspire.Hosting/withImageRegistry", + "qualifiedName": "withImageRegistry", + "description": "Allows overriding the image registry on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImageRegistry(registry string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "registry", + "type": "string", + "description": "Registry value." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImageSHA256", + "capabilityId": "Aspire.Hosting/withImageSHA256", + "qualifiedName": "withImageSHA256", + "description": "Allows setting the image to a specific sha256 on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImageSHA256(sha256 string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "sha256", + "type": "string", + "description": "Registry value." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImageTag", + "capabilityId": "Aspire.Hosting/withImageTag", + "qualifiedName": "withImageTag", + "description": "Allows overriding the image tag on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImageTag(tag string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "Tag value." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithLifetime", + "capabilityId": "Aspire.Hosting/withLifetime", + "qualifiedName": "withLifetime", + "description": "Sets the lifetime behavior of the container resource.", + "remarks": "Prefer `WithPersistentLifetime``1` or\n`WithSessionLifetime``1` for new code.\nMarking a container resource to have a `Persistent` lifetime.\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddContainer(\"mycontainer\", \"myimage\")\n.WithPersistentLifetime();\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLifetime(lifetime ContainerLifetime) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "lifetime", + "type": "ContainerLifetime", + "description": "The lifetime behavior of the container resource. The default behavior is `Session`." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithLifetimeOf", + "capabilityId": "Aspire.Hosting/withLifetimeOf", + "qualifiedName": "withLifetimeOf", + "description": "Configures a resource to match the lifetime of another resource.", + "remarks": "The resource lifetime is evaluated from `sourceBuilder` when the application model is prepared, so later lifetime\nchanges to the source resource are reflected by this resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLifetimeOf(sourceBuilder Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "sourceBuilder", + "type": "Resource", + "description": "The resource builder whose lifetime should be used." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithMcpServer", + "capabilityId": "Aspire.Hosting/withMcpServer", + "qualifiedName": "withMcpServer", + "description": "Marks the resource as hosting a Model Context Protocol (MCP) server on the specified endpoint.", + "remarks": "This method adds an `McpServerEndpointAnnotation` to the resource, enabling the Aspire tooling\nto discover and proxy the MCP server exposed by the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithMcpServer(options ...*WithMcpServerOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithMcpServerOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "An optional path to append to the endpoint URL when forming the MCP server address. Defaults to `\"/mcp\"`." + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string", + "description": "An optional name of the endpoint that hosts the MCP server. If not specified, defaults to the first HTTPS or HTTP endpoint." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithOtlpExporter", + "capabilityId": "Aspire.Hosting/withOtlpExporter", + "qualifiedName": "withOtlpExporter", + "description": "Configures OTLP telemetry export", + "kind": "Method", + "signature": "WithOtlpExporter(options ...*WithOtlpExporterOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [], + "options": { + "typeName": "WithOtlpExporterOptions", + "fields": [ + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*OtlpProtocol" + } + ] + }, + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithParentProcessLifetime", + "capabilityId": "Aspire.Hosting/withParentProcessLifetime", + "qualifiedName": "withParentProcessLifetime", + "description": "Configures a resource to use a persistent lifetime that ends when a parent process exits.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithParentProcessLifetime(parentProcessId float64) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "parentProcessId", + "type": "float64", + "description": "The ID of the parent process to monitor." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithParentRelationship", + "capabilityId": "Aspire.Hosting/withBuilderParentRelationship", + "qualifiedName": "withParentRelationship", + "description": "Sets the parent relationship", + "returns": "A resource builder.", + "kind": "Method", + "signature": "WithParentRelationship(parent Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "parent", + "type": "Resource", + "description": "The parent of `builder`." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPersistentLifetime", + "capabilityId": "Aspire.Hosting/withPersistentLifetime", + "qualifiedName": "withPersistentLifetime", + "description": "Configures a resource to use a persistent lifetime.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPersistentLifetime() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPipelineConfiguration", + "capabilityId": "Aspire.Hosting/withPipelineConfiguration", + "qualifiedName": "withPipelineConfiguration", + "description": "Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithPipelineConfiguration(callback func(obj PipelineConfigurationContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(obj PipelineConfigurationContext)", + "isCallback": true, + "callbackSignature": "func(obj PipelineConfigurationContext)", + "description": "The callback function to execute during the configuration phase." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPipelineStepFactory", + "capabilityId": "Aspire.Hosting/withPipelineStepFactory", + "qualifiedName": "withPipelineStepFactory", + "description": "Adds a pipeline step to the resource that will be executed during deployment.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithPipelineStepFactory(stepName string, callback func(arg PipelineStepContext), options ...*WithPipelineStepFactoryOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The unique name of the pipeline step." + }, + { + "name": "callback", + "type": "func(arg PipelineStepContext)", + "isCallback": true, + "callbackSignature": "func(arg PipelineStepContext)", + "description": "The callback to execute when the step runs." + } + ], + "options": { + "typeName": "WithPipelineStepFactoryOptions", + "fields": [ + { + "name": "DependsOn", + "jsonName": "dependsOn", + "type": "[]string", + "description": "Optional step names that this step depends on." + }, + { + "name": "RequiredBy", + "jsonName": "requiredBy", + "type": "[]string", + "description": "Optional step names that require this step." + }, + { + "name": "Tags", + "jsonName": "tags", + "type": "[]string", + "description": "Optional tags that categorize this step." + }, + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "An optional human-readable description of the step." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithProcessCommand", + "capabilityId": "Aspire.Hosting/withProcessCommand", + "qualifiedName": "withProcessCommand", + "description": "Adds a command to the resource that starts a local process when invoked.", + "kind": "Method", + "signature": "WithProcessCommand(commandName string, displayName string, options *ProcessCommandExportOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "commandName", + "type": "string" + }, + { + "name": "displayName", + "type": "string" + }, + { + "name": "options", + "type": "*ProcessCommandExportOptions" + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithProcessCommandFactory", + "capabilityId": "Aspire.Hosting/withProcessCommandFactory", + "qualifiedName": "withProcessCommandFactory", + "description": "Adds a command to the resource that starts a local process created by a callback when invoked.", + "kind": "Method", + "signature": "WithProcessCommandFactory(commandName string, displayName string, createProcessSpec func(arg ExecuteCommandContext) *ProcessCommandSpecExportData, options ...*ProcessCommandResultExportOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "commandName", + "type": "string" + }, + { + "name": "displayName", + "type": "string" + }, + { + "name": "createProcessSpec", + "type": "func(arg ExecuteCommandContext) *ProcessCommandSpecExportData", + "isCallback": true, + "callbackSignature": "func(arg ExecuteCommandContext) *ProcessCommandSpecExportData" + } + ], + "options": { + "typeName": "ProcessCommandResultExportOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithReference", + "capabilityId": "Aspire.Hosting/withReference", + "qualifiedName": "withReference", + "description": "Adds a reference to another resource", + "kind": "Method", + "signature": "WithReference(source any, options ...*WithReferenceOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "source", + "type": "any", + "allowedTypes": [ + "Resource", + "EndpointReference", + "string" + ] + } + ], + "options": { + "typeName": "WithReferenceOptions", + "fields": [ + { + "name": "ConnectionName", + "jsonName": "connectionName", + "type": "*string" + }, + { + "name": "Optional", + "jsonName": "optional", + "type": "*bool" + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string" + } + ] + }, + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithReferenceEnvironment", + "capabilityId": "Aspire.Hosting/withReferenceEnvironment", + "qualifiedName": "withReferenceEnvironment", + "description": "Configures how information is injected into environment variables when the resource references other resources.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithReferenceEnvironment(options *ReferenceEnvironmentInjectionOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "options", + "type": "*ReferenceEnvironmentInjectionOptions", + "description": "Options controlling which reference information is emitted." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithRelationship", + "capabilityId": "Aspire.Hosting/withBuilderRelationship", + "qualifiedName": "withRelationship", + "description": "Adds a relationship to another resource using its builder.", + "returns": "A resource builder.", + "kind": "Method", + "signature": "WithRelationship(resourceBuilder Resource, type_ string) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "resourceBuilder", + "type": "Resource", + "description": "The resource builder that the relationship is to." + }, + { + "name": "type_", + "type": "string", + "description": "The relationship type." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithRemoteImageName", + "capabilityId": "Aspire.Hosting/withRemoteImageName", + "qualifiedName": "withRemoteImageName", + "description": "Sets the remote image name (without registry endpoint or tag) for container push operations.", + "remarks": "Use this with `withRemoteImageTag` to fully customize the image reference used for container push operations.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRemoteImageName(remoteImageName string) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "remoteImageName", + "type": "string", + "description": "The remote image name (e.g., \"myapp\" or \"myorg/myapp\")." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithRemoteImageTag", + "capabilityId": "Aspire.Hosting/withRemoteImageTag", + "qualifiedName": "withRemoteImageTag", + "description": "Sets the remote image tag for container push operations.", + "remarks": "Use this with `withRemoteImageName` to fully customize the image reference used for container push operations.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRemoteImageTag(remoteImageTag string) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "remoteImageTag", + "type": "string", + "description": "The remote image tag (e.g., \"latest\", \"v1.0.0\")." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithReplicas", + "capabilityId": "Aspire.Hosting/withReplicas", + "qualifiedName": "withReplicas", + "description": "Configures how many replicas of the project should be created for the project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithReplicas(replicas float64) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "replicas", + "type": "float64", + "description": "The number of replicas." + } + ], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithRequiredCommand", + "capabilityId": "Aspire.Hosting/withRequiredCommand", + "qualifiedName": "withRequiredCommand", + "description": "Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.", + "remarks": "The command is considered valid if either:\n1. It is an absolute or relative path (contains a directory separator) that points to an existing file, or\n2. It is discoverable on the current process PATH (respecting PATHEXT on Windows).\nIf the command is not found, a warning message will be logged but the resource will be allowed to attempt to start.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRequiredCommand(command string, options ...*WithRequiredCommandOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "command", + "type": "string", + "description": "The command string (file name or path) that should be validated." + } + ], + "options": { + "typeName": "WithRequiredCommandOptions", + "fields": [ + { + "name": "HelpLink", + "jsonName": "helpLink", + "type": "*string", + "description": "An optional help link URL to guide users when the command is missing." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithRequiredCommandValidation", + "capabilityId": "Aspire.Hosting/withRequiredCommandValidation", + "qualifiedName": "withRequiredCommandValidation", + "description": "Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start, with custom validation logic.", + "remarks": "The command is first resolved to a full path. If found, the validation callback is invoked with the context containing the resolved path and service provider.\nThe callback should return a `RequiredCommandValidationResult` indicating whether the command is valid,\nwhich can be created via `Success` or `Failure`.\nIf the command is not found or fails validation, a warning message will be logged but the resource will be allowed to attempt to start.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRequiredCommandValidation(command string, validationCallback func(arg RequiredCommandValidationContext) RequiredCommandValidationResult, options ...*WithRequiredCommandValidationOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "command", + "type": "string", + "description": "The command string (file name or path) that should be validated." + }, + { + "name": "validationCallback", + "type": "func(arg RequiredCommandValidationContext) RequiredCommandValidationResult", + "isCallback": true, + "callbackSignature": "func(arg RequiredCommandValidationContext) RequiredCommandValidationResult", + "description": "A callback that validates the resolved command path. Receives a `RequiredCommandValidationContext` and returns a `RequiredCommandValidationResult`." + } + ], + "options": { + "typeName": "WithRequiredCommandValidationOptions", + "fields": [ + { + "name": "HelpLink", + "jsonName": "helpLink", + "type": "*string", + "description": "An optional help link URL to guide users when the command is missing or fails validation." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithSessionLifetime", + "capabilityId": "Aspire.Hosting/withSessionLifetime", + "qualifiedName": "withSessionLifetime", + "description": "Configures a resource to use a session lifetime.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSessionLifetime() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithTerminal", + "capabilityId": "Aspire.Hosting/withTerminal", + "qualifiedName": "withTerminal", + "description": "Adds an interactive terminal session to a resource using the default terminal options.", + "kind": "Method", + "signature": "WithTerminal() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithToolIgnoreExistingFeeds", + "capabilityId": "Aspire.Hosting/withToolIgnoreExistingFeeds", + "qualifiedName": "withToolIgnoreExistingFeeds", + "description": "Configures the tool to use only the specified package sources, ignoring existing NuGet configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolIgnoreExistingFeeds() DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolIgnoreFailedSources", + "capabilityId": "Aspire.Hosting/withToolIgnoreFailedSources", + "qualifiedName": "withToolIgnoreFailedSources", + "description": "Configures the resource to treat package source failures as warnings.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolIgnoreFailedSources() DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolPackage", + "capabilityId": "Aspire.Hosting/withToolPackage", + "qualifiedName": "withToolPackage", + "description": "Sets the package identifier for the tool configuration associated with the resource builder.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolPackage(packageId string) DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [ + { + "name": "packageId", + "type": "string", + "description": "The package identifier to assign to the tool configuration. Cannot be null." + } + ], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolPrerelease", + "capabilityId": "Aspire.Hosting/withToolPrerelease", + "qualifiedName": "withToolPrerelease", + "description": "Allows prerelease versions of the tool to be used", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolPrerelease() DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolSource", + "capabilityId": "Aspire.Hosting/withToolSource", + "qualifiedName": "withToolSource", + "description": "Adds a NuGet package source for tool acquisition.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolSource(source string) DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source to add." + } + ], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolVersion", + "capabilityId": "Aspire.Hosting/withToolVersion", + "qualifiedName": "withToolVersion", + "description": "Sets the package version for a tool to use.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolVersion(version string) DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [ + { + "name": "version", + "type": "string", + "description": "The package version to use" + } + ], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithUrl", + "capabilityId": "Aspire.Hosting/withUrl", + "qualifiedName": "withUrl", + "description": "Adds or modifies displayed URLs", + "kind": "Method", + "signature": "WithUrl(url any, options ...*WithUrlOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ] + } + ], + "options": { + "typeName": "WithUrlOptions", + "fields": [ + { + "name": "DisplayText", + "jsonName": "displayText", + "type": "*string" + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithUrlForEndpoint", + "capabilityId": "Aspire.Hosting/withUrlForEndpoint", + "qualifiedName": "withUrlForEndpoint", + "description": "Registers a callback to update the URL displayed for the endpoint with the specified name.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUrlForEndpoint(endpointName string, callback func(obj *ResourceUrlAnnotation)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "endpointName", + "type": "string", + "description": "The name of the endpoint to customize the URL for." + }, + { + "name": "callback", + "type": "func(obj *ResourceUrlAnnotation)", + "isCallback": true, + "callbackSignature": "func(obj *ResourceUrlAnnotation)", + "description": "The callback that will customize the URL." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithUrls", + "capabilityId": "Aspire.Hosting/withUrls", + "qualifiedName": "withUrls", + "description": "Registers a callback to customize the URLs displayed for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUrls(callback func(obj ResourceUrlsCallbackContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(obj ResourceUrlsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(obj ResourceUrlsCallbackContext)", + "description": "The callback that will customize URLs for the resource." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithVolume", + "capabilityId": "Aspire.Hosting/withExecutableVolume", + "qualifiedName": "withVolume", + "description": "Adds a volume to an executable resource.", + "returns": "The same executable resource builder handle for chaining.", + "kind": "Method", + "signature": "WithVolume(target string, name string, env string, options ...*ExecutableResourceWithVolumeOptions) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "target", + "type": "string", + "description": "The mount path inside the published container." + }, + { + "name": "name", + "type": "string", + "description": "The volume name." + }, + { + "name": "env", + "type": "string", + "description": "The environment variable that receives the effective volume path." + } + ], + "options": { + "typeName": "ExecutableResourceWithVolumeOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "Whether the published volume is read-only." + } + ] + }, + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "WithVolume", + "capabilityId": "Aspire.Hosting/withProjectVolume", + "qualifiedName": "withVolume", + "description": "Adds a volume to a project resource.", + "returns": "The same project resource builder handle for chaining.", + "kind": "Method", + "signature": "WithVolume(target string, name string, env string, options ...*ProjectResourceWithVolumeOptions) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "target", + "type": "string", + "description": "The mount path inside the published container." + }, + { + "name": "name", + "type": "string", + "description": "The volume name." + }, + { + "name": "env", + "type": "string", + "description": "The environment variable that receives the effective volume path." + } + ], + "options": { + "typeName": "ProjectResourceWithVolumeOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "Whether the published volume is read-only." + } + ] + }, + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithVolume", + "capabilityId": "Aspire.Hosting/withVolume", + "qualifiedName": "withVolume", + "description": "Adds a volume to a container resource.", + "remarks": "Volumes persist data across container restarts. Named volumes are managed\nby Docker/Podman and stored in a system-managed location.\nWhy this wrapper exists: The original `ContainerResourceBuilderExtensions.WithVolume`\nhas parameter order `(name?, target, isReadOnly)` where the optional `name` comes first.\nThis wrapper reorders parameters to `(target, name?, isReadOnly)` so the required `target`\nparameter comes first, providing a better API for polyglot consumers.", + "returns": "The same resource builder handle for chaining.", + "kind": "Method", + "signature": "WithVolume(target string, options ...*WithVolumeOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "target", + "type": "string", + "description": "The mount path inside the container." + } + ], + "options": { + "typeName": "WithVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The volume name. If null, an anonymous volume is created." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "Whether the volume is read-only." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithWorkingDirectory", + "capabilityId": "Aspire.Hosting/withWorkingDirectory", + "qualifiedName": "withWorkingDirectory", + "description": "Sets the working directory for the executable resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWorkingDirectory(workingDirectory string) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "workingDirectory", + "type": "string", + "description": "Working directory." + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "WithoutHttpsCertificate", + "capabilityId": "Aspire.Hosting/withoutHttpsCertificate", + "qualifiedName": "withoutHttpsCertificate", + "description": "Disable HTTPS/TLS server certificate configuration for the resource. No HTTPS/TLS termination configuration will be applied.", + "remarks": "Disable HTTPS certificate configuration for a Redis resource:\n```\nvar redis = builder.AddRedis(\"cache\")\n.WithoutHttpsCertificate();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithoutHttpsCertificate() ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WorkDir", + "capabilityId": "Aspire.Hosting/workDir", + "qualifiedName": "workDir", + "description": "Adds a WORKDIR statement to a Dockerfile stage", + "kind": "Method", + "signature": "WorkDir(path string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "path", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + } + ], + "handleTypes": [ + { + "name": "AfterResourcesCreatedEvent", + "fullName": "Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent", + "kind": "handle", + "description": "This event is published after all resources have been created.", + "remarks": "Subscribing to this event is analogous to implementing the `AfterResourcesCreatedAsync`\nmethod. This event provides access to the `IServiceProvider` interface to resolve dependencies including\n`DistributedApplicationModel` service which is passed in as an argument\nin `AfterResourcesCreatedAsync`.", + "implementedInterfaces": [ + "DistributedApplicationEvent" + ], + "capabilities": [ + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/AfterResourcesCreatedEvent.model", + "qualifiedName": "AfterResourcesCreatedEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "AfterResourcesCreatedEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent" + ], + "appliesTo": [ + "AfterResourcesCreatedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/AfterResourcesCreatedEvent.services", + "qualifiedName": "AfterResourcesCreatedEvent.services", + "description": "The `IServiceProvider` instance.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "AfterResourcesCreatedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AfterResourcesCreatedEvent" + ], + "appliesTo": [ + "AfterResourcesCreatedEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BeforeResourceStartedEvent", + "fullName": "Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent", + "kind": "handle", + "description": "This event is raised by orchestrators before they have started a new resource.", + "remarks": "Resources that are created by orchestrators may not yet be ready to handle requests.", + "implementedInterfaces": [ + "DistributedApplicationEvent", + "DistributedApplicationResourceEvent" + ], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeResourceStartedEvent.resource", + "qualifiedName": "BeforeResourceStartedEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "BeforeResourceStartedEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent" + ], + "appliesTo": [ + "BeforeResourceStartedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeResourceStartedEvent.services", + "qualifiedName": "BeforeResourceStartedEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "BeforeResourceStartedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeResourceStartedEvent" + ], + "appliesTo": [ + "BeforeResourceStartedEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BeforeStartEvent", + "fullName": "Aspire.Hosting.ApplicationModel.BeforeStartEvent", + "kind": "handle", + "description": "This event is published before the application starts.", + "remarks": "Subscribing to this event is analogous to implementing the `BeforeStartAsync`\nmethod. This event provides access to the `IServiceProvider` interface to resolve dependencies including\n`DistributedApplicationModel` service which is passed in as an argument\nin `BeforeStartAsync`.", + "implementedInterfaces": [ + "DistributedApplicationEvent" + ], + "capabilities": [ + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeStartEvent.model", + "qualifiedName": "BeforeStartEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "BeforeStartEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeStartEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeStartEvent" + ], + "appliesTo": [ + "BeforeStartEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/BeforeStartEvent.services", + "qualifiedName": "BeforeStartEvent.services", + "description": "The `IServiceProvider` instance.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "BeforeStartEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.BeforeStartEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.BeforeStartEvent" + ], + "appliesTo": [ + "BeforeStartEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "CSharpAppResource", + "fullName": "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "kind": "handle", + "implementedInterfaces": [ + "DotnetProgramResource", + "IComputeResource", + "IContainerFilesDestinationResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "CommandLineArgsCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "kind": "handle", + "description": "Represents a callback context for the list of command-line arguments associated with an executable resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Args", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.args", + "qualifiedName": "CommandLineArgsCallbackContext.args", + "description": "Gets the editor used to manipulate command-line arguments in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Args() CommandLineArgsEditor", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "CommandLineArgsEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.executionContext", + "qualifiedName": "CommandLineArgsCallbackContext.executionContext", + "description": "Gets the execution context associated with this callback.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.log", + "qualifiedName": "CommandLineArgsCallbackContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/CommandLineArgsCallbackContext.resource", + "qualifiedName": "CommandLineArgsCallbackContext.resource", + "description": "The resource associated with this callback context.", + "remarks": "This will be set to the resource in all cases where Aspire invokes the callback.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "CommandLineArgsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsCallbackContext" + ], + "appliesTo": [ + "CommandLineArgsCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "CommandLineArgsEditor", + "fullName": "Aspire.Hosting.ApplicationModel.CommandLineArgsEditor", + "kind": "handle", + "description": "Provides an ATS-first editor for command-line arguments within polyglot callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Add", + "capabilityId": "Aspire.Hosting.ApplicationModel/add", + "qualifiedName": "CommandLineArgsEditor.add", + "description": "Adds a command-line argument.", + "kind": "InstanceMethod", + "signature": "Add(value any) error", + "receiver": "CommandLineArgsEditor", + "parameters": [ + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression", + "EndpointReference", + "ParameterResource", + "ResourceWithConnectionString", + "ExpressionValue" + ], + "description": "The argument to add." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.CommandLineArgsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.CommandLineArgsEditor" + ], + "appliesTo": [ + "CommandLineArgsEditor" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ConnectionStringAvailableEvent", + "fullName": "Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent", + "kind": "handle", + "description": "The {@ats-ref type:ConnectionStringAvailableEvent} is raised when a connection string becomes available for a resource.", + "implementedInterfaces": [ + "DistributedApplicationEvent", + "DistributedApplicationResourceEvent" + ], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ConnectionStringAvailableEvent.resource", + "qualifiedName": "ConnectionStringAvailableEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ConnectionStringAvailableEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent" + ], + "appliesTo": [ + "ConnectionStringAvailableEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ConnectionStringAvailableEvent.services", + "qualifiedName": "ConnectionStringAvailableEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ConnectionStringAvailableEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ConnectionStringAvailableEvent" + ], + "appliesTo": [ + "ConnectionStringAvailableEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerBuildOptionsCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "kind": "handle", + "description": "Context for configuring container build options via a callback.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.cancellationToken", + "qualifiedName": "ContainerBuildOptionsCallbackContext.cancellationToken", + "description": "Gets the cancellation token.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Destination", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.destination", + "qualifiedName": "ContainerBuildOptionsCallbackContext.destination", + "description": "Gets or sets the destination for the container image.", + "kind": "PropertyGetter", + "signature": "Destination() (*ContainerImageDestination, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*ContainerImageDestination, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.executionContext", + "qualifiedName": "ContainerBuildOptionsCallbackContext.executionContext", + "description": "Gets the distributed application execution context.", + "remarks": "Use `IsPublishMode` or\n`IsRunMode` to vary build options\n(for example `TargetPlatform`) between local run and publish operations.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "ImageFormat", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.imageFormat", + "qualifiedName": "ContainerBuildOptionsCallbackContext.imageFormat", + "description": "Gets or sets the container image format.", + "kind": "PropertyGetter", + "signature": "ImageFormat() (*ContainerImageFormat, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*ContainerImageFormat, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "LocalImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.localImageName", + "qualifiedName": "ContainerBuildOptionsCallbackContext.localImageName", + "description": "Gets or sets the local image name for the built container.", + "kind": "PropertyGetter", + "signature": "LocalImageName() (*string, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "LocalImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.localImageTag", + "qualifiedName": "ContainerBuildOptionsCallbackContext.localImageTag", + "description": "Gets or sets the local image tag for the built container.", + "kind": "PropertyGetter", + "signature": "LocalImageTag() (*string, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.logger", + "qualifiedName": "ContainerBuildOptionsCallbackContext.logger", + "description": "Gets the logger instance.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "OutputPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.outputPath", + "qualifiedName": "ContainerBuildOptionsCallbackContext.outputPath", + "description": "Gets or sets the output path for the container archive.", + "remarks": "For .NET SDK publishing, a non-existent path with any filename extension is an archive filename.\nEnd a directory path with the platform's directory separator to make directory intent explicit,\nespecially when its name contains a period. Prefer an explicit archive filename to avoid ambiguity.\nOther container image builders may interpret this path as an output directory.", + "kind": "PropertyGetter", + "signature": "OutputPath() (*string, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.resource", + "qualifiedName": "ContainerBuildOptionsCallbackContext.resource", + "description": "Gets the resource being built.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.services", + "qualifiedName": "ContainerBuildOptionsCallbackContext.services", + "description": "Gets the service provider.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetDestination", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setDestination", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setDestination", + "description": "Gets or sets the destination for the container image.", + "kind": "PropertySetter", + "signature": "SetDestination(value *ContainerImageDestination) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*ContainerImageDestination", + "description": "Gets or sets the destination for the container image." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetImageFormat", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setImageFormat", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setImageFormat", + "description": "Gets or sets the container image format.", + "kind": "PropertySetter", + "signature": "SetImageFormat(value *ContainerImageFormat) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*ContainerImageFormat", + "description": "Gets or sets the container image format." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetLocalImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setLocalImageName", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setLocalImageName", + "description": "Gets or sets the local image name for the built container.", + "kind": "PropertySetter", + "signature": "SetLocalImageName(value *string) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the local image name for the built container." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetLocalImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setLocalImageTag", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setLocalImageTag", + "description": "Gets or sets the local image tag for the built container.", + "kind": "PropertySetter", + "signature": "SetLocalImageTag(value *string) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the local image tag for the built container." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetOutputPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setOutputPath", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setOutputPath", + "description": "Gets or sets the output path for the container archive.", + "remarks": "For .NET SDK publishing, a non-existent path with any filename extension is an archive filename.\nEnd a directory path with the platform's directory separator to make directory intent explicit,\nespecially when its name contains a period. Prefer an explicit archive filename to avoid ambiguity.\nOther container image builders may interpret this path as an output directory.", + "kind": "PropertySetter", + "signature": "SetOutputPath(value *string) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the output path for the container archive." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "SetTargetPlatform", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.setTargetPlatform", + "qualifiedName": "ContainerBuildOptionsCallbackContext.setTargetPlatform", + "description": "Gets or sets the target platform for the container.", + "kind": "PropertySetter", + "signature": "SetTargetPlatform(value *ContainerTargetPlatform) ContainerBuildOptionsCallbackContext", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [ + { + "name": "value", + "type": "*ContainerTargetPlatform", + "description": "Gets or sets the target platform for the container." + } + ], + "returnType": "ContainerBuildOptionsCallbackContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + }, + { + "name": "TargetPlatform", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerBuildOptionsCallbackContext.targetPlatform", + "qualifiedName": "ContainerBuildOptionsCallbackContext.targetPlatform", + "description": "Gets or sets the target platform for the container.", + "kind": "PropertyGetter", + "signature": "TargetPlatform() (*ContainerTargetPlatform, error)", + "receiver": "ContainerBuildOptionsCallbackContext", + "parameters": [], + "returnType": "(*ContainerTargetPlatform, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerBuildOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerBuildOptionsCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerFileSystemCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "kind": "handle", + "description": "Represents the context for a `ContainerFileSystemCallbackAnnotation` callback.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerFileSystemCallbackContext.model", + "qualifiedName": "ContainerFileSystemCallbackContext.model", + "description": "The app model resource the callback is associated with.", + "kind": "PropertyGetter", + "signature": "Model() Resource", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerFileSystemCallbackContext.services", + "qualifiedName": "ContainerFileSystemCallbackContext.services", + "description": "A `IServiceProvider` that can be used to resolve services in the callback.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "CreateCertificateFile", + "capabilityId": "Aspire.Hosting/createCertificateFile", + "qualifiedName": "createCertificateFile", + "description": "Creates a PEM container certificate file entry with the OpenSSL subject-hash symlink.", + "returns": "The created certificate file entry.", + "kind": "Method", + "signature": "CreateCertificateFile(name string, options ...*CreateCertificateFileOptions) ContainerFileSystemItem", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The simple file name (no path separators)." + } + ], + "options": { + "typeName": "CreateCertificateFileOptions", + "fields": [ + { + "name": "Contents", + "jsonName": "contents", + "type": "*string", + "description": "The inline PEM-encoded contents of the certificate. Mutually exclusive with `sourcePath`." + }, + { + "name": "SourcePath", + "jsonName": "sourcePath", + "type": "*string", + "description": "An absolute path to a PEM file on the host to copy. Mutually exclusive with `contents`." + }, + { + "name": "Owner", + "jsonName": "owner", + "type": "*float64", + "description": "The owner UID, or `null` to inherit." + }, + { + "name": "Group", + "jsonName": "group", + "type": "*float64", + "description": "The group GID, or `null` to inherit." + }, + { + "name": "Mode", + "jsonName": "mode", + "type": "*float64", + "description": "The Unix file mode as an integer (for example `0o644`), or `null` to inherit." + }, + { + "name": "ContinueOnError", + "jsonName": "continueOnError", + "type": "*bool", + "description": "Whether to ignore errors creating this file." + } + ] + }, + "returnType": "ContainerFileSystemItem", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "CreateDirectory", + "capabilityId": "Aspire.Hosting/createDirectory", + "qualifiedName": "createDirectory", + "description": "Creates a container directory entry containing the specified child entries.", + "returns": "The created directory entry.", + "kind": "Method", + "signature": "CreateDirectory(name string, entries []ContainerFileSystemItem, options ...*CreateDirectoryOptions) ContainerFileSystemItem", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The simple directory name (no path separators)." + }, + { + "name": "entries", + "type": "[]ContainerFileSystemItem", + "description": "The child entries (files and/or directories) created via this context." + } + ], + "options": { + "typeName": "CreateDirectoryOptions", + "fields": [ + { + "name": "Owner", + "jsonName": "owner", + "type": "*float64", + "description": "The owner UID, or `null` to inherit." + }, + { + "name": "Group", + "jsonName": "group", + "type": "*float64", + "description": "The group GID, or `null` to inherit." + }, + { + "name": "Mode", + "jsonName": "mode", + "type": "*float64", + "description": "The Unix file mode as an integer (for example `0o755`), or `null` to inherit." + } + ] + }, + "returnType": "ContainerFileSystemItem", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + }, + { + "name": "CreateFile", + "capabilityId": "Aspire.Hosting/createFile", + "qualifiedName": "createFile", + "description": "Creates a container file entry with inline contents or a host source path.", + "returns": "The created file entry.", + "kind": "Method", + "signature": "CreateFile(name string, options ...*CreateFileOptions) ContainerFileSystemItem", + "receiver": "ContainerFileSystemCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The simple file name (no path separators)." + } + ], + "options": { + "typeName": "CreateFileOptions", + "fields": [ + { + "name": "Contents", + "jsonName": "contents", + "type": "*string", + "description": "The inline UTF-8 contents of the file. Mutually exclusive with `sourcePath`." + }, + { + "name": "SourcePath", + "jsonName": "sourcePath", + "type": "*string", + "description": "An absolute path to a file on the host to copy. Mutually exclusive with `contents`." + }, + { + "name": "Owner", + "jsonName": "owner", + "type": "*float64", + "description": "The owner UID, or `null` to inherit." + }, + { + "name": "Group", + "jsonName": "group", + "type": "*float64", + "description": "The group GID, or `null` to inherit." + }, + { + "name": "Mode", + "jsonName": "mode", + "type": "*float64", + "description": "The Unix file mode as an integer (for example `0o644`), or `null` to inherit." + }, + { + "name": "ContinueOnError", + "jsonName": "continueOnError", + "type": "*bool", + "description": "Whether to ignore errors creating this file." + } + ] + }, + "returnType": "ContainerFileSystemItem", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerFileSystemCallbackContext" + ], + "appliesTo": [ + "ContainerFileSystemCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerFileSystemItem", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerFileSystemItem", + "kind": "handle", + "description": "Represents a base class for file system entries in a container.", + "remarks": "Exported to ATS as an opaque handle type. Polyglot AppHosts never construct or inspect these\ndirectly; they create concrete entries through the factory methods on\n`ContainerFileSystemCallbackContext` and pass the resulting handles back via the callback.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ContainerImagePushOptions", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "kind": "handle", + "description": "Represents options for pushing container images to a registry.", + "remarks": "This class allows customization of how container images are named and tagged when pushed to a container registry.\nThe `RemoteImageName` specifies the repository path (without registry endpoint or tag),\nand `RemoteImageTag` specifies the tag to apply. Use `GetFullRemoteImageNameAsync`\nto construct the complete image reference including registry endpoint and tag.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "RemoteImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.remoteImageName", + "qualifiedName": "ContainerImagePushOptions.remoteImageName", + "description": "Gets or sets the remote image name (repository path without registry endpoint or tag).", + "kind": "PropertyGetter", + "signature": "RemoteImageName() (*string, error)", + "receiver": "ContainerImagePushOptions", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "RemoteImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.remoteImageTag", + "qualifiedName": "ContainerImagePushOptions.remoteImageTag", + "description": "Gets or sets the remote image tag.", + "kind": "PropertyGetter", + "signature": "RemoteImageTag() (*string, error)", + "receiver": "ContainerImagePushOptions", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "SetRemoteImageName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.setRemoteImageName", + "qualifiedName": "ContainerImagePushOptions.setRemoteImageName", + "description": "Gets or sets the remote image name (repository path without registry endpoint or tag).", + "kind": "PropertySetter", + "signature": "SetRemoteImageName(value *string) ContainerImagePushOptions", + "receiver": "ContainerImagePushOptions", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the remote image name (repository path without registry endpoint or tag)." + } + ], + "returnType": "ContainerImagePushOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + }, + { + "name": "SetRemoteImageTag", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptions.setRemoteImageTag", + "qualifiedName": "ContainerImagePushOptions.setRemoteImageTag", + "description": "Gets or sets the remote image tag.", + "kind": "PropertySetter", + "signature": "SetRemoteImageTag(value *string) ContainerImagePushOptions", + "receiver": "ContainerImagePushOptions", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the remote image tag." + } + ], + "returnType": "ContainerImagePushOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptions" + ], + "appliesTo": [ + "ContainerImagePushOptions" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerImagePushOptionsCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "kind": "handle", + "description": "Provides context information for container image push options callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptionsCallbackContext.cancellationToken", + "qualifiedName": "ContainerImagePushOptionsCallbackContext.cancellationToken", + "description": "Gets the cancellation token to observe while configuring image push options.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ContainerImagePushOptionsCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerImagePushOptionsCallbackContext" + ] + }, + { + "name": "Options", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptionsCallbackContext.options", + "qualifiedName": "ContainerImagePushOptionsCallbackContext.options", + "description": "Gets the container image push options that can be modified by the callback.", + "kind": "PropertyGetter", + "signature": "Options() ContainerImagePushOptions", + "receiver": "ContainerImagePushOptionsCallbackContext", + "parameters": [], + "returnType": "ContainerImagePushOptions", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerImagePushOptionsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImagePushOptionsCallbackContext.resource", + "qualifiedName": "ContainerImagePushOptionsCallbackContext.resource", + "description": "Gets the resource being configured for container image push operations.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerImagePushOptionsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImagePushOptionsCallbackContext" + ], + "appliesTo": [ + "ContainerImagePushOptionsCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerImageReference", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerImageReference", + "kind": "handle", + "description": "Represents the fully‑qualified container image reference that should be deployed.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImageReference.resource", + "qualifiedName": "ContainerImageReference.resource", + "description": "Gets the resource that this container image is associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerImageReference", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImageReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImageReference" + ], + "appliesTo": [ + "ContainerImageReference" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerImageReference.valueExpression", + "qualifiedName": "ContainerImageReference.valueExpression", + "description": "Gets the ValueExpression property", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "ContainerImageReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerImageReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerImageReference" + ], + "appliesTo": [ + "ContainerImageReference" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerMountAnnotation", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "kind": "handle", + "description": "Represents a mount annotation for a container resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "IsReadOnly", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.isReadOnly", + "qualifiedName": "ContainerMountAnnotation.isReadOnly", + "description": "Gets a value indicating whether the volume mount is read-only.", + "kind": "PropertyGetter", + "signature": "IsReadOnly() (bool, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.source", + "qualifiedName": "ContainerMountAnnotation.source", + "description": "Gets the source of the bind mount or name if a volume. Can be `null` if the mount is an anonymous volume.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.target", + "qualifiedName": "ContainerMountAnnotation.target", + "description": "Gets the target of the mount.", + "kind": "PropertyGetter", + "signature": "Target() (string, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + }, + { + "name": "Type", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerMountAnnotation.type", + "qualifiedName": "ContainerMountAnnotation.type", + "description": "Gets the type of the mount.", + "kind": "PropertyGetter", + "signature": "Type() (ContainerMountType, error)", + "receiver": "ContainerMountAnnotation", + "parameters": [], + "returnType": "(ContainerMountType, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerMountAnnotation", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerMountAnnotation" + ], + "appliesTo": [ + "ContainerMountAnnotation" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerPortReference", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerPortReference", + "kind": "handle", + "description": "Represents a TCP/UDP port that a container can expose.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerPortReference.resource", + "qualifiedName": "ContainerPortReference.resource", + "description": "Gets the resource that this container port is associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ContainerPortReference", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerPortReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerPortReference" + ], + "appliesTo": [ + "ContainerPortReference" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ContainerPortReference.valueExpression", + "qualifiedName": "ContainerPortReference.valueExpression", + "description": "Gets the ValueExpression property", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "ContainerPortReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerPortReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerPortReference" + ], + "appliesTo": [ + "ContainerPortReference" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerRegistryResource", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ContainerResource", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerResource", + "kind": "handle", + "description": "A resource that represents a specified container.", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "PublishAsConnectionString", + "capabilityId": "Aspire.Hosting/publishAsConnectionString", + "qualifiedName": "publishAsConnectionString", + "description": "Changes the resource to be published as a connection string reference in the manifest.", + "remarks": "This API only changes the manifest representation; it does not change the resource model used by other publishers.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsConnectionString() ContainerResource", + "receiver": "ContainerResource", + "parameters": [], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "PublishAsContainer", + "capabilityId": "Aspire.Hosting/publishAsContainer", + "qualifiedName": "publishAsContainer", + "description": "Changes the resource to be published as a container in the manifest.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsContainer() ContainerResource", + "receiver": "ContainerResource", + "parameters": [], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithBindMount", + "capabilityId": "Aspire.Hosting/withBindMount", + "qualifiedName": "withBindMount", + "description": "Adds a bind mount to a container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBindMount(source string, target string, options ...*WithBindMountOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source path of the mount. This is the path to the file or directory on the host, relative to the AppHost project directory." + }, + { + "name": "target", + "type": "string", + "description": "The target path where the file or directory is mounted in the container." + } + ], + "options": { + "typeName": "WithBindMountOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithBuildArg", + "capabilityId": "Aspire.Hosting/withBuildArg", + "qualifiedName": "withBuildArg", + "description": "Adds a build argument when the container is built from a Dockerfile.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBuildArg(name string, value any) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the build argument." + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The build argument value, either a string or a parameter resource." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithBuildSecret", + "capabilityId": "Aspire.Hosting/withParameterBuildSecret", + "qualifiedName": "withBuildSecret", + "description": "Adds a secret build argument when the container is built from a Dockerfile.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBuildSecret(name string, value ParameterResource) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret build argument." + }, + { + "name": "value", + "type": "ParameterResource", + "description": "The resource builder for a parameter resource." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerCertificatePaths", + "capabilityId": "Aspire.Hosting/withContainerCertificatePaths", + "qualifiedName": "withContainerCertificatePaths", + "description": "Adds container certificate path overrides used for certificate trust at run time.", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "WithContainerCertificatePaths(options ...*WithContainerCertificatePathsOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [], + "options": { + "typeName": "WithContainerCertificatePathsOptions", + "fields": [ + { + "name": "CustomCertificatesDestination", + "jsonName": "customCertificatesDestination", + "type": "*string", + "description": "The destination path in the container where custom certificates will be copied." + }, + { + "name": "DefaultCertificateBundlePaths", + "jsonName": "defaultCertificateBundlePaths", + "type": "[]string", + "description": "Default certificate bundle paths in the container that will be replaced." + }, + { + "name": "DefaultCertificateDirectoryPaths", + "jsonName": "defaultCertificateDirectoryPaths", + "type": "[]string", + "description": "Default certificate directory paths in the container that may be appended." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerFiles", + "capabilityId": "Aspire.Hosting/withContainerFiles", + "qualifiedName": "withContainerFiles", + "description": "Creates or updates files and folders in a container by copying them from a source path on the host.", + "remarks": "In run mode, Aspire copies the files into the container and applies owner, group, and umask options.\nIn publish mode, Aspire creates a read-only bind mount and ignores those options.\nTo produce entries dynamically (including inline file contents and OpenSSL certificate files), polyglot AppHosts\nuse the `withContainerFilesCallback` overload and build the entries via the factory methods on\n`ContainerFileSystemCallbackContext`. Passing a pre-built `ContainerFileSystemItem` collection\nremains .NET-only.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerFiles(destinationPath string, sourcePath string, options ...*ContainerFilesOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "destinationPath", + "type": "string", + "description": "The destination absolute path in the container." + }, + { + "name": "sourcePath", + "type": "string", + "description": "The source path on the host to copy files from." + } + ], + "options": { + "typeName": "ContainerFilesOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerFilesCallback", + "capabilityId": "Aspire.Hosting/withContainerFilesCallback", + "qualifiedName": "withContainerFilesCallback", + "description": "Creates or updates files and/or folders at the destination path in the container using entries produced by a callback.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerFilesCallback(destinationPath string, callback func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem, options ...*ContainerFilesOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "destinationPath", + "type": "string", + "description": "The destination absolute path in the container." + }, + { + "name": "callback", + "type": "func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem", + "isCallback": true, + "callbackSignature": "func(arg1 ContainerFileSystemCallbackContext, arg2 *CancellationToken) []ContainerFileSystemItem", + "description": "A callback that returns the file system entries to create or update. Use the factory methods on `ContainerFileSystemCallbackContext` (createFile, createDirectory, createCertificateFile) to build the entries." + } + ], + "options": { + "typeName": "ContainerFilesOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerName", + "capabilityId": "Aspire.Hosting/withContainerName", + "qualifiedName": "withContainerName", + "description": "Overrides the default container name for this resource. By default Aspire generates a unique container name based on the resource name and a random postfix (or a postfix based on a hash of the AppHost project path for persistent container resources). This method allows you to override that behavior with a custom name, but could lead to naming conflicts if the specified name is not unique.", + "remarks": "Combining this with `Persistent` will allow Aspire to re-use an existing container that was not\ncreated by an Aspire AppHost.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerName(name string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The desired container name. Must be a valid container name or your runtime will report an error." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerNetworkAlias", + "capabilityId": "Aspire.Hosting/withContainerNetworkAlias", + "qualifiedName": "withContainerNetworkAlias", + "description": "Adds a network alias to container resource.", + "remarks": "Network aliases enable DNS resolution of the container on the network by custom names.\nBy default, containers are accessible on the network using their resource name as a DNS alias.\nThis method allows adding additional aliases for the same container.\nMultiple aliases can be added by calling this method multiple times.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerNetworkAlias(alias string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "alias", + "type": "string", + "description": "The network alias for the container." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithContainerRuntimeArgs", + "capabilityId": "Aspire.Hosting/withContainerRuntimeArgs", + "qualifiedName": "withContainerRuntimeArgs", + "description": "Adds a callback to be executed with a list of arguments to add to the container runtime run command when a container resource is started.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerRuntimeArgs(args []string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "The arguments to be passed to the container runtime run command when the container resource is started." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithDockerfile", + "capabilityId": "Aspire.Hosting/withDockerfile", + "qualifiedName": "withDockerfile", + "description": "Causes Aspire to build the specified container image from a Dockerfile.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfile(contextPath string, options ...*WithDockerfileOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + } + ], + "options": { + "typeName": "WithDockerfileOptions", + "fields": [ + { + "name": "DockerfilePath", + "jsonName": "dockerfilePath", + "type": "*string", + "description": "Path to the Dockerfile relative to the `contextPath`. Defaults to \"Dockerfile\" if not specified." + }, + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithDockerfileBuilder", + "capabilityId": "Aspire.Hosting/withDockerfileBuilder", + "qualifiedName": "withDockerfileBuilder", + "description": "Configures the resource to use a programmatically generated Dockerfile", + "remarks": "This method provides a programmatic way to build Dockerfiles using the `DockerfileBuilder` API\ninstead of string manipulation. Callbacks can be composed by calling this method multiple times - each callback will be invoked\nin order to build up the final Dockerfile.\nThe `contextPath` is relative to the AppHost directory unless it is fully qualified.\nCreates a container with a programmatically built Dockerfile using fluent API:\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddContainer(\"mycontainer\", \"myimage\")\n.WithDockerfileBuilder(\"path/to/context\", context =>\n{\ncontext.Builder.From(\"alpine:latest\")\n.WorkDir(\"/app\")\n.Run(\"apk add curl\")\n.Copy(\".\", \".\")\n.Cmd([\"./myapp\"]);\nreturn Task.CompletedTask;\n});\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfileBuilder(contextPath string, callback func(arg DockerfileBuilderCallbackContext), options ...*WithDockerfileBuilderOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "callback", + "type": "func(arg DockerfileBuilderCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg DockerfileBuilderCallbackContext)", + "description": "A callback that uses the `DockerfileBuilder` API to construct the Dockerfile." + } + ], + "options": { + "typeName": "WithDockerfileBuilderOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithDockerfileFactory", + "capabilityId": "Aspire.Hosting/withDockerfileFactory", + "qualifiedName": "withDockerfileFactory", + "description": "Builds the specified container image from a Dockerfile generated by an asynchronous factory function.", + "remarks": "When this method is called, an annotation is added to the `ContainerResource` that specifies the context path\nand a factory function that generates Dockerfile content. The factory is invoked at build time to produce the Dockerfile,\nwhich is then written to a temporary file and used by the orchestrator to build the container image.\nThe `contextPath` is relative to the AppHost directory unless it is fully qualified.\nThe factory function is invoked once during the build process to generate the Dockerfile content.\nThe output is trusted and not validated.\nCreates a container called `mycontainer` with a dynamically generated Dockerfile.\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddContainer(\"mycontainer\", \"myimage\")\n.WithDockerfileFactory(\"path/to/context\", async context =>\n{\nvar template = await File.ReadAllTextAsync(\"template.dockerfile\", context.CancellationToken);\nreturn template.Replace(\"{{VERSION}}\", \"1.0\");\n});\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfileFactory(contextPath string, dockerfileFactory func(arg DockerfileFactoryContext) string, options ...*WithDockerfileFactoryOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "dockerfileFactory", + "type": "func(arg DockerfileFactoryContext) string", + "isCallback": true, + "callbackSignature": "func(arg DockerfileFactoryContext) string", + "description": "An asynchronous function that returns the Dockerfile content as a string." + } + ], + "options": { + "typeName": "WithDockerfileFactoryOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithEntrypoint", + "capabilityId": "Aspire.Hosting/withEntrypoint", + "qualifiedName": "withEntrypoint", + "description": "Sets the Entrypoint for the container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEntrypoint(entrypoint string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "entrypoint", + "type": "string", + "description": "The new entrypoint for the container." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImage", + "capabilityId": "Aspire.Hosting/withImage", + "qualifiedName": "withImage", + "description": "Allows overriding the image on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImage(image string, options ...*WithImageOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "image", + "type": "string", + "description": "Image value." + } + ], + "options": { + "typeName": "WithImageOptions", + "fields": [ + { + "name": "Tag", + "jsonName": "tag", + "type": "*string", + "description": "Tag value." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImagePullPolicy", + "capabilityId": "Aspire.Hosting/withImagePullPolicy", + "qualifiedName": "withImagePullPolicy", + "description": "Sets the pull policy for the container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImagePullPolicy(pullPolicy ImagePullPolicy) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "pullPolicy", + "type": "ImagePullPolicy", + "description": "The pull policy behavior for the container resource." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImageRegistry", + "capabilityId": "Aspire.Hosting/withImageRegistry", + "qualifiedName": "withImageRegistry", + "description": "Allows overriding the image registry on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImageRegistry(registry string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "registry", + "type": "string", + "description": "Registry value." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImageSHA256", + "capabilityId": "Aspire.Hosting/withImageSHA256", + "qualifiedName": "withImageSHA256", + "description": "Allows setting the image to a specific sha256 on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImageSHA256(sha256 string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "sha256", + "type": "string", + "description": "Registry value." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithImageTag", + "capabilityId": "Aspire.Hosting/withImageTag", + "qualifiedName": "withImageTag", + "description": "Allows overriding the image tag on a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImageTag(tag string) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "Tag value." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithLifetime", + "capabilityId": "Aspire.Hosting/withLifetime", + "qualifiedName": "withLifetime", + "description": "Sets the lifetime behavior of the container resource.", + "remarks": "Prefer `WithPersistentLifetime``1` or\n`WithSessionLifetime``1` for new code.\nMarking a container resource to have a `Persistent` lifetime.\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddContainer(\"mycontainer\", \"myimage\")\n.WithPersistentLifetime();\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLifetime(lifetime ContainerLifetime) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "lifetime", + "type": "ContainerLifetime", + "description": "The lifetime behavior of the container resource. The default behavior is `Session`." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "WithVolume", + "capabilityId": "Aspire.Hosting/withVolume", + "qualifiedName": "withVolume", + "description": "Adds a volume to a container resource.", + "remarks": "Volumes persist data across container restarts. Named volumes are managed\nby Docker/Podman and stored in a system-managed location.\nWhy this wrapper exists: The original `ContainerResourceBuilderExtensions.WithVolume`\nhas parameter order `(name?, target, isReadOnly)` where the optional `name` comes first.\nThis wrapper reorders parameters to `(target, name?, isReadOnly)` so the required `target`\nparameter comes first, providing a better API for polyglot consumers.", + "returns": "The same resource builder handle for chaining.", + "kind": "Method", + "signature": "WithVolume(target string, options ...*WithVolumeOptions) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "target", + "type": "string", + "description": "The mount path inside the container." + } + ], + "options": { + "typeName": "WithVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The volume name. If null, an anonymous volume is created." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "Whether the volume is read-only." + } + ] + }, + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationModel", + "fullName": "Aspire.Hosting.ApplicationModel.DistributedApplicationModel", + "kind": "handle", + "description": "Represents a distributed application.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "FindResourceByName", + "capabilityId": "Aspire.Hosting/findResourceByName", + "qualifiedName": "findResourceByName", + "description": "Finds a resource by name.", + "returns": "The matching resource, or `null` when not found.", + "kind": "Method", + "signature": "FindResourceByName(name string) Resource", + "receiver": "DistributedApplicationModel", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The resource name." + } + ], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DistributedApplicationModel", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DistributedApplicationModel" + ], + "appliesTo": [ + "DistributedApplicationModel" + ] + }, + { + "name": "GetResources", + "capabilityId": "Aspire.Hosting/getResources", + "qualifiedName": "getResources", + "description": "Gets all resources in the distributed application model.", + "returns": "The resources in the model.", + "kind": "Method", + "signature": "GetResources() ([]Resource, error)", + "receiver": "DistributedApplicationModel", + "parameters": [], + "returnType": "([]Resource, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DistributedApplicationModel", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DistributedApplicationModel" + ], + "appliesTo": [ + "DistributedApplicationModel" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerfileBuilder", + "fullName": "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "kind": "handle", + "description": "Builder for creating Dockerfiles programmatically.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AddContainerFilesStages", + "capabilityId": "Aspire.Hosting/dockerfileBuilderAddContainerFilesStages", + "qualifiedName": "addContainerFilesStages", + "description": "Adds Dockerfile stages for published container files", + "kind": "Method", + "signature": "AddContainerFilesStages(resource Resource, options ...*AddContainerFilesStagesOptions) DockerfileBuilder", + "receiver": "DockerfileBuilder", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "options": { + "typeName": "AddContainerFilesStagesOptions", + "fields": [ + { + "name": "Logger", + "jsonName": "logger", + "type": "*Logger" + } + ] + }, + "returnType": "DockerfileBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder" + ], + "appliesTo": [ + "DockerfileBuilder" + ] + }, + { + "name": "Arg", + "capabilityId": "Aspire.Hosting/dockerfileBuilderArg", + "qualifiedName": "arg", + "description": "Adds a global ARG statement to the Dockerfile", + "kind": "Method", + "signature": "Arg(name string, options ...*ArgOptions) DockerfileBuilder", + "receiver": "DockerfileBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "ArgOptions", + "fields": [ + { + "name": "DefaultValue", + "jsonName": "defaultValue", + "type": "*string" + } + ] + }, + "returnType": "DockerfileBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder" + ], + "appliesTo": [ + "DockerfileBuilder" + ] + }, + { + "name": "From", + "capabilityId": "Aspire.Hosting/dockerfileBuilderFrom", + "qualifiedName": "from", + "description": "Adds a FROM statement to start a Dockerfile stage", + "kind": "Method", + "signature": "From(image string, options ...*FromOptions) DockerfileStage", + "receiver": "DockerfileBuilder", + "parameters": [ + { + "name": "image", + "type": "string" + } + ], + "options": { + "typeName": "FromOptions", + "fields": [ + { + "name": "StageName", + "jsonName": "stageName", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileBuilder" + ], + "appliesTo": [ + "DockerfileBuilder" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerfileStage", + "fullName": "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "kind": "handle", + "description": "Represents a stage within a multi-stage Dockerfile.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AddContainerFiles", + "capabilityId": "Aspire.Hosting/dockerfileStageAddContainerFiles", + "qualifiedName": "addContainerFiles", + "description": "Adds COPY --from statements for published container files", + "kind": "Method", + "signature": "AddContainerFiles(resource Resource, rootDestinationPath string, options ...*AddContainerFilesOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "resource", + "type": "Resource" + }, + { + "name": "rootDestinationPath", + "type": "string" + } + ], + "options": { + "typeName": "AddContainerFilesOptions", + "fields": [ + { + "name": "Logger", + "jsonName": "logger", + "type": "*Logger" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Arg", + "capabilityId": "Aspire.Hosting/dockerfileStageArg", + "qualifiedName": "arg", + "description": "Adds an ARG statement to a Dockerfile stage", + "kind": "Method", + "signature": "Arg(name string, options ...*ArgOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "ArgOptions", + "fields": [ + { + "name": "DefaultValue", + "jsonName": "defaultValue", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Cmd", + "capabilityId": "Aspire.Hosting/cmd", + "qualifiedName": "cmd", + "description": "Adds a CMD statement to a Dockerfile stage", + "kind": "Method", + "signature": "Cmd(command []string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "[]string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Comment", + "capabilityId": "Aspire.Hosting/comment", + "qualifiedName": "comment", + "description": "Adds a comment to a Dockerfile stage", + "kind": "Method", + "signature": "Comment(comment string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "comment", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Copy", + "capabilityId": "Aspire.Hosting/dockerfileStageCopy", + "qualifiedName": "copy", + "description": "Adds a COPY statement to a Dockerfile stage", + "kind": "Method", + "signature": "Copy(source string, destination string, options ...*CopyOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "source", + "type": "string" + }, + { + "name": "destination", + "type": "string" + } + ], + "options": { + "typeName": "CopyOptions", + "fields": [ + { + "name": "Chown", + "jsonName": "chown", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "CopyFrom", + "capabilityId": "Aspire.Hosting/dockerfileStageCopyFrom", + "qualifiedName": "copyFrom", + "description": "Adds a COPY --from statement to a Dockerfile stage", + "kind": "Method", + "signature": "CopyFrom(from string, source string, destination string, options ...*CopyFromOptions) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "from", + "type": "string" + }, + { + "name": "source", + "type": "string" + }, + { + "name": "destination", + "type": "string" + } + ], + "options": { + "typeName": "CopyFromOptions", + "fields": [ + { + "name": "Chown", + "jsonName": "chown", + "type": "*string" + } + ] + }, + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "EmptyLine", + "capabilityId": "Aspire.Hosting/emptyLine", + "qualifiedName": "emptyLine", + "description": "Adds an empty line to a Dockerfile stage", + "kind": "Method", + "signature": "EmptyLine() DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Entrypoint", + "capabilityId": "Aspire.Hosting/entrypoint", + "qualifiedName": "entrypoint", + "description": "Adds an ENTRYPOINT statement to a Dockerfile stage", + "kind": "Method", + "signature": "Entrypoint(command []string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "[]string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Env", + "capabilityId": "Aspire.Hosting/env", + "qualifiedName": "env", + "description": "Adds an ENV statement to a Dockerfile stage", + "kind": "Method", + "signature": "Env(name string, value string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Expose", + "capabilityId": "Aspire.Hosting/expose", + "qualifiedName": "expose", + "description": "Adds an EXPOSE statement to a Dockerfile stage", + "kind": "Method", + "signature": "Expose(port float64) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "port", + "type": "float64" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "Run", + "capabilityId": "Aspire.Hosting/dockerfileStageRun", + "qualifiedName": "run", + "description": "Adds a RUN statement to a Dockerfile stage", + "kind": "Method", + "signature": "Run(command string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "RunWithMounts", + "capabilityId": "Aspire.Hosting/runWithMounts", + "qualifiedName": "runWithMounts", + "description": "Adds a RUN statement with mounts to a Dockerfile stage", + "kind": "Method", + "signature": "RunWithMounts(command string, mounts []string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "command", + "type": "string" + }, + { + "name": "mounts", + "type": "[]string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "User", + "capabilityId": "Aspire.Hosting/user", + "qualifiedName": "user", + "description": "Adds a USER statement to a Dockerfile stage", + "kind": "Method", + "signature": "User(user string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "user", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + }, + { + "name": "WorkDir", + "capabilityId": "Aspire.Hosting/workDir", + "qualifiedName": "workDir", + "description": "Adds a WORKDIR statement to a Dockerfile stage", + "kind": "Method", + "signature": "WorkDir(path string) DockerfileStage", + "receiver": "DockerfileStage", + "parameters": [ + { + "name": "path", + "type": "string" + } + ], + "returnType": "DockerfileStage", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.Docker.DockerfileStage", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.Docker.DockerfileStage" + ], + "appliesTo": [ + "DockerfileStage" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerfileBuilderCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "kind": "handle", + "description": "Provides context information for Dockerfile build callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Builder", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.builder", + "qualifiedName": "DockerfileBuilderCallbackContext.builder", + "description": "Gets the Dockerfile builder instance.", + "kind": "PropertyGetter", + "signature": "Builder() DockerfileBuilder", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "DockerfileBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.cancellationToken", + "qualifiedName": "DockerfileBuilderCallbackContext.cancellationToken", + "description": "Gets the cancellation token to observe while waiting for the task to complete.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.resource", + "qualifiedName": "DockerfileBuilderCallbackContext.resource", + "description": "Gets the resource being built.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileBuilderCallbackContext.services", + "qualifiedName": "DockerfileBuilderCallbackContext.services", + "description": "Gets the service provider for dependency injection.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "DockerfileBuilderCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileBuilderCallbackContext" + ], + "appliesTo": [ + "DockerfileBuilderCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerfileFactoryContext", + "fullName": "Aspire.Hosting.ApplicationModel.DockerfileFactoryContext", + "kind": "handle", + "description": "Provides context for Dockerfile factory functions.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/DockerfileFactoryContext.resource", + "qualifiedName": "DockerfileFactoryContext.resource", + "description": "Gets the resource for which the Dockerfile is being generated. This allows factory functions to query resource annotations and properties to customize the generated Dockerfile. ``` var containerAnnotation = context.Resource.Annotations.OfType().FirstOrDefault(); var baseImage = containerAnnotation?.Image ?? \"alpine:latest\"; ```", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "DockerfileFactoryContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DockerfileFactoryContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DockerfileFactoryContext" + ], + "appliesTo": [ + "DockerfileFactoryContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DotnetToolResource", + "fullName": "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithToolIgnoreExistingFeeds", + "capabilityId": "Aspire.Hosting/withToolIgnoreExistingFeeds", + "qualifiedName": "withToolIgnoreExistingFeeds", + "description": "Configures the tool to use only the specified package sources, ignoring existing NuGet configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolIgnoreExistingFeeds() DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolIgnoreFailedSources", + "capabilityId": "Aspire.Hosting/withToolIgnoreFailedSources", + "qualifiedName": "withToolIgnoreFailedSources", + "description": "Configures the resource to treat package source failures as warnings.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolIgnoreFailedSources() DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolPackage", + "capabilityId": "Aspire.Hosting/withToolPackage", + "qualifiedName": "withToolPackage", + "description": "Sets the package identifier for the tool configuration associated with the resource builder.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolPackage(packageId string) DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [ + { + "name": "packageId", + "type": "string", + "description": "The package identifier to assign to the tool configuration. Cannot be null." + } + ], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolPrerelease", + "capabilityId": "Aspire.Hosting/withToolPrerelease", + "qualifiedName": "withToolPrerelease", + "description": "Allows prerelease versions of the tool to be used", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolPrerelease() DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolSource", + "capabilityId": "Aspire.Hosting/withToolSource", + "qualifiedName": "withToolSource", + "description": "Adds a NuGet package source for tool acquisition.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolSource(source string) DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source to add." + } + ], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + }, + { + "name": "WithToolVersion", + "capabilityId": "Aspire.Hosting/withToolVersion", + "qualifiedName": "withToolVersion", + "description": "Sets the package version for a tool to use.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithToolVersion(version string) DotnetToolResource", + "receiver": "DotnetToolResource", + "parameters": [ + { + "name": "version", + "type": "string", + "description": "The package version to use" + } + ], + "returnType": "DotnetToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.DotnetToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "EndpointReference", + "fullName": "Aspire.Hosting.ApplicationModel.EndpointReference", + "kind": "handle", + "description": "Represents an endpoint reference for a resource with endpoints.", + "implementedInterfaces": [ + "ExpressionValue" + ], + "capabilities": [ + { + "name": "EndpointName", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.endpointName", + "qualifiedName": "EndpointReference.endpointName", + "description": "Gets the name of the endpoint associated with the endpoint reference.", + "kind": "PropertyGetter", + "signature": "EndpointName() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "ErrorMessage", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.errorMessage", + "qualifiedName": "EndpointReference.errorMessage", + "description": "Gets or sets a custom error message to be thrown when the endpoint annotation is not found.", + "kind": "PropertyGetter", + "signature": "ErrorMessage() (*string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "ExcludeReferenceEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.excludeReferenceEndpoint", + "qualifiedName": "EndpointReference.excludeReferenceEndpoint", + "description": "Gets a value indicating whether this endpoint is excluded from the default set when referencing the resource's endpoints.", + "remarks": "Returns `false` if the endpoint annotation has not been added to the resource yet.\nOnce the annotation exists, this property delegates to `ExcludeReferenceEndpoint`.", + "kind": "PropertyGetter", + "signature": "ExcludeReferenceEndpoint() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Exists", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.exists", + "qualifiedName": "EndpointReference.exists", + "description": "Gets a value indicating whether the endpoint exists.", + "kind": "PropertyGetter", + "signature": "Exists() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "GetTlsValue", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.getTlsValue", + "qualifiedName": "EndpointReference.getTlsValue", + "description": "Gets a conditional expression that resolves to the enabledValue when TLS is enabled on the endpoint, or to the disabledValue otherwise.", + "remarks": "The returned expression evaluates the TLS state lazily each time its value is resolved, making it\nsafe to embed in a `ReferenceExpression` that is built before TLS is configured\n(e.g., before `BeforeStartEvent` fires). Because the condition and branches are declarative,\npolyglot code generators can translate this into native conditional constructs in any target language.", + "returns": "A conditional `ReferenceExpression` whose value tracks the TLS state of this endpoint.", + "kind": "InstanceMethod", + "signature": "GetTlsValue(enabledValue *ReferenceExpression, disabledValue *ReferenceExpression) *ReferenceExpression", + "receiver": "EndpointReference", + "parameters": [ + { + "name": "enabledValue", + "type": "*ReferenceExpression", + "description": "The expression to evaluate when TLS is enabled (e.g., `\",ssl=true\"`)." + }, + { + "name": "disabledValue", + "type": "*ReferenceExpression", + "description": "The expression to evaluate when TLS is not enabled." + } + ], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "GetValueAsync", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.getValueAsync", + "qualifiedName": "EndpointReference.getValueAsync", + "description": "Gets the URL of the endpoint asynchronously. Waits for the endpoint to be allocated if necessary.", + "returns": "The URL of the endpoint.", + "kind": "InstanceMethod", + "signature": "GetValueAsync(options ...*GetValueAsyncOptions) (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "options": { + "typeName": "GetValueAsyncOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The cancellation token." + } + ] + }, + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Host", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.host", + "qualifiedName": "EndpointReference.host", + "description": "Gets the host for this endpoint.", + "kind": "PropertyGetter", + "signature": "Host() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsAllocated", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isAllocated", + "qualifiedName": "EndpointReference.isAllocated", + "description": "Gets a value indicating whether the endpoint is allocated.", + "kind": "PropertyGetter", + "signature": "IsAllocated() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsHttp", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isHttp", + "qualifiedName": "EndpointReference.isHttp", + "description": "Gets a value indicating whether the endpoint uses HTTP scheme.", + "kind": "PropertyGetter", + "signature": "IsHttp() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsHttpSchemeNamedEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isHttpSchemeNamedEndpoint", + "qualifiedName": "EndpointReference.isHttpSchemeNamedEndpoint", + "description": "Gets a value indicating whether the endpoint name is \"http\" or \"https\", ignoring case. This is a convention used to identify endpoints that will be resolved based on the scheme of the endpoint in service discovery rather than by the specific endpoint name. This is done to allow http endpoints that are dynamically updated to https to be mapped correctly despite the endpoint name no longer matching the scheme.", + "kind": "PropertyGetter", + "signature": "IsHttpSchemeNamedEndpoint() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "IsHttps", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.isHttps", + "qualifiedName": "EndpointReference.isHttps", + "description": "Gets a value indicating whether the endpoint uses HTTPS scheme.", + "kind": "PropertyGetter", + "signature": "IsHttps() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.port", + "qualifiedName": "EndpointReference.port", + "description": "Gets the port for this endpoint.", + "kind": "PropertyGetter", + "signature": "Port() (float64, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Property", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.property", + "qualifiedName": "EndpointReference.property", + "description": "Gets the specified property expression of the endpoint.", + "returns": "An `EndpointReferenceExpression` representing the specified `EndpointProperty`.", + "kind": "InstanceMethod", + "signature": "Property(property EndpointProperty) EndpointReferenceExpression", + "receiver": "EndpointReference", + "parameters": [ + { + "name": "property", + "type": "EndpointProperty", + "description": "The `EndpointProperty` enum value to use in the reference." + } + ], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.resource", + "qualifiedName": "EndpointReference.resource", + "description": "Gets the resource owner of the endpoint reference.", + "kind": "PropertyGetter", + "signature": "Resource() ResourceWithEndpoints", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "ResourceWithEndpoints", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Scheme", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.scheme", + "qualifiedName": "EndpointReference.scheme", + "description": "Gets the scheme for this endpoint.", + "kind": "PropertyGetter", + "signature": "Scheme() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "TargetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.targetPort", + "qualifiedName": "EndpointReference.targetPort", + "description": "Gets the target port for this endpoint. If the port is dynamically allocated, this will return `null`.", + "kind": "PropertyGetter", + "signature": "TargetPort() (*float64, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "TlsEnabled", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.tlsEnabled", + "qualifiedName": "EndpointReference.tlsEnabled", + "description": "Gets a value indicating whether TLS is enabled for this endpoint.", + "remarks": "Returns `false` if the endpoint annotation has not been added to the resource yet.\nOnce the annotation exists, this property delegates to `TlsEnabled`.", + "kind": "PropertyGetter", + "signature": "TlsEnabled() (bool, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + }, + { + "name": "Url", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReference.url", + "qualifiedName": "EndpointReference.url", + "description": "Gets the URL for this endpoint.", + "kind": "PropertyGetter", + "signature": "Url() (string, error)", + "receiver": "EndpointReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReference", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReference" + ], + "appliesTo": [ + "EndpointReference" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "EndpointReferenceExpression", + "fullName": "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "kind": "handle", + "description": "Represents a property expression for an endpoint reference.", + "implementedInterfaces": [ + "ExpressionValue" + ], + "capabilities": [ + { + "name": "Endpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReferenceExpression.endpoint", + "qualifiedName": "EndpointReferenceExpression.endpoint", + "description": "Gets the `EndpointReference`.", + "kind": "PropertyGetter", + "signature": "Endpoint() EndpointReference", + "receiver": "EndpointReferenceExpression", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression" + ], + "appliesTo": [ + "EndpointReferenceExpression" + ] + }, + { + "name": "Property", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReferenceExpression.property", + "qualifiedName": "EndpointReferenceExpression.property", + "description": "Gets the `EndpointProperty` for the property expression.", + "kind": "PropertyGetter", + "signature": "Property() (EndpointProperty, error)", + "receiver": "EndpointReferenceExpression", + "parameters": [], + "returnType": "(EndpointProperty, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression" + ], + "appliesTo": [ + "EndpointReferenceExpression" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointReferenceExpression.valueExpression", + "qualifiedName": "EndpointReferenceExpression.valueExpression", + "description": "Gets the expression of the property of the endpoint.", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "EndpointReferenceExpression", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointReferenceExpression", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointReferenceExpression" + ], + "appliesTo": [ + "EndpointReferenceExpression" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "EndpointUpdateContext", + "fullName": "Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "kind": "handle", + "description": "Provides a mutable callback context for updating an endpoint in polyglot AppHosts.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ExcludeReferenceEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.excludeReferenceEndpoint", + "qualifiedName": "EndpointUpdateContext.excludeReferenceEndpoint", + "description": "Gets or sets a value indicating whether the endpoint is excluded from the default reference set.", + "kind": "PropertyGetter", + "signature": "ExcludeReferenceEndpoint() (bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "IsExternal", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.isExternal", + "qualifiedName": "EndpointUpdateContext.isExternal", + "description": "Gets or sets a value indicating whether the endpoint is external.", + "kind": "PropertyGetter", + "signature": "IsExternal() (bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "IsProxied", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.isProxied", + "qualifiedName": "EndpointUpdateContext.isProxied", + "description": "Gets or sets a value indicating whether the endpoint is proxied.", + "kind": "PropertyGetter", + "signature": "IsProxied() (*bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.name", + "qualifiedName": "EndpointUpdateContext.name", + "description": "Gets the endpoint name.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.port", + "qualifiedName": "EndpointUpdateContext.port", + "description": "Gets or sets the desired host port.", + "kind": "PropertyGetter", + "signature": "Port() (*float64, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Protocol", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.protocol", + "qualifiedName": "EndpointUpdateContext.protocol", + "description": "Gets or sets the network protocol.", + "kind": "PropertyGetter", + "signature": "Protocol() (ProtocolType, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(ProtocolType, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetExcludeReferenceEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setExcludeReferenceEndpoint", + "qualifiedName": "EndpointUpdateContext.setExcludeReferenceEndpoint", + "description": "Gets or sets a value indicating whether the endpoint is excluded from the default reference set.", + "kind": "PropertySetter", + "signature": "SetExcludeReferenceEndpoint(value bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets a value indicating whether the endpoint is excluded from the default reference set." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetIsExternal", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setIsExternal", + "qualifiedName": "EndpointUpdateContext.setIsExternal", + "description": "Gets or sets a value indicating whether the endpoint is external.", + "kind": "PropertySetter", + "signature": "SetIsExternal(value bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets a value indicating whether the endpoint is external." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetIsProxied", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setIsProxied", + "qualifiedName": "EndpointUpdateContext.setIsProxied", + "description": "Gets or sets a value indicating whether the endpoint is proxied.", + "kind": "PropertySetter", + "signature": "SetIsProxied(value *bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Gets or sets a value indicating whether the endpoint is proxied." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setPort", + "qualifiedName": "EndpointUpdateContext.setPort", + "description": "Gets or sets the desired host port.", + "kind": "PropertySetter", + "signature": "SetPort(value *float64) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the desired host port." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetProtocol", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setProtocol", + "qualifiedName": "EndpointUpdateContext.setProtocol", + "description": "Gets or sets the network protocol.", + "kind": "PropertySetter", + "signature": "SetProtocol(value ProtocolType) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "ProtocolType", + "description": "Gets or sets the network protocol." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTargetHost", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTargetHost", + "qualifiedName": "EndpointUpdateContext.setTargetHost", + "description": "Gets or sets the target host.", + "kind": "PropertySetter", + "signature": "SetTargetHost(value string) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the target host." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTargetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTargetPort", + "qualifiedName": "EndpointUpdateContext.setTargetPort", + "description": "Gets or sets the target port.", + "kind": "PropertySetter", + "signature": "SetTargetPort(value *float64) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the target port." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTlsEnabled", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTlsEnabled", + "qualifiedName": "EndpointUpdateContext.setTlsEnabled", + "description": "Gets or sets a value indicating whether TLS is enabled.", + "kind": "PropertySetter", + "signature": "SetTlsEnabled(value bool) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets a value indicating whether TLS is enabled." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetTransport", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setTransport", + "qualifiedName": "EndpointUpdateContext.setTransport", + "description": "Gets or sets the transport.", + "kind": "PropertySetter", + "signature": "SetTransport(value string) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the transport." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "SetUriScheme", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.setUriScheme", + "qualifiedName": "EndpointUpdateContext.setUriScheme", + "description": "Gets or sets the URI scheme.", + "kind": "PropertySetter", + "signature": "SetUriScheme(value string) EndpointUpdateContext", + "receiver": "EndpointUpdateContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the URI scheme." + } + ], + "returnType": "EndpointUpdateContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "TargetHost", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.targetHost", + "qualifiedName": "EndpointUpdateContext.targetHost", + "description": "Gets or sets the target host.", + "kind": "PropertyGetter", + "signature": "TargetHost() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "TargetPort", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.targetPort", + "qualifiedName": "EndpointUpdateContext.targetPort", + "description": "Gets or sets the target port.", + "kind": "PropertyGetter", + "signature": "TargetPort() (*float64, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "TlsEnabled", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.tlsEnabled", + "qualifiedName": "EndpointUpdateContext.tlsEnabled", + "description": "Gets or sets a value indicating whether TLS is enabled.", + "kind": "PropertyGetter", + "signature": "TlsEnabled() (bool, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "Transport", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.transport", + "qualifiedName": "EndpointUpdateContext.transport", + "description": "Gets or sets the transport.", + "kind": "PropertyGetter", + "signature": "Transport() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + }, + { + "name": "UriScheme", + "capabilityId": "Aspire.Hosting.ApplicationModel/EndpointUpdateContext.uriScheme", + "qualifiedName": "EndpointUpdateContext.uriScheme", + "description": "Gets or sets the URI scheme.", + "kind": "PropertyGetter", + "signature": "UriScheme() (string, error)", + "receiver": "EndpointUpdateContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EndpointUpdateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EndpointUpdateContext" + ], + "appliesTo": [ + "EndpointUpdateContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "EnvironmentCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "kind": "handle", + "description": "Represents a callback context for environment variables associated with a publisher.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Environment", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.environment", + "qualifiedName": "EnvironmentCallbackContext.environment", + "description": "Gets the editor used to set environment variables in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Environment() EnvironmentEditor", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "EnvironmentEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.executionContext", + "qualifiedName": "EnvironmentCallbackContext.executionContext", + "description": "Gets the execution context associated with this invocation of the AppHost.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.log", + "qualifiedName": "EnvironmentCallbackContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/EnvironmentCallbackContext.resource", + "qualifiedName": "EnvironmentCallbackContext.resource", + "description": "The resource associated with this callback context.", + "remarks": "This will be set to the resource in all cases where Aspire invokes the callback.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "EnvironmentCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentCallbackContext" + ], + "appliesTo": [ + "EnvironmentCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "EnvironmentEditor", + "fullName": "Aspire.Hosting.ApplicationModel.EnvironmentEditor", + "kind": "handle", + "description": "Provides an ATS-first editor for environment variables within polyglot callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Set", + "capabilityId": "Aspire.Hosting.ApplicationModel/set", + "qualifiedName": "EnvironmentEditor.set", + "description": "Sets an environment variable.", + "kind": "InstanceMethod", + "signature": "Set(name string, value any) error", + "receiver": "EnvironmentEditor", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the environment variable." + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression", + "EndpointReference", + "ParameterResource", + "ResourceWithConnectionString", + "ExpressionValue" + ], + "description": "The value to assign to the environment variable." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.EnvironmentEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.EnvironmentEditor" + ], + "appliesTo": [ + "EnvironmentEditor" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ExecutableResource", + "fullName": "Aspire.Hosting.ApplicationModel.ExecutableResource", + "kind": "handle", + "description": "A resource that represents a specified executable process.", + "remarks": "You can run any executable command using its full path.\nAs a security feature, Aspire doesn't run executable unless the command is located in a path listed in the PATH environment variable.\nTo run an executable file that's in the current directory, specify the full path or use the relative path `./` to represent the current directory.", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "PublishAsDockerFile", + "capabilityId": "Aspire.Hosting/publishAsDockerFile", + "qualifiedName": "publishAsDockerFile", + "description": "Publishes an executable as a Docker file", + "remarks": "When the executable resource is converted to a container resource, the arguments to the executable\nare not used. This is because arguments to the executable often contain physical paths that are not valid\nin the container. The container can be set up with the correct arguments using the `configure` action.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsDockerFile(configure func(obj ContainerResource)) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj ContainerResource)", + "isCallback": true, + "callbackSignature": "func(obj ContainerResource)", + "description": "Optional action to configure the container resource" + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "WithExecutableCommand", + "capabilityId": "Aspire.Hosting/withExecutableCommand", + "qualifiedName": "withExecutableCommand", + "description": "Sets the command for the executable resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExecutableCommand(command string) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "command", + "type": "string", + "description": "Command." + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "WithVolume", + "capabilityId": "Aspire.Hosting/withExecutableVolume", + "qualifiedName": "withVolume", + "description": "Adds a volume to an executable resource.", + "returns": "The same executable resource builder handle for chaining.", + "kind": "Method", + "signature": "WithVolume(target string, name string, env string, options ...*ExecutableResourceWithVolumeOptions) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "target", + "type": "string", + "description": "The mount path inside the published container." + }, + { + "name": "name", + "type": "string", + "description": "The volume name." + }, + { + "name": "env", + "type": "string", + "description": "The environment variable that receives the effective volume path." + } + ], + "options": { + "typeName": "ExecutableResourceWithVolumeOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "Whether the published volume is read-only." + } + ] + }, + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "WithWorkingDirectory", + "capabilityId": "Aspire.Hosting/withWorkingDirectory", + "qualifiedName": "withWorkingDirectory", + "description": "Sets the working directory for the executable resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWorkingDirectory(workingDirectory string) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "workingDirectory", + "type": "string", + "description": "Working directory." + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ExecuteCommandContext", + "fullName": "Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "kind": "handle", + "description": "Context for {@ats-ref method:ResourceCommandAnnotation.ExecuteCommand}.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Arguments", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.arguments", + "qualifiedName": "ExecuteCommandContext.arguments", + "description": "Gets the invocation arguments supplied by the client when the command is executed.", + "remarks": "The collection contains the arguments described by `Arguments` with their\nsubmitted values populated. CLI positional arguments are mapped by declaration order. Dashboard, MCP, and other\nnamed-payload clients are mapped by `Name`.", + "kind": "PropertyGetter", + "signature": "Arguments() InteractionInputCollection", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.cancellationToken", + "qualifiedName": "ExecuteCommandContext.cancellationToken", + "description": "The cancellation token.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.logger", + "qualifiedName": "ExecuteCommandContext.logger", + "description": "The logger for the resource.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "ResourceName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.resourceName", + "qualifiedName": "ExecuteCommandContext.resourceName", + "description": "The resource name.", + "kind": "PropertyGetter", + "signature": "ResourceName() (string, error)", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ExecuteCommandContext.services", + "qualifiedName": "ExecuteCommandContext.services", + "description": "The service provider.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ExecuteCommandContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecuteCommandContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecuteCommandContext" + ], + "appliesTo": [ + "ExecuteCommandContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "HttpCommandPrepareRequestContext", + "fullName": "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "kind": "handle", + "description": "Provides context for HTTP command prepare-request callbacks in polyglot AppHosts.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Arguments", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.arguments", + "qualifiedName": "HttpCommandPrepareRequestContext.arguments", + "description": "Gets the invocation arguments supplied by the client when the command is executed.", + "kind": "PropertyGetter", + "signature": "Arguments() InteractionInputCollection", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.cancellationToken", + "qualifiedName": "HttpCommandPrepareRequestContext.cancellationToken", + "description": "The cancellation token.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "Endpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.endpoint", + "qualifiedName": "HttpCommandPrepareRequestContext.endpoint", + "description": "The endpoint the request is targeting.", + "kind": "PropertyGetter", + "signature": "Endpoint() EndpointReference", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + }, + { + "name": "ResourceName", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpCommandPrepareRequestContext.resourceName", + "qualifiedName": "HttpCommandPrepareRequestContext.resourceName", + "description": "The name of the resource the command was configured on.", + "kind": "PropertyGetter", + "signature": "ResourceName() (string, error)", + "receiver": "HttpCommandPrepareRequestContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpCommandPrepareRequestContext" + ], + "appliesTo": [ + "HttpCommandPrepareRequestContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "HttpsCertificateConfigurationCallbackAnnotationContext", + "fullName": "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "kind": "handle", + "description": "Context provided to a `HttpsCertificateConfigurationCallbackAnnotation` callback.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Arguments", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.arguments", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.arguments", + "description": "Gets the editor used to manipulate the command-line arguments in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Arguments() CommandLineArgsEditor", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "CommandLineArgsEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.cancellationToken", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.cancellationToken", + "description": "Gets the `CancellationToken` that can be used to cancel the operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CertificatePath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.certificatePath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.certificatePath", + "description": "A value provider that will resolve to a path to the certificate file.", + "kind": "PropertyGetter", + "signature": "CertificatePath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "CertificateWithKeyPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.certificateWithKeyPath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.certificateWithKeyPath", + "description": "A value provider that will resolve to a path to the certificate and key concatenated together in PEM format.", + "kind": "PropertyGetter", + "signature": "CertificateWithKeyPath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.environment", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.environment", + "description": "Gets the editor used to set environment variables in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Environment() EnvironmentEditor", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "EnvironmentEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.executionContext", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.executionContext", + "description": "Gets the `DistributedApplicationExecutionContext` for this session.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "KeyPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.keyPath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.keyPath", + "description": "A value provider that will resolve to a path to the private key for the certificate.", + "kind": "PropertyGetter", + "signature": "KeyPath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "PfxPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.pfxPath", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.pfxPath", + "description": "A value provider that will resolve to a path to a PFX file for the key pair.", + "kind": "PropertyGetter", + "signature": "PfxPath() *ReferenceExpression", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsCertificateConfigurationCallbackAnnotationContext.resource", + "qualifiedName": "HttpsCertificateConfigurationCallbackAnnotationContext.resource", + "description": "Gets the resource to which the annotation is applied.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "HttpsCertificateConfigurationCallbackAnnotationContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsCertificateConfigurationCallbackAnnotationContext" + ], + "appliesTo": [ + "HttpsCertificateConfigurationCallbackAnnotationContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "HttpsEndpointUpdateCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "kind": "handle", + "description": "Context provided to the callback of `SubscribeHttpsEndpointsUpdate``1` when an HTTPS certificate is determined to be available for the resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.cancellationToken", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.cancellationToken", + "description": "Gets the `CancellationToken` for the operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.model", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.model", + "description": "Gets the `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.resource", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.resource", + "description": "Gets the `IResource` that is being configured for HTTPS.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/HttpsEndpointUpdateCallbackContext.services", + "qualifiedName": "HttpsEndpointUpdateCallbackContext.services", + "description": "Gets the `IServiceProvider` instance from the application.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "HttpsEndpointUpdateCallbackContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.HttpsEndpointUpdateCallbackContext" + ], + "appliesTo": [ + "HttpsEndpointUpdateCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AspireStore", + "fullName": "Aspire.Hosting.ApplicationModel.IAspireStore", + "kind": "handle", + "isInterface": true, + "description": "Represents a store for managing files in the Aspire hosting environment that can be reused across runs.", + "remarks": "The store is created under the AppHost obj folder, or under the path specified by the\nASPIRE__STORE__PATH environment variable. Each application gets its own store so files\ndo not conflict with unrelated applications.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "BasePath", + "capabilityId": "Aspire.Hosting.ApplicationModel/IAspireStore.basePath", + "qualifiedName": "IAspireStore.basePath", + "description": "Gets the base path of this store.", + "kind": "PropertyGetter", + "signature": "BasePath() (string, error)", + "receiver": "AspireStore", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IAspireStore", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IAspireStore" + ], + "appliesTo": [ + "AspireStore" + ] + }, + { + "name": "GetFileNameWithContent", + "capabilityId": "Aspire.Hosting/getFileNameWithContent", + "qualifiedName": "getFileNameWithContent", + "description": "Gets a deterministic file path that is a copy of the `sourceFilename`. The resulting file name will depend on the content of the file.", + "returns": "A deterministic file path with the same content as `sourceFilename`.", + "kind": "Method", + "signature": "GetFileNameWithContent(filenameTemplate string, sourceFilename string) (string, error)", + "receiver": "AspireStore", + "parameters": [ + { + "name": "filenameTemplate", + "type": "string", + "description": "A file name to base the result on." + }, + { + "name": "sourceFilename", + "type": "string", + "description": "An existing file." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IAspireStore", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IAspireStore" + ], + "appliesTo": [ + "AspireStore" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ComputeEnvironmentResource", + "fullName": "Aspire.Hosting.ApplicationModel.IComputeEnvironmentResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "IComputeResource", + "fullName": "Aspire.Hosting.ApplicationModel.IComputeResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithComputeEnvironment", + "capabilityId": "Aspire.Hosting/withComputeEnvironment", + "qualifiedName": "withComputeEnvironment", + "description": "Configures the compute environment for the compute resource.", + "remarks": "This method allows associating a specific compute environment with the compute resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithComputeEnvironment(computeEnvironmentResource ComputeEnvironmentResource) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "computeEnvironmentResource", + "type": "ComputeEnvironmentResource", + "description": "The compute environment resource to associate with the compute resource." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithImagePushOptions", + "capabilityId": "Aspire.Hosting/withImagePushOptions", + "qualifiedName": "withImagePushOptions", + "description": "Adds an asynchronous callback to configure container image push options for the resource.", + "remarks": "This method allows customization of how container images are named and tagged when pushed to a registry using an asynchronous callback.\nUse this overload when the callback needs to perform asynchronous operations such as retrieving configuration values from external sources.\nThe callback receives a `ContainerImagePushOptionsCallbackContext` that provides access to the resource\nand the `ContainerImagePushOptions` that can be modified.\nMultiple callbacks can be registered on the same resource, and they will be invoked in the order they were added.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithImagePushOptions(callback func(arg ContainerImagePushOptionsCallbackContext)) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ContainerImagePushOptionsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg ContainerImagePushOptionsCallbackContext)", + "description": "The asynchronous callback to configure push options." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithRemoteImageName", + "capabilityId": "Aspire.Hosting/withRemoteImageName", + "qualifiedName": "withRemoteImageName", + "description": "Sets the remote image name (without registry endpoint or tag) for container push operations.", + "remarks": "Use this with `withRemoteImageTag` to fully customize the image reference used for container push operations.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRemoteImageName(remoteImageName string) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "remoteImageName", + "type": "string", + "description": "The remote image name (e.g., \"myapp\" or \"myorg/myapp\")." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithRemoteImageTag", + "capabilityId": "Aspire.Hosting/withRemoteImageTag", + "qualifiedName": "withRemoteImageTag", + "description": "Sets the remote image tag for container push operations.", + "remarks": "Use this with `withRemoteImageName` to fully customize the image reference used for container push operations.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRemoteImageTag(remoteImageTag string) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "remoteImageTag", + "type": "string", + "description": "The remote image tag (e.g., \"latest\", \"v1.0.0\")." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "IContainerFilesDestinationResource", + "fullName": "Aspire.Hosting.ApplicationModel.IContainerFilesDestinationResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "PublishWithContainerFiles", + "capabilityId": "Aspire.Hosting/publishWithContainerFilesFromResource", + "qualifiedName": "publishWithContainerFiles", + "description": "Configures the resource to copy container files from the specified source resource during publishing.", + "kind": "Method", + "signature": "PublishWithContainerFiles(source ResourceWithContainerFiles, destinationPath string) IContainerFilesDestinationResource", + "receiver": "IContainerFilesDestinationResource", + "parameters": [ + { + "name": "source", + "type": "ResourceWithContainerFiles", + "description": "The resource which contains the container files to be copied." + }, + { + "name": "destinationPath", + "type": "string", + "description": "The destination path within the resource's container where the files will be copied." + } + ], + "returnType": "IContainerFilesDestinationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IContainerFilesDestinationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DotnetProgramResource", + "fullName": "Aspire.Hosting.ApplicationModel.IDotnetProgramResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource backed by a .NET program, such as a project file or a file-based app.", + "remarks": "This interface identifies the source-program model shared by legacy `ProjectResource` instances\nand language integrations such as `Aspire.Hosting.Dotnet`. Implementing this interface does not by itself\nenable SDK container publishing; use the publishing configuration supplied by the resource's builder API.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ExecutionConfigurationBuilder", + "fullName": "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "kind": "handle", + "isInterface": true, + "description": "Builder for gathering and resolving the execution configuration (arguments and environment variables) for a specific resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Build", + "capabilityId": "Aspire.Hosting/buildExecutionConfiguration", + "qualifiedName": "build", + "description": "Builds the execution configuration for the specified builder.", + "returns": "The resolved execution configuration.", + "kind": "Method", + "signature": "Build(executionContext DistributedApplicationExecutionContext, options ...*BuildOptions) ExecutionConfigurationResult", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [ + { + "name": "executionContext", + "type": "DistributedApplicationExecutionContext", + "description": "The execution context used while building the configuration." + } + ], + "options": { + "typeName": "BuildOptions", + "fields": [ + { + "name": "ResourceLogger", + "jsonName": "resourceLogger", + "type": "*Logger", + "description": "The logger used while resolving values." + }, + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "A cancellation token." + } + ] + }, + "returnType": "ExecutionConfigurationResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithArgumentsConfig", + "capabilityId": "Aspire.Hosting/withArgumentsConfig", + "qualifiedName": "withArgumentsConfig", + "description": "Adds a command line arguments configuration gatherer to the builder.", + "returns": "The builder with the configuration gatherer added.", + "kind": "Method", + "signature": "WithArgumentsConfig() ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithCertificateTrustConfig", + "capabilityId": "Aspire.Hosting/withCertificateTrustConfig", + "qualifiedName": "withCertificateTrustConfig", + "description": "Adds a certificate trust configuration gatherer to the builder.", + "returns": "The builder with the configuration gatherer added.", + "kind": "Method", + "signature": "WithCertificateTrustConfig(configContextFactory func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext) ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [ + { + "name": "configContextFactory", + "type": "func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext", + "isCallback": true, + "callbackSignature": "func(arg CertificateTrustScope) *CertificateTrustExecutionConfigurationContext", + "description": "A factory function to create the configuration context." + } + ], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithEnvironmentVariablesConfig", + "capabilityId": "Aspire.Hosting/withEnvironmentVariablesConfig", + "qualifiedName": "withEnvironmentVariablesConfig", + "description": "Adds an environment variables configuration gatherer to the builder.", + "returns": "The builder with the configuration gatherer added.", + "kind": "Method", + "signature": "WithEnvironmentVariablesConfig() ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + }, + { + "name": "WithHttpsCertificateConfig", + "capabilityId": "Aspire.Hosting/withHttpsCertificateConfigExport", + "qualifiedName": "withHttpsCertificateConfig", + "description": "Adds an HTTPS certificate configuration gatherer using certificate metadata instead of a raw X509 certificate.", + "returns": "The execution configuration builder.", + "kind": "Method", + "signature": "WithHttpsCertificateConfig(configContextFactory func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext) ExecutionConfigurationBuilder", + "receiver": "ExecutionConfigurationBuilder", + "parameters": [ + { + "name": "configContextFactory", + "type": "func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext", + "isCallback": true, + "callbackSignature": "func(arg *HttpsCertificateInfo) *HttpsCertificateExecutionConfigurationContext", + "description": "The factory that creates the HTTPS certificate configuration context." + } + ], + "returnType": "ExecutionConfigurationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationBuilder" + ], + "appliesTo": [ + "ExecutionConfigurationBuilder" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ExecutionConfigurationResult", + "fullName": "Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult", + "kind": "handle", + "isInterface": true, + "description": "Configuration (arguments and environment variables) to apply to a specific resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "GetCertificateTrustData", + "capabilityId": "Aspire.Hosting/getCertificateTrustData", + "qualifiedName": "getCertificateTrustData", + "description": "Gets certificate trust execution-configuration data when present.", + "returns": "The certificate trust data. When no additional data is present, an empty DTO is returned.", + "kind": "Method", + "signature": "GetCertificateTrustData() (*CertificateTrustExecutionConfigurationExportData, error)", + "receiver": "ExecutionConfigurationResult", + "parameters": [], + "returnType": "(*CertificateTrustExecutionConfigurationExportData, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult" + ], + "appliesTo": [ + "ExecutionConfigurationResult" + ] + }, + { + "name": "GetHttpsCertificateData", + "capabilityId": "Aspire.Hosting/getHttpsCertificateData", + "qualifiedName": "getHttpsCertificateData", + "description": "Gets HTTPS certificate execution-configuration data when present.", + "returns": "The HTTPS certificate data. When no additional data is present, an empty DTO is returned.", + "kind": "Method", + "signature": "GetHttpsCertificateData() (*HttpsCertificateExecutionConfigurationExportData, error)", + "receiver": "ExecutionConfigurationResult", + "parameters": [], + "returnType": "(*HttpsCertificateExecutionConfigurationExportData, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IExecutionConfigurationResult" + ], + "appliesTo": [ + "ExecutionConfigurationResult" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ExpressionValue", + "fullName": "Aspire.Hosting.ApplicationModel.IExpressionValue", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a value that provides both a runtime value and a manifest expression.", + "remarks": "Expression values can be used anywhere both a runtime value and a publish-time\nmanifest expression are needed.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "Resource", + "fullName": "Aspire.Hosting.ApplicationModel.IResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that can be hosted by an application.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CreateExecutionConfiguration", + "capabilityId": "Aspire.Hosting/createExecutionConfiguration", + "qualifiedName": "createExecutionConfiguration", + "description": "Creates an execution configuration builder for the specified resource.", + "returns": "The execution configuration builder.", + "kind": "Method", + "signature": "CreateExecutionConfiguration() ExecutionConfigurationBuilder", + "receiver": "Resource", + "parameters": [], + "returnType": "ExecutionConfigurationBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "ExcludeFromManifest", + "capabilityId": "Aspire.Hosting/excludeFromManifest", + "qualifiedName": "excludeFromManifest", + "description": "Excludes a resource from being published to the manifest.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ExcludeFromManifest() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "ExcludeFromMcp", + "capabilityId": "Aspire.Hosting/excludeFromMcp", + "qualifiedName": "excludeFromMcp", + "description": "Exclude the resource from MCP operations using the Aspire MCP server. The resource is excluded from results that return resources, console logs and telemetry.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ExcludeFromMcp() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "GetResourceName", + "capabilityId": "Aspire.Hosting/getResourceName", + "qualifiedName": "getResourceName", + "description": "Gets the name of the resource from a builder.", + "remarks": "Why this wrapper exists: This capability accesses a nested property\n(`resource.Resource.Name`) which requires a wrapper method. There is no single\n.NET method that returns just the resource name that could be annotated directly.", + "returns": "The resource name.", + "kind": "Method", + "signature": "GetResourceName() (string, error)", + "receiver": "Resource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnBeforeResourceStarted", + "capabilityId": "Aspire.Hosting/onBeforeResourceStarted", + "qualifiedName": "onBeforeResourceStarted", + "description": "Subscribes to the BeforeResourceStarted event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnBeforeResourceStarted(callback func(arg BeforeResourceStartedEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforeResourceStartedEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforeResourceStartedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnInitializeResource", + "capabilityId": "Aspire.Hosting/onInitializeResource", + "qualifiedName": "onInitializeResource", + "description": "Subscribes to the InitializeResource event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnInitializeResource(callback func(arg InitializeResourceEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg InitializeResourceEvent)", + "isCallback": true, + "callbackSignature": "func(arg InitializeResourceEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnResourceReady", + "capabilityId": "Aspire.Hosting/onResourceReady", + "qualifiedName": "onResourceReady", + "description": "Subscribes to the ResourceReady event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnResourceReady(callback func(arg ResourceReadyEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ResourceReadyEvent)", + "isCallback": true, + "callbackSignature": "func(arg ResourceReadyEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "OnResourceStopped", + "capabilityId": "Aspire.Hosting/onResourceStopped", + "qualifiedName": "onResourceStopped", + "description": "Subscribes to the ResourceStopped event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnResourceStopped(callback func(arg ResourceStoppedEvent)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ResourceStoppedEvent)", + "isCallback": true, + "callbackSignature": "func(arg ResourceStoppedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "SubscribeHttpsEndpointsUpdate", + "capabilityId": "Aspire.Hosting/subscribeHttpsEndpointsUpdate", + "qualifiedName": "subscribeHttpsEndpointsUpdate", + "description": "Subscribes to the `BeforeStartEvent` and invokes the specified callback when an HTTPS certificate is determined to be available for the resource. This is used to conditionally update endpoint URI schemes or perform other HTTPS-related configuration at startup.", + "remarks": "The callback is invoked when either:\n-\n-\nSwitch an endpoint to HTTPS when a certificate is available:\n```\nbuilder.SubscribeHttpsEndpointsUpdate(ctx =>\n{\nbuilder.WithEndpoint(\"http\", ep => ep.UriScheme = \"https\");\n});\n```", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "SubscribeHttpsEndpointsUpdate(callback func(obj HttpsEndpointUpdateCallbackContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(obj HttpsEndpointUpdateCallbackContext)", + "isCallback": true, + "callbackSignature": "func(obj HttpsEndpointUpdateCallbackContext)", + "description": "The callback to invoke when HTTPS is enabled. Receives an `HttpsEndpointUpdateCallbackContext` providing access to the service provider, resource, and application model." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithChildRelationship", + "capabilityId": "Aspire.Hosting/withBuilderChildRelationship", + "qualifiedName": "withChildRelationship", + "description": "Sets a child relationship", + "returns": "A resource builder.", + "kind": "Method", + "signature": "WithChildRelationship(child Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "child", + "type": "Resource", + "description": "The child of `builder`." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithCommand", + "capabilityId": "Aspire.Hosting/withCommand", + "qualifiedName": "withCommand", + "description": "Adds a resource command", + "remarks": "The `WithCommand` method is used to add commands to the resource. Commands are displayed in the dashboard\nand can be executed by a user using the dashboard UI.\nWhen a command is executed, the `executeCommand` callback is called and is run inside the Aspire host.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCommand(name string, displayName string, executeCommand func(arg ExecuteCommandContext) *ExecuteCommandResult, options ...*WithCommandOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the command. The name uniquely identifies the command." + }, + { + "name": "displayName", + "type": "string", + "description": "The display name visible in UI." + }, + { + "name": "executeCommand", + "type": "func(arg ExecuteCommandContext) *ExecuteCommandResult", + "isCallback": true, + "callbackSignature": "func(arg ExecuteCommandContext) *ExecuteCommandResult", + "description": "A callback that is executed when the command is executed. The callback is run inside the Aspire host. The callback result is used to indicate success or failure in the UI." + } + ], + "options": { + "typeName": "WithCommandOptions", + "fields": [ + { + "name": "CommandOptions", + "jsonName": "commandOptions", + "type": "*CommandOptions", + "description": "Optional configuration for the command." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithContainerBuildOptions", + "capabilityId": "Aspire.Hosting/withContainerBuildOptions", + "qualifiedName": "withContainerBuildOptions", + "description": "Configures container build options for a compute resource using an async callback.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithContainerBuildOptions(callback func(arg ContainerBuildOptionsCallbackContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(arg ContainerBuildOptionsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg ContainerBuildOptionsCallbackContext)", + "description": "An async callback to configure container build options." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithContainerRegistry", + "capabilityId": "Aspire.Hosting/withContainerRegistry", + "qualifiedName": "withContainerRegistry", + "description": "Configures the resource to use the specified container registry for container image operations.", + "remarks": "This method adds a `ContainerRegistryReferenceAnnotation` to the resource,\nindicating that the resource should use the specified container registry for container image operations.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithContainerRegistry(registry Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "registry", + "type": "Resource", + "description": "The container registry resource builder." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithDockerfileBaseImage", + "capabilityId": "Aspire.Hosting/withDockerfileBaseImage", + "qualifiedName": "withDockerfileBaseImage", + "description": "Configures custom base images for generated Dockerfiles.", + "remarks": "This extension method allows customization of the base images used in generated Dockerfiles.\nFor multi-stage Dockerfiles (e.g., Python with UV), you can specify separate build and runtime images.\nSpecify custom base images for a Python application:\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddPythonApp(\"myapp\", \"path/to/app\", \"main.py\")\n.WithDockerfileBaseImage(\nbuildImage: \"ghcr.io/astral-sh/uv:python3.12-bookworm-slim\",\nruntimeImage: \"python:3.12-slim-bookworm\");\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDockerfileBaseImage(options ...*WithDockerfileBaseImageOptions) Resource", + "receiver": "Resource", + "parameters": [], + "options": { + "typeName": "WithDockerfileBaseImageOptions", + "fields": [ + { + "name": "BuildImage", + "jsonName": "buildImage", + "type": "*string", + "description": "The base image to use for the build stage. If null, uses the default build image." + }, + { + "name": "RuntimeImage", + "jsonName": "runtimeImage", + "type": "*string", + "description": "The base image to use for the runtime stage. If null, uses the default runtime image." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithExplicitStart", + "capabilityId": "Aspire.Hosting/withExplicitStart", + "qualifiedName": "withExplicitStart", + "description": "Prevents resource from starting automatically", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExplicitStart() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHealthCheck", + "capabilityId": "Aspire.Hosting/withHealthCheck", + "qualifiedName": "withHealthCheck", + "description": "Adds a health check by key", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHealthCheck(key string) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key for the health check." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHidden", + "capabilityId": "Aspire.Hosting/withHidden", + "qualifiedName": "withHidden", + "description": "Hides the resource from default resource lists", + "remarks": "Use this method to hide resources that are implementation details and should never be displayed by default.\nHidden resources can still be accessed directly by their name, by using `Show hidden resources` toggle in the dashboard or by using `aspire describe --include-hidden` from the CLI.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHidden() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHiddenOnCompletion", + "capabilityId": "Aspire.Hosting/withHiddenOnCompletion", + "qualifiedName": "withHiddenOnCompletion", + "description": "Hides the resource from default resource lists after successful completion", + "remarks": "This method is useful for one-off resources such as setup scripts, migrations, or build steps that should remain visible while running\nand then be hidden after successful completion.\nHidden resources can still be accessed directly by their name, by using `Show hidden resources` toggle in the dashboard or by using `aspire describe --include-hidden` from the CLI.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHiddenOnCompletion(options ...*WithHiddenOnCompletionOptions) Resource", + "receiver": "Resource", + "parameters": [], + "options": { + "typeName": "WithHiddenOnCompletionOptions", + "fields": [ + { + "name": "ExitCode", + "jsonName": "exitCode", + "type": "*float64", + "description": "The completion exit code to treat as successful. Defaults to `0`." + }, + { + "name": "ExitCodes", + "jsonName": "exitCodes", + "type": "[]float64", + "description": "Completion exit codes to treat as successful. If no values are provided, `0` is used." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithIconName", + "capabilityId": "Aspire.Hosting/withIconName", + "qualifiedName": "withIconName", + "description": "Specifies the icon to use when displaying the resource in the dashboard.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithIconName(iconName string, options ...*WithIconNameOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "iconName", + "type": "string", + "description": "The name of the FluentUI icon to use. See https://aka.ms/fluentui-system-icons for available icons." + } + ], + "options": { + "typeName": "WithIconNameOptions", + "fields": [ + { + "name": "IconVariant", + "jsonName": "iconVariant", + "type": "*IconVariant", + "description": "The variant of the icon (Regular or Filled). Defaults to Filled." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithLifetimeOf", + "capabilityId": "Aspire.Hosting/withLifetimeOf", + "qualifiedName": "withLifetimeOf", + "description": "Configures a resource to match the lifetime of another resource.", + "remarks": "The resource lifetime is evaluated from `sourceBuilder` when the application model is prepared, so later lifetime\nchanges to the source resource are reflected by this resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLifetimeOf(sourceBuilder Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "sourceBuilder", + "type": "Resource", + "description": "The resource builder whose lifetime should be used." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithParentProcessLifetime", + "capabilityId": "Aspire.Hosting/withParentProcessLifetime", + "qualifiedName": "withParentProcessLifetime", + "description": "Configures a resource to use a persistent lifetime that ends when a parent process exits.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithParentProcessLifetime(parentProcessId float64) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "parentProcessId", + "type": "float64", + "description": "The ID of the parent process to monitor." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithParentRelationship", + "capabilityId": "Aspire.Hosting/withBuilderParentRelationship", + "qualifiedName": "withParentRelationship", + "description": "Sets the parent relationship", + "returns": "A resource builder.", + "kind": "Method", + "signature": "WithParentRelationship(parent Resource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "parent", + "type": "Resource", + "description": "The parent of `builder`." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPersistentLifetime", + "capabilityId": "Aspire.Hosting/withPersistentLifetime", + "qualifiedName": "withPersistentLifetime", + "description": "Configures a resource to use a persistent lifetime.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPersistentLifetime() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPipelineConfiguration", + "capabilityId": "Aspire.Hosting/withPipelineConfiguration", + "qualifiedName": "withPipelineConfiguration", + "description": "Registers a callback to be executed during the pipeline configuration phase, allowing modification of step dependencies and relationships.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithPipelineConfiguration(callback func(obj PipelineConfigurationContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(obj PipelineConfigurationContext)", + "isCallback": true, + "callbackSignature": "func(obj PipelineConfigurationContext)", + "description": "The callback function to execute during the configuration phase." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPipelineStepFactory", + "capabilityId": "Aspire.Hosting/withPipelineStepFactory", + "qualifiedName": "withPipelineStepFactory", + "description": "Adds a pipeline step to the resource that will be executed during deployment.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithPipelineStepFactory(stepName string, callback func(arg PipelineStepContext), options ...*WithPipelineStepFactoryOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The unique name of the pipeline step." + }, + { + "name": "callback", + "type": "func(arg PipelineStepContext)", + "isCallback": true, + "callbackSignature": "func(arg PipelineStepContext)", + "description": "The callback to execute when the step runs." + } + ], + "options": { + "typeName": "WithPipelineStepFactoryOptions", + "fields": [ + { + "name": "DependsOn", + "jsonName": "dependsOn", + "type": "[]string", + "description": "Optional step names that this step depends on." + }, + { + "name": "RequiredBy", + "jsonName": "requiredBy", + "type": "[]string", + "description": "Optional step names that require this step." + }, + { + "name": "Tags", + "jsonName": "tags", + "type": "[]string", + "description": "Optional tags that categorize this step." + }, + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "An optional human-readable description of the step." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithProcessCommand", + "capabilityId": "Aspire.Hosting/withProcessCommand", + "qualifiedName": "withProcessCommand", + "description": "Adds a command to the resource that starts a local process when invoked.", + "kind": "Method", + "signature": "WithProcessCommand(commandName string, displayName string, options *ProcessCommandExportOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "commandName", + "type": "string" + }, + { + "name": "displayName", + "type": "string" + }, + { + "name": "options", + "type": "*ProcessCommandExportOptions" + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithProcessCommandFactory", + "capabilityId": "Aspire.Hosting/withProcessCommandFactory", + "qualifiedName": "withProcessCommandFactory", + "description": "Adds a command to the resource that starts a local process created by a callback when invoked.", + "kind": "Method", + "signature": "WithProcessCommandFactory(commandName string, displayName string, createProcessSpec func(arg ExecuteCommandContext) *ProcessCommandSpecExportData, options ...*ProcessCommandResultExportOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "commandName", + "type": "string" + }, + { + "name": "displayName", + "type": "string" + }, + { + "name": "createProcessSpec", + "type": "func(arg ExecuteCommandContext) *ProcessCommandSpecExportData", + "isCallback": true, + "callbackSignature": "func(arg ExecuteCommandContext) *ProcessCommandSpecExportData" + } + ], + "options": { + "typeName": "ProcessCommandResultExportOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithRelationship", + "capabilityId": "Aspire.Hosting/withBuilderRelationship", + "qualifiedName": "withRelationship", + "description": "Adds a relationship to another resource using its builder.", + "returns": "A resource builder.", + "kind": "Method", + "signature": "WithRelationship(resourceBuilder Resource, type_ string) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "resourceBuilder", + "type": "Resource", + "description": "The resource builder that the relationship is to." + }, + { + "name": "type_", + "type": "string", + "description": "The relationship type." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithRequiredCommand", + "capabilityId": "Aspire.Hosting/withRequiredCommand", + "qualifiedName": "withRequiredCommand", + "description": "Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start.", + "remarks": "The command is considered valid if either:\n1. It is an absolute or relative path (contains a directory separator) that points to an existing file, or\n2. It is discoverable on the current process PATH (respecting PATHEXT on Windows).\nIf the command is not found, a warning message will be logged but the resource will be allowed to attempt to start.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRequiredCommand(command string, options ...*WithRequiredCommandOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "command", + "type": "string", + "description": "The command string (file name or path) that should be validated." + } + ], + "options": { + "typeName": "WithRequiredCommandOptions", + "fields": [ + { + "name": "HelpLink", + "jsonName": "helpLink", + "type": "*string", + "description": "An optional help link URL to guide users when the command is missing." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithRequiredCommandValidation", + "capabilityId": "Aspire.Hosting/withRequiredCommandValidation", + "qualifiedName": "withRequiredCommandValidation", + "description": "Declares that a resource requires a specific command/executable to be available on the local machine PATH before it can start, with custom validation logic.", + "remarks": "The command is first resolved to a full path. If found, the validation callback is invoked with the context containing the resolved path and service provider.\nThe callback should return a `RequiredCommandValidationResult` indicating whether the command is valid,\nwhich can be created via `Success` or `Failure`.\nIf the command is not found or fails validation, a warning message will be logged but the resource will be allowed to attempt to start.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithRequiredCommandValidation(command string, validationCallback func(arg RequiredCommandValidationContext) RequiredCommandValidationResult, options ...*WithRequiredCommandValidationOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "command", + "type": "string", + "description": "The command string (file name or path) that should be validated." + }, + { + "name": "validationCallback", + "type": "func(arg RequiredCommandValidationContext) RequiredCommandValidationResult", + "isCallback": true, + "callbackSignature": "func(arg RequiredCommandValidationContext) RequiredCommandValidationResult", + "description": "A callback that validates the resolved command path. Receives a `RequiredCommandValidationContext` and returns a `RequiredCommandValidationResult`." + } + ], + "options": { + "typeName": "WithRequiredCommandValidationOptions", + "fields": [ + { + "name": "HelpLink", + "jsonName": "helpLink", + "type": "*string", + "description": "An optional help link URL to guide users when the command is missing or fails validation." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithSessionLifetime", + "capabilityId": "Aspire.Hosting/withSessionLifetime", + "qualifiedName": "withSessionLifetime", + "description": "Configures a resource to use a session lifetime.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSessionLifetime() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithTerminal", + "capabilityId": "Aspire.Hosting/withTerminal", + "qualifiedName": "withTerminal", + "description": "Adds an interactive terminal session to a resource using the default terminal options.", + "kind": "Method", + "signature": "WithTerminal() Resource", + "receiver": "Resource", + "parameters": [], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithUrl", + "capabilityId": "Aspire.Hosting/withUrl", + "qualifiedName": "withUrl", + "description": "Adds or modifies displayed URLs", + "kind": "Method", + "signature": "WithUrl(url any, options ...*WithUrlOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ] + } + ], + "options": { + "typeName": "WithUrlOptions", + "fields": [ + { + "name": "DisplayText", + "jsonName": "displayText", + "type": "*string" + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithUrlForEndpoint", + "capabilityId": "Aspire.Hosting/withUrlForEndpoint", + "qualifiedName": "withUrlForEndpoint", + "description": "Registers a callback to update the URL displayed for the endpoint with the specified name.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUrlForEndpoint(endpointName string, callback func(obj *ResourceUrlAnnotation)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "endpointName", + "type": "string", + "description": "The name of the endpoint to customize the URL for." + }, + { + "name": "callback", + "type": "func(obj *ResourceUrlAnnotation)", + "isCallback": true, + "callbackSignature": "func(obj *ResourceUrlAnnotation)", + "description": "The callback that will customize the URL." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithUrls", + "capabilityId": "Aspire.Hosting/withUrls", + "qualifiedName": "withUrls", + "description": "Registers a callback to customize the URLs displayed for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUrls(callback func(obj ResourceUrlsCallbackContext)) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "callback", + "type": "func(obj ResourceUrlsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(obj ResourceUrlsCallbackContext)", + "description": "The callback that will customize URLs for the resource." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithArgs", + "fullName": "Aspire.Hosting.ApplicationModel.IResourceWithArgs", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that is associated with commandline arguments.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithArgs", + "capabilityId": "Aspire.Hosting/withArgs", + "qualifiedName": "withArgs", + "description": "Adds arguments to be passed to a resource that supports arguments when it is launched.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithArgs(args []string) ResourceWithArgs", + "receiver": "ResourceWithArgs", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "The arguments to be passed to the resource when it is started." + } + ], + "returnType": "ResourceWithArgs", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithArgs", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithArgsCallback", + "capabilityId": "Aspire.Hosting/withArgsCallback", + "qualifiedName": "withArgsCallback", + "description": "Adds a callback to be executed with a list of command-line arguments when a resource is started.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithArgsCallback(callback func(obj CommandLineArgsCallbackContext)) ResourceWithArgs", + "receiver": "ResourceWithArgs", + "parameters": [ + { + "name": "callback", + "type": "func(obj CommandLineArgsCallbackContext)", + "isCallback": true, + "callbackSignature": "func(obj CommandLineArgsCallbackContext)", + "description": "A callback that allows for deferred execution for computing arguments. This runs after resources have been allocated by the orchestrator and allows access to other resources to resolve computed data, e.g. connection strings, ports." + } + ], + "returnType": "ResourceWithArgs", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithArgs", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithConnectionString", + "fullName": "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "kind": "handle", + "isInterface": true, + "description": "Represents a resource that has a connection string associated with it.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "GetConnectionProperty", + "capabilityId": "Aspire.Hosting/getConnectionProperty", + "qualifiedName": "getConnectionProperty", + "description": "Retrieves the value of a specified connection property from the resource's connection properties.", + "remarks": "Throws a KeyNotFoundException if the specified key does not exist in the resource's\nconnection properties.", + "returns": "The value associated with the specified connection property key.", + "kind": "Method", + "signature": "GetConnectionProperty(key string) *ReferenceExpression", + "receiver": "ResourceWithConnectionString", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key of the connection property to retrieve. Cannot be null." + } + ], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString" + ], + "appliesTo": [ + "ResourceWithConnectionString" + ] + }, + { + "name": "OnConnectionStringAvailable", + "capabilityId": "Aspire.Hosting/onConnectionStringAvailable", + "qualifiedName": "onConnectionStringAvailable", + "description": "Subscribes to the ConnectionStringAvailable event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnConnectionStringAvailable(callback func(arg ConnectionStringAvailableEvent)) ResourceWithConnectionString", + "receiver": "ResourceWithConnectionString", + "parameters": [ + { + "name": "callback", + "type": "func(arg ConnectionStringAvailableEvent)", + "isCallback": true, + "callbackSignature": "func(arg ConnectionStringAvailableEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "ResourceWithConnectionString", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString" + ], + "appliesTo": [ + "ResourceWithConnectionString" + ] + }, + { + "name": "WithConnectionProperty", + "capabilityId": "Aspire.Hosting/withConnectionProperty", + "qualifiedName": "withConnectionProperty", + "description": "Adds a connection property annotation to the resource being built.", + "returns": "The same resource builder instance with the specified connection property annotation applied.", + "kind": "Method", + "signature": "WithConnectionProperty(name string, value any) ResourceWithConnectionString", + "receiver": "ResourceWithConnectionString", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the connection property to add." + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ], + "description": "The value to assign to the connection property, specified as a string or reference expression." + } + ], + "returnType": "ResourceWithConnectionString", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithConnectionString", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.IResourceWithConnectionString" + ], + "appliesTo": [ + "ResourceWithConnectionString" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithEndpoints", + "fullName": "Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that has endpoints associated with it.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AsHttp2Service", + "capabilityId": "Aspire.Hosting/asHttp2Service", + "qualifiedName": "asHttp2Service", + "description": "Configures a resource to mark all endpoints' transport as HTTP/2. This is useful for HTTP/2 services that need prior knowledge.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsHttp2Service() ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "GetEndpoint", + "capabilityId": "Aspire.Hosting/getEndpoint", + "qualifiedName": "getEndpoint", + "description": "Gets an endpoint reference", + "returns": "An `EndpointReference` that can be used to resolve the address of the endpoint after resource allocation has occurred.", + "kind": "Method", + "signature": "GetEndpoint(name string) EndpointReference", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the endpoint." + } + ], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "OnResourceEndpointsAllocated", + "capabilityId": "Aspire.Hosting/onResourceEndpointsAllocated", + "qualifiedName": "onResourceEndpointsAllocated", + "description": "Subscribes to the ResourceEndpointsAllocated event.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "OnResourceEndpointsAllocated(callback func(arg ResourceEndpointsAllocatedEvent)) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "callback", + "type": "func(arg ResourceEndpointsAllocatedEvent)", + "isCallback": true, + "callbackSignature": "func(arg ResourceEndpointsAllocatedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpoint", + "capabilityId": "Aspire.Hosting/withEndpoint", + "qualifiedName": "withEndpoint", + "description": "Adds a network endpoint", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEndpoint(options ...*WithEndpointOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithEndpointOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "An optional port. This is the port that will be given to other resource to communicate with this resource." + }, + { + "name": "TargetPort", + "jsonName": "targetPort", + "type": "*float64", + "description": "This is the port the resource is listening on. If the endpoint is used for the container, it is the container port." + }, + { + "name": "Scheme", + "jsonName": "scheme", + "type": "*string", + "description": "An optional scheme e.g. (http/https). Defaults to the `protocol` argument if it is defined or \"tcp\" otherwise." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "An optional name of the endpoint. Defaults to the scheme name if not specified." + }, + { + "name": "Env", + "jsonName": "env", + "type": "*string", + "description": "An optional name of the environment variable that will be used to inject the `targetPort`. If the target port is null one will be dynamically generated and assigned to the environment variable." + }, + { + "name": "IsProxied", + "jsonName": "isProxied", + "type": "*bool", + "description": "Specifies if the endpoint will be proxied by DCP. Defaults to `null`." + }, + { + "name": "IsExternal", + "jsonName": "isExternal", + "type": "*bool", + "description": "Indicates that this endpoint should be exposed externally at publish time." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*ProtocolType", + "description": "Network protocol: TCP or UDP are supported today, others possibly in future." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpointCallback", + "capabilityId": "Aspire.Hosting/withEndpointCallback", + "qualifiedName": "withEndpointCallback", + "description": "Updates a named endpoint via callback", + "kind": "Method", + "signature": "WithEndpointCallback(endpointName string, callback func(obj EndpointUpdateContext), options ...*WithEndpointCallbackOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "endpointName", + "type": "string" + }, + { + "name": "callback", + "type": "func(obj EndpointUpdateContext)", + "isCallback": true, + "callbackSignature": "func(obj EndpointUpdateContext)" + } + ], + "options": { + "typeName": "WithEndpointCallbackOptions", + "fields": [ + { + "name": "CreateIfNotExists", + "jsonName": "createIfNotExists", + "type": "*bool" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpointProxySupport", + "capabilityId": "Aspire.Hosting/withEndpointProxySupport", + "qualifiedName": "withEndpointProxySupport", + "description": "Set whether a resource can use proxied endpoints or whether they should be disabled for all endpoints belonging to the resource. If set to `false`, endpoints belonging to the resource will ignore the configured proxy settings and run proxy-less.", + "remarks": "This method is intended to support scenarios with persistent lifetime resources where it is desirable for the resource to be accessible over the same\nport whether the Aspire application is running or not. Proxied endpoints bind ports that are only accessible while the Aspire application is running.\nThe user needs to be careful to ensure that endpoints are using unique ports when disabling proxy support as by default for proxy-less\nendpoints, Aspire will allocate the target port as the host port, which will increase the chance of port conflicts.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEndpointProxySupport(proxyEnabled bool) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "proxyEnabled", + "type": "bool", + "description": "Should endpoints for the resource support using a proxy?" + } + ], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithExternalHttpEndpoints", + "capabilityId": "Aspire.Hosting/withExternalHttpEndpoints", + "qualifiedName": "withExternalHttpEndpoints", + "description": "Marks existing http or https endpoints on a resource as external.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExternalHttpEndpoints() ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpCommand", + "capabilityId": "Aspire.Hosting/withHttpCommand", + "qualifiedName": "withHttpCommand", + "description": "Adds an HTTP resource command", + "kind": "Method", + "signature": "WithHttpCommand(path string, displayName string, options ...*HttpCommandExportOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "path", + "type": "string" + }, + { + "name": "displayName", + "type": "string" + } + ], + "options": { + "typeName": "HttpCommandExportOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpEndpoint", + "capabilityId": "Aspire.Hosting/withHttpEndpoint", + "qualifiedName": "withHttpEndpoint", + "description": "Adds an HTTP endpoint", + "remarks": "If an endpoint with the same name already exists on the resource, the existing endpoint is updated\nwith any non-null parameter values. Parameters left as `null` will not modify the existing endpoint's values.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpEndpoint(options ...*WithHttpEndpointOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithHttpEndpointOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "An optional port. This is the port that will be given to other resource to communicate with this resource." + }, + { + "name": "TargetPort", + "jsonName": "targetPort", + "type": "*float64", + "description": "This is the port the resource is listening on. If the endpoint is used for the container, it is the container port." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "An optional name of the endpoint. Defaults to \"http\" if not specified." + }, + { + "name": "Env", + "jsonName": "env", + "type": "*string", + "description": "An optional name of the environment variable to inject." + }, + { + "name": "IsProxied", + "jsonName": "isProxied", + "type": "*bool", + "description": "Specifies if the endpoint will be proxied by DCP. Defaults to `null`." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpEndpointCallback", + "capabilityId": "Aspire.Hosting/withHttpEndpointCallback", + "qualifiedName": "withHttpEndpointCallback", + "description": "Updates an HTTP endpoint via callback", + "kind": "Method", + "signature": "WithHttpEndpointCallback(callback func(obj EndpointUpdateContext), options ...*WithHttpEndpointCallbackOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "callback", + "type": "func(obj EndpointUpdateContext)", + "isCallback": true, + "callbackSignature": "func(obj EndpointUpdateContext)" + } + ], + "options": { + "typeName": "WithHttpEndpointCallbackOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string" + }, + { + "name": "CreateIfNotExists", + "jsonName": "createIfNotExists", + "type": "*bool" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpHealthCheck", + "capabilityId": "Aspire.Hosting/withHttpHealthCheck", + "qualifiedName": "withHttpHealthCheck", + "description": "Adds a health check to the resource which is mapped to a specific endpoint.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpHealthCheck(options ...*WithHttpHealthCheckOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithHttpHealthCheckOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "The relative path to test." + }, + { + "name": "StatusCode", + "jsonName": "statusCode", + "type": "*float64", + "description": "The result code to interpret as healthy." + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string", + "description": "The name of the endpoint to derive the base address from." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpProbe", + "capabilityId": "Aspire.Hosting/withHttpProbe", + "qualifiedName": "withHttpProbe", + "description": "Adds an HTTP health probe to the resource", + "kind": "Method", + "signature": "WithHttpProbe(probeType ProbeType, options ...*WithHttpProbeOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "probeType", + "type": "ProbeType" + } + ], + "options": { + "typeName": "WithHttpProbeOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string" + }, + { + "name": "InitialDelaySeconds", + "jsonName": "initialDelaySeconds", + "type": "*float64" + }, + { + "name": "PeriodSeconds", + "jsonName": "periodSeconds", + "type": "*float64" + }, + { + "name": "TimeoutSeconds", + "jsonName": "timeoutSeconds", + "type": "*float64" + }, + { + "name": "FailureThreshold", + "jsonName": "failureThreshold", + "type": "*float64" + }, + { + "name": "SuccessThreshold", + "jsonName": "successThreshold", + "type": "*float64" + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsEndpoint", + "capabilityId": "Aspire.Hosting/withHttpsEndpoint", + "qualifiedName": "withHttpsEndpoint", + "description": "Adds an HTTPS endpoint", + "remarks": "If an endpoint with the same name already exists on the resource, the existing endpoint is updated\nwith any non-null parameter values. Parameters left as `null` will not modify the existing endpoint's values.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsEndpoint(options ...*WithHttpsEndpointOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithHttpsEndpointOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "An optional host port." + }, + { + "name": "TargetPort", + "jsonName": "targetPort", + "type": "*float64", + "description": "This is the port the resource is listening on. If the endpoint is used for the container, it is the container port." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "An optional name of the endpoint. Defaults to \"https\" if not specified." + }, + { + "name": "Env", + "jsonName": "env", + "type": "*string", + "description": "An optional name of the environment variable to inject." + }, + { + "name": "IsProxied", + "jsonName": "isProxied", + "type": "*bool", + "description": "Specifies if the endpoint will be proxied by DCP. Defaults to `null`." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsEndpointCallback", + "capabilityId": "Aspire.Hosting/withHttpsEndpointCallback", + "qualifiedName": "withHttpsEndpointCallback", + "description": "Updates an HTTPS endpoint via callback", + "kind": "Method", + "signature": "WithHttpsEndpointCallback(callback func(obj EndpointUpdateContext), options ...*WithHttpsEndpointCallbackOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "callback", + "type": "func(obj EndpointUpdateContext)", + "isCallback": true, + "callbackSignature": "func(obj EndpointUpdateContext)" + } + ], + "options": { + "typeName": "WithHttpsEndpointCallbackOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string" + }, + { + "name": "CreateIfNotExists", + "jsonName": "createIfNotExists", + "type": "*bool" + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithMcpServer", + "capabilityId": "Aspire.Hosting/withMcpServer", + "qualifiedName": "withMcpServer", + "description": "Marks the resource as hosting a Model Context Protocol (MCP) server on the specified endpoint.", + "remarks": "This method adds an `McpServerEndpointAnnotation` to the resource, enabling the Aspire tooling\nto discover and proxy the MCP server exposed by the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithMcpServer(options ...*WithMcpServerOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithMcpServerOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "An optional path to append to the endpoint URL when forming the MCP server address. Defaults to `\"/mcp\"`." + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string", + "description": "An optional name of the endpoint that hosts the MCP server. If not specified, defaults to the first HTTPS or HTTP endpoint." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithEnvironment", + "fullName": "Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that is associated with an environment.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithCertificateTrustScope", + "capabilityId": "Aspire.Hosting/withCertificateTrustScope", + "qualifiedName": "withCertificateTrustScope", + "description": "Sets the certificate trust scope", + "remarks": "The default scope if not overridden is `Append` which means that custom certificate\nauthorities should be appended to the default trusted certificate authorities for the resource. Setting the scope to\n`Override` indicates the set of certificates in referenced\n`CertificateAuthorityCollection` (and optionally Aspire developer certificiates) should be used as the\nexclusive source of trust for a resource.\nIn all cases, this is a best effort implementation as not all resources support full customization of certificate\ntrust.\nSet the scope for custom certificate authorities to override the default trusted certificate authorities for a container resource.\n```\nvar caCollection = builder.AddCertificateAuthorityCollection(\"my-cas\")\n.WithCertificate(new X509Certificate2(\"my-ca.pem\"));\nvar container = builder.AddContainer(\"my-service\", \"my-service:latest\")\n.WithCertificateAuthorityCollection(caCollection)\n.WithCertificateTrustScope(CertificateTrustScope.Override);\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCertificateTrustScope(scope CertificateTrustScope) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "scope", + "type": "CertificateTrustScope", + "description": "The scope to apply to custom certificate authorities associated with the resource." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithDeveloperCertificateTrust", + "capabilityId": "Aspire.Hosting/withDeveloperCertificateTrust", + "qualifiedName": "withDeveloperCertificateTrust", + "description": "Indicates whether developer certificates should be treated as trusted certificate authorities for the resource at run time. Currently this indicates trust for the ASP.NET Core developer certificate. The developer certificate will only be trusted when running in local development scenarios; in publish mode resources will use their default certificate trust.", + "remarks": "Disable trust for AppHost managed developer certificate(s) for a container resource.\n```\nvar container = builder.AddContainer(\"my-service\", \"my-service:latest\")\n.WithDeveloperCertificateTrust(false);\n```\nDisable automatic trust for AppHost managed developer certificate(s), but explicitly enable it for a specific resource.\n```\nvar builder = DistributedApplication.CreateBuilder(new DistributedApplicationOptions()\n{\nArgs = args,\nTrustDeveloperCertificate = false,\n});\nvar project = builder.AddProject(\"my-service\")\n.WithDeveloperCertificateTrust(true);\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDeveloperCertificateTrust(trust bool) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "trust", + "type": "bool", + "description": "Indicates whether the developer certificate should be treated as trusted." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEnvironment", + "capabilityId": "Aspire.Hosting/withEnvironment", + "qualifiedName": "withEnvironment", + "description": "Sets an environment variable", + "kind": "Method", + "signature": "WithEnvironment(name string, value any) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression", + "EndpointReference", + "ParameterResource", + "ExternalServiceResource", + "ResourceWithConnectionString", + "ExpressionValue" + ] + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithEnvironmentCallback", + "capabilityId": "Aspire.Hosting/withEnvironmentCallback", + "qualifiedName": "withEnvironmentCallback", + "description": "Allows for the population of environment variables on a resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEnvironmentCallback(callback func(arg EnvironmentCallbackContext)) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "callback", + "type": "func(arg EnvironmentCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg EnvironmentCallbackContext)", + "description": "A callback that allows for deferred execution for computing many environment variables. This runs after resources have been allocated by the orchestrator and allows access to other resources to resolve computed data, e.g. connection strings, ports." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsCertificateConfiguration", + "capabilityId": "Aspire.Hosting/withHttpsCertificateConfiguration", + "qualifiedName": "withHttpsCertificateConfiguration", + "description": "Adds a callback that allows configuring the resource to use a specific HTTPS/TLS certificate key pair for server authentication.", + "remarks": "Pass the path to the PFX certificate file to the container arguments.\n```\nbuilder.AddContainer(\"my-service\", \"my-image\")\n.WithHttpsCertificateConfiguration(ctx =>\n{\nctx.Arguments.Add(\"--https-certificate-path\");\nctx.Arguments.Add(ctx.PfxPath);\nreturn Task.CompletedTask;\n});\n```", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "WithHttpsCertificateConfiguration(callback func(arg HttpsCertificateConfigurationCallbackAnnotationContext)) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "callback", + "type": "func(arg HttpsCertificateConfigurationCallbackAnnotationContext)", + "isCallback": true, + "callbackSignature": "func(arg HttpsCertificateConfigurationCallbackAnnotationContext)", + "description": "The callback to configure the resource to use a certificate key pair." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithHttpsDeveloperCertificate", + "capabilityId": "Aspire.Hosting/withParameterHttpsDeveloperCertificate", + "qualifiedName": "withHttpsDeveloperCertificate", + "description": "Indicates that a resource should use the developer certificate key pair for HTTPS endpoints at run time. Currently this indicates use of the ASP.NET Core developer certificate. The developer certificate will only be used when running in local development scenarios; in publish mode resources will use their default certificate configuration.", + "remarks": "Use the developer certificate for HTTPS/TLS endpoints on a container resource:\n```\nbuilder.AddContainer(\"my-service\", \"my-image\")\n.WithHttpsDeveloperCertificate()\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsDeveloperCertificate(options ...*WithHttpsDeveloperCertificateOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [], + "options": { + "typeName": "WithHttpsDeveloperCertificateOptions", + "fields": [ + { + "name": "Password", + "jsonName": "password", + "type": "*ParameterResource", + "description": "A parameter specifying the password used to encrypt the certificate private key." + } + ] + }, + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithOtlpExporter", + "capabilityId": "Aspire.Hosting/withOtlpExporter", + "qualifiedName": "withOtlpExporter", + "description": "Configures OTLP telemetry export", + "kind": "Method", + "signature": "WithOtlpExporter(options ...*WithOtlpExporterOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [], + "options": { + "typeName": "WithOtlpExporterOptions", + "fields": [ + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*OtlpProtocol" + } + ] + }, + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithReference", + "capabilityId": "Aspire.Hosting/withReference", + "qualifiedName": "withReference", + "description": "Adds a reference to another resource", + "kind": "Method", + "signature": "WithReference(source any, options ...*WithReferenceOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "source", + "type": "any", + "allowedTypes": [ + "Resource", + "EndpointReference", + "string" + ] + } + ], + "options": { + "typeName": "WithReferenceOptions", + "fields": [ + { + "name": "ConnectionName", + "jsonName": "connectionName", + "type": "*string" + }, + { + "name": "Optional", + "jsonName": "optional", + "type": "*bool" + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string" + } + ] + }, + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithReferenceEnvironment", + "capabilityId": "Aspire.Hosting/withReferenceEnvironment", + "qualifiedName": "withReferenceEnvironment", + "description": "Configures how information is injected into environment variables when the resource references other resources.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithReferenceEnvironment(options *ReferenceEnvironmentInjectionOptions) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "options", + "type": "*ReferenceEnvironmentInjectionOptions", + "description": "Options controlling which reference information is emitted." + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithoutHttpsCertificate", + "capabilityId": "Aspire.Hosting/withoutHttpsCertificate", + "qualifiedName": "withoutHttpsCertificate", + "description": "Disable HTTPS/TLS server certificate configuration for the resource. No HTTPS/TLS termination configuration will be applied.", + "remarks": "Disable HTTPS certificate configuration for a Redis resource:\n```\nvar redis = builder.AddRedis(\"cache\")\n.WithoutHttpsCertificate();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithoutHttpsCertificate() ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithParent", + "fullName": "Aspire.Hosting.ApplicationModel.IResourceWithParent", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that has a parent resource.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithWaitSupport", + "fullName": "Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that can wait for other resources to be running, health, and/or completed.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WaitFor", + "capabilityId": "Aspire.Hosting/waitFor", + "qualifiedName": "waitFor", + "description": "Waits for another resource to be ready", + "kind": "Method", + "signature": "WaitFor(dependency Resource, options ...*WaitForOptions) ResourceWithWaitSupport", + "receiver": "ResourceWithWaitSupport", + "parameters": [ + { + "name": "dependency", + "type": "Resource" + } + ], + "options": { + "typeName": "WaitForOptions", + "fields": [ + { + "name": "WaitBehavior", + "jsonName": "waitBehavior", + "type": "*WaitBehavior" + } + ] + }, + "returnType": "ResourceWithWaitSupport", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WaitForCompletion", + "capabilityId": "Aspire.Hosting/waitForResourceCompletion", + "qualifiedName": "waitForCompletion", + "description": "Waits for the dependency resource to enter the Exited or Finished state before starting the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WaitForCompletion(dependency Resource, options ...*WaitForCompletionOptions) ResourceWithWaitSupport", + "receiver": "ResourceWithWaitSupport", + "parameters": [ + { + "name": "dependency", + "type": "Resource", + "description": "The resource builder for the dependency resource." + } + ], + "options": { + "typeName": "WaitForCompletionOptions", + "fields": [ + { + "name": "ExitCode", + "jsonName": "exitCode", + "type": "*float64", + "description": "The exit code which is interpreted as successful." + } + ] + }, + "returnType": "ResourceWithWaitSupport", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WaitForStart", + "capabilityId": "Aspire.Hosting/waitForStart", + "qualifiedName": "waitForStart", + "description": "Waits for another resource to start", + "kind": "Method", + "signature": "WaitForStart(dependency Resource, options ...*WaitForStartOptions) ResourceWithWaitSupport", + "receiver": "ResourceWithWaitSupport", + "parameters": [ + { + "name": "dependency", + "type": "Resource" + } + ], + "options": { + "typeName": "WaitForStartOptions", + "fields": [ + { + "name": "WaitBehavior", + "jsonName": "waitBehavior", + "type": "*WaitBehavior" + } + ] + }, + "returnType": "ResourceWithWaitSupport", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithWaitSupport", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InitializeResourceEvent", + "fullName": "Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "kind": "handle", + "description": "This event is raised by orchestrators to signal to resources that they should initialize themselves.", + "remarks": "Custom resources can subscribe to this event to perform initialization tasks, including starting background tasks\nthat manage the resource's lifecycle.", + "implementedInterfaces": [ + "DistributedApplicationEvent", + "DistributedApplicationResourceEvent" + ], + "capabilities": [ + { + "name": "Eventing", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.eventing", + "qualifiedName": "InitializeResourceEvent.eventing", + "description": "The `IDistributedApplicationEventing` service for the AppHost.", + "kind": "PropertyGetter", + "signature": "Eventing() DistributedApplicationEventing", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "DistributedApplicationEventing", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.logger", + "qualifiedName": "InitializeResourceEvent.logger", + "description": "An instance of `ILogger` that can be used to log messages for the resource.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Notifications", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.notifications", + "qualifiedName": "InitializeResourceEvent.notifications", + "description": "The `ResourceNotificationService` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Notifications() ResourceNotificationService", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "ResourceNotificationService", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.resource", + "qualifiedName": "InitializeResourceEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/InitializeResourceEvent.services", + "qualifiedName": "InitializeResourceEvent.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "InitializeResourceEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.InitializeResourceEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.InitializeResourceEvent" + ], + "appliesTo": [ + "InitializeResourceEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "LogFacade", + "fullName": "Aspire.Hosting.ApplicationModel.LogFacade", + "kind": "handle", + "description": "Provides a narrow logging surface for polyglot callback contexts.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Debug", + "capabilityId": "Aspire.Hosting.ApplicationModel/debug", + "qualifiedName": "LogFacade.debug", + "description": "Writes a debug log message.", + "kind": "InstanceMethod", + "signature": "Debug(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "Error", + "capabilityId": "Aspire.Hosting.ApplicationModel/error", + "qualifiedName": "LogFacade.error", + "description": "Writes an error log message.", + "kind": "InstanceMethod", + "signature": "Error(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "Info", + "capabilityId": "Aspire.Hosting.ApplicationModel/info", + "qualifiedName": "LogFacade.info", + "description": "Writes an informational log message.", + "kind": "InstanceMethod", + "signature": "Info(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + }, + { + "name": "Warning", + "capabilityId": "Aspire.Hosting.ApplicationModel/warning", + "qualifiedName": "LogFacade.warning", + "description": "Writes a warning log message.", + "kind": "InstanceMethod", + "signature": "Warning(message string) error", + "receiver": "LogFacade", + "parameters": [ + { + "name": "message", + "type": "string", + "description": "The message to write." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.LogFacade", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.LogFacade" + ], + "appliesTo": [ + "LogFacade" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ParameterResource", + "fullName": "Aspire.Hosting.ApplicationModel.ParameterResource", + "kind": "handle", + "description": "Represents a parameter resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource" + ], + "capabilities": [ + { + "name": "WithCustomInput", + "capabilityId": "Aspire.Hosting/withCustomInput", + "qualifiedName": "withCustomInput", + "description": "Sets a custom input for the parameter resource from a polyglot AppHost.", + "returns": "Resource builder for the parameter.", + "kind": "Method", + "signature": "WithCustomInput(options *ParameterCustomInputOptions) ParameterResource", + "receiver": "ParameterResource", + "parameters": [ + { + "name": "options", + "type": "*ParameterCustomInputOptions", + "description": "Options used to customize the input for the parameter." + } + ], + "returnType": "ParameterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ParameterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ParameterResource" + ], + "appliesTo": [ + "ParameterResource" + ] + }, + { + "name": "WithDescription", + "capabilityId": "Aspire.Hosting/withDescription", + "qualifiedName": "withDescription", + "description": "Sets the description of the parameter resource.", + "returns": "Resource builder for the parameter.", + "kind": "Method", + "signature": "WithDescription(description string, options ...*WithDescriptionOptions) ParameterResource", + "receiver": "ParameterResource", + "parameters": [ + { + "name": "description", + "type": "string", + "description": "The parameter description." + } + ], + "options": { + "typeName": "WithDescriptionOptions", + "fields": [ + { + "name": "EnableMarkdown", + "jsonName": "enableMarkdown", + "type": "*bool", + "description": "A value indicating whether the description should be rendered as Markdown. `true` allows the description to contain Markdown elements such as links, text decoration and lists." + } + ] + }, + "returnType": "ParameterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ParameterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ParameterResource" + ], + "appliesTo": [ + "ParameterResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProjectResource", + "fullName": "Aspire.Hosting.ApplicationModel.ProjectResource", + "kind": "handle", + "description": "A resource that represents a specified .NET project.", + "implementedInterfaces": [ + "DotnetProgramResource", + "IComputeResource", + "IContainerFilesDestinationResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "DisableForwardedHeaders", + "capabilityId": "Aspire.Hosting/disableForwardedHeaders", + "qualifiedName": "disableForwardedHeaders", + "description": "Configures the project to disable forwarded headers when being published.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "DisableForwardedHeaders() ProjectResource", + "receiver": "ProjectResource", + "parameters": [], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "PublishAsDockerFile", + "capabilityId": "Aspire.Hosting/publishProjectAsDockerFileWithConfigure", + "qualifiedName": "publishAsDockerFile", + "description": "Publishes a project as a Docker file with optional container configuration", + "remarks": "When the executable resource is converted to a container resource, the arguments to the executable\nare not used. This is because arguments to the project often contain physical paths that are not valid\nin the container. The container can be set up with the correct arguments using the `configure` action.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsDockerFile(options ...*PublishAsDockerFileOptions) ProjectResource", + "receiver": "ProjectResource", + "parameters": [], + "options": { + "typeName": "PublishAsDockerFileOptions", + "fields": [ + { + "name": "Configure", + "type": "func(obj ContainerResource)", + "isCallback": true, + "callbackSignature": "func(obj ContainerResource)", + "description": "Optional action to configure the container resource" + } + ] + }, + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithEndpointsInEnvironment", + "capabilityId": "Aspire.Hosting/withEndpointsInEnvironment", + "qualifiedName": "withEndpointsInEnvironment", + "description": "Includes only the specified project endpoint names in environment-variable injection.", + "returns": "The same project resource builder handle for chaining.", + "kind": "Method", + "signature": "WithEndpointsInEnvironment(endpointNames []string) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "endpointNames", + "type": "[]string", + "description": "The endpoint names to include in environment variables." + } + ], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithReplicas", + "capabilityId": "Aspire.Hosting/withReplicas", + "qualifiedName": "withReplicas", + "description": "Configures how many replicas of the project should be created for the project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithReplicas(replicas float64) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "replicas", + "type": "float64", + "description": "The number of replicas." + } + ], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithVolume", + "capabilityId": "Aspire.Hosting/withProjectVolume", + "qualifiedName": "withVolume", + "description": "Adds a volume to a project resource.", + "returns": "The same project resource builder handle for chaining.", + "kind": "Method", + "signature": "WithVolume(target string, name string, env string, options ...*ProjectResourceWithVolumeOptions) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "target", + "type": "string", + "description": "The mount path inside the published container." + }, + { + "name": "name", + "type": "string", + "description": "The volume name." + }, + { + "name": "env", + "type": "string", + "description": "The environment variable that receives the effective volume path." + } + ], + "options": { + "typeName": "ProjectResourceWithVolumeOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "Whether the published volume is read-only." + } + ] + }, + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ReferenceExpressionBuilder", + "fullName": "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "kind": "handle", + "description": "A builder for creating {@ats-ref type:ReferenceExpression} instances.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AppendFormatted", + "capabilityId": "Aspire.Hosting.ApplicationModel/appendFormatted", + "qualifiedName": "ReferenceExpressionBuilder.appendFormatted", + "description": "Appends a formatted value to the expression.", + "kind": "InstanceMethod", + "signature": "AppendFormatted(value string, options ...*AppendFormattedOptions) error", + "receiver": "ReferenceExpressionBuilder", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The formatted string to be appended to the interpolated string." + } + ], + "options": { + "typeName": "AppendFormattedOptions", + "fields": [ + { + "name": "Format", + "jsonName": "format", + "type": "*string", + "description": "The format to be applied to the value. e.g., \"uri\"" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "AppendLiteral", + "capabilityId": "Aspire.Hosting.ApplicationModel/appendLiteral", + "qualifiedName": "ReferenceExpressionBuilder.appendLiteral", + "description": "Appends a literal value to the expression.", + "kind": "InstanceMethod", + "signature": "AppendLiteral(value string) error", + "receiver": "ReferenceExpressionBuilder", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The literal string value to be appended to the interpolated string." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "AppendValueProvider", + "capabilityId": "Aspire.Hosting.ApplicationModel/appendValueProvider", + "qualifiedName": "ReferenceExpressionBuilder.appendValueProvider", + "description": "Appends a value provider to the reference expression", + "kind": "InstanceMethod", + "signature": "AppendValueProvider(valueProvider any, options ...*AppendValueProviderOptions) error", + "receiver": "ReferenceExpressionBuilder", + "parameters": [ + { + "name": "valueProvider", + "type": "any", + "description": "The value provider to append." + } + ], + "options": { + "typeName": "AppendValueProviderOptions", + "fields": [ + { + "name": "Format", + "jsonName": "format", + "type": "*string", + "description": "Optional format specifier." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting.ApplicationModel/build", + "qualifiedName": "ReferenceExpressionBuilder.build", + "description": "Builds the reference expression", + "kind": "InstanceMethod", + "signature": "Build() *ReferenceExpression", + "receiver": "ReferenceExpressionBuilder", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + }, + { + "name": "IsEmpty", + "capabilityId": "Aspire.Hosting.ApplicationModel/ReferenceExpressionBuilder.isEmpty", + "qualifiedName": "ReferenceExpressionBuilder.isEmpty", + "description": "Indicates whether the expression is empty.", + "kind": "PropertyGetter", + "signature": "IsEmpty() (bool, error)", + "receiver": "ReferenceExpressionBuilder", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ReferenceExpressionBuilder" + ], + "appliesTo": [ + "ReferenceExpressionBuilder" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "RequiredCommandValidationContext", + "fullName": "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "kind": "handle", + "description": "Provides context for validating a required command.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.cancellationToken", + "qualifiedName": "RequiredCommandValidationContext.cancellationToken", + "description": "Gets a cancellation token that can be used to cancel the validation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "Failure", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.failure", + "qualifiedName": "RequiredCommandValidationContext.failure", + "description": "Creates a failed validation result with the specified message.", + "returns": "A `RequiredCommandValidationResult` indicating the command is invalid.", + "kind": "InstanceMethod", + "signature": "Failure(validationMessage string) RequiredCommandValidationResult", + "receiver": "RequiredCommandValidationContext", + "parameters": [ + { + "name": "validationMessage", + "type": "string", + "description": "A message describing why validation failed." + } + ], + "returnType": "RequiredCommandValidationResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "ResolvedPath", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.resolvedPath", + "qualifiedName": "RequiredCommandValidationContext.resolvedPath", + "description": "Gets the resolved full path to the command executable.", + "kind": "PropertyGetter", + "signature": "ResolvedPath() (string, error)", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.services", + "qualifiedName": "RequiredCommandValidationContext.services", + "description": "Gets the service provider for accessing application services.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + }, + { + "name": "Success", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationContext.success", + "qualifiedName": "RequiredCommandValidationContext.success", + "description": "Creates a successful validation result.", + "returns": "A `RequiredCommandValidationResult` indicating the command is valid.", + "kind": "InstanceMethod", + "signature": "Success() RequiredCommandValidationResult", + "receiver": "RequiredCommandValidationContext", + "parameters": [], + "returnType": "RequiredCommandValidationResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationContext" + ], + "appliesTo": [ + "RequiredCommandValidationContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "RequiredCommandValidationResult", + "fullName": "Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult", + "kind": "handle", + "description": "Represents the result of validating a required command.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "IsValid", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationResult.isValid", + "qualifiedName": "RequiredCommandValidationResult.isValid", + "description": "Gets a value indicating whether the command validation succeeded.", + "kind": "PropertyGetter", + "signature": "IsValid() (bool, error)", + "receiver": "RequiredCommandValidationResult", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult" + ], + "appliesTo": [ + "RequiredCommandValidationResult" + ] + }, + { + "name": "ValidationMessage", + "capabilityId": "Aspire.Hosting.ApplicationModel/RequiredCommandValidationResult.validationMessage", + "qualifiedName": "RequiredCommandValidationResult.validationMessage", + "description": "Gets an optional validation message describing why validation failed.", + "kind": "PropertyGetter", + "signature": "ValidationMessage() (*string, error)", + "receiver": "RequiredCommandValidationResult", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.RequiredCommandValidationResult" + ], + "appliesTo": [ + "RequiredCommandValidationResult" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceCommandService", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceCommandService", + "kind": "handle", + "description": "A service to execute resource commands.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ExecuteCommandAsync", + "capabilityId": "Aspire.Hosting/executeResourceCommand", + "qualifiedName": "executeCommandAsync", + "description": "Executes a command for the specified resource.", + "returns": "The command execution result.", + "kind": "Method", + "signature": "ExecuteCommandAsync(resource any, commandName string, options ...*ExecuteCommandAsyncOptions) (*ExecuteCommandResult, error)", + "receiver": "ResourceCommandService", + "parameters": [ + { + "name": "resource", + "type": "any", + "allowedTypes": [ + "string", + "Resource" + ], + "description": "The resource id or resource handle. A resource id can either exactly match the unique id of the resource or the displayed resource name if the resource name doesn't have duplicates." + }, + { + "name": "commandName", + "type": "string", + "description": "The command name." + } + ], + "options": { + "typeName": "ExecuteCommandAsyncOptions", + "fields": [ + { + "name": "Arguments", + "jsonName": "arguments", + "type": "map[string]string", + "description": "The optional invocation arguments supplied to the command callback." + }, + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The cancellation token." + } + ] + }, + "returnType": "(*ExecuteCommandResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceCommandService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceCommandService" + ], + "appliesTo": [ + "ResourceCommandService" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceEndpointsAllocatedEvent", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent", + "kind": "handle", + "description": "This event is raised by orchestrators to signal to resources that their endpoints have been allocated.", + "remarks": "Any resources that customize their URLs via a `ResourceUrlsCallbackAnnotation` will have their callbacks invoked during this event.", + "implementedInterfaces": [ + "DistributedApplicationEvent", + "DistributedApplicationResourceEvent" + ], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceEndpointsAllocatedEvent.resource", + "qualifiedName": "ResourceEndpointsAllocatedEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceEndpointsAllocatedEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent" + ], + "appliesTo": [ + "ResourceEndpointsAllocatedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceEndpointsAllocatedEvent.services", + "qualifiedName": "ResourceEndpointsAllocatedEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ResourceEndpointsAllocatedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceEndpointsAllocatedEvent" + ], + "appliesTo": [ + "ResourceEndpointsAllocatedEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceLoggerService", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceLoggerService", + "kind": "handle", + "description": "A service that provides loggers for resources to write to.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CompleteLog", + "capabilityId": "Aspire.Hosting/completeLog", + "qualifiedName": "completeLog", + "description": "Completes the log stream for a resource.", + "kind": "Method", + "signature": "CompleteLog(resource Resource) error", + "receiver": "ResourceLoggerService", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceLoggerService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceLoggerService" + ], + "appliesTo": [ + "ResourceLoggerService" + ] + }, + { + "name": "CompleteLogByName", + "capabilityId": "Aspire.Hosting/completeLogByName", + "qualifiedName": "completeLogByName", + "description": "Completes the log stream by resource name.", + "kind": "Method", + "signature": "CompleteLogByName(resourceName string) error", + "receiver": "ResourceLoggerService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceLoggerService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceLoggerService" + ], + "appliesTo": [ + "ResourceLoggerService" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceNotificationService", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "kind": "handle", + "description": "A service that allows publishing and subscribing to changes in the state of a resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "PublishResourceUpdate", + "capabilityId": "Aspire.Hosting/publishResourceUpdate", + "qualifiedName": "publishResourceUpdate", + "description": "Publishes an update for a resource's state.", + "kind": "Method", + "signature": "PublishResourceUpdate(resource Resource, options ...*PublishResourceUpdateOptions) error", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "options": { + "typeName": "PublishResourceUpdateOptions", + "fields": [ + { + "name": "State", + "jsonName": "state", + "type": "*string" + }, + { + "name": "StateStyle", + "jsonName": "stateStyle", + "type": "*string" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "TryGetResourceState", + "capabilityId": "Aspire.Hosting/tryGetResourceState", + "qualifiedName": "tryGetResourceState", + "description": "Tries to get the current state of a resource.", + "kind": "Method", + "signature": "TryGetResourceState(resourceName string) (*ResourceEventDto, error)", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "returnType": "(*ResourceEventDto, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForDependencies", + "capabilityId": "Aspire.Hosting/waitForDependencies", + "qualifiedName": "waitForDependencies", + "description": "Waits for all dependencies of a resource to be ready.", + "kind": "Method", + "signature": "WaitForDependencies(resource Resource) error", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resource", + "type": "Resource" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForResourceHealthy", + "capabilityId": "Aspire.Hosting/waitForResourceHealthy", + "qualifiedName": "waitForResourceHealthy", + "description": "Waits for a resource to become healthy.", + "kind": "Method", + "signature": "WaitForResourceHealthy(resourceName string) (*ResourceEventDto, error)", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "returnType": "(*ResourceEventDto, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForResourceState", + "capabilityId": "Aspire.Hosting/waitForResourceState", + "qualifiedName": "waitForResourceState", + "description": "Waits for a resource to reach a specified state.", + "kind": "Method", + "signature": "WaitForResourceState(resourceName string, options ...*WaitForResourceStateOptions) error", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + } + ], + "options": { + "typeName": "WaitForResourceStateOptions", + "fields": [ + { + "name": "TargetState", + "jsonName": "targetState", + "type": "*string" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + }, + { + "name": "WaitForResourceStates", + "capabilityId": "Aspire.Hosting/waitForResourceStates", + "qualifiedName": "waitForResourceStates", + "description": "Waits for a resource to reach one of the specified states.", + "kind": "Method", + "signature": "WaitForResourceStates(resourceName string, targetStates []string) (string, error)", + "receiver": "ResourceNotificationService", + "parameters": [ + { + "name": "resourceName", + "type": "string" + }, + { + "name": "targetStates", + "type": "[]string" + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceNotificationService", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceNotificationService" + ], + "appliesTo": [ + "ResourceNotificationService" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceReadyEvent", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceReadyEvent", + "kind": "handle", + "description": "Event that is raised when a resource initially transitions to a ready state.", + "remarks": "This event is only fired the first time a resource transitions to a ready state after starting.", + "implementedInterfaces": [ + "DistributedApplicationEvent", + "DistributedApplicationResourceEvent" + ], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceReadyEvent.resource", + "qualifiedName": "ResourceReadyEvent.resource", + "description": "The resource that is in a healthy state.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceReadyEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceReadyEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceReadyEvent" + ], + "appliesTo": [ + "ResourceReadyEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceReadyEvent.services", + "qualifiedName": "ResourceReadyEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ResourceReadyEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceReadyEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceReadyEvent" + ], + "appliesTo": [ + "ResourceReadyEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceStoppedEvent", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceStoppedEvent", + "kind": "handle", + "description": "This event is raised after a resource has stopped.", + "remarks": "This event allows for cleanup or unregistration logic when a resource is stopped by an orchestrator.", + "implementedInterfaces": [ + "DistributedApplicationEvent", + "DistributedApplicationResourceEvent" + ], + "capabilities": [ + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceStoppedEvent.resource", + "qualifiedName": "ResourceStoppedEvent.resource", + "description": "Gets the Resource property", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceStoppedEvent", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceStoppedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceStoppedEvent" + ], + "appliesTo": [ + "ResourceStoppedEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceStoppedEvent.services", + "qualifiedName": "ResourceStoppedEvent.services", + "description": "Gets the Services property", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "ResourceStoppedEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceStoppedEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceStoppedEvent" + ], + "appliesTo": [ + "ResourceStoppedEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceUrlsCallbackContext", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "kind": "handle", + "description": "Represents a callback context for resource URLs.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.executionContext", + "qualifiedName": "ResourceUrlsCallbackContext.executionContext", + "description": "Gets the execution context associated with this invocation of the AppHost.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "GetEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/getEndpoint", + "qualifiedName": "ResourceUrlsCallbackContext.getEndpoint", + "description": "Gets an endpoint reference from the associated resource", + "kind": "InstanceMethod", + "signature": "GetEndpoint(name string) EndpointReference", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the endpoint." + } + ], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.log", + "qualifiedName": "ResourceUrlsCallbackContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.resource", + "qualifiedName": "ResourceUrlsCallbackContext.resource", + "description": "Gets the resource this the URLs are associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + }, + { + "name": "Urls", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsCallbackContext.urls", + "qualifiedName": "ResourceUrlsCallbackContext.urls", + "description": "Gets the editor used to manipulate displayed URLs in polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Urls() ResourceUrlsEditor", + "receiver": "ResourceUrlsCallbackContext", + "parameters": [], + "returnType": "ResourceUrlsEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsCallbackContext" + ], + "appliesTo": [ + "ResourceUrlsCallbackContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceUrlsEditor", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "kind": "handle", + "description": "Provides an ATS-first editor for resource URLs within polyglot callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Add", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsEditor.add", + "qualifiedName": "ResourceUrlsEditor.add", + "description": "Adds a displayed URL.", + "kind": "InstanceMethod", + "signature": "Add(url any, options ...*AddOptions) error", + "receiver": "ResourceUrlsEditor", + "parameters": [ + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ], + "description": "The URL to add, specified as a string or reference expression." + } + ], + "options": { + "typeName": "AddOptions", + "fields": [ + { + "name": "DisplayText", + "jsonName": "displayText", + "type": "*string", + "description": "The optional display text to show for the URL." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor" + ], + "appliesTo": [ + "ResourceUrlsEditor" + ] + }, + { + "name": "AddForEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsEditor.addForEndpoint", + "qualifiedName": "ResourceUrlsEditor.addForEndpoint", + "description": "Adds a displayed URL for a specific endpoint.", + "kind": "InstanceMethod", + "signature": "AddForEndpoint(endpoint EndpointReference, url any, options ...*AddForEndpointOptions) error", + "receiver": "ResourceUrlsEditor", + "parameters": [ + { + "name": "endpoint", + "type": "EndpointReference", + "description": "The endpoint the URL is associated with." + }, + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "*ReferenceExpression" + ], + "description": "The URL to add, specified as a string or reference expression." + } + ], + "options": { + "typeName": "AddForEndpointOptions", + "fields": [ + { + "name": "DisplayText", + "jsonName": "displayText", + "type": "*string", + "description": "The optional display text to show for the URL." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor" + ], + "appliesTo": [ + "ResourceUrlsEditor" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.ApplicationModel/ResourceUrlsEditor.executionContext", + "qualifiedName": "ResourceUrlsEditor.executionContext", + "description": "Gets the execution context associated with this editor.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "ResourceUrlsEditor", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ResourceUrlsEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ResourceUrlsEditor" + ], + "appliesTo": [ + "ResourceUrlsEditor" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "UpdateCommandStateContext", + "fullName": "Aspire.Hosting.ApplicationModel.UpdateCommandStateContext", + "kind": "handle", + "description": "Context for {@ats-ref method:ResourceCommandAnnotation.UpdateState}.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ResourceSnapshot", + "capabilityId": "Aspire.Hosting.ApplicationModel/UpdateCommandStateContext.resourceSnapshot", + "qualifiedName": "UpdateCommandStateContext.resourceSnapshot", + "description": "Gets the resource snapshot data available to polyglot command state callbacks.", + "kind": "PropertyGetter", + "signature": "ResourceSnapshot() (*UpdateCommandStateResourceSnapshot, error)", + "receiver": "UpdateCommandStateContext", + "parameters": [], + "returnType": "(*UpdateCommandStateResourceSnapshot, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.UpdateCommandStateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.UpdateCommandStateContext" + ], + "appliesTo": [ + "UpdateCommandStateContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.ApplicationModel/UpdateCommandStateContext.services", + "qualifiedName": "UpdateCommandStateContext.services", + "description": "The service provider.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "UpdateCommandStateContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.UpdateCommandStateContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.UpdateCommandStateContext" + ], + "appliesTo": [ + "UpdateCommandStateContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "EventingSubscriberRegistrationContext", + "fullName": "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "kind": "handle", + "description": "Context passed to ATS-friendly eventing subscriber registrations.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.Ats/EventingSubscriberRegistrationContext.cancellationToken", + "qualifiedName": "EventingSubscriberRegistrationContext.cancellationToken", + "description": "The cancellation token associated with the subscriber registration.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.Ats/EventingSubscriberRegistrationContext.executionContext", + "qualifiedName": "EventingSubscriberRegistrationContext.executionContext", + "description": "The execution context for the AppHost invocation.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnAfterPublish", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnAfterPublish", + "qualifiedName": "onAfterPublish", + "description": "Subscribes to the AfterPublish event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnAfterPublish(callback func(arg AfterPublishEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterPublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterPublishEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnAfterResourcesCreated", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnAfterResourcesCreated", + "qualifiedName": "onAfterResourcesCreated", + "description": "Subscribes to the AfterResourcesCreated event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnAfterResourcesCreated(callback func(arg AfterResourcesCreatedEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterResourcesCreatedEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterResourcesCreatedEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnBeforePublish", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnBeforePublish", + "qualifiedName": "onBeforePublish", + "description": "Subscribes to the BeforePublish event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnBeforePublish(callback func(arg BeforePublishEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforePublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforePublishEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + }, + { + "name": "OnBeforeStart", + "capabilityId": "Aspire.Hosting/eventingSubscriberOnBeforeStart", + "qualifiedName": "onBeforeStart", + "description": "Subscribes to the BeforeStart event from an eventing subscriber registration context.", + "returns": "The event subscription.", + "kind": "Method", + "signature": "OnBeforeStart(callback func(arg BeforeStartEvent)) DistributedApplicationEventSubscription", + "receiver": "EventingSubscriberRegistrationContext", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforeStartEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforeStartEvent)", + "description": "The callback to invoke when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.EventingSubscriberRegistrationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.EventingSubscriberRegistrationContext" + ], + "appliesTo": [ + "EventingSubscriberRegistrationContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InputsInteractionResult", + "fullName": "Aspire.Hosting.Ats.InputsInteractionResult", + "kind": "handle", + "description": "The result of a multi-input interaction prompt.", + "remarks": "Modeled as a handle (not a by-value DTO) so the returned inputs are surfaced as the\n`InteractionInputCollection` handle. That lets polyglot callers reuse the same name-based\naccessors (for example `result.inputs().value(\"color\")`) that the validation and command-argument\ncollections already expose, instead of having to scan a serialized array by hand.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Canceled", + "capabilityId": "Aspire.Hosting.Ats/InputsInteractionResult.canceled", + "qualifiedName": "InputsInteractionResult.canceled", + "description": "Gets a value indicating whether the interaction was canceled by the user.", + "kind": "PropertyGetter", + "signature": "Canceled() (bool, error)", + "receiver": "InputsInteractionResult", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InputsInteractionResult", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InputsInteractionResult" + ], + "appliesTo": [ + "InputsInteractionResult" + ] + }, + { + "name": "Inputs", + "capabilityId": "Aspire.Hosting.Ats/InputsInteractionResult.inputs", + "qualifiedName": "InputsInteractionResult.inputs", + "description": "Gets the inputs returned from the interaction. Empty when `Canceled` is `true`.", + "kind": "PropertyGetter", + "signature": "Inputs() InteractionInputCollection", + "receiver": "InputsInteractionResult", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InputsInteractionResult", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InputsInteractionResult" + ], + "appliesTo": [ + "InputsInteractionResult" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InteractionInputBuilder", + "fullName": "Aspire.Hosting.Ats.InteractionInputBuilder", + "kind": "handle", + "description": "An opaque, server-side builder for an `InteractionInput` used by polyglot AppHosts.", + "remarks": "The builder owns the live `InteractionInput` instance. Dynamic-loading callbacks mutate this same\ninstance through `InteractionInputLoadContext`, which is why the input is modeled as a handle here\ninstead of the by-value `InteractionInput` DTO.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ReleaseFiles", + "capabilityId": "Aspire.Hosting.Ats/releaseFiles", + "qualifiedName": "InteractionInputBuilder.releaseFiles", + "description": "Releases uploaded files associated with the input.", + "remarks": "Call this after processing the file paths returned by the prompt. Releasing the files deletes the\nserver-side temporary files before AppHost shutdown and is idempotent. Files that are not released are\ndeleted when the AppHost shuts down.", + "kind": "InstanceMethod", + "signature": "ReleaseFiles() error", + "receiver": "InteractionInputBuilder", + "parameters": [], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "WithChoiceOptions", + "capabilityId": "Aspire.Hosting.Ats/withChoiceOptions", + "qualifiedName": "InteractionInputBuilder.withChoiceOptions", + "description": "Sets the choice options for the input.", + "returns": "The same builder handle.", + "kind": "InstanceMethod", + "signature": "WithChoiceOptions(choices []*InteractionChoiceOption) InteractionInputBuilder", + "receiver": "InteractionInputBuilder", + "parameters": [ + { + "name": "choices", + "type": "[]*InteractionChoiceOption", + "description": "The available choices, in display order. Each option pairs a submitted value with a display label." + } + ], + "returnType": "InteractionInputBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "WithDynamicLoading", + "capabilityId": "Aspire.Hosting.Ats/withDynamicLoading", + "qualifiedName": "InteractionInputBuilder.withDynamicLoading", + "description": "Attaches a callback that dynamically loads or updates the input after the prompt starts.", + "returns": "The same builder handle.", + "kind": "InstanceMethod", + "signature": "WithDynamicLoading(callback func(arg InteractionInputLoadContext), options ...*DynamicLoadingOptions) InteractionInputBuilder", + "receiver": "InteractionInputBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg InteractionInputLoadContext)", + "isCallback": true, + "callbackSignature": "func(arg InteractionInputLoadContext)", + "description": "The callback invoked to load the input. Use the supplied context to read other inputs and update this input." + } + ], + "options": { + "typeName": "DynamicLoadingOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + }, + { + "name": "WithValue", + "capabilityId": "Aspire.Hosting.Ats/withValue", + "qualifiedName": "InteractionInputBuilder.withValue", + "description": "Sets the value of the input.", + "returns": "The same builder handle.", + "kind": "InstanceMethod", + "signature": "WithValue(value string) InteractionInputBuilder", + "receiver": "InteractionInputBuilder", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The value to assign." + } + ], + "returnType": "InteractionInputBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputBuilder" + ], + "appliesTo": [ + "InteractionInputBuilder" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InteractionInputLoadContext", + "fullName": "Aspire.Hosting.Ats.InteractionInputLoadContext", + "kind": "handle", + "description": "The context passed to a polyglot dynamic-loading callback. Exposes the loading input as a handle and provides read access to the other inputs in the prompt.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Input", + "capabilityId": "Aspire.Hosting.Ats/input", + "qualifiedName": "InteractionInputLoadContext.input", + "description": "Gets a handle to the input that is loading. Mutate the input through this handle.", + "remarks": "Mirrors the native `LoadInputContext.Input`: the callback updates the live input it is loading, rather than\nthe context itself. The input is a handle (not a by-value DTO) so guarded setters route back to the server-side\ninput across the ATS boundary.", + "returns": "A handle to the loading input.", + "kind": "InstanceMethod", + "signature": "Input() InteractionLoadingInput", + "receiver": "InteractionInputLoadContext", + "parameters": [], + "returnType": "InteractionLoadingInput", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputLoadContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputLoadContext" + ], + "appliesTo": [ + "InteractionInputLoadContext" + ] + }, + { + "name": "Inputs", + "capabilityId": "Aspire.Hosting.Ats/InteractionInputLoadContext.inputs", + "qualifiedName": "InteractionInputLoadContext.inputs", + "description": "Gets all inputs in the prompt, including the one currently loading.", + "remarks": "Mirrors the native `LoadInputContext.AllInputs`. Use the collection's by-name accessors (for example\n`value` or `requiredValue`) to read the dependency inputs declared via\n`DependsOnInputs`. This is the same `InteractionInputCollection`\nidiom used by the validation callback and prompt results, so reading inputs by name is consistent across every\ncallback context. This is exposed as a property (rather than a method) so it routes through the generated\ncollection accessor, matching the other contexts that surface an `InteractionInputCollection`.", + "kind": "PropertyGetter", + "signature": "Inputs() InteractionInputCollection", + "receiver": "InteractionInputLoadContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionInputLoadContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionInputLoadContext" + ], + "appliesTo": [ + "InteractionInputLoadContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InteractionLoadingInput", + "fullName": "Aspire.Hosting.Ats.InteractionLoadingInput", + "kind": "handle", + "description": "A handle to the input currently being loaded by a dynamic-loading callback. Mirrors the native `LoadInputContext.Input` by letting callbacks update the live input directly.", + "remarks": "The handle owns the live `InteractionInput` for the duration of the load callback. Setters are routed\nback to the server-side input across the ATS boundary, which is why this is a handle rather than the by-value\n`InteractionInput` DTO.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "GetName", + "capabilityId": "Aspire.Hosting.Ats/getName", + "qualifiedName": "InteractionLoadingInput.getName", + "description": "Gets the name of the input.", + "returns": "The input name.", + "kind": "InstanceMethod", + "signature": "GetName() (string, error)", + "receiver": "InteractionLoadingInput", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionLoadingInput", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionLoadingInput" + ], + "appliesTo": [ + "InteractionLoadingInput" + ] + }, + { + "name": "SetChoiceOptions", + "capabilityId": "Aspire.Hosting.Ats/setChoiceOptions", + "qualifiedName": "InteractionLoadingInput.setChoiceOptions", + "description": "Sets the choice options for the input.", + "kind": "InstanceMethod", + "signature": "SetChoiceOptions(choices []*InteractionChoiceOption) error", + "receiver": "InteractionLoadingInput", + "parameters": [ + { + "name": "choices", + "type": "[]*InteractionChoiceOption", + "description": "The available choices, in display order. Each option pairs a submitted value with a display label." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionLoadingInput", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionLoadingInput" + ], + "appliesTo": [ + "InteractionLoadingInput" + ] + }, + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting.Ats/setValue", + "qualifiedName": "InteractionLoadingInput.setValue", + "description": "Sets the value of the input.", + "kind": "InstanceMethod", + "signature": "SetValue(value string) error", + "receiver": "InteractionLoadingInput", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The value to assign." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Ats.InteractionLoadingInput", + "expandedTargetTypes": [ + "Aspire.Hosting.Ats.InteractionLoadingInput" + ], + "appliesTo": [ + "InteractionLoadingInput" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplication", + "fullName": "Aspire.Hosting.DistributedApplication", + "kind": "handle", + "description": "Represents a distributed application that implements the {@ats-ref type:IHost} and {@ats-ref type:IAsyncDisposable} interfaces.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Run", + "capabilityId": "Aspire.Hosting/run", + "qualifiedName": "DistributedApplication.run", + "description": "Runs the distributed application", + "remarks": "When the Aspire AppHost is launched via `RunAsync` there are\ntwo possible modes that it is running in:\n-\n-\nDevelopers extending the Aspire application model should consider the lifetime\nof `IHostedService` instances which are added to the dependency injection\ncontainer. For more information on determining the mode that the AppHost is running\nin refer to `DistributedApplicationExecutionContext`.", + "returns": "The `Task` that represents the asynchronous operation.", + "kind": "InstanceMethod", + "signature": "Run(options ...*RunOptions) error", + "receiver": "DistributedApplication", + "parameters": [], + "options": { + "typeName": "RunOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The token to trigger shutdown." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplication", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplication" + ], + "appliesTo": [ + "DistributedApplication" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationExecutionContext", + "fullName": "Aspire.Hosting.DistributedApplicationExecutionContext", + "kind": "handle", + "description": "Exposes the global contextual information for this invocation of the AppHost.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "IsPublishMode", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.isPublishMode", + "qualifiedName": "DistributedApplicationExecutionContext.isPublishMode", + "description": "Returns true if the current operation is publishing.", + "kind": "PropertyGetter", + "signature": "IsPublishMode() (bool, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "IsRunMode", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.isRunMode", + "qualifiedName": "DistributedApplicationExecutionContext.isRunMode", + "description": "Returns true if the current operation is running.", + "kind": "PropertyGetter", + "signature": "IsRunMode() (bool, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "Operation", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.operation", + "qualifiedName": "DistributedApplicationExecutionContext.operation", + "description": "The operation currently being performed by the AppHost.", + "kind": "PropertyGetter", + "signature": "Operation() (DistributedApplicationOperation, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(DistributedApplicationOperation, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "PublisherName", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.publisherName", + "qualifiedName": "DistributedApplicationExecutionContext.publisherName", + "description": "The name of the publisher that is being used if `Operation` is set to `Publish`.", + "kind": "PropertyGetter", + "signature": "PublisherName() (string, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "RunConfiguration", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.runConfiguration", + "qualifiedName": "DistributedApplicationExecutionContext.runConfiguration", + "description": "Describes how the AppHost is being run. Only meaningful when `Operation` is `Run`; otherwise every aspect holds its default value.", + "kind": "PropertyGetter", + "signature": "RunConfiguration() (*RunConfiguration, error)", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "(*RunConfiguration, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "ServiceProvider", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.serviceProvider", + "qualifiedName": "DistributedApplicationExecutionContext.serviceProvider", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "ServiceProvider() ServiceProvider", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.services", + "qualifiedName": "DistributedApplicationExecutionContext.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + }, + { + "name": "SetPublisherName", + "capabilityId": "Aspire.Hosting/DistributedApplicationExecutionContext.setPublisherName", + "qualifiedName": "DistributedApplicationExecutionContext.setPublisherName", + "description": "The name of the publisher that is being used if `Operation` is set to `Publish`.", + "kind": "PropertySetter", + "signature": "SetPublisherName(value string) DistributedApplicationExecutionContext", + "receiver": "DistributedApplicationExecutionContext", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The name of the publisher that is being used if `Operation` is set to `Publish`." + } + ], + "returnType": "DistributedApplicationExecutionContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.DistributedApplicationExecutionContext", + "expandedTargetTypes": [ + "Aspire.Hosting.DistributedApplicationExecutionContext" + ], + "appliesTo": [ + "DistributedApplicationExecutionContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationExecutionContextOptions", + "fullName": "Aspire.Hosting.DistributedApplicationExecutionContextOptions", + "kind": "handle", + "description": "Configuration options and references that need to be exposed to the {@ats-ref type:DistributedApplicationExecutionContext}.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationEventSubscription", + "fullName": "Aspire.Hosting.Eventing.DistributedApplicationEventSubscription", + "kind": "handle", + "description": "Represents a subscription to an event that is published during the lifecycle of the AppHost.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationResourceEventSubscription", + "fullName": "Aspire.Hosting.Eventing.DistributedApplicationResourceEventSubscription", + "kind": "handle", + "description": "Represents a subscription to an event that is published during the lifecycle of the AppHost for a specific resource.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationEvent", + "fullName": "Aspire.Hosting.Eventing.IDistributedApplicationEvent", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents an event that is published during the lifecycle of the AppHost.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationEventing", + "fullName": "Aspire.Hosting.Eventing.IDistributedApplicationEventing", + "kind": "handle", + "isInterface": true, + "description": "Supports publishing and subscribing to events which are executed during the AppHost lifecycle.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Unsubscribe", + "capabilityId": "Aspire.Hosting.Eventing/IDistributedApplicationEventing.unsubscribe", + "qualifiedName": "IDistributedApplicationEventing.unsubscribe", + "description": "Unsubscribe from an event.", + "kind": "InstanceMethod", + "signature": "Unsubscribe(subscription DistributedApplicationEventSubscription) error", + "receiver": "DistributedApplicationEventing", + "parameters": [ + { + "name": "subscription", + "type": "DistributedApplicationEventSubscription", + "description": "The specific subscription to unsubscribe." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Eventing.IDistributedApplicationEventing", + "expandedTargetTypes": [ + "Aspire.Hosting.Eventing.IDistributedApplicationEventing" + ], + "appliesTo": [ + "DistributedApplicationEventing" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationResourceEvent", + "fullName": "Aspire.Hosting.Eventing.IDistributedApplicationResourceEvent", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents an event that is published during the lifecycle of the AppHost for a specific resource.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ExternalServiceResource", + "fullName": "Aspire.Hosting.ExternalServiceResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithHttpHealthCheck", + "capabilityId": "Aspire.Hosting/withExternalServiceHttpHealthCheck", + "qualifiedName": "withHttpHealthCheck", + "description": "Adds an HTTP health check to the external service for polyglot AppHosts.", + "kind": "Method", + "signature": "WithHttpHealthCheck(options ...*WithHttpHealthCheckOptions) ExternalServiceResource", + "receiver": "ExternalServiceResource", + "parameters": [], + "options": { + "typeName": "WithHttpHealthCheckOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string" + }, + { + "name": "StatusCode", + "jsonName": "statusCode", + "type": "*float64" + }, + { + "name": "EndpointName", + "jsonName": "endpointName", + "type": "*string" + } + ] + }, + "returnType": "ExternalServiceResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ExternalServiceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ExternalServiceResource" + ], + "appliesTo": [ + "ExternalServiceResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DistributedApplicationBuilder", + "fullName": "Aspire.Hosting.IDistributedApplicationBuilder", + "kind": "handle", + "isInterface": true, + "description": "A builder for creating instances of {@ats-ref type:DistributedApplication}.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AppHostDirectory", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.appHostDirectory", + "qualifiedName": "IDistributedApplicationBuilder.appHostDirectory", + "description": "Directory of the project where the AppHost is located. Defaults to the content root if there's no project.", + "kind": "PropertyGetter", + "signature": "AppHostDirectory() (string, error)", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting/build", + "qualifiedName": "IDistributedApplicationBuilder.build", + "description": "Builds the distributed application", + "remarks": "Callers of the `Build` method should only call it once. are responsible for the lifecycle of the\n`DistributedApplication` instance that is returned. Note that the `DistributedApplication`\ntype implements `IDisposable` and should be disposed of when it is no longer needed. Note that in\nmany templates and samples Dispose is omitted for brevity because in those cases the instance is destroyed\nwhen the process exists.", + "returns": "A new `DistributedApplication` instance.", + "kind": "InstanceMethod", + "signature": "Build() (DistributedApplication, error)", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "(DistributedApplication, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.environment", + "qualifiedName": "IDistributedApplicationBuilder.environment", + "description": "Gets the Environment property", + "kind": "PropertyGetter", + "signature": "Environment() HostEnvironment", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "HostEnvironment", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Eventing", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.eventing", + "qualifiedName": "IDistributedApplicationBuilder.eventing", + "description": "Eventing infrastructure for AppHost lifecycle.", + "kind": "PropertyGetter", + "signature": "Eventing() DistributedApplicationEventing", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationEventing", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.executionContext", + "qualifiedName": "IDistributedApplicationBuilder.executionContext", + "description": "Execution context for this invocation of the AppHost.", + "remarks": "Use this property to determine whether the AppHost is running locally or publishing\ndeployment artifacts, and adjust the application model accordingly.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "Pipeline", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.pipeline", + "qualifiedName": "IDistributedApplicationBuilder.pipeline", + "description": "Gets the deployment pipeline for this distributed application.", + "remarks": "The pipeline allows adding custom deployment steps that execute during the deploy process.\nSteps can declare dependencies on other steps to control execution order.", + "kind": "PropertyGetter", + "signature": "Pipeline() DistributedApplicationPipeline", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationPipeline", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "UserSecretsManager", + "capabilityId": "Aspire.Hosting/IDistributedApplicationBuilder.userSecretsManager", + "qualifiedName": "IDistributedApplicationBuilder.userSecretsManager", + "description": "Gets the service for managing user secrets.", + "remarks": "The `UserSecretsManager` provides a centralized way to manage user secrets\nused by Aspire, enabling testability and consistent secret management.", + "kind": "PropertyGetter", + "signature": "UserSecretsManager() UserSecretsManager", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "UserSecretsManager", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddCSharpApp", + "capabilityId": "Aspire.Hosting/addCSharpApp", + "qualifiedName": "addCSharpApp", + "description": "Adds a C# application resource", + "kind": "Method", + "signature": "AddCSharpApp(name string, path string, options ...*AddCSharpAppOptions) CSharpAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "path", + "type": "string" + } + ], + "options": { + "typeName": "AddCSharpAppOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*ProjectResourceOptions" + } + ] + }, + "returnType": "CSharpAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddConnectionString", + "capabilityId": "Aspire.Hosting/addConnectionString", + "qualifiedName": "addConnectionString", + "description": "Adds a connection string resource", + "kind": "Method", + "signature": "AddConnectionString(name string, options ...*AddConnectionStringOptions) ResourceWithConnectionString", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddConnectionStringOptions", + "fields": [ + { + "name": "EnvironmentVariableNameOrExpression", + "jsonName": "environmentVariableNameOrExpression", + "type": "any" + } + ] + }, + "returnType": "ResourceWithConnectionString", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddContainer", + "capabilityId": "Aspire.Hosting/addContainer", + "qualifiedName": "addContainer", + "description": "Adds a container resource to the application.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddContainer(name string, image any) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "image", + "type": "any", + "allowedTypes": [ + "string", + "*AddContainerOptions" + ], + "description": "The image name or image options for the container." + } + ], + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddContainerRegistry", + "capabilityId": "Aspire.Hosting/addContainerRegistry", + "qualifiedName": "addContainerRegistry", + "description": "Adds a container registry resource", + "kind": "Method", + "signature": "AddContainerRegistry(name string, endpoint any, options ...*AddContainerRegistryOptions) ContainerRegistryResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "endpoint", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "options": { + "typeName": "AddContainerRegistryOptions", + "fields": [ + { + "name": "Repository", + "jsonName": "repository", + "type": "any" + } + ] + }, + "returnType": "ContainerRegistryResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDockerfile", + "capabilityId": "Aspire.Hosting/addDockerfile", + "qualifiedName": "addDockerfile", + "description": "Adds a Dockerfile to the application model that can be treated like a container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerfile(name string, contextPath string, options ...*AddDockerfileOptions) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + } + ], + "options": { + "typeName": "AddDockerfileOptions", + "fields": [ + { + "name": "DockerfilePath", + "jsonName": "dockerfilePath", + "type": "*string", + "description": "Path to the Dockerfile relative to the `contextPath`. Defaults to \"Dockerfile\" if not specified." + }, + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDockerfileBuilder", + "capabilityId": "Aspire.Hosting/addDockerfileBuilder", + "qualifiedName": "addDockerfileBuilder", + "description": "Adds a container resource built from a programmatically generated Dockerfile", + "remarks": "This method provides a programmatic way to build Dockerfiles using the `DockerfileBuilder` API\ninstead of string manipulation.\nThe `contextPath` is relative to the AppHost directory unless it is fully qualified.\nCreates a container with a programmatically built Dockerfile:\n```\nvar builder = DistributedApplication.CreateBuilder(args);\nbuilder.AddDockerfileBuilder(\"mycontainer\", \"path/to/context\", context =>\n{\ncontext.Builder.From(\"alpine:latest\")\n.WorkDir(\"/app\")\n.Copy(\".\", \".\")\n.Cmd([\"./myapp\"]);\nreturn Task.CompletedTask;\n});\nbuilder.Build().Run();\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerfileBuilder(name string, contextPath string, callback func(arg DockerfileBuilderCallbackContext), options ...*AddDockerfileBuilderOptions) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "callback", + "type": "func(arg DockerfileBuilderCallbackContext)", + "isCallback": true, + "callbackSignature": "func(arg DockerfileBuilderCallbackContext)", + "description": "A callback that uses the `DockerfileBuilder` API to construct the Dockerfile." + } + ], + "options": { + "typeName": "AddDockerfileBuilderOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDockerfileFactory", + "capabilityId": "Aspire.Hosting/addDockerfileFactory", + "qualifiedName": "addDockerfileFactory", + "description": "Adds a Dockerfile to the application model that can be treated like a container resource, with the Dockerfile content generated by an asynchronous factory function.", + "remarks": "The `contextPath` is relative to the AppHost directory unless it is fully qualified.\nThe factory function is invoked once during the build process to generate the Dockerfile content.\nThe output is trusted and not validated.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerfileFactory(name string, contextPath string, dockerfileFactory func(arg DockerfileFactoryContext) string, options ...*AddDockerfileFactoryOptions) ContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "contextPath", + "type": "string", + "description": "Path to be used as the context for the container image build." + }, + { + "name": "dockerfileFactory", + "type": "func(arg DockerfileFactoryContext) string", + "isCallback": true, + "callbackSignature": "func(arg DockerfileFactoryContext) string", + "description": "An asynchronous function that returns the Dockerfile content as a string." + } + ], + "options": { + "typeName": "AddDockerfileFactoryOptions", + "fields": [ + { + "name": "Stage", + "jsonName": "stage", + "type": "*string", + "description": "The stage representing the image to be published in a multi-stage Dockerfile." + } + ] + }, + "returnType": "ContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDotnetTool", + "capabilityId": "Aspire.Hosting/addDotnetTool", + "qualifiedName": "addDotnetTool", + "description": "Adds a .NET tool resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDotnetTool(name string, packageId string) DotnetToolResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "packageId", + "type": "string", + "description": "The package id of the tool." + } + ], + "returnType": "DotnetToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddEventingSubscriber", + "capabilityId": "Aspire.Hosting/addEventingSubscriber", + "qualifiedName": "addEventingSubscriber", + "description": "Adds an ATS-friendly eventing subscriber callback to the distributed-application builder.", + "kind": "Method", + "signature": "AddEventingSubscriber(subscribe func(arg EventingSubscriberRegistrationContext)) error", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "subscribe", + "type": "func(arg EventingSubscriberRegistrationContext)", + "isCallback": true, + "callbackSignature": "func(arg EventingSubscriberRegistrationContext)", + "description": "The callback that registers the event subscriptions." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddExecutable", + "capabilityId": "Aspire.Hosting/addExecutable", + "qualifiedName": "addExecutable", + "description": "Adds an executable resource to the application model.", + "remarks": "You can run any executable command using its full path.\nAs a security feature, Aspire doesn't run executable unless the command is located in a path listed in the PATH environment variable.\nTo run an executable file that's in the current directory, specify the full path or use the relative path `./` to represent the current directory.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddExecutable(name string, command string, workingDirectory string, args []string) ExecutableResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "command", + "type": "string", + "description": "The executable path. This can be a fully qualified path or a executable to run from the shell/command line." + }, + { + "name": "workingDirectory", + "type": "string", + "description": "The working directory of the executable." + }, + { + "name": "args", + "type": "[]string", + "description": "The arguments to the executable." + } + ], + "returnType": "ExecutableResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddExternalService", + "capabilityId": "Aspire.Hosting/addExternalService", + "qualifiedName": "addExternalService", + "description": "Adds an external service resource", + "kind": "Method", + "signature": "AddExternalService(name string, url any) ExternalServiceResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "url", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "ExternalServiceResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddHealthCheck", + "capabilityId": "Aspire.Hosting/addHealthCheck", + "qualifiedName": "addHealthCheck", + "description": "Adds a custom health check callback to the distributed-application builder.", + "kind": "Method", + "signature": "AddHealthCheck(name string, check func(...any) *HealthCheckResult) error", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The health check registration name." + }, + { + "name": "check", + "type": "func(...any) *HealthCheckResult", + "isCallback": true, + "callbackSignature": "func(...any) *HealthCheckResult", + "description": "The callback that evaluates the health check." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddParameter", + "capabilityId": "Aspire.Hosting/addParameter", + "qualifiedName": "addParameter", + "description": "Adds a parameter resource", + "kind": "Method", + "signature": "AddParameter(name string, options ...*AddParameterOptions) ParameterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddParameterOptions", + "fields": [ + { + "name": "Value", + "jsonName": "value", + "type": "*string" + }, + { + "name": "PublishValueAsDefault", + "jsonName": "publishValueAsDefault", + "type": "*bool" + }, + { + "name": "Secret", + "jsonName": "secret", + "type": "*bool" + } + ] + }, + "returnType": "ParameterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddParameterFromConfiguration", + "capabilityId": "Aspire.Hosting/addParameterFromConfiguration", + "qualifiedName": "addParameterFromConfiguration", + "description": "Adds a parameter resource to the application, with a value coming from configuration.", + "returns": "Resource builder for the parameter.", + "kind": "Method", + "signature": "AddParameterFromConfiguration(name string, configurationKey string, options ...*AddParameterFromConfigurationOptions) ParameterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "Name of parameter resource" + }, + { + "name": "configurationKey", + "type": "string", + "description": "Configuration key used to get the value of the parameter" + } + ], + "options": { + "typeName": "AddParameterFromConfigurationOptions", + "fields": [ + { + "name": "Secret", + "jsonName": "secret", + "type": "*bool", + "description": "Optional flag indicating whether the parameter should be regarded as secret." + } + ] + }, + "returnType": "ParameterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddParameterWithGeneratedValue", + "capabilityId": "Aspire.Hosting/addParameterWithGeneratedValue", + "qualifiedName": "addParameterWithGeneratedValue", + "description": "Adds a parameter with a generated default value", + "kind": "Method", + "signature": "AddParameterWithGeneratedValue(name string, value *GenerateParameterDefault, options ...*AddParameterWithGeneratedValueOptions) ParameterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "*GenerateParameterDefault" + } + ], + "options": { + "typeName": "AddParameterWithGeneratedValueOptions", + "fields": [ + { + "name": "Secret", + "jsonName": "secret", + "type": "*bool" + }, + { + "name": "Persist", + "jsonName": "persist", + "type": "*bool" + } + ] + }, + "returnType": "ParameterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddProject", + "capabilityId": "Aspire.Hosting/addProject", + "qualifiedName": "addProject", + "description": "Adds a .NET project resource", + "kind": "Method", + "signature": "AddProject(name string, projectPath string, options ...*AddProjectOptions) ProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "projectPath", + "type": "string" + } + ], + "options": { + "typeName": "AddProjectOptions", + "fields": [ + { + "name": "LaunchProfileOrOptions", + "jsonName": "launchProfileOrOptions", + "type": "any" + } + ] + }, + "returnType": "ProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "GetConfiguration", + "capabilityId": "Aspire.Hosting/getConfiguration", + "qualifiedName": "getConfiguration", + "description": "Gets the application configuration.", + "returns": "The configuration handle.", + "kind": "Method", + "signature": "GetConfiguration() Configuration", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "Configuration", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeAfterPublish", + "capabilityId": "Aspire.Hosting/subscribeAfterPublish", + "qualifiedName": "subscribeAfterPublish", + "description": "Subscribes to the AfterPublish event, which fires after the application is published.", + "remarks": "This event provides access to the service provider and distributed application model,\nallowing you to inspect the model after publish pipeline steps complete.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeAfterPublish(callback func(arg AfterPublishEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterPublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterPublishEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeAfterResourcesCreated", + "capabilityId": "Aspire.Hosting/subscribeAfterResourcesCreated", + "qualifiedName": "subscribeAfterResourcesCreated", + "description": "Subscribes to the AfterResourcesCreated event, which fires after all resources are created.", + "remarks": "At this point, all resources have been instantiated but may not yet be running.\nThis is useful for performing cross-resource configuration.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeAfterResourcesCreated(callback func(arg AfterResourcesCreatedEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg AfterResourcesCreatedEvent)", + "isCallback": true, + "callbackSignature": "func(arg AfterResourcesCreatedEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeBeforePublish", + "capabilityId": "Aspire.Hosting/subscribeBeforePublish", + "qualifiedName": "subscribeBeforePublish", + "description": "Subscribes to the BeforePublish event, which fires before the application is published.", + "remarks": "This event provides access to the service provider and distributed application model,\nallowing you to perform final configuration or validation before publish pipeline steps run.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeBeforePublish(callback func(arg BeforePublishEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforePublishEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforePublishEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "SubscribeBeforeStart", + "capabilityId": "Aspire.Hosting/subscribeBeforeStart", + "qualifiedName": "subscribeBeforeStart", + "description": "Subscribes to the BeforeStart event, which fires before the application starts.", + "remarks": "This event provides access to the service provider and distributed application model,\nallowing you to perform final configuration or validation before resources start.", + "returns": "A subscription handle that can be used to unsubscribe.", + "kind": "Method", + "signature": "SubscribeBeforeStart(callback func(arg BeforeStartEvent)) DistributedApplicationEventSubscription", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "callback", + "type": "func(arg BeforeStartEvent)", + "isCallback": true, + "callbackSignature": "func(arg BeforeStartEvent)", + "description": "A callback that receives the exported event when the event fires." + } + ], + "returnType": "DistributedApplicationEventSubscription", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "TryAddEventingSubscriber", + "capabilityId": "Aspire.Hosting/tryAddEventingSubscriber", + "qualifiedName": "tryAddEventingSubscriber", + "description": "Attempts to add an ATS-friendly eventing subscriber callback to the distributed-application builder.", + "kind": "Method", + "signature": "TryAddEventingSubscriber(subscribe func(arg EventingSubscriberRegistrationContext)) error", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "subscribe", + "type": "func(arg EventingSubscriberRegistrationContext)", + "isCallback": true, + "callbackSignature": "func(arg EventingSubscriberRegistrationContext)", + "description": "The callback that registers the event subscriptions." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InteractionService", + "fullName": "Aspire.Hosting.IInteractionService", + "kind": "handle", + "isInterface": true, + "description": "A service to interact with the current development environment.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CreateBooleanInput", + "capabilityId": "Aspire.Hosting/createBooleanInput", + "qualifiedName": "createBooleanInput", + "description": "Creates a boolean (checkbox) input.", + "kind": "Method", + "signature": "CreateBooleanInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateChoiceInput", + "capabilityId": "Aspire.Hosting/createChoiceInput", + "qualifiedName": "createChoiceInput", + "description": "Creates a choice input that selects from a list of options.", + "kind": "Method", + "signature": "CreateChoiceInput(name string, options ...*CreateChoiceInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the input." + } + ], + "options": { + "typeName": "CreateChoiceInputOptions", + "fields": [ + { + "name": "Choices", + "jsonName": "choices", + "type": "[]*InteractionChoiceOption", + "description": "The available choices, in display order. Each option pairs a submitted value with a display label." + }, + { + "name": "Options", + "jsonName": "options", + "type": "*CreateInteractionInputOptions", + "description": "Optional configuration for the input." + } + ] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateFileInput", + "capabilityId": "Aspire.Hosting/createFileInput", + "qualifiedName": "createFileInput", + "description": "Creates a file input.", + "kind": "Method", + "signature": "CreateFileInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateNumberInput", + "capabilityId": "Aspire.Hosting/createNumberInput", + "qualifiedName": "createNumberInput", + "description": "Creates a numeric input.", + "kind": "Method", + "signature": "CreateNumberInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateSecretInput", + "capabilityId": "Aspire.Hosting/createSecretInput", + "qualifiedName": "createSecretInput", + "description": "Creates a secret (masked) text input.", + "kind": "Method", + "signature": "CreateSecretInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "CreateTextInput", + "capabilityId": "Aspire.Hosting/createTextInput", + "qualifiedName": "createTextInput", + "description": "Creates a single-line text input.", + "kind": "Method", + "signature": "CreateTextInput(name string, options ...*CreateInteractionInputOptions) InteractionInputBuilder", + "receiver": "InteractionService", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "CreateInteractionInputOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "InteractionInputBuilder", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "IsAvailable", + "capabilityId": "Aspire.Hosting/isAvailable", + "qualifiedName": "isAvailable", + "description": "Gets a value indicating whether the interaction service is available to prompt the user.", + "returns": "`true` when the service can prompt the user; otherwise `false`.", + "kind": "Method", + "signature": "IsAvailable() (bool, error)", + "receiver": "InteractionService", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptConfirmation", + "capabilityId": "Aspire.Hosting/promptConfirmation", + "qualifiedName": "promptConfirmation", + "description": "Prompts the user for confirmation with an OK/Cancel dialog.", + "kind": "Method", + "signature": "PromptConfirmation(title string, message string, options ...*PromptConfirmationOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptConfirmationOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionMessageBoxOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptInput", + "capabilityId": "Aspire.Hosting/promptInput", + "qualifiedName": "promptInput", + "description": "Prompts the user for a single input.", + "kind": "Method", + "signature": "PromptInput(title string, message string, input InteractionInputBuilder, options ...*PromptInputOptions) (*InputInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + }, + { + "name": "input", + "type": "InteractionInputBuilder" + } + ], + "options": { + "typeName": "PromptInputOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionInputsDialogOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*InputInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptInputs", + "capabilityId": "Aspire.Hosting/promptInputs", + "qualifiedName": "promptInputs", + "description": "Prompts the user for multiple inputs.", + "kind": "Method", + "signature": "PromptInputs(title string, message string, inputs []InteractionInputBuilder, options ...*PromptInputsOptions) InputsInteractionResult", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + }, + { + "name": "inputs", + "type": "[]InteractionInputBuilder" + } + ], + "options": { + "typeName": "PromptInputsOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionInputsDialogOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "InputsInteractionResult", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptMessageBox", + "capabilityId": "Aspire.Hosting/promptMessageBox", + "qualifiedName": "promptMessageBox", + "description": "Prompts the user with a message box dialog.", + "kind": "Method", + "signature": "PromptMessageBox(title string, message string, options ...*PromptMessageBoxOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptMessageBoxOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionMessageBoxOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptNotification", + "capabilityId": "Aspire.Hosting/promptNotification", + "qualifiedName": "promptNotification", + "description": "Prompts the user with a notification.", + "kind": "Method", + "signature": "PromptNotification(title string, message string, options ...*PromptNotificationOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "title", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptNotificationOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionNotificationOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + }, + { + "name": "PromptProgress", + "capabilityId": "Aspire.Hosting/promptProgress", + "qualifiedName": "promptProgress", + "description": "Displays a progress dialog with an indeterminate progress indicator.", + "kind": "Method", + "signature": "PromptProgress(message string, options ...*PromptProgressOptions) (*BoolInteractionResult, error)", + "receiver": "InteractionService", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "options": { + "typeName": "PromptProgressOptions", + "fields": [ + { + "name": "Options", + "jsonName": "options", + "type": "*InteractionProgressOptions" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "(*BoolInteractionResult, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IInteractionService", + "expandedTargetTypes": [ + "Aspire.Hosting.IInteractionService" + ], + "appliesTo": [ + "InteractionService" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ResourceWithContainerFiles", + "fullName": "Aspire.Hosting.IResourceWithContainerFiles", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ClearContainerFilesSources", + "capabilityId": "Aspire.Hosting/clearContainerFilesSources", + "qualifiedName": "clearContainerFilesSources", + "description": "Removes any container files source annotation from the resource being built.", + "returns": "The resource builder instance with the container files source annotation applied.", + "kind": "Method", + "signature": "ClearContainerFilesSources() ResourceWithContainerFiles", + "receiver": "ResourceWithContainerFiles", + "parameters": [], + "returnType": "ResourceWithContainerFiles", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IResourceWithContainerFiles", + "expandedTargetTypes": [ + "Aspire.Hosting.IResourceWithContainerFiles" + ], + "appliesTo": [ + "ResourceWithContainerFiles" + ] + }, + { + "name": "WithContainerFilesSource", + "capabilityId": "Aspire.Hosting/withContainerFilesSource", + "qualifiedName": "withContainerFilesSource", + "description": "Adds a container files source annotation to the resource being built, specifying the path to the container files source.", + "returns": "The resource builder instance with the container files source annotation applied.", + "kind": "Method", + "signature": "WithContainerFilesSource(sourcePath string) ResourceWithContainerFiles", + "receiver": "ResourceWithContainerFiles", + "parameters": [ + { + "name": "sourcePath", + "type": "string", + "description": "The path to the container files source to associate with the resource. Cannot be null." + } + ], + "returnType": "ResourceWithContainerFiles", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IResourceWithContainerFiles", + "expandedTargetTypes": [ + "Aspire.Hosting.IResourceWithContainerFiles" + ], + "appliesTo": [ + "ResourceWithContainerFiles" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "UserSecretsManager", + "fullName": "Aspire.Hosting.IUserSecretsManager", + "kind": "handle", + "isInterface": true, + "description": "Defines an interface for managing user secrets with support for read and write operations.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "FilePath", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.filePath", + "qualifiedName": "IUserSecretsManager.filePath", + "description": "Gets the path to the user secrets file.", + "kind": "PropertyGetter", + "signature": "FilePath() (string, error)", + "receiver": "UserSecretsManager", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "IsAvailable", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.isAvailable", + "qualifiedName": "IUserSecretsManager.isAvailable", + "description": "Gets a value indicating whether user secrets are available.", + "remarks": "Returns `true` if the project has a user secrets ID configured; otherwise, `false`.", + "kind": "PropertyGetter", + "signature": "IsAvailable() (bool, error)", + "receiver": "UserSecretsManager", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "TryDeleteSecret", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.tryDeleteSecret", + "qualifiedName": "IUserSecretsManager.tryDeleteSecret", + "description": "Attempts to delete a user secret value synchronously.", + "remarks": "The default implementation returns `false` so existing implementations remain compatible.", + "returns": "True if the secret was deleted successfully; otherwise, false.", + "kind": "InstanceMethod", + "signature": "TryDeleteSecret(name string) (bool, error)", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "TrySetSecret", + "capabilityId": "Aspire.Hosting/IUserSecretsManager.trySetSecret", + "qualifiedName": "IUserSecretsManager.trySetSecret", + "description": "Attempts to set a user secret value synchronously.", + "returns": "True if the secret was set successfully; otherwise, false.", + "kind": "InstanceMethod", + "signature": "TrySetSecret(name string, value string) (bool, error)", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret." + }, + { + "name": "value", + "type": "string", + "description": "The value of the secret." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "GetOrSetSecret", + "capabilityId": "Aspire.Hosting/getOrSetSecret", + "qualifiedName": "getOrSetSecret", + "description": "Gets a secret value if it exists in configuration, or sets it to the provided value if it does not.", + "kind": "Method", + "signature": "GetOrSetSecret(resourceBuilder Resource, name string, value string) error", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "resourceBuilder", + "type": "Resource", + "description": "A resource builder from the target application." + }, + { + "name": "name", + "type": "string", + "description": "The secret name." + }, + { + "name": "value", + "type": "string", + "description": "The value to persist when the secret is missing." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + }, + { + "name": "SaveStateJson", + "capabilityId": "Aspire.Hosting/saveStateJson", + "qualifiedName": "saveStateJson", + "description": "Saves state to user secrets from a JSON string.", + "returns": "A task that completes when the state is saved.", + "kind": "Method", + "signature": "SaveStateJson(json string, options ...*SaveStateJsonOptions) error", + "receiver": "UserSecretsManager", + "parameters": [ + { + "name": "json", + "type": "string", + "description": "The JSON object payload to persist." + } + ], + "options": { + "typeName": "SaveStateJsonOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken", + "description": "The cancellation token." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IUserSecretsManager", + "expandedTargetTypes": [ + "Aspire.Hosting.IUserSecretsManager" + ], + "appliesTo": [ + "UserSecretsManager" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InputsDialogValidationContext", + "fullName": "Aspire.Hosting.InputsDialogValidationContext", + "kind": "handle", + "description": "Represents the context for validating inputs in an inputs dialog interaction.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AddValidationError", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.addValidationError", + "qualifiedName": "InputsDialogValidationContext.addValidationError", + "description": "Adds a validation error for the input with the specified name.", + "kind": "InstanceMethod", + "signature": "AddValidationError(inputName string, errorMessage string) error", + "receiver": "InputsDialogValidationContext", + "parameters": [ + { + "name": "inputName", + "type": "string", + "description": "The name of the input to add a validation error for." + }, + { + "name": "errorMessage", + "type": "string", + "description": "The error message to add." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.cancellationToken", + "qualifiedName": "InputsDialogValidationContext.cancellationToken", + "description": "Gets the cancellation token for the validation operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "InputsDialogValidationContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "Inputs", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.inputs", + "qualifiedName": "InputsDialogValidationContext.inputs", + "description": "Gets the inputs that are being validated.", + "kind": "PropertyGetter", + "signature": "Inputs() InteractionInputCollection", + "receiver": "InputsDialogValidationContext", + "parameters": [], + "returnType": "InteractionInputCollection", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting/InputsDialogValidationContext.services", + "qualifiedName": "InputsDialogValidationContext.services", + "description": "Gets the service provider for resolving services during validation.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "InputsDialogValidationContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InputsDialogValidationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.InputsDialogValidationContext" + ], + "appliesTo": [ + "InputsDialogValidationContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "InteractionInputCollection", + "fullName": "Aspire.Hosting.InteractionInputCollection", + "kind": "handle", + "description": "A collection of interaction inputs that supports both indexed and name-based access.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ToArray", + "capabilityId": "Aspire.Hosting/InteractionInputCollection.toArray", + "qualifiedName": "InteractionInputCollection.toArray", + "description": "Gets all inputs in declaration order.", + "returns": "A copy of the inputs in declaration order.", + "kind": "InstanceMethod", + "signature": "ToArray() ([]*InteractionInput, error)", + "receiver": "InteractionInputCollection", + "parameters": [], + "returnType": "([]*InteractionInput, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.InteractionInputCollection", + "expandedTargetTypes": [ + "Aspire.Hosting.InteractionInputCollection" + ], + "appliesTo": [ + "InteractionInputCollection" + ] + } + ], + "synthesizedMembers": [ + { + "name": "Get", + "signature": "Get(name string) (*InteractionInput, error)", + "description": "Get returns the input with the specified name, or nil if no input matches." + }, + { + "name": "Required", + "signature": "Required(name string) (*InteractionInput, error)", + "description": "Required returns the input with the specified name, or an error if no input matches." + }, + { + "name": "Value", + "signature": "Value(name string) (string, error)", + "description": "Value returns the value of the input with the specified name, or an empty string if no input matches or it has no value." + }, + { + "name": "RequiredValue", + "signature": "RequiredValue(name string) (string, error)", + "description": "RequiredValue returns the value of the input with the specified name, or an error if no input matches." + } + ] + }, + { + "name": "DistributedApplicationPipeline", + "fullName": "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "kind": "handle", + "isInterface": true, + "description": "Represents a pipeline for executing deployment steps in a distributed application.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AddStep", + "capabilityId": "Aspire.Hosting/addStep", + "qualifiedName": "addStep", + "description": "Adds an application-level pipeline step in a TypeScript-friendly shape.", + "kind": "Method", + "signature": "AddStep(stepName string, callback func(arg PipelineStepContext), options ...*AddStepOptions) error", + "receiver": "DistributedApplicationPipeline", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The unique name of the pipeline step." + }, + { + "name": "callback", + "type": "func(arg PipelineStepContext)", + "isCallback": true, + "callbackSignature": "func(arg PipelineStepContext)", + "description": "The callback to execute when the step runs." + } + ], + "options": { + "typeName": "AddStepOptions", + "fields": [ + { + "name": "DependsOn", + "jsonName": "dependsOn", + "type": "[]string", + "description": "Optional step names that this step depends on." + }, + { + "name": "RequiredBy", + "jsonName": "requiredBy", + "type": "[]string", + "description": "Optional step names that require this step." + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline" + ], + "appliesTo": [ + "DistributedApplicationPipeline" + ] + }, + { + "name": "Configure", + "capabilityId": "Aspire.Hosting/configure", + "qualifiedName": "configure", + "description": "Registers a pipeline configuration callback in a TypeScript-friendly shape.", + "kind": "Method", + "signature": "Configure(callback func(arg PipelineConfigurationContext)) error", + "receiver": "DistributedApplicationPipeline", + "parameters": [ + { + "name": "callback", + "type": "func(arg PipelineConfigurationContext)", + "isCallback": true, + "callbackSignature": "func(arg PipelineConfigurationContext)", + "description": "The callback to execute during pipeline configuration." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline" + ], + "appliesTo": [ + "DistributedApplicationPipeline" + ] + }, + { + "name": "DisableBuildOnlyContainerValidation", + "capabilityId": "Aspire.Hosting/disableBuildOnlyContainerValidation", + "qualifiedName": "disableBuildOnlyContainerValidation", + "description": "Disables the publish and deploy validation that requires build-only containers to be consumed by another resource.", + "remarks": "This is an application-wide escape hatch for scenarios where the build-only container validation is too restrictive\nfor a particular app. Prefer wiring build-only containers through `PublishWithContainerFiles` or\n`PublishWithStaticFiles` when possible.", + "returns": "The distributed application pipeline for chaining.", + "kind": "Method", + "signature": "DisableBuildOnlyContainerValidation() DistributedApplicationPipeline", + "receiver": "DistributedApplicationPipeline", + "parameters": [], + "returnType": "DistributedApplicationPipeline", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IDistributedApplicationPipeline", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IDistributedApplicationPipeline" + ], + "appliesTo": [ + "DistributedApplicationPipeline" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ReportingStep", + "fullName": "Aspire.Hosting.Pipelines.IReportingStep", + "kind": "handle", + "isInterface": true, + "description": "Represents a publishing step, which can contain multiple tasks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CompleteStep", + "capabilityId": "Aspire.Hosting/completeStep", + "qualifiedName": "completeStep", + "description": "Completes the reporting step with plain-text completion text.", + "kind": "Method", + "signature": "CompleteStep(completionText string, options ...*CompleteStepOptions) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "completionText", + "type": "string" + } + ], + "options": { + "typeName": "CompleteStepOptions", + "fields": [ + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CompleteStepMarkdown", + "capabilityId": "Aspire.Hosting/completeStepMarkdown", + "qualifiedName": "completeStepMarkdown", + "description": "Completes the reporting step with Markdown-formatted completion text.", + "kind": "Method", + "signature": "CompleteStepMarkdown(markdownString string, options ...*CompleteStepMarkdownOptions) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "CompleteStepMarkdownOptions", + "fields": [ + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CreateMarkdownTask", + "capabilityId": "Aspire.Hosting/createMarkdownTask", + "qualifiedName": "createMarkdownTask", + "description": "Creates a reporting task with Markdown-formatted status text.", + "kind": "Method", + "signature": "CreateMarkdownTask(markdownString string, options ...*CreateMarkdownTaskOptions) ReportingTask", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "CreateMarkdownTaskOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "ReportingTask", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "CreateTask", + "capabilityId": "Aspire.Hosting/createTask", + "qualifiedName": "createTask", + "description": "Creates a reporting task with plain-text status text.", + "kind": "Method", + "signature": "CreateTask(statusText string, options ...*CreateTaskOptions) ReportingTask", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "statusText", + "type": "string" + } + ], + "options": { + "typeName": "CreateTaskOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "ReportingTask", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "LogStep", + "capabilityId": "Aspire.Hosting/logStep", + "qualifiedName": "logStep", + "description": "Logs a plain-text message for the reporting step.", + "kind": "Method", + "signature": "LogStep(level string, message string) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "level", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + }, + { + "name": "LogStepMarkdown", + "capabilityId": "Aspire.Hosting/logStepMarkdown", + "qualifiedName": "logStepMarkdown", + "description": "Logs a Markdown-formatted message for the reporting step.", + "kind": "Method", + "signature": "LogStepMarkdown(level string, markdownString string) error", + "receiver": "ReportingStep", + "parameters": [ + { + "name": "level", + "type": "string" + }, + { + "name": "markdownString", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingStep" + ], + "appliesTo": [ + "ReportingStep" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ReportingTask", + "fullName": "Aspire.Hosting.Pipelines.IReportingTask", + "kind": "handle", + "isInterface": true, + "description": "Represents a publishing task, which belongs to a step.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CompleteTask", + "capabilityId": "Aspire.Hosting/completeTask", + "qualifiedName": "completeTask", + "description": "Completes the reporting task with plain-text completion text.", + "kind": "Method", + "signature": "CompleteTask(options ...*CompleteTaskOptions) error", + "receiver": "ReportingTask", + "parameters": [], + "options": { + "typeName": "CompleteTaskOptions", + "fields": [ + { + "name": "CompletionMessage", + "jsonName": "completionMessage", + "type": "*string" + }, + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "CompleteTaskMarkdown", + "capabilityId": "Aspire.Hosting/completeTaskMarkdown", + "qualifiedName": "completeTaskMarkdown", + "description": "Completes the reporting task with Markdown-formatted completion text.", + "kind": "Method", + "signature": "CompleteTaskMarkdown(markdownString string, options ...*CompleteTaskMarkdownOptions) error", + "receiver": "ReportingTask", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "CompleteTaskMarkdownOptions", + "fields": [ + { + "name": "CompletionState", + "jsonName": "completionState", + "type": "*string" + }, + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "UpdateTask", + "capabilityId": "Aspire.Hosting/updateTask", + "qualifiedName": "updateTask", + "description": "Updates the reporting task with plain-text status text.", + "kind": "Method", + "signature": "UpdateTask(statusText string, options ...*UpdateTaskOptions) error", + "receiver": "ReportingTask", + "parameters": [ + { + "name": "statusText", + "type": "string" + } + ], + "options": { + "typeName": "UpdateTaskOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + }, + { + "name": "UpdateTaskMarkdown", + "capabilityId": "Aspire.Hosting/updateTaskMarkdown", + "qualifiedName": "updateTaskMarkdown", + "description": "Updates the reporting task with Markdown-formatted status text.", + "kind": "Method", + "signature": "UpdateTaskMarkdown(markdownString string, options ...*UpdateTaskMarkdownOptions) error", + "receiver": "ReportingTask", + "parameters": [ + { + "name": "markdownString", + "type": "string" + } + ], + "options": { + "typeName": "UpdateTaskMarkdownOptions", + "fields": [ + { + "name": "CancellationToken", + "type": "*CancellationToken" + } + ] + }, + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.IReportingTask", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.IReportingTask" + ], + "appliesTo": [ + "ReportingTask" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineConfigurationContext", + "fullName": "Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "kind": "handle", + "description": "Provides contextual information for pipeline configuration callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "GetSteps", + "capabilityId": "Aspire.Hosting.Pipelines/getSteps", + "qualifiedName": "PipelineConfigurationContext.getSteps", + "description": "Gets all pipeline steps with the specified tag.", + "returns": "A collection of steps that have the specified tag.", + "kind": "InstanceMethod", + "signature": "GetSteps(tag string) ([]PipelineStep, error)", + "receiver": "PipelineConfigurationContext", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "The tag to search for." + } + ], + "returnType": "([]PipelineStep, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineConfigurationContext" + ], + "appliesTo": [ + "PipelineConfigurationContext" + ] + }, + { + "name": "Log", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineConfigurationContext.log", + "qualifiedName": "PipelineConfigurationContext.log", + "description": "Gets the logger facade used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Log() LogFacade", + "receiver": "PipelineConfigurationContext", + "parameters": [], + "returnType": "LogFacade", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineConfigurationContext" + ], + "appliesTo": [ + "PipelineConfigurationContext" + ] + }, + { + "name": "Pipeline", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineConfigurationContext.pipeline", + "qualifiedName": "PipelineConfigurationContext.pipeline", + "description": "Gets the pipeline editor used by polyglot callbacks.", + "kind": "PropertyGetter", + "signature": "Pipeline() PipelineEditor", + "receiver": "PipelineConfigurationContext", + "parameters": [], + "returnType": "PipelineEditor", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineConfigurationContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineConfigurationContext" + ], + "appliesTo": [ + "PipelineConfigurationContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineContext", + "fullName": "Aspire.Hosting.Pipelines.PipelineContext", + "kind": "handle", + "description": "Provides contextual information and services for the pipeline execution process of a distributed application.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.cancellationToken", + "qualifiedName": "PipelineContext.cancellationToken", + "description": "Gets the cancellation token for the pipeline operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.executionContext", + "qualifiedName": "PipelineContext.executionContext", + "description": "Gets the execution context for the distributed application.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.logger", + "qualifiedName": "PipelineContext.logger", + "description": "Gets the logger for pipeline operations.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.model", + "qualifiedName": "PipelineContext.model", + "description": "Gets the distributed application model to be deployed.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.services", + "qualifiedName": "PipelineContext.services", + "description": "Gets the service provider for dependency resolution.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "SetCancellationToken", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.setCancellationToken", + "qualifiedName": "PipelineContext.setCancellationToken", + "description": "Gets the cancellation token for the pipeline operation.", + "kind": "PropertySetter", + "signature": "SetCancellationToken(options ...*SetCancellationTokenOptions) PipelineContext", + "receiver": "PipelineContext", + "parameters": [], + "options": { + "typeName": "SetCancellationTokenOptions", + "fields": [ + { + "name": "Value", + "type": "*CancellationToken", + "description": "Gets the cancellation token for the pipeline operation." + } + ] + }, + "returnType": "PipelineContext", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + }, + { + "name": "Summary", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineContext.summary", + "qualifiedName": "PipelineContext.summary", + "description": "Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes.", + "remarks": "Pipeline steps can add key-value pairs to the summary to provide useful information\nabout the pipeline execution, such as deployment targets, resource names, URLs, etc.", + "kind": "PropertyGetter", + "signature": "Summary() PipelineSummary", + "receiver": "PipelineContext", + "parameters": [], + "returnType": "PipelineSummary", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineContext" + ], + "appliesTo": [ + "PipelineContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineEditor", + "fullName": "Aspire.Hosting.Pipelines.PipelineEditor", + "kind": "handle", + "description": "Provides an ATS-first editor for pipeline configuration callbacks.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Steps", + "capabilityId": "Aspire.Hosting.Pipelines/steps", + "qualifiedName": "PipelineEditor.steps", + "description": "Gets all configured pipeline steps.", + "returns": "The configured pipeline steps.", + "kind": "InstanceMethod", + "signature": "Steps() ([]PipelineStep, error)", + "receiver": "PipelineEditor", + "parameters": [], + "returnType": "([]PipelineStep, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineEditor" + ], + "appliesTo": [ + "PipelineEditor" + ] + }, + { + "name": "StepsByTag", + "capabilityId": "Aspire.Hosting.Pipelines/stepsByTag", + "qualifiedName": "PipelineEditor.stepsByTag", + "description": "Gets all pipeline steps that have the specified tag.", + "returns": "The matching pipeline steps.", + "kind": "InstanceMethod", + "signature": "StepsByTag(tag string) ([]PipelineStep, error)", + "receiver": "PipelineEditor", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "The tag to search for." + } + ], + "returnType": "([]PipelineStep, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineEditor", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineEditor" + ], + "appliesTo": [ + "PipelineEditor" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineStep", + "fullName": "Aspire.Hosting.Pipelines.PipelineStep", + "kind": "handle", + "description": "Represents a step in the deployment pipeline.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AddTag", + "capabilityId": "Aspire.Hosting.Pipelines/addTag", + "qualifiedName": "PipelineStep.addTag", + "description": "Adds a tag to the step.", + "kind": "InstanceMethod", + "signature": "AddTag(tag string) error", + "receiver": "PipelineStep", + "parameters": [ + { + "name": "tag", + "type": "string", + "description": "The tag to add." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "DependsOn", + "capabilityId": "Aspire.Hosting.Pipelines/dependsOn", + "qualifiedName": "PipelineStep.dependsOn", + "description": "Adds a dependency on another step.", + "kind": "InstanceMethod", + "signature": "DependsOn(stepName string) error", + "receiver": "PipelineStep", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The name of the step to depend on." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "DependsOnSteps", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.dependsOnSteps", + "qualifiedName": "PipelineStep.dependsOnSteps", + "description": "Gets or initializes the list of step names that this step depends on.", + "kind": "PropertyGetter", + "signature": "DependsOnSteps() *List[string]", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.description", + "qualifiedName": "PipelineStep.description", + "description": "Gets or initializes the description of the step.", + "remarks": "The description provides human-readable context about what the step does,\nhelping users and tools understand the purpose of the step.", + "kind": "PropertyGetter", + "signature": "Description() (*string, error)", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.name", + "qualifiedName": "PipelineStep.name", + "description": "Gets or initializes the unique name of the step.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "RequiredBy", + "capabilityId": "Aspire.Hosting.Pipelines/requiredBy", + "qualifiedName": "PipelineStep.requiredBy", + "description": "Specifies that this step is required by another step. This creates the inverse relationship where the other step will depend on this step.", + "kind": "InstanceMethod", + "signature": "RequiredBy(stepName string) error", + "receiver": "PipelineStep", + "parameters": [ + { + "name": "stepName", + "type": "string", + "description": "The name of the step that requires this step." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "RequiredBySteps", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.requiredBySteps", + "qualifiedName": "PipelineStep.requiredBySteps", + "description": "Gets or initializes the list of step names that require this step to complete before they can finish. This is used internally during pipeline construction and is converted to DependsOn relationships.", + "kind": "PropertyGetter", + "signature": "RequiredBySteps() *List[string]", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + }, + { + "name": "Tags", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStep.tags", + "qualifiedName": "PipelineStep.tags", + "description": "Gets or initializes the list of tags that categorize this step.", + "kind": "PropertyGetter", + "signature": "Tags() *List[string]", + "receiver": "PipelineStep", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStep", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStep" + ], + "appliesTo": [ + "PipelineStep" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineStepContext", + "fullName": "Aspire.Hosting.Pipelines.PipelineStepContext", + "kind": "handle", + "description": "Provides contextual information for a specific pipeline step execution.", + "remarks": "This context combines the shared pipeline context with a step-specific publishing step,\nallowing each step to track its own tasks and completion state independently.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.cancellationToken", + "qualifiedName": "PipelineStepContext.cancellationToken", + "description": "Gets the cancellation token for the pipeline operation.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "ExecutionContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.executionContext", + "qualifiedName": "PipelineStepContext.executionContext", + "description": "Gets the execution context for the distributed application.", + "kind": "PropertyGetter", + "signature": "ExecutionContext() DistributedApplicationExecutionContext", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "DistributedApplicationExecutionContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Logger", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.logger", + "qualifiedName": "PipelineStepContext.logger", + "description": "Gets the logger for pipeline operations that writes to both the pipeline logger and the step logger.", + "kind": "PropertyGetter", + "signature": "Logger() Logger", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.model", + "qualifiedName": "PipelineStepContext.model", + "description": "Gets the distributed application model to be deployed.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "PipelineContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.pipelineContext", + "qualifiedName": "PipelineStepContext.pipelineContext", + "description": "Gets the pipeline context shared across all steps.", + "kind": "PropertyGetter", + "signature": "PipelineContext() PipelineContext", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "PipelineContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "ReportingStep", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.reportingStep", + "qualifiedName": "PipelineStepContext.reportingStep", + "description": "Gets the publishing step associated with this specific step execution.", + "kind": "PropertyGetter", + "signature": "ReportingStep() ReportingStep", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "ReportingStep", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.services", + "qualifiedName": "PipelineStepContext.services", + "description": "Gets the service provider for dependency resolution.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + }, + { + "name": "Summary", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepContext.summary", + "qualifiedName": "PipelineStepContext.summary", + "description": "Gets the pipeline summary that steps can add information to. The summary will be displayed to users after pipeline execution completes.", + "remarks": "Pipeline steps can add key-value pairs to the summary to provide useful information\nabout the pipeline execution, such as deployment targets, resource names, URLs, etc.", + "kind": "PropertyGetter", + "signature": "Summary() PipelineSummary", + "receiver": "PipelineStepContext", + "parameters": [], + "returnType": "PipelineSummary", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepContext" + ], + "appliesTo": [ + "PipelineStepContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineStepFactoryContext", + "fullName": "Aspire.Hosting.Pipelines.PipelineStepFactoryContext", + "kind": "handle", + "description": "Provides contextual information for creating pipeline steps from a {@ats-ref type:PipelineStepAnnotation}.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "PipelineContext", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepFactoryContext.pipelineContext", + "qualifiedName": "PipelineStepFactoryContext.pipelineContext", + "description": "Gets the pipeline context that has the model and other properties.", + "kind": "PropertyGetter", + "signature": "PipelineContext() PipelineContext", + "receiver": "PipelineStepFactoryContext", + "parameters": [], + "returnType": "PipelineContext", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepFactoryContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepFactoryContext" + ], + "appliesTo": [ + "PipelineStepFactoryContext" + ] + }, + { + "name": "Resource", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineStepFactoryContext.resource", + "qualifiedName": "PipelineStepFactoryContext.resource", + "description": "Gets the resource that this factory is associated with.", + "kind": "PropertyGetter", + "signature": "Resource() Resource", + "receiver": "PipelineStepFactoryContext", + "parameters": [], + "returnType": "Resource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineStepFactoryContext", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineStepFactoryContext" + ], + "appliesTo": [ + "PipelineStepFactoryContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "PipelineSummary", + "fullName": "Aspire.Hosting.Pipelines.PipelineSummary", + "kind": "handle", + "description": "Represents pipeline summary information to be displayed after pipeline completion. This is a general-purpose key-value collection that pipeline steps can contribute to.", + "remarks": "This class provides a flexible way for any pipeline step to contribute\ninformation to be displayed after pipeline execution. The data is stored as\nkey-value pairs that will be formatted as a table or list in the CLI output.\nPipeline steps can add any relevant information such as resource group names,\nsubscription IDs, URLs, namespaces, cluster names, or any other details.\nValues can be plain text or Markdown-formatted by using `MarkdownString`.\nThe summary is available via the `Summary`\nproperty and can be accessed from any pipeline step.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Add", + "capabilityId": "Aspire.Hosting.Pipelines/PipelineSummary.add", + "qualifiedName": "PipelineSummary.add", + "description": "Adds a key-value pair to the pipeline summary with a plain-text value.", + "kind": "InstanceMethod", + "signature": "Add(key string, value string) error", + "receiver": "PipelineSummary", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key or label for the item (e.g., \"Namespace\", \"URL\")." + }, + { + "name": "value", + "type": "string", + "description": "The plain-text value for the item." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineSummary", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineSummary" + ], + "appliesTo": [ + "PipelineSummary" + ] + }, + { + "name": "AddMarkdown", + "capabilityId": "Aspire.Hosting/addMarkdown", + "qualifiedName": "addMarkdown", + "description": "Adds a key-value pair to the pipeline summary with a Markdown-formatted value.", + "kind": "Method", + "signature": "AddMarkdown(key string, markdownString string) error", + "receiver": "PipelineSummary", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The key or label for the item." + }, + { + "name": "markdownString", + "type": "string", + "description": "The Markdown-formatted value for the item." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Pipelines.PipelineSummary", + "expandedTargetTypes": [ + "Aspire.Hosting.Pipelines.PipelineSummary" + ], + "appliesTo": [ + "PipelineSummary" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProgressContext", + "fullName": "Aspire.Hosting.ProgressContext", + "kind": "handle", + "description": "Provides context to the work callback of a progress interaction.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CancellationToken", + "capabilityId": "Aspire.Hosting/ProgressContext.cancellationToken", + "qualifiedName": "ProgressContext.cancellationToken", + "description": "Gets the `CancellationToken` that is triggered when the user clicks the cancel button or the operation is externally canceled.", + "kind": "PropertyGetter", + "signature": "CancellationToken() (*CancellationToken, error)", + "receiver": "ProgressContext", + "parameters": [], + "returnType": "(*CancellationToken, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProgressContext", + "expandedTargetTypes": [ + "Aspire.Hosting.ProgressContext" + ], + "appliesTo": [ + "ProgressContext" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProjectResourceOptions", + "fullName": "Aspire.Hosting.ProjectResourceOptions", + "kind": "handle", + "description": "Various properties to modify the behavior of the project resource.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ExcludeKestrelEndpoints", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.excludeKestrelEndpoints", + "qualifiedName": "ProjectResourceOptions.excludeKestrelEndpoints", + "description": "If set, ignore endpoints coming from Kestrel configuration.", + "kind": "PropertyGetter", + "signature": "ExcludeKestrelEndpoints() (bool, error)", + "receiver": "ProjectResourceOptions", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "ExcludeLaunchProfile", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.excludeLaunchProfile", + "qualifiedName": "ProjectResourceOptions.excludeLaunchProfile", + "description": "If set, no launch profile will be used, and LaunchProfileName will be ignored.", + "kind": "PropertyGetter", + "signature": "ExcludeLaunchProfile() (bool, error)", + "receiver": "ProjectResourceOptions", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "LaunchProfileName", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.launchProfileName", + "qualifiedName": "ProjectResourceOptions.launchProfileName", + "description": "The launch profile to use. If `null` then the default launch profile will be used.", + "kind": "PropertyGetter", + "signature": "LaunchProfileName() (*string, error)", + "receiver": "ProjectResourceOptions", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "SetExcludeKestrelEndpoints", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.setExcludeKestrelEndpoints", + "qualifiedName": "ProjectResourceOptions.setExcludeKestrelEndpoints", + "description": "If set, ignore endpoints coming from Kestrel configuration.", + "kind": "PropertySetter", + "signature": "SetExcludeKestrelEndpoints(value bool) ProjectResourceOptions", + "receiver": "ProjectResourceOptions", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "If set, ignore endpoints coming from Kestrel configuration." + } + ], + "returnType": "ProjectResourceOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "SetExcludeLaunchProfile", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.setExcludeLaunchProfile", + "qualifiedName": "ProjectResourceOptions.setExcludeLaunchProfile", + "description": "If set, no launch profile will be used, and LaunchProfileName will be ignored.", + "kind": "PropertySetter", + "signature": "SetExcludeLaunchProfile(value bool) ProjectResourceOptions", + "receiver": "ProjectResourceOptions", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "If set, no launch profile will be used, and LaunchProfileName will be ignored." + } + ], + "returnType": "ProjectResourceOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + }, + { + "name": "SetLaunchProfileName", + "capabilityId": "Aspire.Hosting/ProjectResourceOptions.setLaunchProfileName", + "qualifiedName": "ProjectResourceOptions.setLaunchProfileName", + "description": "The launch profile to use. If `null` then the default launch profile will be used.", + "kind": "PropertySetter", + "signature": "SetLaunchProfileName(value *string) ProjectResourceOptions", + "receiver": "ProjectResourceOptions", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "The launch profile to use. If `null` then the default launch profile will be used." + } + ], + "returnType": "ProjectResourceOptions", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ProjectResourceOptions", + "expandedTargetTypes": [ + "Aspire.Hosting.ProjectResourceOptions" + ], + "appliesTo": [ + "ProjectResourceOptions" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AfterPublishEvent", + "fullName": "Aspire.Hosting.Publishing.AfterPublishEvent", + "kind": "handle", + "description": "This event is published after the distributed application is published.", + "implementedInterfaces": [ + "DistributedApplicationEvent" + ], + "capabilities": [ + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Publishing/AfterPublishEvent.model", + "qualifiedName": "AfterPublishEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "AfterPublishEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.AfterPublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.AfterPublishEvent" + ], + "appliesTo": [ + "AfterPublishEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Publishing/AfterPublishEvent.services", + "qualifiedName": "AfterPublishEvent.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "AfterPublishEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.AfterPublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.AfterPublishEvent" + ], + "appliesTo": [ + "AfterPublishEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BeforePublishEvent", + "fullName": "Aspire.Hosting.Publishing.BeforePublishEvent", + "kind": "handle", + "description": "This event is published before the distributed application is published.", + "implementedInterfaces": [ + "DistributedApplicationEvent" + ], + "capabilities": [ + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Publishing/BeforePublishEvent.model", + "qualifiedName": "BeforePublishEvent.model", + "description": "The `DistributedApplicationModel` instance.", + "kind": "PropertyGetter", + "signature": "Model() DistributedApplicationModel", + "receiver": "BeforePublishEvent", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.BeforePublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.BeforePublishEvent" + ], + "appliesTo": [ + "BeforePublishEvent" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Publishing/BeforePublishEvent.services", + "qualifiedName": "BeforePublishEvent.services", + "description": "The `IServiceProvider` for the AppHost.", + "kind": "PropertyGetter", + "signature": "Services() ServiceProvider", + "receiver": "BeforePublishEvent", + "parameters": [], + "returnType": "ServiceProvider", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.Publishing.BeforePublishEvent", + "expandedTargetTypes": [ + "Aspire.Hosting.Publishing.BeforePublishEvent" + ], + "appliesTo": [ + "BeforePublishEvent" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Configuration", + "fullName": "Microsoft.Extensions.Configuration.IConfiguration", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Exists", + "capabilityId": "Aspire.Hosting/exists", + "qualifiedName": "exists", + "description": "Checks whether a configuration section exists.", + "returns": "`true` when the section exists; otherwise, `false`.", + "kind": "Method", + "signature": "Exists(key string) (bool, error)", + "receiver": "Configuration", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The configuration key." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetChildren", + "capabilityId": "Aspire.Hosting/getChildren", + "qualifiedName": "getChildren", + "description": "Gets the child sections of a configuration handle.", + "returns": "The child sections.", + "kind": "Method", + "signature": "GetChildren() ([]ConfigurationSection, error)", + "receiver": "Configuration", + "parameters": [], + "returnType": "([]ConfigurationSection, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetConfigValue", + "capabilityId": "Aspire.Hosting/getConfigValue", + "qualifiedName": "getConfigValue", + "description": "Gets a configuration value by key.", + "returns": "The configuration value, or null if not found.", + "kind": "Method", + "signature": "GetConfigValue(key string) (string, error)", + "receiver": "Configuration", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The configuration key (e.g., \"ConnectionStrings:Default\")." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetConnectionString", + "capabilityId": "Aspire.Hosting/getConnectionString", + "qualifiedName": "getConnectionString", + "description": "Gets a connection string by name.", + "returns": "The connection string value, or null if not found.", + "kind": "Method", + "signature": "GetConnectionString(name string) (string, error)", + "receiver": "Configuration", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The connection string name." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + }, + { + "name": "GetSection", + "capabilityId": "Aspire.Hosting/getSection", + "qualifiedName": "getSection", + "description": "Gets a configuration section by key.", + "returns": "The configuration section handle.", + "kind": "Method", + "signature": "GetSection(key string) ConfigurationSection", + "receiver": "Configuration", + "parameters": [ + { + "name": "key", + "type": "string", + "description": "The configuration key." + } + ], + "returnType": "ConfigurationSection", + "errorModel": "deferred", + "targetTypeId": "Microsoft.Extensions.Configuration.Abstractions/Microsoft.Extensions.Configuration.IConfiguration", + "expandedTargetTypes": [ + "Microsoft.Extensions.Configuration.IConfiguration" + ], + "appliesTo": [ + "Configuration" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ConfigurationSection", + "fullName": "Microsoft.Extensions.Configuration.IConfigurationSection", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "HostEnvironment", + "fullName": "Microsoft.Extensions.Hosting.IHostEnvironment", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "IsDevelopment", + "capabilityId": "Aspire.Hosting/isDevelopment", + "qualifiedName": "isDevelopment", + "description": "Checks if the environment is Development.", + "returns": "True if running in Development environment.", + "kind": "Method", + "signature": "IsDevelopment() (bool, error)", + "receiver": "HostEnvironment", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "IsEnvironment", + "capabilityId": "Aspire.Hosting/isEnvironment", + "qualifiedName": "isEnvironment", + "description": "Checks if the environment matches the specified name.", + "returns": "True if the environment matches the specified name.", + "kind": "Method", + "signature": "IsEnvironment(environmentName string) (bool, error)", + "receiver": "HostEnvironment", + "parameters": [ + { + "name": "environmentName", + "type": "string", + "description": "The environment name to compare against." + } + ], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "IsProduction", + "capabilityId": "Aspire.Hosting/isProduction", + "qualifiedName": "isProduction", + "description": "Checks if the environment is Production.", + "returns": "True if running in Production environment.", + "kind": "Method", + "signature": "IsProduction() (bool, error)", + "receiver": "HostEnvironment", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + }, + { + "name": "IsStaging", + "capabilityId": "Aspire.Hosting/isStaging", + "qualifiedName": "isStaging", + "description": "Checks if the environment is Staging.", + "returns": "True if running in Staging environment.", + "kind": "Method", + "signature": "IsStaging() (bool, error)", + "receiver": "HostEnvironment", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Hosting.Abstractions/Microsoft.Extensions.Hosting.IHostEnvironment", + "expandedTargetTypes": [ + "Microsoft.Extensions.Hosting.IHostEnvironment" + ], + "appliesTo": [ + "HostEnvironment" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Logger", + "fullName": "Microsoft.Extensions.Logging.ILogger", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Log", + "capabilityId": "Aspire.Hosting/log", + "qualifiedName": "log", + "description": "Logs a message with a specified log level.", + "kind": "Method", + "signature": "Log(level string, message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "level", + "type": "string" + }, + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogDebug", + "capabilityId": "Aspire.Hosting/logDebug", + "qualifiedName": "logDebug", + "description": "Logs a debug message.", + "kind": "Method", + "signature": "LogDebug(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogError", + "capabilityId": "Aspire.Hosting/logError", + "qualifiedName": "logError", + "description": "Logs an error message.", + "kind": "Method", + "signature": "LogError(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogInformation", + "capabilityId": "Aspire.Hosting/logInformation", + "qualifiedName": "logInformation", + "description": "Logs an information message.", + "kind": "Method", + "signature": "LogInformation(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + }, + { + "name": "LogWarning", + "capabilityId": "Aspire.Hosting/logWarning", + "qualifiedName": "logWarning", + "description": "Logs a warning message.", + "kind": "Method", + "signature": "LogWarning(message string) error", + "receiver": "Logger", + "parameters": [ + { + "name": "message", + "type": "string" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILogger", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILogger" + ], + "appliesTo": [ + "Logger" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "LoggerFactory", + "fullName": "Microsoft.Extensions.Logging.ILoggerFactory", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CreateLogger", + "capabilityId": "Aspire.Hosting/createLogger", + "qualifiedName": "createLogger", + "description": "Creates a logger for the specified category name.", + "returns": "A logger handle.", + "kind": "Method", + "signature": "CreateLogger(categoryName string) Logger", + "receiver": "LoggerFactory", + "parameters": [ + { + "name": "categoryName", + "type": "string", + "description": "The category name." + } + ], + "returnType": "Logger", + "errorModel": "deferred", + "targetTypeId": "Microsoft.Extensions.Logging.Abstractions/Microsoft.Extensions.Logging.ILoggerFactory", + "expandedTargetTypes": [ + "Microsoft.Extensions.Logging.ILoggerFactory" + ], + "appliesTo": [ + "LoggerFactory" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ServiceProvider", + "fullName": "System.IServiceProvider", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "GetAspireStore", + "capabilityId": "Aspire.Hosting/getAspireStore", + "qualifiedName": "getAspireStore", + "description": "Gets the Aspire store from the service provider.", + "returns": "The Aspire store.", + "kind": "Method", + "signature": "GetAspireStore() AspireStore", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "AspireStore", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetDistributedApplicationModel", + "capabilityId": "Aspire.Hosting/getDistributedApplicationModel", + "qualifiedName": "getDistributedApplicationModel", + "description": "Gets the distributed application model from the service provider.", + "returns": "The distributed application model handle.", + "kind": "Method", + "signature": "GetDistributedApplicationModel() DistributedApplicationModel", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "DistributedApplicationModel", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetEventing", + "capabilityId": "Aspire.Hosting/getEventing", + "qualifiedName": "getEventing", + "description": "Gets the distributed application eventing service from the service provider.", + "returns": "The distributed application eventing handle.", + "kind": "Method", + "signature": "GetEventing() DistributedApplicationEventing", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "DistributedApplicationEventing", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetInteractionService", + "capabilityId": "Aspire.Hosting/getInteractionService", + "qualifiedName": "getInteractionService", + "description": "Gets the interaction service from the service provider.", + "returns": "An interaction service handle.", + "kind": "Method", + "signature": "GetInteractionService() InteractionService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "InteractionService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetLoggerFactory", + "capabilityId": "Aspire.Hosting/getLoggerFactory", + "qualifiedName": "getLoggerFactory", + "description": "Gets the logger factory from the service provider.", + "returns": "A logger factory handle.", + "kind": "Method", + "signature": "GetLoggerFactory() LoggerFactory", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "LoggerFactory", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetResourceCommandService", + "capabilityId": "Aspire.Hosting/getResourceCommandService", + "qualifiedName": "getResourceCommandService", + "description": "Gets the resource command service from the service provider.", + "returns": "A resource command service handle.", + "kind": "Method", + "signature": "GetResourceCommandService() ResourceCommandService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "ResourceCommandService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetResourceLoggerService", + "capabilityId": "Aspire.Hosting/getResourceLoggerService", + "qualifiedName": "getResourceLoggerService", + "description": "Gets the resource logger service from the service provider.", + "returns": "A resource logger service handle.", + "kind": "Method", + "signature": "GetResourceLoggerService() ResourceLoggerService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "ResourceLoggerService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetResourceNotificationService", + "capabilityId": "Aspire.Hosting/getResourceNotificationService", + "qualifiedName": "getResourceNotificationService", + "description": "Gets the resource notification service from the service provider.", + "returns": "A resource notification service handle.", + "kind": "Method", + "signature": "GetResourceNotificationService() ResourceNotificationService", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "ResourceNotificationService", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + }, + { + "name": "GetUserSecretsManager", + "capabilityId": "Aspire.Hosting/getUserSecretsManager", + "qualifiedName": "getUserSecretsManager", + "description": "Gets the user secrets manager from the service provider.", + "returns": "A user secrets manager handle.", + "kind": "Method", + "signature": "GetUserSecretsManager() UserSecretsManager", + "receiver": "ServiceProvider", + "parameters": [], + "returnType": "UserSecretsManager", + "errorModel": "deferred", + "targetTypeId": "System.ComponentModel/System.IServiceProvider", + "expandedTargetTypes": [ + "System.IServiceProvider" + ], + "appliesTo": [ + "ServiceProvider" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "CertificateTrustExecutionConfigurationContext", + "fullName": "Aspire.Hosting.ApplicationModel.CertificateTrustExecutionConfigurationContext", + "kind": "dto", + "description": "Context for configuring certificate trust configuration properties.", + "fields": [ + { + "name": "CertificateBundlePath", + "jsonName": "CertificateBundlePath", + "type": "*ReferenceExpression", + "description": "The path to the PEM certificate bundle file in the resource context (e.g., container filesystem)." + }, + { + "name": "CertificateDirectoriesPath", + "jsonName": "CertificateDirectoriesPath", + "type": "*ReferenceExpression", + "description": "The path(s) to the certificate directories in the resource context (e.g., container filesystem)." + }, + { + "name": "RootCertificatesPath", + "jsonName": "RootCertificatesPath", + "type": "string", + "description": "The root path certificates will be written to in the resource context (e.g., container filesystem)." + }, + { + "name": "IsContainer", + "jsonName": "IsContainer", + "type": "*bool", + "isOptional": true, + "description": "Is this request being generated for a container resource (i.e. does it require Linux style paths?)." + } + ] + }, + { + "name": "CommandOptions", + "fullName": "Aspire.Hosting.ApplicationModel.CommandOptions", + "kind": "dto", + "description": "Optional configuration for resource commands.", + "fields": [ + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Optional description of the command, to be shown in the UI. Could be used as a tooltip. May be localized." + }, + { + "name": "Parameter", + "jsonName": "Parameter", + "type": "any", + "description": "Obsolete optional parameter that configures the command in some way. Clients must return any value provided by the server when invoking the command." + }, + { + "name": "Arguments", + "jsonName": "Arguments", + "type": "[]*InteractionInput", + "description": "Gets or sets the invocation arguments accepted by the command." + }, + { + "name": "ValidateArguments", + "jsonName": "ValidateArguments", + "type": "func(...any) any", + "isCallback": true, + "description": "Gets or sets the callback that validates invocation arguments before the command callback is executed." + }, + { + "name": "Visibility", + "jsonName": "Visibility", + "type": "ResourceCommandVisibility", + "description": "Gets or sets where the command is visible to users and clients." + }, + { + "name": "ConfirmationMessage", + "jsonName": "ConfirmationMessage", + "type": "*string", + "description": "When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog and the confirmation message before starting the command." + }, + { + "name": "IconName", + "jsonName": "IconName", + "type": "*string", + "description": "The icon name for the command. The name should be a valid FluentUI icon name from ." + }, + { + "name": "IconVariant", + "jsonName": "IconVariant", + "type": "*IconVariant", + "isOptional": true, + "description": "The icon variant." + }, + { + "name": "IsHighlighted", + "jsonName": "IsHighlighted", + "type": "bool", + "description": "A flag indicating whether the command is highlighted in the UI." + }, + { + "name": "UpdateState", + "jsonName": "UpdateState", + "type": "func(...any) any", + "isCallback": true, + "description": "A callback that is used to update the command state. The callback is executed when the command's resource snapshot is updated. If a callback isn't specified, the command is always enabled." + }, + { + "name": "Progress", + "jsonName": "Progress", + "type": "*CommandProgressOptions", + "description": "Gets or sets options for displaying a progress dialog while the command is executing." + } + ] + }, + { + "name": "CommandProgressOptions", + "fullName": "Aspire.Hosting.ApplicationModel.CommandProgressOptions", + "kind": "dto", + "description": "Options for displaying a progress dialog while a command is executing.", + "fields": [ + { + "name": "Message", + "jsonName": "Message", + "type": "*string", + "description": "Gets or sets the message to display in the progress dialog." + }, + { + "name": "Title", + "jsonName": "Title", + "type": "*string", + "description": "Gets or sets the optional title of the progress dialog." + }, + { + "name": "HideCancelButton", + "jsonName": "HideCancelButton", + "type": "bool", + "description": "Gets or sets a value indicating whether the cancel button is hidden in the progress dialog." + } + ] + }, + { + "name": "CommandResultData", + "fullName": "Aspire.Hosting.ApplicationModel.CommandResultData", + "kind": "dto", + "description": "Represents a value produced by a command.", + "fields": [ + { + "name": "Value", + "jsonName": "Value", + "type": "string", + "description": "The value data." + }, + { + "name": "Format", + "jsonName": "Format", + "type": "*CommandResultFormat", + "isOptional": true, + "description": "The format of the `Value` data." + }, + { + "name": "DisplayImmediately", + "jsonName": "DisplayImmediately", + "type": "*bool", + "isOptional": true, + "description": "When `true`, the dashboard will immediately display the value in a dialog when the command completes." + } + ] + }, + { + "name": "ExecuteCommandResult", + "fullName": "Aspire.Hosting.ApplicationModel.ExecuteCommandResult", + "kind": "dto", + "description": "The result of executing a command. Returned from `ExecuteCommand`.", + "fields": [ + { + "name": "Success", + "jsonName": "Success", + "type": "bool", + "description": "A flag that indicates whether the command was successful." + }, + { + "name": "Canceled", + "jsonName": "Canceled", + "type": "*bool", + "isOptional": true, + "description": "A flag that indicates whether the command was canceled by the user." + }, + { + "name": "ErrorMessage", + "jsonName": "ErrorMessage", + "type": "*string", + "isOptional": true, + "description": "An optional error message that can be set when the command is unsuccessful." + }, + { + "name": "Message", + "jsonName": "Message", + "type": "*string", + "isOptional": true, + "description": "An optional message associated with the command result." + }, + { + "name": "Data", + "jsonName": "Data", + "type": "*CommandResultData", + "isOptional": true, + "description": "An optional value produced by the command." + } + ] + }, + { + "name": "GenerateParameterDefault", + "fullName": "Aspire.Hosting.ApplicationModel.GenerateParameterDefault", + "kind": "dto", + "description": "Represents that a default value should be generated.", + "remarks": "The recommended minimum bits of entropy for a generated password is 128 bits.\nThe general calculation of bits of entropy is:\n`log base 2 (numberPossibleOutputs)`\nThis generator uses 23 upper case, 23 lower case (excludes i,l,o,I,L,O to prevent confusion),\n10 numeric, and 11 special characters. So a total of 67 possible characters.\nWhen all character sets are enabled, the number of possible outputs is `(67 ^ length)`.\nThe minimum password length for 128 bits of entropy is 22 characters: `log base 2 (67 ^ 22)`.\nWhen character sets are disabled, it lowers the number of possible outputs and thus the bits of entropy.\nUsing MinLower, MinUpper, MinNumeric, and MinSpecial also lowers the number of possible outputs and thus the bits of entropy.\nA generalized lower-bound formula for the number of possible outputs is to consider a string of the form:\n```\n{nonRequiredCharacters}{requiredCharacters}\nlet a = MinLower, b = MinUpper, c = MinNumeric, d = MinSpecial\nlet x = length - (a + b + c + d)\nnonRequiredPossibilities = 67^x\nrequiredPossibilities = 23^a * 23^b * 10^c * 11^d * (a + b + c + d)! / (a! * b! * c! * d!)\nlower-bound of total possibilities = nonRequiredPossibilities * requiredPossibilities\n```\nPutting it all together, the lower-bound bits of entropy calculation is:\n```\nlog base 2 [67^x * 23^a * 23^b * 10^c * 11^d * (a + b + c + d)! / (a! * b! * c! * d!)]\n```", + "fields": [ + { + "name": "MinLength", + "jsonName": "MinLength", + "type": "float64", + "description": "Gets or sets the minimum length of the generated value." + }, + { + "name": "Lower", + "jsonName": "Lower", + "type": "bool", + "description": "Gets or sets a value indicating whether to include lowercase alphabet characters in the result." + }, + { + "name": "Upper", + "jsonName": "Upper", + "type": "bool", + "description": "Gets or sets a value indicating whether to include uppercase alphabet characters in the result." + }, + { + "name": "Numeric", + "jsonName": "Numeric", + "type": "bool", + "description": "Gets or sets a value indicating whether to include numeric characters in the result." + }, + { + "name": "Special", + "jsonName": "Special", + "type": "bool", + "description": "Gets or sets a value indicating whether to include special characters in the result." + }, + { + "name": "MinLower", + "jsonName": "MinLower", + "type": "float64", + "description": "Gets or sets the minimum number of lowercase characters in the result." + }, + { + "name": "MinUpper", + "jsonName": "MinUpper", + "type": "float64", + "description": "Gets or sets the minimum number of uppercase characters in the result." + }, + { + "name": "MinNumeric", + "jsonName": "MinNumeric", + "type": "float64", + "description": "Gets or sets the minimum number of numeric characters in the result." + }, + { + "name": "MinSpecial", + "jsonName": "MinSpecial", + "type": "float64", + "description": "Gets or sets the minimum number of special characters in the result." + } + ] + }, + { + "name": "HttpCommandExportOptions", + "fullName": "Aspire.Hosting.ApplicationModel.HttpCommandExportOptions", + "kind": "dto", + "description": "ATS-friendly configuration for resource HTTP commands.", + "fields": [ + { + "name": "CommandOptions", + "jsonName": "CommandOptions", + "type": "*CommandOptions", + "isOptional": true, + "description": "Optional command configuration." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Optional description of the command, to be shown in the UI." + }, + { + "name": "ConfirmationMessage", + "jsonName": "ConfirmationMessage", + "type": "*string", + "description": "When a confirmation message is specified, the UI will prompt with an OK/Cancel dialog before starting the command." + }, + { + "name": "IconName", + "jsonName": "IconName", + "type": "*string", + "description": "The icon name for the command." + }, + { + "name": "IconVariant", + "jsonName": "IconVariant", + "type": "*IconVariant", + "isOptional": true, + "description": "The icon variant." + }, + { + "name": "IsHighlighted", + "jsonName": "IsHighlighted", + "type": "bool", + "description": "A flag indicating whether the command is highlighted in the UI." + }, + { + "name": "CommandName", + "jsonName": "CommandName", + "type": "*string", + "description": "Gets or sets the command name." + }, + { + "name": "EndpointName", + "jsonName": "EndpointName", + "type": "*string", + "description": "Gets or sets the HTTP endpoint name to send the request to when the command is invoked." + }, + { + "name": "MethodName", + "jsonName": "MethodName", + "type": "*string", + "description": "Gets or sets the HTTP method name to use when sending the request." + }, + { + "name": "PrepareRequest", + "jsonName": "PrepareRequest", + "type": "func(...any) any", + "isOptional": true, + "isCallback": true, + "description": "Gets or sets a callback to be invoked to configure the request before it is sent." + }, + { + "name": "ResultMode", + "jsonName": "ResultMode", + "type": "HttpCommandResultMode", + "description": "Gets or sets how the HTTP response content should be returned as command result data." + } + ] + }, + { + "name": "HttpCommandRequestExportData", + "fullName": "Aspire.Hosting.ApplicationModel.HttpCommandRequestExportData", + "kind": "dto", + "description": "ATS-friendly request data returned from HTTP command prepare-request callbacks.", + "fields": [ + { + "name": "MethodName", + "jsonName": "MethodName", + "type": "*string", + "description": "Gets or sets the HTTP method name to use when sending the request." + }, + { + "name": "Headers", + "jsonName": "Headers", + "type": "map[string]string", + "description": "Gets or sets the request headers." + }, + { + "name": "Content", + "jsonName": "Content", + "type": "*string", + "description": "Gets or sets the request content." + }, + { + "name": "ContentType", + "jsonName": "ContentType", + "type": "*string", + "description": "Gets or sets the request content type." + } + ] + }, + { + "name": "HttpsCertificateExecutionConfigurationContext", + "fullName": "Aspire.Hosting.ApplicationModel.HttpsCertificateExecutionConfigurationContext", + "kind": "dto", + "description": "Configuration context for server authentication certificate configuration.", + "fields": [ + { + "name": "CertificatePath", + "jsonName": "CertificatePath", + "type": "*ReferenceExpression", + "description": "Expression that will resolve to the path of the server authentication certificate in PEM format. For containers this will be a path inside the container." + }, + { + "name": "KeyPath", + "jsonName": "KeyPath", + "type": "*ReferenceExpression", + "description": "Expression that will resolve to the path of the server authentication certificate key in PEM format. For containers this will be a path inside the container." + }, + { + "name": "CertificateWithKeyPath", + "jsonName": "CertificateWithKeyPath", + "type": "*ReferenceExpression", + "description": "Expression that will resolve to the path of the server authentication certificate and key in a combined PEM file. For containers this will be a path inside the container." + }, + { + "name": "PfxPath", + "jsonName": "PfxPath", + "type": "*ReferenceExpression", + "description": "Expression that will resolve to the path of the server authentication certificate in PFX format. For containers this will be a path inside the container." + } + ] + }, + { + "name": "ProcessCommandExportOptions", + "fullName": "Aspire.Hosting.ApplicationModel.ProcessCommandExportOptions", + "kind": "dto", + "description": "ATS-friendly configuration for resource process commands.", + "fields": [ + { + "name": "ExecutablePath", + "jsonName": "ExecutablePath", + "type": "*string", + "description": "The executable path or command name to start." + }, + { + "name": "Arguments", + "jsonName": "Arguments", + "type": "[]string", + "description": "The command-line arguments for the process." + }, + { + "name": "WorkingDirectory", + "jsonName": "WorkingDirectory", + "type": "*string", + "description": "The working directory for the process." + }, + { + "name": "EnvironmentVariables", + "jsonName": "EnvironmentVariables", + "type": "map[string]string", + "description": "The environment variables to set for the process." + }, + { + "name": "InheritEnvironmentVariables", + "jsonName": "InheritEnvironmentVariables", + "type": "*bool", + "isOptional": true, + "description": "A value indicating whether the process should inherit the current environment variables." + }, + { + "name": "StandardInputContent", + "jsonName": "StandardInputContent", + "type": "*string", + "description": "Standard input content to write to the process after it starts." + }, + { + "name": "KillEntireProcessTree", + "jsonName": "KillEntireProcessTree", + "type": "*bool", + "isOptional": true, + "description": "A value indicating whether the entire process tree should be killed when the process is disposed." + }, + { + "name": "CreateProcessSpec", + "jsonName": "CreateProcessSpec", + "type": "func(...any) any", + "isOptional": true, + "isCallback": true, + "description": "A callback that creates the local process specification when the command is invoked." + }, + { + "name": "CommandOptions", + "jsonName": "CommandOptions", + "type": "*CommandOptions", + "description": "Optional command configuration." + }, + { + "name": "MaxOutputLineCount", + "jsonName": "MaxOutputLineCount", + "type": "*float64", + "isOptional": true, + "description": "The maximum number of stdout and stderr output lines returned as command result data." + }, + { + "name": "DisplayImmediately", + "jsonName": "DisplayImmediately", + "type": "*bool", + "isOptional": true, + "description": "A value indicating whether returned command output should be displayed immediately in the dashboard." + }, + { + "name": "SuccessExitCodes", + "jsonName": "SuccessExitCodes", + "type": "[]float64", + "description": "The exit codes that are treated as a successful command invocation." + } + ] + }, + { + "name": "ProcessCommandResultExportOptions", + "fullName": "Aspire.Hosting.ApplicationModel.ProcessCommandResultExportOptions", + "kind": "dto", + "description": "ATS-friendly result and command configuration for resource process commands.", + "fields": [ + { + "name": "CommandOptions", + "jsonName": "CommandOptions", + "type": "*CommandOptions", + "description": "Optional command configuration." + }, + { + "name": "MaxOutputLineCount", + "jsonName": "MaxOutputLineCount", + "type": "*float64", + "isOptional": true, + "description": "The maximum number of stdout and stderr output lines returned as command result data." + }, + { + "name": "DisplayImmediately", + "jsonName": "DisplayImmediately", + "type": "*bool", + "isOptional": true, + "description": "A value indicating whether returned command output should be displayed immediately in the dashboard." + }, + { + "name": "SuccessExitCodes", + "jsonName": "SuccessExitCodes", + "type": "[]float64", + "description": "The exit codes that are treated as a successful command invocation." + } + ] + }, + { + "name": "ProcessCommandSpecExportData", + "fullName": "Aspire.Hosting.ApplicationModel.ProcessCommandSpecExportData", + "kind": "dto", + "description": "ATS-friendly process specification for resource process command callbacks.", + "fields": [ + { + "name": "ExecutablePath", + "jsonName": "ExecutablePath", + "type": "*string", + "description": "The executable path or command name to start." + }, + { + "name": "Arguments", + "jsonName": "Arguments", + "type": "[]string", + "description": "The command-line arguments for the process." + }, + { + "name": "WorkingDirectory", + "jsonName": "WorkingDirectory", + "type": "*string", + "description": "The working directory for the process." + }, + { + "name": "EnvironmentVariables", + "jsonName": "EnvironmentVariables", + "type": "map[string]string", + "description": "The environment variables to set for the process." + }, + { + "name": "InheritEnvironmentVariables", + "jsonName": "InheritEnvironmentVariables", + "type": "*bool", + "isOptional": true, + "description": "A value indicating whether the process should inherit the current environment variables." + }, + { + "name": "StandardInputContent", + "jsonName": "StandardInputContent", + "type": "*string", + "description": "Standard input content to write to the process after it starts." + }, + { + "name": "KillEntireProcessTree", + "jsonName": "KillEntireProcessTree", + "type": "*bool", + "isOptional": true, + "description": "A value indicating whether the entire process tree should be killed when the process is disposed." + } + ] + }, + { + "name": "ResourceUrlAnnotation", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceUrlAnnotation", + "kind": "dto", + "description": "A URL that should be displayed for a resource.", + "fields": [ + { + "name": "Url", + "jsonName": "Url", + "type": "string", + "description": "The URL. When rendered as a link this will be used as the link target." + }, + { + "name": "DisplayText", + "jsonName": "DisplayText", + "type": "*string", + "description": "The name of the URL. When rendered as a link this will be used as the linked text." + }, + { + "name": "Endpoint", + "jsonName": "Endpoint", + "type": "*EndpointReference", + "isOptional": true, + "description": "The endpoint associated with this URL. Can be `null` if this URL is not associated with an endpoint." + }, + { + "name": "DisplayLocation", + "jsonName": "DisplayLocation", + "type": "UrlDisplayLocation", + "description": "Locations where this URL should be shown on the dashboard. Defaults to `SummaryAndDetails`." + } + ] + }, + { + "name": "UpdateCommandStateResourceSnapshot", + "fullName": "Aspire.Hosting.ApplicationModel.UpdateCommandStateResourceSnapshot", + "kind": "dto", + "description": "Resource snapshot data exposed to polyglot command state callbacks.", + "fields": [ + { + "name": "ResourceType", + "jsonName": "ResourceType", + "type": "string", + "description": "The type of the resource." + }, + { + "name": "State", + "jsonName": "State", + "type": "*string", + "isOptional": true, + "description": "The current lifecycle state text for the resource." + }, + { + "name": "StateStyle", + "jsonName": "StateStyle", + "type": "*string", + "isOptional": true, + "description": "The display style for the current lifecycle state." + }, + { + "name": "HealthStatus", + "jsonName": "HealthStatus", + "type": "*HealthStatus", + "isOptional": true, + "description": "The current health status for the resource." + }, + { + "name": "ExitCode", + "jsonName": "ExitCode", + "type": "*float64", + "isOptional": true, + "description": "The exit code of the resource." + } + ] + }, + { + "name": "AddContainerOptions", + "fullName": "Aspire.Hosting.Ats.AddContainerOptions", + "kind": "dto", + "description": "Options for configuring a container image in polyglot apphosts.", + "fields": [ + { + "name": "Image", + "jsonName": "Image", + "type": "string", + "description": "The container image name." + }, + { + "name": "Tag", + "jsonName": "Tag", + "type": "*string", + "isOptional": true, + "description": "The container image tag." + } + ] + }, + { + "name": "BoolInteractionResult", + "fullName": "Aspire.Hosting.Ats.BoolInteractionResult", + "kind": "dto", + "description": "The result of a boolean interaction prompt.", + "fields": [ + { + "name": "Canceled", + "jsonName": "Canceled", + "type": "bool", + "description": "Gets a value indicating whether the interaction was canceled by the user." + }, + { + "name": "Value", + "jsonName": "Value", + "type": "*bool", + "isOptional": true, + "description": "Gets the value returned from the interaction. Not meaningful when `Canceled` is `true`." + } + ] + }, + { + "name": "CertificateTrustExecutionConfigurationExportData", + "fullName": "Aspire.Hosting.Ats.CertificateTrustExecutionConfigurationExportData", + "kind": "dto", + "description": "ATS-friendly certificate trust data returned from an execution-configuration result.", + "fields": [ + { + "name": "Scope", + "jsonName": "Scope", + "type": "CertificateTrustScope", + "description": "The certificate trust scope." + }, + { + "name": "CertificateSubjects", + "jsonName": "CertificateSubjects", + "type": "[]string", + "description": "The certificate subjects included in the trust configuration." + }, + { + "name": "CustomBundlePaths", + "jsonName": "CustomBundlePaths", + "type": "[]string", + "description": "The relative custom bundle paths." + } + ] + }, + { + "name": "ContainerFilesOptions", + "fullName": "Aspire.Hosting.Ats.ContainerFilesOptions", + "kind": "dto", + "description": "Options for creating or updating files and directories in a container from polyglot apphosts.", + "fields": [ + { + "name": "DefaultOwner", + "jsonName": "DefaultOwner", + "type": "*float64", + "isOptional": true, + "description": "The default owner UID for the created or updated file system entries. Defaults to 0 for root if not set." + }, + { + "name": "DefaultGroup", + "jsonName": "DefaultGroup", + "type": "*float64", + "isOptional": true, + "description": "The default group ID for the created or updated file system entries. Defaults to 0 for root if not set." + }, + { + "name": "Umask", + "jsonName": "Umask", + "type": "*float64", + "isOptional": true, + "description": "The Unix umask to apply to files or directories without explicit permissions. Use octal literals in JavaScript or TypeScript, for example `0o022`." + } + ] + }, + { + "name": "CreateBuilderOptions", + "fullName": "Aspire.Hosting.Ats.CreateBuilderOptions", + "kind": "dto", + "description": "Options for creating a distributed application builder from polyglot apphosts.", + "fields": [ + { + "name": "Args", + "jsonName": "Args", + "type": "[]string", + "description": "The command line arguments." + }, + { + "name": "ProjectDirectory", + "jsonName": "ProjectDirectory", + "type": "*string", + "description": "The directory containing the AppHost project file." + }, + { + "name": "AppHostFilePath", + "jsonName": "AppHostFilePath", + "type": "*string", + "description": "The full path to the AppHost file (e.g., apphost.ts, apphost.py). Used for consistent socket path computation across CLI and AppHost." + }, + { + "name": "ContainerRegistryOverride", + "jsonName": "ContainerRegistryOverride", + "type": "*string", + "description": "When containers are used, use this value to override the container registry." + }, + { + "name": "DisableDashboard", + "jsonName": "DisableDashboard", + "type": "bool", + "description": "Determines whether the dashboard is disabled." + }, + { + "name": "DashboardApplicationName", + "jsonName": "DashboardApplicationName", + "type": "*string", + "description": "The application name to display in the dashboard." + }, + { + "name": "AllowUnsecuredTransport", + "jsonName": "AllowUnsecuredTransport", + "type": "bool", + "description": "Allows the use of HTTP urls for the AppHost resource endpoint." + }, + { + "name": "EnableResourceLogging", + "jsonName": "EnableResourceLogging", + "type": "bool", + "description": "Enables resource logging." + } + ] + }, + { + "name": "CreateInteractionInputOptions", + "fullName": "Aspire.Hosting.Ats.CreateInteractionInputOptions", + "kind": "dto", + "description": "Optional configuration shared by interaction input factory capabilities.", + "fields": [ + { + "name": "Label", + "jsonName": "Label", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the label for the input. Defaults to the input name when not specified." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the description for the input." + }, + { + "name": "EnableDescriptionMarkdown", + "jsonName": "EnableDescriptionMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the description is rendered as Markdown." + }, + { + "name": "Required", + "jsonName": "Required", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the input is required." + }, + { + "name": "Placeholder", + "jsonName": "Placeholder", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the placeholder text for the input." + }, + { + "name": "Value", + "jsonName": "Value", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the initial value of the input." + }, + { + "name": "AllowCustomChoice", + "jsonName": "AllowCustomChoice", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether a custom choice is allowed. Only used by choice inputs." + }, + { + "name": "Disabled", + "jsonName": "Disabled", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the input is disabled." + }, + { + "name": "MaxLength", + "jsonName": "MaxLength", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the maximum length for text inputs." + }, + { + "name": "MaxFileSize", + "jsonName": "MaxFileSize", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the maximum file size in bytes for file inputs." + }, + { + "name": "AllowMultipleFiles", + "jsonName": "AllowMultipleFiles", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether multiple files can be selected. Only used by file inputs." + }, + { + "name": "FileFilter", + "jsonName": "FileFilter", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the file type filter for file inputs. Uses the same format as the HTML accept attribute. The CLI validates only dot-prefixed extension filters and does not validate MIME type patterns such as \"image/*\"." + } + ] + }, + { + "name": "DynamicLoadingOptions", + "fullName": "Aspire.Hosting.Ats.DynamicLoadingOptions", + "kind": "dto", + "description": "Options controlling when a dynamic-loading callback runs.", + "fields": [ + { + "name": "AlwaysLoadOnStart", + "jsonName": "AlwaysLoadOnStart", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the callback always runs at the start of the prompt." + }, + { + "name": "DependsOnInputs", + "jsonName": "DependsOnInputs", + "type": "[]string", + "isOptional": true, + "description": "Gets or sets the names of inputs this input depends on. The callback runs when any of them change." + } + ] + }, + { + "name": "HealthCheckResult", + "fullName": "Aspire.Hosting.Ats.HealthCheckResult", + "kind": "dto", + "description": "ATS-friendly custom health check result.", + "fields": [ + { + "name": "Status", + "jsonName": "Status", + "type": "HealthStatus", + "description": "Gets the health status returned by the health check." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "isOptional": true, + "description": "Gets an optional description for the health check result." + }, + { + "name": "Data", + "jsonName": "Data", + "type": "map[string]string", + "isOptional": true, + "description": "Gets optional string data for the health check result." + } + ] + }, + { + "name": "HttpsCertificateExecutionConfigurationExportData", + "fullName": "Aspire.Hosting.Ats.HttpsCertificateExecutionConfigurationExportData", + "kind": "dto", + "description": "ATS-friendly HTTPS certificate data returned from an execution-configuration result.", + "fields": [ + { + "name": "Subject", + "jsonName": "Subject", + "type": "string", + "description": "The certificate subject." + }, + { + "name": "Thumbprint", + "jsonName": "Thumbprint", + "type": "*string", + "isOptional": true, + "description": "The certificate thumbprint." + }, + { + "name": "KeyPathExpression", + "jsonName": "KeyPathExpression", + "type": "string", + "description": "The expression for the key path reference." + }, + { + "name": "PfxPathExpression", + "jsonName": "PfxPathExpression", + "type": "string", + "description": "The expression for the PFX path reference." + }, + { + "name": "IsKeyPathReferenced", + "jsonName": "IsKeyPathReferenced", + "type": "bool", + "description": "Indicates whether the key path was referenced." + }, + { + "name": "IsCertificateWithKeyPathReferenced", + "jsonName": "IsCertificateWithKeyPathReferenced", + "type": "bool", + "description": "Indicates whether the key path was referenced." + }, + { + "name": "IsPfxPathReferenced", + "jsonName": "IsPfxPathReferenced", + "type": "bool", + "description": "Indicates whether the PFX path was referenced." + }, + { + "name": "Password", + "jsonName": "Password", + "type": "*string", + "isOptional": true, + "description": "The certificate password, if any." + } + ] + }, + { + "name": "HttpsCertificateInfo", + "fullName": "Aspire.Hosting.Ats.HttpsCertificateInfo", + "kind": "dto", + "description": "ATS-friendly certificate metadata supplied to HTTPS certificate configuration callbacks.", + "fields": [ + { + "name": "Subject", + "jsonName": "Subject", + "type": "string", + "description": "The certificate subject." + }, + { + "name": "Issuer", + "jsonName": "Issuer", + "type": "string", + "description": "The certificate issuer." + }, + { + "name": "Thumbprint", + "jsonName": "Thumbprint", + "type": "*string", + "isOptional": true, + "description": "The certificate thumbprint." + } + ] + }, + { + "name": "InputInteractionResult", + "fullName": "Aspire.Hosting.Ats.InputInteractionResult", + "kind": "dto", + "description": "The result of a single-input interaction prompt.", + "fields": [ + { + "name": "Canceled", + "jsonName": "Canceled", + "type": "bool", + "description": "Gets a value indicating whether the interaction was canceled by the user." + }, + { + "name": "Input", + "jsonName": "Input", + "type": "*InteractionInput", + "isOptional": true, + "description": "Gets the input returned from the interaction. Not present when `Canceled` is `true`." + } + ] + }, + { + "name": "InteractionChoiceOption", + "fullName": "Aspire.Hosting.Ats.InteractionChoiceOption", + "kind": "dto", + "description": "A single selectable option for a choice input. Options are presented in the order supplied.", + "fields": [ + { + "name": "Value", + "jsonName": "Value", + "type": "string", + "description": "Gets or sets the value submitted when this option is selected." + }, + { + "name": "Label", + "jsonName": "Label", + "type": "string", + "description": "Gets or sets the label displayed for this option." + } + ] + }, + { + "name": "InteractionInputsDialogOptions", + "fullName": "Aspire.Hosting.Ats.InteractionInputsDialogOptions", + "kind": "dto", + "description": "Options for inputs dialog prompts.", + "fields": [ + { + "name": "PrimaryButtonText", + "jsonName": "PrimaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the primary button text." + }, + { + "name": "SecondaryButtonText", + "jsonName": "SecondaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the secondary button text." + }, + { + "name": "ShowSecondaryButton", + "jsonName": "ShowSecondaryButton", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the secondary button is shown." + }, + { + "name": "ShowDismiss", + "jsonName": "ShowDismiss", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the dismiss button is shown." + }, + { + "name": "EnableMessageMarkdown", + "jsonName": "EnableMessageMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether Markdown in the message is rendered." + }, + { + "name": "ValidationCallback", + "jsonName": "ValidationCallback", + "type": "func(...any) any", + "isOptional": true, + "isCallback": true, + "description": "Gets or sets a callback invoked to validate the inputs before the dialog is accepted. The callback receives a validation context that exposes the current inputs and can record validation errors." + } + ] + }, + { + "name": "InteractionMessageBoxOptions", + "fullName": "Aspire.Hosting.Ats.InteractionMessageBoxOptions", + "kind": "dto", + "description": "Options for message box and confirmation prompts.", + "fields": [ + { + "name": "PrimaryButtonText", + "jsonName": "PrimaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the primary button text." + }, + { + "name": "SecondaryButtonText", + "jsonName": "SecondaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the secondary button text." + }, + { + "name": "ShowSecondaryButton", + "jsonName": "ShowSecondaryButton", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the secondary button is shown." + }, + { + "name": "ShowDismiss", + "jsonName": "ShowDismiss", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the dismiss button is shown." + }, + { + "name": "EnableMessageMarkdown", + "jsonName": "EnableMessageMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether Markdown in the message is rendered." + }, + { + "name": "Intent", + "jsonName": "Intent", + "type": "*MessageIntent", + "isOptional": true, + "description": "Gets or sets the intent of the message box." + } + ] + }, + { + "name": "InteractionNotificationOptions", + "fullName": "Aspire.Hosting.Ats.InteractionNotificationOptions", + "kind": "dto", + "description": "Options for notification prompts.", + "fields": [ + { + "name": "PrimaryButtonText", + "jsonName": "PrimaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the primary button text." + }, + { + "name": "SecondaryButtonText", + "jsonName": "SecondaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the secondary button text." + }, + { + "name": "ShowSecondaryButton", + "jsonName": "ShowSecondaryButton", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the secondary button is shown." + }, + { + "name": "ShowDismiss", + "jsonName": "ShowDismiss", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the dismiss button is shown." + }, + { + "name": "EnableMessageMarkdown", + "jsonName": "EnableMessageMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether Markdown in the message is rendered." + }, + { + "name": "Intent", + "jsonName": "Intent", + "type": "*MessageIntent", + "isOptional": true, + "description": "Gets or sets the intent of the notification." + }, + { + "name": "LinkText", + "jsonName": "LinkText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the text for a link in the notification." + }, + { + "name": "LinkUrl", + "jsonName": "LinkUrl", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the URL for the link in the notification." + } + ] + }, + { + "name": "InteractionProgressOptions", + "fullName": "Aspire.Hosting.Ats.InteractionProgressOptions", + "kind": "dto", + "description": "Options for progress dialog prompts.", + "fields": [ + { + "name": "Title", + "jsonName": "Title", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the optional title of the progress dialog." + }, + { + "name": "PrimaryButtonText", + "jsonName": "PrimaryButtonText", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the primary button text (e.g. \"Cancel\")." + }, + { + "name": "EnableMessageMarkdown", + "jsonName": "EnableMessageMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether Markdown in the message is rendered." + }, + { + "name": "Work", + "jsonName": "Work", + "type": "func(...any) any", + "isOptional": true, + "isCallback": true, + "description": "Gets or sets an optional asynchronous work callback to execute while the progress dialog is displayed. When provided, the progress dialog remains open while this callback executes and closes automatically when the callback completes." + } + ] + }, + { + "name": "ParameterCustomInputOptions", + "fullName": "Aspire.Hosting.Ats.ParameterCustomInputOptions", + "kind": "dto", + "description": "Options for customizing parameter inputs from polyglot AppHosts.", + "fields": [ + { + "name": "InputType", + "jsonName": "InputType", + "type": "*InputType", + "isOptional": true, + "description": "Gets or sets the type of the input." + }, + { + "name": "Label", + "jsonName": "Label", + "type": "*string", + "description": "Gets or sets the label for the input." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Gets or sets the description for the input." + }, + { + "name": "EnableDescriptionMarkdown", + "jsonName": "EnableDescriptionMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets whether the description should be rendered as Markdown." + }, + { + "name": "Options", + "jsonName": "Options", + "type": "map[string]string", + "description": "Gets or sets the choice options keyed by submitted value." + }, + { + "name": "Value", + "jsonName": "Value", + "type": "*string", + "description": "Gets or sets the initial value of the input." + }, + { + "name": "Placeholder", + "jsonName": "Placeholder", + "type": "*string", + "description": "Gets or sets the placeholder text for the input." + }, + { + "name": "AllowCustomChoice", + "jsonName": "AllowCustomChoice", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets whether custom choices are allowed." + }, + { + "name": "Disabled", + "jsonName": "Disabled", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets whether the input is disabled." + }, + { + "name": "MaxLength", + "jsonName": "MaxLength", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the maximum length for text inputs." + } + ] + }, + { + "name": "ReferenceEnvironmentInjectionOptions", + "fullName": "Aspire.Hosting.Ats.ReferenceEnvironmentInjectionOptions", + "kind": "dto", + "description": "Options that control which reference information is injected into environment variables.", + "fields": [ + { + "name": "ConnectionString", + "jsonName": "ConnectionString", + "type": "bool", + "description": "Injects the connection string environment variable." + }, + { + "name": "ConnectionProperties", + "jsonName": "ConnectionProperties", + "type": "bool", + "description": "Injects individual connection property environment variables." + }, + { + "name": "ServiceDiscovery", + "jsonName": "ServiceDiscovery", + "type": "bool", + "description": "Injects service discovery environment variables." + }, + { + "name": "Endpoints", + "jsonName": "Endpoints", + "type": "bool", + "description": "Injects endpoint environment variables." + } + ] + }, + { + "name": "ResourceEventDto", + "fullName": "Aspire.Hosting.Ats.ResourceEventDto", + "kind": "dto", + "description": "DTO for resource events returned from notification service.", + "fields": [ + { + "name": "ResourceName", + "jsonName": "ResourceName", + "type": "string", + "description": "The resource name." + }, + { + "name": "ResourceId", + "jsonName": "ResourceId", + "type": "string", + "description": "The unique resource ID." + }, + { + "name": "State", + "jsonName": "State", + "type": "*string", + "isOptional": true, + "description": "The current state text." + }, + { + "name": "StateStyle", + "jsonName": "StateStyle", + "type": "*string", + "isOptional": true, + "description": "The state style (e.g., \"success\", \"warn\", \"error\")." + }, + { + "name": "HealthStatus", + "jsonName": "HealthStatus", + "type": "*string", + "isOptional": true, + "description": "The health status of the resource." + }, + { + "name": "ExitCode", + "jsonName": "ExitCode", + "type": "*float64", + "isOptional": true, + "description": "The exit code if the resource has exited." + } + ] + }, + { + "name": "InteractionInput", + "fullName": "Aspire.Hosting.InteractionInput", + "kind": "dto", + "description": "Represents an input for an interaction.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "string", + "description": "Gets or sets the name for the input. Used for accessing inputs by name from a keyed collection." + }, + { + "name": "Label", + "jsonName": "Label", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the label for the input. If not specified, the name will be used as the label." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the description for the input." + }, + { + "name": "EnableDescriptionMarkdown", + "jsonName": "EnableDescriptionMarkdown", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the description should be rendered as Markdown. Setting this to `true` allows a description to contain Markdown elements such as links, text decoration and lists." + }, + { + "name": "InputType", + "jsonName": "InputType", + "type": "InputType", + "description": "Gets or sets the type of the input." + }, + { + "name": "Required", + "jsonName": "Required", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the input is required." + }, + { + "name": "Options", + "jsonName": "Options", + "type": "[]any", + "description": "Gets or sets the options for the input. Only used by `Choice` inputs." + }, + { + "name": "Value", + "jsonName": "Value", + "type": "*string", + "description": "Gets or sets the value of the input." + }, + { + "name": "Placeholder", + "jsonName": "Placeholder", + "type": "*string", + "isOptional": true, + "description": "Gets the placeholder text for the input." + }, + { + "name": "AllowCustomChoice", + "jsonName": "AllowCustomChoice", + "type": "*bool", + "isOptional": true, + "description": "Gets a value indicating whether a custom choice is allowed. Only used by `Choice` inputs." + }, + { + "name": "Disabled", + "jsonName": "Disabled", + "type": "bool", + "description": "Gets or sets a value indicating whether the input is disabled." + }, + { + "name": "MaxLength", + "jsonName": "MaxLength", + "type": "*float64", + "isOptional": true, + "description": "gets or sets the maximum length for text inputs." + }, + { + "name": "AllowMultipleFiles", + "jsonName": "AllowMultipleFiles", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether multiple files can be selected. Only used by `File` inputs." + }, + { + "name": "FileFilter", + "jsonName": "FileFilter", + "type": "*string", + "isOptional": true, + "description": "Gets or sets the file type filter for `File` inputs. Uses the same format as the HTML `accept` attribute, e.g. `\".pem,.pfx,.crt\"` or `\"image/*\"`. When set, the file picker restricts selectable files. The CLI validates only dot-prefixed extension filters and does not validate MIME type patterns such as `\"image/*\"`." + }, + { + "name": "MaxFileSize", + "jsonName": "MaxFileSize", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the maximum file size in bytes for `File` inputs. If not specified, the server applies the configured upload limit (default 100 MB). When specified, the value is capped at the server-side upload limit." + } + ] + }, + { + "name": "RunConfiguration", + "fullName": "Aspire.Hosting.RunConfiguration", + "kind": "dto", + "description": "Holds settings applicable to the AppHost run mode (when `Operation` is `Run`).", + "remarks": "Integrations use it to vary how their resources are launched without changing the core hosting behavior.\nIn `Publish` mode every property holds its default value.", + "fields": [ + { + "name": "WatchEnabled", + "jsonName": "WatchEnabled", + "type": "*bool", + "isOptional": true, + "description": "Indicates that resources should start in watch mode if able." + } + ] + } + ], + "enumTypes": [ + { + "name": "CertificateTrustScope", + "fullName": "Aspire.Hosting.ApplicationModel.CertificateTrustScope", + "kind": "enum", + "description": "Defines the scope of custom certificate authorities for a resource. The default scope for most resources is `Append`, but some resources may choose to override this default behavior.", + "members": [ + { + "name": "CertificateTrustScopeNone", + "value": "None", + "description": "Disable all custom certificate authority configuration for a resource. This indicates that the resource should use its default certificate authority trust behavior without modification." + }, + { + "name": "CertificateTrustScopeAppend", + "value": "Append", + "description": "Append the specified certificate authorities to the default set of trusted CAs for a resource. Not all resources support this mode, in which case custom certificate authorities may not be applied. In that case, consider using `Override` or `System` instead. This is the default mode unless otherwise specified." + }, + { + "name": "CertificateTrustScopeOverride", + "value": "Override", + "description": "Replace the default set of trusted CAs for a resource with the specified certificate authorities. This mode indicates that only the provided custom certificate authorities should be considered trusted by the resource." + }, + { + "name": "CertificateTrustScopeSystem", + "value": "System", + "description": "Attempt to configure the resource to trust the default system certificate authorities in addition to any configured custom certificate trust. This mode is useful for resources that don't otherwise allow appending to their default trusted certificate authorities but do allow overriding the set of trusted certificates (e.g. Python, Rust, etc.)." + } + ] + }, + { + "name": "CommandResultFormat", + "fullName": "Aspire.Hosting.ApplicationModel.CommandResultFormat", + "kind": "enum", + "description": "Specifies the format of a command result.", + "members": [ + { + "name": "CommandResultFormatText", + "value": "Text", + "description": "Plain text result." + }, + { + "name": "CommandResultFormatJson", + "value": "Json", + "description": "JSON result." + }, + { + "name": "CommandResultFormatMarkdown", + "value": "Markdown", + "description": "Markdown result." + } + ] + }, + { + "name": "ContainerLifetime", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerLifetime", + "kind": "enum", + "description": "Lifetime modes for container resources.", + "members": [ + { + "name": "ContainerLifetimeSession", + "value": "Session", + "description": "Create the resource when the AppHost process starts and dispose of it when the AppHost process shuts down." + }, + { + "name": "ContainerLifetimePersistent", + "value": "Persistent", + "description": "Attempt to re-use a previously created resource (based on the container name) if one exists. Do not destroy the container on AppHost process shutdown.", + "remarks": "In the event that a container with the given name does not exist, a new container will always be created based on the\ncurrent `ContainerResource` configuration.\nWhen an existing container IS found, Aspire MAY re-use it based on the following criteria:\n-\n-\n-" + } + ] + }, + { + "name": "ContainerMountType", + "fullName": "Aspire.Hosting.ApplicationModel.ContainerMountType", + "kind": "enum", + "description": "Represents the type of a container mount.", + "members": [ + { + "name": "ContainerMountTypeBindMount", + "value": "BindMount", + "description": "A local directory or file that is mounted into the container." + }, + { + "name": "ContainerMountTypeVolume", + "value": "Volume", + "description": "A volume." + } + ] + }, + { + "name": "EndpointProperty", + "fullName": "Aspire.Hosting.ApplicationModel.EndpointProperty", + "kind": "enum", + "description": "Represents the properties of an endpoint that can be referenced.", + "members": [ + { + "name": "EndpointPropertyUrl", + "value": "Url", + "description": "The entire URL of the endpoint." + }, + { + "name": "EndpointPropertyHost", + "value": "Host", + "description": "The host of the endpoint." + }, + { + "name": "EndpointPropertyIPV4Host", + "value": "IPV4Host", + "description": "The IPv4 address of the endpoint." + }, + { + "name": "EndpointPropertyPort", + "value": "Port", + "description": "The port of the endpoint." + }, + { + "name": "EndpointPropertyScheme", + "value": "Scheme", + "description": "The scheme of the endpoint." + }, + { + "name": "EndpointPropertyTargetPort", + "value": "TargetPort", + "description": "The target port of the endpoint." + }, + { + "name": "EndpointPropertyHostAndPort", + "value": "HostAndPort", + "description": "The host and port of the endpoint in the format `{Host}:{Port}`." + }, + { + "name": "EndpointPropertyTlsEnabled", + "value": "TlsEnabled", + "description": "Whether TLS is enabled on the endpoint. Returns `TrueString` or `FalseString`." + } + ] + }, + { + "name": "HttpCommandResultMode", + "fullName": "Aspire.Hosting.ApplicationModel.HttpCommandResultMode", + "kind": "enum", + "description": "Specifies how an HTTP command should surface the HTTP response body as command result data.", + "members": [ + { + "name": "HttpCommandResultModeNone", + "value": "None", + "description": "Do not capture the HTTP response body as command result data." + }, + { + "name": "HttpCommandResultModeAuto", + "value": "Auto", + "description": "Infer the command result format from the HTTP response content type." + }, + { + "name": "HttpCommandResultModeJson", + "value": "Json", + "description": "Return the HTTP response body as JSON command result data." + }, + { + "name": "HttpCommandResultModeText", + "value": "Text", + "description": "Return the HTTP response body as plain text command result data." + } + ] + }, + { + "name": "IconVariant", + "fullName": "Aspire.Hosting.ApplicationModel.IconVariant", + "kind": "enum", + "description": "The icon variant.", + "members": [ + { + "name": "IconVariantRegular", + "value": "Regular", + "description": "Regular variant of icons." + }, + { + "name": "IconVariantFilled", + "value": "Filled", + "description": "Filled variant of icons." + } + ] + }, + { + "name": "ImagePullPolicy", + "fullName": "Aspire.Hosting.ApplicationModel.ImagePullPolicy", + "kind": "enum", + "description": "Image pull policies for container resources.", + "members": [ + { + "name": "ImagePullPolicyDefault", + "value": "Default", + "description": "Default image pull policy behavior. Currently this will be the same as the default behavior for your container runtime." + }, + { + "name": "ImagePullPolicyAlways", + "value": "Always", + "description": "Always pull the image when creating the container." + }, + { + "name": "ImagePullPolicyMissing", + "value": "Missing", + "description": "Pull the image only if it does not already exist." + }, + { + "name": "ImagePullPolicyNever", + "value": "Never", + "description": "Never pull the image from the registry even if it is missing locally." + } + ] + }, + { + "name": "ProbeType", + "fullName": "Aspire.Hosting.ApplicationModel.ProbeType", + "kind": "enum", + "description": "Enum representing the type of probe.", + "members": [ + { + "name": "ProbeTypeStartup", + "value": "Startup", + "description": "Startup probe." + }, + { + "name": "ProbeTypeReadiness", + "value": "Readiness", + "description": "Readiness probe." + }, + { + "name": "ProbeTypeLiveness", + "value": "Liveness", + "description": "Liveness probe." + } + ] + }, + { + "name": "ResourceCommandState", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceCommandState", + "kind": "enum", + "description": "The state of a resource command.", + "members": [ + { + "name": "ResourceCommandStateEnabled", + "value": "Enabled", + "description": "Command is visible and enabled for use." + }, + { + "name": "ResourceCommandStateDisabled", + "value": "Disabled", + "description": "Command is visible and disabled for use." + }, + { + "name": "ResourceCommandStateHidden", + "value": "Hidden", + "description": "Command is hidden." + } + ] + }, + { + "name": "ResourceCommandVisibility", + "fullName": "Aspire.Hosting.ApplicationModel.ResourceCommandVisibility", + "kind": "enum", + "description": "Describes where a resource command is visible.", + "members": [ + { + "name": "ResourceCommandVisibilityNone", + "value": "None", + "description": "The command is not visible to any clients." + }, + { + "name": "ResourceCommandVisibilityUI", + "value": "UI", + "description": "The command is displayed in UI clients." + }, + { + "name": "ResourceCommandVisibilityApi", + "value": "Api", + "description": "The command is exposed through resource command API discovery." + } + ] + }, + { + "name": "UrlDisplayLocation", + "fullName": "Aspire.Hosting.ApplicationModel.UrlDisplayLocation", + "kind": "enum", + "description": "Specifies where the URL should be displayed.", + "members": [ + { + "name": "UrlDisplayLocationSummaryAndDetails", + "value": "SummaryAndDetails", + "description": "Show the URL in locations where either the resource summary or resource details are being displayed." + }, + { + "name": "UrlDisplayLocationDetailsOnly", + "value": "DetailsOnly", + "description": "Show the URL in locations where the full details of the resource are being displayed." + } + ] + }, + { + "name": "WaitBehavior", + "fullName": "Aspire.Hosting.ApplicationModel.WaitBehavior", + "kind": "enum", + "description": "Specifies the behavior of the wait.", + "members": [ + { + "name": "WaitBehaviorWaitOnResourceUnavailable", + "value": "WaitOnResourceUnavailable", + "description": "If the resource is unavailable, continue waiting." + }, + { + "name": "WaitBehaviorStopOnResourceUnavailable", + "value": "StopOnResourceUnavailable", + "description": "If the resource is unavailable, stop waiting." + } + ] + }, + { + "name": "DistributedApplicationOperation", + "fullName": "Aspire.Hosting.DistributedApplicationOperation", + "kind": "enum", + "description": "Describes the context in which the AppHost is being executed.", + "members": [ + { + "name": "DistributedApplicationOperationRun", + "value": "Run", + "description": "AppHost is being run for the purpose of debugging locally." + }, + { + "name": "DistributedApplicationOperationPublish", + "value": "Publish", + "description": "AppHost is being run for the purpose of publishing a manifest for deployment." + } + ] + }, + { + "name": "InputType", + "fullName": "Aspire.Hosting.InputType", + "kind": "enum", + "description": "Specifies the type of input for an `InteractionInput`.", + "members": [ + { + "name": "InputTypeText", + "value": "Text", + "description": "A single-line text input." + }, + { + "name": "InputTypeSecretText", + "value": "SecretText", + "description": "A secure text input." + }, + { + "name": "InputTypeChoice", + "value": "Choice", + "description": "A choice input. Selects from a list of options." + }, + { + "name": "InputTypeBoolean", + "value": "Boolean", + "description": "A boolean input." + }, + { + "name": "InputTypeNumber", + "value": "Number", + "description": "A numeric input." + }, + { + "name": "InputTypeFile", + "value": "File", + "description": "A file input. Allows the user to select a file using the OS/browser file picker." + } + ] + }, + { + "name": "MessageIntent", + "fullName": "Aspire.Hosting.MessageIntent", + "kind": "enum", + "description": "Specifies the intent or purpose of a message in an interaction.", + "members": [ + { + "name": "MessageIntentNone", + "value": "None", + "description": "No specific intent." + }, + { + "name": "MessageIntentSuccess", + "value": "Success", + "description": "Indicates a successful operation." + }, + { + "name": "MessageIntentWarning", + "value": "Warning", + "description": "Indicates a warning." + }, + { + "name": "MessageIntentError", + "value": "Error", + "description": "Indicates an error." + }, + { + "name": "MessageIntentInformation", + "value": "Information", + "description": "Provides informational content." + }, + { + "name": "MessageIntentConfirmation", + "value": "Confirmation", + "description": "Requests confirmation from the user." + } + ] + }, + { + "name": "OtlpProtocol", + "fullName": "Aspire.Hosting.OtlpProtocol", + "kind": "enum", + "description": "Protocols available for OTLP exporters.", + "members": [ + { + "name": "OtlpProtocolGrpc", + "value": "Grpc", + "description": "A gRPC-based OTLP exporter." + }, + { + "name": "OtlpProtocolHttpProtobuf", + "value": "HttpProtobuf", + "description": "Http/Protobuf-based OTLP exporter." + }, + { + "name": "OtlpProtocolHttpJson", + "value": "HttpJson", + "description": "Http/JSON-based OTLP exporter." + } + ] + }, + { + "name": "ContainerImageDestination", + "fullName": "Aspire.Hosting.Publishing.ContainerImageDestination", + "kind": "enum", + "description": "Specifies the destination for container images.", + "members": [ + { + "name": "ContainerImageDestinationRegistry", + "value": "Registry", + "description": "Image will be pushed to a container registry." + }, + { + "name": "ContainerImageDestinationArchive", + "value": "Archive", + "description": "Image will be saved as an archive file." + } + ] + }, + { + "name": "ContainerImageFormat", + "fullName": "Aspire.Hosting.Publishing.ContainerImageFormat", + "kind": "enum", + "description": "Specifies the format for container images.", + "members": [ + { + "name": "ContainerImageFormatDocker", + "value": "Docker", + "description": "Docker format (default)." + }, + { + "name": "ContainerImageFormatOci", + "value": "Oci", + "description": "OCI format." + } + ] + }, + { + "name": "ContainerTargetPlatform", + "fullName": "Aspire.Hosting.Publishing.ContainerTargetPlatform", + "kind": "enum", + "description": "Specifies the target platform for container images.", + "members": [ + { + "name": "ContainerTargetPlatformLinuxAmd64", + "value": "LinuxAmd64", + "description": "Linux AMD64 (linux/amd64)." + }, + { + "name": "ContainerTargetPlatformLinuxArm64", + "value": "LinuxArm64", + "description": "Linux ARM64 (linux/arm64)." + }, + { + "name": "ContainerTargetPlatformAllLinux", + "value": "AllLinux", + "description": "All Linux platforms (AMD64 and ARM64)." + }, + { + "name": "ContainerTargetPlatformLinuxArm", + "value": "LinuxArm", + "description": "Linux ARM (linux/arm)." + }, + { + "name": "ContainerTargetPlatformLinux386", + "value": "Linux386", + "description": "Linux 386 (linux/386)." + }, + { + "name": "ContainerTargetPlatformWindowsAmd64", + "value": "WindowsAmd64", + "description": "Windows AMD64 (windows/amd64)." + }, + { + "name": "ContainerTargetPlatformWindowsArm64", + "value": "WindowsArm64", + "description": "Windows ARM64 (windows/arm64)." + } + ] + } + ], + "exportedValues": [ + { + "name": "WellKnownPipelineSteps", + "fullName": "WellKnownPipelineSteps", + "kind": "exportedValue", + "values": [ + { + "path": "BeforeStart", + "type": "string", + "value": "\"before-start\"", + "description": "The step that runs before the application starts." + }, + { + "path": "Build", + "type": "string", + "value": "\"build\"", + "description": "The well-known step for building resources." + }, + { + "path": "BuildPrereq", + "type": "string", + "value": "\"build-prereq\"", + "description": "The prerequisite step that runs before any build operations." + }, + { + "path": "CheckContainerRuntime", + "type": "string", + "value": "\"check-container-runtime\"", + "description": "The step that checks whether the container runtime (e.g., Docker or Podman) is running. Build steps that need a container runtime should depend on this step." + }, + { + "path": "Deploy", + "type": "string", + "value": "\"deploy\"", + "description": "Aggregation step for all deploy operations. All deploy steps should be required by this step." + }, + { + "path": "DeployPrereq", + "type": "string", + "value": "\"deploy-prereq\"", + "description": "The prerequisite step that runs before any deploy operations." + }, + { + "path": "Destroy", + "type": "string", + "value": "\"destroy\"", + "description": "Aggregation step for all destroy operations. All destroy steps should be required by this step." + }, + { + "path": "DestroyPrereq", + "type": "string", + "value": "\"destroy-prereq\"", + "description": "The prerequisite step that runs before any destroy operations." + }, + { + "path": "Diagnostics", + "type": "string", + "value": "\"diagnostics\"", + "description": "The diagnostic step that dumps dependency graph information for troubleshooting." + }, + { + "path": "ProcessParameters", + "type": "string", + "value": "\"process-parameters\"", + "description": "The step that prompts for parameter values before build, publish, or deployment operations." + }, + { + "path": "Publish", + "type": "string", + "value": "\"publish\"", + "description": "Aggregation step for all publish operations. All publish steps should be required by this step." + }, + { + "path": "PublishPrereq", + "type": "string", + "value": "\"publish-prereq\"", + "description": "The prerequisite step that runs before any publish operations." + }, + { + "path": "Push", + "type": "string", + "value": "\"push\"", + "description": "The meta-step that coordinates all push operations. All push steps should be required by this step." + }, + { + "path": "PushPrereq", + "type": "string", + "value": "\"push-prereq\"", + "description": "The prerequisite step that runs before any push operations." + }, + { + "path": "ValidateComputeEnvironments", + "type": "string", + "value": "\"validate-compute-environments\"", + "description": "The step that validates compute resources are assigned to unambiguous compute environments." + } + ] + }, + { + "name": "WellKnownPipelineTags", + "fullName": "WellKnownPipelineTags", + "kind": "exportedValue", + "values": [ + { + "path": "BuildCompute", + "type": "string", + "value": "\"build-compute\"", + "description": "Tag for steps that build compute resources." + }, + { + "path": "DeployCompute", + "type": "string", + "value": "\"deploy-compute\"", + "description": "Tag for steps that deploy to compute infrastructure." + }, + { + "path": "ProvisionInfrastructure", + "type": "string", + "value": "\"provision-infra\"", + "description": "Tag for steps that provision infrastructure resources." + }, + { + "path": "PushContainerImage", + "type": "string", + "value": "\"push-container-image\"", + "description": "Tag for steps that push container images to a registry." + } + ] + } + ] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.AWS.13.7.2.json b/src/frontend/src/data/go-modules/Aspire.Hosting.AWS.13.7.2.json new file mode 100644 index 0000000000..e2deed04f1 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.AWS.13.7.2.json @@ -0,0 +1,942 @@ +{ + "package": { + "name": "Aspire.Hosting.AWS", + "version": "13.7.2", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/aws/integrations-on-dotnet-aspire-for-aws" + }, + "functions": [ + { + "name": "AddAWSAPIGatewayEmulator", + "capabilityId": "Aspire.Hosting.AWS/addAWSAPIGatewayEmulator", + "qualifiedName": "addAWSAPIGatewayEmulator", + "kind": "Method", + "signature": "AddAWSAPIGatewayEmulator(name string, apiGatewayType APIGatewayType, options ...*APIGatewayEmulatorOptions) APIGatewayEmulatorResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "apiGatewayType", + "type": "APIGatewayType" + } + ], + "options": { + "typeName": "APIGatewayEmulatorOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "APIGatewayEmulatorResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAWSDynamoDBLocal", + "capabilityId": "Aspire.Hosting.AWS/addAWSDynamoDBLocal", + "qualifiedName": "addAWSDynamoDBLocal", + "kind": "Method", + "signature": "AddAWSDynamoDBLocal(name string, options ...*DynamoDBLocalOptions) DynamoDBLocalResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "DynamoDBLocalOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "DynamoDBLocalResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAWSLambdaFunction", + "capabilityId": "Aspire.Hosting.AWS/addAWSLambdaFunction", + "qualifiedName": "addAWSLambdaFunction", + "kind": "Method", + "signature": "AddAWSLambdaFunction(name string, projectPath string, lambdaHandler string, options ...*LambdaFunctionPolyglotOptions) LambdaProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "projectPath", + "type": "string" + }, + { + "name": "lambdaHandler", + "type": "string" + } + ], + "options": { + "typeName": "LambdaFunctionPolyglotOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "LambdaProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAWSLambdaServiceEmulator", + "capabilityId": "Aspire.Hosting.AWS/addAWSLambdaServiceEmulator", + "qualifiedName": "addAWSLambdaServiceEmulator", + "kind": "Method", + "signature": "AddAWSLambdaServiceEmulator(options ...*LambdaEmulatorOptions) LambdaEmulatorResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "options": { + "typeName": "LambdaEmulatorOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "LambdaEmulatorResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAWSSDKConfig", + "capabilityId": "Aspire.Hosting.AWS/addAWSSDKConfig", + "qualifiedName": "addAWSSDKConfig", + "kind": "Method", + "signature": "AddAWSSDKConfig() AWSSDKConfig", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "AWSSDKConfig", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithAPIGatewayLambdaReference", + "capabilityId": "Aspire.Hosting.AWS/withAPIGatewayLambdaReference", + "qualifiedName": "withAPIGatewayLambdaReference", + "kind": "Method", + "signature": "WithAPIGatewayLambdaReference(lambda LambdaProjectResource, httpMethod Method, path string) APIGatewayEmulatorResource", + "receiver": "APIGatewayEmulatorResource", + "parameters": [ + { + "name": "lambda", + "type": "LambdaProjectResource" + }, + { + "name": "httpMethod", + "type": "Method" + }, + { + "name": "path", + "type": "string" + } + ], + "returnType": "APIGatewayEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource" + ], + "appliesTo": [ + "APIGatewayEmulatorResource" + ] + }, + { + "name": "WithAWSSDKConfigReference", + "capabilityId": "Aspire.Hosting.AWS/withAWSSDKConfigReference", + "qualifiedName": "withAWSSDKConfigReference", + "kind": "Method", + "signature": "WithAWSSDKConfigReference(awsSdkConfig AWSSDKConfig) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "awsSdkConfig", + "type": "AWSSDKConfig" + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource", + "Aspire.Hosting.AWS.Lambda.LambdaEmulatorResource", + "Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "Aspire.Hosting.AWS.DynamoDB.DynamoDBLocalResource", + "Aspire.Hosting.ApplicationModel.RedisResource", + "Aspire.Hosting.Redis.RedisCommanderResource", + "Aspire.Hosting.Redis.RedisInsightResource", + "Aspire.Hosting.ApplicationModel.ValkeyResource" + ], + "appliesTo": [ + "APIGatewayEmulatorResource", + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "DynamoDBLocalResource", + "ExecutableResource", + "LambdaEmulatorResource", + "LambdaProjectResource", + "ProjectResource", + "RedisCommanderResource", + "RedisInsightResource", + "RedisResource", + "ValkeyResource" + ] + }, + { + "name": "WithDynamoDBLocalReference", + "capabilityId": "Aspire.Hosting.AWS/withDynamoDBLocalReference", + "qualifiedName": "withDynamoDBLocalReference", + "kind": "Method", + "signature": "WithDynamoDBLocalReference(dynamoDBLocalResourceBuilder DynamoDBLocalResource) ResourceWithEnvironment", + "receiver": "ResourceWithEnvironment", + "parameters": [ + { + "name": "dynamoDBLocalResourceBuilder", + "type": "DynamoDBLocalResource" + } + ], + "returnType": "ResourceWithEnvironment", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEnvironment", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource", + "Aspire.Hosting.AWS.Lambda.LambdaEmulatorResource", + "Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "Aspire.Hosting.AWS.DynamoDB.DynamoDBLocalResource", + "Aspire.Hosting.ApplicationModel.RedisResource", + "Aspire.Hosting.Redis.RedisCommanderResource", + "Aspire.Hosting.Redis.RedisInsightResource", + "Aspire.Hosting.ApplicationModel.ValkeyResource" + ], + "appliesTo": [ + "APIGatewayEmulatorResource", + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "DynamoDBLocalResource", + "ExecutableResource", + "LambdaEmulatorResource", + "LambdaProjectResource", + "ProjectResource", + "RedisCommanderResource", + "RedisInsightResource", + "RedisResource", + "ValkeyResource" + ] + }, + { + "name": "WithDynamoDBStreamsEventSource", + "capabilityId": "Aspire.Hosting.AWS/withDynamoDBStreamsEventSource", + "qualifiedName": "withDynamoDBStreamsEventSource", + "kind": "Method", + "signature": "WithDynamoDBStreamsEventSource(tableName string, options ...*DynamoDBStreamsEventSourceOptions) LambdaProjectResource", + "receiver": "LambdaProjectResource", + "parameters": [ + { + "name": "tableName", + "type": "string" + } + ], + "options": { + "typeName": "DynamoDBStreamsEventSourceOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "LambdaProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.Lambda.LambdaProjectResource" + ], + "appliesTo": [ + "LambdaProjectResource" + ] + }, + { + "name": "WithProfile", + "capabilityId": "Aspire.Hosting.AWS/withProfile", + "qualifiedName": "withProfile", + "kind": "Method", + "signature": "WithProfile(profile string) AWSSDKConfig", + "receiver": "AWSSDKConfig", + "parameters": [ + { + "name": "profile", + "type": "string" + } + ], + "returnType": "AWSSDKConfig", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.IAWSSDKConfig", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.IAWSSDKConfig" + ], + "appliesTo": [ + "AWSSDKConfig" + ] + }, + { + "name": "WithRegion", + "capabilityId": "Aspire.Hosting.AWS/withRegion", + "qualifiedName": "withRegion", + "kind": "Method", + "signature": "WithRegion(systemName string) AWSSDKConfig", + "receiver": "AWSSDKConfig", + "parameters": [ + { + "name": "systemName", + "type": "string" + } + ], + "returnType": "AWSSDKConfig", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.IAWSSDKConfig", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.IAWSSDKConfig" + ], + "appliesTo": [ + "AWSSDKConfig" + ] + }, + { + "name": "WithSQSEventSource", + "capabilityId": "Aspire.Hosting.AWS/withSQSEventSource", + "qualifiedName": "withSQSEventSource", + "kind": "Method", + "signature": "WithSQSEventSource(queueUrl string, options ...*SQSEventSourceOptions) LambdaProjectResource", + "receiver": "LambdaProjectResource", + "parameters": [ + { + "name": "queueUrl", + "type": "string" + } + ], + "options": { + "typeName": "SQSEventSourceOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "LambdaProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.Lambda.LambdaProjectResource" + ], + "appliesTo": [ + "LambdaProjectResource" + ] + }, + { + "name": "WithSdkValidation", + "capabilityId": "Aspire.Hosting.AWS/withSdkValidation", + "qualifiedName": "withSdkValidation", + "kind": "Method", + "signature": "WithSdkValidation(sdkValidationEnabled bool) AWSSDKConfig", + "receiver": "AWSSDKConfig", + "parameters": [ + { + "name": "sdkValidationEnabled", + "type": "bool" + } + ], + "returnType": "AWSSDKConfig", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.IAWSSDKConfig", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.IAWSSDKConfig" + ], + "appliesTo": [ + "AWSSDKConfig" + ] + } + ], + "handleTypes": [ + { + "name": "DynamoDBLocalResource", + "fullName": "Aspire.Hosting.AWS.DynamoDB.DynamoDBLocalResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AWSSDKConfig", + "fullName": "Aspire.Hosting.AWS.IAWSSDKConfig", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithProfile", + "capabilityId": "Aspire.Hosting.AWS/withProfile", + "qualifiedName": "withProfile", + "kind": "Method", + "signature": "WithProfile(profile string) AWSSDKConfig", + "receiver": "AWSSDKConfig", + "parameters": [ + { + "name": "profile", + "type": "string" + } + ], + "returnType": "AWSSDKConfig", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.IAWSSDKConfig", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.IAWSSDKConfig" + ], + "appliesTo": [ + "AWSSDKConfig" + ] + }, + { + "name": "WithRegion", + "capabilityId": "Aspire.Hosting.AWS/withRegion", + "qualifiedName": "withRegion", + "kind": "Method", + "signature": "WithRegion(systemName string) AWSSDKConfig", + "receiver": "AWSSDKConfig", + "parameters": [ + { + "name": "systemName", + "type": "string" + } + ], + "returnType": "AWSSDKConfig", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.IAWSSDKConfig", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.IAWSSDKConfig" + ], + "appliesTo": [ + "AWSSDKConfig" + ] + }, + { + "name": "WithSdkValidation", + "capabilityId": "Aspire.Hosting.AWS/withSdkValidation", + "qualifiedName": "withSdkValidation", + "kind": "Method", + "signature": "WithSdkValidation(sdkValidationEnabled bool) AWSSDKConfig", + "receiver": "AWSSDKConfig", + "parameters": [ + { + "name": "sdkValidationEnabled", + "type": "bool" + } + ], + "returnType": "AWSSDKConfig", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.IAWSSDKConfig", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.IAWSSDKConfig" + ], + "appliesTo": [ + "AWSSDKConfig" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "APIGatewayEmulatorResource", + "fullName": "Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithAPIGatewayLambdaReference", + "capabilityId": "Aspire.Hosting.AWS/withAPIGatewayLambdaReference", + "qualifiedName": "withAPIGatewayLambdaReference", + "kind": "Method", + "signature": "WithAPIGatewayLambdaReference(lambda LambdaProjectResource, httpMethod Method, path string) APIGatewayEmulatorResource", + "receiver": "APIGatewayEmulatorResource", + "parameters": [ + { + "name": "lambda", + "type": "LambdaProjectResource" + }, + { + "name": "httpMethod", + "type": "Method" + }, + { + "name": "path", + "type": "string" + } + ], + "returnType": "APIGatewayEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorResource" + ], + "appliesTo": [ + "APIGatewayEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "LambdaEmulatorResource", + "fullName": "Aspire.Hosting.AWS.Lambda.LambdaEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "LambdaProjectResource", + "fullName": "Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "IContainerFilesDestinationResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithDynamoDBStreamsEventSource", + "capabilityId": "Aspire.Hosting.AWS/withDynamoDBStreamsEventSource", + "qualifiedName": "withDynamoDBStreamsEventSource", + "kind": "Method", + "signature": "WithDynamoDBStreamsEventSource(tableName string, options ...*DynamoDBStreamsEventSourceOptions) LambdaProjectResource", + "receiver": "LambdaProjectResource", + "parameters": [ + { + "name": "tableName", + "type": "string" + } + ], + "options": { + "typeName": "DynamoDBStreamsEventSourceOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "LambdaProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.Lambda.LambdaProjectResource" + ], + "appliesTo": [ + "LambdaProjectResource" + ] + }, + { + "name": "WithSQSEventSource", + "capabilityId": "Aspire.Hosting.AWS/withSQSEventSource", + "qualifiedName": "withSQSEventSource", + "kind": "Method", + "signature": "WithSQSEventSource(queueUrl string, options ...*SQSEventSourceOptions) LambdaProjectResource", + "receiver": "LambdaProjectResource", + "parameters": [ + { + "name": "queueUrl", + "type": "string" + } + ], + "options": { + "typeName": "SQSEventSourceOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "LambdaProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.AWS/Aspire.Hosting.AWS.Lambda.LambdaProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AWS.Lambda.LambdaProjectResource" + ], + "appliesTo": [ + "LambdaProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "RedisResource", + "fullName": "Aspire.Hosting.ApplicationModel.RedisResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ValkeyResource", + "fullName": "Aspire.Hosting.ApplicationModel.ValkeyResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "RedisCommanderResource", + "fullName": "Aspire.Hosting.Redis.RedisCommanderResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "RedisInsightResource", + "fullName": "Aspire.Hosting.Redis.RedisInsightResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "DynamoDBLocalOptions", + "fullName": "Aspire.Hosting.AWS.DynamoDB.DynamoDBLocalOptions", + "kind": "dto", + "fields": [ + { + "name": "Registry", + "jsonName": "Registry", + "type": "string" + }, + { + "name": "Image", + "jsonName": "Image", + "type": "string" + }, + { + "name": "Tag", + "jsonName": "Tag", + "type": "string" + }, + { + "name": "SharedDb", + "jsonName": "SharedDb", + "type": "bool" + }, + { + "name": "InMemory", + "jsonName": "InMemory", + "type": "bool" + }, + { + "name": "LocalStorageDirectory", + "jsonName": "LocalStorageDirectory", + "type": "*string" + }, + { + "name": "DisableDynamoDBLocalTelemetry", + "jsonName": "DisableDynamoDBLocalTelemetry", + "type": "bool" + }, + { + "name": "DelayTransientStatuses", + "jsonName": "DelayTransientStatuses", + "type": "bool" + }, + { + "name": "Port", + "jsonName": "Port", + "type": "*float64", + "isOptional": true + } + ] + }, + { + "name": "APIGatewayEmulatorOptions", + "fullName": "Aspire.Hosting.AWS.Lambda.APIGatewayEmulatorOptions", + "kind": "dto", + "fields": [ + { + "name": "HttpPort", + "jsonName": "HttpPort", + "type": "*float64", + "isOptional": true + }, + { + "name": "HttpsPort", + "jsonName": "HttpsPort", + "type": "*float64", + "isOptional": true + }, + { + "name": "DisableHttpsEndpoint", + "jsonName": "DisableHttpsEndpoint", + "type": "bool" + } + ] + }, + { + "name": "DynamoDBStreamsEventSourceOptions", + "fullName": "Aspire.Hosting.AWS.Lambda.DynamoDBStreamsEventSourceOptions", + "kind": "dto", + "fields": [ + { + "name": "ResourceName", + "jsonName": "ResourceName", + "type": "*string" + }, + { + "name": "BatchSize", + "jsonName": "BatchSize", + "type": "*float64", + "isOptional": true + }, + { + "name": "PollingIntervalMs", + "jsonName": "PollingIntervalMs", + "type": "*float64", + "isOptional": true + } + ] + }, + { + "name": "LambdaEmulatorOptions", + "fullName": "Aspire.Hosting.AWS.Lambda.LambdaEmulatorOptions", + "kind": "dto", + "fields": [ + { + "name": "DisableAutoInstall", + "jsonName": "DisableAutoInstall", + "type": "bool" + }, + { + "name": "OverrideMinimumInstallVersion", + "jsonName": "OverrideMinimumInstallVersion", + "type": "*string" + }, + { + "name": "AllowDowngrade", + "jsonName": "AllowDowngrade", + "type": "bool" + }, + { + "name": "HttpPort", + "jsonName": "HttpPort", + "type": "*float64", + "isOptional": true + }, + { + "name": "HttpsPort", + "jsonName": "HttpsPort", + "type": "*float64", + "isOptional": true + }, + { + "name": "ConfigStoragePath", + "jsonName": "ConfigStoragePath", + "type": "*string" + }, + { + "name": "DisableHttpsEndpoint", + "jsonName": "DisableHttpsEndpoint", + "type": "bool" + } + ] + }, + { + "name": "LambdaFunctionPolyglotOptions", + "fullName": "Aspire.Hosting.AWS.Lambda.LambdaFunctionPolyglotOptions", + "kind": "dto", + "fields": [ + { + "name": "LogFormat", + "jsonName": "LogFormat", + "type": "*string" + }, + { + "name": "ApplicationLogLevel", + "jsonName": "ApplicationLogLevel", + "type": "*string" + } + ] + }, + { + "name": "SQSEventSourceOptions", + "fullName": "Aspire.Hosting.AWS.Lambda.SQSEventSourceOptions", + "kind": "dto", + "fields": [ + { + "name": "ResourceName", + "jsonName": "ResourceName", + "type": "*string" + }, + { + "name": "BatchSize", + "jsonName": "BatchSize", + "type": "*float64", + "isOptional": true + }, + { + "name": "DisableMessageDelete", + "jsonName": "DisableMessageDelete", + "type": "*bool", + "isOptional": true + }, + { + "name": "VisibilityTimeout", + "jsonName": "VisibilityTimeout", + "type": "*float64", + "isOptional": true + } + ] + } + ], + "enumTypes": [ + { + "name": "APIGatewayType", + "fullName": "Aspire.Hosting.AWS.Lambda.APIGatewayType", + "kind": "enum", + "members": [ + { + "name": "APIGatewayTypeRest", + "value": "Rest" + }, + { + "name": "APIGatewayTypeHttpV1", + "value": "HttpV1" + }, + { + "name": "APIGatewayTypeHttpV2", + "value": "HttpV2" + } + ] + }, + { + "name": "Method", + "fullName": "Aspire.Hosting.AWS.Lambda.Method", + "kind": "enum", + "members": [ + { + "name": "MethodAny", + "value": "Any" + }, + { + "name": "MethodGet", + "value": "Get" + }, + { + "name": "MethodPost", + "value": "Post" + }, + { + "name": "MethodPut", + "value": "Put" + }, + { + "name": "MethodDelete", + "value": "Delete" + }, + { + "name": "MethodPatch", + "value": "Patch" + }, + { + "name": "MethodHead", + "value": "Head" + }, + { + "name": "MethodOptions", + "value": "Options" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.13.6.0.json new file mode 100644 index 0000000000..668cde22eb --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.13.6.0.json @@ -0,0 +1,2084 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Azure/BicepOutputReference.name", + "qualifiedName": "BicepOutputReference.name", + "description": "Name of the output.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "BicepOutputReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.BicepOutputReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.BicepOutputReference" + ], + "appliesTo": [ + "BicepOutputReference" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting.Azure/BicepOutputReference.value", + "qualifiedName": "BicepOutputReference.value", + "description": "The value of the output.", + "kind": "PropertyGetter", + "signature": "Value() (*string, error)", + "receiver": "BicepOutputReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.BicepOutputReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.BicepOutputReference" + ], + "appliesTo": [ + "BicepOutputReference" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.Azure/BicepOutputReference.valueExpression", + "qualifiedName": "BicepOutputReference.valueExpression", + "description": "The expression used in the manifest to reference the value of the output.", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "BicepOutputReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.BicepOutputReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.BicepOutputReference" + ], + "appliesTo": [ + "BicepOutputReference" + ] + }, + { + "name": "AddAzureEnvironment", + "capabilityId": "Aspire.Hosting.Azure/addAzureEnvironment", + "qualifiedName": "addAzureEnvironment", + "description": "Adds an Azure environment resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureEnvironment() AzureEnvironmentResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "AzureEnvironmentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAzureInfrastructure", + "capabilityId": "Aspire.Hosting.Azure/addAzureInfrastructure", + "qualifiedName": "addAzureInfrastructure", + "description": "Adds an Azure provisioning resource to the application model.", + "returns": "A resource builder for the `AzureProvisioningResource` that can be used for further configuration.", + "kind": "Method", + "signature": "AddAzureInfrastructure(name string, configureInfrastructure func(obj AzureResourceInfrastructure)) AzureProvisioningResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource being added." + }, + { + "name": "configureInfrastructure", + "type": "func(obj AzureResourceInfrastructure)", + "isCallback": true, + "callbackSignature": "func(obj AzureResourceInfrastructure)", + "description": "A callback used to configure the infrastructure resource." + } + ], + "returnType": "AzureProvisioningResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAzureProvisioning", + "capabilityId": "Aspire.Hosting.Azure/addAzureProvisioning", + "qualifiedName": "addAzureProvisioning", + "description": "Adds support for generating Azure resources dynamically during application startup. The application must configure the appropriate Azure subscription and location before resources can be provisioned.", + "returns": "The distributed application builder.", + "kind": "Method", + "signature": "AddAzureProvisioning() DistributedApplicationBuilder", + "receiver": "DistributedApplicationBuilder", + "parameters": [], + "returnType": "DistributedApplicationBuilder", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddAzureUserAssignedIdentity", + "capabilityId": "Aspire.Hosting.Azure/addAzureUserAssignedIdentity", + "qualifiedName": "addAzureUserAssignedIdentity", + "description": "Adds an Azure user‑assigned identity resource to the application model.", + "remarks": "This method adds an Azure user‑assigned identity resource to the application model. It configures the\ninfrastructure for the resource and returns a builder for the resource.\nThe resource is added to the infrastructure only if the application is not in run mode.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureUserAssignedIdentity(name string) AzureUserAssignedIdentityResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureUserAssignedIdentityResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddBicepTemplate", + "capabilityId": "Aspire.Hosting.Azure/addBicepTemplate", + "qualifiedName": "addBicepTemplate", + "description": "Adds an Azure Bicep resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBicepTemplate(name string, bicepFile string) AzureBicepResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the deployment name." + }, + { + "name": "bicepFile", + "type": "string", + "description": "The path to the bicep file on disk. This path is relative to the apphost's project directory." + } + ], + "returnType": "AzureBicepResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddBicepTemplateString", + "capabilityId": "Aspire.Hosting.Azure/addBicepTemplateString", + "qualifiedName": "addBicepTemplateString", + "description": "Adds an Azure Bicep resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBicepTemplateString(name string, bicepContent string) AzureBicepResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the deployment name." + }, + { + "name": "bicepContent", + "type": "string", + "description": "A string that represents a snippet of bicep." + } + ], + "returnType": "AzureBicepResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Azure/asExisting", + "qualifiedName": "asExisting", + "description": "Marks the resource as an existing resource in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExisting(name any, options ...*AsExistingOptions) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "options": { + "typeName": "AsExistingOptions", + "fields": [ + { + "name": "ResourceGroup", + "jsonName": "resourceGroup", + "type": "any", + "description": "The name of the existing resource group as a string or parameter resource." + } + ] + }, + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "AsExistingInResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/asExistingInResourceGroup", + "qualifiedName": "asExistingInResourceGroup", + "description": "Marks the resource as an existing resource in a specific resource group and subscription in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "resourceGroup", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The resource group containing the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource group as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "AsExistingInSubscription", + "capabilityId": "Aspire.Hosting.Azure/asExistingInSubscription", + "qualifiedName": "asExistingInSubscription", + "description": "Marks the subscription-scoped resource as an existing resource in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExistingInSubscription(name any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "AsExistingInTenant", + "capabilityId": "Aspire.Hosting.Azure/asExistingInTenant", + "qualifiedName": "asExistingInTenant", + "description": "Marks the current-tenant-scoped resource as an existing resource in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExistingInTenant(name any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "ClearDefaultRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure/clearDefaultRoleAssignments", + "qualifiedName": "clearDefaultRoleAssignments", + "description": "Clears all default role assignments for the specified Azure resource.", + "remarks": "This method removes all default role assignments from the Azure resource. This can be useful when\nrole assignments can't be created, for example on existing resources where you don't have permission\nto create the assignments.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ClearDefaultRoleAssignments() AzureResource", + "receiver": "AzureResource", + "parameters": [], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "ConfigureInfrastructure", + "capabilityId": "Aspire.Hosting.Azure/configureInfrastructure", + "qualifiedName": "configureInfrastructure", + "description": "Configures the Azure provisioning infrastructure callback", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureInfrastructure(configure func(obj AzureResourceInfrastructure)) AzureProvisioningResource", + "receiver": "AzureProvisioningResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureResourceInfrastructure)", + "isCallback": true, + "callbackSignature": "func(obj AzureResourceInfrastructure)", + "description": "The configuration callback." + } + ], + "returnType": "AzureProvisioningResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureProvisioningResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "GetBicepIdentifier", + "capabilityId": "Aspire.Hosting.Azure/getBicepIdentifier", + "qualifiedName": "getBicepIdentifier", + "description": "Gets the Bicep identifier for the Azure resource.", + "returns": "A valid Bicep identifier.", + "kind": "Method", + "signature": "GetBicepIdentifier() (string, error)", + "receiver": "AzureResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "GetOutput", + "capabilityId": "Aspire.Hosting.Azure/getOutput", + "qualifiedName": "getOutput", + "description": "Gets a reference to an output from a bicep template.", + "returns": "A `BicepOutputReference` that represents the output.", + "kind": "Method", + "signature": "GetOutput(name string) BicepOutputReference", + "receiver": "AzureBicepResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "Name of the output." + } + ], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureBicepResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "IsExisting", + "capabilityId": "Aspire.Hosting.Azure/isExisting", + "qualifiedName": "isExisting", + "description": "Determines whether the Azure resource is marked as existing.", + "returns": "`true` if the resource is marked as existing; otherwise, `false`.", + "kind": "Method", + "signature": "IsExisting() (bool, error)", + "receiver": "AzureResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsConnectionString", + "capabilityId": "Aspire.Hosting.Azure/publishAsConnectionString", + "qualifiedName": "publishAsConnectionString", + "description": "Changes the resource to be published as a connection string reference in the manifest.", + "remarks": "This API only changes the manifest representation; it does not change the resource model used by other publishers.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsConnectionString() AzureResource", + "receiver": "AzureResource", + "parameters": [], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExisting", + "capabilityId": "Aspire.Hosting.Azure/publishAsExisting", + "qualifiedName": "publishAsExisting", + "description": "Marks the resource as an existing resource when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExisting(name any, options ...*PublishAsExistingOptions) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "options": { + "typeName": "PublishAsExistingOptions", + "fields": [ + { + "name": "ResourceGroup", + "jsonName": "resourceGroup", + "type": "any", + "description": "The name of the existing resource group as a string or parameter resource." + } + ] + }, + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExistingInResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/publishAsExistingInResourceGroup", + "qualifiedName": "publishAsExistingInResourceGroup", + "description": "Marks the resource as an existing resource in a specific resource group and subscription when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "resourceGroup", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The resource group containing the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource group as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExistingInSubscription", + "capabilityId": "Aspire.Hosting.Azure/publishAsExistingInSubscription", + "qualifiedName": "publishAsExistingInSubscription", + "description": "Marks the subscription-scoped resource as an existing resource when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExistingInSubscription(name any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExistingInTenant", + "capabilityId": "Aspire.Hosting.Azure/publishAsExistingInTenant", + "qualifiedName": "publishAsExistingInTenant", + "description": "Marks the current-tenant-scoped resource as an existing resource when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExistingInTenant(name any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExisting", + "capabilityId": "Aspire.Hosting.Azure/runAsExisting", + "qualifiedName": "runAsExisting", + "description": "Marks the resource as an existing resource when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExisting(name any, options ...*RunAsExistingOptions) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "options": { + "typeName": "RunAsExistingOptions", + "fields": [ + { + "name": "ResourceGroup", + "jsonName": "resourceGroup", + "type": "any", + "description": "The name of the existing resource group as a string or parameter resource." + } + ] + }, + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExistingInResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/runAsExistingInResourceGroup", + "qualifiedName": "runAsExistingInResourceGroup", + "description": "Marks the resource as an existing resource in a specific resource group and subscription when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "resourceGroup", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The resource group containing the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource group as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExistingInSubscription", + "capabilityId": "Aspire.Hosting.Azure/runAsExistingInSubscription", + "qualifiedName": "runAsExistingInSubscription", + "description": "Marks the subscription-scoped resource as an existing resource when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExistingInSubscription(name any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExistingInTenant", + "capabilityId": "Aspire.Hosting.Azure/runAsExistingInTenant", + "qualifiedName": "runAsExistingInTenant", + "description": "Marks the current-tenant-scoped resource as an existing resource when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExistingInTenant(name any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "WithAzureUserAssignedIdentity", + "capabilityId": "Aspire.Hosting.Azure/withUserAssignedIdentityAzureUserAssignedIdentity", + "qualifiedName": "withAzureUserAssignedIdentity", + "description": "Associates an Azure user-assigned identity with a compute resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAzureUserAssignedIdentity(identityResourceBuilder AzureUserAssignedIdentityResource) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "identityResourceBuilder", + "type": "AzureUserAssignedIdentityResource", + "description": "The builder for the `AzureUserAssignedIdentityResource`." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithLocation", + "capabilityId": "Aspire.Hosting.Azure/withLocation", + "qualifiedName": "withLocation", + "description": "Sets the location of the Azure environment resource.", + "remarks": "This method is used to set the location of the Azure environment resource.\nThe location is used to determine where the resources will be deployed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLocation(location ParameterResource) AzureEnvironmentResource", + "receiver": "AzureEnvironmentResource", + "parameters": [ + { + "name": "location", + "type": "ParameterResource", + "description": "The Azure location." + } + ], + "returnType": "AzureEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEnvironmentResource" + ], + "appliesTo": [ + "AzureEnvironmentResource" + ] + }, + { + "name": "WithParameter", + "capabilityId": "Aspire.Hosting.Azure/withParameter", + "qualifiedName": "withParameter", + "description": "Adds a Bicep parameter", + "kind": "Method", + "signature": "WithParameter(name string, options ...*WithParameterOptions) AzureBicepResource", + "receiver": "AzureBicepResource", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "WithParameterOptions", + "fields": [ + { + "name": "Value", + "jsonName": "value", + "type": "any" + } + ] + }, + "returnType": "AzureBicepResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureBicepResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "WithResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/withResourceGroup", + "qualifiedName": "withResourceGroup", + "description": "Sets the resource group name of the Azure environment resource.", + "remarks": "This method is used to set the resource group name of the Azure environment resource.\nThe resource group name is used to determine where the resources will be deployed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithResourceGroup(resourceGroup ParameterResource) AzureEnvironmentResource", + "receiver": "AzureEnvironmentResource", + "parameters": [ + { + "name": "resourceGroup", + "type": "ParameterResource", + "description": "The Azure resource group name." + } + ], + "returnType": "AzureEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEnvironmentResource" + ], + "appliesTo": [ + "AzureEnvironmentResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureResource", + "fullName": "Aspire.Hosting.ApplicationModel.IAzureResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents an Azure resource, as a marker interface for {@ats-ref type:IResource}'s that can be deployed to an Azure resource group.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Azure/asExisting", + "qualifiedName": "asExisting", + "description": "Marks the resource as an existing resource in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExisting(name any, options ...*AsExistingOptions) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "options": { + "typeName": "AsExistingOptions", + "fields": [ + { + "name": "ResourceGroup", + "jsonName": "resourceGroup", + "type": "any", + "description": "The name of the existing resource group as a string or parameter resource." + } + ] + }, + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "AsExistingInResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/asExistingInResourceGroup", + "qualifiedName": "asExistingInResourceGroup", + "description": "Marks the resource as an existing resource in a specific resource group and subscription in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "resourceGroup", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The resource group containing the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource group as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "AsExistingInSubscription", + "capabilityId": "Aspire.Hosting.Azure/asExistingInSubscription", + "qualifiedName": "asExistingInSubscription", + "description": "Marks the subscription-scoped resource as an existing resource in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExistingInSubscription(name any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "AsExistingInTenant", + "capabilityId": "Aspire.Hosting.Azure/asExistingInTenant", + "qualifiedName": "asExistingInTenant", + "description": "Marks the current-tenant-scoped resource as an existing resource in both run and publish modes.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "AsExistingInTenant(name any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "ClearDefaultRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure/clearDefaultRoleAssignments", + "qualifiedName": "clearDefaultRoleAssignments", + "description": "Clears all default role assignments for the specified Azure resource.", + "remarks": "This method removes all default role assignments from the Azure resource. This can be useful when\nrole assignments can't be created, for example on existing resources where you don't have permission\nto create the assignments.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ClearDefaultRoleAssignments() AzureResource", + "receiver": "AzureResource", + "parameters": [], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "GetBicepIdentifier", + "capabilityId": "Aspire.Hosting.Azure/getBicepIdentifier", + "qualifiedName": "getBicepIdentifier", + "description": "Gets the Bicep identifier for the Azure resource.", + "returns": "A valid Bicep identifier.", + "kind": "Method", + "signature": "GetBicepIdentifier() (string, error)", + "receiver": "AzureResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "IsExisting", + "capabilityId": "Aspire.Hosting.Azure/isExisting", + "qualifiedName": "isExisting", + "description": "Determines whether the Azure resource is marked as existing.", + "returns": "`true` if the resource is marked as existing; otherwise, `false`.", + "kind": "Method", + "signature": "IsExisting() (bool, error)", + "receiver": "AzureResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsConnectionString", + "capabilityId": "Aspire.Hosting.Azure/publishAsConnectionString", + "qualifiedName": "publishAsConnectionString", + "description": "Changes the resource to be published as a connection string reference in the manifest.", + "remarks": "This API only changes the manifest representation; it does not change the resource model used by other publishers.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsConnectionString() AzureResource", + "receiver": "AzureResource", + "parameters": [], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExisting", + "capabilityId": "Aspire.Hosting.Azure/publishAsExisting", + "qualifiedName": "publishAsExisting", + "description": "Marks the resource as an existing resource when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExisting(name any, options ...*PublishAsExistingOptions) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "options": { + "typeName": "PublishAsExistingOptions", + "fields": [ + { + "name": "ResourceGroup", + "jsonName": "resourceGroup", + "type": "any", + "description": "The name of the existing resource group as a string or parameter resource." + } + ] + }, + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExistingInResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/publishAsExistingInResourceGroup", + "qualifiedName": "publishAsExistingInResourceGroup", + "description": "Marks the resource as an existing resource in a specific resource group and subscription when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "resourceGroup", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The resource group containing the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource group as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExistingInSubscription", + "capabilityId": "Aspire.Hosting.Azure/publishAsExistingInSubscription", + "qualifiedName": "publishAsExistingInSubscription", + "description": "Marks the subscription-scoped resource as an existing resource when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExistingInSubscription(name any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "PublishAsExistingInTenant", + "capabilityId": "Aspire.Hosting.Azure/publishAsExistingInTenant", + "qualifiedName": "publishAsExistingInTenant", + "description": "Marks the current-tenant-scoped resource as an existing resource when the application is deployed.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "PublishAsExistingInTenant(name any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExisting", + "capabilityId": "Aspire.Hosting.Azure/runAsExisting", + "qualifiedName": "runAsExisting", + "description": "Marks the resource as an existing resource when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExisting(name any, options ...*RunAsExistingOptions) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "options": { + "typeName": "RunAsExistingOptions", + "fields": [ + { + "name": "ResourceGroup", + "jsonName": "resourceGroup", + "type": "any", + "description": "The name of the existing resource group as a string or parameter resource." + } + ] + }, + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExistingInResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/runAsExistingInResourceGroup", + "qualifiedName": "runAsExistingInResourceGroup", + "description": "Marks the resource as an existing resource in a specific resource group and subscription when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExistingInResourceGroup(name any, resourceGroup any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "resourceGroup", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The resource group containing the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource group as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExistingInSubscription", + "capabilityId": "Aspire.Hosting.Azure/runAsExistingInSubscription", + "qualifiedName": "runAsExistingInSubscription", + "description": "Marks the subscription-scoped resource as an existing resource when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExistingInSubscription(name any, subscription any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + }, + { + "name": "subscription", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The subscription identifier containing the resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "RunAsExistingInTenant", + "capabilityId": "Aspire.Hosting.Azure/runAsExistingInTenant", + "qualifiedName": "runAsExistingInTenant", + "description": "Marks the current-tenant-scoped resource as an existing resource when the application is running.", + "returns": "The resource builder with the existing resource annotation added.", + "kind": "Method", + "signature": "RunAsExistingInTenant(name any) AzureResource", + "receiver": "AzureResource", + "parameters": [ + { + "name": "name", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ], + "description": "The name of the existing resource as a string or parameter resource." + } + ], + "returnType": "AzureResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.ApplicationModel.IAzureResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [ + "AzureResource", + "Resource" + ], + "capabilities": [ + { + "name": "GetOutput", + "capabilityId": "Aspire.Hosting.Azure/getOutput", + "qualifiedName": "getOutput", + "description": "Gets a reference to an output from a bicep template.", + "returns": "A `BicepOutputReference` that represents the output.", + "kind": "Method", + "signature": "GetOutput(name string) BicepOutputReference", + "receiver": "AzureBicepResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "Name of the output." + } + ], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureBicepResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + }, + { + "name": "WithParameter", + "capabilityId": "Aspire.Hosting.Azure/withParameter", + "qualifiedName": "withParameter", + "description": "Adds a Bicep parameter", + "kind": "Method", + "signature": "WithParameter(name string, options ...*WithParameterOptions) AzureBicepResource", + "receiver": "AzureBicepResource", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "WithParameterOptions", + "fields": [ + { + "name": "Value", + "jsonName": "value", + "type": "any" + } + ] + }, + "returnType": "AzureBicepResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureBicepResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithLocation", + "capabilityId": "Aspire.Hosting.Azure/withLocation", + "qualifiedName": "withLocation", + "description": "Sets the location of the Azure environment resource.", + "remarks": "This method is used to set the location of the Azure environment resource.\nThe location is used to determine where the resources will be deployed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLocation(location ParameterResource) AzureEnvironmentResource", + "receiver": "AzureEnvironmentResource", + "parameters": [ + { + "name": "location", + "type": "ParameterResource", + "description": "The Azure location." + } + ], + "returnType": "AzureEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEnvironmentResource" + ], + "appliesTo": [ + "AzureEnvironmentResource" + ] + }, + { + "name": "WithResourceGroup", + "capabilityId": "Aspire.Hosting.Azure/withResourceGroup", + "qualifiedName": "withResourceGroup", + "description": "Sets the resource group name of the Azure environment resource.", + "remarks": "This method is used to set the resource group name of the Azure environment resource.\nThe resource group name is used to determine where the resources will be deployed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithResourceGroup(resourceGroup ParameterResource) AzureEnvironmentResource", + "receiver": "AzureEnvironmentResource", + "parameters": [ + { + "name": "resourceGroup", + "type": "ParameterResource", + "description": "The Azure resource group name." + } + ], + "returnType": "AzureEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEnvironmentResource" + ], + "appliesTo": [ + "AzureEnvironmentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [ + "AzureResource", + "Resource" + ], + "capabilities": [ + { + "name": "ConfigureInfrastructure", + "capabilityId": "Aspire.Hosting.Azure/configureInfrastructure", + "qualifiedName": "configureInfrastructure", + "description": "Configures the Azure provisioning infrastructure callback", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureInfrastructure(configure func(obj AzureResourceInfrastructure)) AzureProvisioningResource", + "receiver": "AzureProvisioningResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureResourceInfrastructure)", + "isCallback": true, + "callbackSignature": "func(obj AzureResourceInfrastructure)", + "description": "The configuration callback." + } + ], + "returnType": "AzureProvisioningResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureProvisioningResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureResourceInfrastructure", + "fullName": "Aspire.Hosting.Azure.AzureResourceInfrastructure", + "kind": "handle", + "description": "An Azure Provisioning {@ats-ref type:Infrastructure} which represents the root Bicep module that is generated for an Azure resource.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [ + "AzureResource", + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "BicepOutputReference", + "fullName": "Aspire.Hosting.Azure.BicepOutputReference", + "kind": "handle", + "description": "A reference to an output from a bicep template.", + "implementedInterfaces": [ + "ExpressionValue" + ], + "capabilities": [ + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Azure/BicepOutputReference.name", + "qualifiedName": "BicepOutputReference.name", + "description": "Name of the output.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "BicepOutputReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.BicepOutputReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.BicepOutputReference" + ], + "appliesTo": [ + "BicepOutputReference" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting.Azure/BicepOutputReference.value", + "qualifiedName": "BicepOutputReference.value", + "description": "The value of the output.", + "kind": "PropertyGetter", + "signature": "Value() (*string, error)", + "receiver": "BicepOutputReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.BicepOutputReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.BicepOutputReference" + ], + "appliesTo": [ + "BicepOutputReference" + ] + }, + { + "name": "ValueExpression", + "capabilityId": "Aspire.Hosting.Azure/BicepOutputReference.valueExpression", + "qualifiedName": "BicepOutputReference.valueExpression", + "description": "The expression used in the manifest to reference the value of the output.", + "kind": "PropertyGetter", + "signature": "ValueExpression() (string, error)", + "receiver": "BicepOutputReference", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.BicepOutputReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.BicepOutputReference" + ], + "appliesTo": [ + "BicepOutputReference" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultResource", + "fullName": "Aspire.Hosting.Azure.IAzureKeyVaultResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a resource that represents an Azure Key Vault.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultSecretReference", + "fullName": "Aspire.Hosting.Azure.IAzureKeyVaultSecretReference", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "description": "Represents a reference to a secret in an Azure Key Vault resource.", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [ + { + "name": "AzureSubnetServiceDelegations", + "fullName": "AzureSubnetServiceDelegations", + "kind": "exportedValue", + "values": [ + { + "path": "AppServiceEnvironments", + "type": "string", + "value": "\"Microsoft.Web/serverFarms\"", + "description": "Delegation for Azure App Service environments." + }, + { + "path": "ApplicationGatewayForContainers", + "type": "string", + "value": "\"Microsoft.ServiceNetworking/trafficControllers\"", + "description": "Delegation for Azure Application Gateway for Containers." + }, + { + "path": "ContainerAppEnvironments", + "type": "string", + "value": "\"Microsoft.App/environments\"", + "description": "Delegation for Azure Container Apps environments." + }, + { + "path": "ContainerInstances", + "type": "string", + "value": "\"Microsoft.ContainerInstance/containerGroups\"", + "description": "Delegation for Azure Container Instances (ACI), which allows container groups to be deployed into the subnet." + } + ] + } + ] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppConfiguration.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppConfiguration.13.6.0.json new file mode 100644 index 0000000000..6e2f03f612 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppConfiguration.13.6.0.json @@ -0,0 +1,440 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.AppConfiguration", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureAppConfiguration", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/addAzureAppConfiguration", + "qualifiedName": "addAzureAppConfiguration", + "description": "Adds an Azure App Configuration resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureAppConfiguration(name string) AzureAppConfigurationResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureAppConfigurationResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures Azure App Configuration to run with the local emulator", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureAppConfigurationResource", + "receiver": "AzureAppConfigurationResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureEmulator", + "type": "func(obj AzureAppConfigurationEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureAppConfigurationEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureAppConfigurationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationResource" + ], + "appliesTo": [ + "AzureAppConfigurationResource" + ] + }, + { + "name": "WithAppConfigurationRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withAppConfigurationRoleAssignments", + "qualifiedName": "withAppConfigurationRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure App Configuration resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAppConfigurationRoleAssignments(target AzureAppConfigurationResource, roles []AzureAppConfigurationRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureAppConfigurationResource", + "description": "The target Azure App Configuration resource." + }, + { + "name": "roles", + "type": "[]AzureAppConfigurationRole", + "description": "The App Configuration roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureAppConfigurationResource", + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource", + "AzureAppConfigurationResource", + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the storage of an Azure App Configuration emulator resource.", + "returns": "A builder for the `AzureAppConfigurationEmulatorResource`.", + "kind": "Method", + "signature": "WithDataBindMount(options ...*WithDataBindMountOptions) AzureAppConfigurationEmulatorResource", + "receiver": "AzureAppConfigurationEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "Relative path to the AppHost where emulator storage is persisted between runs. Defaults to the path '.aace'" + } + ] + }, + "returnType": "AzureAppConfigurationEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to an Azure App Configuration emulator resource.", + "returns": "A builder for the `AzureAppConfigurationEmulatorResource`.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) AzureAppConfigurationEmulatorResource", + "receiver": "AzureAppConfigurationEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + } + ] + }, + "returnType": "AzureAppConfigurationEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port for the Azure App Configuration emulator is exposed on instead of using randomly assigned port.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(port *float64) AzureAppConfigurationEmulatorResource", + "receiver": "AzureAppConfigurationEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "The port to bind on the host. If `null` is used, a random port will be assigned." + } + ], + "returnType": "AzureAppConfigurationEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureAppConfigurationEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the storage of an Azure App Configuration emulator resource.", + "returns": "A builder for the `AzureAppConfigurationEmulatorResource`.", + "kind": "Method", + "signature": "WithDataBindMount(options ...*WithDataBindMountOptions) AzureAppConfigurationEmulatorResource", + "receiver": "AzureAppConfigurationEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "Relative path to the AppHost where emulator storage is persisted between runs. Defaults to the path '.aace'" + } + ] + }, + "returnType": "AzureAppConfigurationEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to an Azure App Configuration emulator resource.", + "returns": "A builder for the `AzureAppConfigurationEmulatorResource`.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) AzureAppConfigurationEmulatorResource", + "receiver": "AzureAppConfigurationEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + } + ] + }, + "returnType": "AzureAppConfigurationEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port for the Azure App Configuration emulator is exposed on instead of using randomly assigned port.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(port *float64) AzureAppConfigurationEmulatorResource", + "receiver": "AzureAppConfigurationEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "The port to bind on the host. If `null` is used, a random port will be assigned." + } + ], + "returnType": "AzureAppConfigurationEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationEmulatorResource" + ], + "appliesTo": [ + "AzureAppConfigurationEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureAppConfigurationResource", + "fullName": "Aspire.Hosting.Azure.AzureAppConfigurationResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.AppConfiguration/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures Azure App Configuration to run with the local emulator", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureAppConfigurationResource", + "receiver": "AzureAppConfigurationResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureEmulator", + "type": "func(obj AzureAppConfigurationEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureAppConfigurationEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureAppConfigurationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppConfiguration/Aspire.Hosting.Azure.AzureAppConfigurationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppConfigurationResource" + ], + "appliesTo": [ + "AzureAppConfigurationResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureAppConfigurationRole", + "fullName": "Aspire.Hosting.AzureAppConfigurationRole", + "kind": "enum", + "description": "Represents Azure App Configuration roles that are compatible with the Aspire Type System (ATS).", + "members": [ + { + "name": "AzureAppConfigurationRoleAppConfigurationDataOwner", + "value": "AppConfigurationDataOwner" + }, + { + "name": "AzureAppConfigurationRoleAppConfigurationDataReader", + "value": "AppConfigurationDataReader" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppContainers.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppContainers.13.6.0.json new file mode 100644 index 0000000000..f51129b8db --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppContainers.13.6.0.json @@ -0,0 +1,834 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.AppContainers", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureContainerAppEnvironment", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/addAzureContainerAppEnvironment", + "qualifiedName": "addAzureContainerAppEnvironment", + "description": "Adds a container app environment resource to the distributed application builder.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureContainerAppEnvironment(name string) AzureContainerAppEnvironmentResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureContainerAppEnvironmentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AsExpress", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/asExpress", + "qualifiedName": "asExpress", + "description": "Configures the container app environment to publish and deploy HTTP applications using Azure Container Apps Express.", + "remarks": "Express defaults to zero minimum replicas and does not provision the managed Aspire dashboard.\nExplicit replica settings and infrastructure customization are preserved. Azure validates service compatibility.\nApp-to-app references require explicitly public HTTP endpoints. References to apps in Express environments use HTTPS; cross-environment references preserve the producer's configured scheme.\nLocal execution is unchanged.\nWhen combined with existing-resource configuration, the existing environment must already use Express.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "AsExpress() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "ConfigureCustomDomain", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/configureCustomDomain", + "qualifiedName": "configureCustomDomain", + "description": "Configures the custom domain for the container app.", + "kind": "Method", + "signature": "ConfigureCustomDomain(customDomain ParameterResource, certificateName ParameterResource) error", + "receiver": "ContainerApp", + "parameters": [ + { + "name": "customDomain", + "type": "ParameterResource", + "description": "A resource builder for a parameter resource capturing the name of the custom domain." + }, + { + "name": "certificateName", + "type": "ParameterResource", + "description": "A resource builder for a parameter resource capturing the name of the certificate configured in the Azure Portal." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppContainers/Azure.Provisioning.AppContainers.ContainerApp", + "expandedTargetTypes": [ + "Azure.Provisioning.AppContainers.ContainerApp" + ], + "appliesTo": [ + "ContainerApp" + ] + }, + { + "name": "ConfigureScale", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/configureContainerAppScale", + "qualifiedName": "configureScale", + "description": "Configures supported Azure Container App scale settings.", + "kind": "Method", + "signature": "ConfigureScale(scale *AzureContainerAppScaleConfig) error", + "receiver": "ContainerApp", + "parameters": [ + { + "name": "scale", + "type": "*AzureContainerAppScaleConfig" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppContainers/Azure.Provisioning.AppContainers.ContainerApp", + "expandedTargetTypes": [ + "Azure.Provisioning.AppContainers.ContainerApp" + ], + "appliesTo": [ + "ContainerApp" + ] + }, + { + "name": "PublishAsAzureContainerApp", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/publishContainerAsAzureContainerApp", + "qualifiedName": "publishAsAzureContainerApp", + "description": "Publishes the specified container resource as a container app.", + "remarks": "This method checks if the application is in publish mode. If it is, it adds the necessary infrastructure\nfor container apps and applies the provided configuration action to the container app.\n```\nbuilder.AddContainer(\"name\", \"image\").PublishAsAzureContainerApp((infrastructure, app) =>\n{\n// Configure the container app here\n});\n```", + "returns": "The updated container resource builder.", + "kind": "Method", + "signature": "PublishAsAzureContainerApp(configure func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)) ContainerResource", + "receiver": "ContainerResource", + "parameters": [ + { + "name": "configure", + "type": "func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)", + "description": "The configuration action for the container app." + } + ], + "returnType": "ContainerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource" + ], + "appliesTo": [ + "ContainerResource" + ] + }, + { + "name": "PublishAsAzureContainerApp", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/publishExecutableAsAzureContainerApp", + "qualifiedName": "publishAsAzureContainerApp", + "description": "Publishes the specified container resource as a container app.", + "remarks": "This method checks if the application is in publish mode. If it is, it adds the necessary infrastructure\nfor container apps and applies the provided configuration action to the container app.\n```\nbuilder.AddNpmApp(\"name\", \"image\").PublishAsAzureContainerApp((infrastructure, app) =>\n{\n// Configure the container app here\n});\n```", + "returns": "The updated container resource builder.", + "kind": "Method", + "signature": "PublishAsAzureContainerApp(configure func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)) ExecutableResource", + "receiver": "ExecutableResource", + "parameters": [ + { + "name": "configure", + "type": "func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)", + "description": "The configuration action for the container app." + } + ], + "returnType": "ExecutableResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ExecutableResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource" + ], + "appliesTo": [ + "DotnetToolResource", + "ExecutableResource" + ] + }, + { + "name": "PublishAsAzureContainerApp", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/publishProjectAsAzureContainerApp", + "qualifiedName": "publishAsAzureContainerApp", + "description": "Allows configuring the specified project resource as a container app.", + "returns": "The updated project resource builder.", + "kind": "Method", + "signature": "PublishAsAzureContainerApp(configure func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "configure", + "type": "func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 ContainerApp)", + "description": "The configuration action for the container app." + } + ], + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "PublishAsAzureContainerAppJob", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/publishAsAzureContainerAppJob", + "qualifiedName": "publishAsAzureContainerAppJob", + "description": "Configures the compute resource as an Azure Container App Job", + "kind": "Method", + "signature": "PublishAsAzureContainerAppJob(options ...*PublishAsAzureContainerAppJobOptions) IComputeResource", + "receiver": "IComputeResource", + "parameters": [], + "options": { + "typeName": "PublishAsAzureContainerAppJobOptions", + "fields": [ + { + "name": "Configure", + "type": "func(arg1 AzureResourceInfrastructure, arg2 ContainerAppJob)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 ContainerAppJob)" + } + ] + }, + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "PublishAsScheduledAzureContainerAppJob", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/publishAsScheduledAzureContainerAppJob", + "qualifiedName": "publishAsScheduledAzureContainerAppJob", + "description": "Configures the compute resource as a scheduled Azure Container App Job", + "kind": "Method", + "signature": "PublishAsScheduledAzureContainerAppJob(cronExpression string, options ...*PublishAsScheduledAzureContainerAppJobOptions) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "cronExpression", + "type": "string" + } + ], + "options": { + "typeName": "PublishAsScheduledAzureContainerAppJobOptions", + "fields": [ + { + "name": "Configure", + "type": "func(arg1 AzureResourceInfrastructure, arg2 ContainerAppJob)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 ContainerAppJob)" + } + ] + }, + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithAcrPullIdentity", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withAcrPullIdentity", + "qualifiedName": "withAcrPullIdentity", + "description": "Configures the container app environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that container apps in the environment use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.", + "remarks": "When this is set, Aspire will not create a new identity or an `AcrPull` role assignment for the\ncontainer registry. The caller is responsible for ensuring the supplied identity already has the required\n`AcrPull` role assignment on the registry, for example by chaining\n`.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` when adding the identity.\nThis is commonly combined with `AsExisting` on the environment and on the container registry to deploy\ncontainer apps into a pre-provisioned set of Azure resources without Aspire emitting any new identity or\nrole-assignment resources. See for the\nscenario this addresses.\nOnly the combination of an existing environment, an existing container registry, and this method avoids\nemitting any new identity or role-assignment resources in the env module. Other combinations still work but\nwill emit additional resources:\n- If the environment is marked `AsExisting` but no identity is supplied here, Aspire still emits a new `UserAssignedIdentity` and an `AcrPull` role assignment on the configured registry.\n- If this method is used but the container registry is not existing (either the Aspire-generated default registry or a user-added registry without `AsExisting`), the registry itself is still provisioned. To wire the supplied identity to that newly-created registry, chain `.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` on the identity.", + "returns": "The `IResourceBuilder`1` for chaining.", + "kind": "Method", + "signature": "WithAcrPullIdentity(identityBuilder AzureUserAssignedIdentityResource) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [ + { + "name": "identityBuilder", + "type": "AzureUserAssignedIdentityResource", + "description": "The resource builder for the user-assigned identity that should be used for image pulls. This identity is only used for the `AcrPull` role; it is not assigned to individual container apps in the environment." + } + ], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithAzdResourceNaming", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withAzdResourceNaming", + "qualifiedName": "withAzdResourceNaming", + "description": "Configures the container app environment resources to use the same naming conventions as azd.", + "remarks": "By default, the container app environment resources use a different naming convention than azd.\nThis method allows for reusing the previously deployed resources if the application was deployed using\nazd without calling `AddAzureContainerAppEnvironment`", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAzdResourceNaming() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithAzureLogAnalyticsWorkspace", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withAzureLogAnalyticsWorkspace", + "qualifiedName": "withAzureLogAnalyticsWorkspace", + "description": "Configures the container app environment resource to use the specified Log Analytics Workspace.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAzureLogAnalyticsWorkspace(workspaceBuilder AzureLogAnalyticsWorkspaceResource) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [ + { + "name": "workspaceBuilder", + "type": "AzureLogAnalyticsWorkspaceResource", + "description": "The resource builder for the `AzureLogAnalyticsWorkspaceResource` to use." + } + ], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithCompactResourceNaming", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withCompactResourceNaming", + "qualifiedName": "withCompactResourceNaming", + "description": "Configures the container app environment to use compact resource naming that maximally preserves the `uniqueString` suffix for length-constrained Azure resources such as storage accounts.", + "remarks": "By default, the generated Azure resource names use long static suffixes (e.g. `storageVolume`,\n`managedStorage`) that can consume most of the 24-character storage account name limit, truncating\nthe `uniqueString(resourceGroup().id)` portion that provides cross-deployment uniqueness.\nWhen enabled, this method shortens the static portions of generated names so the full 13-character\n`uniqueString` is preserved. This prevents naming collisions when deploying multiple environments\nto different resource groups.\nThis option only affects volume-related storage resources. It does not change the naming of the\ncontainer app environment, container registry, log analytics workspace, or managed identity.\nUse `WithAzdResourceNaming` to change those names as well.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCompactResourceNaming() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithDashboard", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withDashboard", + "qualifiedName": "withDashboard", + "description": "Configures whether the Aspire dashboard should be included in the container app environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDashboard(options ...*WithDashboardOptions) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithDashboardOptions", + "fields": [ + { + "name": "Enable", + "jsonName": "enable", + "type": "*bool", + "description": "Whether to include the Aspire dashboard. Default is true." + } + ] + }, + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithHttpsUpgrade", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withHttpsUpgrade", + "qualifiedName": "withHttpsUpgrade", + "description": "Configures whether HTTP endpoints should be upgraded to HTTPS in Azure Container Apps. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.", + "remarks": "When disabled (`false`), HTTP endpoints will use HTTP scheme and port 80 in Azure Container Apps.\nNote that explicit ports specified for development (e.g., port 8080) are still normalized\nto standard ports (80/443) as required by Azure Container Apps.\nDisabling HTTPS upgrade for an Express environment is rejected during publishing or deployment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsUpgrade(options ...*WithHttpsUpgradeOptions) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithHttpsUpgradeOptions", + "fields": [ + { + "name": "Upgrade", + "jsonName": "upgrade", + "type": "*bool", + "description": "Whether to upgrade HTTP endpoints to HTTPS. Default is true." + } + ] + }, + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithUniqueResourceNaming", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withUniqueResourceNaming", + "qualifiedName": "withUniqueResourceNaming", + "description": "Configures the container app environment to incorporate its resource name into the generated managed environment `name`, so that multiple environments in the same resource group get distinct names.", + "remarks": "By default the managed environment relies on Azure.Provisioning's name, whose sanitizer keeps only\nlowercase letters. For example, two `AddAzureContainerAppEnvironment` resources named\n`cae1` and `cae2` both drop their trailing digit and yield\n`take('cae${uniqueString(resourceGroup().id)}', 24)`. When they share a resource group,\nthat default would collapse both onto a single physical environment and concurrent\ncontainer-app writes would race with `ManagedEnvironmentOperationInProgress`. Publish and deploy\ndetect this collision and fail with guidance to apply this method instead\n(see ).\nApplying this method computes the managed environment `name` with the same algorithm Azure.Provisioning\nuses for every other Azure resource type (sanitized resource name, then a hyphen separator and a\n`uniqueString(resourceGroup().id)` suffix, truncated to the maximum length), but with the character\nrequirements Azure Container Apps managed environments actually allow — lowercase letters, digits, and\nhyphens, with a 60-character maximum. For example, `cae1` produces\n`take('cae1-${uniqueString(resourceGroup().id)}', 60)`, while `prod1` uses a `prod1`\nprefix. Preserving the digits gives each environment a distinct `name`. This is opt-in because\nenabling it changes the environment `name` for an already-deployed single environment, which would\ncause Azure to recreate it. Apply it only to the environments that need distinct names (typically when\ndeploying more than one environment to a single resource group), or to new deployments.\nThis option acts as a fallback after name resolvers configured through\n`ProvisioningBuildOptions`. A configured resolver can therefore\noverride the generated name. This option also has no effect when `WithAzdResourceNaming` is\nused, since azd naming sets the environment name explicitly.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUniqueResourceNaming() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureContainerAppEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [ + "ComputeEnvironmentResource", + "Resource" + ], + "capabilities": [ + { + "name": "AsExpress", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/asExpress", + "qualifiedName": "asExpress", + "description": "Configures the container app environment to publish and deploy HTTP applications using Azure Container Apps Express.", + "remarks": "Express defaults to zero minimum replicas and does not provision the managed Aspire dashboard.\nExplicit replica settings and infrastructure customization are preserved. Azure validates service compatibility.\nApp-to-app references require explicitly public HTTP endpoints. References to apps in Express environments use HTTPS; cross-environment references preserve the producer's configured scheme.\nLocal execution is unchanged.\nWhen combined with existing-resource configuration, the existing environment must already use Express.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "AsExpress() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithAcrPullIdentity", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withAcrPullIdentity", + "qualifiedName": "withAcrPullIdentity", + "description": "Configures the container app environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that container apps in the environment use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.", + "remarks": "When this is set, Aspire will not create a new identity or an `AcrPull` role assignment for the\ncontainer registry. The caller is responsible for ensuring the supplied identity already has the required\n`AcrPull` role assignment on the registry, for example by chaining\n`.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` when adding the identity.\nThis is commonly combined with `AsExisting` on the environment and on the container registry to deploy\ncontainer apps into a pre-provisioned set of Azure resources without Aspire emitting any new identity or\nrole-assignment resources. See for the\nscenario this addresses.\nOnly the combination of an existing environment, an existing container registry, and this method avoids\nemitting any new identity or role-assignment resources in the env module. Other combinations still work but\nwill emit additional resources:\n- If the environment is marked `AsExisting` but no identity is supplied here, Aspire still emits a new `UserAssignedIdentity` and an `AcrPull` role assignment on the configured registry.\n- If this method is used but the container registry is not existing (either the Aspire-generated default registry or a user-added registry without `AsExisting`), the registry itself is still provisioned. To wire the supplied identity to that newly-created registry, chain `.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` on the identity.", + "returns": "The `IResourceBuilder`1` for chaining.", + "kind": "Method", + "signature": "WithAcrPullIdentity(identityBuilder AzureUserAssignedIdentityResource) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [ + { + "name": "identityBuilder", + "type": "AzureUserAssignedIdentityResource", + "description": "The resource builder for the user-assigned identity that should be used for image pulls. This identity is only used for the `AcrPull` role; it is not assigned to individual container apps in the environment." + } + ], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithAzdResourceNaming", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withAzdResourceNaming", + "qualifiedName": "withAzdResourceNaming", + "description": "Configures the container app environment resources to use the same naming conventions as azd.", + "remarks": "By default, the container app environment resources use a different naming convention than azd.\nThis method allows for reusing the previously deployed resources if the application was deployed using\nazd without calling `AddAzureContainerAppEnvironment`", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAzdResourceNaming() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithAzureLogAnalyticsWorkspace", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withAzureLogAnalyticsWorkspace", + "qualifiedName": "withAzureLogAnalyticsWorkspace", + "description": "Configures the container app environment resource to use the specified Log Analytics Workspace.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAzureLogAnalyticsWorkspace(workspaceBuilder AzureLogAnalyticsWorkspaceResource) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [ + { + "name": "workspaceBuilder", + "type": "AzureLogAnalyticsWorkspaceResource", + "description": "The resource builder for the `AzureLogAnalyticsWorkspaceResource` to use." + } + ], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithCompactResourceNaming", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withCompactResourceNaming", + "qualifiedName": "withCompactResourceNaming", + "description": "Configures the container app environment to use compact resource naming that maximally preserves the `uniqueString` suffix for length-constrained Azure resources such as storage accounts.", + "remarks": "By default, the generated Azure resource names use long static suffixes (e.g. `storageVolume`,\n`managedStorage`) that can consume most of the 24-character storage account name limit, truncating\nthe `uniqueString(resourceGroup().id)` portion that provides cross-deployment uniqueness.\nWhen enabled, this method shortens the static portions of generated names so the full 13-character\n`uniqueString` is preserved. This prevents naming collisions when deploying multiple environments\nto different resource groups.\nThis option only affects volume-related storage resources. It does not change the naming of the\ncontainer app environment, container registry, log analytics workspace, or managed identity.\nUse `WithAzdResourceNaming` to change those names as well.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCompactResourceNaming() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithDashboard", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withDashboard", + "qualifiedName": "withDashboard", + "description": "Configures whether the Aspire dashboard should be included in the container app environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDashboard(options ...*WithDashboardOptions) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithDashboardOptions", + "fields": [ + { + "name": "Enable", + "jsonName": "enable", + "type": "*bool", + "description": "Whether to include the Aspire dashboard. Default is true." + } + ] + }, + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithHttpsUpgrade", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withHttpsUpgrade", + "qualifiedName": "withHttpsUpgrade", + "description": "Configures whether HTTP endpoints should be upgraded to HTTPS in Azure Container Apps. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.", + "remarks": "When disabled (`false`), HTTP endpoints will use HTTP scheme and port 80 in Azure Container Apps.\nNote that explicit ports specified for development (e.g., port 8080) are still normalized\nto standard ports (80/443) as required by Azure Container Apps.\nDisabling HTTPS upgrade for an Express environment is rejected during publishing or deployment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsUpgrade(options ...*WithHttpsUpgradeOptions) AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithHttpsUpgradeOptions", + "fields": [ + { + "name": "Upgrade", + "jsonName": "upgrade", + "type": "*bool", + "description": "Whether to upgrade HTTP endpoints to HTTPS. Default is true." + } + ] + }, + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + }, + { + "name": "WithUniqueResourceNaming", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/withUniqueResourceNaming", + "qualifiedName": "withUniqueResourceNaming", + "description": "Configures the container app environment to incorporate its resource name into the generated managed environment `name`, so that multiple environments in the same resource group get distinct names.", + "remarks": "By default the managed environment relies on Azure.Provisioning's name, whose sanitizer keeps only\nlowercase letters. For example, two `AddAzureContainerAppEnvironment` resources named\n`cae1` and `cae2` both drop their trailing digit and yield\n`take('cae${uniqueString(resourceGroup().id)}', 24)`. When they share a resource group,\nthat default would collapse both onto a single physical environment and concurrent\ncontainer-app writes would race with `ManagedEnvironmentOperationInProgress`. Publish and deploy\ndetect this collision and fail with guidance to apply this method instead\n(see ).\nApplying this method computes the managed environment `name` with the same algorithm Azure.Provisioning\nuses for every other Azure resource type (sanitized resource name, then a hyphen separator and a\n`uniqueString(resourceGroup().id)` suffix, truncated to the maximum length), but with the character\nrequirements Azure Container Apps managed environments actually allow — lowercase letters, digits, and\nhyphens, with a 60-character maximum. For example, `cae1` produces\n`take('cae1-${uniqueString(resourceGroup().id)}', 60)`, while `prod1` uses a `prod1`\nprefix. Preserving the digits gives each environment a distinct `name`. This is opt-in because\nenabling it changes the environment `name` for an already-deployed single environment, which would\ncause Azure to recreate it. Apply it only to the environments that need distinct names (typically when\ndeploying more than one environment to a single resource group), or to new deployments.\nThis option acts as a fallback after name resolvers configured through\n`ProvisioningBuildOptions`. A configured resolver can therefore\noverride the generated name. This option also has no effect when `WithAzdResourceNaming` is\nused, since azd naming sets the environment name explicitly.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUniqueResourceNaming() AzureContainerAppEnvironmentResource", + "receiver": "AzureContainerAppEnvironmentResource", + "parameters": [], + "returnType": "AzureContainerAppEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppContainers/Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AppContainers.AzureContainerAppEnvironmentResource" + ], + "appliesTo": [ + "AzureContainerAppEnvironmentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureLogAnalyticsWorkspaceResource", + "fullName": "Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureResourceInfrastructure", + "fullName": "Aspire.Hosting.Azure.AzureResourceInfrastructure", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ContainerApp", + "fullName": "Azure.Provisioning.AppContainers.ContainerApp", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ConfigureCustomDomain", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/configureCustomDomain", + "qualifiedName": "configureCustomDomain", + "description": "Configures the custom domain for the container app.", + "kind": "Method", + "signature": "ConfigureCustomDomain(customDomain ParameterResource, certificateName ParameterResource) error", + "receiver": "ContainerApp", + "parameters": [ + { + "name": "customDomain", + "type": "ParameterResource", + "description": "A resource builder for a parameter resource capturing the name of the custom domain." + }, + { + "name": "certificateName", + "type": "ParameterResource", + "description": "A resource builder for a parameter resource capturing the name of the certificate configured in the Azure Portal." + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppContainers/Azure.Provisioning.AppContainers.ContainerApp", + "expandedTargetTypes": [ + "Azure.Provisioning.AppContainers.ContainerApp" + ], + "appliesTo": [ + "ContainerApp" + ] + }, + { + "name": "ConfigureScale", + "capabilityId": "Aspire.Hosting.Azure.AppContainers/configureContainerAppScale", + "qualifiedName": "configureScale", + "description": "Configures supported Azure Container App scale settings.", + "kind": "Method", + "signature": "ConfigureScale(scale *AzureContainerAppScaleConfig) error", + "receiver": "ContainerApp", + "parameters": [ + { + "name": "scale", + "type": "*AzureContainerAppScaleConfig" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppContainers/Azure.Provisioning.AppContainers.ContainerApp", + "expandedTargetTypes": [ + "Azure.Provisioning.AppContainers.ContainerApp" + ], + "appliesTo": [ + "ContainerApp" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ContainerAppJob", + "fullName": "Azure.Provisioning.AppContainers.ContainerAppJob", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "AzureContainerAppScaleConfig", + "fullName": "Aspire.Hosting.Azure.AzureContainerAppScaleConfig", + "kind": "dto", + "description": "Polyglot-friendly subset of Azure Container App scale configuration.", + "fields": [ + { + "name": "MinReplicas", + "jsonName": "MinReplicas", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the minimum number of replicas." + } + ] + } + ], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppService.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppService.13.6.0.json new file mode 100644 index 0000000000..3a86c6f5f9 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.AppService.13.6.0.json @@ -0,0 +1,604 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.AppService", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureAppServiceEnvironment", + "capabilityId": "Aspire.Hosting.Azure.AppService/addAzureAppServiceEnvironment", + "qualifiedName": "addAzureAppServiceEnvironment", + "description": "Adds a azure app service environment resource to the distributed application builder.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureAppServiceEnvironment(name string) AzureAppServiceEnvironmentResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureAppServiceEnvironmentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "ConfigureSiteConfig", + "capabilityId": "Aspire.Hosting.Azure.AppService/configureWebSiteSiteConfig", + "qualifiedName": "configureSiteConfig", + "description": "Configures supported Azure App Service site settings.", + "kind": "Method", + "signature": "ConfigureSiteConfig(siteConfig *AzureAppServiceSiteConfig) error", + "receiver": "WebSite", + "parameters": [ + { + "name": "siteConfig", + "type": "*AzureAppServiceSiteConfig" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppService/Azure.Provisioning.AppService.WebSite", + "expandedTargetTypes": [ + "Azure.Provisioning.AppService.WebSite" + ], + "appliesTo": [ + "WebSite" + ] + }, + { + "name": "ConfigureSlotSiteConfig", + "capabilityId": "Aspire.Hosting.Azure.AppService/configureWebSiteSlotSiteConfig", + "qualifiedName": "configureSlotSiteConfig", + "description": "Configures supported Azure App Service deployment slot site settings.", + "kind": "Method", + "signature": "ConfigureSlotSiteConfig(siteConfig *AzureAppServiceSiteConfig) error", + "receiver": "WebSiteSlot", + "parameters": [ + { + "name": "siteConfig", + "type": "*AzureAppServiceSiteConfig" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppService/Azure.Provisioning.AppService.WebSiteSlot", + "expandedTargetTypes": [ + "Azure.Provisioning.AppService.WebSiteSlot" + ], + "appliesTo": [ + "WebSiteSlot" + ] + }, + { + "name": "PublishAsAzureAppServiceWebsite", + "capabilityId": "Aspire.Hosting.Azure.AppService/publishAsAzureAppServiceWebsite", + "qualifiedName": "publishAsAzureAppServiceWebsite", + "description": "Publishes the specified compute resource as an Azure App Service or Azure App Service Slot.", + "returns": "The updated compute resource builder.", + "kind": "Method", + "signature": "PublishAsAzureAppServiceWebsite(options ...*PublishAsAzureAppServiceWebsiteOptions) IComputeResource", + "receiver": "IComputeResource", + "parameters": [], + "options": { + "typeName": "PublishAsAzureAppServiceWebsiteOptions", + "fields": [ + { + "name": "Configure", + "type": "func(arg1 AzureResourceInfrastructure, arg2 WebSite)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 WebSite)", + "description": "The configuration action for the App Service WebSite resource." + }, + { + "name": "ConfigureSlot", + "type": "func(arg1 AzureResourceInfrastructure, arg2 WebSiteSlot)", + "isCallback": true, + "callbackSignature": "func(arg1 AzureResourceInfrastructure, arg2 WebSiteSlot)", + "description": "The configuration action for the App Service WebSite Slot resource." + } + ] + }, + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "SkipEnvironmentVariableNameChecks", + "capabilityId": "Aspire.Hosting.Azure.AppService/skipEnvironmentVariableNameChecks", + "qualifiedName": "skipEnvironmentVariableNameChecks", + "description": "Skips validation for environment variable names that Azure App Service may not support.", + "remarks": "When running on Azure App Service, environment variable names can't contain hyphens.\nThis can cause Aspire client integrations that rely on the original environment variable names to fail.\nBy default, Aspire performs validation to ensure environment variable names are compatible with Azure App Service,\nfailing to publish if any invalid names are found.", + "returns": "The updated compute resource builder.", + "kind": "Method", + "signature": "SkipEnvironmentVariableNameChecks() IComputeResource", + "receiver": "IComputeResource", + "parameters": [], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithAcrPullIdentity", + "capabilityId": "Aspire.Hosting.Azure.AppService/withAcrPullIdentity", + "qualifiedName": "withAcrPullIdentity", + "description": "Configures the Azure App Service environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that App Service apps use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.", + "remarks": "When this is set, Aspire will not create a new identity or an `AcrPull` role assignment for the\ncontainer registry. The caller is responsible for ensuring the supplied identity already has the required\n`AcrPull` role assignment on the registry, for example by chaining\n`.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` when adding the identity.\nUnlike the equivalent method on Azure Container Apps, App Service reuses this single identity for more than\njust image pulls. The same identity is also attached to every generated App Service web app as a user-assigned\nmanaged identity, and is used by the Aspire OTLP sidecar to authenticate telemetry to the Aspire dashboard\n(it is added to the dashboard's `ALLOWED_MANAGED_IDENTITIES` and exposed to each app via the OTEL\nclient-id app setting). If you supply an existing identity here, it will take on all of these roles.\nThis is commonly combined with `AsExisting` on the App Service environment (App Service Plan) and on\nthe container registry to deploy websites into a pre-provisioned set of Azure resources without Aspire\nemitting any new ACR-pull identity or ACR-pull role-assignment resources. See\nfor the scenario this addresses.\nOnly the combination of an existing App Service Plan, an existing container registry, and this method\navoids emitting any new identity or role-assignment resources in the env module. Other combinations still\nwork but will emit additional resources:\n- If the App Service Plan is marked `AsExisting` but no identity is supplied here, Aspire still emits a new `UserAssignedIdentity` and an `AcrPull` role assignment on the configured registry.\n- If this method is used but the container registry is not existing (either the Aspire-generated default registry or a user-added registry without `AsExisting`), the registry itself is still provisioned. To wire the supplied identity to that newly-created registry, chain `.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` on the identity.\nIf the Aspire dashboard is enabled, Aspire still provisions the dashboard website and its contributor\nidentity. Use `WithDashboard` with\n`false` when targeting a fully pre-provisioned App Service Plan that should not receive a\ndashboard.", + "returns": "The `IResourceBuilder`1` for chaining.", + "kind": "Method", + "signature": "WithAcrPullIdentity(identityBuilder AzureUserAssignedIdentityResource) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [ + { + "name": "identityBuilder", + "type": "AzureUserAssignedIdentityResource", + "description": "The resource builder for the user-assigned identity that should be used for image pulls. The supplied identity must already have the `AcrPull` role on the configured container registry." + } + ], + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithAzureApplicationInsights", + "capabilityId": "Aspire.Hosting.Azure.AppService/withAzureApplicationInsights", + "qualifiedName": "withAzureApplicationInsights", + "description": "Enables Azure Application Insights for the Azure App Service environment", + "kind": "Method", + "signature": "WithAzureApplicationInsights(options ...*WithAzureApplicationInsightsOptions) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithAzureApplicationInsightsOptions", + "fields": [ + { + "name": "ApplicationInsights", + "jsonName": "applicationInsights", + "type": "any" + } + ] + }, + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithDashboard", + "capabilityId": "Aspire.Hosting.Azure.AppService/withDashboard", + "qualifiedName": "withDashboard", + "description": "Configures whether the Aspire dashboard should be included in the Azure App Service environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDashboard(options ...*WithDashboardOptions) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithDashboardOptions", + "fields": [ + { + "name": "Enable", + "jsonName": "enable", + "type": "*bool", + "description": "Whether to include the Aspire dashboard. Default is true." + } + ] + }, + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithDeploymentSlot", + "capabilityId": "Aspire.Hosting.Azure.AppService/withDeploymentSlot", + "qualifiedName": "withDeploymentSlot", + "description": "Configures the deployment slot for all Azure App Services in the environment", + "kind": "Method", + "signature": "WithDeploymentSlot(deploymentSlot any) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [ + { + "name": "deploymentSlot", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithHttpsUpgrade", + "capabilityId": "Aspire.Hosting.Azure.AppService/withHttpsUpgrade", + "qualifiedName": "withHttpsUpgrade", + "description": "Configures whether HTTP endpoints should be automatically upgraded to HTTPS for the Azure App Service environment. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.", + "remarks": "When disabled (`false`), HTTP endpoints will use HTTP scheme and port 80 in Azure App Service.\nNote that Azure App Service forces HTTP to HTTPS redirects at the platform level,\nso disabling upgrade primarily affects connection strings generated for dependent resources.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsUpgrade(options ...*WithHttpsUpgradeOptions) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithHttpsUpgradeOptions", + "fields": [ + { + "name": "Upgrade", + "jsonName": "upgrade", + "type": "*bool", + "description": "Whether to upgrade HTTP endpoints to HTTPS. Default is true." + } + ] + }, + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureAppServiceEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [ + "ComputeEnvironmentResource", + "Resource" + ], + "capabilities": [ + { + "name": "WithAcrPullIdentity", + "capabilityId": "Aspire.Hosting.Azure.AppService/withAcrPullIdentity", + "qualifiedName": "withAcrPullIdentity", + "description": "Configures the Azure App Service environment to use the supplied `AzureUserAssignedIdentityResource` as the managed identity that App Service apps use to pull images from the configured container registry (the `AcrPull` identity), instead of having Aspire create a new identity and a new `AcrPull` role assignment.", + "remarks": "When this is set, Aspire will not create a new identity or an `AcrPull` role assignment for the\ncontainer registry. The caller is responsible for ensuring the supplied identity already has the required\n`AcrPull` role assignment on the registry, for example by chaining\n`.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` when adding the identity.\nUnlike the equivalent method on Azure Container Apps, App Service reuses this single identity for more than\njust image pulls. The same identity is also attached to every generated App Service web app as a user-assigned\nmanaged identity, and is used by the Aspire OTLP sidecar to authenticate telemetry to the Aspire dashboard\n(it is added to the dashboard's `ALLOWED_MANAGED_IDENTITIES` and exposed to each app via the OTEL\nclient-id app setting). If you supply an existing identity here, it will take on all of these roles.\nThis is commonly combined with `AsExisting` on the App Service environment (App Service Plan) and on\nthe container registry to deploy websites into a pre-provisioned set of Azure resources without Aspire\nemitting any new ACR-pull identity or ACR-pull role-assignment resources. See\nfor the scenario this addresses.\nOnly the combination of an existing App Service Plan, an existing container registry, and this method\navoids emitting any new identity or role-assignment resources in the env module. Other combinations still\nwork but will emit additional resources:\n- If the App Service Plan is marked `AsExisting` but no identity is supplied here, Aspire still emits a new `UserAssignedIdentity` and an `AcrPull` role assignment on the configured registry.\n- If this method is used but the container registry is not existing (either the Aspire-generated default registry or a user-added registry without `AsExisting`), the registry itself is still provisioned. To wire the supplied identity to that newly-created registry, chain `.WithRoleAssignments(acr, ContainerRegistryBuiltInRole.AcrPull)` on the identity.\nIf the Aspire dashboard is enabled, Aspire still provisions the dashboard website and its contributor\nidentity. Use `WithDashboard` with\n`false` when targeting a fully pre-provisioned App Service Plan that should not receive a\ndashboard.", + "returns": "The `IResourceBuilder`1` for chaining.", + "kind": "Method", + "signature": "WithAcrPullIdentity(identityBuilder AzureUserAssignedIdentityResource) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [ + { + "name": "identityBuilder", + "type": "AzureUserAssignedIdentityResource", + "description": "The resource builder for the user-assigned identity that should be used for image pulls. The supplied identity must already have the `AcrPull` role on the configured container registry." + } + ], + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithAzureApplicationInsights", + "capabilityId": "Aspire.Hosting.Azure.AppService/withAzureApplicationInsights", + "qualifiedName": "withAzureApplicationInsights", + "description": "Enables Azure Application Insights for the Azure App Service environment", + "kind": "Method", + "signature": "WithAzureApplicationInsights(options ...*WithAzureApplicationInsightsOptions) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithAzureApplicationInsightsOptions", + "fields": [ + { + "name": "ApplicationInsights", + "jsonName": "applicationInsights", + "type": "any" + } + ] + }, + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithDashboard", + "capabilityId": "Aspire.Hosting.Azure.AppService/withDashboard", + "qualifiedName": "withDashboard", + "description": "Configures whether the Aspire dashboard should be included in the Azure App Service environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDashboard(options ...*WithDashboardOptions) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithDashboardOptions", + "fields": [ + { + "name": "Enable", + "jsonName": "enable", + "type": "*bool", + "description": "Whether to include the Aspire dashboard. Default is true." + } + ] + }, + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithDeploymentSlot", + "capabilityId": "Aspire.Hosting.Azure.AppService/withDeploymentSlot", + "qualifiedName": "withDeploymentSlot", + "description": "Configures the deployment slot for all Azure App Services in the environment", + "kind": "Method", + "signature": "WithDeploymentSlot(deploymentSlot any) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [ + { + "name": "deploymentSlot", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + }, + { + "name": "WithHttpsUpgrade", + "capabilityId": "Aspire.Hosting.Azure.AppService/withHttpsUpgrade", + "qualifiedName": "withHttpsUpgrade", + "description": "Configures whether HTTP endpoints should be automatically upgraded to HTTPS for the Azure App Service environment. By default, HTTP endpoints are upgraded to HTTPS for security and WebSocket compatibility.", + "remarks": "When disabled (`false`), HTTP endpoints will use HTTP scheme and port 80 in Azure App Service.\nNote that Azure App Service forces HTTP to HTTPS redirects at the platform level,\nso disabling upgrade primarily affects connection strings generated for dependent resources.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHttpsUpgrade(options ...*WithHttpsUpgradeOptions) AzureAppServiceEnvironmentResource", + "receiver": "AzureAppServiceEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithHttpsUpgradeOptions", + "fields": [ + { + "name": "Upgrade", + "jsonName": "upgrade", + "type": "*bool", + "description": "Whether to upgrade HTTP endpoints to HTTPS. Default is true." + } + ] + }, + "returnType": "AzureAppServiceEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.AppService/Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureAppServiceEnvironmentResource" + ], + "appliesTo": [ + "AzureAppServiceEnvironmentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureApplicationInsightsResource", + "fullName": "Aspire.Hosting.Azure.AzureApplicationInsightsResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureResourceInfrastructure", + "fullName": "Aspire.Hosting.Azure.AzureResourceInfrastructure", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "WebSite", + "fullName": "Azure.Provisioning.AppService.WebSite", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ConfigureSiteConfig", + "capabilityId": "Aspire.Hosting.Azure.AppService/configureWebSiteSiteConfig", + "qualifiedName": "configureSiteConfig", + "description": "Configures supported Azure App Service site settings.", + "kind": "Method", + "signature": "ConfigureSiteConfig(siteConfig *AzureAppServiceSiteConfig) error", + "receiver": "WebSite", + "parameters": [ + { + "name": "siteConfig", + "type": "*AzureAppServiceSiteConfig" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppService/Azure.Provisioning.AppService.WebSite", + "expandedTargetTypes": [ + "Azure.Provisioning.AppService.WebSite" + ], + "appliesTo": [ + "WebSite" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "WebSiteSlot", + "fullName": "Azure.Provisioning.AppService.WebSiteSlot", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "ConfigureSlotSiteConfig", + "capabilityId": "Aspire.Hosting.Azure.AppService/configureWebSiteSlotSiteConfig", + "qualifiedName": "configureSlotSiteConfig", + "description": "Configures supported Azure App Service deployment slot site settings.", + "kind": "Method", + "signature": "ConfigureSlotSiteConfig(siteConfig *AzureAppServiceSiteConfig) error", + "receiver": "WebSiteSlot", + "parameters": [ + { + "name": "siteConfig", + "type": "*AzureAppServiceSiteConfig" + } + ], + "returnType": "error", + "errorModel": "returned", + "targetTypeId": "Azure.Provisioning.AppService/Azure.Provisioning.AppService.WebSiteSlot", + "expandedTargetTypes": [ + "Azure.Provisioning.AppService.WebSiteSlot" + ], + "appliesTo": [ + "WebSiteSlot" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "AzureAppServiceSiteConfig", + "fullName": "Aspire.Hosting.Azure.AzureAppServiceSiteConfig", + "kind": "dto", + "description": "Polyglot-friendly subset of Azure App Service site configuration.", + "fields": [ + { + "name": "IsAlwaysOn", + "jsonName": "IsAlwaysOn", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets whether the App Service app is always loaded." + } + ] + } + ], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ApplicationInsights.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ApplicationInsights.13.6.0.json new file mode 100644 index 0000000000..4f3983fe61 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ApplicationInsights.13.6.0.json @@ -0,0 +1,121 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.ApplicationInsights", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureApplicationInsights", + "capabilityId": "Aspire.Hosting.Azure.ApplicationInsights/addAzureApplicationInsights", + "qualifiedName": "addAzureApplicationInsights", + "description": "Adds an Azure Application Insights resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureApplicationInsights(name string) AzureApplicationInsightsResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureApplicationInsightsResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithLogAnalyticsWorkspace", + "capabilityId": "Aspire.Hosting.Azure.ApplicationInsights/withLogAnalyticsWorkspace", + "qualifiedName": "withLogAnalyticsWorkspace", + "description": "Configures the Application Insights resource to use the specified Log Analytics Workspace resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLogAnalyticsWorkspace(logAnalyticsWorkspace AzureLogAnalyticsWorkspaceResource) AzureApplicationInsightsResource", + "receiver": "AzureApplicationInsightsResource", + "parameters": [ + { + "name": "logAnalyticsWorkspace", + "type": "AzureLogAnalyticsWorkspaceResource", + "description": "The resource builder for the `AzureLogAnalyticsWorkspaceResource`." + } + ], + "returnType": "AzureApplicationInsightsResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ApplicationInsights/Aspire.Hosting.Azure.AzureApplicationInsightsResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureApplicationInsightsResource" + ], + "appliesTo": [ + "AzureApplicationInsightsResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureApplicationInsightsResource", + "fullName": "Aspire.Hosting.Azure.AzureApplicationInsightsResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "WithLogAnalyticsWorkspace", + "capabilityId": "Aspire.Hosting.Azure.ApplicationInsights/withLogAnalyticsWorkspace", + "qualifiedName": "withLogAnalyticsWorkspace", + "description": "Configures the Application Insights resource to use the specified Log Analytics Workspace resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLogAnalyticsWorkspace(logAnalyticsWorkspace AzureLogAnalyticsWorkspaceResource) AzureApplicationInsightsResource", + "receiver": "AzureApplicationInsightsResource", + "parameters": [ + { + "name": "logAnalyticsWorkspace", + "type": "AzureLogAnalyticsWorkspaceResource", + "description": "The resource builder for the `AzureLogAnalyticsWorkspaceResource`." + } + ], + "returnType": "AzureApplicationInsightsResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ApplicationInsights/Aspire.Hosting.Azure.AzureApplicationInsightsResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureApplicationInsightsResource" + ], + "appliesTo": [ + "AzureApplicationInsightsResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureLogAnalyticsWorkspaceResource", + "fullName": "Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.CognitiveServices.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.CognitiveServices.13.6.0.json new file mode 100644 index 0000000000..2d9672662a --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.CognitiveServices.13.6.0.json @@ -0,0 +1,852 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.CognitiveServices", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.connectionStringExpression", + "qualifiedName": "AzureOpenAIDeploymentResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure OpenAI Deployment resource.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "DeploymentName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.deploymentName", + "qualifiedName": "AzureOpenAIDeploymentResource.deploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `Name`, but allows for a different deployment name in Azure.", + "kind": "PropertyGetter", + "signature": "DeploymentName() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "ModelName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.modelName", + "qualifiedName": "AzureOpenAIDeploymentResource.modelName", + "description": "Gets the name of the model.", + "kind": "PropertyGetter", + "signature": "ModelName() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "ModelVersion", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.modelVersion", + "qualifiedName": "AzureOpenAIDeploymentResource.modelVersion", + "description": "Gets the version of the model.", + "kind": "PropertyGetter", + "signature": "ModelVersion() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.parent", + "qualifiedName": "AzureOpenAIDeploymentResource.parent", + "description": "Gets the parent Azure OpenAI resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureOpenAIResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "AzureOpenAIResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetDeploymentName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setDeploymentName", + "qualifiedName": "AzureOpenAIDeploymentResource.setDeploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `Name`, but allows for a different deployment name in Azure.", + "kind": "PropertySetter", + "signature": "SetDeploymentName(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the deployment." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetModelName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setModelName", + "qualifiedName": "AzureOpenAIDeploymentResource.setModelName", + "description": "Gets the name of the model.", + "kind": "PropertySetter", + "signature": "SetModelName(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets the name of the model." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetModelVersion", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setModelVersion", + "qualifiedName": "AzureOpenAIDeploymentResource.setModelVersion", + "description": "Gets the version of the model.", + "kind": "PropertySetter", + "signature": "SetModelVersion(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets the version of the model." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetSkuCapacity", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setSkuCapacity", + "qualifiedName": "AzureOpenAIDeploymentResource.setSkuCapacity", + "description": "Gets the capacity of the SKU.", + "kind": "PropertySetter", + "signature": "SetSkuCapacity(value float64) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "Gets the capacity of the SKU." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetSkuName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setSkuName", + "qualifiedName": "AzureOpenAIDeploymentResource.setSkuName", + "description": "Gets the name of the SKU.", + "kind": "PropertySetter", + "signature": "SetSkuName(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets the name of the SKU." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SkuCapacity", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.skuCapacity", + "qualifiedName": "AzureOpenAIDeploymentResource.skuCapacity", + "description": "Gets the capacity of the SKU.", + "kind": "PropertyGetter", + "signature": "SkuCapacity() (float64, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SkuName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.skuName", + "qualifiedName": "AzureOpenAIDeploymentResource.skuName", + "description": "Gets the name of the SKU.", + "kind": "PropertyGetter", + "signature": "SkuName() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "AddAzureOpenAI", + "capabilityId": "Aspire.Hosting.Azure.CognitiveServices/addAzureOpenAI", + "qualifiedName": "addAzureOpenAI", + "description": "Adds an Azure OpenAI resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureOpenAI(name string) AzureOpenAIResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureOpenAIResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDeployment", + "capabilityId": "Aspire.Hosting.Azure.CognitiveServices/addDeployment", + "qualifiedName": "addDeployment", + "description": "Adds an Azure OpenAI deployment resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDeployment(name string, modelName string, modelVersion string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure OpenAI Deployment resource." + }, + { + "name": "modelName", + "type": "string", + "description": "The name of the model to deploy." + }, + { + "name": "modelVersion", + "type": "string", + "description": "The version of the model to deploy." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIResource" + ], + "appliesTo": [ + "AzureOpenAIResource" + ] + }, + { + "name": "WithCognitiveServicesRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.CognitiveServices/withCognitiveServicesRoleAssignments", + "qualifiedName": "withCognitiveServicesRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure OpenAI resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCognitiveServicesRoleAssignments(target AzureOpenAIResource, roles []AzureOpenAIRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureOpenAIResource", + "description": "The target Azure OpenAI resource." + }, + { + "name": "roles", + "type": "[]AzureOpenAIRole", + "description": "The Azure OpenAI roles to be assigned (for example, `CognitiveServicesOpenAIUser`)." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "Aspire.Hosting.ApplicationModel.AzureOpenAIResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureOpenAIDeploymentResource", + "AzureOpenAIResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.CognitiveServices/withProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure OpenAI Deployment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureOpenAIDeploymentResource)) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureOpenAIDeploymentResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureOpenAIDeploymentResource)", + "description": "A method that can be used for customizing the `AzureOpenAIDeploymentResource`." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureOpenAIDeploymentResource", + "fullName": "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "kind": "handle", + "description": "Represents an Azure OpenAI Deployment resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.connectionStringExpression", + "qualifiedName": "AzureOpenAIDeploymentResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure OpenAI Deployment resource.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "DeploymentName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.deploymentName", + "qualifiedName": "AzureOpenAIDeploymentResource.deploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `Name`, but allows for a different deployment name in Azure.", + "kind": "PropertyGetter", + "signature": "DeploymentName() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "ModelName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.modelName", + "qualifiedName": "AzureOpenAIDeploymentResource.modelName", + "description": "Gets the name of the model.", + "kind": "PropertyGetter", + "signature": "ModelName() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "ModelVersion", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.modelVersion", + "qualifiedName": "AzureOpenAIDeploymentResource.modelVersion", + "description": "Gets the version of the model.", + "kind": "PropertyGetter", + "signature": "ModelVersion() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.parent", + "qualifiedName": "AzureOpenAIDeploymentResource.parent", + "description": "Gets the parent Azure OpenAI resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureOpenAIResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "AzureOpenAIResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetDeploymentName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setDeploymentName", + "qualifiedName": "AzureOpenAIDeploymentResource.setDeploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `Name`, but allows for a different deployment name in Azure.", + "kind": "PropertySetter", + "signature": "SetDeploymentName(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the deployment." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetModelName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setModelName", + "qualifiedName": "AzureOpenAIDeploymentResource.setModelName", + "description": "Gets the name of the model.", + "kind": "PropertySetter", + "signature": "SetModelName(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets the name of the model." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetModelVersion", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setModelVersion", + "qualifiedName": "AzureOpenAIDeploymentResource.setModelVersion", + "description": "Gets the version of the model.", + "kind": "PropertySetter", + "signature": "SetModelVersion(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets the version of the model." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetSkuCapacity", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setSkuCapacity", + "qualifiedName": "AzureOpenAIDeploymentResource.setSkuCapacity", + "description": "Gets the capacity of the SKU.", + "kind": "PropertySetter", + "signature": "SetSkuCapacity(value float64) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "Gets the capacity of the SKU." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SetSkuName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.setSkuName", + "qualifiedName": "AzureOpenAIDeploymentResource.setSkuName", + "description": "Gets the name of the SKU.", + "kind": "PropertySetter", + "signature": "SetSkuName(value string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets the name of the SKU." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SkuCapacity", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.skuCapacity", + "qualifiedName": "AzureOpenAIDeploymentResource.skuCapacity", + "description": "Gets the capacity of the SKU.", + "kind": "PropertyGetter", + "signature": "SkuCapacity() (float64, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "SkuName", + "capabilityId": "Aspire.Hosting.ApplicationModel/AzureOpenAIDeploymentResource.skuName", + "qualifiedName": "AzureOpenAIDeploymentResource.skuName", + "description": "Gets the name of the SKU.", + "kind": "PropertyGetter", + "signature": "SkuName() (string, error)", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.CognitiveServices/withProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure OpenAI Deployment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureOpenAIDeploymentResource)) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIDeploymentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureOpenAIDeploymentResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureOpenAIDeploymentResource)", + "description": "A method that can be used for customizing the `AzureOpenAIDeploymentResource`." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIDeploymentResource" + ], + "appliesTo": [ + "AzureOpenAIDeploymentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureOpenAIResource", + "fullName": "Aspire.Hosting.ApplicationModel.AzureOpenAIResource", + "kind": "handle", + "description": "Represents an Azure OpenAI resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "AddDeployment", + "capabilityId": "Aspire.Hosting.Azure.CognitiveServices/addDeployment", + "qualifiedName": "addDeployment", + "description": "Adds an Azure OpenAI deployment resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDeployment(name string, modelName string, modelVersion string) AzureOpenAIDeploymentResource", + "receiver": "AzureOpenAIResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure OpenAI Deployment resource." + }, + { + "name": "modelName", + "type": "string", + "description": "The name of the model to deploy." + }, + { + "name": "modelVersion", + "type": "string", + "description": "The version of the model to deploy." + } + ], + "returnType": "AzureOpenAIDeploymentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CognitiveServices/Aspire.Hosting.ApplicationModel.AzureOpenAIResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureOpenAIResource" + ], + "appliesTo": [ + "AzureOpenAIResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureOpenAIRole", + "fullName": "Aspire.Hosting.Azure.CognitiveServices.AzureOpenAIRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure OpenAI roles.", + "members": [ + { + "name": "AzureOpenAIRoleCognitiveServicesOpenAIContributor", + "value": "CognitiveServicesOpenAIContributor", + "description": "Allows full management of Azure OpenAI resources." + }, + { + "name": "AzureOpenAIRoleCognitiveServicesOpenAIUser", + "value": "CognitiveServicesOpenAIUser", + "description": "Allows using Azure OpenAI models for inference." + }, + { + "name": "AzureOpenAIRoleCognitiveServicesUser", + "value": "CognitiveServicesUser", + "description": "Allows access to Azure Cognitive Services resources." + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ConnectorNamespace.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ConnectorNamespace.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..8aa9b63a8f --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ConnectorNamespace.13.6.0-preview.1.26478.8.json @@ -0,0 +1,787 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.ConnectorNamespace", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureConnectorNamespace", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/addAzureConnectorNamespace", + "qualifiedName": "addAzureConnectorNamespace", + "description": "Adds an Azure Connector Namespace resource to the application model.", + "remarks": "Connector Namespace is a preview service. Connections that use OAuth or another interactive\nauthorization flow must be authorized in the Connector Namespaces portal after provisioning.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureConnectorNamespace(name string) AzureConnectorNamespaceResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureConnectorNamespaceResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddConnection", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/addConnection", + "qualifiedName": "addConnection", + "description": "Adds a connection to an Azure Connector Namespace.", + "remarks": "This method provisions the connection resource but does not automate OAuth consent or other\ninteractive authorization. Complete those steps in the Connector Namespaces portal.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddConnection(name string, connectorName string, options ...*AzureConnectorNamespaceConnectionOptions) AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name." + }, + { + "name": "connectorName", + "type": "string", + "description": "The connector catalog name, such as `office365`." + } + ], + "options": { + "typeName": "AzureConnectorNamespaceConnectionOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "AzureConnectorNamespaceConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceResource" + ] + }, + { + "name": "AddMcpServerConfig", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/addMcpServerConfig", + "qualifiedName": "addMcpServerConfig", + "description": "Adds a managed MCP server configuration to an Azure Connector Namespace.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddMcpServerConfig(name string, options ...*AzureConnectorNamespaceMcpServerConfigOptions) AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name." + } + ], + "options": { + "typeName": "AzureConnectorNamespaceMcpServerConfigOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceResource" + ] + }, + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/asExistingConnectorNamespaceConnection", + "qualifiedName": "asExisting", + "description": "Marks a Connector Namespace connection as an existing Azure resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsExisting() AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceConnectionResource", + "parameters": [], + "returnType": "AzureConnectorNamespaceConnectionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceConnectionResource" + ] + }, + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/asExistingConnectorNamespaceMcpServerConfig", + "qualifiedName": "asExisting", + "description": "Marks a managed MCP server configuration as an existing Azure resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsExisting() AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceMcpServerConfigResource", + "parameters": [], + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceMcpServerConfigResource" + ] + }, + { + "name": "WithAccessPolicy", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withAccessPolicy", + "qualifiedName": "withAccessPolicy", + "description": "Adds a Microsoft Entra access policy to a Connector Namespace connection.", + "remarks": "Access policies authorize a specific Microsoft Entra principal to use the connection. They do\nnot perform connector OAuth consent and should be limited to principals that require access.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAccessPolicy(name string, options *AzureConnectorNamespaceAccessPolicyOptions) AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceConnectionResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the policy." + }, + { + "name": "options", + "type": "*AzureConnectorNamespaceAccessPolicyOptions", + "description": "The authorized principal and optional Azure policy name." + } + ], + "returnType": "AzureConnectorNamespaceConnectionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceConnectionResource" + ] + }, + { + "name": "WithAccessPolicy", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withMcpServerConfigAccessPolicy", + "qualifiedName": "withAccessPolicy", + "description": "Adds a Microsoft Entra user or group access policy to a managed MCP server configuration.", + "remarks": "Managed MCP endpoints reject callers that do not have a config-scoped access policy.\nConnector Namespace currently supports Microsoft Entra users and groups for these policies.\nThe Azure child resource name is set to the principal object ID as required by the service.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAccessPolicy(name string, options *AzureConnectorNamespaceMcpAccessPolicyOptions) AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceMcpServerConfigResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the policy." + }, + { + "name": "options", + "type": "*AzureConnectorNamespaceMcpAccessPolicyOptions", + "description": "The authorized user or group." + } + ], + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceMcpServerConfigResource" + ] + }, + { + "name": "WithConnector", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withConnector", + "qualifiedName": "withConnector", + "description": "Adds a connector route and an explicit operation allow-list to a managed MCP server configuration.", + "remarks": "Connections and MCP server configurations are separate Azure resources so a connection can be\nreused independently. This method links the MCP server configuration to its underlying connection\nand exposes only the operations listed in `options` as MCP tools. Operation IDs\nare connector-specific and should be verified against the connector operation metadata. The current\nConnector Namespace preview supports one connector per managed MCP server configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithConnector(connectorName string, connection AzureConnectorNamespaceConnectionResource, options *AzureConnectorNamespaceMcpConnectorOptions) AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceMcpServerConfigResource", + "parameters": [ + { + "name": "connectorName", + "type": "string", + "description": "The connector route name." + }, + { + "name": "connection", + "type": "AzureConnectorNamespaceConnectionResource", + "description": "The connection used by the connector route." + }, + { + "name": "options", + "type": "*AzureConnectorNamespaceMcpConnectorOptions", + "description": "The connector metadata and operation allow-list." + } + ], + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceMcpServerConfigResource" + ] + }, + { + "name": "WithIdentityAccessPolicy", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withIdentityAccessPolicy", + "qualifiedName": "withIdentityAccessPolicy", + "description": "Adds a connection access policy for a user-assigned managed identity.", + "remarks": "This method authorizes the identity to use the connection. The connection's downstream OAuth,\nAPI key, or basic authentication must still be configured separately.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithIdentityAccessPolicy(name string, identity AzureUserAssignedIdentityResource, options ...*WithIdentityAccessPolicyOptions) AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceConnectionResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the policy." + }, + { + "name": "identity", + "type": "AzureUserAssignedIdentityResource", + "description": "The user-assigned managed identity authorized to use the connection." + } + ], + "options": { + "typeName": "WithIdentityAccessPolicyOptions", + "fields": [ + { + "name": "PolicyName", + "jsonName": "policyName", + "type": "*string", + "description": "The optional Azure child resource name. The Aspire resource name is used when omitted." + } + ] + }, + "returnType": "AzureConnectorNamespaceConnectionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceConnectionResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureConnectorNamespaceConnectionResource", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "kind": "handle", + "description": "Represents a connection child resource in an Azure Connector Namespace.", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/asExistingConnectorNamespaceConnection", + "qualifiedName": "asExisting", + "description": "Marks a Connector Namespace connection as an existing Azure resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsExisting() AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceConnectionResource", + "parameters": [], + "returnType": "AzureConnectorNamespaceConnectionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceConnectionResource" + ] + }, + { + "name": "WithAccessPolicy", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withAccessPolicy", + "qualifiedName": "withAccessPolicy", + "description": "Adds a Microsoft Entra access policy to a Connector Namespace connection.", + "remarks": "Access policies authorize a specific Microsoft Entra principal to use the connection. They do\nnot perform connector OAuth consent and should be limited to principals that require access.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAccessPolicy(name string, options *AzureConnectorNamespaceAccessPolicyOptions) AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceConnectionResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the policy." + }, + { + "name": "options", + "type": "*AzureConnectorNamespaceAccessPolicyOptions", + "description": "The authorized principal and optional Azure policy name." + } + ], + "returnType": "AzureConnectorNamespaceConnectionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceConnectionResource" + ] + }, + { + "name": "WithIdentityAccessPolicy", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withIdentityAccessPolicy", + "qualifiedName": "withIdentityAccessPolicy", + "description": "Adds a connection access policy for a user-assigned managed identity.", + "remarks": "This method authorizes the identity to use the connection. The connection's downstream OAuth,\nAPI key, or basic authentication must still be configured separately.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithIdentityAccessPolicy(name string, identity AzureUserAssignedIdentityResource, options ...*WithIdentityAccessPolicyOptions) AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceConnectionResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the policy." + }, + { + "name": "identity", + "type": "AzureUserAssignedIdentityResource", + "description": "The user-assigned managed identity authorized to use the connection." + } + ], + "options": { + "typeName": "WithIdentityAccessPolicyOptions", + "fields": [ + { + "name": "PolicyName", + "jsonName": "policyName", + "type": "*string", + "description": "The optional Azure child resource name. The Aspire resource name is used when omitted." + } + ] + }, + "returnType": "AzureConnectorNamespaceConnectionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceConnectionResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureConnectorNamespaceMcpServerConfigResource", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "kind": "handle", + "description": "Represents a managed MCP server configuration child resource in an Azure Connector Namespace.", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/asExistingConnectorNamespaceMcpServerConfig", + "qualifiedName": "asExisting", + "description": "Marks a managed MCP server configuration as an existing Azure resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsExisting() AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceMcpServerConfigResource", + "parameters": [], + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceMcpServerConfigResource" + ] + }, + { + "name": "WithAccessPolicy", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withMcpServerConfigAccessPolicy", + "qualifiedName": "withAccessPolicy", + "description": "Adds a Microsoft Entra user or group access policy to a managed MCP server configuration.", + "remarks": "Managed MCP endpoints reject callers that do not have a config-scoped access policy.\nConnector Namespace currently supports Microsoft Entra users and groups for these policies.\nThe Azure child resource name is set to the principal object ID as required by the service.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAccessPolicy(name string, options *AzureConnectorNamespaceMcpAccessPolicyOptions) AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceMcpServerConfigResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the policy." + }, + { + "name": "options", + "type": "*AzureConnectorNamespaceMcpAccessPolicyOptions", + "description": "The authorized user or group." + } + ], + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceMcpServerConfigResource" + ] + }, + { + "name": "WithConnector", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/withConnector", + "qualifiedName": "withConnector", + "description": "Adds a connector route and an explicit operation allow-list to a managed MCP server configuration.", + "remarks": "Connections and MCP server configurations are separate Azure resources so a connection can be\nreused independently. This method links the MCP server configuration to its underlying connection\nand exposes only the operations listed in `options` as MCP tools. Operation IDs\nare connector-specific and should be verified against the connector operation metadata. The current\nConnector Namespace preview supports one connector per managed MCP server configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithConnector(connectorName string, connection AzureConnectorNamespaceConnectionResource, options *AzureConnectorNamespaceMcpConnectorOptions) AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceMcpServerConfigResource", + "parameters": [ + { + "name": "connectorName", + "type": "string", + "description": "The connector route name." + }, + { + "name": "connection", + "type": "AzureConnectorNamespaceConnectionResource", + "description": "The connection used by the connector route." + }, + { + "name": "options", + "type": "*AzureConnectorNamespaceMcpConnectorOptions", + "description": "The connector metadata and operation allow-list." + } + ], + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceMcpServerConfigResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureConnectorNamespaceResource", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceResource", + "kind": "handle", + "description": "Represents an Azure Connector Namespace backed by a `Microsoft.Web/connectorGateways` resource.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "AddConnection", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/addConnection", + "qualifiedName": "addConnection", + "description": "Adds a connection to an Azure Connector Namespace.", + "remarks": "This method provisions the connection resource but does not automate OAuth consent or other\ninteractive authorization. Complete those steps in the Connector Namespaces portal.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddConnection(name string, connectorName string, options ...*AzureConnectorNamespaceConnectionOptions) AzureConnectorNamespaceConnectionResource", + "receiver": "AzureConnectorNamespaceResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name." + }, + { + "name": "connectorName", + "type": "string", + "description": "The connector catalog name, such as `office365`." + } + ], + "options": { + "typeName": "AzureConnectorNamespaceConnectionOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "AzureConnectorNamespaceConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceResource" + ] + }, + { + "name": "AddMcpServerConfig", + "capabilityId": "Aspire.Hosting.Azure.ConnectorNamespace/addMcpServerConfig", + "qualifiedName": "addMcpServerConfig", + "description": "Adds a managed MCP server configuration to an Azure Connector Namespace.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddMcpServerConfig(name string, options ...*AzureConnectorNamespaceMcpServerConfigOptions) AzureConnectorNamespaceMcpServerConfigResource", + "receiver": "AzureConnectorNamespaceResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name." + } + ], + "options": { + "typeName": "AzureConnectorNamespaceMcpServerConfigOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "AzureConnectorNamespaceMcpServerConfigResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ConnectorNamespace/Aspire.Hosting.Azure.AzureConnectorNamespaceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureConnectorNamespaceResource" + ], + "appliesTo": [ + "AzureConnectorNamespaceResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "AzureConnectorNamespaceAccessPolicyOptions", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceAccessPolicyOptions", + "kind": "dto", + "description": "Configures a Microsoft Entra access policy for a Connector Namespace connection.", + "fields": [ + { + "name": "PolicyName", + "jsonName": "PolicyName", + "type": "*string", + "description": "Gets or sets the Azure child resource name. The Aspire resource name is used when omitted." + }, + { + "name": "ObjectId", + "jsonName": "ObjectId", + "type": "string", + "description": "Gets or sets the Microsoft Entra object ID authorized to use the connection." + }, + { + "name": "TenantId", + "jsonName": "TenantId", + "type": "string", + "description": "Gets or sets the Microsoft Entra tenant ID for `ObjectId`." + } + ] + }, + { + "name": "AzureConnectorNamespaceConnectionOptions", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceConnectionOptions", + "kind": "dto", + "description": "Configures a Connector Namespace connection.", + "fields": [ + { + "name": "ConnectionName", + "jsonName": "ConnectionName", + "type": "*string", + "description": "Gets or sets the Azure child resource name. The Aspire resource name is used when omitted." + }, + { + "name": "DisplayName", + "jsonName": "DisplayName", + "type": "*string", + "description": "Gets or sets the friendly connection name shown in the Connector Namespace portal." + } + ] + }, + { + "name": "AzureConnectorNamespaceMcpAccessPolicyOptions", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpAccessPolicyOptions", + "kind": "dto", + "description": "Configures a Microsoft Entra access policy for a managed MCP server configuration.", + "fields": [ + { + "name": "ObjectId", + "jsonName": "ObjectId", + "type": "string", + "description": "Gets or sets the Microsoft Entra object ID authorized to call the MCP server." + }, + { + "name": "TenantId", + "jsonName": "TenantId", + "type": "string", + "description": "Gets or sets the Microsoft Entra tenant ID for `ObjectId`." + }, + { + "name": "PrincipalType", + "jsonName": "PrincipalType", + "type": "AzureConnectorNamespaceMcpAccessPolicyPrincipalType", + "description": "Gets or sets whether `ObjectId` identifies a user or group." + } + ] + }, + { + "name": "AzureConnectorNamespaceMcpConnectorOptions", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpConnectorOptions", + "kind": "dto", + "description": "Configures a connector route exposed by a managed MCP server.", + "fields": [ + { + "name": "DisplayName", + "jsonName": "DisplayName", + "type": "*string", + "description": "Gets or sets the friendly connector name shown to MCP clients." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Gets or sets the connector description shown to MCP clients." + }, + { + "name": "Operations", + "jsonName": "Operations", + "type": "[]*AzureConnectorNamespaceMcpOperationOptions", + "description": "Gets or sets the allow-listed connector operations exposed as MCP tools." + } + ] + }, + { + "name": "AzureConnectorNamespaceMcpOperationOptions", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpOperationOptions", + "kind": "dto", + "description": "Describes a connector operation exposed as an MCP tool.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "string", + "description": "Gets or sets the connector operation ID." + }, + { + "name": "DisplayName", + "jsonName": "DisplayName", + "type": "*string", + "description": "Gets or sets the friendly operation name shown to MCP clients." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Gets or sets the operation description shown to MCP clients." + } + ] + }, + { + "name": "AzureConnectorNamespaceMcpServerConfigOptions", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpServerConfigOptions", + "kind": "dto", + "description": "Configures a managed MCP server in a Connector Namespace.", + "fields": [ + { + "name": "ConfigName", + "jsonName": "ConfigName", + "type": "*string", + "description": "Gets or sets the Azure child resource name. The Aspire resource name is used when omitted." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Gets or sets the description shown to MCP clients." + } + ] + } + ], + "enumTypes": [ + { + "name": "AzureConnectorNamespaceMcpAccessPolicyPrincipalType", + "fullName": "Aspire.Hosting.Azure.AzureConnectorNamespaceMcpAccessPolicyPrincipalType", + "kind": "enum", + "description": "Specifies the Microsoft Entra principal type authorized to call a managed MCP server.", + "members": [ + { + "name": "AzureConnectorNamespaceMcpAccessPolicyPrincipalTypeUser", + "value": "User", + "description": "Authorizes an individual Microsoft Entra user." + }, + { + "name": "AzureConnectorNamespaceMcpAccessPolicyPrincipalTypeGroup", + "value": "Group", + "description": "Authorizes a Microsoft Entra group." + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ContainerRegistry.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ContainerRegistry.13.6.0.json new file mode 100644 index 0000000000..2492d1fd73 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ContainerRegistry.13.6.0.json @@ -0,0 +1,388 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.ContainerRegistry", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureContainerRegistry", + "capabilityId": "Aspire.Hosting.Azure.ContainerRegistry/addAzureContainerRegistry", + "qualifiedName": "addAzureContainerRegistry", + "description": "Adds an Azure Container Registry resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureContainerRegistry(name string) AzureContainerRegistryResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureContainerRegistryResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "GetAzureContainerRegistry", + "capabilityId": "Aspire.Hosting.Azure.ContainerRegistry/getAzureContainerRegistry", + "qualifiedName": "getAzureContainerRegistry", + "description": "Gets the Azure Container Registry associated with a compute environment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "GetAzureContainerRegistry() AzureContainerRegistryResource", + "receiver": "Resource", + "parameters": [], + "returnType": "AzureContainerRegistryResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureContainerRegistryResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithAzureContainerRegistry", + "capabilityId": "Aspire.Hosting.Azure.ContainerRegistry/withContainerRegistryAzureContainerRegistry", + "qualifiedName": "withAzureContainerRegistry", + "description": "Configures a compute environment resource to use an Azure Container Registry.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAzureContainerRegistry(registryBuilder AzureContainerRegistryResource) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "registryBuilder", + "type": "AzureContainerRegistryResource", + "description": "The resource builder for the `AzureContainerRegistryResource` to use." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureContainerRegistryResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithContainerRegistryRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.ContainerRegistry/withContainerRegistryRoleAssignments", + "qualifiedName": "withContainerRegistryRoleAssignments", + "description": "Adds role assignments to the specified Azure Container Registry resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerRegistryRoleAssignments(target AzureContainerRegistryResource, roles []AzureContainerRegistryRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureContainerRegistryResource", + "description": "The target Azure Container Registry resource." + }, + { + "name": "roles", + "type": "[]AzureContainerRegistryRole", + "description": "The Azure Container Registry roles to assign to the resource." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureContainerRegistryResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPurgeTask", + "capabilityId": "Aspire.Hosting.Azure.ContainerRegistry/withPurgeTask", + "qualifiedName": "withPurgeTask", + "description": "Adds a scheduled ACR purge task to remove old or unused container images from the registry.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPurgeTask(schedule string, options ...*WithPurgeTaskOptions) AzureContainerRegistryResource", + "receiver": "AzureContainerRegistryResource", + "parameters": [ + { + "name": "schedule", + "type": "string", + "description": "The cron schedule for the purge task timer trigger. Must be a five-part cron expression (`minute hour day-of-month month day-of-week`); seconds are not supported." + } + ], + "options": { + "typeName": "WithPurgeTaskOptions", + "fields": [ + { + "name": "Filter", + "jsonName": "filter", + "type": "*string", + "description": "An optional filter for the `acr purge --filter` parameter. Only repositories matching this filter will be purged. Defaults to `\".*:.*\"` (all repositories and tags) when `null`." + }, + { + "name": "Ago", + "jsonName": "ago", + "type": "*float64", + "description": "The age threshold for `acr purge --ago`. Images older than this duration will be considered for removal. Uses Go-style duration format (e.g., `2d3h6m`). Defaults to `0d` when `null`." + }, + { + "name": "Keep", + "jsonName": "keep", + "type": "*float64", + "description": "The number of most recent images to keep per repository, regardless of age. Must be greater than zero. Defaults to 3." + }, + { + "name": "TaskName", + "jsonName": "taskName", + "type": "*string", + "description": "An optional name for the ACR task resource. If not provided, a name is auto-generated based on existing purge tasks to avoid conflicts. If a task with the specified name already exists, an `ArgumentException` is thrown." + } + ] + }, + "returnType": "AzureContainerRegistryResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ContainerRegistry/Aspire.Hosting.Azure.AzureContainerRegistryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureContainerRegistryResource" + ], + "appliesTo": [ + "AzureContainerRegistryResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureContainerRegistryResource", + "fullName": "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithPurgeTask", + "capabilityId": "Aspire.Hosting.Azure.ContainerRegistry/withPurgeTask", + "qualifiedName": "withPurgeTask", + "description": "Adds a scheduled ACR purge task to remove old or unused container images from the registry.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPurgeTask(schedule string, options ...*WithPurgeTaskOptions) AzureContainerRegistryResource", + "receiver": "AzureContainerRegistryResource", + "parameters": [ + { + "name": "schedule", + "type": "string", + "description": "The cron schedule for the purge task timer trigger. Must be a five-part cron expression (`minute hour day-of-month month day-of-week`); seconds are not supported." + } + ], + "options": { + "typeName": "WithPurgeTaskOptions", + "fields": [ + { + "name": "Filter", + "jsonName": "filter", + "type": "*string", + "description": "An optional filter for the `acr purge --filter` parameter. Only repositories matching this filter will be purged. Defaults to `\".*:.*\"` (all repositories and tags) when `null`." + }, + { + "name": "Ago", + "jsonName": "ago", + "type": "*float64", + "description": "The age threshold for `acr purge --ago`. Images older than this duration will be considered for removal. Uses Go-style duration format (e.g., `2d3h6m`). Defaults to `0d` when `null`." + }, + { + "name": "Keep", + "jsonName": "keep", + "type": "*float64", + "description": "The number of most recent images to keep per repository, regardless of age. Must be greater than zero. Defaults to 3." + }, + { + "name": "TaskName", + "jsonName": "taskName", + "type": "*string", + "description": "An optional name for the ACR task resource. If not provided, a name is auto-generated based on existing purge tasks to avoid conflicts. If a task with the specified name already exists, an `ArgumentException` is thrown." + } + ] + }, + "returnType": "AzureContainerRegistryResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ContainerRegistry/Aspire.Hosting.Azure.AzureContainerRegistryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureContainerRegistryResource" + ], + "appliesTo": [ + "AzureContainerRegistryResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureContainerRegistryRole", + "fullName": "Aspire.Hosting.AzureContainerRegistryRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure Container Registry roles.", + "members": [ + { + "name": "AzureContainerRegistryRoleAcrDelete", + "value": "AcrDelete" + }, + { + "name": "AzureContainerRegistryRoleAcrImageSigner", + "value": "AcrImageSigner" + }, + { + "name": "AzureContainerRegistryRoleAcrPull", + "value": "AcrPull" + }, + { + "name": "AzureContainerRegistryRoleAcrPush", + "value": "AcrPush" + }, + { + "name": "AzureContainerRegistryRoleAcrQuarantineReader", + "value": "AcrQuarantineReader" + }, + { + "name": "AzureContainerRegistryRoleAcrQuarantineWriter", + "value": "AcrQuarantineWriter" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.CosmosDB.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.CosmosDB.13.6.0.json new file mode 100644 index 0000000000..bc3f2bc602 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.CosmosDB.13.6.0.json @@ -0,0 +1,835 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.CosmosDB", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureCosmosDB", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/addAzureCosmosDB", + "qualifiedName": "addAzureCosmosDB", + "description": "Adds an Azure Cosmos DB connection to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureCosmosDB(name string) AzureCosmosDBResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureCosmosDBResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddContainer", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/addContainer", + "qualifiedName": "addContainer", + "description": "Adds an Azure Cosmos DB container resource", + "kind": "Method", + "signature": "AddContainer(name string, partitionKeyPaths any, options ...*AzureCosmosDBDatabaseResourceAddContainerOptions) AzureCosmosDBContainerResource", + "receiver": "AzureCosmosDBDatabaseResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "partitionKeyPaths", + "type": "any", + "allowedTypes": [ + "string", + "[]string" + ] + } + ], + "options": { + "typeName": "AzureCosmosDBDatabaseResourceAddContainerOptions", + "fields": [ + { + "name": "ContainerName", + "jsonName": "containerName", + "type": "*string" + } + ] + }, + "returnType": "AzureCosmosDBContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource" + ], + "appliesTo": [ + "AzureCosmosDBDatabaseResource" + ] + }, + { + "name": "AddCosmosDatabase", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/addCosmosDatabase", + "qualifiedName": "addCosmosDatabase", + "description": "Adds a database to the associated Cosmos DB account resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddCosmosDatabase(name string, options ...*AddCosmosDatabaseOptions) AzureCosmosDBDatabaseResource", + "receiver": "AzureCosmosDBResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the database resource." + } + ], + "options": { + "typeName": "AddCosmosDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureCosmosDBDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "RunAsClassicEmulator", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/runAsClassicEmulator", + "qualifiedName": "runAsClassicEmulator", + "description": "Configures the Azure Cosmos DB resource to run using the classic emulator", + "remarks": "When using the classic Azure Cosmos DB emulator, the container requires a TLS/SSL certificate.\nFor more information, see .\nThis version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsClassicEmulator(options ...*RunAsClassicEmulatorOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "RunAsClassicEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureCosmosDBEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureCosmosDBEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureCosmosDBEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureCosmosDBEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "RunAsPreviewEmulator", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/runAsPreviewEmulator", + "qualifiedName": "runAsPreviewEmulator", + "description": "Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator. Use runAsEmulator instead.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsPreviewEmulator(options ...*RunAsPreviewEmulatorOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "RunAsPreviewEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureCosmosDBEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureCosmosDBEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "WithAccessKeyAuthentication", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withAccessKeyAuthentication", + "qualifiedName": "withAccessKeyAuthentication", + "description": "Configures Azure Cosmos DB to use access key authentication", + "kind": "Method", + "signature": "WithAccessKeyAuthentication(options ...*WithAccessKeyAuthenticationOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "WithAccessKeyAuthenticationOptions", + "fields": [ + { + "name": "KeyVaultBuilder", + "jsonName": "keyVaultBuilder", + "type": "*AzureKeyVaultResource" + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "WithDataExplorer", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withDataExplorer", + "qualifiedName": "withDataExplorer", + "description": "Configures the Azure Cosmos DB Linux-based (vNext) emulator to expose the Data Explorer endpoint.", + "remarks": "The separate Data Explorer endpoint configured by this method is only available with `RunAsEmulator`.", + "returns": "Cosmos emulator resource builder.", + "kind": "Method", + "signature": "WithDataExplorer(options ...*WithDataExplorerOptions) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataExplorerOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "Optional host port to bind the Data Explorer to." + } + ] + }, + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to an Azure Cosmos DB emulator resource.", + "returns": "A builder for the `AzureCosmosDBEmulatorResource`.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + } + ] + }, + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + }, + { + "name": "WithDefaultAzureSku", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withDefaultAzureSku", + "qualifiedName": "withDefaultAzureSku", + "description": "Configures the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDefaultAzureSku() AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "WithGatewayPort", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withGatewayPort", + "qualifiedName": "withGatewayPort", + "description": "Configures the gateway port for the Azure Cosmos DB emulator.", + "returns": "Cosmos emulator resource builder.", + "kind": "Method", + "signature": "WithGatewayPort(port *float64) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "Host port to bind to the emulator gateway port." + } + ], + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + }, + { + "name": "WithPartitionCount", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withPartitionCount", + "qualifiedName": "withPartitionCount", + "description": "Configures the partition count for the Azure Cosmos DB emulator.", + "remarks": "Not calling this method will result in the default of 10 partitions. The actual started partitions is always one more than specified.\nSee this documentation about setting the partition count.", + "returns": "Cosmos emulator resource builder.", + "kind": "Method", + "signature": "WithPartitionCount(count float64) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [ + { + "name": "count", + "type": "float64", + "description": "Desired partition count." + } + ], + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureCosmosDBContainerResource", + "fullName": "Aspire.Hosting.Azure.AzureCosmosDBContainerResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBDatabaseResource", + "fullName": "Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "AddContainer", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/addContainer", + "qualifiedName": "addContainer", + "description": "Adds an Azure Cosmos DB container resource", + "kind": "Method", + "signature": "AddContainer(name string, partitionKeyPaths any, options ...*AzureCosmosDBDatabaseResourceAddContainerOptions) AzureCosmosDBContainerResource", + "receiver": "AzureCosmosDBDatabaseResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "partitionKeyPaths", + "type": "any", + "allowedTypes": [ + "string", + "[]string" + ] + } + ], + "options": { + "typeName": "AzureCosmosDBDatabaseResourceAddContainerOptions", + "fields": [ + { + "name": "ContainerName", + "jsonName": "containerName", + "type": "*string" + } + ] + }, + "returnType": "AzureCosmosDBContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource" + ], + "appliesTo": [ + "AzureCosmosDBDatabaseResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithDataExplorer", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withDataExplorer", + "qualifiedName": "withDataExplorer", + "description": "Configures the Azure Cosmos DB Linux-based (vNext) emulator to expose the Data Explorer endpoint.", + "remarks": "The separate Data Explorer endpoint configured by this method is only available with `RunAsEmulator`.", + "returns": "Cosmos emulator resource builder.", + "kind": "Method", + "signature": "WithDataExplorer(options ...*WithDataExplorerOptions) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataExplorerOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "Optional host port to bind the Data Explorer to." + } + ] + }, + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to an Azure Cosmos DB emulator resource.", + "returns": "A builder for the `AzureCosmosDBEmulatorResource`.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + } + ] + }, + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + }, + { + "name": "WithGatewayPort", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withGatewayPort", + "qualifiedName": "withGatewayPort", + "description": "Configures the gateway port for the Azure Cosmos DB emulator.", + "returns": "Cosmos emulator resource builder.", + "kind": "Method", + "signature": "WithGatewayPort(port *float64) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "Host port to bind to the emulator gateway port." + } + ], + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + }, + { + "name": "WithPartitionCount", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withPartitionCount", + "qualifiedName": "withPartitionCount", + "description": "Configures the partition count for the Azure Cosmos DB emulator.", + "remarks": "Not calling this method will result in the default of 10 partitions. The actual started partitions is always one more than specified.\nSee this documentation about setting the partition count.", + "returns": "Cosmos emulator resource builder.", + "kind": "Method", + "signature": "WithPartitionCount(count float64) AzureCosmosDBEmulatorResource", + "receiver": "AzureCosmosDBEmulatorResource", + "parameters": [ + { + "name": "count", + "type": "float64", + "description": "Desired partition count." + } + ], + "returnType": "AzureCosmosDBEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultResource", + "fullName": "Aspire.Hosting.Azure.IAzureKeyVaultResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBResource", + "fullName": "Aspire.Hosting.AzureCosmosDBResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddCosmosDatabase", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/addCosmosDatabase", + "qualifiedName": "addCosmosDatabase", + "description": "Adds a database to the associated Cosmos DB account resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddCosmosDatabase(name string, options ...*AddCosmosDatabaseOptions) AzureCosmosDBDatabaseResource", + "receiver": "AzureCosmosDBResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the database resource." + } + ], + "options": { + "typeName": "AddCosmosDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureCosmosDBDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "RunAsClassicEmulator", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/runAsClassicEmulator", + "qualifiedName": "runAsClassicEmulator", + "description": "Configures the Azure Cosmos DB resource to run using the classic emulator", + "remarks": "When using the classic Azure Cosmos DB emulator, the container requires a TLS/SSL certificate.\nFor more information, see .\nThis version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsClassicEmulator(options ...*RunAsClassicEmulatorOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "RunAsClassicEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureCosmosDBEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureCosmosDBEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureCosmosDBEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureCosmosDBEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "RunAsPreviewEmulator", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/runAsPreviewEmulator", + "qualifiedName": "runAsPreviewEmulator", + "description": "Configures the Azure Cosmos DB resource to run using the local Linux-based (vNext) emulator. Use runAsEmulator instead.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsPreviewEmulator(options ...*RunAsPreviewEmulatorOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "RunAsPreviewEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureCosmosDBEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureCosmosDBEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "WithAccessKeyAuthentication", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withAccessKeyAuthentication", + "qualifiedName": "withAccessKeyAuthentication", + "description": "Configures Azure Cosmos DB to use access key authentication", + "kind": "Method", + "signature": "WithAccessKeyAuthentication(options ...*WithAccessKeyAuthenticationOptions) AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "options": { + "typeName": "WithAccessKeyAuthenticationOptions", + "fields": [ + { + "name": "KeyVaultBuilder", + "jsonName": "keyVaultBuilder", + "type": "*AzureKeyVaultResource" + } + ] + }, + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + }, + { + "name": "WithDefaultAzureSku", + "capabilityId": "Aspire.Hosting.Azure.CosmosDB/withDefaultAzureSku", + "qualifiedName": "withDefaultAzureSku", + "description": "Configures the Azure Cosmos DB resource to be deployed use the default SKU provided by Azure.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDefaultAzureSku() AzureCosmosDBResource", + "receiver": "AzureCosmosDBResource", + "parameters": [], + "returnType": "AzureCosmosDBResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.CosmosDB/Aspire.Hosting.AzureCosmosDBResource", + "expandedTargetTypes": [ + "Aspire.Hosting.AzureCosmosDBResource" + ], + "appliesTo": [ + "AzureCosmosDBResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.EventHubs.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.EventHubs.13.6.0.json new file mode 100644 index 0000000000..2ac95d5bf6 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.EventHubs.13.6.0.json @@ -0,0 +1,959 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.EventHubs", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.connectionStringExpression", + "qualifiedName": "AzureEventHubResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Event Hub.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "HubName", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.hubName", + "qualifiedName": "AzureEventHubResource.hubName", + "description": "The event hub name.", + "kind": "PropertyGetter", + "signature": "HubName() (string, error)", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.parent", + "qualifiedName": "AzureEventHubResource.parent", + "description": "Gets the parent Azure Event Hubs resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureEventHubsResource", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "AzureEventHubsResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "PartitionCount", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.partitionCount", + "qualifiedName": "AzureEventHubResource.partitionCount", + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.", + "kind": "PropertyGetter", + "signature": "PartitionCount() (*float64, error)", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "SetHubName", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.setHubName", + "qualifiedName": "AzureEventHubResource.setHubName", + "description": "The event hub name.", + "kind": "PropertySetter", + "signature": "SetHubName(value string) AzureEventHubResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The event hub name." + } + ], + "returnType": "AzureEventHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "SetPartitionCount", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.setPartitionCount", + "qualifiedName": "AzureEventHubResource.setPartitionCount", + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.", + "kind": "PropertySetter", + "signature": "SetPartitionCount(value *float64) AzureEventHubResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." + } + ], + "returnType": "AzureEventHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "AddAzureEventHubs", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/addAzureEventHubs", + "qualifiedName": "addAzureEventHubs", + "description": "Adds an Azure Event Hubs Namespace resource to the application model. This resource can be used to create Event Hub resources.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureEventHubs(name string) AzureEventHubsResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureEventHubsResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddConsumerGroup", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/addConsumerGroup", + "qualifiedName": "addConsumerGroup", + "description": "Adds an Azure Event Hub Consumer Group resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddConsumerGroup(name string, options ...*AddConsumerGroupOptions) AzureEventHubConsumerGroupResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Event Hub Consumer Group resource." + } + ], + "options": { + "typeName": "AddConsumerGroupOptions", + "fields": [ + { + "name": "GroupName", + "jsonName": "groupName", + "type": "*string", + "description": "The name of the Consumer Group. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureEventHubConsumerGroupResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "AddHub", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/addHub", + "qualifiedName": "addHub", + "description": "Adds an Azure Event Hubs hub resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddHub(name string, options ...*AddHubOptions) AzureEventHubResource", + "receiver": "AzureEventHubsResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Event Hub resource." + } + ], + "options": { + "typeName": "AddHubOptions", + "fields": [ + { + "name": "HubName", + "jsonName": "hubName", + "type": "*string", + "description": "The name of the Event Hub. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureEventHubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsResource" + ], + "appliesTo": [ + "AzureEventHubsResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Event Hubs resource to run with the local emulator", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureEventHubsResource", + "receiver": "AzureEventHubsResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureEventHubsEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureEventHubsEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureEventHubsResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsResource" + ], + "appliesTo": [ + "AzureEventHubsResource" + ] + }, + { + "name": "WithConfigurationFile", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withConfigurationFile", + "qualifiedName": "withConfigurationFile", + "description": "Adds a bind mount for the configuration file of an Azure Event Hubs emulator resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithConfigurationFile(path string) AzureEventHubsEmulatorResource", + "receiver": "AzureEventHubsEmulatorResource", + "parameters": [ + { + "name": "path", + "type": "string", + "description": "Path to the file on the AppHost where the emulator configuration is located." + } + ], + "returnType": "AzureEventHubsEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsEmulatorResource" + ], + "appliesTo": [ + "AzureEventHubsEmulatorResource" + ] + }, + { + "name": "WithEventHubsRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withEventHubsRoleAssignments", + "qualifiedName": "withEventHubsRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Event Hubs Namespace resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithEventHubsRoleAssignments(target AzureEventHubsResource, roles []AzureEventHubsRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureEventHubsResource", + "description": "The target Azure Event Hubs Namespace resource." + }, + { + "name": "roles", + "type": "[]AzureEventHubsRole", + "description": "The Event Hubs roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureEventHubResource", + "Aspire.Hosting.Azure.AzureEventHubsResource", + "Aspire.Hosting.Azure.AzureEventHubConsumerGroupResource", + "Aspire.Hosting.Azure.AzureEventHubsEmulatorResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "Aspire.Hosting.Azure.AzureStorageResource", + "Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "Aspire.Hosting.Azure.AzureBlobStorageResource", + "Aspire.Hosting.Azure.AzureDataLakeStorageResource", + "Aspire.Hosting.Azure.AzureBlobStorageContainerResource", + "Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource", + "Aspire.Hosting.Azure.AzureTableStorageResource", + "Aspire.Hosting.Azure.AzureQueueStorageResource", + "Aspire.Hosting.Azure.AzureQueueStorageQueueResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureBlobStorageContainerResource", + "AzureBlobStorageResource", + "AzureDataLakeStorageFileSystemResource", + "AzureDataLakeStorageResource", + "AzureEnvironmentResource", + "AzureEventHubConsumerGroupResource", + "AzureEventHubResource", + "AzureEventHubsEmulatorResource", + "AzureEventHubsResource", + "AzureProvisioningResource", + "AzureQueueStorageQueueResource", + "AzureQueueStorageResource", + "AzureStorageEmulatorResource", + "AzureStorageResource", + "AzureTableStorageResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port for the Azure Event Hubs emulator is exposed on instead of using randomly assigned port.", + "returns": "Azure Event Hubs emulator resource builder.", + "kind": "Method", + "signature": "WithHostPort(port *float64) AzureEventHubsEmulatorResource", + "receiver": "AzureEventHubsEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "The port to bind on the host. If `null` is used, a random port will be assigned." + } + ], + "returnType": "AzureEventHubsEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsEmulatorResource" + ], + "appliesTo": [ + "AzureEventHubsEmulatorResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Event Hub resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureEventHubResource)) AzureEventHubResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureEventHubResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureEventHubResource)", + "description": "A method that can be used for customizing the `AzureEventHubResource`." + } + ], + "returnType": "AzureEventHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBlobStorageContainerResource", + "fullName": "Aspire.Hosting.Azure.AzureBlobStorageContainerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBlobStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureBlobStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureDataLakeStorageFileSystemResource", + "fullName": "Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureDataLakeStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureDataLakeStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEventHubConsumerGroupResource", + "fullName": "Aspire.Hosting.Azure.AzureEventHubConsumerGroupResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEventHubResource", + "fullName": "Aspire.Hosting.Azure.AzureEventHubResource", + "kind": "handle", + "description": "Represents an Azure Event Hub. Initializes a new instance of the {@ats-ref type:AzureEventHubResource} class.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.connectionStringExpression", + "qualifiedName": "AzureEventHubResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Event Hub.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "HubName", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.hubName", + "qualifiedName": "AzureEventHubResource.hubName", + "description": "The event hub name.", + "kind": "PropertyGetter", + "signature": "HubName() (string, error)", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.parent", + "qualifiedName": "AzureEventHubResource.parent", + "description": "Gets the parent Azure Event Hubs resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureEventHubsResource", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "AzureEventHubsResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "PartitionCount", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.partitionCount", + "qualifiedName": "AzureEventHubResource.partitionCount", + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.", + "kind": "PropertyGetter", + "signature": "PartitionCount() (*float64, error)", + "receiver": "AzureEventHubResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "SetHubName", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.setHubName", + "qualifiedName": "AzureEventHubResource.setHubName", + "description": "The event hub name.", + "kind": "PropertySetter", + "signature": "SetHubName(value string) AzureEventHubResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The event hub name." + } + ], + "returnType": "AzureEventHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "SetPartitionCount", + "capabilityId": "Aspire.Hosting.Azure/AzureEventHubResource.setPartitionCount", + "qualifiedName": "AzureEventHubResource.setPartitionCount", + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions.", + "kind": "PropertySetter", + "signature": "SetPartitionCount(value *float64) AzureEventHubResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions." + } + ], + "returnType": "AzureEventHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "AddConsumerGroup", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/addConsumerGroup", + "qualifiedName": "addConsumerGroup", + "description": "Adds an Azure Event Hub Consumer Group resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddConsumerGroup(name string, options ...*AddConsumerGroupOptions) AzureEventHubConsumerGroupResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Event Hub Consumer Group resource." + } + ], + "options": { + "typeName": "AddConsumerGroupOptions", + "fields": [ + { + "name": "GroupName", + "jsonName": "groupName", + "type": "*string", + "description": "The name of the Consumer Group. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureEventHubConsumerGroupResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Event Hub resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureEventHubResource)) AzureEventHubResource", + "receiver": "AzureEventHubResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureEventHubResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureEventHubResource)", + "description": "A method that can be used for customizing the `AzureEventHubResource`." + } + ], + "returnType": "AzureEventHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubResource" + ], + "appliesTo": [ + "AzureEventHubResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureEventHubsEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureEventHubsEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithConfigurationFile", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withConfigurationFile", + "qualifiedName": "withConfigurationFile", + "description": "Adds a bind mount for the configuration file of an Azure Event Hubs emulator resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithConfigurationFile(path string) AzureEventHubsEmulatorResource", + "receiver": "AzureEventHubsEmulatorResource", + "parameters": [ + { + "name": "path", + "type": "string", + "description": "Path to the file on the AppHost where the emulator configuration is located." + } + ], + "returnType": "AzureEventHubsEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsEmulatorResource" + ], + "appliesTo": [ + "AzureEventHubsEmulatorResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port for the Azure Event Hubs emulator is exposed on instead of using randomly assigned port.", + "returns": "Azure Event Hubs emulator resource builder.", + "kind": "Method", + "signature": "WithHostPort(port *float64) AzureEventHubsEmulatorResource", + "receiver": "AzureEventHubsEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "The port to bind on the host. If `null` is used, a random port will be assigned." + } + ], + "returnType": "AzureEventHubsEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsEmulatorResource" + ], + "appliesTo": [ + "AzureEventHubsEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureEventHubsResource", + "fullName": "Aspire.Hosting.Azure.AzureEventHubsResource", + "kind": "handle", + "description": "Represents an Azure Event Hubs resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddHub", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/addHub", + "qualifiedName": "addHub", + "description": "Adds an Azure Event Hubs hub resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddHub(name string, options ...*AddHubOptions) AzureEventHubResource", + "receiver": "AzureEventHubsResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Event Hub resource." + } + ], + "options": { + "typeName": "AddHubOptions", + "fields": [ + { + "name": "HubName", + "jsonName": "hubName", + "type": "*string", + "description": "The name of the Event Hub. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureEventHubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsResource" + ], + "appliesTo": [ + "AzureEventHubsResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.EventHubs/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Event Hubs resource to run with the local emulator", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureEventHubsResource", + "receiver": "AzureEventHubsResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureEventHubsEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureEventHubsEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureEventHubsResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.EventHubs/Aspire.Hosting.Azure.AzureEventHubsResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureEventHubsResource" + ], + "appliesTo": [ + "AzureEventHubsResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureQueueStorageQueueResource", + "fullName": "Aspire.Hosting.Azure.AzureQueueStorageQueueResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureQueueStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureQueueStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureTableStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureTableStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureEventHubsRole", + "fullName": "Aspire.Hosting.AzureEventHubsRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure Event Hubs roles.", + "members": [ + { + "name": "AzureEventHubsRoleAzureEventHubsDataOwner", + "value": "AzureEventHubsDataOwner" + }, + { + "name": "AzureEventHubsRoleAzureEventHubsDataReceiver", + "value": "AzureEventHubsDataReceiver" + }, + { + "name": "AzureEventHubsRoleAzureEventHubsDataSender", + "value": "AzureEventHubsDataSender" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.FrontDoor.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.FrontDoor.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..5717cb224e --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.FrontDoor.13.6.0-preview.1.26478.8.json @@ -0,0 +1,113 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.FrontDoor", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureFrontDoor", + "capabilityId": "Aspire.Hosting.Azure.FrontDoor/addAzureFrontDoor", + "qualifiedName": "addAzureFrontDoor", + "description": "Adds an Azure Front Door resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureFrontDoor(name string) AzureFrontDoorResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureFrontDoorResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithOrigin", + "capabilityId": "Aspire.Hosting.Azure.FrontDoor/withOrigin", + "qualifiedName": "withOrigin", + "description": "Adds an origin (backend) to the Azure Front Door resource. Each origin gets its own Front Door endpoint with a distinct `*.azurefd.net` hostname, its own origin group, and a default route.", + "remarks": "Add multiple origins (each gets its own Front Door endpoint):\n```\nvar frontDoor = builder.AddAzureFrontDoor(\"frontdoor\")\n.WithOrigin(api)\n.WithOrigin(web);\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithOrigin(resource IComputeResource) AzureFrontDoorResource", + "receiver": "AzureFrontDoorResource", + "parameters": [ + { + "name": "resource", + "type": "IComputeResource", + "description": "The resource to add as an origin (e.g., a project, container, or other compute resource with endpoints)." + } + ], + "returnType": "AzureFrontDoorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.FrontDoor/Aspire.Hosting.Azure.AzureFrontDoorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureFrontDoorResource" + ], + "appliesTo": [ + "AzureFrontDoorResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureFrontDoorResource", + "fullName": "Aspire.Hosting.Azure.AzureFrontDoorResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithOrigin", + "capabilityId": "Aspire.Hosting.Azure.FrontDoor/withOrigin", + "qualifiedName": "withOrigin", + "description": "Adds an origin (backend) to the Azure Front Door resource. Each origin gets its own Front Door endpoint with a distinct `*.azurefd.net` hostname, its own origin group, and a default route.", + "remarks": "Add multiple origins (each gets its own Front Door endpoint):\n```\nvar frontDoor = builder.AddAzureFrontDoor(\"frontdoor\")\n.WithOrigin(api)\n.WithOrigin(web);\n```", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithOrigin(resource IComputeResource) AzureFrontDoorResource", + "receiver": "AzureFrontDoorResource", + "parameters": [ + { + "name": "resource", + "type": "IComputeResource", + "description": "The resource to add as an origin (e.g., a project, container, or other compute resource with endpoints)." + } + ], + "returnType": "AzureFrontDoorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.FrontDoor/Aspire.Hosting.Azure.AzureFrontDoorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureFrontDoorResource" + ], + "appliesTo": [ + "AzureFrontDoorResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Functions.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Functions.13.6.0.json new file mode 100644 index 0000000000..d093d771d0 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Functions.13.6.0.json @@ -0,0 +1,520 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Functions", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure.DurableTask/DurableTaskHubResource.connectionStringExpression", + "qualifiedName": "DurableTaskHubResource.connectionStringExpression", + "description": "Gets the connection string expression composed of the scheduler connection string and the TaskHub name.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "DurableTaskHubResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource" + ], + "appliesTo": [ + "DurableTaskHubResource" + ] + }, + { + "name": "TaskHubName", + "capabilityId": "Aspire.Hosting.Azure.DurableTask/DurableTaskHubResource.taskHubName", + "qualifiedName": "DurableTaskHubResource.taskHubName", + "description": "Gets the name of the Task Hub. If not provided, the logical name of this resource is returned.", + "kind": "PropertyGetter", + "signature": "TaskHubName() *ReferenceExpression", + "receiver": "DurableTaskHubResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource" + ], + "appliesTo": [ + "DurableTaskHubResource" + ] + }, + { + "name": "AddAzureFunctionsProject", + "capabilityId": "Aspire.Hosting.Azure.Functions/addAzureFunctionsProject", + "qualifiedName": "addAzureFunctionsProject", + "description": "Adds an Azure Functions project to the distributed application.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureFunctionsProject(name string, projectPath string) AzureFunctionsProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name to be associated with the Azure Functions project. This name will be used for service discovery when referenced in a dependency." + }, + { + "name": "projectPath", + "type": "string", + "description": "The path to the Azure Functions project file." + } + ], + "returnType": "AzureFunctionsProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDurableTaskScheduler", + "capabilityId": "Aspire.Hosting.Azure.Functions/addDurableTaskScheduler", + "qualifiedName": "addDurableTaskScheduler", + "description": "Adds a Durable Task scheduler resource to the distributed application.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDurableTaskScheduler(name string) DurableTaskSchedulerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The logical name of the scheduler resource." + } + ], + "returnType": "DurableTaskSchedulerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddTaskHub", + "capabilityId": "Aspire.Hosting.Azure.Functions/addTaskHub", + "qualifiedName": "addTaskHub", + "description": "Adds a Durable Task hub resource associated with the specified scheduler.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddTaskHub(name string) DurableTaskHubResource", + "receiver": "DurableTaskSchedulerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The logical name of the task hub resource." + } + ], + "returnType": "DurableTaskHubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource" + ], + "appliesTo": [ + "DurableTaskSchedulerResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.Functions/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Durable Task scheduler to run using the local emulator (only in non-publish modes).", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) DurableTaskSchedulerResource", + "receiver": "DurableTaskSchedulerResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj DurableTaskSchedulerEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj DurableTaskSchedulerEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "DurableTaskSchedulerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource" + ], + "appliesTo": [ + "DurableTaskSchedulerResource" + ] + }, + { + "name": "RunAsExisting", + "capabilityId": "Aspire.Hosting.Azure.Functions/runAsExisting", + "qualifiedName": "runAsExisting", + "description": "Configures the Durable Task scheduler to use an existing scheduler instance from a connection string or parameter resource.", + "kind": "Method", + "signature": "RunAsExisting(connectionString any) DurableTaskSchedulerResource", + "receiver": "DurableTaskSchedulerResource", + "parameters": [ + { + "name": "connectionString", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "DurableTaskSchedulerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource" + ], + "appliesTo": [ + "DurableTaskSchedulerResource" + ] + }, + { + "name": "WithHostStorage", + "capabilityId": "Aspire.Hosting.Azure.Functions/withHostStorage", + "qualifiedName": "withHostStorage", + "description": "Configures the Azure Functions project resource to use the specified Azure Storage resource as its host storage.", + "returns": "The resource builder for the Azure Functions project resource, configured with the specified host storage.", + "kind": "Method", + "signature": "WithHostStorage(storage AzureStorageResource) AzureFunctionsProjectResource", + "receiver": "AzureFunctionsProjectResource", + "parameters": [ + { + "name": "storage", + "type": "AzureStorageResource", + "description": "The resource builder for the Azure Storage resource to be used as host storage." + } + ], + "returnType": "AzureFunctionsProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.AzureFunctionsProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureFunctionsProjectResource" + ], + "appliesTo": [ + "AzureFunctionsProjectResource" + ] + }, + { + "name": "WithTaskHubName", + "capabilityId": "Aspire.Hosting.Azure.Functions/withTaskHubName", + "qualifiedName": "withTaskHubName", + "description": "Sets the Durable Task hub name from a string or parameter resource.", + "kind": "Method", + "signature": "WithTaskHubName(taskHubName any) DurableTaskHubResource", + "receiver": "DurableTaskHubResource", + "parameters": [ + { + "name": "taskHubName", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "DurableTaskHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource" + ], + "appliesTo": [ + "DurableTaskHubResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureFunctionsProjectResource", + "fullName": "Aspire.Hosting.Azure.AzureFunctionsProjectResource", + "kind": "handle", + "implementedInterfaces": [ + "DotnetProgramResource", + "IComputeResource", + "IContainerFilesDestinationResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithHostStorage", + "capabilityId": "Aspire.Hosting.Azure.Functions/withHostStorage", + "qualifiedName": "withHostStorage", + "description": "Configures the Azure Functions project resource to use the specified Azure Storage resource as its host storage.", + "returns": "The resource builder for the Azure Functions project resource, configured with the specified host storage.", + "kind": "Method", + "signature": "WithHostStorage(storage AzureStorageResource) AzureFunctionsProjectResource", + "receiver": "AzureFunctionsProjectResource", + "parameters": [ + { + "name": "storage", + "type": "AzureStorageResource", + "description": "The resource builder for the Azure Storage resource to be used as host storage." + } + ], + "returnType": "AzureFunctionsProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.AzureFunctionsProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureFunctionsProjectResource" + ], + "appliesTo": [ + "AzureFunctionsProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "DurableTaskHubResource", + "fullName": "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "kind": "handle", + "description": "Represents a Durable Task hub resource. A Task Hub groups durable orchestrations and activities. This resource extends the scheduler connection string with the TaskHub name so that clients can connect to the correct hub.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure.DurableTask/DurableTaskHubResource.connectionStringExpression", + "qualifiedName": "DurableTaskHubResource.connectionStringExpression", + "description": "Gets the connection string expression composed of the scheduler connection string and the TaskHub name.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "DurableTaskHubResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource" + ], + "appliesTo": [ + "DurableTaskHubResource" + ] + }, + { + "name": "TaskHubName", + "capabilityId": "Aspire.Hosting.Azure.DurableTask/DurableTaskHubResource.taskHubName", + "qualifiedName": "DurableTaskHubResource.taskHubName", + "description": "Gets the name of the Task Hub. If not provided, the logical name of this resource is returned.", + "kind": "PropertyGetter", + "signature": "TaskHubName() *ReferenceExpression", + "receiver": "DurableTaskHubResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource" + ], + "appliesTo": [ + "DurableTaskHubResource" + ] + }, + { + "name": "WithTaskHubName", + "capabilityId": "Aspire.Hosting.Azure.Functions/withTaskHubName", + "qualifiedName": "withTaskHubName", + "description": "Sets the Durable Task hub name from a string or parameter resource.", + "kind": "Method", + "signature": "WithTaskHubName(taskHubName any) DurableTaskHubResource", + "receiver": "DurableTaskHubResource", + "parameters": [ + { + "name": "taskHubName", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "DurableTaskHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskHubResource" + ], + "appliesTo": [ + "DurableTaskHubResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DurableTaskSchedulerEmulatorResource", + "fullName": "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "DurableTaskSchedulerResource", + "fullName": "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddTaskHub", + "capabilityId": "Aspire.Hosting.Azure.Functions/addTaskHub", + "qualifiedName": "addTaskHub", + "description": "Adds a Durable Task hub resource associated with the specified scheduler.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddTaskHub(name string) DurableTaskHubResource", + "receiver": "DurableTaskSchedulerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The logical name of the task hub resource." + } + ], + "returnType": "DurableTaskHubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource" + ], + "appliesTo": [ + "DurableTaskSchedulerResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.Functions/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Durable Task scheduler to run using the local emulator (only in non-publish modes).", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) DurableTaskSchedulerResource", + "receiver": "DurableTaskSchedulerResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj DurableTaskSchedulerEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj DurableTaskSchedulerEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "DurableTaskSchedulerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource" + ], + "appliesTo": [ + "DurableTaskSchedulerResource" + ] + }, + { + "name": "RunAsExisting", + "capabilityId": "Aspire.Hosting.Azure.Functions/runAsExisting", + "qualifiedName": "runAsExisting", + "description": "Configures the Durable Task scheduler to use an existing scheduler instance from a connection string or parameter resource.", + "kind": "Method", + "signature": "RunAsExisting(connectionString any) DurableTaskSchedulerResource", + "receiver": "DurableTaskSchedulerResource", + "parameters": [ + { + "name": "connectionString", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "returnType": "DurableTaskSchedulerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Functions/Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.DurableTask.DurableTaskSchedulerResource" + ], + "appliesTo": [ + "DurableTaskSchedulerResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.KeyVault.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.KeyVault.13.6.0.json new file mode 100644 index 0000000000..936b808d09 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.KeyVault.13.6.0.json @@ -0,0 +1,371 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.KeyVault", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureKeyVault", + "capabilityId": "Aspire.Hosting.Azure.KeyVault/addAzureKeyVault", + "qualifiedName": "addAzureKeyVault", + "description": "Adds an Azure Key Vault resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureKeyVault(name string) AzureKeyVaultResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureKeyVaultResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddSecret", + "capabilityId": "Aspire.Hosting.Azure.KeyVault/addSecret", + "qualifiedName": "addSecret", + "description": "Adds a secret to the Azure Key Vault", + "kind": "Method", + "signature": "AddSecret(name string, value any, options ...*AddSecretOptions) AzureKeyVaultSecretResource", + "receiver": "AzureKeyVaultResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "ParameterResource", + "*ReferenceExpression" + ] + } + ], + "options": { + "typeName": "AddSecretOptions", + "fields": [ + { + "name": "SecretName", + "jsonName": "secretName", + "type": "*string" + } + ] + }, + "returnType": "AzureKeyVaultSecretResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.KeyVault/Aspire.Hosting.Azure.AzureKeyVaultResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKeyVaultResource" + ], + "appliesTo": [ + "AzureKeyVaultResource" + ] + }, + { + "name": "GetSecret", + "capabilityId": "Aspire.Hosting.Azure.KeyVault/getSecret", + "qualifiedName": "getSecret", + "description": "Gets a secret reference for the specified secret name from the Azure Key Vault resource.", + "returns": "A reference to the secret.", + "kind": "Method", + "signature": "GetSecret(secretName string) AzureKeyVaultSecretReference", + "receiver": "AzureKeyVaultResource", + "parameters": [ + { + "name": "secretName", + "type": "string", + "description": "The name of the secret." + } + ], + "returnType": "AzureKeyVaultSecretReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.KeyVault/Aspire.Hosting.Azure.AzureKeyVaultResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKeyVaultResource" + ], + "appliesTo": [ + "AzureKeyVaultResource" + ] + }, + { + "name": "WithKeyVaultRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.KeyVault/withKeyVaultRoleAssignments", + "qualifiedName": "withKeyVaultRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Key Vault resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithKeyVaultRoleAssignments(target AzureKeyVaultResource, roles []AzureKeyVaultRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureKeyVaultResource", + "description": "The target Azure Key Vault resource." + }, + { + "name": "roles", + "type": "[]AzureKeyVaultRole", + "description": "The Key Vault roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureKeyVaultResource", + "Aspire.Hosting.Azure.AzureKeyVaultSecretResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureKeyVaultResource", + "AzureKeyVaultSecretResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultResource", + "fullName": "Aspire.Hosting.Azure.AzureKeyVaultResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddSecret", + "capabilityId": "Aspire.Hosting.Azure.KeyVault/addSecret", + "qualifiedName": "addSecret", + "description": "Adds a secret to the Azure Key Vault", + "kind": "Method", + "signature": "AddSecret(name string, value any, options ...*AddSecretOptions) AzureKeyVaultSecretResource", + "receiver": "AzureKeyVaultResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "value", + "type": "any", + "allowedTypes": [ + "ParameterResource", + "*ReferenceExpression" + ] + } + ], + "options": { + "typeName": "AddSecretOptions", + "fields": [ + { + "name": "SecretName", + "jsonName": "secretName", + "type": "*string" + } + ] + }, + "returnType": "AzureKeyVaultSecretResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.KeyVault/Aspire.Hosting.Azure.AzureKeyVaultResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKeyVaultResource" + ], + "appliesTo": [ + "AzureKeyVaultResource" + ] + }, + { + "name": "GetSecret", + "capabilityId": "Aspire.Hosting.Azure.KeyVault/getSecret", + "qualifiedName": "getSecret", + "description": "Gets a secret reference for the specified secret name from the Azure Key Vault resource.", + "returns": "A reference to the secret.", + "kind": "Method", + "signature": "GetSecret(secretName string) AzureKeyVaultSecretReference", + "receiver": "AzureKeyVaultResource", + "parameters": [ + { + "name": "secretName", + "type": "string", + "description": "The name of the secret." + } + ], + "returnType": "AzureKeyVaultSecretReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.KeyVault/Aspire.Hosting.Azure.AzureKeyVaultResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKeyVaultResource" + ], + "appliesTo": [ + "AzureKeyVaultResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultSecretResource", + "fullName": "Aspire.Hosting.Azure.AzureKeyVaultSecretResource", + "kind": "handle", + "implementedInterfaces": [ + "AzureKeyVaultSecretReference", + "ExpressionValue", + "Resource", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultSecretReference", + "fullName": "Aspire.Hosting.Azure.IAzureKeyVaultSecretReference", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureKeyVaultRole", + "fullName": "Aspire.Hosting.AzureKeyVaultRole", + "kind": "enum", + "description": "Represents ATS-compatible Key Vault roles.", + "members": [ + { + "name": "AzureKeyVaultRoleKeyVaultAdministrator", + "value": "KeyVaultAdministrator" + }, + { + "name": "AzureKeyVaultRoleKeyVaultCertificateUser", + "value": "KeyVaultCertificateUser" + }, + { + "name": "AzureKeyVaultRoleKeyVaultCertificatesOfficer", + "value": "KeyVaultCertificatesOfficer" + }, + { + "name": "AzureKeyVaultRoleKeyVaultContributor", + "value": "KeyVaultContributor" + }, + { + "name": "AzureKeyVaultRoleKeyVaultCryptoOfficer", + "value": "KeyVaultCryptoOfficer" + }, + { + "name": "AzureKeyVaultRoleKeyVaultCryptoServiceEncryptionUser", + "value": "KeyVaultCryptoServiceEncryptionUser" + }, + { + "name": "AzureKeyVaultRoleKeyVaultCryptoServiceReleaseUser", + "value": "KeyVaultCryptoServiceReleaseUser" + }, + { + "name": "AzureKeyVaultRoleKeyVaultCryptoUser", + "value": "KeyVaultCryptoUser" + }, + { + "name": "AzureKeyVaultRoleKeyVaultDataAccessAdministrator", + "value": "KeyVaultDataAccessAdministrator" + }, + { + "name": "AzureKeyVaultRoleKeyVaultReader", + "value": "KeyVaultReader" + }, + { + "name": "AzureKeyVaultRoleKeyVaultSecretsOfficer", + "value": "KeyVaultSecretsOfficer" + }, + { + "name": "AzureKeyVaultRoleKeyVaultSecretsUser", + "value": "KeyVaultSecretsUser" + }, + { + "name": "AzureKeyVaultRoleManagedHsmContributor", + "value": "ManagedHsmContributor" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Kubernetes.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Kubernetes.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..3443f48d61 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Kubernetes.13.6.0-preview.1.26478.8.json @@ -0,0 +1,8472 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Kubernetes", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureKubernetesEnvironment", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addAzureKubernetesEnvironment", + "qualifiedName": "addAzureKubernetesEnvironment", + "description": "Adds an Azure Kubernetes Service (AKS) environment to the distributed application. This provisions an AKS cluster and configures it as a Kubernetes compute environment.", + "remarks": "This method internally creates a Kubernetes environment for Helm-based deployment\nand provisions an AKS cluster via Azure Bicep. It combines the functionality of\n`AddKubernetesEnvironment` with Azure-specific provisioning.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureKubernetesEnvironment(name string) AzureKubernetesEnvironmentResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the AKS environment resource." + } + ], + "returnType": "AzureKubernetesEnvironmentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddCertManager", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addCertManager", + "qualifiedName": "addCertManager", + "description": "Installs cert-manager into an AKS environment", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddCertManager(name string, options ...*AddCertManagerOptions) CertManagerResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the cert-manager installation." + } + ], + "options": { + "typeName": "AddCertManagerOptions", + "fields": [ + { + "name": "ChartVersion", + "jsonName": "chartVersion", + "type": "*string", + "description": "The cert-manager Helm chart version to install. Defaults to a pinned version validated against this Aspire build." + } + ] + }, + "returnType": "CertManagerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddGateway", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addGateway", + "qualifiedName": "addGateway", + "description": "Adds a Kubernetes Gateway API Gateway resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddGateway(name string) KubernetesGatewayResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the gateway resource." + } + ], + "returnType": "KubernetesGatewayResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddHelmChart", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addHelmChart", + "qualifiedName": "addHelmChart", + "description": "Adds an external Helm chart to be installed in the AKS environment's inner Kubernetes environment. The chart is installed via `helm upgrade --install` as a pipeline step after the main application Helm chart is deployed.", + "remarks": "This method delegates to the inner `KubernetesEnvironmentResource` of the AKS\nenvironment, so the returned `KubernetesHelmChartResource` can be configured\nwith the same `WithHelmValue`,\n`WithNamespace`,\n`WithReleaseName`, and\n`WithDestroy` extensions used with\nnon-AKS Kubernetes environments.\nExternal Helm charts are not uninstalled by `aspire destroy` by default,\nbecause they may be shared with workloads outside the Aspire app. Opt in by chaining\n`WithDestroy`.", + "returns": "A resource builder for the Helm chart resource.", + "kind": "Method", + "signature": "AddHelmChart(name string, chartReference string, chartVersion string) KubernetesHelmChartResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Helm chart resource." + }, + { + "name": "chartReference", + "type": "string", + "description": "The Helm chart reference. Can be an OCI registry URL (e.g., `oci://quay.io/jetstack/charts/cert-manager`) or a chart name from an added repository." + }, + { + "name": "chartVersion", + "type": "string", + "description": "The chart version to install." + } + ], + "returnType": "KubernetesHelmChartResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddIngress", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addIngress", + "qualifiedName": "addIngress", + "description": "Adds a Kubernetes Ingress resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment. The ingress generates a `networking.k8s.io/v1 Ingress` resource in the Helm chart output at publish time.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddIngress(name string) KubernetesIngressResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the ingress resource." + } + ], + "returnType": "KubernetesIngressResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddLoadBalancer", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addLoadBalancer", + "qualifiedName": "addLoadBalancer", + "description": "Adds an Azure Application Gateway for Containers (AGC) `ApplicationLoadBalancer` to this AKS environment, bound to the supplied delegated subnet. Returns a resource builder that can be passed to `gateway.WithLoadBalancer(lb)` / `ingress.WithLoadBalancer(lb)` to route traffic through this load balancer.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddLoadBalancer(name string, subnet AzureSubnetResource) AzureKubernetesLoadBalancerResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the load balancer resource. Used to derive the in-cluster `ApplicationLoadBalancer` name (`alb-{name}`) referenced by gateway/ingress annotations." + }, + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "A subnet that will be associated with the AGC ALB. The subnet is automatically delegated to `Microsoft.ServiceNetworking/trafficControllers`; this is required by AGC and is idempotent across multiple `AddLoadBalancer` calls against the same subnet." + } + ], + "returnType": "AzureKubernetesLoadBalancerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddNodePool", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addNodePool", + "qualifiedName": "addNodePool", + "description": "Adds a node pool to the AKS cluster.", + "remarks": "The returned node pool resource can be passed to\n`WithNodePool``1` on compute resources to schedule workloads on this pool.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddNodePool(name string, options ...*AddNodePoolOptions) AksNodePoolResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the node pool." + } + ], + "options": { + "typeName": "AddNodePoolOptions", + "fields": [ + { + "name": "VmSize", + "jsonName": "vmSize", + "type": "*string", + "description": "The VM size for nodes. Defaults to `Standard_D2s_v5` if not specified." + }, + { + "name": "MinCount", + "jsonName": "minCount", + "type": "*float64", + "description": "The minimum node count for autoscaling. Defaults to 1." + }, + { + "name": "MaxCount", + "jsonName": "maxCount", + "type": "*float64", + "description": "The maximum node count for autoscaling. Defaults to 3." + } + ] + }, + "returnType": "AksNodePoolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddPersistentVolume", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addPersistentVolume", + "qualifiedName": "addPersistentVolume", + "description": "Adds a Kubernetes PersistentVolumeClaim resource to an AKS environment", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPersistentVolume(name string) KubernetesPersistentVolumeResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the persistent volume resource." + } + ], + "returnType": "KubernetesPersistentVolumeResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithContainerRegistry", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withContainerRegistry", + "qualifiedName": "withContainerRegistry", + "description": "Configures the AKS environment to use a specific Azure Container Registry for image storage. When set, this replaces the auto-created default container registry.", + "remarks": "If not called, a default Azure Container Registry is automatically created.\nThe registry endpoint is flowed to the inner Kubernetes environment so that\nHelm deployments can push and pull images.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerRegistry(registry AzureContainerRegistryResource) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "registry", + "type": "AzureContainerRegistryResource", + "description": "The Azure Container Registry resource builder." + } + ], + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithLoadBalancer", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withLoadBalancer", + "qualifiedName": "withLoadBalancer", + "description": "Routes a Kubernetes Gateway through an AGC ApplicationLoadBalancer", + "remarks": "Writes the AGC routing annotations (`alb.networking.azure.io/alb-name` and\n`alb.networking.azure.io/alb-namespace`) onto the rendered Gateway and defaults\nthe GatewayClass to `azure-alb-external` when one has not already been set via\n`WithGatewayClass(...)`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLoadBalancer(loadBalancer AzureKubernetesLoadBalancerResource) KubernetesGatewayResource", + "receiver": "KubernetesGatewayResource", + "parameters": [ + { + "name": "loadBalancer", + "type": "AzureKubernetesLoadBalancerResource", + "description": "The AGC load balancer to route through." + } + ], + "returnType": "KubernetesGatewayResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Kubernetes/Aspire.Hosting.Kubernetes.KubernetesGatewayResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Kubernetes.KubernetesGatewayResource" + ], + "appliesTo": [ + "KubernetesGatewayResource" + ] + }, + { + "name": "WithLoadBalancer", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withLoadBalancerOnIngress", + "qualifiedName": "withLoadBalancer", + "description": "Routes a Kubernetes Ingress through an AGC ApplicationLoadBalancer", + "remarks": "Writes the AGC routing annotations (`alb.networking.azure.io/alb-name` and\n`alb.networking.azure.io/alb-namespace`) onto the rendered Ingress and defaults\nthe IngressClass to `azure-alb-external` when one has not already been set via\n`WithIngressClass(...)`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLoadBalancer(loadBalancer AzureKubernetesLoadBalancerResource) KubernetesIngressResource", + "receiver": "KubernetesIngressResource", + "parameters": [ + { + "name": "loadBalancer", + "type": "AzureKubernetesLoadBalancerResource", + "description": "The AGC load balancer to route through." + } + ], + "returnType": "KubernetesIngressResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Kubernetes/Aspire.Hosting.Kubernetes.KubernetesIngressResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Kubernetes.KubernetesIngressResource" + ], + "appliesTo": [ + "KubernetesIngressResource" + ] + }, + { + "name": "WithSubnet", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withNodePoolSubnet", + "qualifiedName": "withSubnet", + "description": "Configures an AKS node pool to use a specific VNet subnet", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSubnet(subnet AzureSubnetResource) AksNodePoolResource", + "receiver": "AksNodePoolResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to use for this node pool." + } + ], + "returnType": "AksNodePoolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AksNodePoolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AksNodePoolResource" + ], + "appliesTo": [ + "AksNodePoolResource" + ] + }, + { + "name": "WithSubnet", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withSubnet", + "qualifiedName": "withSubnet", + "description": "Configures the AKS cluster to use a VNet subnet", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSubnet(subnet AzureSubnetResource) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to use for AKS node pools." + } + ], + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithSystemNodePool", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withSystemNodePool", + "qualifiedName": "withSystemNodePool", + "description": "Replaces the default system node pool with a customized configuration.", + "remarks": "Every AKS cluster requires exactly one system node pool for hosting system pods.\nBy default, the system pool uses `Standard_D2s_v5`. Use this method to change\nthe VM size when the default SKU is not available in your subscription or region.\nCalling this method multiple times replaces the previous system pool configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSystemNodePool(options ...*WithSystemNodePoolOptions) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithSystemNodePoolOptions", + "fields": [ + { + "name": "VmSize", + "jsonName": "vmSize", + "type": "*string", + "description": "The VM size for system pool nodes. Defaults to `Standard_D2s_v5` if not specified." + }, + { + "name": "MinCount", + "jsonName": "minCount", + "type": "*float64", + "description": "The minimum node count for autoscaling. Defaults to 1." + }, + { + "name": "MaxCount", + "jsonName": "maxCount", + "type": "*float64", + "description": "The maximum node count for autoscaling. Defaults to 3." + } + ] + }, + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithWorkloadIdentity", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withWorkloadIdentity", + "qualifiedName": "withWorkloadIdentity", + "description": "Enables or disables workload identity on the AKS environment, allowing pods to authenticate to Azure services using federated credentials.", + "remarks": "This ensures the AKS cluster is configured with OIDC issuer and workload identity enabled.\nWorkload identity is automatically wired when compute resources have an `AppIdentityAnnotation`,\nwhich is added by `WithAzureUserAssignedIdentity` or auto-created by `AzureResourcePreparer`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWorkloadIdentity(options ...*WithWorkloadIdentityOptions) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithWorkloadIdentityOptions", + "fields": [ + { + "name": "Enabled", + "jsonName": "enabled", + "type": "*bool", + "description": "`true` to enable workload identity (the default); `false` to disable it." + } + ] + }, + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureContainerRegistryResource", + "fullName": "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSubnetResource", + "fullName": "Aspire.Hosting.Azure.AzureSubnetResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AksNodePoolResource", + "fullName": "Aspire.Hosting.Azure.Kubernetes.AksNodePoolResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "WithSubnet", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withNodePoolSubnet", + "qualifiedName": "withSubnet", + "description": "Configures an AKS node pool to use a specific VNet subnet", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSubnet(subnet AzureSubnetResource) AksNodePoolResource", + "receiver": "AksNodePoolResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to use for this node pool." + } + ], + "returnType": "AksNodePoolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AksNodePoolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AksNodePoolResource" + ], + "appliesTo": [ + "AksNodePoolResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKubernetesEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [ + "ComputeEnvironmentResource", + "Resource" + ], + "capabilities": [ + { + "name": "AddCertManager", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addCertManager", + "qualifiedName": "addCertManager", + "description": "Installs cert-manager into an AKS environment", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddCertManager(name string, options ...*AddCertManagerOptions) CertManagerResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Aspire resource name for the cert-manager installation." + } + ], + "options": { + "typeName": "AddCertManagerOptions", + "fields": [ + { + "name": "ChartVersion", + "jsonName": "chartVersion", + "type": "*string", + "description": "The cert-manager Helm chart version to install. Defaults to a pinned version validated against this Aspire build." + } + ] + }, + "returnType": "CertManagerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddGateway", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addGateway", + "qualifiedName": "addGateway", + "description": "Adds a Kubernetes Gateway API Gateway resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddGateway(name string) KubernetesGatewayResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the gateway resource." + } + ], + "returnType": "KubernetesGatewayResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddHelmChart", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addHelmChart", + "qualifiedName": "addHelmChart", + "description": "Adds an external Helm chart to be installed in the AKS environment's inner Kubernetes environment. The chart is installed via `helm upgrade --install` as a pipeline step after the main application Helm chart is deployed.", + "remarks": "This method delegates to the inner `KubernetesEnvironmentResource` of the AKS\nenvironment, so the returned `KubernetesHelmChartResource` can be configured\nwith the same `WithHelmValue`,\n`WithNamespace`,\n`WithReleaseName`, and\n`WithDestroy` extensions used with\nnon-AKS Kubernetes environments.\nExternal Helm charts are not uninstalled by `aspire destroy` by default,\nbecause they may be shared with workloads outside the Aspire app. Opt in by chaining\n`WithDestroy`.", + "returns": "A resource builder for the Helm chart resource.", + "kind": "Method", + "signature": "AddHelmChart(name string, chartReference string, chartVersion string) KubernetesHelmChartResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Helm chart resource." + }, + { + "name": "chartReference", + "type": "string", + "description": "The Helm chart reference. Can be an OCI registry URL (e.g., `oci://quay.io/jetstack/charts/cert-manager`) or a chart name from an added repository." + }, + { + "name": "chartVersion", + "type": "string", + "description": "The chart version to install." + } + ], + "returnType": "KubernetesHelmChartResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddIngress", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addIngress", + "qualifiedName": "addIngress", + "description": "Adds a Kubernetes Ingress resource to the application model, associated with the inner Kubernetes environment of the specified AKS environment. The ingress generates a `networking.k8s.io/v1 Ingress` resource in the Helm chart output at publish time.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddIngress(name string) KubernetesIngressResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the ingress resource." + } + ], + "returnType": "KubernetesIngressResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddLoadBalancer", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addLoadBalancer", + "qualifiedName": "addLoadBalancer", + "description": "Adds an Azure Application Gateway for Containers (AGC) `ApplicationLoadBalancer` to this AKS environment, bound to the supplied delegated subnet. Returns a resource builder that can be passed to `gateway.WithLoadBalancer(lb)` / `ingress.WithLoadBalancer(lb)` to route traffic through this load balancer.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddLoadBalancer(name string, subnet AzureSubnetResource) AzureKubernetesLoadBalancerResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the load balancer resource. Used to derive the in-cluster `ApplicationLoadBalancer` name (`alb-{name}`) referenced by gateway/ingress annotations." + }, + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "A subnet that will be associated with the AGC ALB. The subnet is automatically delegated to `Microsoft.ServiceNetworking/trafficControllers`; this is required by AGC and is idempotent across multiple `AddLoadBalancer` calls against the same subnet." + } + ], + "returnType": "AzureKubernetesLoadBalancerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddNodePool", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addNodePool", + "qualifiedName": "addNodePool", + "description": "Adds a node pool to the AKS cluster.", + "remarks": "The returned node pool resource can be passed to\n`WithNodePool``1` on compute resources to schedule workloads on this pool.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddNodePool(name string, options ...*AddNodePoolOptions) AksNodePoolResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the node pool." + } + ], + "options": { + "typeName": "AddNodePoolOptions", + "fields": [ + { + "name": "VmSize", + "jsonName": "vmSize", + "type": "*string", + "description": "The VM size for nodes. Defaults to `Standard_D2s_v5` if not specified." + }, + { + "name": "MinCount", + "jsonName": "minCount", + "type": "*float64", + "description": "The minimum node count for autoscaling. Defaults to 1." + }, + { + "name": "MaxCount", + "jsonName": "maxCount", + "type": "*float64", + "description": "The maximum node count for autoscaling. Defaults to 3." + } + ] + }, + "returnType": "AksNodePoolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "AddPersistentVolume", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/addPersistentVolume", + "qualifiedName": "addPersistentVolume", + "description": "Adds a Kubernetes PersistentVolumeClaim resource to an AKS environment", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPersistentVolume(name string) KubernetesPersistentVolumeResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the persistent volume resource." + } + ], + "returnType": "KubernetesPersistentVolumeResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithContainerRegistry", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withContainerRegistry", + "qualifiedName": "withContainerRegistry", + "description": "Configures the AKS environment to use a specific Azure Container Registry for image storage. When set, this replaces the auto-created default container registry.", + "remarks": "If not called, a default Azure Container Registry is automatically created.\nThe registry endpoint is flowed to the inner Kubernetes environment so that\nHelm deployments can push and pull images.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithContainerRegistry(registry AzureContainerRegistryResource) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "registry", + "type": "AzureContainerRegistryResource", + "description": "The Azure Container Registry resource builder." + } + ], + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithSubnet", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withSubnet", + "qualifiedName": "withSubnet", + "description": "Configures the AKS cluster to use a VNet subnet", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSubnet(subnet AzureSubnetResource) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to use for AKS node pools." + } + ], + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithSystemNodePool", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withSystemNodePool", + "qualifiedName": "withSystemNodePool", + "description": "Replaces the default system node pool with a customized configuration.", + "remarks": "Every AKS cluster requires exactly one system node pool for hosting system pods.\nBy default, the system pool uses `Standard_D2s_v5`. Use this method to change\nthe VM size when the default SKU is not available in your subscription or region.\nCalling this method multiple times replaces the previous system pool configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSystemNodePool(options ...*WithSystemNodePoolOptions) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithSystemNodePoolOptions", + "fields": [ + { + "name": "VmSize", + "jsonName": "vmSize", + "type": "*string", + "description": "The VM size for system pool nodes. Defaults to `Standard_D2s_v5` if not specified." + }, + { + "name": "MinCount", + "jsonName": "minCount", + "type": "*float64", + "description": "The minimum node count for autoscaling. Defaults to 1." + }, + { + "name": "MaxCount", + "jsonName": "maxCount", + "type": "*float64", + "description": "The maximum node count for autoscaling. Defaults to 3." + } + ] + }, + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + }, + { + "name": "WithWorkloadIdentity", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withWorkloadIdentity", + "qualifiedName": "withWorkloadIdentity", + "description": "Enables or disables workload identity on the AKS environment, allowing pods to authenticate to Azure services using federated credentials.", + "remarks": "This ensures the AKS cluster is configured with OIDC issuer and workload identity enabled.\nWorkload identity is automatically wired when compute resources have an `AppIdentityAnnotation`,\nwhich is added by `WithAzureUserAssignedIdentity` or auto-created by `AzureResourcePreparer`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWorkloadIdentity(options ...*WithWorkloadIdentityOptions) AzureKubernetesEnvironmentResource", + "receiver": "AzureKubernetesEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithWorkloadIdentityOptions", + "fields": [ + { + "name": "Enabled", + "jsonName": "enabled", + "type": "*bool", + "description": "`true` to enable workload identity (the default); `false` to disable it." + } + ] + }, + "returnType": "AzureKubernetesEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kubernetes/Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesEnvironmentResource" + ], + "appliesTo": [ + "AzureKubernetesEnvironmentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKubernetesLoadBalancerResource", + "fullName": "Aspire.Hosting.Azure.Kubernetes.AzureKubernetesLoadBalancerResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "CertManagerResource", + "fullName": "Aspire.Hosting.Kubernetes.CertManagerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "KubernetesGatewayResource", + "fullName": "Aspire.Hosting.Kubernetes.KubernetesGatewayResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithLoadBalancer", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withLoadBalancer", + "qualifiedName": "withLoadBalancer", + "description": "Routes a Kubernetes Gateway through an AGC ApplicationLoadBalancer", + "remarks": "Writes the AGC routing annotations (`alb.networking.azure.io/alb-name` and\n`alb.networking.azure.io/alb-namespace`) onto the rendered Gateway and defaults\nthe GatewayClass to `azure-alb-external` when one has not already been set via\n`WithGatewayClass(...)`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLoadBalancer(loadBalancer AzureKubernetesLoadBalancerResource) KubernetesGatewayResource", + "receiver": "KubernetesGatewayResource", + "parameters": [ + { + "name": "loadBalancer", + "type": "AzureKubernetesLoadBalancerResource", + "description": "The AGC load balancer to route through." + } + ], + "returnType": "KubernetesGatewayResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Kubernetes/Aspire.Hosting.Kubernetes.KubernetesGatewayResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Kubernetes.KubernetesGatewayResource" + ], + "appliesTo": [ + "KubernetesGatewayResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "KubernetesHelmChartResource", + "fullName": "Aspire.Hosting.Kubernetes.KubernetesHelmChartResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "KubernetesIngressResource", + "fullName": "Aspire.Hosting.Kubernetes.KubernetesIngressResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithLoadBalancer", + "capabilityId": "Aspire.Hosting.Azure.Kubernetes/withLoadBalancerOnIngress", + "qualifiedName": "withLoadBalancer", + "description": "Routes a Kubernetes Ingress through an AGC ApplicationLoadBalancer", + "remarks": "Writes the AGC routing annotations (`alb.networking.azure.io/alb-name` and\n`alb.networking.azure.io/alb-namespace`) onto the rendered Ingress and defaults\nthe IngressClass to `azure-alb-external` when one has not already been set via\n`WithIngressClass(...)`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithLoadBalancer(loadBalancer AzureKubernetesLoadBalancerResource) KubernetesIngressResource", + "receiver": "KubernetesIngressResource", + "parameters": [ + { + "name": "loadBalancer", + "type": "AzureKubernetesLoadBalancerResource", + "description": "The AGC load balancer to route through." + } + ], + "returnType": "KubernetesIngressResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Kubernetes/Aspire.Hosting.Kubernetes.KubernetesIngressResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Kubernetes.KubernetesIngressResource" + ], + "appliesTo": [ + "KubernetesIngressResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "KubernetesPersistentVolumeResource", + "fullName": "Aspire.Hosting.Kubernetes.KubernetesPersistentVolumeResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [ + { + "name": "AksNodeVmSizes", + "fullName": "AksNodeVmSizes", + "kind": "exportedValue", + "values": [ + { + "path": "StandardAv2.StandardA2V2", + "type": "string", + "value": "\"Standard_A2_v2\"" + }, + { + "path": "StandardAv2.StandardA2mV2", + "type": "string", + "value": "\"Standard_A2m_v2\"" + }, + { + "path": "StandardAv2.StandardA4V2", + "type": "string", + "value": "\"Standard_A4_v2\"" + }, + { + "path": "StandardAv2.StandardA4mV2", + "type": "string", + "value": "\"Standard_A4m_v2\"" + }, + { + "path": "StandardAv2.StandardA8V2", + "type": "string", + "value": "\"Standard_A8_v2\"" + }, + { + "path": "StandardAv2.StandardA8mV2", + "type": "string", + "value": "\"Standard_A8m_v2\"" + }, + { + "path": "StandardBS.StandardB12ms", + "type": "string", + "value": "\"Standard_B12ms\"" + }, + { + "path": "StandardBS.StandardB16ms", + "type": "string", + "value": "\"Standard_B16ms\"" + }, + { + "path": "StandardBS.StandardB20ms", + "type": "string", + "value": "\"Standard_B20ms\"" + }, + { + "path": "StandardBS.StandardB2ms", + "type": "string", + "value": "\"Standard_B2ms\"" + }, + { + "path": "StandardBS.StandardB2s", + "type": "string", + "value": "\"Standard_B2s\"" + }, + { + "path": "StandardBS.StandardB4ms", + "type": "string", + "value": "\"Standard_B4ms\"" + }, + { + "path": "StandardBS.StandardB8ms", + "type": "string", + "value": "\"Standard_B8ms\"" + }, + { + "path": "StandardBasv2.StandardB16alsV2", + "type": "string", + "value": "\"Standard_B16als_v2\"" + }, + { + "path": "StandardBasv2.StandardB16asV2", + "type": "string", + "value": "\"Standard_B16as_v2\"" + }, + { + "path": "StandardBasv2.StandardB2alsV2", + "type": "string", + "value": "\"Standard_B2als_v2\"" + }, + { + "path": "StandardBasv2.StandardB2asV2", + "type": "string", + "value": "\"Standard_B2as_v2\"" + }, + { + "path": "StandardBasv2.StandardB32alsV2", + "type": "string", + "value": "\"Standard_B32als_v2\"" + }, + { + "path": "StandardBasv2.StandardB32asV2", + "type": "string", + "value": "\"Standard_B32as_v2\"" + }, + { + "path": "StandardBasv2.StandardB4alsV2", + "type": "string", + "value": "\"Standard_B4als_v2\"" + }, + { + "path": "StandardBasv2.StandardB4asV2", + "type": "string", + "value": "\"Standard_B4as_v2\"" + }, + { + "path": "StandardBasv2.StandardB8alsV2", + "type": "string", + "value": "\"Standard_B8als_v2\"" + }, + { + "path": "StandardBasv2.StandardB8asV2", + "type": "string", + "value": "\"Standard_B8as_v2\"" + }, + { + "path": "StandardBpsv2.StandardB16plsV2", + "type": "string", + "value": "\"Standard_B16pls_v2\"" + }, + { + "path": "StandardBpsv2.StandardB16psV2", + "type": "string", + "value": "\"Standard_B16ps_v2\"" + }, + { + "path": "StandardBpsv2.StandardB2plsV2", + "type": "string", + "value": "\"Standard_B2pls_v2\"" + }, + { + "path": "StandardBpsv2.StandardB2psV2", + "type": "string", + "value": "\"Standard_B2ps_v2\"" + }, + { + "path": "StandardBpsv2.StandardB4plsV2", + "type": "string", + "value": "\"Standard_B4pls_v2\"" + }, + { + "path": "StandardBpsv2.StandardB4psV2", + "type": "string", + "value": "\"Standard_B4ps_v2\"" + }, + { + "path": "StandardBpsv2.StandardB8plsV2", + "type": "string", + "value": "\"Standard_B8pls_v2\"" + }, + { + "path": "StandardBpsv2.StandardB8psV2", + "type": "string", + "value": "\"Standard_B8ps_v2\"" + }, + { + "path": "StandardBsv2.StandardB16lsV2", + "type": "string", + "value": "\"Standard_B16ls_v2\"" + }, + { + "path": "StandardBsv2.StandardB16sV2", + "type": "string", + "value": "\"Standard_B16s_v2\"" + }, + { + "path": "StandardBsv2.StandardB2lsV2", + "type": "string", + "value": "\"Standard_B2ls_v2\"" + }, + { + "path": "StandardBsv2.StandardB2sV2", + "type": "string", + "value": "\"Standard_B2s_v2\"" + }, + { + "path": "StandardBsv2.StandardB32lsV2", + "type": "string", + "value": "\"Standard_B32ls_v2\"" + }, + { + "path": "StandardBsv2.StandardB32sV2", + "type": "string", + "value": "\"Standard_B32s_v2\"" + }, + { + "path": "StandardBsv2.StandardB4lsV2", + "type": "string", + "value": "\"Standard_B4ls_v2\"" + }, + { + "path": "StandardBsv2.StandardB4sV2", + "type": "string", + "value": "\"Standard_B4s_v2\"" + }, + { + "path": "StandardBsv2.StandardB8lsV2", + "type": "string", + "value": "\"Standard_B8ls_v2\"" + }, + { + "path": "StandardBsv2.StandardB8sV2", + "type": "string", + "value": "\"Standard_B8s_v2\"" + }, + { + "path": "StandardD.StandardD11", + "type": "string", + "value": "\"Standard_D11\"" + }, + { + "path": "StandardD.StandardD12", + "type": "string", + "value": "\"Standard_D12\"" + }, + { + "path": "StandardD.StandardD13", + "type": "string", + "value": "\"Standard_D13\"" + }, + { + "path": "StandardD.StandardD14", + "type": "string", + "value": "\"Standard_D14\"" + }, + { + "path": "StandardD.StandardD2", + "type": "string", + "value": "\"Standard_D2\"" + }, + { + "path": "StandardD.StandardD3", + "type": "string", + "value": "\"Standard_D3\"" + }, + { + "path": "StandardD.StandardD4", + "type": "string", + "value": "\"Standard_D4\"" + }, + { + "path": "StandardDADSv5.StandardD16adsV5", + "type": "string", + "value": "\"Standard_D16ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD2adsV5", + "type": "string", + "value": "\"Standard_D2ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD32adsV5", + "type": "string", + "value": "\"Standard_D32ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD48adsV5", + "type": "string", + "value": "\"Standard_D48ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD4adsV5", + "type": "string", + "value": "\"Standard_D4ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD64adsV5", + "type": "string", + "value": "\"Standard_D64ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD8adsV5", + "type": "string", + "value": "\"Standard_D8ads_v5\"" + }, + { + "path": "StandardDADSv5.StandardD96adsV5", + "type": "string", + "value": "\"Standard_D96ads_v5\"" + }, + { + "path": "StandardDASv4.StandardD16asV4", + "type": "string", + "value": "\"Standard_D16as_v4\"" + }, + { + "path": "StandardDASv4.StandardD2asV4", + "type": "string", + "value": "\"Standard_D2as_v4\"" + }, + { + "path": "StandardDASv4.StandardD32asV4", + "type": "string", + "value": "\"Standard_D32as_v4\"" + }, + { + "path": "StandardDASv4.StandardD48asV4", + "type": "string", + "value": "\"Standard_D48as_v4\"" + }, + { + "path": "StandardDASv4.StandardD4asV4", + "type": "string", + "value": "\"Standard_D4as_v4\"" + }, + { + "path": "StandardDASv4.StandardD64asV4", + "type": "string", + "value": "\"Standard_D64as_v4\"" + }, + { + "path": "StandardDASv4.StandardD8asV4", + "type": "string", + "value": "\"Standard_D8as_v4\"" + }, + { + "path": "StandardDASv4.StandardD96asV4", + "type": "string", + "value": "\"Standard_D96as_v4\"" + }, + { + "path": "StandardDASv5.StandardD16asV5", + "type": "string", + "value": "\"Standard_D16as_v5\"" + }, + { + "path": "StandardDASv5.StandardD2asV5", + "type": "string", + "value": "\"Standard_D2as_v5\"" + }, + { + "path": "StandardDASv5.StandardD32asV5", + "type": "string", + "value": "\"Standard_D32as_v5\"" + }, + { + "path": "StandardDASv5.StandardD48asV5", + "type": "string", + "value": "\"Standard_D48as_v5\"" + }, + { + "path": "StandardDASv5.StandardD4asV5", + "type": "string", + "value": "\"Standard_D4as_v5\"" + }, + { + "path": "StandardDASv5.StandardD64asV5", + "type": "string", + "value": "\"Standard_D64as_v5\"" + }, + { + "path": "StandardDASv5.StandardD8asV5", + "type": "string", + "value": "\"Standard_D8as_v5\"" + }, + { + "path": "StandardDASv5.StandardD96asV5", + "type": "string", + "value": "\"Standard_D96as_v5\"" + }, + { + "path": "StandardDAv4.StandardD16aV4", + "type": "string", + "value": "\"Standard_D16a_v4\"" + }, + { + "path": "StandardDAv4.StandardD2aV4", + "type": "string", + "value": "\"Standard_D2a_v4\"" + }, + { + "path": "StandardDAv4.StandardD32aV4", + "type": "string", + "value": "\"Standard_D32a_v4\"" + }, + { + "path": "StandardDAv4.StandardD48aV4", + "type": "string", + "value": "\"Standard_D48a_v4\"" + }, + { + "path": "StandardDAv4.StandardD4aV4", + "type": "string", + "value": "\"Standard_D4a_v4\"" + }, + { + "path": "StandardDAv4.StandardD64aV4", + "type": "string", + "value": "\"Standard_D64a_v4\"" + }, + { + "path": "StandardDAv4.StandardD8aV4", + "type": "string", + "value": "\"Standard_D8a_v4\"" + }, + { + "path": "StandardDAv4.StandardD96aV4", + "type": "string", + "value": "\"Standard_D96a_v4\"" + }, + { + "path": "StandardDCACCV5.StandardDC16asCcV5", + "type": "string", + "value": "\"Standard_DC16as_cc_v5\"" + }, + { + "path": "StandardDCACCV5.StandardDC32asCcV5", + "type": "string", + "value": "\"Standard_DC32as_cc_v5\"" + }, + { + "path": "StandardDCACCV5.StandardDC48asCcV5", + "type": "string", + "value": "\"Standard_DC48as_cc_v5\"" + }, + { + "path": "StandardDCACCV5.StandardDC4asCcV5", + "type": "string", + "value": "\"Standard_DC4as_cc_v5\"" + }, + { + "path": "StandardDCACCV5.StandardDC64asCcV5", + "type": "string", + "value": "\"Standard_DC64as_cc_v5\"" + }, + { + "path": "StandardDCACCV5.StandardDC8asCcV5", + "type": "string", + "value": "\"Standard_DC8as_cc_v5\"" + }, + { + "path": "StandardDCACCV5.StandardDC96asCcV5", + "type": "string", + "value": "\"Standard_DC96as_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC16adsCcV5", + "type": "string", + "value": "\"Standard_DC16ads_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC32adsCcV5", + "type": "string", + "value": "\"Standard_DC32ads_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC48adsCcV5", + "type": "string", + "value": "\"Standard_DC48ads_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC4adsCcV5", + "type": "string", + "value": "\"Standard_DC4ads_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC64adsCcV5", + "type": "string", + "value": "\"Standard_DC64ads_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC8adsCcV5", + "type": "string", + "value": "\"Standard_DC8ads_cc_v5\"" + }, + { + "path": "StandardDCADCCV5.StandardDC96adsCcV5", + "type": "string", + "value": "\"Standard_DC96ads_cc_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC16adsV5", + "type": "string", + "value": "\"Standard_DC16ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC2adsV5", + "type": "string", + "value": "\"Standard_DC2ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC32adsV5", + "type": "string", + "value": "\"Standard_DC32ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC48adsV5", + "type": "string", + "value": "\"Standard_DC48ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC4adsV5", + "type": "string", + "value": "\"Standard_DC4ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC64adsV5", + "type": "string", + "value": "\"Standard_DC64ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC8adsV5", + "type": "string", + "value": "\"Standard_DC8ads_v5\"" + }, + { + "path": "StandardDCADSv5.StandardDC96adsV5", + "type": "string", + "value": "\"Standard_DC96ads_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC16asV5", + "type": "string", + "value": "\"Standard_DC16as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC2asV5", + "type": "string", + "value": "\"Standard_DC2as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC32asV5", + "type": "string", + "value": "\"Standard_DC32as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC48asV5", + "type": "string", + "value": "\"Standard_DC48as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC4asV5", + "type": "string", + "value": "\"Standard_DC4as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC64asV5", + "type": "string", + "value": "\"Standard_DC64as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC8asV5", + "type": "string", + "value": "\"Standard_DC8as_v5\"" + }, + { + "path": "StandardDCASv5.StandardDC96asV5", + "type": "string", + "value": "\"Standard_DC96as_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC16edsV5", + "type": "string", + "value": "\"Standard_DC16eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC2edsV5", + "type": "string", + "value": "\"Standard_DC2eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC32edsV5", + "type": "string", + "value": "\"Standard_DC32eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC48edsV5", + "type": "string", + "value": "\"Standard_DC48eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC4edsV5", + "type": "string", + "value": "\"Standard_DC4eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC64edsV5", + "type": "string", + "value": "\"Standard_DC64eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC8edsV5", + "type": "string", + "value": "\"Standard_DC8eds_v5\"" + }, + { + "path": "StandardDCEDV5.StandardDC96edsV5", + "type": "string", + "value": "\"Standard_DC96eds_v5\"" + }, + { + "path": "StandardDCEDV6.StandardDC128edsV6", + "type": "string", + "value": "\"Standard_DC128eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC16edsV6", + "type": "string", + "value": "\"Standard_DC16eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC2edsV6", + "type": "string", + "value": "\"Standard_DC2eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC32edsV6", + "type": "string", + "value": "\"Standard_DC32eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC48edsV6", + "type": "string", + "value": "\"Standard_DC48eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC4edsV6", + "type": "string", + "value": "\"Standard_DC4eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC64edsV6", + "type": "string", + "value": "\"Standard_DC64eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC8edsV6", + "type": "string", + "value": "\"Standard_DC8eds_v6\"" + }, + { + "path": "StandardDCEDV6.StandardDC96edsV6", + "type": "string", + "value": "\"Standard_DC96eds_v6\"" + }, + { + "path": "StandardDCEV5.StandardDC16esV5", + "type": "string", + "value": "\"Standard_DC16es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC2esV5", + "type": "string", + "value": "\"Standard_DC2es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC32esV5", + "type": "string", + "value": "\"Standard_DC32es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC48esV5", + "type": "string", + "value": "\"Standard_DC48es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC4esV5", + "type": "string", + "value": "\"Standard_DC4es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC64esV5", + "type": "string", + "value": "\"Standard_DC64es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC8esV5", + "type": "string", + "value": "\"Standard_DC8es_v5\"" + }, + { + "path": "StandardDCEV5.StandardDC96esV5", + "type": "string", + "value": "\"Standard_DC96es_v5\"" + }, + { + "path": "StandardDCEV6.StandardDC128esV6", + "type": "string", + "value": "\"Standard_DC128es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC16esV6", + "type": "string", + "value": "\"Standard_DC16es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC2esV6", + "type": "string", + "value": "\"Standard_DC2es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC32esV6", + "type": "string", + "value": "\"Standard_DC32es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC48esV6", + "type": "string", + "value": "\"Standard_DC48es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC4esV6", + "type": "string", + "value": "\"Standard_DC4es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC64esV6", + "type": "string", + "value": "\"Standard_DC64es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC8esV6", + "type": "string", + "value": "\"Standard_DC8es_v6\"" + }, + { + "path": "StandardDCEV6.StandardDC96esV6", + "type": "string", + "value": "\"Standard_DC96es_v6\"" + }, + { + "path": "StandardDCSv2.StandardDC2sV2", + "type": "string", + "value": "\"Standard_DC2s_v2\"" + }, + { + "path": "StandardDCSv2.StandardDC4sV2", + "type": "string", + "value": "\"Standard_DC4s_v2\"" + }, + { + "path": "StandardDCSv2.StandardDC8V2", + "type": "string", + "value": "\"Standard_DC8_v2\"" + }, + { + "path": "StandardDCSv3.StandardDC16sV3", + "type": "string", + "value": "\"Standard_DC16s_v3\"" + }, + { + "path": "StandardDCSv3.StandardDC24sV3", + "type": "string", + "value": "\"Standard_DC24s_v3\"" + }, + { + "path": "StandardDCSv3.StandardDC2sV3", + "type": "string", + "value": "\"Standard_DC2s_v3\"" + }, + { + "path": "StandardDCSv3.StandardDC32sV3", + "type": "string", + "value": "\"Standard_DC32s_v3\"" + }, + { + "path": "StandardDCSv3.StandardDC48sV3", + "type": "string", + "value": "\"Standard_DC48s_v3\"" + }, + { + "path": "StandardDCSv3.StandardDC4sV3", + "type": "string", + "value": "\"Standard_DC4s_v3\"" + }, + { + "path": "StandardDCSv3.StandardDC8sV3", + "type": "string", + "value": "\"Standard_DC8s_v3\"" + }, + { + "path": "StandardDCadsv6.StandardDC16adsV6", + "type": "string", + "value": "\"Standard_DC16ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC2adsV6", + "type": "string", + "value": "\"Standard_DC2ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC32adsV6", + "type": "string", + "value": "\"Standard_DC32ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC48adsV6", + "type": "string", + "value": "\"Standard_DC48ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC4adsV6", + "type": "string", + "value": "\"Standard_DC4ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC64adsV6", + "type": "string", + "value": "\"Standard_DC64ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC8adsV6", + "type": "string", + "value": "\"Standard_DC8ads_v6\"" + }, + { + "path": "StandardDCadsv6.StandardDC96adsV6", + "type": "string", + "value": "\"Standard_DC96ads_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC16asV6", + "type": "string", + "value": "\"Standard_DC16as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC2asV6", + "type": "string", + "value": "\"Standard_DC2as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC32asV6", + "type": "string", + "value": "\"Standard_DC32as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC48asV6", + "type": "string", + "value": "\"Standard_DC48as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC4asV6", + "type": "string", + "value": "\"Standard_DC4as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC64asV6", + "type": "string", + "value": "\"Standard_DC64as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC8asV6", + "type": "string", + "value": "\"Standard_DC8as_v6\"" + }, + { + "path": "StandardDCasv6.StandardDC96asV6", + "type": "string", + "value": "\"Standard_DC96as_v6\"" + }, + { + "path": "StandardDDCSv3.StandardDC16dsV3", + "type": "string", + "value": "\"Standard_DC16ds_v3\"" + }, + { + "path": "StandardDDCSv3.StandardDC24dsV3", + "type": "string", + "value": "\"Standard_DC24ds_v3\"" + }, + { + "path": "StandardDDCSv3.StandardDC2dsV3", + "type": "string", + "value": "\"Standard_DC2ds_v3\"" + }, + { + "path": "StandardDDCSv3.StandardDC32dsV3", + "type": "string", + "value": "\"Standard_DC32ds_v3\"" + }, + { + "path": "StandardDDCSv3.StandardDC48dsV3", + "type": "string", + "value": "\"Standard_DC48ds_v3\"" + }, + { + "path": "StandardDDCSv3.StandardDC4dsV3", + "type": "string", + "value": "\"Standard_DC4ds_v3\"" + }, + { + "path": "StandardDDCSv3.StandardDC8dsV3", + "type": "string", + "value": "\"Standard_DC8ds_v3\"" + }, + { + "path": "StandardDDSv4.StandardD16dsV4", + "type": "string", + "value": "\"Standard_D16ds_v4\"" + }, + { + "path": "StandardDDSv4.StandardD2dsV4", + "type": "string", + "value": "\"Standard_D2ds_v4\"" + }, + { + "path": "StandardDDSv4.StandardD32dsV4", + "type": "string", + "value": "\"Standard_D32ds_v4\"" + }, + { + "path": "StandardDDSv4.StandardD48dsV4", + "type": "string", + "value": "\"Standard_D48ds_v4\"" + }, + { + "path": "StandardDDSv4.StandardD4dsV4", + "type": "string", + "value": "\"Standard_D4ds_v4\"" + }, + { + "path": "StandardDDSv4.StandardD64dsV4", + "type": "string", + "value": "\"Standard_D64ds_v4\"" + }, + { + "path": "StandardDDSv4.StandardD8dsV4", + "type": "string", + "value": "\"Standard_D8ds_v4\"" + }, + { + "path": "StandardDDSv5.StandardD16dsV5", + "type": "string", + "value": "\"Standard_D16ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD2dsV5", + "type": "string", + "value": "\"Standard_D2ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD32dsV5", + "type": "string", + "value": "\"Standard_D32ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD48dsV5", + "type": "string", + "value": "\"Standard_D48ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD4dsV5", + "type": "string", + "value": "\"Standard_D4ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD64dsV5", + "type": "string", + "value": "\"Standard_D64ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD8dsV5", + "type": "string", + "value": "\"Standard_D8ds_v5\"" + }, + { + "path": "StandardDDSv5.StandardD96dsV5", + "type": "string", + "value": "\"Standard_D96ds_v5\"" + }, + { + "path": "StandardDDv4.StandardD16dV4", + "type": "string", + "value": "\"Standard_D16d_v4\"" + }, + { + "path": "StandardDDv4.StandardD2dV4", + "type": "string", + "value": "\"Standard_D2d_v4\"" + }, + { + "path": "StandardDDv4.StandardD32dV4", + "type": "string", + "value": "\"Standard_D32d_v4\"" + }, + { + "path": "StandardDDv4.StandardD48dV4", + "type": "string", + "value": "\"Standard_D48d_v4\"" + }, + { + "path": "StandardDDv4.StandardD4dV4", + "type": "string", + "value": "\"Standard_D4d_v4\"" + }, + { + "path": "StandardDDv4.StandardD64dV4", + "type": "string", + "value": "\"Standard_D64d_v4\"" + }, + { + "path": "StandardDDv4.StandardD8dV4", + "type": "string", + "value": "\"Standard_D8d_v4\"" + }, + { + "path": "StandardDDv5.StandardD16dV5", + "type": "string", + "value": "\"Standard_D16d_v5\"" + }, + { + "path": "StandardDDv5.StandardD2dV5", + "type": "string", + "value": "\"Standard_D2d_v5\"" + }, + { + "path": "StandardDDv5.StandardD32dV5", + "type": "string", + "value": "\"Standard_D32d_v5\"" + }, + { + "path": "StandardDDv5.StandardD48dV5", + "type": "string", + "value": "\"Standard_D48d_v5\"" + }, + { + "path": "StandardDDv5.StandardD4dV5", + "type": "string", + "value": "\"Standard_D4d_v5\"" + }, + { + "path": "StandardDDv5.StandardD64dV5", + "type": "string", + "value": "\"Standard_D64d_v5\"" + }, + { + "path": "StandardDDv5.StandardD8dV5", + "type": "string", + "value": "\"Standard_D8d_v5\"" + }, + { + "path": "StandardDDv5.StandardD96dV5", + "type": "string", + "value": "\"Standard_D96d_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD16ldsV5", + "type": "string", + "value": "\"Standard_D16lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD2ldsV5", + "type": "string", + "value": "\"Standard_D2lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD32ldsV5", + "type": "string", + "value": "\"Standard_D32lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD48ldsV5", + "type": "string", + "value": "\"Standard_D48lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD4ldsV5", + "type": "string", + "value": "\"Standard_D4lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD64ldsV5", + "type": "string", + "value": "\"Standard_D64lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD8ldsV5", + "type": "string", + "value": "\"Standard_D8lds_v5\"" + }, + { + "path": "StandardDLDSv5.StandardD96ldsV5", + "type": "string", + "value": "\"Standard_D96lds_v5\"" + }, + { + "path": "StandardDLSv5.StandardD16lsV5", + "type": "string", + "value": "\"Standard_D16ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD2lsV5", + "type": "string", + "value": "\"Standard_D2ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD32lsV5", + "type": "string", + "value": "\"Standard_D32ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD48lsV5", + "type": "string", + "value": "\"Standard_D48ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD4lsV5", + "type": "string", + "value": "\"Standard_D4ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD64lsV5", + "type": "string", + "value": "\"Standard_D64ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD8lsV5", + "type": "string", + "value": "\"Standard_D8ls_v5\"" + }, + { + "path": "StandardDLSv5.StandardD96lsV5", + "type": "string", + "value": "\"Standard_D96ls_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD16pdsV5", + "type": "string", + "value": "\"Standard_D16pds_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD2pdsV5", + "type": "string", + "value": "\"Standard_D2pds_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD32pdsV5", + "type": "string", + "value": "\"Standard_D32pds_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD48pdsV5", + "type": "string", + "value": "\"Standard_D48pds_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD4pdsV5", + "type": "string", + "value": "\"Standard_D4pds_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD64pdsV5", + "type": "string", + "value": "\"Standard_D64pds_v5\"" + }, + { + "path": "StandardDPDSv5.StandardD8pdsV5", + "type": "string", + "value": "\"Standard_D8pds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD16pldsV5", + "type": "string", + "value": "\"Standard_D16plds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD2pldsV5", + "type": "string", + "value": "\"Standard_D2plds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD32pldsV5", + "type": "string", + "value": "\"Standard_D32plds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD48pldsV5", + "type": "string", + "value": "\"Standard_D48plds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD4pldsV5", + "type": "string", + "value": "\"Standard_D4plds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD64pldsV5", + "type": "string", + "value": "\"Standard_D64plds_v5\"" + }, + { + "path": "StandardDPLDSv5.StandardD8pldsV5", + "type": "string", + "value": "\"Standard_D8plds_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD16plsV5", + "type": "string", + "value": "\"Standard_D16pls_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD2plsV5", + "type": "string", + "value": "\"Standard_D2pls_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD32plsV5", + "type": "string", + "value": "\"Standard_D32pls_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD48plsV5", + "type": "string", + "value": "\"Standard_D48pls_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD4plsV5", + "type": "string", + "value": "\"Standard_D4pls_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD64plsV5", + "type": "string", + "value": "\"Standard_D64pls_v5\"" + }, + { + "path": "StandardDPLSv5.StandardD8plsV5", + "type": "string", + "value": "\"Standard_D8pls_v5\"" + }, + { + "path": "StandardDPSv5.StandardD16psV5", + "type": "string", + "value": "\"Standard_D16ps_v5\"" + }, + { + "path": "StandardDPSv5.StandardD2psV5", + "type": "string", + "value": "\"Standard_D2ps_v5\"" + }, + { + "path": "StandardDPSv5.StandardD32psV5", + "type": "string", + "value": "\"Standard_D32ps_v5\"" + }, + { + "path": "StandardDPSv5.StandardD48psV5", + "type": "string", + "value": "\"Standard_D48ps_v5\"" + }, + { + "path": "StandardDPSv5.StandardD4psV5", + "type": "string", + "value": "\"Standard_D4ps_v5\"" + }, + { + "path": "StandardDPSv5.StandardD64psV5", + "type": "string", + "value": "\"Standard_D64ps_v5\"" + }, + { + "path": "StandardDPSv5.StandardD8psV5", + "type": "string", + "value": "\"Standard_D8ps_v5\"" + }, + { + "path": "StandardDS.StandardDS11", + "type": "string", + "value": "\"Standard_DS11\"" + }, + { + "path": "StandardDS.StandardDS12", + "type": "string", + "value": "\"Standard_DS12\"" + }, + { + "path": "StandardDS.StandardDS13", + "type": "string", + "value": "\"Standard_DS13\"" + }, + { + "path": "StandardDS.StandardDS14", + "type": "string", + "value": "\"Standard_DS14\"" + }, + { + "path": "StandardDS.StandardDS2", + "type": "string", + "value": "\"Standard_DS2\"" + }, + { + "path": "StandardDS.StandardDS3", + "type": "string", + "value": "\"Standard_DS3\"" + }, + { + "path": "StandardDS.StandardDS4", + "type": "string", + "value": "\"Standard_DS4\"" + }, + { + "path": "StandardDSv2.StandardDS111V2", + "type": "string", + "value": "\"Standard_DS11-1_v2\"" + }, + { + "path": "StandardDSv2.StandardDS11V2", + "type": "string", + "value": "\"Standard_DS11_v2\"" + }, + { + "path": "StandardDSv2.StandardDS121V2", + "type": "string", + "value": "\"Standard_DS12-1_v2\"" + }, + { + "path": "StandardDSv2.StandardDS122V2", + "type": "string", + "value": "\"Standard_DS12-2_v2\"" + }, + { + "path": "StandardDSv2.StandardDS12V2", + "type": "string", + "value": "\"Standard_DS12_v2\"" + }, + { + "path": "StandardDSv2.StandardDS132V2", + "type": "string", + "value": "\"Standard_DS13-2_v2\"" + }, + { + "path": "StandardDSv2.StandardDS134V2", + "type": "string", + "value": "\"Standard_DS13-4_v2\"" + }, + { + "path": "StandardDSv2.StandardDS13V2", + "type": "string", + "value": "\"Standard_DS13_v2\"" + }, + { + "path": "StandardDSv2.StandardDS144V2", + "type": "string", + "value": "\"Standard_DS14-4_v2\"" + }, + { + "path": "StandardDSv2.StandardDS148V2", + "type": "string", + "value": "\"Standard_DS14-8_v2\"" + }, + { + "path": "StandardDSv2.StandardDS14V2", + "type": "string", + "value": "\"Standard_DS14_v2\"" + }, + { + "path": "StandardDSv2.StandardDS15V2", + "type": "string", + "value": "\"Standard_DS15_v2\"" + }, + { + "path": "StandardDSv2.StandardDS2V2", + "type": "string", + "value": "\"Standard_DS2_v2\"" + }, + { + "path": "StandardDSv2.StandardDS3V2", + "type": "string", + "value": "\"Standard_DS3_v2\"" + }, + { + "path": "StandardDSv2.StandardDS4V2", + "type": "string", + "value": "\"Standard_DS4_v2\"" + }, + { + "path": "StandardDSv2.StandardDS5V2", + "type": "string", + "value": "\"Standard_DS5_v2\"" + }, + { + "path": "StandardDSv2Promo.StandardDS11V2Promo", + "type": "string", + "value": "\"Standard_DS11_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS12V2Promo", + "type": "string", + "value": "\"Standard_DS12_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS13V2Promo", + "type": "string", + "value": "\"Standard_DS13_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS14V2Promo", + "type": "string", + "value": "\"Standard_DS14_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS2V2Promo", + "type": "string", + "value": "\"Standard_DS2_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS3V2Promo", + "type": "string", + "value": "\"Standard_DS3_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS4V2Promo", + "type": "string", + "value": "\"Standard_DS4_v2_Promo\"" + }, + { + "path": "StandardDSv2Promo.StandardDS5V2Promo", + "type": "string", + "value": "\"Standard_DS5_v2_Promo\"" + }, + { + "path": "StandardDSv3.StandardD16sV3", + "type": "string", + "value": "\"Standard_D16s_v3\"" + }, + { + "path": "StandardDSv3.StandardD2sV3", + "type": "string", + "value": "\"Standard_D2s_v3\"" + }, + { + "path": "StandardDSv3.StandardD32sV3", + "type": "string", + "value": "\"Standard_D32s_v3\"" + }, + { + "path": "StandardDSv3.StandardD48sV3", + "type": "string", + "value": "\"Standard_D48s_v3\"" + }, + { + "path": "StandardDSv3.StandardD4sV3", + "type": "string", + "value": "\"Standard_D4s_v3\"" + }, + { + "path": "StandardDSv3.StandardD64sV3", + "type": "string", + "value": "\"Standard_D64s_v3\"" + }, + { + "path": "StandardDSv3.StandardD8sV3", + "type": "string", + "value": "\"Standard_D8s_v3\"" + }, + { + "path": "StandardDSv4.StandardD16sV4", + "type": "string", + "value": "\"Standard_D16s_v4\"" + }, + { + "path": "StandardDSv4.StandardD2sV4", + "type": "string", + "value": "\"Standard_D2s_v4\"" + }, + { + "path": "StandardDSv4.StandardD32sV4", + "type": "string", + "value": "\"Standard_D32s_v4\"" + }, + { + "path": "StandardDSv4.StandardD48sV4", + "type": "string", + "value": "\"Standard_D48s_v4\"" + }, + { + "path": "StandardDSv4.StandardD4sV4", + "type": "string", + "value": "\"Standard_D4s_v4\"" + }, + { + "path": "StandardDSv4.StandardD64sV4", + "type": "string", + "value": "\"Standard_D64s_v4\"" + }, + { + "path": "StandardDSv4.StandardD8sV4", + "type": "string", + "value": "\"Standard_D8s_v4\"" + }, + { + "path": "StandardDSv5.StandardD16sV5", + "type": "string", + "value": "\"Standard_D16s_v5\"" + }, + { + "path": "StandardDSv5.StandardD2sV5", + "type": "string", + "value": "\"Standard_D2s_v5\"" + }, + { + "path": "StandardDSv5.StandardD32sV5", + "type": "string", + "value": "\"Standard_D32s_v5\"" + }, + { + "path": "StandardDSv5.StandardD48sV5", + "type": "string", + "value": "\"Standard_D48s_v5\"" + }, + { + "path": "StandardDSv5.StandardD4sV5", + "type": "string", + "value": "\"Standard_D4s_v5\"" + }, + { + "path": "StandardDSv5.StandardD64sV5", + "type": "string", + "value": "\"Standard_D64s_v5\"" + }, + { + "path": "StandardDSv5.StandardD8sV5", + "type": "string", + "value": "\"Standard_D8s_v5\"" + }, + { + "path": "StandardDSv5.StandardD96sV5", + "type": "string", + "value": "\"Standard_D96s_v5\"" + }, + { + "path": "StandardDadsv7.StandardD128adsV7", + "type": "string", + "value": "\"Standard_D128ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD160adsV7", + "type": "string", + "value": "\"Standard_D160ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD16adsV7", + "type": "string", + "value": "\"Standard_D16ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD2adsV7", + "type": "string", + "value": "\"Standard_D2ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD32adsV7", + "type": "string", + "value": "\"Standard_D32ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD48adsV7", + "type": "string", + "value": "\"Standard_D48ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD4adsV7", + "type": "string", + "value": "\"Standard_D4ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD64adsV7", + "type": "string", + "value": "\"Standard_D64ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD8adsV7", + "type": "string", + "value": "\"Standard_D8ads_v7\"" + }, + { + "path": "StandardDadsv7.StandardD96adsV7", + "type": "string", + "value": "\"Standard_D96ads_v7\"" + }, + { + "path": "StandardDadv6.StandardD16adsV6", + "type": "string", + "value": "\"Standard_D16ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD2adsV6", + "type": "string", + "value": "\"Standard_D2ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD32adsV6", + "type": "string", + "value": "\"Standard_D32ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD48adsV6", + "type": "string", + "value": "\"Standard_D48ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD4adsV6", + "type": "string", + "value": "\"Standard_D4ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD64adsV6", + "type": "string", + "value": "\"Standard_D64ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD8adsV6", + "type": "string", + "value": "\"Standard_D8ads_v6\"" + }, + { + "path": "StandardDadv6.StandardD96adsV6", + "type": "string", + "value": "\"Standard_D96ads_v6\"" + }, + { + "path": "StandardDaldsv7.StandardD128aldsV7", + "type": "string", + "value": "\"Standard_D128alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD160aldsV7", + "type": "string", + "value": "\"Standard_D160alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD16aldsV7", + "type": "string", + "value": "\"Standard_D16alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD2aldsV7", + "type": "string", + "value": "\"Standard_D2alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD32aldsV7", + "type": "string", + "value": "\"Standard_D32alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD48aldsV7", + "type": "string", + "value": "\"Standard_D48alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD4aldsV7", + "type": "string", + "value": "\"Standard_D4alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD64aldsV7", + "type": "string", + "value": "\"Standard_D64alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD8aldsV7", + "type": "string", + "value": "\"Standard_D8alds_v7\"" + }, + { + "path": "StandardDaldsv7.StandardD96aldsV7", + "type": "string", + "value": "\"Standard_D96alds_v7\"" + }, + { + "path": "StandardDaldv6.StandardD16aldsV6", + "type": "string", + "value": "\"Standard_D16alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD2aldsV6", + "type": "string", + "value": "\"Standard_D2alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD32aldsV6", + "type": "string", + "value": "\"Standard_D32alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD48aldsV6", + "type": "string", + "value": "\"Standard_D48alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD4aldsV6", + "type": "string", + "value": "\"Standard_D4alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD64aldsV6", + "type": "string", + "value": "\"Standard_D64alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD8aldsV6", + "type": "string", + "value": "\"Standard_D8alds_v6\"" + }, + { + "path": "StandardDaldv6.StandardD96aldsV6", + "type": "string", + "value": "\"Standard_D96alds_v6\"" + }, + { + "path": "StandardDalsv7.StandardD128alsV7", + "type": "string", + "value": "\"Standard_D128als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD160alsV7", + "type": "string", + "value": "\"Standard_D160als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD16alsV7", + "type": "string", + "value": "\"Standard_D16als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD2alsV7", + "type": "string", + "value": "\"Standard_D2als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD32alsV7", + "type": "string", + "value": "\"Standard_D32als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD48alsV7", + "type": "string", + "value": "\"Standard_D48als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD4alsV7", + "type": "string", + "value": "\"Standard_D4als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD64alsV7", + "type": "string", + "value": "\"Standard_D64als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD8alsV7", + "type": "string", + "value": "\"Standard_D8als_v7\"" + }, + { + "path": "StandardDalsv7.StandardD96alsV7", + "type": "string", + "value": "\"Standard_D96als_v7\"" + }, + { + "path": "StandardDalv6.StandardD16alsV6", + "type": "string", + "value": "\"Standard_D16als_v6\"" + }, + { + "path": "StandardDalv6.StandardD2alsV6", + "type": "string", + "value": "\"Standard_D2als_v6\"" + }, + { + "path": "StandardDalv6.StandardD32alsV6", + "type": "string", + "value": "\"Standard_D32als_v6\"" + }, + { + "path": "StandardDalv6.StandardD48alsV6", + "type": "string", + "value": "\"Standard_D48als_v6\"" + }, + { + "path": "StandardDalv6.StandardD4alsV6", + "type": "string", + "value": "\"Standard_D4als_v6\"" + }, + { + "path": "StandardDalv6.StandardD64alsV6", + "type": "string", + "value": "\"Standard_D64als_v6\"" + }, + { + "path": "StandardDalv6.StandardD8alsV6", + "type": "string", + "value": "\"Standard_D8als_v6\"" + }, + { + "path": "StandardDalv6.StandardD96alsV6", + "type": "string", + "value": "\"Standard_D96als_v6\"" + }, + { + "path": "StandardDasv7.StandardD128asV7", + "type": "string", + "value": "\"Standard_D128as_v7\"" + }, + { + "path": "StandardDasv7.StandardD160asV7", + "type": "string", + "value": "\"Standard_D160as_v7\"" + }, + { + "path": "StandardDasv7.StandardD16asV7", + "type": "string", + "value": "\"Standard_D16as_v7\"" + }, + { + "path": "StandardDasv7.StandardD2asV7", + "type": "string", + "value": "\"Standard_D2as_v7\"" + }, + { + "path": "StandardDasv7.StandardD32asV7", + "type": "string", + "value": "\"Standard_D32as_v7\"" + }, + { + "path": "StandardDasv7.StandardD48asV7", + "type": "string", + "value": "\"Standard_D48as_v7\"" + }, + { + "path": "StandardDasv7.StandardD4asV7", + "type": "string", + "value": "\"Standard_D4as_v7\"" + }, + { + "path": "StandardDasv7.StandardD64asV7", + "type": "string", + "value": "\"Standard_D64as_v7\"" + }, + { + "path": "StandardDasv7.StandardD8asV7", + "type": "string", + "value": "\"Standard_D8as_v7\"" + }, + { + "path": "StandardDasv7.StandardD96asV7", + "type": "string", + "value": "\"Standard_D96as_v7\"" + }, + { + "path": "StandardDav6.StandardD16asV6", + "type": "string", + "value": "\"Standard_D16as_v6\"" + }, + { + "path": "StandardDav6.StandardD2asV6", + "type": "string", + "value": "\"Standard_D2as_v6\"" + }, + { + "path": "StandardDav6.StandardD32asV6", + "type": "string", + "value": "\"Standard_D32as_v6\"" + }, + { + "path": "StandardDav6.StandardD48asV6", + "type": "string", + "value": "\"Standard_D48as_v6\"" + }, + { + "path": "StandardDav6.StandardD4asV6", + "type": "string", + "value": "\"Standard_D4as_v6\"" + }, + { + "path": "StandardDav6.StandardD64asV6", + "type": "string", + "value": "\"Standard_D64as_v6\"" + }, + { + "path": "StandardDav6.StandardD8asV6", + "type": "string", + "value": "\"Standard_D8as_v6\"" + }, + { + "path": "StandardDav6.StandardD96asV6", + "type": "string", + "value": "\"Standard_D96as_v6\"" + }, + { + "path": "StandardDdsv6.StandardD128dsV6", + "type": "string", + "value": "\"Standard_D128ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD16dsV6", + "type": "string", + "value": "\"Standard_D16ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD192dsV6", + "type": "string", + "value": "\"Standard_D192ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD2dsV6", + "type": "string", + "value": "\"Standard_D2ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD32dsV6", + "type": "string", + "value": "\"Standard_D32ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD48dsV6", + "type": "string", + "value": "\"Standard_D48ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD4dsV6", + "type": "string", + "value": "\"Standard_D4ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD64dsV6", + "type": "string", + "value": "\"Standard_D64ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD8dsV6", + "type": "string", + "value": "\"Standard_D8ds_v6\"" + }, + { + "path": "StandardDdsv6.StandardD96dsV6", + "type": "string", + "value": "\"Standard_D96ds_v6\"" + }, + { + "path": "StandardDdsv7.StandardD128dsV7", + "type": "string", + "value": "\"Standard_D128ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD16dsV7", + "type": "string", + "value": "\"Standard_D16ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD192dsV7", + "type": "string", + "value": "\"Standard_D192ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD2dsV7", + "type": "string", + "value": "\"Standard_D2ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD32dsV7", + "type": "string", + "value": "\"Standard_D32ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD48dsV7", + "type": "string", + "value": "\"Standard_D48ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD4dsV7", + "type": "string", + "value": "\"Standard_D4ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD64dsV7", + "type": "string", + "value": "\"Standard_D64ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD8dsV7", + "type": "string", + "value": "\"Standard_D8ds_v7\"" + }, + { + "path": "StandardDdsv7.StandardD96dsV7", + "type": "string", + "value": "\"Standard_D96ds_v7\"" + }, + { + "path": "StandardDldsv6.StandardD128ldsV6", + "type": "string", + "value": "\"Standard_D128lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD16ldsV6", + "type": "string", + "value": "\"Standard_D16lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD2ldsV6", + "type": "string", + "value": "\"Standard_D2lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD32ldsV6", + "type": "string", + "value": "\"Standard_D32lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD48ldsV6", + "type": "string", + "value": "\"Standard_D48lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD4ldsV6", + "type": "string", + "value": "\"Standard_D4lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD64ldsV6", + "type": "string", + "value": "\"Standard_D64lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD8ldsV6", + "type": "string", + "value": "\"Standard_D8lds_v6\"" + }, + { + "path": "StandardDldsv6.StandardD96ldsV6", + "type": "string", + "value": "\"Standard_D96lds_v6\"" + }, + { + "path": "StandardDldsv7.StandardD128ldsV7", + "type": "string", + "value": "\"Standard_D128lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD16ldsV7", + "type": "string", + "value": "\"Standard_D16lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD192ldsV7", + "type": "string", + "value": "\"Standard_D192lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD2ldsV7", + "type": "string", + "value": "\"Standard_D2lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD32ldsV7", + "type": "string", + "value": "\"Standard_D32lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD48ldsV7", + "type": "string", + "value": "\"Standard_D48lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD4ldsV7", + "type": "string", + "value": "\"Standard_D4lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD64ldsV7", + "type": "string", + "value": "\"Standard_D64lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD8ldsV7", + "type": "string", + "value": "\"Standard_D8lds_v7\"" + }, + { + "path": "StandardDldsv7.StandardD96ldsV7", + "type": "string", + "value": "\"Standard_D96lds_v7\"" + }, + { + "path": "StandardDlsv6.StandardD128lsV6", + "type": "string", + "value": "\"Standard_D128ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD16lsV6", + "type": "string", + "value": "\"Standard_D16ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD2lsV6", + "type": "string", + "value": "\"Standard_D2ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD32lsV6", + "type": "string", + "value": "\"Standard_D32ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD48lsV6", + "type": "string", + "value": "\"Standard_D48ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD4lsV6", + "type": "string", + "value": "\"Standard_D4ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD64lsV6", + "type": "string", + "value": "\"Standard_D64ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD8lsV6", + "type": "string", + "value": "\"Standard_D8ls_v6\"" + }, + { + "path": "StandardDlsv6.StandardD96lsV6", + "type": "string", + "value": "\"Standard_D96ls_v6\"" + }, + { + "path": "StandardDlsv7.StandardD128lsV7", + "type": "string", + "value": "\"Standard_D128ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD16lsV7", + "type": "string", + "value": "\"Standard_D16ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD192lsV7", + "type": "string", + "value": "\"Standard_D192ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD2lsV7", + "type": "string", + "value": "\"Standard_D2ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD32lsV7", + "type": "string", + "value": "\"Standard_D32ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD48lsV7", + "type": "string", + "value": "\"Standard_D48ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD4lsV7", + "type": "string", + "value": "\"Standard_D4ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD64lsV7", + "type": "string", + "value": "\"Standard_D64ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD8lsV7", + "type": "string", + "value": "\"Standard_D8ls_v7\"" + }, + { + "path": "StandardDlsv7.StandardD96lsV7", + "type": "string", + "value": "\"Standard_D96ls_v7\"" + }, + { + "path": "StandardDndv6.StandardD128ndsV6", + "type": "string", + "value": "\"Standard_D128nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD16ndsV6", + "type": "string", + "value": "\"Standard_D16nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD2ndsV6", + "type": "string", + "value": "\"Standard_D2nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD32ndsV6", + "type": "string", + "value": "\"Standard_D32nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD48ndsV6", + "type": "string", + "value": "\"Standard_D48nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD4ndsV6", + "type": "string", + "value": "\"Standard_D4nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD64ndsV6", + "type": "string", + "value": "\"Standard_D64nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD8ndsV6", + "type": "string", + "value": "\"Standard_D8nds_v6\"" + }, + { + "path": "StandardDndv6.StandardD96ndsV6", + "type": "string", + "value": "\"Standard_D96nds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD128nldsV6", + "type": "string", + "value": "\"Standard_D128nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD16nldsV6", + "type": "string", + "value": "\"Standard_D16nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD2nldsV6", + "type": "string", + "value": "\"Standard_D2nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD32nldsV6", + "type": "string", + "value": "\"Standard_D32nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD48nldsV6", + "type": "string", + "value": "\"Standard_D48nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD4nldsV6", + "type": "string", + "value": "\"Standard_D4nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD64nldsV6", + "type": "string", + "value": "\"Standard_D64nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD8nldsV6", + "type": "string", + "value": "\"Standard_D8nlds_v6\"" + }, + { + "path": "StandardDnldv6.StandardD96nldsV6", + "type": "string", + "value": "\"Standard_D96nlds_v6\"" + }, + { + "path": "StandardDnlv6.StandardD128nlsV6", + "type": "string", + "value": "\"Standard_D128nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD16nlsV6", + "type": "string", + "value": "\"Standard_D16nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD2nlsV6", + "type": "string", + "value": "\"Standard_D2nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD32nlsV6", + "type": "string", + "value": "\"Standard_D32nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD48nlsV6", + "type": "string", + "value": "\"Standard_D48nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD4nlsV6", + "type": "string", + "value": "\"Standard_D4nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD64nlsV6", + "type": "string", + "value": "\"Standard_D64nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD8nlsV6", + "type": "string", + "value": "\"Standard_D8nls_v6\"" + }, + { + "path": "StandardDnlv6.StandardD96nlsV6", + "type": "string", + "value": "\"Standard_D96nls_v6\"" + }, + { + "path": "StandardDnv6.StandardD128nsV6", + "type": "string", + "value": "\"Standard_D128ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD16nsV6", + "type": "string", + "value": "\"Standard_D16ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD2nsV6", + "type": "string", + "value": "\"Standard_D2ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD32nsV6", + "type": "string", + "value": "\"Standard_D32ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD48nsV6", + "type": "string", + "value": "\"Standard_D48ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD4nsV6", + "type": "string", + "value": "\"Standard_D4ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD64nsV6", + "type": "string", + "value": "\"Standard_D64ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD8nsV6", + "type": "string", + "value": "\"Standard_D8ns_v6\"" + }, + { + "path": "StandardDnv6.StandardD96nsV6", + "type": "string", + "value": "\"Standard_D96ns_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD16pdsV6", + "type": "string", + "value": "\"Standard_D16pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD2pdsV6", + "type": "string", + "value": "\"Standard_D2pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD32pdsV6", + "type": "string", + "value": "\"Standard_D32pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD48pdsV6", + "type": "string", + "value": "\"Standard_D48pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD4pdsV6", + "type": "string", + "value": "\"Standard_D4pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD64pdsV6", + "type": "string", + "value": "\"Standard_D64pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD8pdsV6", + "type": "string", + "value": "\"Standard_D8pds_v6\"" + }, + { + "path": "StandardDpdsv6.StandardD96pdsV6", + "type": "string", + "value": "\"Standard_D96pds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD16pldsV6", + "type": "string", + "value": "\"Standard_D16plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD2pldsV6", + "type": "string", + "value": "\"Standard_D2plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD32pldsV6", + "type": "string", + "value": "\"Standard_D32plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD48pldsV6", + "type": "string", + "value": "\"Standard_D48plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD4pldsV6", + "type": "string", + "value": "\"Standard_D4plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD64pldsV6", + "type": "string", + "value": "\"Standard_D64plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD8pldsV6", + "type": "string", + "value": "\"Standard_D8plds_v6\"" + }, + { + "path": "StandardDpldsv6.StandardD96pldsV6", + "type": "string", + "value": "\"Standard_D96plds_v6\"" + }, + { + "path": "StandardDplsv6.StandardD16plsV6", + "type": "string", + "value": "\"Standard_D16pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD2plsV6", + "type": "string", + "value": "\"Standard_D2pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD32plsV6", + "type": "string", + "value": "\"Standard_D32pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD48plsV6", + "type": "string", + "value": "\"Standard_D48pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD4plsV6", + "type": "string", + "value": "\"Standard_D4pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD64plsV6", + "type": "string", + "value": "\"Standard_D64pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD8plsV6", + "type": "string", + "value": "\"Standard_D8pls_v6\"" + }, + { + "path": "StandardDplsv6.StandardD96plsV6", + "type": "string", + "value": "\"Standard_D96pls_v6\"" + }, + { + "path": "StandardDpsv6.StandardD16psV6", + "type": "string", + "value": "\"Standard_D16ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD2psV6", + "type": "string", + "value": "\"Standard_D2ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD32psV6", + "type": "string", + "value": "\"Standard_D32ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD48psV6", + "type": "string", + "value": "\"Standard_D48ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD4psV6", + "type": "string", + "value": "\"Standard_D4ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD64psV6", + "type": "string", + "value": "\"Standard_D64ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD8psV6", + "type": "string", + "value": "\"Standard_D8ps_v6\"" + }, + { + "path": "StandardDpsv6.StandardD96psV6", + "type": "string", + "value": "\"Standard_D96ps_v6\"" + }, + { + "path": "StandardDsv6.StandardD128sV6", + "type": "string", + "value": "\"Standard_D128s_v6\"" + }, + { + "path": "StandardDsv6.StandardD16sV6", + "type": "string", + "value": "\"Standard_D16s_v6\"" + }, + { + "path": "StandardDsv6.StandardD192sV6", + "type": "string", + "value": "\"Standard_D192s_v6\"" + }, + { + "path": "StandardDsv6.StandardD2sV6", + "type": "string", + "value": "\"Standard_D2s_v6\"" + }, + { + "path": "StandardDsv6.StandardD32sV6", + "type": "string", + "value": "\"Standard_D32s_v6\"" + }, + { + "path": "StandardDsv6.StandardD48sV6", + "type": "string", + "value": "\"Standard_D48s_v6\"" + }, + { + "path": "StandardDsv6.StandardD4sV6", + "type": "string", + "value": "\"Standard_D4s_v6\"" + }, + { + "path": "StandardDsv6.StandardD64sV6", + "type": "string", + "value": "\"Standard_D64s_v6\"" + }, + { + "path": "StandardDsv6.StandardD8sV6", + "type": "string", + "value": "\"Standard_D8s_v6\"" + }, + { + "path": "StandardDsv6.StandardD96sV6", + "type": "string", + "value": "\"Standard_D96s_v6\"" + }, + { + "path": "StandardDsv7.StandardD128sV7", + "type": "string", + "value": "\"Standard_D128s_v7\"" + }, + { + "path": "StandardDsv7.StandardD16sV7", + "type": "string", + "value": "\"Standard_D16s_v7\"" + }, + { + "path": "StandardDsv7.StandardD192sV7", + "type": "string", + "value": "\"Standard_D192s_v7\"" + }, + { + "path": "StandardDsv7.StandardD2sV7", + "type": "string", + "value": "\"Standard_D2s_v7\"" + }, + { + "path": "StandardDsv7.StandardD32sV7", + "type": "string", + "value": "\"Standard_D32s_v7\"" + }, + { + "path": "StandardDsv7.StandardD48sV7", + "type": "string", + "value": "\"Standard_D48s_v7\"" + }, + { + "path": "StandardDsv7.StandardD4sV7", + "type": "string", + "value": "\"Standard_D4s_v7\"" + }, + { + "path": "StandardDsv7.StandardD64sV7", + "type": "string", + "value": "\"Standard_D64s_v7\"" + }, + { + "path": "StandardDsv7.StandardD8sV7", + "type": "string", + "value": "\"Standard_D8s_v7\"" + }, + { + "path": "StandardDsv7.StandardD96sV7", + "type": "string", + "value": "\"Standard_D96s_v7\"" + }, + { + "path": "StandardDv2.StandardD11V2", + "type": "string", + "value": "\"Standard_D11_v2\"" + }, + { + "path": "StandardDv2.StandardD12V2", + "type": "string", + "value": "\"Standard_D12_v2\"" + }, + { + "path": "StandardDv2.StandardD13V2", + "type": "string", + "value": "\"Standard_D13_v2\"" + }, + { + "path": "StandardDv2.StandardD14V2", + "type": "string", + "value": "\"Standard_D14_v2\"" + }, + { + "path": "StandardDv2.StandardD15V2", + "type": "string", + "value": "\"Standard_D15_v2\"" + }, + { + "path": "StandardDv2.StandardD2V2", + "type": "string", + "value": "\"Standard_D2_v2\"" + }, + { + "path": "StandardDv2.StandardD3V2", + "type": "string", + "value": "\"Standard_D3_v2\"" + }, + { + "path": "StandardDv2.StandardD4V2", + "type": "string", + "value": "\"Standard_D4_v2\"" + }, + { + "path": "StandardDv2.StandardD5V2", + "type": "string", + "value": "\"Standard_D5_v2\"" + }, + { + "path": "StandardDv2Promo.StandardD11V2Promo", + "type": "string", + "value": "\"Standard_D11_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD12V2Promo", + "type": "string", + "value": "\"Standard_D12_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD13V2Promo", + "type": "string", + "value": "\"Standard_D13_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD14V2Promo", + "type": "string", + "value": "\"Standard_D14_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD2V2Promo", + "type": "string", + "value": "\"Standard_D2_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD3V2Promo", + "type": "string", + "value": "\"Standard_D3_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD4V2Promo", + "type": "string", + "value": "\"Standard_D4_v2_Promo\"" + }, + { + "path": "StandardDv2Promo.StandardD5V2Promo", + "type": "string", + "value": "\"Standard_D5_v2_Promo\"" + }, + { + "path": "StandardDv3.StandardD16V3", + "type": "string", + "value": "\"Standard_D16_v3\"" + }, + { + "path": "StandardDv3.StandardD2V3", + "type": "string", + "value": "\"Standard_D2_v3\"" + }, + { + "path": "StandardDv3.StandardD32V3", + "type": "string", + "value": "\"Standard_D32_v3\"" + }, + { + "path": "StandardDv3.StandardD48V3", + "type": "string", + "value": "\"Standard_D48_v3\"" + }, + { + "path": "StandardDv3.StandardD4V3", + "type": "string", + "value": "\"Standard_D4_v3\"" + }, + { + "path": "StandardDv3.StandardD64V3", + "type": "string", + "value": "\"Standard_D64_v3\"" + }, + { + "path": "StandardDv3.StandardD8V3", + "type": "string", + "value": "\"Standard_D8_v3\"" + }, + { + "path": "StandardDv4.StandardD16V4", + "type": "string", + "value": "\"Standard_D16_v4\"" + }, + { + "path": "StandardDv4.StandardD2V4", + "type": "string", + "value": "\"Standard_D2_v4\"" + }, + { + "path": "StandardDv4.StandardD32V4", + "type": "string", + "value": "\"Standard_D32_v4\"" + }, + { + "path": "StandardDv4.StandardD48V4", + "type": "string", + "value": "\"Standard_D48_v4\"" + }, + { + "path": "StandardDv4.StandardD4V4", + "type": "string", + "value": "\"Standard_D4_v4\"" + }, + { + "path": "StandardDv4.StandardD64V4", + "type": "string", + "value": "\"Standard_D64_v4\"" + }, + { + "path": "StandardDv4.StandardD8V4", + "type": "string", + "value": "\"Standard_D8_v4\"" + }, + { + "path": "StandardDv5.StandardD16V5", + "type": "string", + "value": "\"Standard_D16_v5\"" + }, + { + "path": "StandardDv5.StandardD2V5", + "type": "string", + "value": "\"Standard_D2_v5\"" + }, + { + "path": "StandardDv5.StandardD32V5", + "type": "string", + "value": "\"Standard_D32_v5\"" + }, + { + "path": "StandardDv5.StandardD48V5", + "type": "string", + "value": "\"Standard_D48_v5\"" + }, + { + "path": "StandardDv5.StandardD4V5", + "type": "string", + "value": "\"Standard_D4_v5\"" + }, + { + "path": "StandardDv5.StandardD64V5", + "type": "string", + "value": "\"Standard_D64_v5\"" + }, + { + "path": "StandardDv5.StandardD8V5", + "type": "string", + "value": "\"Standard_D8_v5\"" + }, + { + "path": "StandardDv5.StandardD96V5", + "type": "string", + "value": "\"Standard_D96_v5\"" + }, + { + "path": "StandardEADSv5.StandardE164adsV5", + "type": "string", + "value": "\"Standard_E16-4ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE168adsV5", + "type": "string", + "value": "\"Standard_E16-8ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE16adsV5", + "type": "string", + "value": "\"Standard_E16ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE20adsV5", + "type": "string", + "value": "\"Standard_E20ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE2adsV5", + "type": "string", + "value": "\"Standard_E2ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE3216adsV5", + "type": "string", + "value": "\"Standard_E32-16ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE328adsV5", + "type": "string", + "value": "\"Standard_E32-8ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE32adsV5", + "type": "string", + "value": "\"Standard_E32ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE42adsV5", + "type": "string", + "value": "\"Standard_E4-2ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE48adsV5", + "type": "string", + "value": "\"Standard_E48ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE4adsV5", + "type": "string", + "value": "\"Standard_E4ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE6416adsV5", + "type": "string", + "value": "\"Standard_E64-16ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE6432adsV5", + "type": "string", + "value": "\"Standard_E64-32ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE64adsV5", + "type": "string", + "value": "\"Standard_E64ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE82adsV5", + "type": "string", + "value": "\"Standard_E8-2ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE84adsV5", + "type": "string", + "value": "\"Standard_E8-4ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE8adsV5", + "type": "string", + "value": "\"Standard_E8ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE9624adsV5", + "type": "string", + "value": "\"Standard_E96-24ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE9648adsV5", + "type": "string", + "value": "\"Standard_E96-48ads_v5\"" + }, + { + "path": "StandardEADSv5.StandardE96adsV5", + "type": "string", + "value": "\"Standard_E96ads_v5\"" + }, + { + "path": "StandardEASv4.StandardE164asV4", + "type": "string", + "value": "\"Standard_E16-4as_v4\"" + }, + { + "path": "StandardEASv4.StandardE168asV4", + "type": "string", + "value": "\"Standard_E16-8as_v4\"" + }, + { + "path": "StandardEASv4.StandardE16asV4", + "type": "string", + "value": "\"Standard_E16as_v4\"" + }, + { + "path": "StandardEASv4.StandardE20asV4", + "type": "string", + "value": "\"Standard_E20as_v4\"" + }, + { + "path": "StandardEASv4.StandardE2asV4", + "type": "string", + "value": "\"Standard_E2as_v4\"" + }, + { + "path": "StandardEASv4.StandardE3216asV4", + "type": "string", + "value": "\"Standard_E32-16as_v4\"" + }, + { + "path": "StandardEASv4.StandardE328asV4", + "type": "string", + "value": "\"Standard_E32-8as_v4\"" + }, + { + "path": "StandardEASv4.StandardE32asV4", + "type": "string", + "value": "\"Standard_E32as_v4\"" + }, + { + "path": "StandardEASv4.StandardE42asV4", + "type": "string", + "value": "\"Standard_E4-2as_v4\"" + }, + { + "path": "StandardEASv4.StandardE48asV4", + "type": "string", + "value": "\"Standard_E48as_v4\"" + }, + { + "path": "StandardEASv4.StandardE4asV4", + "type": "string", + "value": "\"Standard_E4as_v4\"" + }, + { + "path": "StandardEASv4.StandardE6416asV4", + "type": "string", + "value": "\"Standard_E64-16as_v4\"" + }, + { + "path": "StandardEASv4.StandardE6432asV4", + "type": "string", + "value": "\"Standard_E64-32as_v4\"" + }, + { + "path": "StandardEASv4.StandardE64asV4", + "type": "string", + "value": "\"Standard_E64as_v4\"" + }, + { + "path": "StandardEASv4.StandardE82asV4", + "type": "string", + "value": "\"Standard_E8-2as_v4\"" + }, + { + "path": "StandardEASv4.StandardE84asV4", + "type": "string", + "value": "\"Standard_E8-4as_v4\"" + }, + { + "path": "StandardEASv4.StandardE8asV4", + "type": "string", + "value": "\"Standard_E8as_v4\"" + }, + { + "path": "StandardEASv4.StandardE9624asV4", + "type": "string", + "value": "\"Standard_E96-24as_v4\"" + }, + { + "path": "StandardEASv4.StandardE9648asV4", + "type": "string", + "value": "\"Standard_E96-48as_v4\"" + }, + { + "path": "StandardEASv4.StandardE96asV4", + "type": "string", + "value": "\"Standard_E96as_v4\"" + }, + { + "path": "StandardEASv5.StandardE164asV5", + "type": "string", + "value": "\"Standard_E16-4as_v5\"" + }, + { + "path": "StandardEASv5.StandardE168asV5", + "type": "string", + "value": "\"Standard_E16-8as_v5\"" + }, + { + "path": "StandardEASv5.StandardE16asV5", + "type": "string", + "value": "\"Standard_E16as_v5\"" + }, + { + "path": "StandardEASv5.StandardE20asV5", + "type": "string", + "value": "\"Standard_E20as_v5\"" + }, + { + "path": "StandardEASv5.StandardE2asV5", + "type": "string", + "value": "\"Standard_E2as_v5\"" + }, + { + "path": "StandardEASv5.StandardE3216asV5", + "type": "string", + "value": "\"Standard_E32-16as_v5\"" + }, + { + "path": "StandardEASv5.StandardE328asV5", + "type": "string", + "value": "\"Standard_E32-8as_v5\"" + }, + { + "path": "StandardEASv5.StandardE32asV5", + "type": "string", + "value": "\"Standard_E32as_v5\"" + }, + { + "path": "StandardEASv5.StandardE42asV5", + "type": "string", + "value": "\"Standard_E4-2as_v5\"" + }, + { + "path": "StandardEASv5.StandardE48asV5", + "type": "string", + "value": "\"Standard_E48as_v5\"" + }, + { + "path": "StandardEASv5.StandardE4asV5", + "type": "string", + "value": "\"Standard_E4as_v5\"" + }, + { + "path": "StandardEASv5.StandardE6416asV5", + "type": "string", + "value": "\"Standard_E64-16as_v5\"" + }, + { + "path": "StandardEASv5.StandardE6432asV5", + "type": "string", + "value": "\"Standard_E64-32as_v5\"" + }, + { + "path": "StandardEASv5.StandardE64asV5", + "type": "string", + "value": "\"Standard_E64as_v5\"" + }, + { + "path": "StandardEASv5.StandardE82asV5", + "type": "string", + "value": "\"Standard_E8-2as_v5\"" + }, + { + "path": "StandardEASv5.StandardE84asV5", + "type": "string", + "value": "\"Standard_E8-4as_v5\"" + }, + { + "path": "StandardEASv5.StandardE8asV5", + "type": "string", + "value": "\"Standard_E8as_v5\"" + }, + { + "path": "StandardEASv5.StandardE9624asV5", + "type": "string", + "value": "\"Standard_E96-24as_v5\"" + }, + { + "path": "StandardEASv5.StandardE9648asV5", + "type": "string", + "value": "\"Standard_E96-48as_v5\"" + }, + { + "path": "StandardEASv5.StandardE96asV5", + "type": "string", + "value": "\"Standard_E96as_v5\"" + }, + { + "path": "StandardEAv4.StandardE16aV4", + "type": "string", + "value": "\"Standard_E16a_v4\"" + }, + { + "path": "StandardEAv4.StandardE20aV4", + "type": "string", + "value": "\"Standard_E20a_v4\"" + }, + { + "path": "StandardEAv4.StandardE2aV4", + "type": "string", + "value": "\"Standard_E2a_v4\"" + }, + { + "path": "StandardEAv4.StandardE32aV4", + "type": "string", + "value": "\"Standard_E32a_v4\"" + }, + { + "path": "StandardEAv4.StandardE48aV4", + "type": "string", + "value": "\"Standard_E48a_v4\"" + }, + { + "path": "StandardEAv4.StandardE4aV4", + "type": "string", + "value": "\"Standard_E4a_v4\"" + }, + { + "path": "StandardEAv4.StandardE64aV4", + "type": "string", + "value": "\"Standard_E64a_v4\"" + }, + { + "path": "StandardEAv4.StandardE8aV4", + "type": "string", + "value": "\"Standard_E8a_v4\"" + }, + { + "path": "StandardEAv4.StandardE96aV4", + "type": "string", + "value": "\"Standard_E96a_v4\"" + }, + { + "path": "StandardEBDSv5.StandardE16bdsV5", + "type": "string", + "value": "\"Standard_E16bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE2bdsV5", + "type": "string", + "value": "\"Standard_E2bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE32bdsV5", + "type": "string", + "value": "\"Standard_E32bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE48bdsV5", + "type": "string", + "value": "\"Standard_E48bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE4bdsV5", + "type": "string", + "value": "\"Standard_E4bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE64bdsV5", + "type": "string", + "value": "\"Standard_E64bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE8bdsV5", + "type": "string", + "value": "\"Standard_E8bds_v5\"" + }, + { + "path": "StandardEBDSv5.StandardE96bdsV5", + "type": "string", + "value": "\"Standard_E96bds_v5\"" + }, + { + "path": "StandardEBSv5.StandardE16bsV5", + "type": "string", + "value": "\"Standard_E16bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE2bsV5", + "type": "string", + "value": "\"Standard_E2bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE32bsV5", + "type": "string", + "value": "\"Standard_E32bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE48bsV5", + "type": "string", + "value": "\"Standard_E48bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE4bsV5", + "type": "string", + "value": "\"Standard_E4bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE64bsV5", + "type": "string", + "value": "\"Standard_E64bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE8bsV5", + "type": "string", + "value": "\"Standard_E8bs_v5\"" + }, + { + "path": "StandardEBSv5.StandardE96bsV5", + "type": "string", + "value": "\"Standard_E96bs_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC16asCcV5", + "type": "string", + "value": "\"Standard_EC16as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC20asCcV5", + "type": "string", + "value": "\"Standard_EC20as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC32asCcV5", + "type": "string", + "value": "\"Standard_EC32as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC48asCcV5", + "type": "string", + "value": "\"Standard_EC48as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC4asCcV5", + "type": "string", + "value": "\"Standard_EC4as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC64asCcV5", + "type": "string", + "value": "\"Standard_EC64as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC8asCcV5", + "type": "string", + "value": "\"Standard_EC8as_cc_v5\"" + }, + { + "path": "StandardECACCV5.StandardEC96asCcV5", + "type": "string", + "value": "\"Standard_EC96as_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC16adsCcV5", + "type": "string", + "value": "\"Standard_EC16ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC20adsCcV5", + "type": "string", + "value": "\"Standard_EC20ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC32adsCcV5", + "type": "string", + "value": "\"Standard_EC32ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC48adsCcV5", + "type": "string", + "value": "\"Standard_EC48ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC4adsCcV5", + "type": "string", + "value": "\"Standard_EC4ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC64adsCcV5", + "type": "string", + "value": "\"Standard_EC64ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC8adsCcV5", + "type": "string", + "value": "\"Standard_EC8ads_cc_v5\"" + }, + { + "path": "StandardECADCCV5.StandardEC96adsCcV5", + "type": "string", + "value": "\"Standard_EC96ads_cc_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC16adsV5", + "type": "string", + "value": "\"Standard_EC16ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC20adsV5", + "type": "string", + "value": "\"Standard_EC20ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC2adsV5", + "type": "string", + "value": "\"Standard_EC2ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC32adsV5", + "type": "string", + "value": "\"Standard_EC32ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC48adsV5", + "type": "string", + "value": "\"Standard_EC48ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC4adsV5", + "type": "string", + "value": "\"Standard_EC4ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC64adsV5", + "type": "string", + "value": "\"Standard_EC64ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC8adsV5", + "type": "string", + "value": "\"Standard_EC8ads_v5\"" + }, + { + "path": "StandardECADSv5.StandardEC96adsV5", + "type": "string", + "value": "\"Standard_EC96ads_v5\"" + }, + { + "path": "StandardECASv5.StandardEC16asV5", + "type": "string", + "value": "\"Standard_EC16as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC20asV5", + "type": "string", + "value": "\"Standard_EC20as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC2asV5", + "type": "string", + "value": "\"Standard_EC2as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC32asV5", + "type": "string", + "value": "\"Standard_EC32as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC48asV5", + "type": "string", + "value": "\"Standard_EC48as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC4asV5", + "type": "string", + "value": "\"Standard_EC4as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC64asV5", + "type": "string", + "value": "\"Standard_EC64as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC8asV5", + "type": "string", + "value": "\"Standard_EC8as_v5\"" + }, + { + "path": "StandardECASv5.StandardEC96asV5", + "type": "string", + "value": "\"Standard_EC96as_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC128edsV5", + "type": "string", + "value": "\"Standard_EC128eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC16edsV5", + "type": "string", + "value": "\"Standard_EC16eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC2edsV5", + "type": "string", + "value": "\"Standard_EC2eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC32edsV5", + "type": "string", + "value": "\"Standard_EC32eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC48edsV5", + "type": "string", + "value": "\"Standard_EC48eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC4edsV5", + "type": "string", + "value": "\"Standard_EC4eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC64edsV5", + "type": "string", + "value": "\"Standard_EC64eds_v5\"" + }, + { + "path": "StandardECEDV5.StandardEC8edsV5", + "type": "string", + "value": "\"Standard_EC8eds_v5\"" + }, + { + "path": "StandardECEDV6.StandardEC16edsV6", + "type": "string", + "value": "\"Standard_EC16eds_v6\"" + }, + { + "path": "StandardECEDV6.StandardEC2edsV6", + "type": "string", + "value": "\"Standard_EC2eds_v6\"" + }, + { + "path": "StandardECEDV6.StandardEC32edsV6", + "type": "string", + "value": "\"Standard_EC32eds_v6\"" + }, + { + "path": "StandardECEDV6.StandardEC48edsV6", + "type": "string", + "value": "\"Standard_EC48eds_v6\"" + }, + { + "path": "StandardECEDV6.StandardEC4edsV6", + "type": "string", + "value": "\"Standard_EC4eds_v6\"" + }, + { + "path": "StandardECEDV6.StandardEC64edsV6", + "type": "string", + "value": "\"Standard_EC64eds_v6\"" + }, + { + "path": "StandardECEDV6.StandardEC8edsV6", + "type": "string", + "value": "\"Standard_EC8eds_v6\"" + }, + { + "path": "StandardECEV5.StandardEC128esV5", + "type": "string", + "value": "\"Standard_EC128es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC16esV5", + "type": "string", + "value": "\"Standard_EC16es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC2esV5", + "type": "string", + "value": "\"Standard_EC2es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC32esV5", + "type": "string", + "value": "\"Standard_EC32es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC48esV5", + "type": "string", + "value": "\"Standard_EC48es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC4esV5", + "type": "string", + "value": "\"Standard_EC4es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC64esV5", + "type": "string", + "value": "\"Standard_EC64es_v5\"" + }, + { + "path": "StandardECEV5.StandardEC8esV5", + "type": "string", + "value": "\"Standard_EC8es_v5\"" + }, + { + "path": "StandardECEV6.StandardEC16esV6", + "type": "string", + "value": "\"Standard_EC16es_v6\"" + }, + { + "path": "StandardECEV6.StandardEC2esV6", + "type": "string", + "value": "\"Standard_EC2es_v6\"" + }, + { + "path": "StandardECEV6.StandardEC32esV6", + "type": "string", + "value": "\"Standard_EC32es_v6\"" + }, + { + "path": "StandardECEV6.StandardEC48esV6", + "type": "string", + "value": "\"Standard_EC48es_v6\"" + }, + { + "path": "StandardECEV6.StandardEC4esV6", + "type": "string", + "value": "\"Standard_EC4es_v6\"" + }, + { + "path": "StandardECEV6.StandardEC64esV6", + "type": "string", + "value": "\"Standard_EC64es_v6\"" + }, + { + "path": "StandardECEV6.StandardEC8esV6", + "type": "string", + "value": "\"Standard_EC8es_v6\"" + }, + { + "path": "StandardECIADSv5.StandardEC96iadsV5", + "type": "string", + "value": "\"Standard_EC96iads_v5\"" + }, + { + "path": "StandardECIASv5.StandardEC96iasV5", + "type": "string", + "value": "\"Standard_EC96ias_v5\"" + }, + { + "path": "StandardECIEDV5.StandardEC128iedsV5", + "type": "string", + "value": "\"Standard_EC128ieds_v5\"" + }, + { + "path": "StandardECIEV5.StandardEC128iesV5", + "type": "string", + "value": "\"Standard_EC128ies_v5\"" + }, + { + "path": "StandardECadsv6.StandardEC16adsV6", + "type": "string", + "value": "\"Standard_EC16ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC2adsV6", + "type": "string", + "value": "\"Standard_EC2ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC32adsV6", + "type": "string", + "value": "\"Standard_EC32ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC48adsV6", + "type": "string", + "value": "\"Standard_EC48ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC4adsV6", + "type": "string", + "value": "\"Standard_EC4ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC64adsV6", + "type": "string", + "value": "\"Standard_EC64ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC8adsV6", + "type": "string", + "value": "\"Standard_EC8ads_v6\"" + }, + { + "path": "StandardECadsv6.StandardEC96adsV6", + "type": "string", + "value": "\"Standard_EC96ads_v6\"" + }, + { + "path": "StandardECasv6.StandardEC16asV6", + "type": "string", + "value": "\"Standard_EC16as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC2asV6", + "type": "string", + "value": "\"Standard_EC2as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC32asV6", + "type": "string", + "value": "\"Standard_EC32as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC48asV6", + "type": "string", + "value": "\"Standard_EC48as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC4asV6", + "type": "string", + "value": "\"Standard_EC4as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC64asV6", + "type": "string", + "value": "\"Standard_EC64as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC8asV6", + "type": "string", + "value": "\"Standard_EC8as_v6\"" + }, + { + "path": "StandardECasv6.StandardEC96asV6", + "type": "string", + "value": "\"Standard_EC96as_v6\"" + }, + { + "path": "StandardEDSv4.StandardE164dsV4", + "type": "string", + "value": "\"Standard_E16-4ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE168dsV4", + "type": "string", + "value": "\"Standard_E16-8ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE16dsV4", + "type": "string", + "value": "\"Standard_E16ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE20dsV4", + "type": "string", + "value": "\"Standard_E20ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE2dsV4", + "type": "string", + "value": "\"Standard_E2ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE3216dsV4", + "type": "string", + "value": "\"Standard_E32-16ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE328dsV4", + "type": "string", + "value": "\"Standard_E32-8ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE32dsV4", + "type": "string", + "value": "\"Standard_E32ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE42dsV4", + "type": "string", + "value": "\"Standard_E4-2ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE48dsV4", + "type": "string", + "value": "\"Standard_E48ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE4dsV4", + "type": "string", + "value": "\"Standard_E4ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE6416dsV4", + "type": "string", + "value": "\"Standard_E64-16ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE6432dsV4", + "type": "string", + "value": "\"Standard_E64-32ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE64dsV4", + "type": "string", + "value": "\"Standard_E64ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE82dsV4", + "type": "string", + "value": "\"Standard_E8-2ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE84dsV4", + "type": "string", + "value": "\"Standard_E8-4ds_v4\"" + }, + { + "path": "StandardEDSv4.StandardE8dsV4", + "type": "string", + "value": "\"Standard_E8ds_v4\"" + }, + { + "path": "StandardEDSv5.StandardE164dsV5", + "type": "string", + "value": "\"Standard_E16-4ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE168dsV5", + "type": "string", + "value": "\"Standard_E16-8ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE16dsV5", + "type": "string", + "value": "\"Standard_E16ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE20dsV5", + "type": "string", + "value": "\"Standard_E20ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE2dsV5", + "type": "string", + "value": "\"Standard_E2ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE3216dsV5", + "type": "string", + "value": "\"Standard_E32-16ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE328dsV5", + "type": "string", + "value": "\"Standard_E32-8ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE32dsV5", + "type": "string", + "value": "\"Standard_E32ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE42dsV5", + "type": "string", + "value": "\"Standard_E4-2ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE48dsV5", + "type": "string", + "value": "\"Standard_E48ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE4dsV5", + "type": "string", + "value": "\"Standard_E4ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE6416dsV5", + "type": "string", + "value": "\"Standard_E64-16ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE6432dsV5", + "type": "string", + "value": "\"Standard_E64-32ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE64dsV5", + "type": "string", + "value": "\"Standard_E64ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE82dsV5", + "type": "string", + "value": "\"Standard_E8-2ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE84dsV5", + "type": "string", + "value": "\"Standard_E8-4ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE8dsV5", + "type": "string", + "value": "\"Standard_E8ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE9624dsV5", + "type": "string", + "value": "\"Standard_E96-24ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE9648dsV5", + "type": "string", + "value": "\"Standard_E96-48ds_v5\"" + }, + { + "path": "StandardEDSv5.StandardE96dsV5", + "type": "string", + "value": "\"Standard_E96ds_v5\"" + }, + { + "path": "StandardEDv4.StandardE16dV4", + "type": "string", + "value": "\"Standard_E16d_v4\"" + }, + { + "path": "StandardEDv4.StandardE20dV4", + "type": "string", + "value": "\"Standard_E20d_v4\"" + }, + { + "path": "StandardEDv4.StandardE2dV4", + "type": "string", + "value": "\"Standard_E2d_v4\"" + }, + { + "path": "StandardEDv4.StandardE32dV4", + "type": "string", + "value": "\"Standard_E32d_v4\"" + }, + { + "path": "StandardEDv4.StandardE48dV4", + "type": "string", + "value": "\"Standard_E48d_v4\"" + }, + { + "path": "StandardEDv4.StandardE4dV4", + "type": "string", + "value": "\"Standard_E4d_v4\"" + }, + { + "path": "StandardEDv4.StandardE64dV4", + "type": "string", + "value": "\"Standard_E64d_v4\"" + }, + { + "path": "StandardEDv4.StandardE8dV4", + "type": "string", + "value": "\"Standard_E8d_v4\"" + }, + { + "path": "StandardEDv5.StandardE16dV5", + "type": "string", + "value": "\"Standard_E16d_v5\"" + }, + { + "path": "StandardEDv5.StandardE20dV5", + "type": "string", + "value": "\"Standard_E20d_v5\"" + }, + { + "path": "StandardEDv5.StandardE2dV5", + "type": "string", + "value": "\"Standard_E2d_v5\"" + }, + { + "path": "StandardEDv5.StandardE32dV5", + "type": "string", + "value": "\"Standard_E32d_v5\"" + }, + { + "path": "StandardEDv5.StandardE48dV5", + "type": "string", + "value": "\"Standard_E48d_v5\"" + }, + { + "path": "StandardEDv5.StandardE4dV5", + "type": "string", + "value": "\"Standard_E4d_v5\"" + }, + { + "path": "StandardEDv5.StandardE64dV5", + "type": "string", + "value": "\"Standard_E64d_v5\"" + }, + { + "path": "StandardEDv5.StandardE8dV5", + "type": "string", + "value": "\"Standard_E8d_v5\"" + }, + { + "path": "StandardEDv5.StandardE96dV5", + "type": "string", + "value": "\"Standard_E96d_v5\"" + }, + { + "path": "StandardEIADSv5.StandardE112iadsV5", + "type": "string", + "value": "\"Standard_E112iads_v5\"" + }, + { + "path": "StandardEIASv4.StandardE96iasV4", + "type": "string", + "value": "\"Standard_E96ias_v4\"" + }, + { + "path": "StandardEIASv5.StandardE112iasV5", + "type": "string", + "value": "\"Standard_E112ias_v5\"" + }, + { + "path": "StandardEIBDSv5.StandardE112ibdsV5", + "type": "string", + "value": "\"Standard_E112ibds_v5\"" + }, + { + "path": "StandardEIBSv5.StandardE112ibsV5", + "type": "string", + "value": "\"Standard_E112ibs_v5\"" + }, + { + "path": "StandardEIDSv5.StandardE104idsV5", + "type": "string", + "value": "\"Standard_E104ids_v5\"" + }, + { + "path": "StandardEIDv5.StandardE104idV5", + "type": "string", + "value": "\"Standard_E104id_v5\"" + }, + { + "path": "StandardEISv5.StandardE104isV5", + "type": "string", + "value": "\"Standard_E104is_v5\"" + }, + { + "path": "StandardEIv5.StandardE104iV5", + "type": "string", + "value": "\"Standard_E104i_v5\"" + }, + { + "path": "StandardEPDSv5.StandardE16pdsV5", + "type": "string", + "value": "\"Standard_E16pds_v5\"" + }, + { + "path": "StandardEPDSv5.StandardE20pdsV5", + "type": "string", + "value": "\"Standard_E20pds_v5\"" + }, + { + "path": "StandardEPDSv5.StandardE2pdsV5", + "type": "string", + "value": "\"Standard_E2pds_v5\"" + }, + { + "path": "StandardEPDSv5.StandardE32pdsV5", + "type": "string", + "value": "\"Standard_E32pds_v5\"" + }, + { + "path": "StandardEPDSv5.StandardE4pdsV5", + "type": "string", + "value": "\"Standard_E4pds_v5\"" + }, + { + "path": "StandardEPDSv5.StandardE8pdsV5", + "type": "string", + "value": "\"Standard_E8pds_v5\"" + }, + { + "path": "StandardEPSv5.StandardE16psV5", + "type": "string", + "value": "\"Standard_E16ps_v5\"" + }, + { + "path": "StandardEPSv5.StandardE20psV5", + "type": "string", + "value": "\"Standard_E20ps_v5\"" + }, + { + "path": "StandardEPSv5.StandardE2psV5", + "type": "string", + "value": "\"Standard_E2ps_v5\"" + }, + { + "path": "StandardEPSv5.StandardE32psV5", + "type": "string", + "value": "\"Standard_E32ps_v5\"" + }, + { + "path": "StandardEPSv5.StandardE4psV5", + "type": "string", + "value": "\"Standard_E4ps_v5\"" + }, + { + "path": "StandardEPSv5.StandardE8psV5", + "type": "string", + "value": "\"Standard_E8ps_v5\"" + }, + { + "path": "StandardESv3.StandardE164sV3", + "type": "string", + "value": "\"Standard_E16-4s_v3\"" + }, + { + "path": "StandardESv3.StandardE168sV3", + "type": "string", + "value": "\"Standard_E16-8s_v3\"" + }, + { + "path": "StandardESv3.StandardE16sV3", + "type": "string", + "value": "\"Standard_E16s_v3\"" + }, + { + "path": "StandardESv3.StandardE20sV3", + "type": "string", + "value": "\"Standard_E20s_v3\"" + }, + { + "path": "StandardESv3.StandardE2sV3", + "type": "string", + "value": "\"Standard_E2s_v3\"" + }, + { + "path": "StandardESv3.StandardE3216sV3", + "type": "string", + "value": "\"Standard_E32-16s_v3\"" + }, + { + "path": "StandardESv3.StandardE328sV3", + "type": "string", + "value": "\"Standard_E32-8s_v3\"" + }, + { + "path": "StandardESv3.StandardE32sV3", + "type": "string", + "value": "\"Standard_E32s_v3\"" + }, + { + "path": "StandardESv3.StandardE42sV3", + "type": "string", + "value": "\"Standard_E4-2s_v3\"" + }, + { + "path": "StandardESv3.StandardE48sV3", + "type": "string", + "value": "\"Standard_E48s_v3\"" + }, + { + "path": "StandardESv3.StandardE4sV3", + "type": "string", + "value": "\"Standard_E4s_v3\"" + }, + { + "path": "StandardESv3.StandardE6416sV3", + "type": "string", + "value": "\"Standard_E64-16s_v3\"" + }, + { + "path": "StandardESv3.StandardE6432sV3", + "type": "string", + "value": "\"Standard_E64-32s_v3\"" + }, + { + "path": "StandardESv3.StandardE64sV3", + "type": "string", + "value": "\"Standard_E64s_v3\"" + }, + { + "path": "StandardESv3.StandardE82sV3", + "type": "string", + "value": "\"Standard_E8-2s_v3\"" + }, + { + "path": "StandardESv3.StandardE84sV3", + "type": "string", + "value": "\"Standard_E8-4s_v3\"" + }, + { + "path": "StandardESv3.StandardE8sV3", + "type": "string", + "value": "\"Standard_E8s_v3\"" + }, + { + "path": "StandardESv4.StandardE164sV4", + "type": "string", + "value": "\"Standard_E16-4s_v4\"" + }, + { + "path": "StandardESv4.StandardE168sV4", + "type": "string", + "value": "\"Standard_E16-8s_v4\"" + }, + { + "path": "StandardESv4.StandardE16sV4", + "type": "string", + "value": "\"Standard_E16s_v4\"" + }, + { + "path": "StandardESv4.StandardE20sV4", + "type": "string", + "value": "\"Standard_E20s_v4\"" + }, + { + "path": "StandardESv4.StandardE2sV4", + "type": "string", + "value": "\"Standard_E2s_v4\"" + }, + { + "path": "StandardESv4.StandardE3216sV4", + "type": "string", + "value": "\"Standard_E32-16s_v4\"" + }, + { + "path": "StandardESv4.StandardE328sV4", + "type": "string", + "value": "\"Standard_E32-8s_v4\"" + }, + { + "path": "StandardESv4.StandardE32sV4", + "type": "string", + "value": "\"Standard_E32s_v4\"" + }, + { + "path": "StandardESv4.StandardE42sV4", + "type": "string", + "value": "\"Standard_E4-2s_v4\"" + }, + { + "path": "StandardESv4.StandardE48sV4", + "type": "string", + "value": "\"Standard_E48s_v4\"" + }, + { + "path": "StandardESv4.StandardE4sV4", + "type": "string", + "value": "\"Standard_E4s_v4\"" + }, + { + "path": "StandardESv4.StandardE6416sV4", + "type": "string", + "value": "\"Standard_E64-16s_v4\"" + }, + { + "path": "StandardESv4.StandardE6432sV4", + "type": "string", + "value": "\"Standard_E64-32s_v4\"" + }, + { + "path": "StandardESv4.StandardE64sV4", + "type": "string", + "value": "\"Standard_E64s_v4\"" + }, + { + "path": "StandardESv4.StandardE82sV4", + "type": "string", + "value": "\"Standard_E8-2s_v4\"" + }, + { + "path": "StandardESv4.StandardE84sV4", + "type": "string", + "value": "\"Standard_E8-4s_v4\"" + }, + { + "path": "StandardESv4.StandardE8sV4", + "type": "string", + "value": "\"Standard_E8s_v4\"" + }, + { + "path": "StandardESv5.StandardE164sV5", + "type": "string", + "value": "\"Standard_E16-4s_v5\"" + }, + { + "path": "StandardESv5.StandardE168sV5", + "type": "string", + "value": "\"Standard_E16-8s_v5\"" + }, + { + "path": "StandardESv5.StandardE16sV5", + "type": "string", + "value": "\"Standard_E16s_v5\"" + }, + { + "path": "StandardESv5.StandardE20sV5", + "type": "string", + "value": "\"Standard_E20s_v5\"" + }, + { + "path": "StandardESv5.StandardE2sV5", + "type": "string", + "value": "\"Standard_E2s_v5\"" + }, + { + "path": "StandardESv5.StandardE3216sV5", + "type": "string", + "value": "\"Standard_E32-16s_v5\"" + }, + { + "path": "StandardESv5.StandardE328sV5", + "type": "string", + "value": "\"Standard_E32-8s_v5\"" + }, + { + "path": "StandardESv5.StandardE32sV5", + "type": "string", + "value": "\"Standard_E32s_v5\"" + }, + { + "path": "StandardESv5.StandardE42sV5", + "type": "string", + "value": "\"Standard_E4-2s_v5\"" + }, + { + "path": "StandardESv5.StandardE48sV5", + "type": "string", + "value": "\"Standard_E48s_v5\"" + }, + { + "path": "StandardESv5.StandardE4sV5", + "type": "string", + "value": "\"Standard_E4s_v5\"" + }, + { + "path": "StandardESv5.StandardE6416sV5", + "type": "string", + "value": "\"Standard_E64-16s_v5\"" + }, + { + "path": "StandardESv5.StandardE6432sV5", + "type": "string", + "value": "\"Standard_E64-32s_v5\"" + }, + { + "path": "StandardESv5.StandardE64sV5", + "type": "string", + "value": "\"Standard_E64s_v5\"" + }, + { + "path": "StandardESv5.StandardE82sV5", + "type": "string", + "value": "\"Standard_E8-2s_v5\"" + }, + { + "path": "StandardESv5.StandardE84sV5", + "type": "string", + "value": "\"Standard_E8-4s_v5\"" + }, + { + "path": "StandardESv5.StandardE8sV5", + "type": "string", + "value": "\"Standard_E8s_v5\"" + }, + { + "path": "StandardESv5.StandardE9624sV5", + "type": "string", + "value": "\"Standard_E96-24s_v5\"" + }, + { + "path": "StandardESv5.StandardE9648sV5", + "type": "string", + "value": "\"Standard_E96-48s_v5\"" + }, + { + "path": "StandardESv5.StandardE96sV5", + "type": "string", + "value": "\"Standard_E96s_v5\"" + }, + { + "path": "StandardEadsv7.StandardE12832adsV7", + "type": "string", + "value": "\"Standard_E128-32ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE12864adsV7", + "type": "string", + "value": "\"Standard_E128-64ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE128adsV7", + "type": "string", + "value": "\"Standard_E128ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE160adsV7", + "type": "string", + "value": "\"Standard_E160ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE164adsV7", + "type": "string", + "value": "\"Standard_E16-4ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE168adsV7", + "type": "string", + "value": "\"Standard_E16-8ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE16adsV7", + "type": "string", + "value": "\"Standard_E16ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE2adsV7", + "type": "string", + "value": "\"Standard_E2ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE3216adsV7", + "type": "string", + "value": "\"Standard_E32-16ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE328adsV7", + "type": "string", + "value": "\"Standard_E32-8ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE32adsV7", + "type": "string", + "value": "\"Standard_E32ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE42adsV7", + "type": "string", + "value": "\"Standard_E4-2ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE48adsV7", + "type": "string", + "value": "\"Standard_E48ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE4adsV7", + "type": "string", + "value": "\"Standard_E4ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE6416adsV7", + "type": "string", + "value": "\"Standard_E64-16ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE6432adsV7", + "type": "string", + "value": "\"Standard_E64-32ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE64adsV7", + "type": "string", + "value": "\"Standard_E64ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE82adsV7", + "type": "string", + "value": "\"Standard_E8-2ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE84adsV7", + "type": "string", + "value": "\"Standard_E8-4ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE8adsV7", + "type": "string", + "value": "\"Standard_E8ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE9624adsV7", + "type": "string", + "value": "\"Standard_E96-24ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE9648adsV7", + "type": "string", + "value": "\"Standard_E96-48ads_v7\"" + }, + { + "path": "StandardEadsv7.StandardE96adsV7", + "type": "string", + "value": "\"Standard_E96ads_v7\"" + }, + { + "path": "StandardEadv6.StandardE16adsV6", + "type": "string", + "value": "\"Standard_E16ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE20adsV6", + "type": "string", + "value": "\"Standard_E20ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE2adsV6", + "type": "string", + "value": "\"Standard_E2ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE32adsV6", + "type": "string", + "value": "\"Standard_E32ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE48adsV6", + "type": "string", + "value": "\"Standard_E48ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE4adsV6", + "type": "string", + "value": "\"Standard_E4ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE64adsV6", + "type": "string", + "value": "\"Standard_E64ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE8adsV6", + "type": "string", + "value": "\"Standard_E8ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE9624adsV6", + "type": "string", + "value": "\"Standard_E96-24ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE9648adsV6", + "type": "string", + "value": "\"Standard_E96-48ads_v6\"" + }, + { + "path": "StandardEadv6.StandardE96adsV6", + "type": "string", + "value": "\"Standard_E96ads_v6\"" + }, + { + "path": "StandardEasv7.StandardE12832asV7", + "type": "string", + "value": "\"Standard_E128-32as_v7\"" + }, + { + "path": "StandardEasv7.StandardE12864asV7", + "type": "string", + "value": "\"Standard_E128-64as_v7\"" + }, + { + "path": "StandardEasv7.StandardE128asV7", + "type": "string", + "value": "\"Standard_E128as_v7\"" + }, + { + "path": "StandardEasv7.StandardE160asV7", + "type": "string", + "value": "\"Standard_E160as_v7\"" + }, + { + "path": "StandardEasv7.StandardE164asV7", + "type": "string", + "value": "\"Standard_E16-4as_v7\"" + }, + { + "path": "StandardEasv7.StandardE168asV7", + "type": "string", + "value": "\"Standard_E16-8as_v7\"" + }, + { + "path": "StandardEasv7.StandardE16asV7", + "type": "string", + "value": "\"Standard_E16as_v7\"" + }, + { + "path": "StandardEasv7.StandardE2asV7", + "type": "string", + "value": "\"Standard_E2as_v7\"" + }, + { + "path": "StandardEasv7.StandardE3216asV7", + "type": "string", + "value": "\"Standard_E32-16as_v7\"" + }, + { + "path": "StandardEasv7.StandardE328asV7", + "type": "string", + "value": "\"Standard_E32-8as_v7\"" + }, + { + "path": "StandardEasv7.StandardE32asV7", + "type": "string", + "value": "\"Standard_E32as_v7\"" + }, + { + "path": "StandardEasv7.StandardE42asV7", + "type": "string", + "value": "\"Standard_E4-2as_v7\"" + }, + { + "path": "StandardEasv7.StandardE48asV7", + "type": "string", + "value": "\"Standard_E48as_v7\"" + }, + { + "path": "StandardEasv7.StandardE4asV7", + "type": "string", + "value": "\"Standard_E4as_v7\"" + }, + { + "path": "StandardEasv7.StandardE6416asV7", + "type": "string", + "value": "\"Standard_E64-16as_v7\"" + }, + { + "path": "StandardEasv7.StandardE6432asV7", + "type": "string", + "value": "\"Standard_E64-32as_v7\"" + }, + { + "path": "StandardEasv7.StandardE64asV7", + "type": "string", + "value": "\"Standard_E64as_v7\"" + }, + { + "path": "StandardEasv7.StandardE82asV7", + "type": "string", + "value": "\"Standard_E8-2as_v7\"" + }, + { + "path": "StandardEasv7.StandardE84asV7", + "type": "string", + "value": "\"Standard_E8-4as_v7\"" + }, + { + "path": "StandardEasv7.StandardE8asV7", + "type": "string", + "value": "\"Standard_E8as_v7\"" + }, + { + "path": "StandardEasv7.StandardE9624asV7", + "type": "string", + "value": "\"Standard_E96-24as_v7\"" + }, + { + "path": "StandardEasv7.StandardE9648asV7", + "type": "string", + "value": "\"Standard_E96-48as_v7\"" + }, + { + "path": "StandardEasv7.StandardE96asV7", + "type": "string", + "value": "\"Standard_E96as_v7\"" + }, + { + "path": "StandardEav6.StandardE16asV6", + "type": "string", + "value": "\"Standard_E16as_v6\"" + }, + { + "path": "StandardEav6.StandardE20asV6", + "type": "string", + "value": "\"Standard_E20as_v6\"" + }, + { + "path": "StandardEav6.StandardE2asV6", + "type": "string", + "value": "\"Standard_E2as_v6\"" + }, + { + "path": "StandardEav6.StandardE32asV6", + "type": "string", + "value": "\"Standard_E32as_v6\"" + }, + { + "path": "StandardEav6.StandardE48asV6", + "type": "string", + "value": "\"Standard_E48as_v6\"" + }, + { + "path": "StandardEav6.StandardE4asV6", + "type": "string", + "value": "\"Standard_E4as_v6\"" + }, + { + "path": "StandardEav6.StandardE64asV6", + "type": "string", + "value": "\"Standard_E64as_v6\"" + }, + { + "path": "StandardEav6.StandardE8asV6", + "type": "string", + "value": "\"Standard_E8as_v6\"" + }, + { + "path": "StandardEav6.StandardE96asV6", + "type": "string", + "value": "\"Standard_E96as_v6\"" + }, + { + "path": "StandardEdsv6.StandardE12832dsV6", + "type": "string", + "value": "\"Standard_E128-32ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE12864dsV6", + "type": "string", + "value": "\"Standard_E128-64ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE128dsV6", + "type": "string", + "value": "\"Standard_E128ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE164dsV6", + "type": "string", + "value": "\"Standard_E16-4ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE168dsV6", + "type": "string", + "value": "\"Standard_E16-8ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE16dsV6", + "type": "string", + "value": "\"Standard_E16ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE192idsV6", + "type": "string", + "value": "\"Standard_E192ids_v6\"" + }, + { + "path": "StandardEdsv6.StandardE20dsV6", + "type": "string", + "value": "\"Standard_E20ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE2dsV6", + "type": "string", + "value": "\"Standard_E2ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE3216dsV6", + "type": "string", + "value": "\"Standard_E32-16ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE328dsV6", + "type": "string", + "value": "\"Standard_E32-8ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE32dsV6", + "type": "string", + "value": "\"Standard_E32ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE42dsV6", + "type": "string", + "value": "\"Standard_E4-2ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE48dsV6", + "type": "string", + "value": "\"Standard_E48ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE4dsV6", + "type": "string", + "value": "\"Standard_E4ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE6416dsV6", + "type": "string", + "value": "\"Standard_E64-16ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE6432dsV6", + "type": "string", + "value": "\"Standard_E64-32ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE64dsV6", + "type": "string", + "value": "\"Standard_E64ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE82dsV6", + "type": "string", + "value": "\"Standard_E8-2ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE84dsV6", + "type": "string", + "value": "\"Standard_E8-4ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE8dsV6", + "type": "string", + "value": "\"Standard_E8ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE9624dsV6", + "type": "string", + "value": "\"Standard_E96-24ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE9648dsV6", + "type": "string", + "value": "\"Standard_E96-48ds_v6\"" + }, + { + "path": "StandardEdsv6.StandardE96dsV6", + "type": "string", + "value": "\"Standard_E96ds_v6\"" + }, + { + "path": "StandardEdsv7.StandardE128dsV7", + "type": "string", + "value": "\"Standard_E128ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE16dsV7", + "type": "string", + "value": "\"Standard_E16ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE192dsV7", + "type": "string", + "value": "\"Standard_E192ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE20dsV7", + "type": "string", + "value": "\"Standard_E20ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE2dsV7", + "type": "string", + "value": "\"Standard_E2ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE32dsV7", + "type": "string", + "value": "\"Standard_E32ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE48dsV7", + "type": "string", + "value": "\"Standard_E48ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE4dsV7", + "type": "string", + "value": "\"Standard_E4ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE64dsV7", + "type": "string", + "value": "\"Standard_E64ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE8dsV7", + "type": "string", + "value": "\"Standard_E8ds_v7\"" + }, + { + "path": "StandardEdsv7.StandardE96dsV7", + "type": "string", + "value": "\"Standard_E96ds_v7\"" + }, + { + "path": "StandardEndv6.StandardE128ndsV6", + "type": "string", + "value": "\"Standard_E128nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE16ndsV6", + "type": "string", + "value": "\"Standard_E16nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE2ndsV6", + "type": "string", + "value": "\"Standard_E2nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE32ndsV6", + "type": "string", + "value": "\"Standard_E32nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE48ndsV6", + "type": "string", + "value": "\"Standard_E48nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE4ndsV6", + "type": "string", + "value": "\"Standard_E4nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE64ndsV6", + "type": "string", + "value": "\"Standard_E64nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE8ndsV6", + "type": "string", + "value": "\"Standard_E8nds_v6\"" + }, + { + "path": "StandardEndv6.StandardE96ndsV6", + "type": "string", + "value": "\"Standard_E96nds_v6\"" + }, + { + "path": "StandardEnv6.StandardE128nsV6", + "type": "string", + "value": "\"Standard_E128ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE16nsV6", + "type": "string", + "value": "\"Standard_E16ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE2nsV6", + "type": "string", + "value": "\"Standard_E2ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE32nsV6", + "type": "string", + "value": "\"Standard_E32ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE48nsV6", + "type": "string", + "value": "\"Standard_E48ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE4nsV6", + "type": "string", + "value": "\"Standard_E4ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE64nsV6", + "type": "string", + "value": "\"Standard_E64ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE8nsV6", + "type": "string", + "value": "\"Standard_E8ns_v6\"" + }, + { + "path": "StandardEnv6.StandardE96nsV6", + "type": "string", + "value": "\"Standard_E96ns_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE16pdsV6", + "type": "string", + "value": "\"Standard_E16pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE2pdsV6", + "type": "string", + "value": "\"Standard_E2pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE32pdsV6", + "type": "string", + "value": "\"Standard_E32pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE48pdsV6", + "type": "string", + "value": "\"Standard_E48pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE4pdsV6", + "type": "string", + "value": "\"Standard_E4pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE64pdsV6", + "type": "string", + "value": "\"Standard_E64pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE8pdsV6", + "type": "string", + "value": "\"Standard_E8pds_v6\"" + }, + { + "path": "StandardEpdsv6.StandardE96pdsV6", + "type": "string", + "value": "\"Standard_E96pds_v6\"" + }, + { + "path": "StandardEpsv6.StandardE16psV6", + "type": "string", + "value": "\"Standard_E16ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE2psV6", + "type": "string", + "value": "\"Standard_E2ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE32psV6", + "type": "string", + "value": "\"Standard_E32ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE48psV6", + "type": "string", + "value": "\"Standard_E48ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE4psV6", + "type": "string", + "value": "\"Standard_E4ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE64psV6", + "type": "string", + "value": "\"Standard_E64ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE8psV6", + "type": "string", + "value": "\"Standard_E8ps_v6\"" + }, + { + "path": "StandardEpsv6.StandardE96psV6", + "type": "string", + "value": "\"Standard_E96ps_v6\"" + }, + { + "path": "StandardEsv6.StandardE12832sV6", + "type": "string", + "value": "\"Standard_E128-32s_v6\"" + }, + { + "path": "StandardEsv6.StandardE12864sV6", + "type": "string", + "value": "\"Standard_E128-64s_v6\"" + }, + { + "path": "StandardEsv6.StandardE128sV6", + "type": "string", + "value": "\"Standard_E128s_v6\"" + }, + { + "path": "StandardEsv6.StandardE164sV6", + "type": "string", + "value": "\"Standard_E16-4s_v6\"" + }, + { + "path": "StandardEsv6.StandardE168sV6", + "type": "string", + "value": "\"Standard_E16-8s_v6\"" + }, + { + "path": "StandardEsv6.StandardE16sV6", + "type": "string", + "value": "\"Standard_E16s_v6\"" + }, + { + "path": "StandardEsv6.StandardE192isV6", + "type": "string", + "value": "\"Standard_E192is_v6\"" + }, + { + "path": "StandardEsv6.StandardE20sV6", + "type": "string", + "value": "\"Standard_E20s_v6\"" + }, + { + "path": "StandardEsv6.StandardE2sV6", + "type": "string", + "value": "\"Standard_E2s_v6\"" + }, + { + "path": "StandardEsv6.StandardE3216sV6", + "type": "string", + "value": "\"Standard_E32-16s_v6\"" + }, + { + "path": "StandardEsv6.StandardE328sV6", + "type": "string", + "value": "\"Standard_E32-8s_v6\"" + }, + { + "path": "StandardEsv6.StandardE32sV6", + "type": "string", + "value": "\"Standard_E32s_v6\"" + }, + { + "path": "StandardEsv6.StandardE42sV6", + "type": "string", + "value": "\"Standard_E4-2s_v6\"" + }, + { + "path": "StandardEsv6.StandardE48sV6", + "type": "string", + "value": "\"Standard_E48s_v6\"" + }, + { + "path": "StandardEsv6.StandardE4sV6", + "type": "string", + "value": "\"Standard_E4s_v6\"" + }, + { + "path": "StandardEsv6.StandardE6416sV6", + "type": "string", + "value": "\"Standard_E64-16s_v6\"" + }, + { + "path": "StandardEsv6.StandardE6432sV6", + "type": "string", + "value": "\"Standard_E64-32s_v6\"" + }, + { + "path": "StandardEsv6.StandardE64sV6", + "type": "string", + "value": "\"Standard_E64s_v6\"" + }, + { + "path": "StandardEsv6.StandardE82sV6", + "type": "string", + "value": "\"Standard_E8-2s_v6\"" + }, + { + "path": "StandardEsv6.StandardE84sV6", + "type": "string", + "value": "\"Standard_E8-4s_v6\"" + }, + { + "path": "StandardEsv6.StandardE8sV6", + "type": "string", + "value": "\"Standard_E8s_v6\"" + }, + { + "path": "StandardEsv6.StandardE9624sV6", + "type": "string", + "value": "\"Standard_E96-24s_v6\"" + }, + { + "path": "StandardEsv6.StandardE9648sV6", + "type": "string", + "value": "\"Standard_E96-48s_v6\"" + }, + { + "path": "StandardEsv6.StandardE96sV6", + "type": "string", + "value": "\"Standard_E96s_v6\"" + }, + { + "path": "StandardEsv7.StandardE128sV7", + "type": "string", + "value": "\"Standard_E128s_v7\"" + }, + { + "path": "StandardEsv7.StandardE16sV7", + "type": "string", + "value": "\"Standard_E16s_v7\"" + }, + { + "path": "StandardEsv7.StandardE192sV7", + "type": "string", + "value": "\"Standard_E192s_v7\"" + }, + { + "path": "StandardEsv7.StandardE20sV7", + "type": "string", + "value": "\"Standard_E20s_v7\"" + }, + { + "path": "StandardEsv7.StandardE2sV7", + "type": "string", + "value": "\"Standard_E2s_v7\"" + }, + { + "path": "StandardEsv7.StandardE32sV7", + "type": "string", + "value": "\"Standard_E32s_v7\"" + }, + { + "path": "StandardEsv7.StandardE48sV7", + "type": "string", + "value": "\"Standard_E48s_v7\"" + }, + { + "path": "StandardEsv7.StandardE4sV7", + "type": "string", + "value": "\"Standard_E4s_v7\"" + }, + { + "path": "StandardEsv7.StandardE64sV7", + "type": "string", + "value": "\"Standard_E64s_v7\"" + }, + { + "path": "StandardEsv7.StandardE8sV7", + "type": "string", + "value": "\"Standard_E8s_v7\"" + }, + { + "path": "StandardEsv7.StandardE96sV7", + "type": "string", + "value": "\"Standard_E96s_v7\"" + }, + { + "path": "StandardEv3.StandardE16V3", + "type": "string", + "value": "\"Standard_E16_v3\"" + }, + { + "path": "StandardEv3.StandardE20V3", + "type": "string", + "value": "\"Standard_E20_v3\"" + }, + { + "path": "StandardEv3.StandardE2V3", + "type": "string", + "value": "\"Standard_E2_v3\"" + }, + { + "path": "StandardEv3.StandardE32V3", + "type": "string", + "value": "\"Standard_E32_v3\"" + }, + { + "path": "StandardEv3.StandardE48V3", + "type": "string", + "value": "\"Standard_E48_v3\"" + }, + { + "path": "StandardEv3.StandardE4V3", + "type": "string", + "value": "\"Standard_E4_v3\"" + }, + { + "path": "StandardEv3.StandardE64V3", + "type": "string", + "value": "\"Standard_E64_v3\"" + }, + { + "path": "StandardEv3.StandardE8V3", + "type": "string", + "value": "\"Standard_E8_v3\"" + }, + { + "path": "StandardEv4.StandardE16V4", + "type": "string", + "value": "\"Standard_E16_v4\"" + }, + { + "path": "StandardEv4.StandardE20V4", + "type": "string", + "value": "\"Standard_E20_v4\"" + }, + { + "path": "StandardEv4.StandardE2V4", + "type": "string", + "value": "\"Standard_E2_v4\"" + }, + { + "path": "StandardEv4.StandardE32V4", + "type": "string", + "value": "\"Standard_E32_v4\"" + }, + { + "path": "StandardEv4.StandardE48V4", + "type": "string", + "value": "\"Standard_E48_v4\"" + }, + { + "path": "StandardEv4.StandardE4V4", + "type": "string", + "value": "\"Standard_E4_v4\"" + }, + { + "path": "StandardEv4.StandardE64V4", + "type": "string", + "value": "\"Standard_E64_v4\"" + }, + { + "path": "StandardEv4.StandardE8V4", + "type": "string", + "value": "\"Standard_E8_v4\"" + }, + { + "path": "StandardEv5.StandardE16V5", + "type": "string", + "value": "\"Standard_E16_v5\"" + }, + { + "path": "StandardEv5.StandardE20V5", + "type": "string", + "value": "\"Standard_E20_v5\"" + }, + { + "path": "StandardEv5.StandardE2V5", + "type": "string", + "value": "\"Standard_E2_v5\"" + }, + { + "path": "StandardEv5.StandardE32V5", + "type": "string", + "value": "\"Standard_E32_v5\"" + }, + { + "path": "StandardEv5.StandardE48V5", + "type": "string", + "value": "\"Standard_E48_v5\"" + }, + { + "path": "StandardEv5.StandardE4V5", + "type": "string", + "value": "\"Standard_E4_v5\"" + }, + { + "path": "StandardEv5.StandardE64V5", + "type": "string", + "value": "\"Standard_E64_v5\"" + }, + { + "path": "StandardEv5.StandardE8V5", + "type": "string", + "value": "\"Standard_E8_v5\"" + }, + { + "path": "StandardEv5.StandardE96V5", + "type": "string", + "value": "\"Standard_E96_v5\"" + }, + { + "path": "StandardF.StandardF16", + "type": "string", + "value": "\"Standard_F16\"" + }, + { + "path": "StandardF.StandardF2", + "type": "string", + "value": "\"Standard_F2\"" + }, + { + "path": "StandardF.StandardF4", + "type": "string", + "value": "\"Standard_F4\"" + }, + { + "path": "StandardF.StandardF8", + "type": "string", + "value": "\"Standard_F8\"" + }, + { + "path": "StandardFS.StandardF16s", + "type": "string", + "value": "\"Standard_F16s\"" + }, + { + "path": "StandardFS.StandardF2s", + "type": "string", + "value": "\"Standard_F2s\"" + }, + { + "path": "StandardFS.StandardF4s", + "type": "string", + "value": "\"Standard_F4s\"" + }, + { + "path": "StandardFS.StandardF8s", + "type": "string", + "value": "\"Standard_F8s\"" + }, + { + "path": "StandardFSv2.StandardF16sV2", + "type": "string", + "value": "\"Standard_F16s_v2\"" + }, + { + "path": "StandardFSv2.StandardF2sV2", + "type": "string", + "value": "\"Standard_F2s_v2\"" + }, + { + "path": "StandardFSv2.StandardF32sV2", + "type": "string", + "value": "\"Standard_F32s_v2\"" + }, + { + "path": "StandardFSv2.StandardF48sV2", + "type": "string", + "value": "\"Standard_F48s_v2\"" + }, + { + "path": "StandardFSv2.StandardF4sV2", + "type": "string", + "value": "\"Standard_F4s_v2\"" + }, + { + "path": "StandardFSv2.StandardF64sV2", + "type": "string", + "value": "\"Standard_F64s_v2\"" + }, + { + "path": "StandardFSv2.StandardF72sV2", + "type": "string", + "value": "\"Standard_F72s_v2\"" + }, + { + "path": "StandardFSv2.StandardF8sV2", + "type": "string", + "value": "\"Standard_F8s_v2\"" + }, + { + "path": "StandardFXMDVS.StandardFX12mds", + "type": "string", + "value": "\"Standard_FX12mds\"" + }, + { + "path": "StandardFXMDVS.StandardFX24mds", + "type": "string", + "value": "\"Standard_FX24mds\"" + }, + { + "path": "StandardFXMDVS.StandardFX36mds", + "type": "string", + "value": "\"Standard_FX36mds\"" + }, + { + "path": "StandardFXMDVS.StandardFX48mds", + "type": "string", + "value": "\"Standard_FX48mds\"" + }, + { + "path": "StandardFXMDVS.StandardFX4mds", + "type": "string", + "value": "\"Standard_FX4mds\"" + }, + { + "path": "StandardFXmdsv2.StandardFX126mdsV2", + "type": "string", + "value": "\"Standard_FX12-6mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX12mdsV2", + "type": "string", + "value": "\"Standard_FX12mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX164mdsV2", + "type": "string", + "value": "\"Standard_FX16-4mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX168mdsV2", + "type": "string", + "value": "\"Standard_FX16-8mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX16mdsV2", + "type": "string", + "value": "\"Standard_FX16mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX2412mdsV2", + "type": "string", + "value": "\"Standard_FX24-12mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX246mdsV2", + "type": "string", + "value": "\"Standard_FX24-6mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX24mdsV2", + "type": "string", + "value": "\"Standard_FX24mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX2mdsV2", + "type": "string", + "value": "\"Standard_FX2mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX3216mdsV2", + "type": "string", + "value": "\"Standard_FX32-16mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX328mdsV2", + "type": "string", + "value": "\"Standard_FX32-8mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX32mdsV2", + "type": "string", + "value": "\"Standard_FX32mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX42mdsV2", + "type": "string", + "value": "\"Standard_FX4-2mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX4812mdsV2", + "type": "string", + "value": "\"Standard_FX48-12mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX4824mdsV2", + "type": "string", + "value": "\"Standard_FX48-24mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX48mdsV2", + "type": "string", + "value": "\"Standard_FX48mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX4mdsV2", + "type": "string", + "value": "\"Standard_FX4mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX6416mdsV2", + "type": "string", + "value": "\"Standard_FX64-16mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX6432mdsV2", + "type": "string", + "value": "\"Standard_FX64-32mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX64mdsV2", + "type": "string", + "value": "\"Standard_FX64mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX82mdsV2", + "type": "string", + "value": "\"Standard_FX8-2mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX84mdsV2", + "type": "string", + "value": "\"Standard_FX8-4mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX8mdsV2", + "type": "string", + "value": "\"Standard_FX8mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX9624mdsV2", + "type": "string", + "value": "\"Standard_FX96-24mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX9648mdsV2", + "type": "string", + "value": "\"Standard_FX96-48mds_v2\"" + }, + { + "path": "StandardFXmdsv2.StandardFX96mdsV2", + "type": "string", + "value": "\"Standard_FX96mds_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX126msV2", + "type": "string", + "value": "\"Standard_FX12-6ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX12msV2", + "type": "string", + "value": "\"Standard_FX12ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX164msV2", + "type": "string", + "value": "\"Standard_FX16-4ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX168msV2", + "type": "string", + "value": "\"Standard_FX16-8ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX16msV2", + "type": "string", + "value": "\"Standard_FX16ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX2412msV2", + "type": "string", + "value": "\"Standard_FX24-12ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX246msV2", + "type": "string", + "value": "\"Standard_FX24-6ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX24msV2", + "type": "string", + "value": "\"Standard_FX24ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX2msV2", + "type": "string", + "value": "\"Standard_FX2ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX3216msV2", + "type": "string", + "value": "\"Standard_FX32-16ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX328msV2", + "type": "string", + "value": "\"Standard_FX32-8ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX32msV2", + "type": "string", + "value": "\"Standard_FX32ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX42msV2", + "type": "string", + "value": "\"Standard_FX4-2ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX4812msV2", + "type": "string", + "value": "\"Standard_FX48-12ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX4824msV2", + "type": "string", + "value": "\"Standard_FX48-24ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX48msV2", + "type": "string", + "value": "\"Standard_FX48ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX4msV2", + "type": "string", + "value": "\"Standard_FX4ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX6416msV2", + "type": "string", + "value": "\"Standard_FX64-16ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX6432msV2", + "type": "string", + "value": "\"Standard_FX64-32ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX64msV2", + "type": "string", + "value": "\"Standard_FX64ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX82msV2", + "type": "string", + "value": "\"Standard_FX8-2ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX84msV2", + "type": "string", + "value": "\"Standard_FX8-4ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX8msV2", + "type": "string", + "value": "\"Standard_FX8ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX9624msV2", + "type": "string", + "value": "\"Standard_FX96-24ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX9648msV2", + "type": "string", + "value": "\"Standard_FX96-48ms_v2\"" + }, + { + "path": "StandardFXmsv2.StandardFX96msV2", + "type": "string", + "value": "\"Standard_FX96ms_v2\"" + }, + { + "path": "StandardFadsv7.StandardF16adsV7", + "type": "string", + "value": "\"Standard_F16ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF2adsV7", + "type": "string", + "value": "\"Standard_F2ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF32adsV7", + "type": "string", + "value": "\"Standard_F32ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF48adsV7", + "type": "string", + "value": "\"Standard_F48ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF4adsV7", + "type": "string", + "value": "\"Standard_F4ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF64adsV7", + "type": "string", + "value": "\"Standard_F64ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF80adsV7", + "type": "string", + "value": "\"Standard_F80ads_v7\"" + }, + { + "path": "StandardFadsv7.StandardF8adsV7", + "type": "string", + "value": "\"Standard_F8ads_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF16aldsV7", + "type": "string", + "value": "\"Standard_F16alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF2aldsV7", + "type": "string", + "value": "\"Standard_F2alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF32aldsV7", + "type": "string", + "value": "\"Standard_F32alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF48aldsV7", + "type": "string", + "value": "\"Standard_F48alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF4aldsV7", + "type": "string", + "value": "\"Standard_F4alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF64aldsV7", + "type": "string", + "value": "\"Standard_F64alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF80aldsV7", + "type": "string", + "value": "\"Standard_F80alds_v7\"" + }, + { + "path": "StandardFaldsv7.StandardF8aldsV7", + "type": "string", + "value": "\"Standard_F8alds_v7\"" + }, + { + "path": "StandardFalsv6.StandardF16alsV6", + "type": "string", + "value": "\"Standard_F16als_v6\"" + }, + { + "path": "StandardFalsv6.StandardF2alsV6", + "type": "string", + "value": "\"Standard_F2als_v6\"" + }, + { + "path": "StandardFalsv6.StandardF32alsV6", + "type": "string", + "value": "\"Standard_F32als_v6\"" + }, + { + "path": "StandardFalsv6.StandardF48alsV6", + "type": "string", + "value": "\"Standard_F48als_v6\"" + }, + { + "path": "StandardFalsv6.StandardF4alsV6", + "type": "string", + "value": "\"Standard_F4als_v6\"" + }, + { + "path": "StandardFalsv6.StandardF64alsV6", + "type": "string", + "value": "\"Standard_F64als_v6\"" + }, + { + "path": "StandardFalsv6.StandardF8alsV6", + "type": "string", + "value": "\"Standard_F8als_v6\"" + }, + { + "path": "StandardFalsv7.StandardF16alsV7", + "type": "string", + "value": "\"Standard_F16als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF2alsV7", + "type": "string", + "value": "\"Standard_F2als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF32alsV7", + "type": "string", + "value": "\"Standard_F32als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF48alsV7", + "type": "string", + "value": "\"Standard_F48als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF4alsV7", + "type": "string", + "value": "\"Standard_F4als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF64alsV7", + "type": "string", + "value": "\"Standard_F64als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF80alsV7", + "type": "string", + "value": "\"Standard_F80als_v7\"" + }, + { + "path": "StandardFalsv7.StandardF8alsV7", + "type": "string", + "value": "\"Standard_F8als_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF164amdsV7", + "type": "string", + "value": "\"Standard_F16-4amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF168amdsV7", + "type": "string", + "value": "\"Standard_F16-8amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF16amdsV7", + "type": "string", + "value": "\"Standard_F16amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF21amdsV7", + "type": "string", + "value": "\"Standard_F2-1amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF2amdsV7", + "type": "string", + "value": "\"Standard_F2amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF3216amdsV7", + "type": "string", + "value": "\"Standard_F32-16amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF328amdsV7", + "type": "string", + "value": "\"Standard_F32-8amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF32amdsV7", + "type": "string", + "value": "\"Standard_F32amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF41amdsV7", + "type": "string", + "value": "\"Standard_F4-1amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF42amdsV7", + "type": "string", + "value": "\"Standard_F4-2amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF48amdsV7", + "type": "string", + "value": "\"Standard_F48amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF4amdsV7", + "type": "string", + "value": "\"Standard_F4amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF6416amdsV7", + "type": "string", + "value": "\"Standard_F64-16amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF6432amdsV7", + "type": "string", + "value": "\"Standard_F64-32amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF64amdsV7", + "type": "string", + "value": "\"Standard_F64amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF80amdsV7", + "type": "string", + "value": "\"Standard_F80amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF82amdsV7", + "type": "string", + "value": "\"Standard_F8-2amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF84amdsV7", + "type": "string", + "value": "\"Standard_F8-4amds_v7\"" + }, + { + "path": "StandardFamdsv7.StandardF8amdsV7", + "type": "string", + "value": "\"Standard_F8amds_v7\"" + }, + { + "path": "StandardFamsv6.StandardF16amsV6", + "type": "string", + "value": "\"Standard_F16ams_v6\"" + }, + { + "path": "StandardFamsv6.StandardF2amsV6", + "type": "string", + "value": "\"Standard_F2ams_v6\"" + }, + { + "path": "StandardFamsv6.StandardF32amsV6", + "type": "string", + "value": "\"Standard_F32ams_v6\"" + }, + { + "path": "StandardFamsv6.StandardF48amsV6", + "type": "string", + "value": "\"Standard_F48ams_v6\"" + }, + { + "path": "StandardFamsv6.StandardF4amsV6", + "type": "string", + "value": "\"Standard_F4ams_v6\"" + }, + { + "path": "StandardFamsv6.StandardF64amsV6", + "type": "string", + "value": "\"Standard_F64ams_v6\"" + }, + { + "path": "StandardFamsv6.StandardF8amsV6", + "type": "string", + "value": "\"Standard_F8ams_v6\"" + }, + { + "path": "StandardFamsv7.StandardF164amsV7", + "type": "string", + "value": "\"Standard_F16-4ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF168amsV7", + "type": "string", + "value": "\"Standard_F16-8ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF16amsV7", + "type": "string", + "value": "\"Standard_F16ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF21amsV7", + "type": "string", + "value": "\"Standard_F2-1ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF2amsV7", + "type": "string", + "value": "\"Standard_F2ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF3216amsV7", + "type": "string", + "value": "\"Standard_F32-16ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF328amsV7", + "type": "string", + "value": "\"Standard_F32-8ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF32amsV7", + "type": "string", + "value": "\"Standard_F32ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF41amsV7", + "type": "string", + "value": "\"Standard_F4-1ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF42amsV7", + "type": "string", + "value": "\"Standard_F4-2ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF48amsV7", + "type": "string", + "value": "\"Standard_F48ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF4amsV7", + "type": "string", + "value": "\"Standard_F4ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF6416amsV7", + "type": "string", + "value": "\"Standard_F64-16ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF6432amsV7", + "type": "string", + "value": "\"Standard_F64-32ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF64amsV7", + "type": "string", + "value": "\"Standard_F64ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF80amsV7", + "type": "string", + "value": "\"Standard_F80ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF82amsV7", + "type": "string", + "value": "\"Standard_F8-2ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF84amsV7", + "type": "string", + "value": "\"Standard_F8-4ams_v7\"" + }, + { + "path": "StandardFamsv7.StandardF8amsV7", + "type": "string", + "value": "\"Standard_F8ams_v7\"" + }, + { + "path": "StandardFasv6.StandardF16asV6", + "type": "string", + "value": "\"Standard_F16as_v6\"" + }, + { + "path": "StandardFasv6.StandardF2asV6", + "type": "string", + "value": "\"Standard_F2as_v6\"" + }, + { + "path": "StandardFasv6.StandardF32asV6", + "type": "string", + "value": "\"Standard_F32as_v6\"" + }, + { + "path": "StandardFasv6.StandardF48asV6", + "type": "string", + "value": "\"Standard_F48as_v6\"" + }, + { + "path": "StandardFasv6.StandardF4asV6", + "type": "string", + "value": "\"Standard_F4as_v6\"" + }, + { + "path": "StandardFasv6.StandardF64asV6", + "type": "string", + "value": "\"Standard_F64as_v6\"" + }, + { + "path": "StandardFasv6.StandardF8asV6", + "type": "string", + "value": "\"Standard_F8as_v6\"" + }, + { + "path": "StandardFasv7.StandardF16asV7", + "type": "string", + "value": "\"Standard_F16as_v7\"" + }, + { + "path": "StandardFasv7.StandardF2asV7", + "type": "string", + "value": "\"Standard_F2as_v7\"" + }, + { + "path": "StandardFasv7.StandardF32asV7", + "type": "string", + "value": "\"Standard_F32as_v7\"" + }, + { + "path": "StandardFasv7.StandardF48asV7", + "type": "string", + "value": "\"Standard_F48as_v7\"" + }, + { + "path": "StandardFasv7.StandardF4asV7", + "type": "string", + "value": "\"Standard_F4as_v7\"" + }, + { + "path": "StandardFasv7.StandardF64asV7", + "type": "string", + "value": "\"Standard_F64as_v7\"" + }, + { + "path": "StandardFasv7.StandardF80asV7", + "type": "string", + "value": "\"Standard_F80as_v7\"" + }, + { + "path": "StandardFasv7.StandardF8asV7", + "type": "string", + "value": "\"Standard_F8as_v7\"" + }, + { + "path": "StandardG.StandardG1", + "type": "string", + "value": "\"Standard_G1\"" + }, + { + "path": "StandardG.StandardG2", + "type": "string", + "value": "\"Standard_G2\"" + }, + { + "path": "StandardG.StandardG3", + "type": "string", + "value": "\"Standard_G3\"" + }, + { + "path": "StandardG.StandardG4", + "type": "string", + "value": "\"Standard_G4\"" + }, + { + "path": "StandardG.StandardG5", + "type": "string", + "value": "\"Standard_G5\"" + }, + { + "path": "StandardGS.StandardGS1", + "type": "string", + "value": "\"Standard_GS1\"" + }, + { + "path": "StandardGS.StandardGS2", + "type": "string", + "value": "\"Standard_GS2\"" + }, + { + "path": "StandardGS.StandardGS3", + "type": "string", + "value": "\"Standard_GS3\"" + }, + { + "path": "StandardGS.StandardGS4", + "type": "string", + "value": "\"Standard_GS4\"" + }, + { + "path": "StandardGS.StandardGS44", + "type": "string", + "value": "\"Standard_GS4-4\"" + }, + { + "path": "StandardGS.StandardGS48", + "type": "string", + "value": "\"Standard_GS4-8\"" + }, + { + "path": "StandardGS.StandardGS5", + "type": "string", + "value": "\"Standard_GS5\"" + }, + { + "path": "StandardGS.StandardGS516", + "type": "string", + "value": "\"Standard_GS5-16\"" + }, + { + "path": "StandardGS.StandardGS58", + "type": "string", + "value": "\"Standard_GS5-8\"" + }, + { + "path": "StandardHBrsv2.StandardHB12016rsV2", + "type": "string", + "value": "\"Standard_HB120-16rs_v2\"" + }, + { + "path": "StandardHBrsv2.StandardHB12032rsV2", + "type": "string", + "value": "\"Standard_HB120-32rs_v2\"" + }, + { + "path": "StandardHBrsv2.StandardHB12064rsV2", + "type": "string", + "value": "\"Standard_HB120-64rs_v2\"" + }, + { + "path": "StandardHBrsv2.StandardHB12096rsV2", + "type": "string", + "value": "\"Standard_HB120-96rs_v2\"" + }, + { + "path": "StandardHBrsv2.StandardHB120rsV2", + "type": "string", + "value": "\"Standard_HB120rs_v2\"" + }, + { + "path": "StandardHBv3.StandardHB12016rsV3", + "type": "string", + "value": "\"Standard_HB120-16rs_v3\"" + }, + { + "path": "StandardHBv3.StandardHB12032rsV3", + "type": "string", + "value": "\"Standard_HB120-32rs_v3\"" + }, + { + "path": "StandardHBv3.StandardHB12064rsV3", + "type": "string", + "value": "\"Standard_HB120-64rs_v3\"" + }, + { + "path": "StandardHBv3.StandardHB12096rsV3", + "type": "string", + "value": "\"Standard_HB120-96rs_v3\"" + }, + { + "path": "StandardHBv3.StandardHB120rsV3", + "type": "string", + "value": "\"Standard_HB120rs_v3\"" + }, + { + "path": "StandardHBv4.StandardHB176144rsV4", + "type": "string", + "value": "\"Standard_HB176-144rs_v4\"" + }, + { + "path": "StandardHBv4.StandardHB17624rsV4", + "type": "string", + "value": "\"Standard_HB176-24rs_v4\"" + }, + { + "path": "StandardHBv4.StandardHB17648rsV4", + "type": "string", + "value": "\"Standard_HB176-48rs_v4\"" + }, + { + "path": "StandardHBv4.StandardHB17696rsV4", + "type": "string", + "value": "\"Standard_HB176-96rs_v4\"" + }, + { + "path": "StandardHBv4.StandardHB176rsV4", + "type": "string", + "value": "\"Standard_HB176rs_v4\"" + }, + { + "path": "StandardHBv5.StandardHB368144rsV5", + "type": "string", + "value": "\"Standard_HB368-144rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB368192rsV5", + "type": "string", + "value": "\"Standard_HB368-192rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB368240rsV5", + "type": "string", + "value": "\"Standard_HB368-240rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB368288rsV5", + "type": "string", + "value": "\"Standard_HB368-288rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB368336rsV5", + "type": "string", + "value": "\"Standard_HB368-336rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB36848rsV5", + "type": "string", + "value": "\"Standard_HB368-48rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB36896rsV5", + "type": "string", + "value": "\"Standard_HB368-96rs_v5\"" + }, + { + "path": "StandardHBv5.StandardHB368rsV5", + "type": "string", + "value": "\"Standard_HB368rs_v5\"" + }, + { + "path": "StandardHCS.StandardHC4416rs", + "type": "string", + "value": "\"Standard_HC44-16rs\"" + }, + { + "path": "StandardHCS.StandardHC4432rs", + "type": "string", + "value": "\"Standard_HC44-32rs\"" + }, + { + "path": "StandardHCS.StandardHC44rs", + "type": "string", + "value": "\"Standard_HC44rs\"" + }, + { + "path": "StandardHX.StandardHX176144rs", + "type": "string", + "value": "\"Standard_HX176-144rs\"" + }, + { + "path": "StandardHX.StandardHX17624rs", + "type": "string", + "value": "\"Standard_HX176-24rs\"" + }, + { + "path": "StandardHX.StandardHX17648rs", + "type": "string", + "value": "\"Standard_HX176-48rs\"" + }, + { + "path": "StandardHX.StandardHX17696rs", + "type": "string", + "value": "\"Standard_HX176-96rs\"" + }, + { + "path": "StandardHX.StandardHX176rs", + "type": "string", + "value": "\"Standard_HX176rs\"" + }, + { + "path": "StandardLASv3.StandardL16asV3", + "type": "string", + "value": "\"Standard_L16as_v3\"" + }, + { + "path": "StandardLASv3.StandardL32asV3", + "type": "string", + "value": "\"Standard_L32as_v3\"" + }, + { + "path": "StandardLASv3.StandardL48asV3", + "type": "string", + "value": "\"Standard_L48as_v3\"" + }, + { + "path": "StandardLASv3.StandardL64asV3", + "type": "string", + "value": "\"Standard_L64as_v3\"" + }, + { + "path": "StandardLASv3.StandardL80asV3", + "type": "string", + "value": "\"Standard_L80as_v3\"" + }, + { + "path": "StandardLASv3.StandardL8asV3", + "type": "string", + "value": "\"Standard_L8as_v3\"" + }, + { + "path": "StandardLS.StandardL16s", + "type": "string", + "value": "\"Standard_L16s\"" + }, + { + "path": "StandardLS.StandardL32s", + "type": "string", + "value": "\"Standard_L32s\"" + }, + { + "path": "StandardLS.StandardL4s", + "type": "string", + "value": "\"Standard_L4s\"" + }, + { + "path": "StandardLS.StandardL8s", + "type": "string", + "value": "\"Standard_L8s\"" + }, + { + "path": "StandardLSv2.StandardL16sV2", + "type": "string", + "value": "\"Standard_L16s_v2\"" + }, + { + "path": "StandardLSv2.StandardL32sV2", + "type": "string", + "value": "\"Standard_L32s_v2\"" + }, + { + "path": "StandardLSv2.StandardL48sV2", + "type": "string", + "value": "\"Standard_L48s_v2\"" + }, + { + "path": "StandardLSv2.StandardL64sV2", + "type": "string", + "value": "\"Standard_L64s_v2\"" + }, + { + "path": "StandardLSv2.StandardL80sV2", + "type": "string", + "value": "\"Standard_L80s_v2\"" + }, + { + "path": "StandardLSv2.StandardL8sV2", + "type": "string", + "value": "\"Standard_L8s_v2\"" + }, + { + "path": "StandardLSv3.StandardL16sV3", + "type": "string", + "value": "\"Standard_L16s_v3\"" + }, + { + "path": "StandardLSv3.StandardL32sV3", + "type": "string", + "value": "\"Standard_L32s_v3\"" + }, + { + "path": "StandardLSv3.StandardL48sV3", + "type": "string", + "value": "\"Standard_L48s_v3\"" + }, + { + "path": "StandardLSv3.StandardL64sV3", + "type": "string", + "value": "\"Standard_L64s_v3\"" + }, + { + "path": "StandardLSv3.StandardL80sV3", + "type": "string", + "value": "\"Standard_L80s_v3\"" + }, + { + "path": "StandardLSv3.StandardL8sV3", + "type": "string", + "value": "\"Standard_L8s_v3\"" + }, + { + "path": "StandardLaosv4.StandardL12aosV4", + "type": "string", + "value": "\"Standard_L12aos_v4\"" + }, + { + "path": "StandardLaosv4.StandardL16aosV4", + "type": "string", + "value": "\"Standard_L16aos_v4\"" + }, + { + "path": "StandardLaosv4.StandardL24aosV4", + "type": "string", + "value": "\"Standard_L24aos_v4\"" + }, + { + "path": "StandardLaosv4.StandardL2aosV4", + "type": "string", + "value": "\"Standard_L2aos_v4\"" + }, + { + "path": "StandardLaosv4.StandardL32aosV4", + "type": "string", + "value": "\"Standard_L32aos_v4\"" + }, + { + "path": "StandardLaosv4.StandardL4aosV4", + "type": "string", + "value": "\"Standard_L4aos_v4\"" + }, + { + "path": "StandardLaosv4.StandardL8aosV4", + "type": "string", + "value": "\"Standard_L8aos_v4\"" + }, + { + "path": "StandardLasv4.StandardL16asV4", + "type": "string", + "value": "\"Standard_L16as_v4\"" + }, + { + "path": "StandardLasv4.StandardL2asV4", + "type": "string", + "value": "\"Standard_L2as_v4\"" + }, + { + "path": "StandardLasv4.StandardL32asV4", + "type": "string", + "value": "\"Standard_L32as_v4\"" + }, + { + "path": "StandardLasv4.StandardL48asV4", + "type": "string", + "value": "\"Standard_L48as_v4\"" + }, + { + "path": "StandardLasv4.StandardL4asV4", + "type": "string", + "value": "\"Standard_L4as_v4\"" + }, + { + "path": "StandardLasv4.StandardL64asV4", + "type": "string", + "value": "\"Standard_L64as_v4\"" + }, + { + "path": "StandardLasv4.StandardL80asV4", + "type": "string", + "value": "\"Standard_L80as_v4\"" + }, + { + "path": "StandardLasv4.StandardL8asV4", + "type": "string", + "value": "\"Standard_L8as_v4\"" + }, + { + "path": "StandardLasv4.StandardL96asV4", + "type": "string", + "value": "\"Standard_L96as_v4\"" + }, + { + "path": "StandardLsv4.StandardL16sV4", + "type": "string", + "value": "\"Standard_L16s_v4\"" + }, + { + "path": "StandardLsv4.StandardL2sV4", + "type": "string", + "value": "\"Standard_L2s_v4\"" + }, + { + "path": "StandardLsv4.StandardL32sV4", + "type": "string", + "value": "\"Standard_L32s_v4\"" + }, + { + "path": "StandardLsv4.StandardL48sV4", + "type": "string", + "value": "\"Standard_L48s_v4\"" + }, + { + "path": "StandardLsv4.StandardL4sV4", + "type": "string", + "value": "\"Standard_L4s_v4\"" + }, + { + "path": "StandardLsv4.StandardL64sV4", + "type": "string", + "value": "\"Standard_L64s_v4\"" + }, + { + "path": "StandardLsv4.StandardL80sV4", + "type": "string", + "value": "\"Standard_L80s_v4\"" + }, + { + "path": "StandardLsv4.StandardL8sV4", + "type": "string", + "value": "\"Standard_L8s_v4\"" + }, + { + "path": "StandardLsv4.StandardL96sV4", + "type": "string", + "value": "\"Standard_L96s_v4\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM12864bds3V3", + "type": "string", + "value": "\"Standard_M128-64bds_3_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM12864bdsV3", + "type": "string", + "value": "\"Standard_M128-64bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM128bds3V3", + "type": "string", + "value": "\"Standard_M128bds_3_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM128bdsV3", + "type": "string", + "value": "\"Standard_M128bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM16bdsV3", + "type": "string", + "value": "\"Standard_M16bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM17688bds4V3", + "type": "string", + "value": "\"Standard_M176-88bds_4_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM17688bdsV3", + "type": "string", + "value": "\"Standard_M176-88bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM176bds4V3", + "type": "string", + "value": "\"Standard_M176bds_4_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM176bdsV3", + "type": "string", + "value": "\"Standard_M176bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM32bdsV3", + "type": "string", + "value": "\"Standard_M32bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM48bdsV3", + "type": "string", + "value": "\"Standard_M48bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM6432bds1V3", + "type": "string", + "value": "\"Standard_M64-32bds_1_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM64bds1V3", + "type": "string", + "value": "\"Standard_M64bds_1_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM64bdsV3", + "type": "string", + "value": "\"Standard_M64bds_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM9648bds2V3", + "type": "string", + "value": "\"Standard_M96-48bds_2_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM96bds2V3", + "type": "string", + "value": "\"Standard_M96bds_2_v3\"" + }, + { + "path": "StandardMBDSMediumMemoryv3.StandardM96bdsV3", + "type": "string", + "value": "\"Standard_M96bds_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM12864bsV3", + "type": "string", + "value": "\"Standard_M128-64bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM128bsV3", + "type": "string", + "value": "\"Standard_M128bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM16bsV3", + "type": "string", + "value": "\"Standard_M16bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM17688bsV3", + "type": "string", + "value": "\"Standard_M176-88bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM176bsV3", + "type": "string", + "value": "\"Standard_M176bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM32bsV3", + "type": "string", + "value": "\"Standard_M32bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM416bsV3", + "type": "string", + "value": "\"Standard_M416bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM48bsV3", + "type": "string", + "value": "\"Standard_M48bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM64bsV3", + "type": "string", + "value": "\"Standard_M64bs_v3\"" + }, + { + "path": "StandardMBSMediumMemoryv3.StandardM96bsV3", + "type": "string", + "value": "\"Standard_M96bs_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM416ds10V3", + "type": "string", + "value": "\"Standard_M416ds_10_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM416ds12V3", + "type": "string", + "value": "\"Standard_M416ds_12_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM416ds6V3", + "type": "string", + "value": "\"Standard_M416ds_6_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM416ds8V3", + "type": "string", + "value": "\"Standard_M416ds_8_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM416ds9V3", + "type": "string", + "value": "\"Standard_M416ds_9_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM624ds12V3", + "type": "string", + "value": "\"Standard_M624ds_12_v3\"" + }, + { + "path": "StandardMDSHighMemoryv3.StandardM832ds12V3", + "type": "string", + "value": "\"Standard_M832ds_12_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv2.StandardM128dmsV2", + "type": "string", + "value": "\"Standard_M128dms_v2\"" + }, + { + "path": "StandardMDSMediumMemoryv2.StandardM128dsV2", + "type": "string", + "value": "\"Standard_M128ds_v2\"" + }, + { + "path": "StandardMDSMediumMemoryv2.StandardM32dmsV2", + "type": "string", + "value": "\"Standard_M32dms_v2\"" + }, + { + "path": "StandardMDSMediumMemoryv2.StandardM64dmsV2", + "type": "string", + "value": "\"Standard_M64dms_v2\"" + }, + { + "path": "StandardMDSMediumMemoryv2.StandardM64dsV2", + "type": "string", + "value": "\"Standard_M64ds_v2\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM12dsV3", + "type": "string", + "value": "\"Standard_M12ds_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM176ds3V3", + "type": "string", + "value": "\"Standard_M176ds_3_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM176ds4V3", + "type": "string", + "value": "\"Standard_M176ds_4_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM24dsV3", + "type": "string", + "value": "\"Standard_M24ds_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM48ds1V3", + "type": "string", + "value": "\"Standard_M48ds_1_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM96ds1V3", + "type": "string", + "value": "\"Standard_M96ds_1_v3\"" + }, + { + "path": "StandardMDSMediumMemoryv3.StandardM96ds2V3", + "type": "string", + "value": "\"Standard_M96ds_2_v3\"" + }, + { + "path": "StandardMIDSHighMemoryv3.StandardM832ids16V3", + "type": "string", + "value": "\"Standard_M832ids_16_v3\"" + }, + { + "path": "StandardMIDSMediumMemoryv2.StandardM192idmsV2", + "type": "string", + "value": "\"Standard_M192idms_v2\"" + }, + { + "path": "StandardMIDSMediumMemoryv2.StandardM192idsV2", + "type": "string", + "value": "\"Standard_M192ids_v2\"" + }, + { + "path": "StandardMISHighMemoryv3.StandardM832is16V3", + "type": "string", + "value": "\"Standard_M832is_16_v3\"" + }, + { + "path": "StandardMISMediumMemoryv2.StandardM192imsV2", + "type": "string", + "value": "\"Standard_M192ims_v2\"" + }, + { + "path": "StandardMISMediumMemoryv2.StandardM192isV2", + "type": "string", + "value": "\"Standard_M192is_v2\"" + }, + { + "path": "StandardMS.StandardM128", + "type": "string", + "value": "\"Standard_M128\"" + }, + { + "path": "StandardMS.StandardM12832ms", + "type": "string", + "value": "\"Standard_M128-32ms\"" + }, + { + "path": "StandardMS.StandardM12864ms", + "type": "string", + "value": "\"Standard_M128-64ms\"" + }, + { + "path": "StandardMS.StandardM128m", + "type": "string", + "value": "\"Standard_M128m\"" + }, + { + "path": "StandardMS.StandardM128ms", + "type": "string", + "value": "\"Standard_M128ms\"" + }, + { + "path": "StandardMS.StandardM128s", + "type": "string", + "value": "\"Standard_M128s\"" + }, + { + "path": "StandardMS.StandardM164ms", + "type": "string", + "value": "\"Standard_M16-4ms\"" + }, + { + "path": "StandardMS.StandardM168ms", + "type": "string", + "value": "\"Standard_M16-8ms\"" + }, + { + "path": "StandardMS.StandardM16ms", + "type": "string", + "value": "\"Standard_M16ms\"" + }, + { + "path": "StandardMS.StandardM3216ms", + "type": "string", + "value": "\"Standard_M32-16ms\"" + }, + { + "path": "StandardMS.StandardM328ms", + "type": "string", + "value": "\"Standard_M32-8ms\"" + }, + { + "path": "StandardMS.StandardM32ls", + "type": "string", + "value": "\"Standard_M32ls\"" + }, + { + "path": "StandardMS.StandardM32ms", + "type": "string", + "value": "\"Standard_M32ms\"" + }, + { + "path": "StandardMS.StandardM32ts", + "type": "string", + "value": "\"Standard_M32ts\"" + }, + { + "path": "StandardMS.StandardM64", + "type": "string", + "value": "\"Standard_M64\"" + }, + { + "path": "StandardMS.StandardM6416ms", + "type": "string", + "value": "\"Standard_M64-16ms\"" + }, + { + "path": "StandardMS.StandardM6432ms", + "type": "string", + "value": "\"Standard_M64-32ms\"" + }, + { + "path": "StandardMS.StandardM64ls", + "type": "string", + "value": "\"Standard_M64ls\"" + }, + { + "path": "StandardMS.StandardM64m", + "type": "string", + "value": "\"Standard_M64m\"" + }, + { + "path": "StandardMS.StandardM64ms", + "type": "string", + "value": "\"Standard_M64ms\"" + }, + { + "path": "StandardMS.StandardM64s", + "type": "string", + "value": "\"Standard_M64s\"" + }, + { + "path": "StandardMS.StandardM82ms", + "type": "string", + "value": "\"Standard_M8-2ms\"" + }, + { + "path": "StandardMS.StandardM84ms", + "type": "string", + "value": "\"Standard_M8-4ms\"" + }, + { + "path": "StandardMS.StandardM8ms", + "type": "string", + "value": "\"Standard_M8ms\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM416s10V3", + "type": "string", + "value": "\"Standard_M416s_10_v3\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM416s12V3", + "type": "string", + "value": "\"Standard_M416s_12_v3\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM416s6V3", + "type": "string", + "value": "\"Standard_M416s_6_v3\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM416s8V3", + "type": "string", + "value": "\"Standard_M416s_8_v3\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM416s9V3", + "type": "string", + "value": "\"Standard_M416s_9_v3\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM624s12V3", + "type": "string", + "value": "\"Standard_M624s_12_v3\"" + }, + { + "path": "StandardMSHighMemoryv3.StandardM832s12V3", + "type": "string", + "value": "\"Standard_M832s_12_v3\"" + }, + { + "path": "StandardMSMediumMemoryv2.StandardM128msV2", + "type": "string", + "value": "\"Standard_M128ms_v2\"" + }, + { + "path": "StandardMSMediumMemoryv2.StandardM128sV2", + "type": "string", + "value": "\"Standard_M128s_v2\"" + }, + { + "path": "StandardMSMediumMemoryv2.StandardM32msV2", + "type": "string", + "value": "\"Standard_M32ms_v2\"" + }, + { + "path": "StandardMSMediumMemoryv2.StandardM64msV2", + "type": "string", + "value": "\"Standard_M64ms_v2\"" + }, + { + "path": "StandardMSMediumMemoryv2.StandardM64sV2", + "type": "string", + "value": "\"Standard_M64s_v2\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM12sV3", + "type": "string", + "value": "\"Standard_M12s_v3\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM176s3V3", + "type": "string", + "value": "\"Standard_M176s_3_v3\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM176s4V3", + "type": "string", + "value": "\"Standard_M176s_4_v3\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM24sV3", + "type": "string", + "value": "\"Standard_M24s_v3\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM48s1V3", + "type": "string", + "value": "\"Standard_M48s_1_v3\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM96s1V3", + "type": "string", + "value": "\"Standard_M96s_1_v3\"" + }, + { + "path": "StandardMSMediumMemoryv3.StandardM96s2V3", + "type": "string", + "value": "\"Standard_M96s_2_v3\"" + }, + { + "path": "StandardMSv2.StandardM208msV2", + "type": "string", + "value": "\"Standard_M208ms_v2\"" + }, + { + "path": "StandardMSv2.StandardM208sV2", + "type": "string", + "value": "\"Standard_M208s_v2\"" + }, + { + "path": "StandardMSv2.StandardM416208msV2", + "type": "string", + "value": "\"Standard_M416-208ms_v2\"" + }, + { + "path": "StandardMSv2.StandardM416208sV2", + "type": "string", + "value": "\"Standard_M416-208s_v2\"" + }, + { + "path": "StandardMSv2.StandardM416msV2", + "type": "string", + "value": "\"Standard_M416ms_v2\"" + }, + { + "path": "StandardMSv2.StandardM416s10V2", + "type": "string", + "value": "\"Standard_M416s_10_v2\"" + }, + { + "path": "StandardMSv2.StandardM416s8V2", + "type": "string", + "value": "\"Standard_M416s_8_v2\"" + }, + { + "path": "StandardMSv2.StandardM416s9V2", + "type": "string", + "value": "\"Standard_M416s_9_v2\"" + }, + { + "path": "StandardMSv2.StandardM416sV2", + "type": "string", + "value": "\"Standard_M416s_v2\"" + }, + { + "path": "StandardNCADSA100v4.StandardNC24adsA100V4", + "type": "string", + "value": "\"Standard_NC24ads_A100_v4\"" + }, + { + "path": "StandardNCADSA100v4.StandardNC48adsA100V4", + "type": "string", + "value": "\"Standard_NC48ads_A100_v4\"" + }, + { + "path": "StandardNCADSA100v4.StandardNC96adsA100V4", + "type": "string", + "value": "\"Standard_NC96ads_A100_v4\"" + }, + { + "path": "StandardNCADSA10v4.StandardNC16adsA10V4", + "type": "string", + "value": "\"Standard_NC16ads_A10_v4\"" + }, + { + "path": "StandardNCADSA10v4.StandardNC32adsA10V4", + "type": "string", + "value": "\"Standard_NC32ads_A10_v4\"" + }, + { + "path": "StandardNCADSA10v4.StandardNC8adsA10V4", + "type": "string", + "value": "\"Standard_NC8ads_A10_v4\"" + }, + { + "path": "StandardNCASv3T4.StandardNC16asT4V3", + "type": "string", + "value": "\"Standard_NC16as_T4_v3\"" + }, + { + "path": "StandardNCASv3T4.StandardNC4asT4V3", + "type": "string", + "value": "\"Standard_NC4as_T4_v3\"" + }, + { + "path": "StandardNCASv3T4.StandardNC64asT4V3", + "type": "string", + "value": "\"Standard_NC64as_T4_v3\"" + }, + { + "path": "StandardNCASv3T4.StandardNC8asT4V3", + "type": "string", + "value": "\"Standard_NC8as_T4_v3\"" + }, + { + "path": "StandardNCCads2023.StandardNCC40adsH100V5", + "type": "string", + "value": "\"Standard_NCC40ads_H100_v5\"" + }, + { + "path": "StandardNCSv3.StandardNC12sV3", + "type": "string", + "value": "\"Standard_NC12s_v3\"" + }, + { + "path": "StandardNCSv3.StandardNC24rsV3", + "type": "string", + "value": "\"Standard_NC24rs_v3\"" + }, + { + "path": "StandardNCSv3.StandardNC24sV3", + "type": "string", + "value": "\"Standard_NC24s_v3\"" + }, + { + "path": "StandardNCSv3.StandardNC6sV3", + "type": "string", + "value": "\"Standard_NC6s_v3\"" + }, + { + "path": "StandardNCadsH100v5.StandardNC40adsH100V5", + "type": "string", + "value": "\"Standard_NC40ads_H100_v5\"" + }, + { + "path": "StandardNCadsH100v5.StandardNC80adisH100V5", + "type": "string", + "value": "\"Standard_NC80adis_H100_v5\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC144dsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC144ds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC144ldsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC144lds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC24ldsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC24lds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC288dsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC288ds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC288ldsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC288lds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC36dsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC36ds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC36ldsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC36lds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC72dsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC72ds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNCdsRTXPRO6000BSEv6XL.StandardNC72ldsXlRTXPRO6000BSEV6", + "type": "string", + "value": "\"Standard_NC72lds_xl_RTXPRO6000BSE_v6\"" + }, + { + "path": "StandardNDAMSv4A100.StandardND96amsrA100V4", + "type": "string", + "value": "\"Standard_ND96amsr_A100_v4\"" + }, + { + "path": "StandardNDASv4A100.StandardND96asrV4", + "type": "string", + "value": "\"Standard_ND96asr_v4\"" + }, + { + "path": "StandardNDISRGB200V6NDR.StandardND128isrNDRGB200V6", + "type": "string", + "value": "\"Standard_ND128isr_NDR_GB200_v6\"" + }, + { + "path": "StandardNDISRGB300V6.StandardND128isrGB300V6", + "type": "string", + "value": "\"Standard_ND128isr_GB300_v6\"" + }, + { + "path": "StandardNDISRH200V5.StandardND96isrH200V5", + "type": "string", + "value": "\"Standard_ND96isr_H200_v5\"" + }, + { + "path": "StandardNDISv5MI300X.StandardND96isMI300XV5", + "type": "string", + "value": "\"Standard_ND96is_MI300X_v5\"" + }, + { + "path": "StandardNDISv5MI300X.StandardND96isrMI300XV5", + "type": "string", + "value": "\"Standard_ND96isr_MI300X_v5\"" + }, + { + "path": "StandardNDSH100v5.StandardND96isrH100V5", + "type": "string", + "value": "\"Standard_ND96isr_H100_v5\"" + }, + { + "path": "StandardNDSv2.StandardND40rsV2", + "type": "string", + "value": "\"Standard_ND40rs_v2\"" + }, + { + "path": "StandardNGADSV620v1.StandardNG16adsV620V1", + "type": "string", + "value": "\"Standard_NG16ads_V620_v1\"" + }, + { + "path": "StandardNGADSV620v1.StandardNG32admsV620V1", + "type": "string", + "value": "\"Standard_NG32adms_V620_v1\"" + }, + { + "path": "StandardNGADSV620v1.StandardNG32adsV620V1", + "type": "string", + "value": "\"Standard_NG32ads_V620_v1\"" + }, + { + "path": "StandardNGADSV620v1.StandardNG8adsV620V1", + "type": "string", + "value": "\"Standard_NG8ads_V620_v1\"" + }, + { + "path": "StandardNPS.StandardNP10s", + "type": "string", + "value": "\"Standard_NP10s\"" + }, + { + "path": "StandardNPS.StandardNP20s", + "type": "string", + "value": "\"Standard_NP20s\"" + }, + { + "path": "StandardNPS.StandardNP40s", + "type": "string", + "value": "\"Standard_NP40s\"" + }, + { + "path": "StandardNVADSA10v5.StandardNV12adsA10V5", + "type": "string", + "value": "\"Standard_NV12ads_A10_v5\"" + }, + { + "path": "StandardNVADSA10v5.StandardNV18adsA10V5", + "type": "string", + "value": "\"Standard_NV18ads_A10_v5\"" + }, + { + "path": "StandardNVADSA10v5.StandardNV36admsA10V5", + "type": "string", + "value": "\"Standard_NV36adms_A10_v5\"" + }, + { + "path": "StandardNVADSA10v5.StandardNV36adsA10V5", + "type": "string", + "value": "\"Standard_NV36ads_A10_v5\"" + }, + { + "path": "StandardNVADSA10v5.StandardNV6adsA10V5", + "type": "string", + "value": "\"Standard_NV6ads_A10_v5\"" + }, + { + "path": "StandardNVADSA10v5.StandardNV72adsA10V5", + "type": "string", + "value": "\"Standard_NV72ads_A10_v5\"" + }, + { + "path": "StandardNVSv2.StandardNV12sV2", + "type": "string", + "value": "\"Standard_NV12s_v2\"" + }, + { + "path": "StandardNVSv2.StandardNV24sV2", + "type": "string", + "value": "\"Standard_NV24s_v2\"" + }, + { + "path": "StandardNVSv2.StandardNV6sV2", + "type": "string", + "value": "\"Standard_NV6s_v2\"" + }, + { + "path": "StandardNVSv3.StandardNV12sV3", + "type": "string", + "value": "\"Standard_NV12s_v3\"" + }, + { + "path": "StandardNVSv3.StandardNV24sV3", + "type": "string", + "value": "\"Standard_NV24s_v3\"" + }, + { + "path": "StandardNVSv3.StandardNV48sV3", + "type": "string", + "value": "\"Standard_NV48s_v3\"" + }, + { + "path": "StandardNVSv4.StandardNV16asV4", + "type": "string", + "value": "\"Standard_NV16as_v4\"" + }, + { + "path": "StandardNVSv4.StandardNV32asV4", + "type": "string", + "value": "\"Standard_NV32as_v4\"" + }, + { + "path": "StandardNVSv4.StandardNV4asV4", + "type": "string", + "value": "\"Standard_NV4as_v4\"" + }, + { + "path": "StandardNVSv4.StandardNV8asV4", + "type": "string", + "value": "\"Standard_NV8as_v4\"" + }, + { + "path": "StandardNVadsV710v5.StandardNV12adsV710V5", + "type": "string", + "value": "\"Standard_NV12ads_V710_v5\"" + }, + { + "path": "StandardNVadsV710v5.StandardNV24adsV710V5", + "type": "string", + "value": "\"Standard_NV24ads_V710_v5\"" + }, + { + "path": "StandardNVadsV710v5.StandardNV28admsV710V5", + "type": "string", + "value": "\"Standard_NV28adms_V710_v5\"" + }, + { + "path": "StandardNVadsV710v5.StandardNV4adsV710V5", + "type": "string", + "value": "\"Standard_NV4ads_V710_v5\"" + }, + { + "path": "StandardNVadsV710v5.StandardNV8adsV710V5", + "type": "string", + "value": "\"Standard_NV8ads_V710_v5\"" + }, + { + "path": "StandardPBS.StandardPB6s", + "type": "string", + "value": "\"Standard_PB6s\"" + }, + { + "path": "StandardXEIDSv4.StandardE80idsV4", + "type": "string", + "value": "\"Standard_E80ids_v4\"" + }, + { + "path": "StandardXEISv4.StandardE80isV4", + "type": "string", + "value": "\"Standard_E80is_v4\"" + } + ] + } + ] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Kusto.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Kusto.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..6e1b99f835 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Kusto.13.6.0-preview.1.26478.8.json @@ -0,0 +1,704 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Kusto", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ClusterUri", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.clusterUri", + "qualifiedName": "AzureKustoClusterResource.clusterUri", + "description": "Gets the cluster URI output reference for the Azure Kusto cluster.", + "kind": "PropertyGetter", + "signature": "ClusterUri() BicepOutputReference", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.connectionStringExpression", + "qualifiedName": "AzureKustoClusterResource.connectionStringExpression", + "description": "Gets the ConnectionStringExpression property", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "IsEmulator", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.isEmulator", + "qualifiedName": "AzureKustoClusterResource.isEmulator", + "description": "Gets whether the resource is running the local emulator.", + "kind": "PropertyGetter", + "signature": "IsEmulator() (bool, error)", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "NameOutputReference", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.nameOutputReference", + "qualifiedName": "AzureKustoClusterResource.nameOutputReference", + "description": "Gets the \"name\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "NameOutputReference() BicepOutputReference", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.uriExpression", + "qualifiedName": "AzureKustoClusterResource.uriExpression", + "description": "Gets the connection URI expression for the Kusto cluster.", + "remarks": "In emulator mode, resolves to the container's HTTP endpoint.\nIn Azure mode, resolves to the Azure Kusto cluster URI.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoReadWriteDatabaseResource.connectionStringExpression", + "qualifiedName": "AzureKustoReadWriteDatabaseResource.connectionStringExpression", + "description": "Gets the connection string expression for the Kusto database.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "DatabaseName", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoReadWriteDatabaseResource.databaseName", + "qualifiedName": "AzureKustoReadWriteDatabaseResource.databaseName", + "description": "Gets the database name.", + "kind": "PropertyGetter", + "signature": "DatabaseName() (string, error)", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoReadWriteDatabaseResource.parent", + "qualifiedName": "AzureKustoReadWriteDatabaseResource.parent", + "description": "Gets the parent Kusto resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureKustoClusterResource", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "AzureKustoClusterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "AddAzureKustoCluster", + "capabilityId": "Aspire.Hosting.Azure.Kusto/addAzureKustoCluster", + "qualifiedName": "addAzureKustoCluster", + "description": "Adds an Azure Data Explorer (Kusto) cluster resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureKustoCluster(name string) AzureKustoClusterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureKustoClusterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddReadWriteDatabase", + "capabilityId": "Aspire.Hosting.Azure.Kusto/addReadWriteDatabase", + "qualifiedName": "addReadWriteDatabase", + "description": "Adds a Kusto read-write database to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddReadWriteDatabase(name string, options ...*AddReadWriteDatabaseOptions) AzureKustoReadWriteDatabaseResource", + "receiver": "AzureKustoClusterResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddReadWriteDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureKustoReadWriteDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "GetDatabaseCreationScript", + "capabilityId": "Aspire.Hosting.Azure.Kusto/getDatabaseCreationScript", + "qualifiedName": "getDatabaseCreationScript", + "description": "Gets the database creation script from the resource annotation if it exists. If not, creates the default database creation script.", + "remarks": "The default script is\n```\n.create database DATABASE_NAME persist (PERSISTENCE_PATH/DATABASE_NAME/md, PERSISTENCE_PATH/DATABASE_NAME/data) ifnotexists\n```\nwhere\nDATABASE_NAME is the database name and PERSISTENCE_PATH is .", + "kind": "Method", + "signature": "GetDatabaseCreationScript() (string, error)", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.Kusto/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Kusto resource to run as an emulator using the Kustainer container.", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureKustoClusterResource", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureKustoEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureKustoEmulatorResource)", + "description": "Optional action to configure the Kusto emulator container." + } + ] + }, + "returnType": "AzureKustoClusterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "WithCreationScript", + "capabilityId": "Aspire.Hosting.Azure.Kusto/withCreationScript", + "qualifiedName": "withCreationScript", + "description": "Defines the script used to create the database.", + "remarks": "This script will only be executed when the Kusto resource is running in emulator mode. In production scenarios, the database creation should be handled as part of the provisioning process.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCreationScript(script string) AzureKustoReadWriteDatabaseResource", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [ + { + "name": "script", + "type": "string", + "description": "KQL script to create databases, tables, or data." + } + ], + "returnType": "AzureKustoReadWriteDatabaseResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.Kusto/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port that the Kusto emulator listens on for HTTP query requests.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(port float64) AzureKustoEmulatorResource", + "receiver": "AzureKustoEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureKustoEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoEmulatorResource" + ], + "appliesTo": [ + "AzureKustoEmulatorResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureKustoClusterResource", + "fullName": "Aspire.Hosting.Azure.AzureKustoClusterResource", + "kind": "handle", + "description": "A resource that represents a Kusto cluster.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "ClusterUri", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.clusterUri", + "qualifiedName": "AzureKustoClusterResource.clusterUri", + "description": "Gets the cluster URI output reference for the Azure Kusto cluster.", + "kind": "PropertyGetter", + "signature": "ClusterUri() BicepOutputReference", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.connectionStringExpression", + "qualifiedName": "AzureKustoClusterResource.connectionStringExpression", + "description": "Gets the ConnectionStringExpression property", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "IsEmulator", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.isEmulator", + "qualifiedName": "AzureKustoClusterResource.isEmulator", + "description": "Gets whether the resource is running the local emulator.", + "kind": "PropertyGetter", + "signature": "IsEmulator() (bool, error)", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "NameOutputReference", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.nameOutputReference", + "qualifiedName": "AzureKustoClusterResource.nameOutputReference", + "description": "Gets the \"name\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "NameOutputReference() BicepOutputReference", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoClusterResource.uriExpression", + "qualifiedName": "AzureKustoClusterResource.uriExpression", + "description": "Gets the connection URI expression for the Kusto cluster.", + "remarks": "In emulator mode, resolves to the container's HTTP endpoint.\nIn Azure mode, resolves to the Azure Kusto cluster URI.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "AddReadWriteDatabase", + "capabilityId": "Aspire.Hosting.Azure.Kusto/addReadWriteDatabase", + "qualifiedName": "addReadWriteDatabase", + "description": "Adds a Kusto read-write database to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddReadWriteDatabase(name string, options ...*AddReadWriteDatabaseOptions) AzureKustoReadWriteDatabaseResource", + "receiver": "AzureKustoClusterResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddReadWriteDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureKustoReadWriteDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.Kusto/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Kusto resource to run as an emulator using the Kustainer container.", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureKustoClusterResource", + "receiver": "AzureKustoClusterResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureKustoEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureKustoEmulatorResource)", + "description": "Optional action to configure the Kusto emulator container." + } + ] + }, + "returnType": "AzureKustoClusterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoClusterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoClusterResource" + ], + "appliesTo": [ + "AzureKustoClusterResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKustoEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureKustoEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.Kusto/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port that the Kusto emulator listens on for HTTP query requests.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(port float64) AzureKustoEmulatorResource", + "receiver": "AzureKustoEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureKustoEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoEmulatorResource" + ], + "appliesTo": [ + "AzureKustoEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKustoReadWriteDatabaseResource", + "fullName": "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "kind": "handle", + "description": "Represents an Azure Kusto read-write database resource, which is a child resource of a {@ats-ref type:AzureKustoClusterResource}.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoReadWriteDatabaseResource.connectionStringExpression", + "qualifiedName": "AzureKustoReadWriteDatabaseResource.connectionStringExpression", + "description": "Gets the connection string expression for the Kusto database.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "DatabaseName", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoReadWriteDatabaseResource.databaseName", + "qualifiedName": "AzureKustoReadWriteDatabaseResource.databaseName", + "description": "Gets the database name.", + "kind": "PropertyGetter", + "signature": "DatabaseName() (string, error)", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureKustoReadWriteDatabaseResource.parent", + "qualifiedName": "AzureKustoReadWriteDatabaseResource.parent", + "description": "Gets the parent Kusto resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureKustoClusterResource", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "AzureKustoClusterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "GetDatabaseCreationScript", + "capabilityId": "Aspire.Hosting.Azure.Kusto/getDatabaseCreationScript", + "qualifiedName": "getDatabaseCreationScript", + "description": "Gets the database creation script from the resource annotation if it exists. If not, creates the default database creation script.", + "remarks": "The default script is\n```\n.create database DATABASE_NAME persist (PERSISTENCE_PATH/DATABASE_NAME/md, PERSISTENCE_PATH/DATABASE_NAME/data) ifnotexists\n```\nwhere\nDATABASE_NAME is the database name and PERSISTENCE_PATH is .", + "kind": "Method", + "signature": "GetDatabaseCreationScript() (string, error)", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + }, + { + "name": "WithCreationScript", + "capabilityId": "Aspire.Hosting.Azure.Kusto/withCreationScript", + "qualifiedName": "withCreationScript", + "description": "Defines the script used to create the database.", + "remarks": "This script will only be executed when the Kusto resource is running in emulator mode. In production scenarios, the database creation should be handled as part of the provisioning process.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithCreationScript(script string) AzureKustoReadWriteDatabaseResource", + "receiver": "AzureKustoReadWriteDatabaseResource", + "parameters": [ + { + "name": "script", + "type": "string", + "description": "KQL script to create databases, tables, or data." + } + ], + "returnType": "AzureKustoReadWriteDatabaseResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Kusto/Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureKustoReadWriteDatabaseResource" + ], + "appliesTo": [ + "AzureKustoReadWriteDatabaseResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BicepOutputReference", + "fullName": "Aspire.Hosting.Azure.BicepOutputReference", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Network.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Network.13.6.0.json new file mode 100644 index 0000000000..ca624919da --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Network.13.6.0.json @@ -0,0 +1,1692 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Network", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureVirtualNetwork", + "capabilityId": "Aspire.Hosting.Azure.Network/addAzureVirtualNetwork", + "qualifiedName": "addAzureVirtualNetwork", + "description": "Adds an Azure Virtual Network resource to the application model.", + "kind": "Method", + "signature": "AddAzureVirtualNetwork(name string, options ...*AddAzureVirtualNetworkOptions) AzureVirtualNetworkResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddAzureVirtualNetworkOptions", + "fields": [ + { + "name": "AddressPrefix", + "jsonName": "addressPrefix", + "type": "any" + } + ] + }, + "returnType": "AzureVirtualNetworkResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddNatGateway", + "capabilityId": "Aspire.Hosting.Azure.Network/addNatGateway", + "qualifiedName": "addNatGateway", + "description": "Adds an Azure NAT Gateway resource to the application model.", + "remarks": "The NAT Gateway is created with Standard SKU. If no Public IP Address is explicitly associated\nvia `WithPublicIPAddress`, a Public IP Address is automatically created in the\nNAT Gateway's bicep module with Standard SKU and Static allocation.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddNatGateway(name string) AzureNatGatewayResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure NAT Gateway resource." + } + ], + "returnType": "AzureNatGatewayResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddNetworkSecurityGroup", + "capabilityId": "Aspire.Hosting.Azure.Network/addNetworkSecurityGroup", + "qualifiedName": "addNetworkSecurityGroup", + "description": "Adds an Azure Network Security Group to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddNetworkSecurityGroup(name string) AzureNetworkSecurityGroupResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Network Security Group resource." + } + ], + "returnType": "AzureNetworkSecurityGroupResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddNetworkSecurityPerimeter", + "capabilityId": "Aspire.Hosting.Azure.Network/addNetworkSecurityPerimeter", + "qualifiedName": "addNetworkSecurityPerimeter", + "description": "Adds an Azure Network Security Perimeter to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddNetworkSecurityPerimeter(name string) AzureNetworkSecurityPerimeterResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Network Security Perimeter resource." + } + ], + "returnType": "AzureNetworkSecurityPerimeterResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddPrivateEndpoint", + "capabilityId": "Aspire.Hosting.Azure.Network/addPrivateEndpoint", + "qualifiedName": "addPrivateEndpoint", + "description": "Adds an Azure Private Endpoint resource to the subnet.", + "remarks": "This method automatically creates the Private DNS Zone, VNet Link, and DNS Zone Group\nrequired for private endpoint DNS resolution. Private DNS Zones are shared across\nmultiple private endpoints that use the same zone name.\nWhen a private endpoint is added, the target resource (or its parent) is automatically\nconfigured to deny public network access. To override this behavior, use\n`ConfigureInfrastructure``1` to customize\nthe network settings.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPrivateEndpoint(target AzurePrivateEndpointTarget) AzurePrivateEndpointResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "target", + "type": "AzurePrivateEndpointTarget", + "description": "The target Azure resource to connect via private link." + } + ], + "returnType": "AzurePrivateEndpointResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "AddPublicIPAddress", + "capabilityId": "Aspire.Hosting.Azure.Network/addPublicIPAddress", + "qualifiedName": "addPublicIPAddress", + "description": "Adds an Azure Public IP Address resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPublicIPAddress(name string) AzurePublicIPAddressResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure Public IP Address resource." + } + ], + "returnType": "AzurePublicIPAddressResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddSubnet", + "capabilityId": "Aspire.Hosting.Azure.Network/addSubnet", + "qualifiedName": "addSubnet", + "description": "Adds an Azure subnet resource to an Azure Virtual Network resource.", + "kind": "Method", + "signature": "AddSubnet(name string, addressPrefix any, options ...*AddSubnetOptions) AzureSubnetResource", + "receiver": "AzureVirtualNetworkResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "addressPrefix", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "options": { + "typeName": "AddSubnetOptions", + "fields": [ + { + "name": "SubnetName", + "jsonName": "subnetName", + "type": "*string" + } + ] + }, + "returnType": "AzureSubnetResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureVirtualNetworkResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureVirtualNetworkResource" + ], + "appliesTo": [ + "AzureVirtualNetworkResource" + ] + }, + { + "name": "AllowInbound", + "capabilityId": "Aspire.Hosting.Azure.Network/allowInbound", + "qualifiedName": "allowInbound", + "description": "Adds an inbound allow rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AllowInbound(options ...*AllowInboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "AllowInboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix (e.g., \"AzureLoadBalancer\", \"Internet\", \"10.0.0.0/8\"). Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix. Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "AllowOutbound", + "capabilityId": "Aspire.Hosting.Azure.Network/allowOutbound", + "qualifiedName": "allowOutbound", + "description": "Adds an outbound allow rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AllowOutbound(options ...*AllowOutboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "AllowOutboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix. Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix (e.g., \"Internet\", \"VirtualNetwork\"). Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "DenyInbound", + "capabilityId": "Aspire.Hosting.Azure.Network/denyInbound", + "qualifiedName": "denyInbound", + "description": "Adds an inbound deny rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "DenyInbound(options ...*DenyInboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "DenyInboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix (e.g., \"Internet\", \"VirtualNetwork\", \"10.0.0.0/8\"). Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix. Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "DenyOutbound", + "capabilityId": "Aspire.Hosting.Azure.Network/denyOutbound", + "qualifiedName": "denyOutbound", + "description": "Adds an outbound deny rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "DenyOutbound(options ...*DenyOutboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "DenyOutboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix. Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix (e.g., \"Internet\", \"VirtualNetwork\"). Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "WithAccessRule", + "capabilityId": "Aspire.Hosting.Azure.Network/withAccessRule", + "qualifiedName": "withAccessRule", + "description": "Adds an access rule to the Network Security Perimeter.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAccessRule(rule *AzureNspAccessRule) AzureNetworkSecurityPerimeterResource", + "receiver": "AzureNetworkSecurityPerimeterResource", + "parameters": [ + { + "name": "rule", + "type": "*AzureNspAccessRule", + "description": "The access rule configuration." + } + ], + "returnType": "AzureNetworkSecurityPerimeterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource" + ], + "appliesTo": [ + "AzureNetworkSecurityPerimeterResource" + ] + }, + { + "name": "WithDelegatedSubnet", + "capabilityId": "Aspire.Hosting.Azure.Network/withSubnetDelegatedSubnet", + "qualifiedName": "withDelegatedSubnet", + "description": "Configures the resource to use the specified subnet with appropriate service delegation.", + "remarks": "This method automatically configures the subnet with the appropriate service delegation\nfor the target resource type (for example, \"Microsoft.App/environments\" for Azure Container Apps\nand \"Microsoft.Web/serverFarms\" for Azure App Service).\nA resource can only be associated with one delegated subnet. Repeating the call with the same subnet is idempotent.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDelegatedSubnet(subnet AzureSubnetResource) AzureDelegatedSubnetResource", + "receiver": "AzureDelegatedSubnetResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to associate with the resource." + } + ], + "returnType": "AzureDelegatedSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.IAzureDelegatedSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.IAzureDelegatedSubnetResource" + ], + "appliesTo": [ + "AzureDelegatedSubnetResource" + ] + }, + { + "name": "WithNatGateway", + "capabilityId": "Aspire.Hosting.Azure.Network/withNatGateway", + "qualifiedName": "withNatGateway", + "description": "Associates a NAT Gateway with the subnet.", + "remarks": "A NAT Gateway provides outbound internet connectivity for resources in the subnet.\nA subnet can have at most one NAT Gateway.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithNatGateway(natGateway AzureNatGatewayResource) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "natGateway", + "type": "AzureNatGatewayResource", + "description": "The NAT Gateway to associate with the subnet." + } + ], + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "WithNetworkSecurityGroup", + "capabilityId": "Aspire.Hosting.Azure.Network/withNetworkSecurityGroup", + "qualifiedName": "withNetworkSecurityGroup", + "description": "Associates a Network Security Group with the subnet.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithNetworkSecurityGroup(nsg AzureNetworkSecurityGroupResource) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "nsg", + "type": "AzureNetworkSecurityGroupResource", + "description": "The Network Security Group to associate with the subnet." + } + ], + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "WithNetworkSecurityPerimeter", + "capabilityId": "Aspire.Hosting.Azure.Network/associateWithNetworkSecurityPerimeter", + "qualifiedName": "withNetworkSecurityPerimeter", + "description": "Associates an Azure PaaS resource with a Network Security Perimeter.", + "remarks": "In `Enforced` mode, resources within the\nperimeter can communicate with each other, but public access is restricted to the rules defined\nin the perimeter profile.\nIn `Learning` mode, traffic that would\nbe blocked by the perimeter rules is logged but not denied. This is useful when onboarding\nresources to identify required access rules before switching to enforced mode.", + "returns": "A reference to the target resource builder for chaining.", + "kind": "Method", + "signature": "WithNetworkSecurityPerimeter(nsp AzureNetworkSecurityPerimeterResource, options ...*WithNetworkSecurityPerimeterOptions) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "nsp", + "type": "AzureNetworkSecurityPerimeterResource", + "description": "The Network Security Perimeter to associate with." + } + ], + "options": { + "typeName": "WithNetworkSecurityPerimeterOptions", + "fields": [ + { + "name": "AccessMode", + "jsonName": "accessMode", + "type": "*NetworkSecurityPerimeterAssociationAccessMode", + "description": "The access mode for the association. Defaults to `Enforced`. Use `Learning` to log violations without blocking traffic." + }, + { + "name": "AssociationName", + "jsonName": "associationName", + "type": "*string", + "description": "An optional name for the association. If not provided, defaults to `\"{resourceName}-assoc\"`." + } + ] + }, + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureSubnetResource", + "Aspire.Hosting.Azure.AzureVirtualNetworkResource", + "Aspire.Hosting.Azure.AzureNatGatewayResource", + "Aspire.Hosting.Azure.AzurePublicIPAddressResource", + "Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource", + "Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource", + "Aspire.Hosting.Azure.AzurePrivateEndpointResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureNatGatewayResource", + "AzureNetworkSecurityGroupResource", + "AzureNetworkSecurityPerimeterResource", + "AzurePrivateEndpointResource", + "AzureProvisioningResource", + "AzurePublicIPAddressResource", + "AzureSubnetResource", + "AzureUserAssignedIdentityResource", + "AzureVirtualNetworkResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithPublicIPAddress", + "capabilityId": "Aspire.Hosting.Azure.Network/withPublicIPAddress", + "qualifiedName": "withPublicIPAddress", + "description": "Associates an explicit Public IP Address resource with the NAT Gateway.", + "remarks": "When an explicit Public IP Address is provided, the NAT Gateway will not auto-create one.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPublicIPAddress(publicIPAddress AzurePublicIPAddressResource) AzureNatGatewayResource", + "receiver": "AzureNatGatewayResource", + "parameters": [ + { + "name": "publicIPAddress", + "type": "AzurePublicIPAddressResource", + "description": "The Public IP Address resource to associate." + } + ], + "returnType": "AzureNatGatewayResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureNatGatewayResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureNatGatewayResource" + ], + "appliesTo": [ + "AzureNatGatewayResource" + ] + }, + { + "name": "WithSecurityRule", + "capabilityId": "Aspire.Hosting.Azure.Network/withSecurityRule", + "qualifiedName": "withSecurityRule", + "description": "Adds a security rule to the Network Security Group.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSecurityRule(rule *AzureSecurityRule) AzureNetworkSecurityGroupResource", + "receiver": "AzureNetworkSecurityGroupResource", + "parameters": [ + { + "name": "rule", + "type": "*AzureSecurityRule", + "description": "The security rule configuration." + } + ], + "returnType": "AzureNetworkSecurityGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource" + ], + "appliesTo": [ + "AzureNetworkSecurityGroupResource" + ] + }, + { + "name": "WithServiceDelegation", + "capabilityId": "Aspire.Hosting.Azure.Network/withServiceDelegation", + "qualifiedName": "withServiceDelegation", + "description": "Delegates the subnet to the specified Azure service.", + "remarks": "Service delegation grants the specified Azure service permission to create service-specific\nresources in the subnet. Azure subnets can carry more than one delegation, but Aspire models a\nsubnet with a single delegation and emits only the most recent one. Calling this multiple times,\nor combining it with `WithDelegatedSubnet``1`, therefore replaces any previously\nconfigured delegation with the latest value (last-write-wins).", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithServiceDelegation(serviceName string, options ...*WithServiceDelegationOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "serviceName", + "type": "string", + "description": "The service name to delegate the subnet to (e.g., \"Microsoft.App/environments\"). See `AzureSubnetServiceDelegations` for well-known values." + } + ], + "options": { + "typeName": "WithServiceDelegationOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the service delegation. If not specified, defaults to `serviceName`." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureNatGatewayResource", + "fullName": "Aspire.Hosting.Azure.AzureNatGatewayResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithPublicIPAddress", + "capabilityId": "Aspire.Hosting.Azure.Network/withPublicIPAddress", + "qualifiedName": "withPublicIPAddress", + "description": "Associates an explicit Public IP Address resource with the NAT Gateway.", + "remarks": "When an explicit Public IP Address is provided, the NAT Gateway will not auto-create one.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPublicIPAddress(publicIPAddress AzurePublicIPAddressResource) AzureNatGatewayResource", + "receiver": "AzureNatGatewayResource", + "parameters": [ + { + "name": "publicIPAddress", + "type": "AzurePublicIPAddressResource", + "description": "The Public IP Address resource to associate." + } + ], + "returnType": "AzureNatGatewayResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureNatGatewayResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureNatGatewayResource" + ], + "appliesTo": [ + "AzureNatGatewayResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureNetworkSecurityGroupResource", + "fullName": "Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithSecurityRule", + "capabilityId": "Aspire.Hosting.Azure.Network/withSecurityRule", + "qualifiedName": "withSecurityRule", + "description": "Adds a security rule to the Network Security Group.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSecurityRule(rule *AzureSecurityRule) AzureNetworkSecurityGroupResource", + "receiver": "AzureNetworkSecurityGroupResource", + "parameters": [ + { + "name": "rule", + "type": "*AzureSecurityRule", + "description": "The security rule configuration." + } + ], + "returnType": "AzureNetworkSecurityGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureNetworkSecurityGroupResource" + ], + "appliesTo": [ + "AzureNetworkSecurityGroupResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureNetworkSecurityPerimeterResource", + "fullName": "Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithAccessRule", + "capabilityId": "Aspire.Hosting.Azure.Network/withAccessRule", + "qualifiedName": "withAccessRule", + "description": "Adds an access rule to the Network Security Perimeter.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAccessRule(rule *AzureNspAccessRule) AzureNetworkSecurityPerimeterResource", + "receiver": "AzureNetworkSecurityPerimeterResource", + "parameters": [ + { + "name": "rule", + "type": "*AzureNspAccessRule", + "description": "The access rule configuration." + } + ], + "returnType": "AzureNetworkSecurityPerimeterResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureNetworkSecurityPerimeterResource" + ], + "appliesTo": [ + "AzureNetworkSecurityPerimeterResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzurePrivateEndpointResource", + "fullName": "Aspire.Hosting.Azure.AzurePrivateEndpointResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzurePublicIPAddressResource", + "fullName": "Aspire.Hosting.Azure.AzurePublicIPAddressResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSubnetResource", + "fullName": "Aspire.Hosting.Azure.AzureSubnetResource", + "kind": "handle", + "description": "Represents an Azure Subnet resource.", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "AddPrivateEndpoint", + "capabilityId": "Aspire.Hosting.Azure.Network/addPrivateEndpoint", + "qualifiedName": "addPrivateEndpoint", + "description": "Adds an Azure Private Endpoint resource to the subnet.", + "remarks": "This method automatically creates the Private DNS Zone, VNet Link, and DNS Zone Group\nrequired for private endpoint DNS resolution. Private DNS Zones are shared across\nmultiple private endpoints that use the same zone name.\nWhen a private endpoint is added, the target resource (or its parent) is automatically\nconfigured to deny public network access. To override this behavior, use\n`ConfigureInfrastructure``1` to customize\nthe network settings.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPrivateEndpoint(target AzurePrivateEndpointTarget) AzurePrivateEndpointResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "target", + "type": "AzurePrivateEndpointTarget", + "description": "The target Azure resource to connect via private link." + } + ], + "returnType": "AzurePrivateEndpointResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "AllowInbound", + "capabilityId": "Aspire.Hosting.Azure.Network/allowInbound", + "qualifiedName": "allowInbound", + "description": "Adds an inbound allow rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AllowInbound(options ...*AllowInboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "AllowInboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix (e.g., \"AzureLoadBalancer\", \"Internet\", \"10.0.0.0/8\"). Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix. Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "AllowOutbound", + "capabilityId": "Aspire.Hosting.Azure.Network/allowOutbound", + "qualifiedName": "allowOutbound", + "description": "Adds an outbound allow rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AllowOutbound(options ...*AllowOutboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "AllowOutboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix. Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix (e.g., \"Internet\", \"VirtualNetwork\"). Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "DenyInbound", + "capabilityId": "Aspire.Hosting.Azure.Network/denyInbound", + "qualifiedName": "denyInbound", + "description": "Adds an inbound deny rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "DenyInbound(options ...*DenyInboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "DenyInboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix (e.g., \"Internet\", \"VirtualNetwork\", \"10.0.0.0/8\"). Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix. Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "DenyOutbound", + "capabilityId": "Aspire.Hosting.Azure.Network/denyOutbound", + "qualifiedName": "denyOutbound", + "description": "Adds an outbound deny rule to the subnet's Network Security Group.", + "remarks": "If no Network Security Group has been associated with the subnet, one is automatically created.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "DenyOutbound(options ...*DenyOutboundOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [], + "options": { + "typeName": "DenyOutboundOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*string", + "description": "The destination port range (e.g., \"443\", \"80-443\"). Defaults to \"*\" (any)." + }, + { + "name": "From", + "jsonName": "from", + "type": "*string", + "description": "The source address prefix. Defaults to \"*\" (any)." + }, + { + "name": "To", + "jsonName": "to", + "type": "*string", + "description": "The destination address prefix (e.g., \"Internet\", \"VirtualNetwork\"). Defaults to \"*\" (any)." + }, + { + "name": "Protocol", + "jsonName": "protocol", + "type": "*SecurityRuleProtocol", + "description": "The network protocol. Defaults to `Asterisk` (any)." + }, + { + "name": "Priority", + "jsonName": "priority", + "type": "*float64", + "description": "The rule priority (100-4096). If not specified, auto-increments from 100 by 100." + }, + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The rule name. If not specified, auto-generated from parameters." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "WithNatGateway", + "capabilityId": "Aspire.Hosting.Azure.Network/withNatGateway", + "qualifiedName": "withNatGateway", + "description": "Associates a NAT Gateway with the subnet.", + "remarks": "A NAT Gateway provides outbound internet connectivity for resources in the subnet.\nA subnet can have at most one NAT Gateway.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithNatGateway(natGateway AzureNatGatewayResource) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "natGateway", + "type": "AzureNatGatewayResource", + "description": "The NAT Gateway to associate with the subnet." + } + ], + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "WithNetworkSecurityGroup", + "capabilityId": "Aspire.Hosting.Azure.Network/withNetworkSecurityGroup", + "qualifiedName": "withNetworkSecurityGroup", + "description": "Associates a Network Security Group with the subnet.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithNetworkSecurityGroup(nsg AzureNetworkSecurityGroupResource) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "nsg", + "type": "AzureNetworkSecurityGroupResource", + "description": "The Network Security Group to associate with the subnet." + } + ], + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + }, + { + "name": "WithServiceDelegation", + "capabilityId": "Aspire.Hosting.Azure.Network/withServiceDelegation", + "qualifiedName": "withServiceDelegation", + "description": "Delegates the subnet to the specified Azure service.", + "remarks": "Service delegation grants the specified Azure service permission to create service-specific\nresources in the subnet. Azure subnets can carry more than one delegation, but Aspire models a\nsubnet with a single delegation and emits only the most recent one. Calling this multiple times,\nor combining it with `WithDelegatedSubnet``1`, therefore replaces any previously\nconfigured delegation with the latest value (last-write-wins).", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithServiceDelegation(serviceName string, options ...*WithServiceDelegationOptions) AzureSubnetResource", + "receiver": "AzureSubnetResource", + "parameters": [ + { + "name": "serviceName", + "type": "string", + "description": "The service name to delegate the subnet to (e.g., \"Microsoft.App/environments\"). See `AzureSubnetServiceDelegations` for well-known values." + } + ], + "options": { + "typeName": "WithServiceDelegationOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the service delegation. If not specified, defaults to `serviceName`." + } + ] + }, + "returnType": "AzureSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSubnetResource" + ], + "appliesTo": [ + "AzureSubnetResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureVirtualNetworkResource", + "fullName": "Aspire.Hosting.Azure.AzureVirtualNetworkResource", + "kind": "handle", + "description": "Represents an Azure Virtual Network resource.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "AddSubnet", + "capabilityId": "Aspire.Hosting.Azure.Network/addSubnet", + "qualifiedName": "addSubnet", + "description": "Adds an Azure subnet resource to an Azure Virtual Network resource.", + "kind": "Method", + "signature": "AddSubnet(name string, addressPrefix any, options ...*AddSubnetOptions) AzureSubnetResource", + "receiver": "AzureVirtualNetworkResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "addressPrefix", + "type": "any", + "allowedTypes": [ + "string", + "ParameterResource" + ] + } + ], + "options": { + "typeName": "AddSubnetOptions", + "fields": [ + { + "name": "SubnetName", + "jsonName": "subnetName", + "type": "*string" + } + ] + }, + "returnType": "AzureSubnetResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Network/Aspire.Hosting.Azure.AzureVirtualNetworkResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureVirtualNetworkResource" + ], + "appliesTo": [ + "AzureVirtualNetworkResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureDelegatedSubnetResource", + "fullName": "Aspire.Hosting.Azure.IAzureDelegatedSubnetResource", + "kind": "handle", + "isInterface": true, + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithDelegatedSubnet", + "capabilityId": "Aspire.Hosting.Azure.Network/withSubnetDelegatedSubnet", + "qualifiedName": "withDelegatedSubnet", + "description": "Configures the resource to use the specified subnet with appropriate service delegation.", + "remarks": "This method automatically configures the subnet with the appropriate service delegation\nfor the target resource type (for example, \"Microsoft.App/environments\" for Azure Container Apps\nand \"Microsoft.Web/serverFarms\" for Azure App Service).\nA resource can only be associated with one delegated subnet. Repeating the call with the same subnet is idempotent.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDelegatedSubnet(subnet AzureSubnetResource) AzureDelegatedSubnetResource", + "receiver": "AzureDelegatedSubnetResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to associate with the resource." + } + ], + "returnType": "AzureDelegatedSubnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.IAzureDelegatedSubnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.IAzureDelegatedSubnetResource" + ], + "appliesTo": [ + "AzureDelegatedSubnetResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzurePrivateEndpointTarget", + "fullName": "Aspire.Hosting.Azure.IAzurePrivateEndpointTarget", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "AzureNspAccessRule", + "fullName": "Aspire.Hosting.Azure.AzureNspAccessRule", + "kind": "dto", + "description": "Represents an access rule configuration for an Azure Network Security Perimeter.", + "remarks": "Access rules control how traffic flows into and out of the network security perimeter.\nInbound rules specify which external sources (IP ranges or subscriptions) can access\nresources within the perimeter. Outbound rules specify which external destinations (FQDNs)\nresources within the perimeter can communicate with.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "string", + "description": "Gets or sets the name of the access rule. This name must be unique within the perimeter profile." + }, + { + "name": "Direction", + "jsonName": "Direction", + "type": "NetworkSecurityPerimeterAccessRuleDirection", + "description": "Gets or sets the direction of the rule." + }, + { + "name": "AddressPrefixes", + "jsonName": "AddressPrefixes", + "type": "[]string", + "isOptional": true, + "description": "Gets or initializes the list of inbound address prefixes (CIDR ranges) allowed by this rule." + }, + { + "name": "AddressPrefixReferences", + "jsonName": "AddressPrefixReferences", + "type": "[]*ReferenceExpression", + "isOptional": true, + "description": "Gets or initializes the list of inbound address prefixes (CIDR ranges) `ReferenceExpression` values allowed by this rule." + }, + { + "name": "Subscriptions", + "jsonName": "Subscriptions", + "type": "[]string", + "isOptional": true, + "description": "Gets or initializes the list of subscription IDs allowed by this rule." + }, + { + "name": "SubscriptionReferences", + "jsonName": "SubscriptionReferences", + "type": "[]*ReferenceExpression", + "isOptional": true, + "description": "Gets or initializes the subscription resource ID `ReferenceExpression` values allowed by this rule." + }, + { + "name": "FullyQualifiedDomainNames", + "jsonName": "FullyQualifiedDomainNames", + "type": "[]string", + "isOptional": true, + "description": "Gets or initializes the list of fully qualified domain names (FQDNs) allowed by this rule." + }, + { + "name": "FullyQualifiedDomainNameReferences", + "jsonName": "FullyQualifiedDomainNameReferences", + "type": "[]*ReferenceExpression", + "isOptional": true, + "description": "Gets or initializes the fully qualified domain name `ReferenceExpression` values allowed by this rule." + } + ] + }, + { + "name": "AzureSecurityRule", + "fullName": "Aspire.Hosting.Azure.AzureSecurityRule", + "kind": "dto", + "description": "Represents a security rule configuration for an Azure Network Security Group.", + "remarks": "Security rules control inbound and outbound network traffic for subnets associated with the Network Security Group.\nRules are evaluated in priority order, with lower numbers having higher priority.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "string", + "description": "Gets or sets the name of the security rule. This name must be unique within the Network Security Group." + }, + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Gets or sets an optional description for the security rule." + }, + { + "name": "Priority", + "jsonName": "Priority", + "type": "float64", + "description": "Gets or sets the priority of the rule. Valid values are between 100 and 4096. Lower numbers have higher priority." + }, + { + "name": "Direction", + "jsonName": "Direction", + "type": "SecurityRuleDirection", + "description": "Gets or sets the direction of the rule." + }, + { + "name": "Access", + "jsonName": "Access", + "type": "SecurityRuleAccess", + "description": "Gets or sets whether network traffic is allowed or denied." + }, + { + "name": "Protocol", + "jsonName": "Protocol", + "type": "SecurityRuleProtocol", + "description": "Gets or sets the network protocol this rule applies to." + }, + { + "name": "SourceAddressPrefix", + "jsonName": "SourceAddressPrefix", + "type": "string", + "description": "Gets or sets the source address prefix. Defaults to \"*\" (any)." + }, + { + "name": "SourceAddressPrefixReference", + "jsonName": "SourceAddressPrefixReference", + "type": "*ReferenceExpression", + "description": "Gets or sets a `ReferenceExpression` whose value is resolved at deploy time and used as the source address prefix for the rule. Takes precedence over `SourceAddressPrefix`." + }, + { + "name": "SourcePortRange", + "jsonName": "SourcePortRange", + "type": "string", + "description": "Gets or sets the source port range. Defaults to \"*\" (any)." + }, + { + "name": "DestinationAddressPrefix", + "jsonName": "DestinationAddressPrefix", + "type": "string", + "description": "Gets or sets the destination address prefix. Defaults to \"*\" (any)." + }, + { + "name": "DestinationAddressPrefixReference", + "jsonName": "DestinationAddressPrefixReference", + "type": "*ReferenceExpression", + "description": "Gets or sets a `ReferenceExpression` whose value is resolved at deploy time and used as the destination address prefix for the rule. Takes precedence over `DestinationAddressPrefix`." + }, + { + "name": "DestinationPortRange", + "jsonName": "DestinationPortRange", + "type": "string", + "description": "Gets or sets the destination port range. Use \"*\" for any, or a range like \"80-443\"." + } + ] + } + ], + "enumTypes": [], + "exportedValues": [ + { + "name": "AzureServiceTags", + "fullName": "AzureServiceTags", + "kind": "exportedValue", + "values": [ + { + "path": "AppService", + "type": "string", + "value": "\"AppService\"", + "description": "Represents Azure App Service and Azure Functions service addresses." + }, + { + "path": "AzureActiveDirectory", + "type": "string", + "value": "\"AzureActiveDirectory\"", + "description": "Represents Microsoft Entra ID (formerly Azure Active Directory) service addresses." + }, + { + "path": "AzureContainerRegistry", + "type": "string", + "value": "\"AzureContainerRegistry\"", + "description": "Represents Azure Container Registry service addresses." + }, + { + "path": "AzureCosmosDB", + "type": "string", + "value": "\"AzureCosmosDB\"", + "description": "Represents Azure Cosmos DB service addresses." + }, + { + "path": "AzureKeyVault", + "type": "string", + "value": "\"AzureKeyVault\"", + "description": "Represents Azure Key Vault service addresses." + }, + { + "path": "AzureLoadBalancer", + "type": "string", + "value": "\"AzureLoadBalancer\"", + "description": "Represents the Azure infrastructure load balancer. This tag is commonly used to allow health probe traffic from Azure." + }, + { + "path": "AzureMonitor", + "type": "string", + "value": "\"AzureMonitor\"", + "description": "Represents Azure Monitor service addresses, including Log Analytics, Application Insights, and Azure Monitor metrics." + }, + { + "path": "AzureTrafficManager", + "type": "string", + "value": "\"AzureTrafficManager\"", + "description": "Represents Azure Traffic Manager probe IP addresses." + }, + { + "path": "EventHub", + "type": "string", + "value": "\"EventHub\"", + "description": "Represents Azure Event Hubs service addresses." + }, + { + "path": "GatewayManager", + "type": "string", + "value": "\"GatewayManager\"", + "description": "Represents the Gateway Manager service, used for VPN Gateway and Application Gateway management traffic." + }, + { + "path": "Internet", + "type": "string", + "value": "\"Internet\"", + "description": "Represents the Internet address space, including all publicly routable IP addresses." + }, + { + "path": "ServiceBus", + "type": "string", + "value": "\"ServiceBus\"", + "description": "Represents Azure Service Bus service addresses." + }, + { + "path": "Sql", + "type": "string", + "value": "\"Sql\"", + "description": "Represents Azure SQL Database, Azure Database for MySQL, Azure Database for PostgreSQL, Azure Database for MariaDB, and Azure Synapse Analytics." + }, + { + "path": "Storage", + "type": "string", + "value": "\"Storage\"", + "description": "Represents the Azure Storage service. This tag does not include specific Storage accounts; it covers all Azure Storage IP addresses." + }, + { + "path": "VirtualNetwork", + "type": "string", + "value": "\"VirtualNetwork\"", + "description": "Represents the address space for the virtual network, including all connected address spaces, all connected on-premises address spaces, and peered virtual networks." + } + ] + } + ] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.OperationalInsights.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.OperationalInsights.13.6.0.json new file mode 100644 index 0000000000..e9d2117b1d --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.OperationalInsights.13.6.0.json @@ -0,0 +1,54 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.OperationalInsights", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureLogAnalyticsWorkspace", + "capabilityId": "Aspire.Hosting.Azure.OperationalInsights/addAzureLogAnalyticsWorkspace", + "qualifiedName": "addAzureLogAnalyticsWorkspace", + "description": "Adds an Azure Log Analytics Workspace resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureLogAnalyticsWorkspace(name string) AzureLogAnalyticsWorkspaceResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureLogAnalyticsWorkspaceResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + } + ], + "handleTypes": [ + { + "name": "AzureLogAnalyticsWorkspaceResource", + "fullName": "Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.PostgreSQL.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.PostgreSQL.13.6.0.json new file mode 100644 index 0000000000..ecf6106a03 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.PostgreSQL.13.6.0.json @@ -0,0 +1,406 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.PostgreSQL", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzurePostgresFlexibleServer", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/addAzurePostgresFlexibleServer", + "qualifiedName": "addAzurePostgresFlexibleServer", + "description": "Adds an Azure PostgreSQL Flexible Server resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzurePostgresFlexibleServer(name string) AzurePostgresFlexibleServerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzurePostgresFlexibleServerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDatabase", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/addDatabase", + "qualifiedName": "addDatabase", + "description": "Adds an Azure PostgreSQL database to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDatabase(name string, options ...*AddDatabaseOptions) AzurePostgresFlexibleServerDatabaseResource", + "receiver": "AzurePostgresFlexibleServerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzurePostgresFlexibleServerDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerResource" + ] + }, + { + "name": "RunAsContainer", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/runAsContainer", + "qualifiedName": "runAsContainer", + "description": "Configures an Azure PostgreSQL Flexible Server resource to run locally in a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsContainer(options ...*RunAsContainerOptions) AzurePostgresFlexibleServerResource", + "receiver": "AzurePostgresFlexibleServerResource", + "parameters": [], + "options": { + "typeName": "RunAsContainerOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj PostgresServerResource)", + "isCallback": true, + "callbackSignature": "func(obj PostgresServerResource)", + "description": "Callback that exposes underlying container to allow for customization." + } + ] + }, + "returnType": "AzurePostgresFlexibleServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerResource" + ] + }, + { + "name": "WithPasswordAuthentication", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/withPasswordAuthentication", + "qualifiedName": "withPasswordAuthentication", + "description": "Configures password authentication for Azure PostgreSQL Flexible Server", + "kind": "Method", + "signature": "WithPasswordAuthentication(options ...*WithPasswordAuthenticationOptions) AzurePostgresFlexibleServerResource", + "receiver": "AzurePostgresFlexibleServerResource", + "parameters": [], + "options": { + "typeName": "WithPasswordAuthenticationOptions", + "fields": [ + { + "name": "KeyVaultBuilder", + "jsonName": "keyVaultBuilder", + "type": "*AzureKeyVaultResource" + }, + { + "name": "UserName", + "jsonName": "userName", + "type": "*ParameterResource" + }, + { + "name": "Password", + "jsonName": "password", + "type": "*ParameterResource" + } + ] + }, + "returnType": "AzurePostgresFlexibleServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerResource" + ] + }, + { + "name": "WithPostgresMcp", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/withPostgresMcp", + "qualifiedName": "withPostgresMcp", + "description": "Adds a Postgres MCP server container and configures it to connect to the database represented by `builder`.", + "remarks": "The Postgres MCP server is configured to use SSE transport and will expose an HTTP endpoint.\nThis extension method only applies when the Azure PostgreSQL resource is running as a container (i.e., `IsContainer` is `true`).\nIf the resource is not running as a container, this method has no effect.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPostgresMcp(options ...*WithPostgresMcpOptions) AzurePostgresFlexibleServerDatabaseResource", + "receiver": "AzurePostgresFlexibleServerDatabaseResource", + "parameters": [], + "options": { + "typeName": "WithPostgresMcpOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj PostgresMcpContainerResource)", + "isCallback": true, + "callbackSignature": "func(obj PostgresMcpContainerResource)", + "description": "Configuration callback for the Postgres MCP container resource." + }, + { + "name": "ContainerName", + "jsonName": "containerName", + "type": "*string", + "description": "The name of the container (optional)." + } + ] + }, + "returnType": "AzurePostgresFlexibleServerDatabaseResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerDatabaseResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerDatabaseResource" + ] + } + ], + "handleTypes": [ + { + "name": "PostgresServerResource", + "fullName": "Aspire.Hosting.ApplicationModel.PostgresServerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzurePostgresFlexibleServerDatabaseResource", + "fullName": "Aspire.Hosting.Azure.AzurePostgresFlexibleServerDatabaseResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "WithPostgresMcp", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/withPostgresMcp", + "qualifiedName": "withPostgresMcp", + "description": "Adds a Postgres MCP server container and configures it to connect to the database represented by `builder`.", + "remarks": "The Postgres MCP server is configured to use SSE transport and will expose an HTTP endpoint.\nThis extension method only applies when the Azure PostgreSQL resource is running as a container (i.e., `IsContainer` is `true`).\nIf the resource is not running as a container, this method has no effect.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPostgresMcp(options ...*WithPostgresMcpOptions) AzurePostgresFlexibleServerDatabaseResource", + "receiver": "AzurePostgresFlexibleServerDatabaseResource", + "parameters": [], + "options": { + "typeName": "WithPostgresMcpOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj PostgresMcpContainerResource)", + "isCallback": true, + "callbackSignature": "func(obj PostgresMcpContainerResource)", + "description": "Configuration callback for the Postgres MCP container resource." + }, + { + "name": "ContainerName", + "jsonName": "containerName", + "type": "*string", + "description": "The name of the container (optional)." + } + ] + }, + "returnType": "AzurePostgresFlexibleServerDatabaseResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerDatabaseResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerDatabaseResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzurePostgresFlexibleServerResource", + "fullName": "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddDatabase", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/addDatabase", + "qualifiedName": "addDatabase", + "description": "Adds an Azure PostgreSQL database to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDatabase(name string, options ...*AddDatabaseOptions) AzurePostgresFlexibleServerDatabaseResource", + "receiver": "AzurePostgresFlexibleServerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzurePostgresFlexibleServerDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerResource" + ] + }, + { + "name": "RunAsContainer", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/runAsContainer", + "qualifiedName": "runAsContainer", + "description": "Configures an Azure PostgreSQL Flexible Server resource to run locally in a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsContainer(options ...*RunAsContainerOptions) AzurePostgresFlexibleServerResource", + "receiver": "AzurePostgresFlexibleServerResource", + "parameters": [], + "options": { + "typeName": "RunAsContainerOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj PostgresServerResource)", + "isCallback": true, + "callbackSignature": "func(obj PostgresServerResource)", + "description": "Callback that exposes underlying container to allow for customization." + } + ] + }, + "returnType": "AzurePostgresFlexibleServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerResource" + ] + }, + { + "name": "WithPasswordAuthentication", + "capabilityId": "Aspire.Hosting.Azure.PostgreSQL/withPasswordAuthentication", + "qualifiedName": "withPasswordAuthentication", + "description": "Configures password authentication for Azure PostgreSQL Flexible Server", + "kind": "Method", + "signature": "WithPasswordAuthentication(options ...*WithPasswordAuthenticationOptions) AzurePostgresFlexibleServerResource", + "receiver": "AzurePostgresFlexibleServerResource", + "parameters": [], + "options": { + "typeName": "WithPasswordAuthenticationOptions", + "fields": [ + { + "name": "KeyVaultBuilder", + "jsonName": "keyVaultBuilder", + "type": "*AzureKeyVaultResource" + }, + { + "name": "UserName", + "jsonName": "userName", + "type": "*ParameterResource" + }, + { + "name": "Password", + "jsonName": "password", + "type": "*ParameterResource" + } + ] + }, + "returnType": "AzurePostgresFlexibleServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.PostgreSQL/Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzurePostgresFlexibleServerResource" + ], + "appliesTo": [ + "AzurePostgresFlexibleServerResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultResource", + "fullName": "Aspire.Hosting.Azure.IAzureKeyVaultResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "PostgresMcpContainerResource", + "fullName": "Aspire.Hosting.Postgres.PostgresMcpContainerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Provisioning.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Provisioning.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..fe5f4dc18c --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Provisioning.13.6.0-preview.1.26478.8.json @@ -0,0 +1,2738 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Provisioning", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AppendLiteral", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/appendLiteral", + "qualifiedName": "BicepStringBuilderProxy.appendLiteral", + "description": "Appends literal text to the interpolated Bicep string.", + "returns": "The string builder.", + "kind": "InstanceMethod", + "signature": "AppendLiteral(value string) BicepStringBuilderProxy", + "receiver": "BicepStringBuilderProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The literal text to append." + } + ], + "returnType": "BicepStringBuilderProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy" + ], + "appliesTo": [ + "BicepStringBuilderProxy" + ] + }, + { + "name": "AppendValue", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/appendValue", + "qualifiedName": "BicepStringBuilderProxy.appendValue", + "description": "Appends a provisioning value to the interpolated Bicep string.", + "returns": "The string builder.", + "kind": "InstanceMethod", + "signature": "AppendValue(value BicepValueProxy) BicepStringBuilderProxy", + "receiver": "BicepStringBuilderProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The provisioning value to append." + } + ], + "returnType": "BicepStringBuilderProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy" + ], + "appliesTo": [ + "BicepStringBuilderProxy" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/build", + "qualifiedName": "BicepStringBuilderProxy.build", + "description": "Builds the interpolated Bicep string.", + "returns": "The composed Bicep string value.", + "kind": "InstanceMethod", + "signature": "Build() BicepValueProxy", + "receiver": "BicepStringBuilderProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy" + ], + "appliesTo": [ + "BicepStringBuilderProxy" + ] + }, + { + "name": "AsString", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/asString", + "qualifiedName": "BicepValueFactoryProxy.asString", + "description": "Creates an explicitly typed Bicep string expression.", + "returns": "A Bicep string expression.", + "kind": "InstanceMethod", + "signature": "AsString(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to convert." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Binary", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/binary", + "qualifiedName": "BicepValueFactoryProxy.binary", + "description": "Creates a binary Bicep expression.", + "returns": "A binary Bicep expression.", + "kind": "InstanceMethod", + "signature": "Binary(left BicepValueProxy, operator BinaryBicepOperator, right BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "left", + "type": "BicepValueProxy", + "description": "The left operand." + }, + { + "name": "operator", + "type": "BinaryBicepOperator", + "description": "The binary operator." + }, + { + "name": "right", + "type": "BicepValueProxy", + "description": "The right operand." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Boolean", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/boolean", + "qualifiedName": "BicepValueFactoryProxy.boolean", + "description": "Creates a Boolean literal.", + "returns": "A Bicep Boolean value.", + "kind": "InstanceMethod", + "signature": "Boolean(value bool) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "The Boolean value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Concat", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/concat", + "qualifiedName": "BicepValueFactoryProxy.concat", + "description": "Creates a Bicep expression that concatenates string values.", + "returns": "A Bicep string concatenation expression.", + "kind": "InstanceMethod", + "signature": "Concat(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The values to concatenate." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Conditional", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/conditional", + "qualifiedName": "BicepValueFactoryProxy.conditional", + "description": "Creates a conditional Bicep expression.", + "returns": "A conditional Bicep expression.", + "kind": "InstanceMethod", + "signature": "Conditional(condition BicepValueProxy, consequent BicepValueProxy, alternate BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "condition", + "type": "BicepValueProxy", + "description": "The condition expression." + }, + { + "name": "consequent", + "type": "BicepValueProxy", + "description": "The value used when the condition is true." + }, + { + "name": "alternate", + "type": "BicepValueProxy", + "description": "The value used when the condition is false." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "CreateGuid", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/createGuid", + "qualifiedName": "BicepValueFactoryProxy.createGuid", + "description": "Creates a deterministic GUID from the supplied values.", + "returns": "A Bicep GUID expression.", + "kind": "InstanceMethod", + "signature": "CreateGuid(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The values used to create the GUID." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "CreateStringBuilder", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/createStringBuilder", + "qualifiedName": "BicepValueFactoryProxy.createStringBuilder", + "description": "Creates a builder for an interpolated Bicep string.", + "returns": "A Bicep string builder.", + "kind": "InstanceMethod", + "signature": "CreateStringBuilder() BicepStringBuilderProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepStringBuilderProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Deployment", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/deployment", + "qualifiedName": "BicepValueFactoryProxy.deployment", + "description": "Creates an expression for the current deployment.", + "returns": "A Bicep deployment expression.", + "kind": "InstanceMethod", + "signature": "Deployment() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Double", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/double", + "qualifiedName": "BicepValueFactoryProxy.double", + "description": "Creates a double-precision numeric literal.", + "returns": "A Bicep numeric value.", + "kind": "InstanceMethod", + "signature": "Double(value float64) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "The numeric value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Function", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/function", + "qualifiedName": "BicepValueFactoryProxy.function", + "description": "Creates a Bicep function-call expression.", + "returns": "A Bicep function-call expression.", + "kind": "InstanceMethod", + "signature": "Function(name string, args []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Bicep function name." + }, + { + "name": "args", + "type": "[]BicepValueProxy", + "description": "The function arguments." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Guid", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/guid", + "qualifiedName": "BicepValueFactoryProxy.guid", + "description": "Creates a GUID literal.", + "returns": "A Bicep GUID value.", + "kind": "InstanceMethod", + "signature": "Guid(value string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The GUID value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Identifier", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/identifier", + "qualifiedName": "BicepValueFactoryProxy.identifier", + "description": "Creates a Bicep identifier expression.", + "returns": "A Bicep identifier expression.", + "kind": "InstanceMethod", + "signature": "Identifier(bicepIdentifier string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string", + "description": "The Bicep identifier." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Index", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/index", + "qualifiedName": "BicepValueFactoryProxy.index", + "description": "Creates an expression that accesses an indexed value.", + "returns": "A Bicep index expression.", + "kind": "InstanceMethod", + "signature": "Index(value BicepValueProxy, index any) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to index." + }, + { + "name": "index", + "type": "any", + "allowedTypes": [ + "string", + "float64", + "BicepValueProxy" + ], + "description": "The string or integer index." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Integer", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/integer", + "qualifiedName": "BicepValueFactoryProxy.integer", + "description": "Creates an integer literal.", + "returns": "A Bicep integer value.", + "kind": "InstanceMethod", + "signature": "Integer(value float64) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "The integer value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Location", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/location", + "qualifiedName": "BicepValueFactoryProxy.location", + "description": "Creates an Azure location literal.", + "returns": "A Bicep Azure location value.", + "kind": "InstanceMethod", + "signature": "Location(name string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Azure location name." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Member", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/member", + "qualifiedName": "BicepValueFactoryProxy.member", + "description": "Creates an expression that accesses a named member.", + "returns": "A Bicep member-access expression.", + "kind": "InstanceMethod", + "signature": "Member(value BicepValueProxy, member string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value containing the member." + }, + { + "name": "member", + "type": "string", + "description": "The member name." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Parameter", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/parameter", + "qualifiedName": "BicepValueFactoryProxy.parameter", + "description": "Creates a Bicep parameter reference for an Aspire parameter.", + "returns": "A Bicep parameter reference.", + "kind": "InstanceMethod", + "signature": "Parameter(parameter ParameterResource, options ...*ParameterOptions) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "parameter", + "type": "ParameterResource", + "description": "The Aspire parameter resource." + } + ], + "options": { + "typeName": "ParameterOptions", + "fields": [ + { + "name": "BicepIdentifier", + "jsonName": "bicepIdentifier", + "type": "*string", + "description": "The optional Bicep parameter identifier." + } + ] + }, + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ParseJson", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/parseJson", + "qualifiedName": "BicepValueFactoryProxy.parseJson", + "description": "Creates an expression that parses a JSON string.", + "returns": "A Bicep JSON parsing expression.", + "kind": "InstanceMethod", + "signature": "ParseJson(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The JSON string value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ReferenceExpression", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/referenceExpression", + "qualifiedName": "BicepValueFactoryProxy.referenceExpression", + "description": "Creates a Bicep parameter reference for an Aspire reference expression.", + "returns": "A Bicep parameter reference.", + "kind": "InstanceMethod", + "signature": "ReferenceExpression(expression *ReferenceExpression, options ...*ReferenceExpressionOptions) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "expression", + "type": "*ReferenceExpression", + "description": "The Aspire reference expression." + } + ], + "options": { + "typeName": "ReferenceExpressionOptions", + "fields": [ + { + "name": "BicepIdentifier", + "jsonName": "bicepIdentifier", + "type": "*string", + "description": "The optional Bicep parameter identifier." + }, + { + "name": "IsSecure", + "jsonName": "isSecure", + "type": "*bool", + "description": "Whether the parameter contains secure data." + } + ] + }, + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ResourceGroup", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/resourceGroup", + "qualifiedName": "BicepValueFactoryProxy.resourceGroup", + "description": "Creates an expression for the current resource group.", + "returns": "A Bicep resource-group expression.", + "kind": "InstanceMethod", + "signature": "ResourceGroup() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ResourceIdentifier", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/resourceIdentifier", + "qualifiedName": "BicepValueFactoryProxy.resourceIdentifier", + "description": "Creates a Bicep identifier expression for a provisionable resource.", + "returns": "A Bicep resource identifier expression.", + "kind": "InstanceMethod", + "signature": "ResourceIdentifier(resource ProvisionableResourceProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "resource", + "type": "ProvisionableResourceProxy", + "description": "The provisionable resource." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "String", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/string", + "qualifiedName": "BicepValueFactoryProxy.string", + "description": "Creates a string literal.", + "returns": "A Bicep string value.", + "kind": "InstanceMethod", + "signature": "String(value string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The string value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Subscription", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/subscription", + "qualifiedName": "BicepValueFactoryProxy.subscription", + "description": "Creates an expression for the current subscription.", + "returns": "A Bicep subscription expression.", + "kind": "InstanceMethod", + "signature": "Subscription() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "SubscriptionResourceId", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/subscriptionResourceId", + "qualifiedName": "BicepValueFactoryProxy.subscriptionResourceId", + "description": "Creates a subscription-scoped resource identifier.", + "returns": "A Bicep subscription resource identifier expression.", + "kind": "InstanceMethod", + "signature": "SubscriptionResourceId(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The resource type and name segments." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Take", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/take", + "qualifiedName": "BicepValueFactoryProxy.take", + "description": "Creates a Bicep expression that takes characters from the start of a string.", + "returns": "A Bicep string expression.", + "kind": "InstanceMethod", + "signature": "Take(value any, count any) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "BicepValueProxy" + ], + "description": "The string value." + }, + { + "name": "count", + "type": "any", + "allowedTypes": [ + "float64", + "BicepValueProxy" + ], + "description": "The number of characters to take." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Tenant", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/tenant", + "qualifiedName": "BicepValueFactoryProxy.tenant", + "description": "Creates an expression for the current tenant.", + "returns": "A Bicep tenant expression.", + "kind": "InstanceMethod", + "signature": "Tenant() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "TimeSpan", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/timeSpan", + "qualifiedName": "BicepValueFactoryProxy.timeSpan", + "description": "Creates a time-span literal.", + "returns": "A Bicep time-span value.", + "kind": "InstanceMethod", + "signature": "TimeSpan(value float64) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "The time-span value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ToLower", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/toLower", + "qualifiedName": "BicepValueFactoryProxy.toLower", + "description": "Creates a lowercase string expression.", + "returns": "A lowercase Bicep string expression.", + "kind": "InstanceMethod", + "signature": "ToLower(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to convert." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ToUpper", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/toUpper", + "qualifiedName": "BicepValueFactoryProxy.toUpper", + "description": "Creates an uppercase string expression.", + "returns": "An uppercase Bicep string expression.", + "kind": "InstanceMethod", + "signature": "ToUpper(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to convert." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Unary", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/unary", + "qualifiedName": "BicepValueFactoryProxy.unary", + "description": "Creates a unary Bicep expression.", + "returns": "A unary Bicep expression.", + "kind": "InstanceMethod", + "signature": "Unary(operator UnaryBicepOperator, value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "operator", + "type": "UnaryBicepOperator", + "description": "The unary operator." + }, + { + "name": "value", + "type": "BicepValueProxy", + "description": "The operand." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "UniqueString", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/uniqueString", + "qualifiedName": "BicepValueFactoryProxy.uniqueString", + "description": "Creates a deterministic unique string from the supplied values.", + "returns": "A Bicep unique-string expression.", + "kind": "InstanceMethod", + "signature": "UniqueString(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The values used to create the unique string." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Uri", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/uri", + "qualifiedName": "BicepValueFactoryProxy.uri", + "description": "Creates a URI literal.", + "returns": "A Bicep URI value.", + "kind": "InstanceMethod", + "signature": "Uri(value string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The URI value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "IsSecure", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/BicepValueProxy.isSecure", + "qualifiedName": "BicepValueProxy.isSecure", + "description": "Gets whether the value contains secure data.", + "kind": "PropertyGetter", + "signature": "IsSecure() (bool, error)", + "receiver": "BicepValueProxy", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueProxy" + ], + "appliesTo": [ + "BicepValueProxy" + ] + }, + { + "name": "Kind", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/BicepValueProxy.kind", + "qualifiedName": "BicepValueProxy.kind", + "description": "Gets whether the value is unset, literal, or expression-backed.", + "kind": "PropertyGetter", + "signature": "Kind() (BicepValueKind, error)", + "receiver": "BicepValueProxy", + "parameters": [], + "returnType": "(BicepValueKind, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueProxy" + ], + "appliesTo": [ + "BicepValueProxy" + ] + }, + { + "name": "BicepIdentifier", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/ProvisionableResourceProxy.bicepIdentifier", + "qualifiedName": "ProvisionableResourceProxy.bicepIdentifier", + "description": "Gets the identifier used for this resource in the generated Bicep module.", + "kind": "PropertyGetter", + "signature": "BicepIdentifier() (string, error)", + "receiver": "ProvisionableResourceProxy", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.ProvisionableResourceProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.ProvisionableResourceProxy" + ], + "appliesTo": [ + "ProvisionableResourceProxy" + ] + }, + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting/ProvisioningOutputProxy.setValue", + "qualifiedName": "ProvisioningOutputProxy.setValue", + "description": "Sets the Value property", + "kind": "PropertySetter", + "signature": "SetValue(value BicepValueProxy) ProvisioningOutputProxy", + "receiver": "ProvisioningOutputProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy" + } + ], + "returnType": "ProvisioningOutputProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningOutputProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningOutputProxy" + ], + "appliesTo": [ + "ProvisioningOutputProxy" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting/ProvisioningOutputProxy.value", + "qualifiedName": "ProvisioningOutputProxy.value", + "description": "Gets the Value property", + "kind": "PropertyGetter", + "signature": "Value() BicepValueProxy", + "receiver": "ProvisioningOutputProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningOutputProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningOutputProxy" + ], + "appliesTo": [ + "ProvisioningOutputProxy" + ] + }, + { + "name": "IsSecure", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.isSecure", + "qualifiedName": "ProvisioningParameterProxy.isSecure", + "description": "Gets or sets whether the parameter is secure. Only string, object, and GUID parameters can be secure.", + "kind": "PropertyGetter", + "signature": "IsSecure() (bool, error)", + "receiver": "ProvisioningParameterProxy", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "SetIsSecure", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.setIsSecure", + "qualifiedName": "ProvisioningParameterProxy.setIsSecure", + "description": "Gets or sets whether the parameter is secure. Only string, object, and GUID parameters can be secure.", + "kind": "PropertySetter", + "signature": "SetIsSecure(value bool) ProvisioningParameterProxy", + "receiver": "ProvisioningParameterProxy", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the parameter is secure. Only string, object, and GUID parameters can be secure." + } + ], + "returnType": "ProvisioningParameterProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.setValue", + "qualifiedName": "ProvisioningParameterProxy.setValue", + "description": "Sets the Value property", + "kind": "PropertySetter", + "signature": "SetValue(value BicepValueProxy) ProvisioningParameterProxy", + "receiver": "ProvisioningParameterProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy" + } + ], + "returnType": "ProvisioningParameterProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.value", + "qualifiedName": "ProvisioningParameterProxy.value", + "description": "Gets the Value property", + "kind": "PropertyGetter", + "signature": "Value() BicepValueProxy", + "receiver": "ProvisioningParameterProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting/ProvisioningVariableProxy.setValue", + "qualifiedName": "ProvisioningVariableProxy.setValue", + "description": "Sets the Value property", + "kind": "PropertySetter", + "signature": "SetValue(value BicepValueProxy) ProvisioningVariableProxy", + "receiver": "ProvisioningVariableProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy" + } + ], + "returnType": "ProvisioningVariableProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningVariableProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningVariableProxy" + ], + "appliesTo": [ + "ProvisioningVariableProxy" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting/ProvisioningVariableProxy.value", + "qualifiedName": "ProvisioningVariableProxy.value", + "description": "Gets the Value property", + "kind": "PropertyGetter", + "signature": "Value() BicepValueProxy", + "receiver": "ProvisioningVariableProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningVariableProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningVariableProxy" + ], + "appliesTo": [ + "ProvisioningVariableProxy" + ] + }, + { + "name": "AddBicepOutput", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/addBicepOutput", + "qualifiedName": "addBicepOutput", + "kind": "Method", + "signature": "AddBicepOutput(bicepIdentifier string, type_ ProvisioningValueType) ProvisioningOutputProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string" + }, + { + "name": "type_", + "type": "ProvisioningValueType" + } + ], + "returnType": "ProvisioningOutputProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + }, + { + "name": "AddBicepParameter", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/addBicepParameter", + "qualifiedName": "addBicepParameter", + "description": "Adds a Bicep parameter. Only string, object, and GUID parameters can be secure.", + "kind": "Method", + "signature": "AddBicepParameter(bicepIdentifier string, type_ ProvisioningValueType, options ...*AddBicepParameterOptions) ProvisioningParameterProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string" + }, + { + "name": "type_", + "type": "ProvisioningValueType" + } + ], + "options": { + "typeName": "AddBicepParameterOptions", + "fields": [ + { + "name": "IsSecure", + "jsonName": "isSecure", + "type": "*bool" + } + ] + }, + "returnType": "ProvisioningParameterProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + }, + { + "name": "AddBicepVariable", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/addBicepVariable", + "qualifiedName": "addBicepVariable", + "kind": "Method", + "signature": "AddBicepVariable(bicepIdentifier string, type_ ProvisioningValueType) ProvisioningVariableProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string" + }, + { + "name": "type_", + "type": "ProvisioningValueType" + } + ], + "returnType": "ProvisioningVariableProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + }, + { + "name": "Bicep", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/bicep", + "qualifiedName": "bicep", + "description": "Creates a factory for composing Bicep values and expressions.", + "returns": "A factory for composing Bicep values and expressions.", + "kind": "Method", + "signature": "Bicep() BicepValueFactoryProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [], + "returnType": "BicepValueFactoryProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + } + ], + "handleTypes": [ + { + "name": "AzureResourceInfrastructure", + "fullName": "Aspire.Hosting.Azure.AzureResourceInfrastructure", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AddBicepOutput", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/addBicepOutput", + "qualifiedName": "addBicepOutput", + "kind": "Method", + "signature": "AddBicepOutput(bicepIdentifier string, type_ ProvisioningValueType) ProvisioningOutputProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string" + }, + { + "name": "type_", + "type": "ProvisioningValueType" + } + ], + "returnType": "ProvisioningOutputProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + }, + { + "name": "AddBicepParameter", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/addBicepParameter", + "qualifiedName": "addBicepParameter", + "description": "Adds a Bicep parameter. Only string, object, and GUID parameters can be secure.", + "kind": "Method", + "signature": "AddBicepParameter(bicepIdentifier string, type_ ProvisioningValueType, options ...*AddBicepParameterOptions) ProvisioningParameterProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string" + }, + { + "name": "type_", + "type": "ProvisioningValueType" + } + ], + "options": { + "typeName": "AddBicepParameterOptions", + "fields": [ + { + "name": "IsSecure", + "jsonName": "isSecure", + "type": "*bool" + } + ] + }, + "returnType": "ProvisioningParameterProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + }, + { + "name": "AddBicepVariable", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/addBicepVariable", + "qualifiedName": "addBicepVariable", + "kind": "Method", + "signature": "AddBicepVariable(bicepIdentifier string, type_ ProvisioningValueType) ProvisioningVariableProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string" + }, + { + "name": "type_", + "type": "ProvisioningValueType" + } + ], + "returnType": "ProvisioningVariableProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + }, + { + "name": "Bicep", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/bicep", + "qualifiedName": "bicep", + "description": "Creates a factory for composing Bicep values and expressions.", + "returns": "A factory for composing Bicep values and expressions.", + "kind": "Method", + "signature": "Bicep() BicepValueFactoryProxy", + "receiver": "AzureResourceInfrastructure", + "parameters": [], + "returnType": "BicepValueFactoryProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure/Aspire.Hosting.Azure.AzureResourceInfrastructure", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureResourceInfrastructure" + ], + "appliesTo": [ + "AzureResourceInfrastructure" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BicepStringBuilderProxy", + "fullName": "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "kind": "handle", + "description": "Builds an interpolated Bicep string from literal text and provisioning values.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AppendLiteral", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/appendLiteral", + "qualifiedName": "BicepStringBuilderProxy.appendLiteral", + "description": "Appends literal text to the interpolated Bicep string.", + "returns": "The string builder.", + "kind": "InstanceMethod", + "signature": "AppendLiteral(value string) BicepStringBuilderProxy", + "receiver": "BicepStringBuilderProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The literal text to append." + } + ], + "returnType": "BicepStringBuilderProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy" + ], + "appliesTo": [ + "BicepStringBuilderProxy" + ] + }, + { + "name": "AppendValue", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/appendValue", + "qualifiedName": "BicepStringBuilderProxy.appendValue", + "description": "Appends a provisioning value to the interpolated Bicep string.", + "returns": "The string builder.", + "kind": "InstanceMethod", + "signature": "AppendValue(value BicepValueProxy) BicepStringBuilderProxy", + "receiver": "BicepStringBuilderProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The provisioning value to append." + } + ], + "returnType": "BicepStringBuilderProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy" + ], + "appliesTo": [ + "BicepStringBuilderProxy" + ] + }, + { + "name": "Build", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/build", + "qualifiedName": "BicepStringBuilderProxy.build", + "description": "Builds the interpolated Bicep string.", + "returns": "The composed Bicep string value.", + "kind": "InstanceMethod", + "signature": "Build() BicepValueProxy", + "receiver": "BicepStringBuilderProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepStringBuilderProxy" + ], + "appliesTo": [ + "BicepStringBuilderProxy" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BicepValueFactoryProxy", + "fullName": "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "kind": "handle", + "description": "Creates and composes Azure Provisioning values for generated infrastructure proxies.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "AsString", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/asString", + "qualifiedName": "BicepValueFactoryProxy.asString", + "description": "Creates an explicitly typed Bicep string expression.", + "returns": "A Bicep string expression.", + "kind": "InstanceMethod", + "signature": "AsString(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to convert." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Binary", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/binary", + "qualifiedName": "BicepValueFactoryProxy.binary", + "description": "Creates a binary Bicep expression.", + "returns": "A binary Bicep expression.", + "kind": "InstanceMethod", + "signature": "Binary(left BicepValueProxy, operator BinaryBicepOperator, right BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "left", + "type": "BicepValueProxy", + "description": "The left operand." + }, + { + "name": "operator", + "type": "BinaryBicepOperator", + "description": "The binary operator." + }, + { + "name": "right", + "type": "BicepValueProxy", + "description": "The right operand." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Boolean", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/boolean", + "qualifiedName": "BicepValueFactoryProxy.boolean", + "description": "Creates a Boolean literal.", + "returns": "A Bicep Boolean value.", + "kind": "InstanceMethod", + "signature": "Boolean(value bool) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "The Boolean value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Concat", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/concat", + "qualifiedName": "BicepValueFactoryProxy.concat", + "description": "Creates a Bicep expression that concatenates string values.", + "returns": "A Bicep string concatenation expression.", + "kind": "InstanceMethod", + "signature": "Concat(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The values to concatenate." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Conditional", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/conditional", + "qualifiedName": "BicepValueFactoryProxy.conditional", + "description": "Creates a conditional Bicep expression.", + "returns": "A conditional Bicep expression.", + "kind": "InstanceMethod", + "signature": "Conditional(condition BicepValueProxy, consequent BicepValueProxy, alternate BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "condition", + "type": "BicepValueProxy", + "description": "The condition expression." + }, + { + "name": "consequent", + "type": "BicepValueProxy", + "description": "The value used when the condition is true." + }, + { + "name": "alternate", + "type": "BicepValueProxy", + "description": "The value used when the condition is false." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "CreateGuid", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/createGuid", + "qualifiedName": "BicepValueFactoryProxy.createGuid", + "description": "Creates a deterministic GUID from the supplied values.", + "returns": "A Bicep GUID expression.", + "kind": "InstanceMethod", + "signature": "CreateGuid(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The values used to create the GUID." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "CreateStringBuilder", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/createStringBuilder", + "qualifiedName": "BicepValueFactoryProxy.createStringBuilder", + "description": "Creates a builder for an interpolated Bicep string.", + "returns": "A Bicep string builder.", + "kind": "InstanceMethod", + "signature": "CreateStringBuilder() BicepStringBuilderProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepStringBuilderProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Deployment", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/deployment", + "qualifiedName": "BicepValueFactoryProxy.deployment", + "description": "Creates an expression for the current deployment.", + "returns": "A Bicep deployment expression.", + "kind": "InstanceMethod", + "signature": "Deployment() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Double", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/double", + "qualifiedName": "BicepValueFactoryProxy.double", + "description": "Creates a double-precision numeric literal.", + "returns": "A Bicep numeric value.", + "kind": "InstanceMethod", + "signature": "Double(value float64) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "The numeric value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Function", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/function", + "qualifiedName": "BicepValueFactoryProxy.function", + "description": "Creates a Bicep function-call expression.", + "returns": "A Bicep function-call expression.", + "kind": "InstanceMethod", + "signature": "Function(name string, args []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Bicep function name." + }, + { + "name": "args", + "type": "[]BicepValueProxy", + "description": "The function arguments." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Guid", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/guid", + "qualifiedName": "BicepValueFactoryProxy.guid", + "description": "Creates a GUID literal.", + "returns": "A Bicep GUID value.", + "kind": "InstanceMethod", + "signature": "Guid(value string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The GUID value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Identifier", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/identifier", + "qualifiedName": "BicepValueFactoryProxy.identifier", + "description": "Creates a Bicep identifier expression.", + "returns": "A Bicep identifier expression.", + "kind": "InstanceMethod", + "signature": "Identifier(bicepIdentifier string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "bicepIdentifier", + "type": "string", + "description": "The Bicep identifier." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Index", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/index", + "qualifiedName": "BicepValueFactoryProxy.index", + "description": "Creates an expression that accesses an indexed value.", + "returns": "A Bicep index expression.", + "kind": "InstanceMethod", + "signature": "Index(value BicepValueProxy, index any) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to index." + }, + { + "name": "index", + "type": "any", + "allowedTypes": [ + "string", + "float64", + "BicepValueProxy" + ], + "description": "The string or integer index." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Integer", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/integer", + "qualifiedName": "BicepValueFactoryProxy.integer", + "description": "Creates an integer literal.", + "returns": "A Bicep integer value.", + "kind": "InstanceMethod", + "signature": "Integer(value float64) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "The integer value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Location", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/location", + "qualifiedName": "BicepValueFactoryProxy.location", + "description": "Creates an Azure location literal.", + "returns": "A Bicep Azure location value.", + "kind": "InstanceMethod", + "signature": "Location(name string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Azure location name." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Member", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/member", + "qualifiedName": "BicepValueFactoryProxy.member", + "description": "Creates an expression that accesses a named member.", + "returns": "A Bicep member-access expression.", + "kind": "InstanceMethod", + "signature": "Member(value BicepValueProxy, member string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value containing the member." + }, + { + "name": "member", + "type": "string", + "description": "The member name." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Parameter", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/parameter", + "qualifiedName": "BicepValueFactoryProxy.parameter", + "description": "Creates a Bicep parameter reference for an Aspire parameter.", + "returns": "A Bicep parameter reference.", + "kind": "InstanceMethod", + "signature": "Parameter(parameter ParameterResource, options ...*ParameterOptions) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "parameter", + "type": "ParameterResource", + "description": "The Aspire parameter resource." + } + ], + "options": { + "typeName": "ParameterOptions", + "fields": [ + { + "name": "BicepIdentifier", + "jsonName": "bicepIdentifier", + "type": "*string", + "description": "The optional Bicep parameter identifier." + } + ] + }, + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ParseJson", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/parseJson", + "qualifiedName": "BicepValueFactoryProxy.parseJson", + "description": "Creates an expression that parses a JSON string.", + "returns": "A Bicep JSON parsing expression.", + "kind": "InstanceMethod", + "signature": "ParseJson(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The JSON string value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ReferenceExpression", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/referenceExpression", + "qualifiedName": "BicepValueFactoryProxy.referenceExpression", + "description": "Creates a Bicep parameter reference for an Aspire reference expression.", + "returns": "A Bicep parameter reference.", + "kind": "InstanceMethod", + "signature": "ReferenceExpression(expression *ReferenceExpression, options ...*ReferenceExpressionOptions) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "expression", + "type": "*ReferenceExpression", + "description": "The Aspire reference expression." + } + ], + "options": { + "typeName": "ReferenceExpressionOptions", + "fields": [ + { + "name": "BicepIdentifier", + "jsonName": "bicepIdentifier", + "type": "*string", + "description": "The optional Bicep parameter identifier." + }, + { + "name": "IsSecure", + "jsonName": "isSecure", + "type": "*bool", + "description": "Whether the parameter contains secure data." + } + ] + }, + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ResourceGroup", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/resourceGroup", + "qualifiedName": "BicepValueFactoryProxy.resourceGroup", + "description": "Creates an expression for the current resource group.", + "returns": "A Bicep resource-group expression.", + "kind": "InstanceMethod", + "signature": "ResourceGroup() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ResourceIdentifier", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/resourceIdentifier", + "qualifiedName": "BicepValueFactoryProxy.resourceIdentifier", + "description": "Creates a Bicep identifier expression for a provisionable resource.", + "returns": "A Bicep resource identifier expression.", + "kind": "InstanceMethod", + "signature": "ResourceIdentifier(resource ProvisionableResourceProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "resource", + "type": "ProvisionableResourceProxy", + "description": "The provisionable resource." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "String", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/string", + "qualifiedName": "BicepValueFactoryProxy.string", + "description": "Creates a string literal.", + "returns": "A Bicep string value.", + "kind": "InstanceMethod", + "signature": "String(value string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The string value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Subscription", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/subscription", + "qualifiedName": "BicepValueFactoryProxy.subscription", + "description": "Creates an expression for the current subscription.", + "returns": "A Bicep subscription expression.", + "kind": "InstanceMethod", + "signature": "Subscription() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "SubscriptionResourceId", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/subscriptionResourceId", + "qualifiedName": "BicepValueFactoryProxy.subscriptionResourceId", + "description": "Creates a subscription-scoped resource identifier.", + "returns": "A Bicep subscription resource identifier expression.", + "kind": "InstanceMethod", + "signature": "SubscriptionResourceId(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The resource type and name segments." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Take", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/take", + "qualifiedName": "BicepValueFactoryProxy.take", + "description": "Creates a Bicep expression that takes characters from the start of a string.", + "returns": "A Bicep string expression.", + "kind": "InstanceMethod", + "signature": "Take(value any, count any) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "any", + "allowedTypes": [ + "string", + "BicepValueProxy" + ], + "description": "The string value." + }, + { + "name": "count", + "type": "any", + "allowedTypes": [ + "float64", + "BicepValueProxy" + ], + "description": "The number of characters to take." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Tenant", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/tenant", + "qualifiedName": "BicepValueFactoryProxy.tenant", + "description": "Creates an expression for the current tenant.", + "returns": "A Bicep tenant expression.", + "kind": "InstanceMethod", + "signature": "Tenant() BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "TimeSpan", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/timeSpan", + "qualifiedName": "BicepValueFactoryProxy.timeSpan", + "description": "Creates a time-span literal.", + "returns": "A Bicep time-span value.", + "kind": "InstanceMethod", + "signature": "TimeSpan(value float64) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "The time-span value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ToLower", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/toLower", + "qualifiedName": "BicepValueFactoryProxy.toLower", + "description": "Creates a lowercase string expression.", + "returns": "A lowercase Bicep string expression.", + "kind": "InstanceMethod", + "signature": "ToLower(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to convert." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "ToUpper", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/toUpper", + "qualifiedName": "BicepValueFactoryProxy.toUpper", + "description": "Creates an uppercase string expression.", + "returns": "An uppercase Bicep string expression.", + "kind": "InstanceMethod", + "signature": "ToUpper(value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy", + "description": "The value to convert." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Unary", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/unary", + "qualifiedName": "BicepValueFactoryProxy.unary", + "description": "Creates a unary Bicep expression.", + "returns": "A unary Bicep expression.", + "kind": "InstanceMethod", + "signature": "Unary(operator UnaryBicepOperator, value BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "operator", + "type": "UnaryBicepOperator", + "description": "The unary operator." + }, + { + "name": "value", + "type": "BicepValueProxy", + "description": "The operand." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "UniqueString", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/uniqueString", + "qualifiedName": "BicepValueFactoryProxy.uniqueString", + "description": "Creates a deterministic unique string from the supplied values.", + "returns": "A Bicep unique-string expression.", + "kind": "InstanceMethod", + "signature": "UniqueString(values []BicepValueProxy) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "values", + "type": "[]BicepValueProxy", + "description": "The values used to create the unique string." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + }, + { + "name": "Uri", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/uri", + "qualifiedName": "BicepValueFactoryProxy.uri", + "description": "Creates a URI literal.", + "returns": "A Bicep URI value.", + "kind": "InstanceMethod", + "signature": "Uri(value string) BicepValueProxy", + "receiver": "BicepValueFactoryProxy", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The URI value." + } + ], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueFactoryProxy" + ], + "appliesTo": [ + "BicepValueFactoryProxy" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BicepValueProxy", + "fullName": "Aspire.Hosting.Azure.Provisioning.BicepValueProxy", + "kind": "handle", + "description": "Represents a literal, resource reference, or expression-backed Azure Provisioning value.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "IsSecure", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/BicepValueProxy.isSecure", + "qualifiedName": "BicepValueProxy.isSecure", + "description": "Gets whether the value contains secure data.", + "kind": "PropertyGetter", + "signature": "IsSecure() (bool, error)", + "receiver": "BicepValueProxy", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueProxy" + ], + "appliesTo": [ + "BicepValueProxy" + ] + }, + { + "name": "Kind", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/BicepValueProxy.kind", + "qualifiedName": "BicepValueProxy.kind", + "description": "Gets whether the value is unset, literal, or expression-backed.", + "kind": "PropertyGetter", + "signature": "Kind() (BicepValueKind, error)", + "receiver": "BicepValueProxy", + "parameters": [], + "returnType": "(BicepValueKind, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.BicepValueProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.BicepValueProxy" + ], + "appliesTo": [ + "BicepValueProxy" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProvisionableResourceProxy", + "fullName": "Aspire.Hosting.Azure.Provisioning.ProvisionableResourceProxy", + "kind": "handle", + "description": "Represents a resource declaration in an Azure Provisioning infrastructure model.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "BicepIdentifier", + "capabilityId": "Aspire.Hosting.Azure.Provisioning/ProvisionableResourceProxy.bicepIdentifier", + "qualifiedName": "ProvisionableResourceProxy.bicepIdentifier", + "description": "Gets the identifier used for this resource in the generated Bicep module.", + "kind": "PropertyGetter", + "signature": "BicepIdentifier() (string, error)", + "receiver": "ProvisionableResourceProxy", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.Azure.Provisioning.ProvisionableResourceProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.Provisioning.ProvisionableResourceProxy" + ], + "appliesTo": [ + "ProvisionableResourceProxy" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProvisioningOutputProxy", + "fullName": "Aspire.Hosting.ProvisioningOutputProxy", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting/ProvisioningOutputProxy.setValue", + "qualifiedName": "ProvisioningOutputProxy.setValue", + "description": "Sets the Value property", + "kind": "PropertySetter", + "signature": "SetValue(value BicepValueProxy) ProvisioningOutputProxy", + "receiver": "ProvisioningOutputProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy" + } + ], + "returnType": "ProvisioningOutputProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningOutputProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningOutputProxy" + ], + "appliesTo": [ + "ProvisioningOutputProxy" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting/ProvisioningOutputProxy.value", + "qualifiedName": "ProvisioningOutputProxy.value", + "description": "Gets the Value property", + "kind": "PropertyGetter", + "signature": "Value() BicepValueProxy", + "receiver": "ProvisioningOutputProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningOutputProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningOutputProxy" + ], + "appliesTo": [ + "ProvisioningOutputProxy" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProvisioningParameterProxy", + "fullName": "Aspire.Hosting.ProvisioningParameterProxy", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "IsSecure", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.isSecure", + "qualifiedName": "ProvisioningParameterProxy.isSecure", + "description": "Gets or sets whether the parameter is secure. Only string, object, and GUID parameters can be secure.", + "kind": "PropertyGetter", + "signature": "IsSecure() (bool, error)", + "receiver": "ProvisioningParameterProxy", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "SetIsSecure", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.setIsSecure", + "qualifiedName": "ProvisioningParameterProxy.setIsSecure", + "description": "Gets or sets whether the parameter is secure. Only string, object, and GUID parameters can be secure.", + "kind": "PropertySetter", + "signature": "SetIsSecure(value bool) ProvisioningParameterProxy", + "receiver": "ProvisioningParameterProxy", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the parameter is secure. Only string, object, and GUID parameters can be secure." + } + ], + "returnType": "ProvisioningParameterProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.setValue", + "qualifiedName": "ProvisioningParameterProxy.setValue", + "description": "Sets the Value property", + "kind": "PropertySetter", + "signature": "SetValue(value BicepValueProxy) ProvisioningParameterProxy", + "receiver": "ProvisioningParameterProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy" + } + ], + "returnType": "ProvisioningParameterProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting/ProvisioningParameterProxy.value", + "qualifiedName": "ProvisioningParameterProxy.value", + "description": "Gets the Value property", + "kind": "PropertyGetter", + "signature": "Value() BicepValueProxy", + "receiver": "ProvisioningParameterProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningParameterProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningParameterProxy" + ], + "appliesTo": [ + "ProvisioningParameterProxy" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ProvisioningVariableProxy", + "fullName": "Aspire.Hosting.ProvisioningVariableProxy", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "SetValue", + "capabilityId": "Aspire.Hosting/ProvisioningVariableProxy.setValue", + "qualifiedName": "ProvisioningVariableProxy.setValue", + "description": "Sets the Value property", + "kind": "PropertySetter", + "signature": "SetValue(value BicepValueProxy) ProvisioningVariableProxy", + "receiver": "ProvisioningVariableProxy", + "parameters": [ + { + "name": "value", + "type": "BicepValueProxy" + } + ], + "returnType": "ProvisioningVariableProxy", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningVariableProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningVariableProxy" + ], + "appliesTo": [ + "ProvisioningVariableProxy" + ] + }, + { + "name": "Value", + "capabilityId": "Aspire.Hosting/ProvisioningVariableProxy.value", + "qualifiedName": "ProvisioningVariableProxy.value", + "description": "Gets the Value property", + "kind": "PropertyGetter", + "signature": "Value() BicepValueProxy", + "receiver": "ProvisioningVariableProxy", + "parameters": [], + "returnType": "BicepValueProxy", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Provisioning/Aspire.Hosting.ProvisioningVariableProxy", + "expandedTargetTypes": [ + "Aspire.Hosting.ProvisioningVariableProxy" + ], + "appliesTo": [ + "ProvisioningVariableProxy" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "ProvisioningValueType", + "fullName": "Aspire.Hosting.ProvisioningValueType", + "kind": "enum", + "description": "Identifies the literal type of a Bicep declaration.", + "members": [ + { + "name": "ProvisioningValueTypeString", + "value": "String" + }, + { + "name": "ProvisioningValueTypeBoolean", + "value": "Boolean" + }, + { + "name": "ProvisioningValueTypeInteger", + "value": "Integer" + }, + { + "name": "ProvisioningValueTypeObject", + "value": "Object" + }, + { + "name": "ProvisioningValueTypeGuid", + "value": "Guid" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Redis.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Redis.13.6.0.json new file mode 100644 index 0000000000..bd453c13ae --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Redis.13.6.0.json @@ -0,0 +1,526 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Redis", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.connectionStringExpression", + "qualifiedName": "AzureManagedRedisResource.connectionStringExpression", + "description": "Gets the connection string template for the manifest for the Azure Managed Redis resource.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "HostName", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.hostName", + "qualifiedName": "AzureManagedRedisResource.hostName", + "description": "Gets the host name for the Redis server.", + "remarks": "In container mode, resolves to the container's primary endpoint host and port.\nIn Azure mode, resolves to the Azure Redis server's hostname.", + "kind": "PropertyGetter", + "signature": "HostName() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "Id", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.id", + "qualifiedName": "AzureManagedRedisResource.id", + "description": "Gets the \"id\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "Id() BicepOutputReference", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "NameOutputReference", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.nameOutputReference", + "qualifiedName": "AzureManagedRedisResource.nameOutputReference", + "description": "Gets the \"name\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "NameOutputReference() BicepOutputReference", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "Password", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.password", + "qualifiedName": "AzureManagedRedisResource.password", + "description": "Gets the password/access key for the Redis server.", + "remarks": "-\n-\n-", + "kind": "PropertyGetter", + "signature": "Password() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.port", + "qualifiedName": "AzureManagedRedisResource.port", + "description": "Gets the port for the Redis server.", + "remarks": "In container mode, resolves to the container's primary endpoint port.\nIn Azure mode, resolves to 10000.", + "kind": "PropertyGetter", + "signature": "Port() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.uriExpression", + "qualifiedName": "AzureManagedRedisResource.uriExpression", + "description": "Gets the connection URI expression for the Redis server.", + "remarks": "Format: `redis://[:{password}@]{host}:{port}`. The password segment is omitted when using Entra ID authentication in Azure mode.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "UseAccessKeyAuthentication", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.useAccessKeyAuthentication", + "qualifiedName": "AzureManagedRedisResource.useAccessKeyAuthentication", + "description": "Gets a value indicating whether the resource uses access key authentication.", + "kind": "PropertyGetter", + "signature": "UseAccessKeyAuthentication() (bool, error)", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "AddAzureManagedRedis", + "capabilityId": "Aspire.Hosting.Azure.Redis/addAzureManagedRedis", + "qualifiedName": "addAzureManagedRedis", + "description": "Adds an Azure Managed Redis resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureManagedRedis(name string) AzureManagedRedisResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureManagedRedisResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "RunAsContainer", + "capabilityId": "Aspire.Hosting.Azure.Redis/runAsContainer", + "qualifiedName": "runAsContainer", + "description": "Configures an Azure Managed Redis resource to run locally in a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsContainer(options ...*RunAsContainerOptions) AzureManagedRedisResource", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "options": { + "typeName": "RunAsContainerOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj RedisResource)", + "isCallback": true, + "callbackSignature": "func(obj RedisResource)", + "description": "Callback that exposes underlying container to allow for customization." + } + ] + }, + "returnType": "AzureManagedRedisResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "WithAccessKeyAuthentication", + "capabilityId": "Aspire.Hosting.Azure.Redis/withAccessKeyAuthentication", + "qualifiedName": "withAccessKeyAuthentication", + "description": "Configures Azure Managed Redis to use access key authentication", + "kind": "Method", + "signature": "WithAccessKeyAuthentication(options ...*WithAccessKeyAuthenticationOptions) AzureManagedRedisResource", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "options": { + "typeName": "WithAccessKeyAuthenticationOptions", + "fields": [ + { + "name": "KeyVaultBuilder", + "jsonName": "keyVaultBuilder", + "type": "*AzureKeyVaultResource" + } + ] + }, + "returnType": "AzureManagedRedisResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + } + ], + "handleTypes": [ + { + "name": "RedisResource", + "fullName": "Aspire.Hosting.ApplicationModel.RedisResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureManagedRedisResource", + "fullName": "Aspire.Hosting.Azure.AzureManagedRedisResource", + "kind": "handle", + "description": "Represents an Azure Managed Redis resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.connectionStringExpression", + "qualifiedName": "AzureManagedRedisResource.connectionStringExpression", + "description": "Gets the connection string template for the manifest for the Azure Managed Redis resource.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "HostName", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.hostName", + "qualifiedName": "AzureManagedRedisResource.hostName", + "description": "Gets the host name for the Redis server.", + "remarks": "In container mode, resolves to the container's primary endpoint host and port.\nIn Azure mode, resolves to the Azure Redis server's hostname.", + "kind": "PropertyGetter", + "signature": "HostName() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "Id", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.id", + "qualifiedName": "AzureManagedRedisResource.id", + "description": "Gets the \"id\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "Id() BicepOutputReference", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "NameOutputReference", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.nameOutputReference", + "qualifiedName": "AzureManagedRedisResource.nameOutputReference", + "description": "Gets the \"name\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "NameOutputReference() BicepOutputReference", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "Password", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.password", + "qualifiedName": "AzureManagedRedisResource.password", + "description": "Gets the password/access key for the Redis server.", + "remarks": "-\n-\n-", + "kind": "PropertyGetter", + "signature": "Password() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.port", + "qualifiedName": "AzureManagedRedisResource.port", + "description": "Gets the port for the Redis server.", + "remarks": "In container mode, resolves to the container's primary endpoint port.\nIn Azure mode, resolves to 10000.", + "kind": "PropertyGetter", + "signature": "Port() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.uriExpression", + "qualifiedName": "AzureManagedRedisResource.uriExpression", + "description": "Gets the connection URI expression for the Redis server.", + "remarks": "Format: `redis://[:{password}@]{host}:{port}`. The password segment is omitted when using Entra ID authentication in Azure mode.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "UseAccessKeyAuthentication", + "capabilityId": "Aspire.Hosting.Azure/AzureManagedRedisResource.useAccessKeyAuthentication", + "qualifiedName": "AzureManagedRedisResource.useAccessKeyAuthentication", + "description": "Gets a value indicating whether the resource uses access key authentication.", + "kind": "PropertyGetter", + "signature": "UseAccessKeyAuthentication() (bool, error)", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "RunAsContainer", + "capabilityId": "Aspire.Hosting.Azure.Redis/runAsContainer", + "qualifiedName": "runAsContainer", + "description": "Configures an Azure Managed Redis resource to run locally in a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsContainer(options ...*RunAsContainerOptions) AzureManagedRedisResource", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "options": { + "typeName": "RunAsContainerOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj RedisResource)", + "isCallback": true, + "callbackSignature": "func(obj RedisResource)", + "description": "Callback that exposes underlying container to allow for customization." + } + ] + }, + "returnType": "AzureManagedRedisResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + }, + { + "name": "WithAccessKeyAuthentication", + "capabilityId": "Aspire.Hosting.Azure.Redis/withAccessKeyAuthentication", + "qualifiedName": "withAccessKeyAuthentication", + "description": "Configures Azure Managed Redis to use access key authentication", + "kind": "Method", + "signature": "WithAccessKeyAuthentication(options ...*WithAccessKeyAuthenticationOptions) AzureManagedRedisResource", + "receiver": "AzureManagedRedisResource", + "parameters": [], + "options": { + "typeName": "WithAccessKeyAuthenticationOptions", + "fields": [ + { + "name": "KeyVaultBuilder", + "jsonName": "keyVaultBuilder", + "type": "*AzureKeyVaultResource" + } + ] + }, + "returnType": "AzureManagedRedisResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Redis/Aspire.Hosting.Azure.AzureManagedRedisResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureManagedRedisResource" + ], + "appliesTo": [ + "AzureManagedRedisResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BicepOutputReference", + "fullName": "Aspire.Hosting.Azure.BicepOutputReference", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultResource", + "fullName": "Aspire.Hosting.Azure.IAzureKeyVaultResource", + "kind": "handle", + "isInterface": true, + "isMarker": true, + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Sandboxes.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Sandboxes.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..fe2879506a --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Sandboxes.13.6.0-preview.1.26478.8.json @@ -0,0 +1,468 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Sandboxes", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureSandboxGroup", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/addAzureSandboxGroup", + "qualifiedName": "addAzureSandboxGroup", + "description": "Adds an Azure Container Apps sandbox group resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureSandboxGroup(name string) AzureSandboxGroupResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureSandboxGroupResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "PublishAsAzureSandbox", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/publishComputeResourceAsAzureSandbox", + "qualifiedName": "publishAsAzureSandbox", + "description": "Configures the specified compute resource when it is published as an Azure sandbox container.", + "remarks": "When the application model contains a single compute environment, Aspire assigns the resource to that environment\nautomatically. When multiple compute environments exist, call `WithComputeEnvironment` before this method.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsAzureSandbox(options ...*AzureSandboxOptions) IComputeResource", + "receiver": "IComputeResource", + "parameters": [], + "options": { + "typeName": "AzureSandboxOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithAcrPullIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withAcrPullIdentity", + "qualifiedName": "withAcrPullIdentity", + "description": "Configures the user-assigned managed identity that Azure Dev Compute uses to pull sandbox images from the configured Azure Container Registry.", + "remarks": "The supplied identity must be attached to an existing sandbox group and have the `AcrPull`\nrole on its registry. For sandbox groups created by Aspire, the identity is attached automatically,\nbut the caller remains responsible for granting `AcrPull`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAcrPullIdentity(identity AzureUserAssignedIdentityResource) AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [ + { + "name": "identity", + "type": "AzureUserAssignedIdentityResource", + "description": "The user-assigned managed identity resource." + } + ], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + }, + { + "name": "WithNoManagedIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withNoManagedIdentity", + "qualifiedName": "withNoManagedIdentity", + "description": "Clears the managed identities explicitly configured for sandbox workloads.", + "remarks": "Workload identities requested by individual compute resources are added to the sandbox group during\ndeployment preparation. Image pulls require a separate user-assigned identity. Aspire creates one by\ndefault for new groups; callers can select one with `WithAcrPullIdentity` and must do so for existing groups.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithNoManagedIdentity() AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + }, + { + "name": "WithSystemAssignedIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withSystemAssignedIdentity", + "qualifiedName": "withSystemAssignedIdentity", + "description": "Configures a system-assigned managed identity for sandbox workloads.", + "remarks": "Image pulls require a separate user-assigned identity. Aspire creates one by default for new groups;\ncallers can select one with `WithAcrPullIdentity` and must do so for existing groups. Workload identities\nrequested by individual compute resources may add more user-assigned identities.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSystemAssignedIdentity() AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + }, + { + "name": "WithUserAssignedIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withUserAssignedIdentity", + "qualifiedName": "withUserAssignedIdentity", + "description": "Adds a user-assigned managed identity for sandbox workloads.", + "remarks": "Image pulls require a separate user-assigned identity. Aspire creates one by default for new groups;\ncallers can select one with `WithAcrPullIdentity` and must do so for existing groups.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUserAssignedIdentity(identity AzureUserAssignedIdentityResource) AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [ + { + "name": "identity", + "type": "AzureUserAssignedIdentityResource", + "description": "The user-assigned managed identity resource." + } + ], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureSandboxGroupResource", + "fullName": "Aspire.Hosting.Azure.AzureSandboxGroupResource", + "kind": "handle", + "description": "Represents an Azure Container Apps sandbox group.", + "implementedInterfaces": [ + "ComputeEnvironmentResource", + "Resource" + ], + "capabilities": [ + { + "name": "WithAcrPullIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withAcrPullIdentity", + "qualifiedName": "withAcrPullIdentity", + "description": "Configures the user-assigned managed identity that Azure Dev Compute uses to pull sandbox images from the configured Azure Container Registry.", + "remarks": "The supplied identity must be attached to an existing sandbox group and have the `AcrPull`\nrole on its registry. For sandbox groups created by Aspire, the identity is attached automatically,\nbut the caller remains responsible for granting `AcrPull`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAcrPullIdentity(identity AzureUserAssignedIdentityResource) AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [ + { + "name": "identity", + "type": "AzureUserAssignedIdentityResource", + "description": "The user-assigned managed identity resource." + } + ], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + }, + { + "name": "WithNoManagedIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withNoManagedIdentity", + "qualifiedName": "withNoManagedIdentity", + "description": "Clears the managed identities explicitly configured for sandbox workloads.", + "remarks": "Workload identities requested by individual compute resources are added to the sandbox group during\ndeployment preparation. Image pulls require a separate user-assigned identity. Aspire creates one by\ndefault for new groups; callers can select one with `WithAcrPullIdentity` and must do so for existing groups.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithNoManagedIdentity() AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + }, + { + "name": "WithSystemAssignedIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withSystemAssignedIdentity", + "qualifiedName": "withSystemAssignedIdentity", + "description": "Configures a system-assigned managed identity for sandbox workloads.", + "remarks": "Image pulls require a separate user-assigned identity. Aspire creates one by default for new groups;\ncallers can select one with `WithAcrPullIdentity` and must do so for existing groups. Workload identities\nrequested by individual compute resources may add more user-assigned identities.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSystemAssignedIdentity() AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + }, + { + "name": "WithUserAssignedIdentity", + "capabilityId": "Aspire.Hosting.Azure.Sandboxes/withUserAssignedIdentity", + "qualifiedName": "withUserAssignedIdentity", + "description": "Adds a user-assigned managed identity for sandbox workloads.", + "remarks": "Image pulls require a separate user-assigned identity. Aspire creates one by default for new groups;\ncallers can select one with `WithAcrPullIdentity` and must do so for existing groups.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithUserAssignedIdentity(identity AzureUserAssignedIdentityResource) AzureSandboxGroupResource", + "receiver": "AzureSandboxGroupResource", + "parameters": [ + { + "name": "identity", + "type": "AzureUserAssignedIdentityResource", + "description": "The user-assigned managed identity resource." + } + ], + "returnType": "AzureSandboxGroupResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sandboxes/Aspire.Hosting.Azure.AzureSandboxGroupResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSandboxGroupResource" + ], + "appliesTo": [ + "AzureSandboxGroupResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "AzureSandboxEndpointOptions", + "fullName": "Aspire.Hosting.Azure.AzureSandboxEndpointOptions", + "kind": "dto", + "description": "Overrides Azure sandbox options for a compute resource endpoint.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "*string", + "description": "Gets or sets the Aspire endpoint name." + }, + { + "name": "Anonymous", + "jsonName": "Anonymous", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether the sandbox port allows anonymous access." + } + ] + }, + { + "name": "AzureSandboxOptions", + "fullName": "Aspire.Hosting.Azure.AzureSandboxOptions", + "kind": "dto", + "description": "Configures Azure sandbox runtime options for a compute resource.", + "fields": [ + { + "name": "Tier", + "jsonName": "Tier", + "type": "AzureSandboxTier", + "description": "Gets or sets the resource tier." + }, + { + "name": "AutoSuspendEnabled", + "jsonName": "AutoSuspendEnabled", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether auto-suspend is enabled." + }, + { + "name": "AutoSuspendInterval", + "jsonName": "AutoSuspendInterval", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the idle interval before auto-suspend runs." + }, + { + "name": "AutoSuspendMode", + "jsonName": "AutoSuspendMode", + "type": "*AzureSandboxAutoSuspendMode", + "isOptional": true, + "description": "Gets or sets the sandbox suspend mode." + }, + { + "name": "AutoDeleteEnabled", + "jsonName": "AutoDeleteEnabled", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets a value indicating whether auto-delete is enabled." + }, + { + "name": "AutoDeleteInterval", + "jsonName": "AutoDeleteInterval", + "type": "*float64", + "isOptional": true, + "description": "Gets or sets the interval before auto-delete runs." + }, + { + "name": "AutoDeleteTrigger", + "jsonName": "AutoDeleteTrigger", + "type": "*AzureSandboxAutoDeleteTrigger", + "isOptional": true, + "description": "Gets or sets the event that starts the auto-delete interval." + }, + { + "name": "Endpoints", + "jsonName": "Endpoints", + "type": "[]*AzureSandboxEndpointOptions", + "description": "Gets or sets endpoint-specific sandbox option overrides." + } + ] + } + ], + "enumTypes": [ + { + "name": "AzureSandboxAutoDeleteTrigger", + "fullName": "Aspire.Hosting.Azure.AzureSandboxAutoDeleteTrigger", + "kind": "enum", + "description": "Events that can start the Azure Container Apps sandbox auto-delete interval.", + "members": [ + { + "name": "AzureSandboxAutoDeleteTriggerAfterSuspend", + "value": "AfterSuspend", + "description": "Starts the interval after the sandbox is suspended." + }, + { + "name": "AzureSandboxAutoDeleteTriggerAfterCreation", + "value": "AfterCreation", + "description": "Starts the interval after the sandbox is created." + } + ] + }, + { + "name": "AzureSandboxAutoSuspendMode", + "fullName": "Aspire.Hosting.Azure.AzureSandboxAutoSuspendMode", + "kind": "enum", + "description": "Azure Container Apps sandbox auto-suspend modes.", + "members": [ + { + "name": "AzureSandboxAutoSuspendModeNone", + "value": "None", + "description": "Disables snapshot preservation." + }, + { + "name": "AzureSandboxAutoSuspendModeMemory", + "value": "Memory", + "description": "Preserves memory and disk state." + }, + { + "name": "AzureSandboxAutoSuspendModeDisk", + "value": "Disk", + "description": "Preserves disk state only." + } + ] + }, + { + "name": "AzureSandboxTier", + "fullName": "Aspire.Hosting.Azure.AzureSandboxTier", + "kind": "enum", + "description": "Azure Container Apps sandbox resource tiers.", + "members": [ + { + "name": "AzureSandboxTierExtraSmall", + "value": "ExtraSmall", + "description": "0.25 vCPU, 0.5 GiB memory, and 5 GiB disk." + }, + { + "name": "AzureSandboxTierSmall", + "value": "Small", + "description": "0.5 vCPU, 1 GiB memory, and 10 GiB disk." + }, + { + "name": "AzureSandboxTierMedium", + "value": "Medium", + "description": "1 vCPU, 2 GiB memory, and 20 GiB disk." + }, + { + "name": "AzureSandboxTierLarge", + "value": "Large", + "description": "2 vCPU, 4 GiB memory, and 40 GiB disk." + }, + { + "name": "AzureSandboxTierExtraLarge", + "value": "ExtraLarge", + "description": "4 vCPU, 8 GiB memory, and 80 GiB disk." + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Search.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Search.13.6.0.json new file mode 100644 index 0000000000..d7b85fd4b4 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Search.13.6.0.json @@ -0,0 +1,166 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Search", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureSearch", + "capabilityId": "Aspire.Hosting.Azure.Search/addAzureSearch", + "qualifiedName": "addAzureSearch", + "description": "Adds an Azure AI Search service resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureSearch(name string) AzureSearchResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure AI Search resource." + } + ], + "returnType": "AzureSearchResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithSearchRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.Search/withSearchRoleAssignments", + "qualifiedName": "withSearchRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure AI Search service resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSearchRoleAssignments(target AzureSearchResource, roles []AzureSearchRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureSearchResource", + "description": "The target Azure AI Search service resource." + }, + { + "name": "roles", + "type": "[]AzureSearchRole", + "description": "The Azure AI Search roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureSearchResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureSearchResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSearchResource", + "fullName": "Aspire.Hosting.Azure.AzureSearchResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureSearchRole", + "fullName": "Aspire.Hosting.AzureSearchRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure AI Search roles.", + "members": [ + { + "name": "AzureSearchRoleSearchIndexDataContributor", + "value": "SearchIndexDataContributor" + }, + { + "name": "AzureSearchRoleSearchIndexDataReader", + "value": "SearchIndexDataReader" + }, + { + "name": "AzureSearchRoleSearchServiceContributor", + "value": "SearchServiceContributor" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ServiceBus.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ServiceBus.13.6.0.json new file mode 100644 index 0000000000..46917d211b --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.ServiceBus.13.6.0.json @@ -0,0 +1,3183 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.ServiceBus", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.connectionStringExpression", + "qualifiedName": "AzureServiceBusQueueResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Service Bus Queue.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "DeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.deadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusQueueResource.deadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertyGetter", + "signature": "DeadLetteringOnMessageExpiration() (*bool, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "DefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.defaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusQueueResource.defaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertyGetter", + "signature": "DefaultMessageTimeToLive() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "DuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.duplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusQueueResource.duplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertyGetter", + "signature": "DuplicateDetectionHistoryTimeWindow() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "ForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.forwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusQueueResource.forwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertyGetter", + "signature": "ForwardDeadLetteredMessagesTo() (*string, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "ForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.forwardTo", + "qualifiedName": "AzureServiceBusQueueResource.forwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertyGetter", + "signature": "ForwardTo() (*string, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "LockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.lockDuration", + "qualifiedName": "AzureServiceBusQueueResource.lockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertyGetter", + "signature": "LockDuration() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "MaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.maxDeliveryCount", + "qualifiedName": "AzureServiceBusQueueResource.maxDeliveryCount", + "description": "The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.", + "kind": "PropertyGetter", + "signature": "MaxDeliveryCount() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.parent", + "qualifiedName": "AzureServiceBusQueueResource.parent", + "description": "Gets the parent Azure Service Bus resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureServiceBusResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "AzureServiceBusResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "QueueName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.queueName", + "qualifiedName": "AzureServiceBusQueueResource.queueName", + "description": "The queue name.", + "kind": "PropertyGetter", + "signature": "QueueName() (string, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "RequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.requiresDuplicateDetection", + "qualifiedName": "AzureServiceBusQueueResource.requiresDuplicateDetection", + "description": "A value indicating if this queue requires duplicate detection.", + "kind": "PropertyGetter", + "signature": "RequiresDuplicateDetection() (*bool, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "RequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.requiresSession", + "qualifiedName": "AzureServiceBusQueueResource.requiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertyGetter", + "signature": "RequiresSession() (*bool, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetDeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setDeadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusQueueResource.setDeadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertySetter", + "signature": "SetDeadLetteringOnMessageExpiration(value *bool) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetDefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setDefaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusQueueResource.setDefaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertySetter", + "signature": "SetDefaultMessageTimeToLive(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetDuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setDuplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusQueueResource.setDuplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertySetter", + "signature": "SetDuplicateDetectionHistoryTimeWindow(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setForwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusQueueResource.setForwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertySetter", + "signature": "SetForwardDeadLetteredMessagesTo(value *string) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the Dead Letter message." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setForwardTo", + "qualifiedName": "AzureServiceBusQueueResource.setForwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertySetter", + "signature": "SetForwardTo(value *string) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the messages." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetLockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setLockDuration", + "qualifiedName": "AzureServiceBusQueueResource.setLockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertySetter", + "signature": "SetLockDuration(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetMaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setMaxDeliveryCount", + "qualifiedName": "AzureServiceBusQueueResource.setMaxDeliveryCount", + "description": "The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.", + "kind": "PropertySetter", + "signature": "SetMaxDeliveryCount(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "The maximum delivery count. A message is automatically dead-lettered after this number of deliveries." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetQueueName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setQueueName", + "qualifiedName": "AzureServiceBusQueueResource.setQueueName", + "description": "The queue name.", + "kind": "PropertySetter", + "signature": "SetQueueName(value string) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The queue name." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetRequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setRequiresDuplicateDetection", + "qualifiedName": "AzureServiceBusQueueResource.setRequiresDuplicateDetection", + "description": "A value indicating if this queue requires duplicate detection.", + "kind": "PropertySetter", + "signature": "SetRequiresDuplicateDetection(value *bool) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value indicating if this queue requires duplicate detection." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetRequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setRequiresSession", + "qualifiedName": "AzureServiceBusQueueResource.setRequiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertySetter", + "signature": "SetRequiresSession(value *bool) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether the queue supports the concept of sessions." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.connectionStringExpression", + "qualifiedName": "AzureServiceBusSubscriptionResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Service Bus Subscription.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "DeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.deadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusSubscriptionResource.deadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertyGetter", + "signature": "DeadLetteringOnMessageExpiration() (*bool, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "DefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.defaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusSubscriptionResource.defaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertyGetter", + "signature": "DefaultMessageTimeToLive() (*float64, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "ForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.forwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.forwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertyGetter", + "signature": "ForwardDeadLetteredMessagesTo() (*string, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "ForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.forwardTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.forwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertyGetter", + "signature": "ForwardTo() (*string, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "LockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.lockDuration", + "qualifiedName": "AzureServiceBusSubscriptionResource.lockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertyGetter", + "signature": "LockDuration() (*float64, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "MaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.maxDeliveryCount", + "qualifiedName": "AzureServiceBusSubscriptionResource.maxDeliveryCount", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.", + "kind": "PropertyGetter", + "signature": "MaxDeliveryCount() (*float64, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.parent", + "qualifiedName": "AzureServiceBusSubscriptionResource.parent", + "description": "Gets the parent Azure Service Bus Topic resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureServiceBusTopicResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "AzureServiceBusTopicResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "RequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.requiresSession", + "qualifiedName": "AzureServiceBusSubscriptionResource.requiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertyGetter", + "signature": "RequiresSession() (*bool, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "Rules", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.rules", + "qualifiedName": "AzureServiceBusSubscriptionResource.rules", + "description": "The rules for this subscription.", + "kind": "PropertyGetter", + "signature": "Rules() *List[*AzureServiceBusRule]", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "*List[*AzureServiceBusRule]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetDeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setDeadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusSubscriptionResource.setDeadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertySetter", + "signature": "SetDeadLetteringOnMessageExpiration(value *bool) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetDefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setDefaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusSubscriptionResource.setDefaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertySetter", + "signature": "SetDefaultMessageTimeToLive(value *float64) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setForwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.setForwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertySetter", + "signature": "SetForwardDeadLetteredMessagesTo(value *string) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the Dead Letter message." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setForwardTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.setForwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertySetter", + "signature": "SetForwardTo(value *string) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the messages." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetLockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setLockDuration", + "qualifiedName": "AzureServiceBusSubscriptionResource.setLockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertySetter", + "signature": "SetLockDuration(value *float64) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetMaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setMaxDeliveryCount", + "qualifiedName": "AzureServiceBusSubscriptionResource.setMaxDeliveryCount", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.", + "kind": "PropertySetter", + "signature": "SetMaxDeliveryCount(value *float64) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetRequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setRequiresSession", + "qualifiedName": "AzureServiceBusSubscriptionResource.setRequiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertySetter", + "signature": "SetRequiresSession(value *bool) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether the queue supports the concept of sessions." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetSubscriptionName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setSubscriptionName", + "qualifiedName": "AzureServiceBusSubscriptionResource.setSubscriptionName", + "description": "The subscription name.", + "kind": "PropertySetter", + "signature": "SetSubscriptionName(value string) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The subscription name." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SubscriptionName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.subscriptionName", + "qualifiedName": "AzureServiceBusSubscriptionResource.subscriptionName", + "description": "The subscription name.", + "kind": "PropertyGetter", + "signature": "SubscriptionName() (string, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.connectionStringExpression", + "qualifiedName": "AzureServiceBusTopicResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Service Bus Topic.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "DefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.defaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusTopicResource.defaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertyGetter", + "signature": "DefaultMessageTimeToLive() (*float64, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "DuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.duplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusTopicResource.duplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertyGetter", + "signature": "DuplicateDetectionHistoryTimeWindow() (*float64, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.parent", + "qualifiedName": "AzureServiceBusTopicResource.parent", + "description": "Gets the parent Azure Service Bus resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureServiceBusResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "AzureServiceBusResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "RequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.requiresDuplicateDetection", + "qualifiedName": "AzureServiceBusTopicResource.requiresDuplicateDetection", + "description": "A value indicating if this topic requires duplicate detection.", + "kind": "PropertyGetter", + "signature": "RequiresDuplicateDetection() (*bool, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetDefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setDefaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusTopicResource.setDefaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertySetter", + "signature": "SetDefaultMessageTimeToLive(value *float64) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetDuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setDuplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusTopicResource.setDuplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertySetter", + "signature": "SetDuplicateDetectionHistoryTimeWindow(value *float64) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetRequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setRequiresDuplicateDetection", + "qualifiedName": "AzureServiceBusTopicResource.setRequiresDuplicateDetection", + "description": "A value indicating if this topic requires duplicate detection.", + "kind": "PropertySetter", + "signature": "SetRequiresDuplicateDetection(value *bool) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value indicating if this topic requires duplicate detection." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetTopicName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setTopicName", + "qualifiedName": "AzureServiceBusTopicResource.setTopicName", + "description": "The topic name.", + "kind": "PropertySetter", + "signature": "SetTopicName(value string) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The topic name." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "TopicName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.topicName", + "qualifiedName": "AzureServiceBusTopicResource.topicName", + "description": "The topic name.", + "kind": "PropertyGetter", + "signature": "TopicName() (string, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "AddAzureServiceBus", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addAzureServiceBus", + "qualifiedName": "addAzureServiceBus", + "description": "Adds an Azure Service Bus Namespace resource to the application model. This resource can be used to create queue, topic, and subscription resources.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureServiceBus(name string) AzureServiceBusResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureServiceBusResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddServiceBusQueue", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addServiceBusQueue", + "qualifiedName": "addServiceBusQueue", + "description": "Adds an Azure Service Bus Queue resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddServiceBusQueue(name string, options ...*AddServiceBusQueueOptions) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the queue resource." + } + ], + "options": { + "typeName": "AddServiceBusQueueOptions", + "fields": [ + { + "name": "QueueName", + "jsonName": "queueName", + "type": "*string", + "description": "The name of the Service Bus Queue. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureServiceBusQueueResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusResource" + ], + "appliesTo": [ + "AzureServiceBusResource" + ] + }, + { + "name": "AddServiceBusSubscription", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addServiceBusSubscription", + "qualifiedName": "addServiceBusSubscription", + "description": "Adds an Azure Service Bus Subscription resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddServiceBusSubscription(name string, options ...*AddServiceBusSubscriptionOptions) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the subscription resource." + } + ], + "options": { + "typeName": "AddServiceBusSubscriptionOptions", + "fields": [ + { + "name": "SubscriptionName", + "jsonName": "subscriptionName", + "type": "*string", + "description": "The name of the Service Bus Subscription. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureServiceBusSubscriptionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "AddServiceBusTopic", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addServiceBusTopic", + "qualifiedName": "addServiceBusTopic", + "description": "Adds an Azure Service Bus Topic resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddServiceBusTopic(name string, options ...*AddServiceBusTopicOptions) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the topic resource." + } + ], + "options": { + "typeName": "AddServiceBusTopicOptions", + "fields": [ + { + "name": "TopicName", + "jsonName": "topicName", + "type": "*string", + "description": "The name of the Service Bus Topic. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureServiceBusTopicResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusResource" + ], + "appliesTo": [ + "AzureServiceBusResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Service Bus resource to run with the local emulator", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureServiceBusResource", + "receiver": "AzureServiceBusResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureServiceBusEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusEmulatorResource)" + } + ] + }, + "returnType": "AzureServiceBusResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusResource" + ], + "appliesTo": [ + "AzureServiceBusResource" + ] + }, + { + "name": "WithConfigurationFile", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withConfigurationFile", + "qualifiedName": "withConfigurationFile", + "description": "Copies the configuration file into an Azure Service Bus emulator resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithConfigurationFile(path string) AzureServiceBusEmulatorResource", + "receiver": "AzureServiceBusEmulatorResource", + "parameters": [ + { + "name": "path", + "type": "string", + "description": "Path to the file on the AppHost where the emulator configuration is located." + } + ], + "returnType": "AzureServiceBusEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusEmulatorResource" + ], + "appliesTo": [ + "AzureServiceBusEmulatorResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(port *float64) AzureServiceBusEmulatorResource", + "receiver": "AzureServiceBusEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "The port to bind on the host. If `null` is used, a random port will be assigned." + } + ], + "returnType": "AzureServiceBusEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusEmulatorResource" + ], + "appliesTo": [ + "AzureServiceBusEmulatorResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withQueueProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Service Bus Queue resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureServiceBusQueueResource)) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureServiceBusQueueResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusQueueResource)", + "description": "A method that can be used for customizing the `AzureServiceBusQueueResource`." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withSubscriptionProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Service Bus Subscription resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureServiceBusSubscriptionResource)) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureServiceBusSubscriptionResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusSubscriptionResource)", + "description": "A method that can be used for customizing the `AzureServiceBusSubscriptionResource`." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withTopicProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Service Bus Topic resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureServiceBusTopicResource)) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureServiceBusTopicResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusTopicResource)", + "description": "A method that can be used for customizing the `AzureServiceBusTopicResource`." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "WithServiceBusRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withServiceBusRoleAssignments", + "qualifiedName": "withServiceBusRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Service Bus namespace. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithServiceBusRoleAssignments(target AzureServiceBusResource, roles []AzureServiceBusRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureServiceBusResource", + "description": "The target Azure Service Bus namespace." + }, + { + "name": "roles", + "type": "[]AzureServiceBusRole", + "description": "The Service Bus roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "Aspire.Hosting.Azure.AzureServiceBusResource", + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "Aspire.Hosting.Azure.AzureServiceBusEmulatorResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureServiceBusEmulatorResource", + "AzureServiceBusQueueResource", + "AzureServiceBusResource", + "AzureServiceBusSubscriptionResource", + "AzureServiceBusTopicResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureServiceBusEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithConfigurationFile", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withConfigurationFile", + "qualifiedName": "withConfigurationFile", + "description": "Copies the configuration file into an Azure Service Bus emulator resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithConfigurationFile(path string) AzureServiceBusEmulatorResource", + "receiver": "AzureServiceBusEmulatorResource", + "parameters": [ + { + "name": "path", + "type": "string", + "description": "Path to the file on the AppHost where the emulator configuration is located." + } + ], + "returnType": "AzureServiceBusEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusEmulatorResource" + ], + "appliesTo": [ + "AzureServiceBusEmulatorResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the host port for the Azure Service Bus emulator is exposed on instead of using randomly assigned port.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(port *float64) AzureServiceBusEmulatorResource", + "receiver": "AzureServiceBusEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "*float64", + "description": "The port to bind on the host. If `null` is used, a random port will be assigned." + } + ], + "returnType": "AzureServiceBusEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusEmulatorResource" + ], + "appliesTo": [ + "AzureServiceBusEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureServiceBusQueueResource", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "kind": "handle", + "description": "Represents a Service Bus Queue. Initializes a new instance of the {@ats-ref type:AzureServiceBusQueueResource} class.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.connectionStringExpression", + "qualifiedName": "AzureServiceBusQueueResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Service Bus Queue.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "DeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.deadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusQueueResource.deadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertyGetter", + "signature": "DeadLetteringOnMessageExpiration() (*bool, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "DefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.defaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusQueueResource.defaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertyGetter", + "signature": "DefaultMessageTimeToLive() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "DuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.duplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusQueueResource.duplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertyGetter", + "signature": "DuplicateDetectionHistoryTimeWindow() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "ForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.forwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusQueueResource.forwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertyGetter", + "signature": "ForwardDeadLetteredMessagesTo() (*string, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "ForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.forwardTo", + "qualifiedName": "AzureServiceBusQueueResource.forwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertyGetter", + "signature": "ForwardTo() (*string, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "LockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.lockDuration", + "qualifiedName": "AzureServiceBusQueueResource.lockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertyGetter", + "signature": "LockDuration() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "MaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.maxDeliveryCount", + "qualifiedName": "AzureServiceBusQueueResource.maxDeliveryCount", + "description": "The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.", + "kind": "PropertyGetter", + "signature": "MaxDeliveryCount() (*float64, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.parent", + "qualifiedName": "AzureServiceBusQueueResource.parent", + "description": "Gets the parent Azure Service Bus resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureServiceBusResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "AzureServiceBusResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "QueueName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.queueName", + "qualifiedName": "AzureServiceBusQueueResource.queueName", + "description": "The queue name.", + "kind": "PropertyGetter", + "signature": "QueueName() (string, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "RequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.requiresDuplicateDetection", + "qualifiedName": "AzureServiceBusQueueResource.requiresDuplicateDetection", + "description": "A value indicating if this queue requires duplicate detection.", + "kind": "PropertyGetter", + "signature": "RequiresDuplicateDetection() (*bool, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "RequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.requiresSession", + "qualifiedName": "AzureServiceBusQueueResource.requiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertyGetter", + "signature": "RequiresSession() (*bool, error)", + "receiver": "AzureServiceBusQueueResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetDeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setDeadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusQueueResource.setDeadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertySetter", + "signature": "SetDeadLetteringOnMessageExpiration(value *bool) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetDefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setDefaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusQueueResource.setDefaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertySetter", + "signature": "SetDefaultMessageTimeToLive(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetDuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setDuplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusQueueResource.setDuplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertySetter", + "signature": "SetDuplicateDetectionHistoryTimeWindow(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setForwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusQueueResource.setForwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertySetter", + "signature": "SetForwardDeadLetteredMessagesTo(value *string) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the Dead Letter message." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setForwardTo", + "qualifiedName": "AzureServiceBusQueueResource.setForwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertySetter", + "signature": "SetForwardTo(value *string) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the messages." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetLockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setLockDuration", + "qualifiedName": "AzureServiceBusQueueResource.setLockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertySetter", + "signature": "SetLockDuration(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetMaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setMaxDeliveryCount", + "qualifiedName": "AzureServiceBusQueueResource.setMaxDeliveryCount", + "description": "The maximum delivery count. A message is automatically dead-lettered after this number of deliveries.", + "kind": "PropertySetter", + "signature": "SetMaxDeliveryCount(value *float64) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "The maximum delivery count. A message is automatically dead-lettered after this number of deliveries." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetQueueName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setQueueName", + "qualifiedName": "AzureServiceBusQueueResource.setQueueName", + "description": "The queue name.", + "kind": "PropertySetter", + "signature": "SetQueueName(value string) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The queue name." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetRequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setRequiresDuplicateDetection", + "qualifiedName": "AzureServiceBusQueueResource.setRequiresDuplicateDetection", + "description": "A value indicating if this queue requires duplicate detection.", + "kind": "PropertySetter", + "signature": "SetRequiresDuplicateDetection(value *bool) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value indicating if this queue requires duplicate detection." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "SetRequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusQueueResource.setRequiresSession", + "qualifiedName": "AzureServiceBusQueueResource.setRequiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertySetter", + "signature": "SetRequiresSession(value *bool) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether the queue supports the concept of sessions." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withQueueProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Service Bus Queue resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureServiceBusQueueResource)) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusQueueResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureServiceBusQueueResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusQueueResource)", + "description": "A method that can be used for customizing the `AzureServiceBusQueueResource`." + } + ], + "returnType": "AzureServiceBusQueueResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusQueueResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusQueueResource" + ], + "appliesTo": [ + "AzureServiceBusQueueResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureServiceBusResource", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusResource", + "kind": "handle", + "description": "Represents an Azure Service Bus resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddServiceBusQueue", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addServiceBusQueue", + "qualifiedName": "addServiceBusQueue", + "description": "Adds an Azure Service Bus Queue resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddServiceBusQueue(name string, options ...*AddServiceBusQueueOptions) AzureServiceBusQueueResource", + "receiver": "AzureServiceBusResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the queue resource." + } + ], + "options": { + "typeName": "AddServiceBusQueueOptions", + "fields": [ + { + "name": "QueueName", + "jsonName": "queueName", + "type": "*string", + "description": "The name of the Service Bus Queue. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureServiceBusQueueResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusResource" + ], + "appliesTo": [ + "AzureServiceBusResource" + ] + }, + { + "name": "AddServiceBusTopic", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addServiceBusTopic", + "qualifiedName": "addServiceBusTopic", + "description": "Adds an Azure Service Bus Topic resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddServiceBusTopic(name string, options ...*AddServiceBusTopicOptions) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the topic resource." + } + ], + "options": { + "typeName": "AddServiceBusTopicOptions", + "fields": [ + { + "name": "TopicName", + "jsonName": "topicName", + "type": "*string", + "description": "The name of the Service Bus Topic. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureServiceBusTopicResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusResource" + ], + "appliesTo": [ + "AzureServiceBusResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Service Bus resource to run with the local emulator", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureServiceBusResource", + "receiver": "AzureServiceBusResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureServiceBusEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusEmulatorResource)" + } + ] + }, + "returnType": "AzureServiceBusResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusResource" + ], + "appliesTo": [ + "AzureServiceBusResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureServiceBusSubscriptionResource", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "kind": "handle", + "description": "Represents a Service Bus Subscription. Initializes a new instance of the {@ats-ref type:AzureServiceBusSubscriptionResource} class.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.connectionStringExpression", + "qualifiedName": "AzureServiceBusSubscriptionResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Service Bus Subscription.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "DeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.deadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusSubscriptionResource.deadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertyGetter", + "signature": "DeadLetteringOnMessageExpiration() (*bool, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "DefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.defaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusSubscriptionResource.defaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertyGetter", + "signature": "DefaultMessageTimeToLive() (*float64, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "ForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.forwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.forwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertyGetter", + "signature": "ForwardDeadLetteredMessagesTo() (*string, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "ForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.forwardTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.forwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertyGetter", + "signature": "ForwardTo() (*string, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "LockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.lockDuration", + "qualifiedName": "AzureServiceBusSubscriptionResource.lockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertyGetter", + "signature": "LockDuration() (*float64, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "MaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.maxDeliveryCount", + "qualifiedName": "AzureServiceBusSubscriptionResource.maxDeliveryCount", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.", + "kind": "PropertyGetter", + "signature": "MaxDeliveryCount() (*float64, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.parent", + "qualifiedName": "AzureServiceBusSubscriptionResource.parent", + "description": "Gets the parent Azure Service Bus Topic resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureServiceBusTopicResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "AzureServiceBusTopicResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "RequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.requiresSession", + "qualifiedName": "AzureServiceBusSubscriptionResource.requiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertyGetter", + "signature": "RequiresSession() (*bool, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "Rules", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.rules", + "qualifiedName": "AzureServiceBusSubscriptionResource.rules", + "description": "The rules for this subscription.", + "kind": "PropertyGetter", + "signature": "Rules() *List[*AzureServiceBusRule]", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "*List[*AzureServiceBusRule]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetDeadLetteringOnMessageExpiration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setDeadLetteringOnMessageExpiration", + "qualifiedName": "AzureServiceBusSubscriptionResource.setDeadLetteringOnMessageExpiration", + "description": "A value that indicates whether this queue has dead letter support when a message expires.", + "kind": "PropertySetter", + "signature": "SetDeadLetteringOnMessageExpiration(value *bool) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether this queue has dead letter support when a message expires." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetDefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setDefaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusSubscriptionResource.setDefaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertySetter", + "signature": "SetDefaultMessageTimeToLive(value *float64) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetForwardDeadLetteredMessagesTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setForwardDeadLetteredMessagesTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.setForwardDeadLetteredMessagesTo", + "description": "Queue/Topic name to forward the Dead Letter message.", + "kind": "PropertySetter", + "signature": "SetForwardDeadLetteredMessagesTo(value *string) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the Dead Letter message." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetForwardTo", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setForwardTo", + "qualifiedName": "AzureServiceBusSubscriptionResource.setForwardTo", + "description": "Queue/Topic name to forward the messages.", + "kind": "PropertySetter", + "signature": "SetForwardTo(value *string) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Queue/Topic name to forward the messages." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetLockDuration", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setLockDuration", + "qualifiedName": "AzureServiceBusSubscriptionResource.setLockDuration", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute.", + "kind": "PropertySetter", + "signature": "SetLockDuration(value *float64) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetMaxDeliveryCount", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setMaxDeliveryCount", + "qualifiedName": "AzureServiceBusSubscriptionResource.setMaxDeliveryCount", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10.", + "kind": "PropertySetter", + "signature": "SetMaxDeliveryCount(value *float64) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "The maximum delivery count. A message is automatically deadlettered after this number of deliveries. default value is 10." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetRequiresSession", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setRequiresSession", + "qualifiedName": "AzureServiceBusSubscriptionResource.setRequiresSession", + "description": "A value that indicates whether the queue supports the concept of sessions.", + "kind": "PropertySetter", + "signature": "SetRequiresSession(value *bool) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value that indicates whether the queue supports the concept of sessions." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SetSubscriptionName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.setSubscriptionName", + "qualifiedName": "AzureServiceBusSubscriptionResource.setSubscriptionName", + "description": "The subscription name.", + "kind": "PropertySetter", + "signature": "SetSubscriptionName(value string) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The subscription name." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "SubscriptionName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusSubscriptionResource.subscriptionName", + "qualifiedName": "AzureServiceBusSubscriptionResource.subscriptionName", + "description": "The subscription name.", + "kind": "PropertyGetter", + "signature": "SubscriptionName() (string, error)", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withSubscriptionProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Service Bus Subscription resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureServiceBusSubscriptionResource)) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusSubscriptionResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureServiceBusSubscriptionResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusSubscriptionResource)", + "description": "A method that can be used for customizing the `AzureServiceBusSubscriptionResource`." + } + ], + "returnType": "AzureServiceBusSubscriptionResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusSubscriptionResource" + ], + "appliesTo": [ + "AzureServiceBusSubscriptionResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureServiceBusTopicResource", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "kind": "handle", + "description": "Represents a Service Bus Topic. Initializes a new instance of the {@ats-ref type:AzureServiceBusTopicResource} class.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.connectionStringExpression", + "qualifiedName": "AzureServiceBusTopicResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure Service Bus Topic.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "DefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.defaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusTopicResource.defaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertyGetter", + "signature": "DefaultMessageTimeToLive() (*float64, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "DuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.duplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusTopicResource.duplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertyGetter", + "signature": "DuplicateDetectionHistoryTimeWindow() (*float64, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.parent", + "qualifiedName": "AzureServiceBusTopicResource.parent", + "description": "Gets the parent Azure Service Bus resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureServiceBusResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "AzureServiceBusResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "RequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.requiresDuplicateDetection", + "qualifiedName": "AzureServiceBusTopicResource.requiresDuplicateDetection", + "description": "A value indicating if this topic requires duplicate detection.", + "kind": "PropertyGetter", + "signature": "RequiresDuplicateDetection() (*bool, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetDefaultMessageTimeToLive", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setDefaultMessageTimeToLive", + "qualifiedName": "AzureServiceBusTopicResource.setDefaultMessageTimeToLive", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.", + "kind": "PropertySetter", + "signature": "SetDefaultMessageTimeToLive(value *float64) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetDuplicateDetectionHistoryTimeWindow", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setDuplicateDetectionHistoryTimeWindow", + "qualifiedName": "AzureServiceBusTopicResource.setDuplicateDetectionHistoryTimeWindow", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.", + "kind": "PropertySetter", + "signature": "SetDuplicateDetectionHistoryTimeWindow(value *float64) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "ISO 8601 timeSpan structure that defines the duration of the duplicate detection history. The default value is 10 minutes." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetRequiresDuplicateDetection", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setRequiresDuplicateDetection", + "qualifiedName": "AzureServiceBusTopicResource.setRequiresDuplicateDetection", + "description": "A value indicating if this topic requires duplicate detection.", + "kind": "PropertySetter", + "signature": "SetRequiresDuplicateDetection(value *bool) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "A value indicating if this topic requires duplicate detection." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "SetTopicName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.setTopicName", + "qualifiedName": "AzureServiceBusTopicResource.setTopicName", + "description": "The topic name.", + "kind": "PropertySetter", + "signature": "SetTopicName(value string) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The topic name." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "TopicName", + "capabilityId": "Aspire.Hosting.Azure/AzureServiceBusTopicResource.topicName", + "qualifiedName": "AzureServiceBusTopicResource.topicName", + "description": "The topic name.", + "kind": "PropertyGetter", + "signature": "TopicName() (string, error)", + "receiver": "AzureServiceBusTopicResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "AddServiceBusSubscription", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/addServiceBusSubscription", + "qualifiedName": "addServiceBusSubscription", + "description": "Adds an Azure Service Bus Subscription resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddServiceBusSubscription(name string, options ...*AddServiceBusSubscriptionOptions) AzureServiceBusSubscriptionResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the subscription resource." + } + ], + "options": { + "typeName": "AddServiceBusSubscriptionOptions", + "fields": [ + { + "name": "SubscriptionName", + "jsonName": "subscriptionName", + "type": "*string", + "description": "The name of the Service Bus Subscription. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureServiceBusSubscriptionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Azure.ServiceBus/withTopicProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of an Azure Service Bus Topic resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj AzureServiceBusTopicResource)) AzureServiceBusTopicResource", + "receiver": "AzureServiceBusTopicResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj AzureServiceBusTopicResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureServiceBusTopicResource)", + "description": "A method that can be used for customizing the `AzureServiceBusTopicResource`." + } + ], + "returnType": "AzureServiceBusTopicResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.ServiceBus/Aspire.Hosting.Azure.AzureServiceBusTopicResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureServiceBusTopicResource" + ], + "appliesTo": [ + "AzureServiceBusTopicResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "AzureServiceBusCorrelationFilter", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusCorrelationFilter", + "kind": "dto", + "description": "Represents the correlation filter expression.", + "fields": [ + { + "name": "Properties", + "jsonName": "Properties", + "type": "map[string]any", + "description": "Dictionary object for custom filters." + }, + { + "name": "CorrelationId", + "jsonName": "CorrelationId", + "type": "*string", + "description": "Identifier of the correlation." + }, + { + "name": "MessageId", + "jsonName": "MessageId", + "type": "*string", + "description": "Identifier of the message." + }, + { + "name": "SendTo", + "jsonName": "SendTo", + "type": "*string", + "description": "Address to send to." + }, + { + "name": "ReplyTo", + "jsonName": "ReplyTo", + "type": "*string", + "description": "Address of the queue to reply to." + }, + { + "name": "Subject", + "jsonName": "Subject", + "type": "*string", + "description": "Application specific label." + }, + { + "name": "SessionId", + "jsonName": "SessionId", + "type": "*string", + "description": "Session identifier." + }, + { + "name": "ReplyToSessionId", + "jsonName": "ReplyToSessionId", + "type": "*string", + "description": "Session identifier to reply to." + }, + { + "name": "ContentType", + "jsonName": "ContentType", + "type": "*string", + "description": "Content type of the message." + }, + { + "name": "RequiresPreprocessing", + "jsonName": "RequiresPreprocessing", + "type": "*bool", + "isOptional": true, + "description": "Value that indicates whether the rule action requires preprocessing." + } + ] + }, + { + "name": "AzureServiceBusRule", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusRule", + "kind": "dto", + "description": "Represents a Service Bus Rule. Initializes a new instance of the `AzureServiceBusRule` class.", + "remarks": "Use `ConfigureInfrastructure``1` to configure specific `Provisioning` properties.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "string", + "description": "The rule name." + }, + { + "name": "CorrelationFilter", + "jsonName": "CorrelationFilter", + "type": "*AzureServiceBusCorrelationFilter", + "description": "Properties of correlation filter." + }, + { + "name": "FilterType", + "jsonName": "FilterType", + "type": "AzureServiceBusFilterType", + "description": "Filter type that is evaluated against a BrokeredMessage." + } + ] + } + ], + "enumTypes": [ + { + "name": "AzureServiceBusFilterType", + "fullName": "Aspire.Hosting.Azure.AzureServiceBusFilterType", + "kind": "enum", + "description": "Rule filter types.", + "members": [ + { + "name": "AzureServiceBusFilterTypeSqlFilter", + "value": "SqlFilter", + "description": "SqlFilter." + }, + { + "name": "AzureServiceBusFilterTypeCorrelationFilter", + "value": "CorrelationFilter", + "description": "CorrelationFilter." + } + ] + }, + { + "name": "AzureServiceBusRole", + "fullName": "Aspire.Hosting.AzureServiceBusRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure Service Bus roles.", + "members": [ + { + "name": "AzureServiceBusRoleAzureServiceBusDataOwner", + "value": "AzureServiceBusDataOwner" + }, + { + "name": "AzureServiceBusRoleAzureServiceBusDataReceiver", + "value": "AzureServiceBusDataReceiver" + }, + { + "name": "AzureServiceBusRoleAzureServiceBusDataSender", + "value": "AzureServiceBusDataSender" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.SignalR.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.SignalR.13.6.0.json new file mode 100644 index 0000000000..602574c66b --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.SignalR.13.6.0.json @@ -0,0 +1,256 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.SignalR", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureSignalR", + "capabilityId": "Aspire.Hosting.Azure.SignalR/addAzureSignalR", + "qualifiedName": "addAzureSignalR", + "description": "Adds an Azure SignalR resource to the application model.", + "kind": "Method", + "signature": "AddAzureSignalR(name string) AzureSignalRResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "returnType": "AzureSignalRResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.SignalR/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures an Azure SignalR resource to be emulated. This resource requires an Azure SignalR resource to be added to the application model. Please note that the resource will be emulated in Serverless mode.", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureSignalRResource", + "receiver": "AzureSignalRResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureSignalREmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureSignalREmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureSignalRResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.SignalR/Aspire.Hosting.ApplicationModel.AzureSignalRResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureSignalRResource" + ], + "appliesTo": [ + "AzureSignalRResource" + ] + }, + { + "name": "WithSignalRRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.SignalR/withSignalRRoleAssignments", + "qualifiedName": "withSignalRRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure SignalR resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithSignalRRoleAssignments(target AzureSignalRResource, roles []AzureSignalRRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureSignalRResource", + "description": "The target Azure SignalR resource." + }, + { + "name": "roles", + "type": "[]AzureSignalRRole", + "description": "The Azure SignalR roles to be assigned (for example, `SignalRContributor`)." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.ApplicationModel.AzureSignalRResource", + "Aspire.Hosting.Azure.AzureSignalREmulatorResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureSignalREmulatorResource", + "AzureSignalRResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureSignalRResource", + "fullName": "Aspire.Hosting.ApplicationModel.AzureSignalRResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.SignalR/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures an Azure SignalR resource to be emulated. This resource requires an Azure SignalR resource to be added to the application model. Please note that the resource will be emulated in Serverless mode.", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureSignalRResource", + "receiver": "AzureSignalRResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureSignalREmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureSignalREmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureSignalRResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.SignalR/Aspire.Hosting.ApplicationModel.AzureSignalRResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureSignalRResource" + ], + "appliesTo": [ + "AzureSignalRResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSignalREmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureSignalREmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureSignalRRole", + "fullName": "Aspire.Hosting.AzureSignalRRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure SignalR roles.", + "members": [ + { + "name": "AzureSignalRRoleSignalRContributor", + "value": "SignalRContributor", + "description": "Allows managing Azure SignalR resources." + }, + { + "name": "AzureSignalRRoleSignalRAppServer", + "value": "SignalRAppServer", + "description": "Allows acting as an app server for SignalR." + }, + { + "name": "AzureSignalRRoleSignalRRestApiOwner", + "value": "SignalRRestApiOwner", + "description": "Allows using REST API for SignalR in serverless mode." + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Sql.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Sql.13.6.0.json new file mode 100644 index 0000000000..539ad08c0f --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Sql.13.6.0.json @@ -0,0 +1,1067 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Sql", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.connectionStringExpression", + "qualifiedName": "AzureSqlDatabaseResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure SQL database.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "DatabaseName", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.databaseName", + "qualifiedName": "AzureSqlDatabaseResource.databaseName", + "description": "Gets the database name.", + "kind": "PropertyGetter", + "signature": "DatabaseName() (string, error)", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "IsContainer", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.isContainer", + "qualifiedName": "AzureSqlDatabaseResource.isContainer", + "description": "Gets a value indicating whether the current resource represents a container. If so the actual resource is not running in Azure.", + "kind": "PropertyGetter", + "signature": "IsContainer() (bool, error)", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "JdbcConnectionString", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.jdbcConnectionString", + "qualifiedName": "AzureSqlDatabaseResource.jdbcConnectionString", + "description": "Gets the JDBC connection string for the Azure SQL database.", + "remarks": "Format: `jdbc:sqlserver://{host}:{port};database={database};encrypt=true;trustServerCertificate=false`.\nWhen running in a container, inherits the container JDBC format including username and password.", + "kind": "PropertyGetter", + "signature": "JdbcConnectionString() *ReferenceExpression", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.parent", + "qualifiedName": "AzureSqlDatabaseResource.parent", + "description": "Gets the parent Azure SQL Database (server) resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureSqlServerResource", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "AzureSqlServerResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.uriExpression", + "qualifiedName": "AzureSqlDatabaseResource.uriExpression", + "description": "Gets the connection URI expression for the Azure SQL database.", + "remarks": "Format: `mssql://{host}:{port}/{database}`.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "AzureSqlDatabases", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.azureSqlDatabases", + "qualifiedName": "AzureSqlServerResource.azureSqlDatabases", + "description": "A dictionary where the key is the resource name and the value is the Azure SQL database resource.", + "kind": "PropertyGetter", + "signature": "AzureSqlDatabases() (map[string]AzureSqlDatabaseResource, error)", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "(map[string]AzureSqlDatabaseResource, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.connectionStringExpression", + "qualifiedName": "AzureSqlServerResource.connectionStringExpression", + "description": "Gets the connection template for the manifest for the Azure SQL Server resource.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "Databases", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.databases", + "qualifiedName": "AzureSqlServerResource.databases", + "description": "A dictionary where the key is the resource name and the value is the Azure SQL database name.", + "kind": "PropertyGetter", + "signature": "Databases() (map[string]string, error)", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "(map[string]string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "FullyQualifiedDomainName", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.fullyQualifiedDomainName", + "qualifiedName": "AzureSqlServerResource.fullyQualifiedDomainName", + "description": "Gets the fully qualified domain name (FQDN) output reference from the bicep template for the Azure SQL Server resource.", + "kind": "PropertyGetter", + "signature": "FullyQualifiedDomainName() BicepOutputReference", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "HostName", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.hostName", + "qualifiedName": "AzureSqlServerResource.hostName", + "description": "Gets the host name for the SQL Server.", + "remarks": "In container mode, resolves to the container's primary endpoint host.\nIn Azure mode, resolves to the Azure SQL Server's fully qualified domain name.", + "kind": "PropertyGetter", + "signature": "HostName() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "Id", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.id", + "qualifiedName": "AzureSqlServerResource.id", + "description": "Gets the \"id\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "Id() BicepOutputReference", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "IsContainer", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.isContainer", + "qualifiedName": "AzureSqlServerResource.isContainer", + "description": "Gets a value indicating whether the current resource represents a container. If so the actual resource is not running in Azure.", + "kind": "PropertyGetter", + "signature": "IsContainer() (bool, error)", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "JdbcConnectionString", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.jdbcConnectionString", + "qualifiedName": "AzureSqlServerResource.jdbcConnectionString", + "description": "Gets the JDBC connection string for the server.", + "remarks": "Format: `jdbc:sqlserver://{host}:{port};authentication=ActiveDirectoryIntegrated;encrypt=true;trustServerCertificate=true`.", + "kind": "PropertyGetter", + "signature": "JdbcConnectionString() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "NameOutputReference", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.nameOutputReference", + "qualifiedName": "AzureSqlServerResource.nameOutputReference", + "description": "Gets the \"name\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "NameOutputReference() BicepOutputReference", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.port", + "qualifiedName": "AzureSqlServerResource.port", + "description": "Gets the port for the PostgreSQL server.", + "remarks": "In container mode, resolves to the container's primary endpoint port.\nIn Azure mode, resolves to 1433.", + "kind": "PropertyGetter", + "signature": "Port() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.uriExpression", + "qualifiedName": "AzureSqlServerResource.uriExpression", + "description": "Gets the connection URI expression for the SQL Server.", + "remarks": "Format: `mssql://{host}:{port}`.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "AddAzureSqlServer", + "capabilityId": "Aspire.Hosting.Azure.Sql/addAzureSqlServer", + "qualifiedName": "addAzureSqlServer", + "description": "Adds an Azure SQL Database (server) resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureSqlServer(name string) AzureSqlServerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureSqlServerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDatabase", + "capabilityId": "Aspire.Hosting.Azure.Sql/addDatabase", + "qualifiedName": "addDatabase", + "description": "Adds an Azure SQL Database to the application model. The Free Offer option will be used when deploying the resource in Azure", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDatabase(name string, options ...*AddDatabaseOptions) AzureSqlDatabaseResource", + "receiver": "AzureSqlServerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureSqlDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "RunAsContainer", + "capabilityId": "Aspire.Hosting.Azure.Sql/runAsContainer", + "qualifiedName": "runAsContainer", + "description": "Configures an Azure SQL Database (server) resource to run locally in a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsContainer(options ...*RunAsContainerOptions) AzureSqlServerResource", + "receiver": "AzureSqlServerResource", + "parameters": [], + "options": { + "typeName": "RunAsContainerOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj SqlServerServerResource)", + "isCallback": true, + "callbackSignature": "func(obj SqlServerServerResource)", + "description": "Callback that exposes underlying container to allow for customization." + } + ] + }, + "returnType": "AzureSqlServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "WithAdminDeploymentScriptStorage", + "capabilityId": "Aspire.Hosting.Azure.Sql/withAdminDeploymentScriptStorage", + "qualifiedName": "withAdminDeploymentScriptStorage", + "description": "Configures the Azure SQL Server to use the specified storage account for deployment script execution.", + "remarks": "When an Azure SQL Server has a private endpoint, deployment scripts require a storage account to upload\nscripts and write logs. This method allows you to provide an explicit storage account instead of having\none auto-created.\nThe storage account must have `AllowSharedKeyAccess` enabled, as deployment scripts need to mount\nfile shares. If the storage is not an existing resource, this method will automatically configure\n`AllowSharedKeyAccess = true`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAdminDeploymentScriptStorage(storage AzureStorageResource) AzureSqlServerResource", + "receiver": "AzureSqlServerResource", + "parameters": [ + { + "name": "storage", + "type": "AzureStorageResource", + "description": "The storage account to use for deployment scripts." + } + ], + "returnType": "AzureSqlServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "WithAdminDeploymentScriptSubnet", + "capabilityId": "Aspire.Hosting.Azure.Sql/withAdminDeploymentScriptSubnet", + "qualifiedName": "withAdminDeploymentScriptSubnet", + "description": "Configures the Azure SQL Server to use the specified subnet for deployment script execution.", + "remarks": "When an Azure SQL Server has a private endpoint, deployment scripts that add database role assignments\nrun inside Azure Container Instances (ACI). This method allows you to provide an explicit subnet for those\ncontainers instead of having one auto-created.\nThe specified subnet will be automatically delegated to `Microsoft.ContainerInstance/containerGroups`.\nEnsure the subnet has outbound network security rules allowing access to Azure Active Directory (port 443)\nand SQL (port 443) service tags.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAdminDeploymentScriptSubnet(subnet AzureSubnetResource) AzureSqlServerResource", + "receiver": "AzureSqlServerResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to delegate for Azure Container Instances used by deployment scripts." + } + ], + "returnType": "AzureSqlServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "WithDefaultAzureSku", + "capabilityId": "Aspire.Hosting.Azure.Sql/withDefaultAzureSku", + "qualifiedName": "withDefaultAzureSku", + "description": "Configures the Azure SQL Database to be deployed use the default SKU provided by Azure. Please be aware that the Azure default Sku might not take advantage of the free offer.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDefaultAzureSku() AzureSqlDatabaseResource", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "AzureSqlDatabaseResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + } + ], + "handleTypes": [ + { + "name": "SqlServerServerResource", + "fullName": "Aspire.Hosting.ApplicationModel.SqlServerServerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSqlDatabaseResource", + "fullName": "Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "kind": "handle", + "description": "A resource that represents an Azure SQL database. This is a child resource of an {@ats-ref type:AzureSqlServerResource}.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.connectionStringExpression", + "qualifiedName": "AzureSqlDatabaseResource.connectionStringExpression", + "description": "Gets the connection string expression for the Azure SQL database.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "DatabaseName", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.databaseName", + "qualifiedName": "AzureSqlDatabaseResource.databaseName", + "description": "Gets the database name.", + "kind": "PropertyGetter", + "signature": "DatabaseName() (string, error)", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "IsContainer", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.isContainer", + "qualifiedName": "AzureSqlDatabaseResource.isContainer", + "description": "Gets a value indicating whether the current resource represents a container. If so the actual resource is not running in Azure.", + "kind": "PropertyGetter", + "signature": "IsContainer() (bool, error)", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "JdbcConnectionString", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.jdbcConnectionString", + "qualifiedName": "AzureSqlDatabaseResource.jdbcConnectionString", + "description": "Gets the JDBC connection string for the Azure SQL database.", + "remarks": "Format: `jdbc:sqlserver://{host}:{port};database={database};encrypt=true;trustServerCertificate=false`.\nWhen running in a container, inherits the container JDBC format including username and password.", + "kind": "PropertyGetter", + "signature": "JdbcConnectionString() *ReferenceExpression", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.parent", + "qualifiedName": "AzureSqlDatabaseResource.parent", + "description": "Gets the parent Azure SQL Database (server) resource.", + "kind": "PropertyGetter", + "signature": "Parent() AzureSqlServerResource", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "AzureSqlServerResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlDatabaseResource.uriExpression", + "qualifiedName": "AzureSqlDatabaseResource.uriExpression", + "description": "Gets the connection URI expression for the Azure SQL database.", + "remarks": "Format: `mssql://{host}:{port}/{database}`.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + }, + { + "name": "WithDefaultAzureSku", + "capabilityId": "Aspire.Hosting.Azure.Sql/withDefaultAzureSku", + "qualifiedName": "withDefaultAzureSku", + "description": "Configures the Azure SQL Database to be deployed use the default SKU provided by Azure. Please be aware that the Azure default Sku might not take advantage of the free offer.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDefaultAzureSku() AzureSqlDatabaseResource", + "receiver": "AzureSqlDatabaseResource", + "parameters": [], + "returnType": "AzureSqlDatabaseResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlDatabaseResource" + ], + "appliesTo": [ + "AzureSqlDatabaseResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureSqlServerResource", + "fullName": "Aspire.Hosting.Azure.AzureSqlServerResource", + "kind": "handle", + "description": "Represents an Azure Sql Server resource.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "AzureSqlDatabases", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.azureSqlDatabases", + "qualifiedName": "AzureSqlServerResource.azureSqlDatabases", + "description": "A dictionary where the key is the resource name and the value is the Azure SQL database resource.", + "kind": "PropertyGetter", + "signature": "AzureSqlDatabases() (map[string]AzureSqlDatabaseResource, error)", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "(map[string]AzureSqlDatabaseResource, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.connectionStringExpression", + "qualifiedName": "AzureSqlServerResource.connectionStringExpression", + "description": "Gets the connection template for the manifest for the Azure SQL Server resource.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "Databases", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.databases", + "qualifiedName": "AzureSqlServerResource.databases", + "description": "A dictionary where the key is the resource name and the value is the Azure SQL database name.", + "kind": "PropertyGetter", + "signature": "Databases() (map[string]string, error)", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "(map[string]string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "FullyQualifiedDomainName", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.fullyQualifiedDomainName", + "qualifiedName": "AzureSqlServerResource.fullyQualifiedDomainName", + "description": "Gets the fully qualified domain name (FQDN) output reference from the bicep template for the Azure SQL Server resource.", + "kind": "PropertyGetter", + "signature": "FullyQualifiedDomainName() BicepOutputReference", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "HostName", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.hostName", + "qualifiedName": "AzureSqlServerResource.hostName", + "description": "Gets the host name for the SQL Server.", + "remarks": "In container mode, resolves to the container's primary endpoint host.\nIn Azure mode, resolves to the Azure SQL Server's fully qualified domain name.", + "kind": "PropertyGetter", + "signature": "HostName() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "Id", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.id", + "qualifiedName": "AzureSqlServerResource.id", + "description": "Gets the \"id\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "Id() BicepOutputReference", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "IsContainer", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.isContainer", + "qualifiedName": "AzureSqlServerResource.isContainer", + "description": "Gets a value indicating whether the current resource represents a container. If so the actual resource is not running in Azure.", + "kind": "PropertyGetter", + "signature": "IsContainer() (bool, error)", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "JdbcConnectionString", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.jdbcConnectionString", + "qualifiedName": "AzureSqlServerResource.jdbcConnectionString", + "description": "Gets the JDBC connection string for the server.", + "remarks": "Format: `jdbc:sqlserver://{host}:{port};authentication=ActiveDirectoryIntegrated;encrypt=true;trustServerCertificate=true`.", + "kind": "PropertyGetter", + "signature": "JdbcConnectionString() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "NameOutputReference", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.nameOutputReference", + "qualifiedName": "AzureSqlServerResource.nameOutputReference", + "description": "Gets the \"name\" output reference for the resource.", + "kind": "PropertyGetter", + "signature": "NameOutputReference() BicepOutputReference", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "BicepOutputReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.port", + "qualifiedName": "AzureSqlServerResource.port", + "description": "Gets the port for the PostgreSQL server.", + "remarks": "In container mode, resolves to the container's primary endpoint port.\nIn Azure mode, resolves to 1433.", + "kind": "PropertyGetter", + "signature": "Port() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.Azure/AzureSqlServerResource.uriExpression", + "qualifiedName": "AzureSqlServerResource.uriExpression", + "description": "Gets the connection URI expression for the SQL Server.", + "remarks": "Format: `mssql://{host}:{port}`.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "AzureSqlServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "AddDatabase", + "capabilityId": "Aspire.Hosting.Azure.Sql/addDatabase", + "qualifiedName": "addDatabase", + "description": "Adds an Azure SQL Database to the application model. The Free Offer option will be used when deploying the resource in Azure", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDatabase(name string, options ...*AddDatabaseOptions) AzureSqlDatabaseResource", + "receiver": "AzureSqlServerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureSqlDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "RunAsContainer", + "capabilityId": "Aspire.Hosting.Azure.Sql/runAsContainer", + "qualifiedName": "runAsContainer", + "description": "Configures an Azure SQL Database (server) resource to run locally in a container.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsContainer(options ...*RunAsContainerOptions) AzureSqlServerResource", + "receiver": "AzureSqlServerResource", + "parameters": [], + "options": { + "typeName": "RunAsContainerOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj SqlServerServerResource)", + "isCallback": true, + "callbackSignature": "func(obj SqlServerServerResource)", + "description": "Callback that exposes underlying container to allow for customization." + } + ] + }, + "returnType": "AzureSqlServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "WithAdminDeploymentScriptStorage", + "capabilityId": "Aspire.Hosting.Azure.Sql/withAdminDeploymentScriptStorage", + "qualifiedName": "withAdminDeploymentScriptStorage", + "description": "Configures the Azure SQL Server to use the specified storage account for deployment script execution.", + "remarks": "When an Azure SQL Server has a private endpoint, deployment scripts require a storage account to upload\nscripts and write logs. This method allows you to provide an explicit storage account instead of having\none auto-created.\nThe storage account must have `AllowSharedKeyAccess` enabled, as deployment scripts need to mount\nfile shares. If the storage is not an existing resource, this method will automatically configure\n`AllowSharedKeyAccess = true`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAdminDeploymentScriptStorage(storage AzureStorageResource) AzureSqlServerResource", + "receiver": "AzureSqlServerResource", + "parameters": [ + { + "name": "storage", + "type": "AzureStorageResource", + "description": "The storage account to use for deployment scripts." + } + ], + "returnType": "AzureSqlServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + }, + { + "name": "WithAdminDeploymentScriptSubnet", + "capabilityId": "Aspire.Hosting.Azure.Sql/withAdminDeploymentScriptSubnet", + "qualifiedName": "withAdminDeploymentScriptSubnet", + "description": "Configures the Azure SQL Server to use the specified subnet for deployment script execution.", + "remarks": "When an Azure SQL Server has a private endpoint, deployment scripts that add database role assignments\nrun inside Azure Container Instances (ACI). This method allows you to provide an explicit subnet for those\ncontainers instead of having one auto-created.\nThe specified subnet will be automatically delegated to `Microsoft.ContainerInstance/containerGroups`.\nEnsure the subnet has outbound network security rules allowing access to Azure Active Directory (port 443)\nand SQL (port 443) service tags.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAdminDeploymentScriptSubnet(subnet AzureSubnetResource) AzureSqlServerResource", + "receiver": "AzureSqlServerResource", + "parameters": [ + { + "name": "subnet", + "type": "AzureSubnetResource", + "description": "The subnet to delegate for Azure Container Instances used by deployment scripts." + } + ], + "returnType": "AzureSqlServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Sql/Aspire.Hosting.Azure.AzureSqlServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureSqlServerResource" + ], + "appliesTo": [ + "AzureSqlServerResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSubnetResource", + "fullName": "Aspire.Hosting.Azure.AzureSubnetResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "BicepOutputReference", + "fullName": "Aspire.Hosting.Azure.BicepOutputReference", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Storage.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Storage.13.6.0.json new file mode 100644 index 0000000000..34bd6ffe2d --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.Storage.13.6.0.json @@ -0,0 +1,1256 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.Storage", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureStorage", + "capabilityId": "Aspire.Hosting.Azure.Storage/addAzureStorage", + "qualifiedName": "addAzureStorage", + "description": "Adds an Azure Storage resource to the application model. This resource can be used to create Azure blob, table, and queue resources.", + "kind": "Method", + "signature": "AddAzureStorage(name string) AzureStorageResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddBlobContainer", + "capabilityId": "Aspire.Hosting.Azure.Storage/addBlobContainer", + "qualifiedName": "addBlobContainer", + "description": "Adds an Azure Blob Storage container resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBlobContainer(name string, options ...*AddBlobContainerOptions) AzureBlobStorageContainerResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "options": { + "typeName": "AddBlobContainerOptions", + "fields": [ + { + "name": "BlobContainerName", + "jsonName": "blobContainerName", + "type": "*string", + "description": "The name of the blob container." + } + ] + }, + "returnType": "AzureBlobStorageContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddBlobs", + "capabilityId": "Aspire.Hosting.Azure.Storage/addBlobs", + "qualifiedName": "addBlobs", + "description": "Adds an Azure Blob Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBlobs(name string) AzureBlobStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureBlobStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddDataLake", + "capabilityId": "Aspire.Hosting.Azure.Storage/addDataLake", + "qualifiedName": "addDataLake", + "description": "Adds an Azure Data Lake Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDataLake(name string) AzureDataLakeStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureDataLakeStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddDataLakeFileSystem", + "capabilityId": "Aspire.Hosting.Azure.Storage/addDataLakeFileSystem", + "qualifiedName": "addDataLakeFileSystem", + "description": "Adds an Azure Data Lake Storage file system resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDataLakeFileSystem(name string, options ...*AddDataLakeFileSystemOptions) AzureDataLakeStorageFileSystemResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "options": { + "typeName": "AddDataLakeFileSystemOptions", + "fields": [ + { + "name": "DataLakeFileSystemName", + "jsonName": "dataLakeFileSystemName", + "type": "*string", + "description": "The name of the data lake file system." + } + ] + }, + "returnType": "AzureDataLakeStorageFileSystemResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddQueue", + "capabilityId": "Aspire.Hosting.Azure.Storage/addQueue", + "qualifiedName": "addQueue", + "description": "Adds an Azure Storage queue resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddQueue(name string, options ...*AddQueueOptions) AzureQueueStorageQueueResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "options": { + "typeName": "AddQueueOptions", + "fields": [ + { + "name": "QueueName", + "jsonName": "queueName", + "type": "*string", + "description": "The name of the queue." + } + ] + }, + "returnType": "AzureQueueStorageQueueResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddQueues", + "capabilityId": "Aspire.Hosting.Azure.Storage/addQueues", + "qualifiedName": "addQueues", + "description": "Adds an Azure Queue Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddQueues(name string) AzureQueueStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureQueueStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddTables", + "capabilityId": "Aspire.Hosting.Azure.Storage/addTables", + "qualifiedName": "addTables", + "description": "Adds an Azure Table Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddTables(name string) AzureTableStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureTableStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.Storage/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Storage resource to be emulated using Azurite", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureStorageResource", + "receiver": "AzureStorageResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureStorageEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureStorageEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureStorageResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "WithApiVersionCheck", + "capabilityId": "Aspire.Hosting.Azure.Storage/withApiVersionCheck", + "qualifiedName": "withApiVersionCheck", + "description": "Ensures the emulator checks that the requested API version is valid.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithApiVersionCheck(options ...*WithApiVersionCheckOptions) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithApiVersionCheckOptions", + "fields": [ + { + "name": "Enable", + "jsonName": "enable", + "type": "*bool", + "description": "Whether to enable API version check or not. Default is true." + } + ] + }, + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithBlobPort", + "capabilityId": "Aspire.Hosting.Azure.Storage/withBlobPort", + "qualifiedName": "withBlobPort", + "description": "Modifies the host port that the storage emulator listens on for blob requests.", + "kind": "Method", + "signature": "WithBlobPort(port float64) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.Azure.Storage/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the data folder to an Azure Storage emulator resource.", + "returns": "A builder for the `AzureStorageEmulatorResource`.", + "kind": "Method", + "signature": "WithDataBindMount(options ...*WithDataBindMountOptions) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "Relative path to the AppHost where emulator storage is persisted between runs. Defaults to the path '.azurite/{builder.Resource.Name}'" + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount." + } + ] + }, + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Azure.Storage/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to an Azure Storage emulator resource.", + "returns": "A builder for the `AzureStorageEmulatorResource`.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only volume." + } + ] + }, + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithQueuePort", + "capabilityId": "Aspire.Hosting.Azure.Storage/withQueuePort", + "qualifiedName": "withQueuePort", + "description": "Modifies the host port that the storage emulator listens on for queue requests.", + "kind": "Method", + "signature": "WithQueuePort(port float64) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithStorageRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.Storage/withStorageRoleAssignments", + "qualifiedName": "withStorageRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Storage account. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithStorageRoleAssignments(target AzureStorageResource, roles []AzureStorageRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureStorageResource", + "description": "The target Azure Storage account." + }, + { + "name": "roles", + "type": "[]AzureStorageRole", + "description": "The storage roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Azure.AzureStorageResource", + "Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "Aspire.Hosting.Azure.AzureBlobStorageResource", + "Aspire.Hosting.Azure.AzureDataLakeStorageResource", + "Aspire.Hosting.Azure.AzureBlobStorageContainerResource", + "Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource", + "Aspire.Hosting.Azure.AzureTableStorageResource", + "Aspire.Hosting.Azure.AzureQueueStorageResource", + "Aspire.Hosting.Azure.AzureQueueStorageQueueResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureBlobStorageContainerResource", + "AzureBlobStorageResource", + "AzureDataLakeStorageFileSystemResource", + "AzureDataLakeStorageResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureQueueStorageQueueResource", + "AzureQueueStorageResource", + "AzureStorageEmulatorResource", + "AzureStorageResource", + "AzureTableStorageResource", + "AzureUserAssignedIdentityResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + }, + { + "name": "WithTablePort", + "capabilityId": "Aspire.Hosting.Azure.Storage/withTablePort", + "qualifiedName": "withTablePort", + "description": "Modifies the host port that the storage emulator listens on for table requests.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTablePort(port float64) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBlobStorageContainerResource", + "fullName": "Aspire.Hosting.Azure.AzureBlobStorageContainerResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBlobStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureBlobStorageResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureDataLakeStorageFileSystemResource", + "fullName": "Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureDataLakeStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureDataLakeStorageResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureQueueStorageQueueResource", + "fullName": "Aspire.Hosting.Azure.AzureQueueStorageQueueResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureQueueStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureQueueStorageResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithApiVersionCheck", + "capabilityId": "Aspire.Hosting.Azure.Storage/withApiVersionCheck", + "qualifiedName": "withApiVersionCheck", + "description": "Ensures the emulator checks that the requested API version is valid.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithApiVersionCheck(options ...*WithApiVersionCheckOptions) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithApiVersionCheckOptions", + "fields": [ + { + "name": "Enable", + "jsonName": "enable", + "type": "*bool", + "description": "Whether to enable API version check or not. Default is true." + } + ] + }, + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithBlobPort", + "capabilityId": "Aspire.Hosting.Azure.Storage/withBlobPort", + "qualifiedName": "withBlobPort", + "description": "Modifies the host port that the storage emulator listens on for blob requests.", + "kind": "Method", + "signature": "WithBlobPort(port float64) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.Azure.Storage/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the data folder to an Azure Storage emulator resource.", + "returns": "A builder for the `AzureStorageEmulatorResource`.", + "kind": "Method", + "signature": "WithDataBindMount(options ...*WithDataBindMountOptions) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "Path", + "jsonName": "path", + "type": "*string", + "description": "Relative path to the AppHost where emulator storage is persisted between runs. Defaults to the path '.azurite/{builder.Resource.Name}'" + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount." + } + ] + }, + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Azure.Storage/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to an Azure Storage emulator resource.", + "returns": "A builder for the `AzureStorageEmulatorResource`.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only volume." + } + ] + }, + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithQueuePort", + "capabilityId": "Aspire.Hosting.Azure.Storage/withQueuePort", + "qualifiedName": "withQueuePort", + "description": "Modifies the host port that the storage emulator listens on for queue requests.", + "kind": "Method", + "signature": "WithQueuePort(port float64) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + }, + { + "name": "WithTablePort", + "capabilityId": "Aspire.Hosting.Azure.Storage/withTablePort", + "qualifiedName": "withTablePort", + "description": "Modifies the host port that the storage emulator listens on for table requests.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTablePort(port float64) AzureStorageEmulatorResource", + "receiver": "AzureStorageEmulatorResource", + "parameters": [ + { + "name": "port", + "type": "float64", + "description": "Host port to use." + } + ], + "returnType": "AzureStorageEmulatorResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureStorageEmulatorResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddBlobContainer", + "capabilityId": "Aspire.Hosting.Azure.Storage/addBlobContainer", + "qualifiedName": "addBlobContainer", + "description": "Adds an Azure Blob Storage container resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBlobContainer(name string, options ...*AddBlobContainerOptions) AzureBlobStorageContainerResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "options": { + "typeName": "AddBlobContainerOptions", + "fields": [ + { + "name": "BlobContainerName", + "jsonName": "blobContainerName", + "type": "*string", + "description": "The name of the blob container." + } + ] + }, + "returnType": "AzureBlobStorageContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddBlobs", + "capabilityId": "Aspire.Hosting.Azure.Storage/addBlobs", + "qualifiedName": "addBlobs", + "description": "Adds an Azure Blob Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBlobs(name string) AzureBlobStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureBlobStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddDataLake", + "capabilityId": "Aspire.Hosting.Azure.Storage/addDataLake", + "qualifiedName": "addDataLake", + "description": "Adds an Azure Data Lake Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDataLake(name string) AzureDataLakeStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureDataLakeStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddDataLakeFileSystem", + "capabilityId": "Aspire.Hosting.Azure.Storage/addDataLakeFileSystem", + "qualifiedName": "addDataLakeFileSystem", + "description": "Adds an Azure Data Lake Storage file system resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDataLakeFileSystem(name string, options ...*AddDataLakeFileSystemOptions) AzureDataLakeStorageFileSystemResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "options": { + "typeName": "AddDataLakeFileSystemOptions", + "fields": [ + { + "name": "DataLakeFileSystemName", + "jsonName": "dataLakeFileSystemName", + "type": "*string", + "description": "The name of the data lake file system." + } + ] + }, + "returnType": "AzureDataLakeStorageFileSystemResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddQueue", + "capabilityId": "Aspire.Hosting.Azure.Storage/addQueue", + "qualifiedName": "addQueue", + "description": "Adds an Azure Storage queue resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddQueue(name string, options ...*AddQueueOptions) AzureQueueStorageQueueResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "options": { + "typeName": "AddQueueOptions", + "fields": [ + { + "name": "QueueName", + "jsonName": "queueName", + "type": "*string", + "description": "The name of the queue." + } + ] + }, + "returnType": "AzureQueueStorageQueueResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddQueues", + "capabilityId": "Aspire.Hosting.Azure.Storage/addQueues", + "qualifiedName": "addQueues", + "description": "Adds an Azure Queue Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddQueues(name string) AzureQueueStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureQueueStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "AddTables", + "capabilityId": "Aspire.Hosting.Azure.Storage/addTables", + "qualifiedName": "addTables", + "description": "Adds an Azure Table Storage resource", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddTables(name string) AzureTableStorageResource", + "receiver": "AzureStorageResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + } + ], + "returnType": "AzureTableStorageResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + }, + { + "name": "RunAsEmulator", + "capabilityId": "Aspire.Hosting.Azure.Storage/runAsEmulator", + "qualifiedName": "runAsEmulator", + "description": "Configures the Azure Storage resource to be emulated using Azurite", + "remarks": "This version of the package defaults to the tag of the / container image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsEmulator(options ...*RunAsEmulatorOptions) AzureStorageResource", + "receiver": "AzureStorageResource", + "parameters": [], + "options": { + "typeName": "RunAsEmulatorOptions", + "fields": [ + { + "name": "ConfigureContainer", + "type": "func(obj AzureStorageEmulatorResource)", + "isCallback": true, + "callbackSignature": "func(obj AzureStorageEmulatorResource)", + "description": "Callback that exposes underlying container used for emulation to allow for customization." + } + ] + }, + "returnType": "AzureStorageResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.Storage/Aspire.Hosting.Azure.AzureStorageResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Azure.AzureStorageResource" + ], + "appliesTo": [ + "AzureStorageResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureTableStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureTableStorageResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureStorageRole", + "fullName": "Aspire.Hosting.AzureStorageRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure Storage roles.", + "members": [ + { + "name": "AzureStorageRoleClassicStorageAccountContributor", + "value": "ClassicStorageAccountContributor" + }, + { + "name": "AzureStorageRoleClassicStorageAccountKeyOperatorServiceRole", + "value": "ClassicStorageAccountKeyOperatorServiceRole" + }, + { + "name": "AzureStorageRoleStorageAccountBackupContributor", + "value": "StorageAccountBackupContributor" + }, + { + "name": "AzureStorageRoleStorageAccountContributor", + "value": "StorageAccountContributor" + }, + { + "name": "AzureStorageRoleStorageAccountKeyOperatorServiceRole", + "value": "StorageAccountKeyOperatorServiceRole" + }, + { + "name": "AzureStorageRoleStorageBlobDataContributor", + "value": "StorageBlobDataContributor" + }, + { + "name": "AzureStorageRoleStorageBlobDataOwner", + "value": "StorageBlobDataOwner" + }, + { + "name": "AzureStorageRoleStorageBlobDataReader", + "value": "StorageBlobDataReader" + }, + { + "name": "AzureStorageRoleStorageBlobDelegator", + "value": "StorageBlobDelegator" + }, + { + "name": "AzureStorageRoleStorageFileDataPrivilegedContributor", + "value": "StorageFileDataPrivilegedContributor" + }, + { + "name": "AzureStorageRoleStorageFileDataPrivilegedReader", + "value": "StorageFileDataPrivilegedReader" + }, + { + "name": "AzureStorageRoleStorageFileDataSmbShareContributor", + "value": "StorageFileDataSmbShareContributor" + }, + { + "name": "AzureStorageRoleStorageFileDataSmbShareReader", + "value": "StorageFileDataSmbShareReader" + }, + { + "name": "AzureStorageRoleStorageFileDataSmbShareElevatedContributor", + "value": "StorageFileDataSmbShareElevatedContributor" + }, + { + "name": "AzureStorageRoleStorageQueueDataContributor", + "value": "StorageQueueDataContributor" + }, + { + "name": "AzureStorageRoleStorageQueueDataReader", + "value": "StorageQueueDataReader" + }, + { + "name": "AzureStorageRoleStorageQueueDataMessageSender", + "value": "StorageQueueDataMessageSender" + }, + { + "name": "AzureStorageRoleStorageQueueDataMessageProcessor", + "value": "StorageQueueDataMessageProcessor" + }, + { + "name": "AzureStorageRoleStorageTableDataContributor", + "value": "StorageTableDataContributor" + }, + { + "name": "AzureStorageRoleStorageTableDataReader", + "value": "StorageTableDataReader" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.WebPubSub.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.WebPubSub.13.6.0.json new file mode 100644 index 0000000000..91f1c452b8 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Azure.WebPubSub.13.6.0.json @@ -0,0 +1,349 @@ +{ + "package": { + "name": "Aspire.Hosting.Azure.WebPubSub", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddAzureWebPubSub", + "capabilityId": "Aspire.Hosting.Azure.WebPubSub/addAzureWebPubSub", + "qualifiedName": "addAzureWebPubSub", + "description": "Adds an Azure Web PubSub resource to the application model. Change sku: WithParameter(\"sku\", \"Standard_S1\") Change capacity: WithParameter(\"capacity\", 2)", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureWebPubSub(name string) AzureWebPubSubResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "AzureWebPubSubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddEventHandler", + "capabilityId": "Aspire.Hosting.Azure.WebPubSub/addEventHandlerWithoutAuth", + "qualifiedName": "addEventHandler", + "description": "Adds an event handler to an Azure Web PubSub hub.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddEventHandler(urlExpression *ReferenceExpression, options ...*AddEventHandlerOptions) AzureWebPubSubHubResource", + "receiver": "AzureWebPubSubHubResource", + "parameters": [ + { + "name": "urlExpression", + "type": "*ReferenceExpression", + "description": "The expression to evaluate the URL template configured for the event handler." + } + ], + "options": { + "typeName": "AddEventHandlerOptions", + "fields": [ + { + "name": "UserEventPattern", + "jsonName": "userEventPattern", + "type": "*string", + "description": "The user event pattern for the event handler." + }, + { + "name": "SystemEvents", + "jsonName": "systemEvents", + "type": "[]string", + "description": "The system events for the event handler." + } + ] + }, + "returnType": "AzureWebPubSubHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.WebPubSub/Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource" + ], + "appliesTo": [ + "AzureWebPubSubHubResource" + ] + }, + { + "name": "AddHub", + "capabilityId": "Aspire.Hosting.Azure.WebPubSub/addHub", + "qualifiedName": "addHub", + "description": "Adds an Azure Web Pub Sub hub resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddHub(name string, options ...*AddHubOptions) AzureWebPubSubHubResource", + "receiver": "AzureWebPubSubResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure WebPubSub Hub resource." + } + ], + "options": { + "typeName": "AddHubOptions", + "fields": [ + { + "name": "HubName", + "jsonName": "hubName", + "type": "*string", + "description": "The name of the Azure WebPubSub Hub. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureWebPubSubHubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.WebPubSub/Aspire.Hosting.ApplicationModel.AzureWebPubSubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureWebPubSubResource" + ], + "appliesTo": [ + "AzureWebPubSubResource" + ] + }, + { + "name": "WithWebPubSubRoleAssignments", + "capabilityId": "Aspire.Hosting.Azure.WebPubSub/withWebPubSubRoleAssignments", + "qualifiedName": "withWebPubSubRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Azure Web PubSub resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWebPubSubRoleAssignments(target AzureWebPubSubResource, roles []AzureWebPubSubRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "AzureWebPubSubResource", + "description": "The target Azure Web PubSub resource." + }, + { + "name": "roles", + "type": "[]AzureWebPubSubRole", + "description": "The Web PubSub roles to be assigned." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.ApplicationModel.AzureWebPubSubResource", + "Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource" + ], + "appliesTo": [ + "AzureBicepResource", + "AzureEnvironmentResource", + "AzureProvisioningResource", + "AzureUserAssignedIdentityResource", + "AzureWebPubSubHubResource", + "AzureWebPubSubResource", + "CSharpAppResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "ParameterResource", + "ProjectResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureWebPubSubHubResource", + "fullName": "Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "AddEventHandler", + "capabilityId": "Aspire.Hosting.Azure.WebPubSub/addEventHandlerWithoutAuth", + "qualifiedName": "addEventHandler", + "description": "Adds an event handler to an Azure Web PubSub hub.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddEventHandler(urlExpression *ReferenceExpression, options ...*AddEventHandlerOptions) AzureWebPubSubHubResource", + "receiver": "AzureWebPubSubHubResource", + "parameters": [ + { + "name": "urlExpression", + "type": "*ReferenceExpression", + "description": "The expression to evaluate the URL template configured for the event handler." + } + ], + "options": { + "typeName": "AddEventHandlerOptions", + "fields": [ + { + "name": "UserEventPattern", + "jsonName": "userEventPattern", + "type": "*string", + "description": "The user event pattern for the event handler." + }, + { + "name": "SystemEvents", + "jsonName": "systemEvents", + "type": "[]string", + "description": "The system events for the event handler." + } + ] + }, + "returnType": "AzureWebPubSubHubResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.WebPubSub/Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureWebPubSubHubResource" + ], + "appliesTo": [ + "AzureWebPubSubHubResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureWebPubSubResource", + "fullName": "Aspire.Hosting.ApplicationModel.AzureWebPubSubResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "AddHub", + "capabilityId": "Aspire.Hosting.Azure.WebPubSub/addHub", + "qualifiedName": "addHub", + "description": "Adds an Azure Web Pub Sub hub resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddHub(name string, options ...*AddHubOptions) AzureWebPubSubHubResource", + "receiver": "AzureWebPubSubResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Azure WebPubSub Hub resource." + } + ], + "options": { + "typeName": "AddHubOptions", + "fields": [ + { + "name": "HubName", + "jsonName": "hubName", + "type": "*string", + "description": "The name of the Azure WebPubSub Hub. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "AzureWebPubSubHubResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Azure.WebPubSub/Aspire.Hosting.ApplicationModel.AzureWebPubSubResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.AzureWebPubSubResource" + ], + "appliesTo": [ + "AzureWebPubSubResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "AzureWebPubSubRole", + "fullName": "Aspire.Hosting.AzureWebPubSubRole", + "kind": "enum", + "description": "Represents ATS-compatible Azure Web PubSub roles.", + "members": [ + { + "name": "AzureWebPubSubRoleWebPubSubContributor", + "value": "WebPubSubContributor" + }, + { + "name": "AzureWebPubSubRoleWebPubSubServiceOwner", + "value": "WebPubSubServiceOwner" + }, + { + "name": "AzureWebPubSubRoleWebPubSubServiceReader", + "value": "WebPubSubServiceReader" + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Blazor.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Blazor.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..437d187778 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Blazor.13.6.0-preview.1.26478.8.json @@ -0,0 +1,339 @@ +{ + "package": { + "name": "Aspire.Hosting.Blazor", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddBlazorGateway", + "capabilityId": "Aspire.Hosting.Blazor/addBlazorGateway", + "qualifiedName": "addBlazorGateway", + "description": "Registers the built-in Blazor Gateway as a file-based C# app. The gateway is shipped as Gateway.cs alongside this library and launched via `AddCSharpApp`. No separate project is needed.", + "kind": "Method", + "signature": "AddBlazorGateway(name string) ProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "returnType": "ProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddBlazorWasmProject", + "capabilityId": "Aspire.Hosting.Blazor/addBlazorWasmProject", + "qualifiedName": "addBlazorWasmProject", + "description": "Registers a Blazor WebAssembly project as a resource without launching it as a process. Prefer AddBlazorWasmProject which uses IProjectMetadata for path discovery.", + "kind": "Method", + "signature": "AddBlazorWasmProject(name string, projectPath string) BlazorWasmAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "projectPath", + "type": "string" + } + ], + "returnType": "BlazorWasmAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDotnetProjectBlazorGateway", + "capabilityId": "Aspire.Hosting.Blazor/addDotnetProjectBlazorGateway", + "qualifiedName": "addDotnetProjectBlazorGateway", + "description": "Adds the built-in Blazor gateway as a .NET program resource.", + "returns": "The gateway resource builder.", + "kind": "Method", + "signature": "AddDotnetProjectBlazorGateway(name string) DotnetProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the gateway resource." + } + ], + "returnType": "DotnetProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithBlazorClientApp", + "capabilityId": "Aspire.Hosting.Blazor/withBlazorClientApp", + "qualifiedName": "withBlazorClientApp", + "description": "Attaches a Blazor WebAssembly app to the Gateway. The resource name is used as the URL path prefix (e.g., resource \"store\" → /store/). Service names are derived from WithReference() annotations on the WASM resource. Service references from the WASM app are automatically forwarded to the gateway so the gateway can resolve service endpoints for YARP proxying.", + "kind": "Method", + "signature": "WithBlazorClientApp(wasmApp BlazorWasmAppResource, options ...*WithBlazorClientAppOptions) ProjectResource", + "receiver": "ProjectResource", + "parameters": [ + { + "name": "wasmApp", + "type": "BlazorWasmAppResource", + "description": "The Blazor WebAssembly app to attach to the gateway." + } + ], + "options": { + "typeName": "WithBlazorClientAppOptions", + "fields": [ + { + "name": "ApiPrefix", + "jsonName": "apiPrefix", + "type": "*string", + "description": "The URL path prefix for API proxy routes. Defaults to `\"_api\"`." + }, + { + "name": "OtlpPrefix", + "jsonName": "otlpPrefix", + "type": "*string", + "description": "The URL path prefix for OTLP proxy routes. Defaults to `\"_otlp\"`." + }, + { + "name": "ProxyTelemetry", + "jsonName": "proxyTelemetry", + "type": "*bool", + "description": "`true` to expose the OTLP proxy for the client app; otherwise, `false`." + } + ] + }, + "returnType": "ProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "WithBlazorClientApp", + "capabilityId": "Aspire.Hosting.Blazor/withDotnetProjectBlazorClientApp", + "qualifiedName": "withBlazorClientApp", + "description": "Attaches a Blazor WebAssembly app to the gateway. The app's resource name becomes its URL path prefix, and its service references are forwarded to the gateway for proxying.", + "returns": "The gateway resource builder.", + "kind": "Method", + "signature": "WithBlazorClientApp(wasmApp BlazorWasmAppResource, options ...*WithBlazorClientAppOptions) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "wasmApp", + "type": "BlazorWasmAppResource", + "description": "The Blazor WebAssembly app to attach to the gateway." + } + ], + "options": { + "typeName": "WithBlazorClientAppOptions", + "fields": [ + { + "name": "ApiPrefix", + "jsonName": "apiPrefix", + "type": "*string", + "description": "The URL path prefix for API proxy routes. The default is `\"_api\"`." + }, + { + "name": "OtlpPrefix", + "jsonName": "otlpPrefix", + "type": "*string", + "description": "The URL path prefix for telemetry proxy routes. The default is `\"_otlp\"`." + }, + { + "name": "ProxyTelemetry", + "jsonName": "proxyTelemetry", + "type": "*bool", + "description": "`true` to expose the telemetry proxy for the client app; otherwise, `false`." + } + ] + }, + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithBlazorDebuggerBrowser", + "capabilityId": "Aspire.Hosting.Blazor/withBlazorDebuggerBrowser", + "qualifiedName": "withBlazorDebuggerBrowser", + "description": "Configures the browser launched when starting a debug session for the Blazor WebAssembly app. The value is read when the debugger is registered on the gateway, so call this before `WithBlazorClientApp` or `WithBlazorClientApp` attaches the app.", + "kind": "Method", + "signature": "WithBlazorDebuggerBrowser(options ...*WithBlazorDebuggerBrowserOptions) BlazorWasmAppResource", + "receiver": "BlazorWasmAppResource", + "parameters": [], + "options": { + "typeName": "WithBlazorDebuggerBrowserOptions", + "fields": [ + { + "name": "Browser", + "jsonName": "browser", + "type": "*string", + "description": "The browser to use for debugging. Defaults to `\"msedge\"`. Supported values include `\"msedge\"` and `\"chrome\"`." + } + ] + }, + "returnType": "BlazorWasmAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Blazor/Aspire.Hosting.BlazorWasmAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.BlazorWasmAppResource" + ], + "appliesTo": [ + "BlazorWasmAppResource" + ] + } + ], + "handleTypes": [ + { + "name": "BlazorWasmAppResource", + "fullName": "Aspire.Hosting.BlazorWasmAppResource", + "kind": "handle", + "description": "A resource representing a Blazor WebAssembly application project. This is not a running process — it's metadata about a WASM project whose static web assets are served through a Gateway. Implements IResourceWithEnvironment so that WithReference() can be used to declare service dependencies (the annotations are read at orchestration time). Implements IResourceWithParent so that the orchestrator mirrors the gateway's lifecycle state (Running, Stopped, etc.) to this child resource automatically.", + "implementedInterfaces": [ + "Resource", + "ResourceWithEnvironment", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "WithBlazorDebuggerBrowser", + "capabilityId": "Aspire.Hosting.Blazor/withBlazorDebuggerBrowser", + "qualifiedName": "withBlazorDebuggerBrowser", + "description": "Configures the browser launched when starting a debug session for the Blazor WebAssembly app. The value is read when the debugger is registered on the gateway, so call this before `WithBlazorClientApp` or `WithBlazorClientApp` attaches the app.", + "kind": "Method", + "signature": "WithBlazorDebuggerBrowser(options ...*WithBlazorDebuggerBrowserOptions) BlazorWasmAppResource", + "receiver": "BlazorWasmAppResource", + "parameters": [], + "options": { + "typeName": "WithBlazorDebuggerBrowserOptions", + "fields": [ + { + "name": "Browser", + "jsonName": "browser", + "type": "*string", + "description": "The browser to use for debugging. Defaults to `\"msedge\"`. Supported values include `\"msedge\"` and `\"chrome\"`." + } + ] + }, + "returnType": "BlazorWasmAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Blazor/Aspire.Hosting.BlazorWasmAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.BlazorWasmAppResource" + ], + "appliesTo": [ + "BlazorWasmAppResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DotnetProjectResource", + "fullName": "Aspire.Hosting.Dotnet.DotnetProjectResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithBlazorClientApp", + "capabilityId": "Aspire.Hosting.Blazor/withDotnetProjectBlazorClientApp", + "qualifiedName": "withBlazorClientApp", + "description": "Attaches a Blazor WebAssembly app to the gateway. The app's resource name becomes its URL path prefix, and its service references are forwarded to the gateway for proxying.", + "returns": "The gateway resource builder.", + "kind": "Method", + "signature": "WithBlazorClientApp(wasmApp BlazorWasmAppResource, options ...*WithBlazorClientAppOptions) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "wasmApp", + "type": "BlazorWasmAppResource", + "description": "The Blazor WebAssembly app to attach to the gateway." + } + ], + "options": { + "typeName": "WithBlazorClientAppOptions", + "fields": [ + { + "name": "ApiPrefix", + "jsonName": "apiPrefix", + "type": "*string", + "description": "The URL path prefix for API proxy routes. The default is `\"_api\"`." + }, + { + "name": "OtlpPrefix", + "jsonName": "otlpPrefix", + "type": "*string", + "description": "The URL path prefix for telemetry proxy routes. The default is `\"_otlp\"`." + }, + { + "name": "ProxyTelemetry", + "jsonName": "proxyTelemetry", + "type": "*bool", + "description": "`true` to expose the telemetry proxy for the client app; otherwise, `false`." + } + ] + }, + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Browsers.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Browsers.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..c87d352ab3 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Browsers.13.6.0-preview.1.26478.8.json @@ -0,0 +1,91 @@ +{ + "package": { + "name": "Aspire.Hosting.Browsers", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "WithBrowserLogs", + "capabilityId": "Aspire.Hosting.Browsers/withBrowserLogs", + "qualifiedName": "withBrowserLogs", + "description": "Adds a child resource that can open the application's primary browser endpoint in a tracked browser session, surface browser diagnostics, and capture screenshots.", + "remarks": "This method adds a child browser logs resource beneath the parent resource represented by `builder`.\nThe child resource exposes a dashboard command that launches a Chromium-based browser in a tracked mode, attaches to\nthe browser's debugging protocol, forwards browser console, error, exception, and network output to the child\nresource's console log stream, and can capture screenshots as command artifacts.\nThe tracked browser session uses the Chrome DevTools\nProtocol (CDP) to subscribe to browser runtime, log, page, and network events.\nThe parent resource must expose at least one HTTP or HTTPS endpoint. HTTPS endpoints are preferred over HTTP\nendpoints when selecting the browser target URL.\nBrowser, profile, and user data mode settings can also be supplied from configuration\nusing `Aspire:Hosting:BrowserLogs:Browser`, `Aspire:Hosting:BrowserLogs:Profile`,\nand `Aspire:Hosting:BrowserLogs:UserDataMode`, or scoped to a specific resource with\n`Aspire:Hosting:BrowserLogs:{ResourceName}:Browser`,\n`Aspire:Hosting:BrowserLogs:{ResourceName}:Profile`, and\n`Aspire:Hosting:BrowserLogs:{ResourceName}:UserDataMode`. Explicit method arguments override configuration.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithBrowserLogs(options ...*WithBrowserLogsOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [], + "options": { + "typeName": "WithBrowserLogsOptions", + "fields": [ + { + "name": "Browser", + "jsonName": "browser", + "type": "*string", + "description": "The browser to launch. When not specified, the tracked browser uses the configured value from `Aspire:Hosting:BrowserLogs` and otherwise prefers an installed `\"msedge\"` browser in shared user data mode, an installed `\"chrome\"` browser in isolated user data mode, and finally falls back to `\"chrome\"`. Supported values include logical browser names such as `\"msedge\"` and `\"chrome\"`, or an explicit browser executable path." + }, + { + "name": "Profile", + "jsonName": "profile", + "type": "*string", + "description": "Optional Chromium profile name or directory name to use. Only valid when the effective user data mode is `Shared`. When not specified, the tracked browser uses the configured value from `Aspire:Hosting:BrowserLogs` if present." + }, + { + "name": "UserDataMode", + "jsonName": "userDataMode", + "type": "*BrowserUserDataMode", + "description": "Optional `BrowserUserDataMode` that selects whether the tracked browser launches against a persistent Aspire-managed user data directory shared across all AppHosts on the machine (`Shared`, the default) or a per-AppHost persistent user data directory (`Isolated`). Both modes use Aspire-managed paths under `%LocalAppData%\\Aspire\\BrowserData` on Windows (or platform equivalents); the user's normal browser profile is never used. When not specified, the tracked browser uses the configured value from `Aspire:Hosting:BrowserLogs` and otherwise defaults to `Shared`." + } + ] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + } + ], + "handleTypes": [], + "dtoTypes": [], + "enumTypes": [ + { + "name": "BrowserUserDataMode", + "fullName": "Aspire.Hosting.BrowserUserDataMode", + "kind": "enum", + "description": "Selects the Chromium user data directory used by tracked browser sessions.", + "members": [ + { + "name": "BrowserUserDataModeShared", + "value": "Shared", + "description": "Use a persistent Aspire-managed user data directory shared across all AppHosts on the machine. State such as cookies, sign-ins, and extensions persist across runs and are visible to every AppHost using the same browser.", + "remarks": "The directory lives under a well-known path (for example `%LocalAppData%\\Aspire\\BrowserData\\shared\\`\non Windows). The directory is persistent across AppHost restarts, but the default tracked browser process is\nowned by the AppHost that launched it." + }, + { + "name": "BrowserUserDataModeIsolated", + "value": "Isolated", + "description": "Use a persistent Aspire-managed user data directory scoped to the current AppHost project. Each AppHost gets its own state that persists across runs but is not shared with other AppHosts.", + "remarks": "The directory is keyed on a stable hash of the AppHost project path (for example\n`%LocalAppData%\\Aspire\\BrowserData\\isolated\\\\` on Windows). The directory persists across\nruns, but the default tracked browser process is owned by the AppHost that launched it." + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.ClickHouse.13.5.3.json b/src/frontend/src/data/go-modules/Aspire.Hosting.ClickHouse.13.5.3.json new file mode 100644 index 0000000000..f5b807108a --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.ClickHouse.13.5.3.json @@ -0,0 +1,748 @@ +{ + "package": { + "name": "Aspire.Hosting.ClickHouse", + "version": "13.5.3", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/ClickHouse/ClickHouse.Aspire", + "sourceCommit": "cabd9edc0899714407e6ad81dc4954eb01302af0" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseDatabaseResource.connectionStringExpression", + "qualifiedName": "ClickHouseDatabaseResource.connectionStringExpression", + "description": "Gets the connection string expression for the ClickHouse database.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "ClickHouseDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource" + ], + "appliesTo": [ + "ClickHouseDatabaseResource" + ] + }, + { + "name": "DatabaseName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseDatabaseResource.databaseName", + "qualifiedName": "ClickHouseDatabaseResource.databaseName", + "description": "Gets the database name.", + "kind": "PropertyGetter", + "signature": "DatabaseName() (string, error)", + "receiver": "ClickHouseDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource" + ], + "appliesTo": [ + "ClickHouseDatabaseResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseDatabaseResource.parent", + "qualifiedName": "ClickHouseDatabaseResource.parent", + "description": "Gets the parent ClickHouse container resource.", + "kind": "PropertyGetter", + "signature": "Parent() ClickHouseServerResource", + "receiver": "ClickHouseDatabaseResource", + "parameters": [], + "returnType": "ClickHouseServerResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource" + ], + "appliesTo": [ + "ClickHouseDatabaseResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.connectionStringExpression", + "qualifiedName": "ClickHouseServerResource.connectionStringExpression", + "description": "Gets the connection string expression for the ClickHouse server.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "Databases", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.databases", + "qualifiedName": "ClickHouseServerResource.databases", + "description": "A dictionary where the key is the resource name and the value is the database name.", + "kind": "PropertyGetter", + "signature": "Databases() (map[string]string, error)", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "(map[string]string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "Host", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.host", + "qualifiedName": "ClickHouseServerResource.host", + "description": "Gets the host expression for this resource.", + "kind": "PropertyGetter", + "signature": "Host() EndpointReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "PasswordParameter", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.passwordParameter", + "qualifiedName": "ClickHouseServerResource.passwordParameter", + "description": "Gets the parameter that contains the ClickHouse server password.", + "kind": "PropertyGetter", + "signature": "PasswordParameter() ParameterResource", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "ParameterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.port", + "qualifiedName": "ClickHouseServerResource.port", + "description": "Gets the port expression for this resource.", + "kind": "PropertyGetter", + "signature": "Port() EndpointReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "PrimaryEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.primaryEndpoint", + "qualifiedName": "ClickHouseServerResource.primaryEndpoint", + "description": "Gets the primary endpoint for the ClickHouse server.", + "kind": "PropertyGetter", + "signature": "PrimaryEndpoint() EndpointReference", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "UserNameParameter", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.userNameParameter", + "qualifiedName": "ClickHouseServerResource.userNameParameter", + "description": "Gets the parameter that contains the ClickHouse server username.", + "kind": "PropertyGetter", + "signature": "UserNameParameter() ParameterResource", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "ParameterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "UserNameReference", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.userNameReference", + "qualifiedName": "ClickHouseServerResource.userNameReference", + "description": "Gets a reference to the user name for the ClickHouse server.", + "remarks": "Returns the user name parameter if specified, otherwise returns the default user name \"default\".", + "kind": "PropertyGetter", + "signature": "UserNameReference() *ReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "AddClickHouse", + "capabilityId": "Aspire.Hosting.ClickHouse/addClickHouse", + "qualifiedName": "addClickHouse", + "description": "Adds a ClickHouse resource to the application model.", + "kind": "Method", + "signature": "AddClickHouse(name string, options ...*AddClickHouseOptions) ClickHouseServerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddClickHouseOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64" + }, + { + "name": "UserName", + "jsonName": "userName", + "type": "*ParameterResource" + }, + { + "name": "Password", + "jsonName": "password", + "type": "*ParameterResource" + } + ] + }, + "returnType": "ClickHouseServerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddDatabase", + "capabilityId": "Aspire.Hosting.ClickHouse/addDatabase", + "qualifiedName": "addDatabase", + "description": "Adds a ClickHouse database to the application model.", + "returns": "The ClickHouse database resource.", + "kind": "Method", + "signature": "AddDatabase(name string, options ...*AddDatabaseOptions) ClickHouseDatabaseResource", + "receiver": "ClickHouseServerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "ClickHouseDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.ClickHouse/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the data folder to a ClickHouse container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataBindMount(source string, options ...*WithDataBindMountOptions) ClickHouseServerResource", + "receiver": "ClickHouseServerResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source directory on the host to mount into the container." + } + ], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount." + } + ] + }, + "returnType": "ClickHouseServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.ClickHouse/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to a ClickHouse container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) ClickHouseServerResource", + "receiver": "ClickHouseServerResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only volume." + } + ] + }, + "returnType": "ClickHouseServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + } + ], + "handleTypes": [ + { + "name": "ClickHouseDatabaseResource", + "fullName": "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "kind": "handle", + "description": "A resource that represents a ClickHouse database. This is a child resource of a `ClickHouseServerResource`.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseDatabaseResource.connectionStringExpression", + "qualifiedName": "ClickHouseDatabaseResource.connectionStringExpression", + "description": "Gets the connection string expression for the ClickHouse database.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "ClickHouseDatabaseResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource" + ], + "appliesTo": [ + "ClickHouseDatabaseResource" + ] + }, + { + "name": "DatabaseName", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseDatabaseResource.databaseName", + "qualifiedName": "ClickHouseDatabaseResource.databaseName", + "description": "Gets the database name.", + "kind": "PropertyGetter", + "signature": "DatabaseName() (string, error)", + "receiver": "ClickHouseDatabaseResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource" + ], + "appliesTo": [ + "ClickHouseDatabaseResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseDatabaseResource.parent", + "qualifiedName": "ClickHouseDatabaseResource.parent", + "description": "Gets the parent ClickHouse container resource.", + "kind": "PropertyGetter", + "signature": "Parent() ClickHouseServerResource", + "receiver": "ClickHouseDatabaseResource", + "parameters": [], + "returnType": "ClickHouseServerResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseDatabaseResource" + ], + "appliesTo": [ + "ClickHouseDatabaseResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ClickHouseServerResource", + "fullName": "Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "kind": "handle", + "description": "A resource that represents a ClickHouse container.", + "implementedInterfaces": [ + "ExpressionValue", + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithConnectionString", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.connectionStringExpression", + "qualifiedName": "ClickHouseServerResource.connectionStringExpression", + "description": "Gets the connection string expression for the ClickHouse server.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "Databases", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.databases", + "qualifiedName": "ClickHouseServerResource.databases", + "description": "A dictionary where the key is the resource name and the value is the database name.", + "kind": "PropertyGetter", + "signature": "Databases() (map[string]string, error)", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "(map[string]string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "Host", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.host", + "qualifiedName": "ClickHouseServerResource.host", + "description": "Gets the host expression for this resource.", + "kind": "PropertyGetter", + "signature": "Host() EndpointReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "PasswordParameter", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.passwordParameter", + "qualifiedName": "ClickHouseServerResource.passwordParameter", + "description": "Gets the parameter that contains the ClickHouse server password.", + "kind": "PropertyGetter", + "signature": "PasswordParameter() ParameterResource", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "ParameterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.port", + "qualifiedName": "ClickHouseServerResource.port", + "description": "Gets the port expression for this resource.", + "kind": "PropertyGetter", + "signature": "Port() EndpointReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "PrimaryEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.primaryEndpoint", + "qualifiedName": "ClickHouseServerResource.primaryEndpoint", + "description": "Gets the primary endpoint for the ClickHouse server.", + "kind": "PropertyGetter", + "signature": "PrimaryEndpoint() EndpointReference", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "UserNameParameter", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.userNameParameter", + "qualifiedName": "ClickHouseServerResource.userNameParameter", + "description": "Gets the parameter that contains the ClickHouse server username.", + "kind": "PropertyGetter", + "signature": "UserNameParameter() ParameterResource", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "ParameterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "UserNameReference", + "capabilityId": "Aspire.Hosting.ApplicationModel/ClickHouseServerResource.userNameReference", + "qualifiedName": "ClickHouseServerResource.userNameReference", + "description": "Gets a reference to the user name for the ClickHouse server.", + "remarks": "Returns the user name parameter if specified, otherwise returns the default user name \"default\".", + "kind": "PropertyGetter", + "signature": "UserNameReference() *ReferenceExpression", + "receiver": "ClickHouseServerResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "AddDatabase", + "capabilityId": "Aspire.Hosting.ClickHouse/addDatabase", + "qualifiedName": "addDatabase", + "description": "Adds a ClickHouse database to the application model.", + "returns": "The ClickHouse database resource.", + "kind": "Method", + "signature": "AddDatabase(name string, options ...*AddDatabaseOptions) ClickHouseDatabaseResource", + "receiver": "ClickHouseServerResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "options": { + "typeName": "AddDatabaseOptions", + "fields": [ + { + "name": "DatabaseName", + "jsonName": "databaseName", + "type": "*string", + "description": "The name of the database. If not provided, this defaults to the same value as `name`." + } + ] + }, + "returnType": "ClickHouseDatabaseResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.ClickHouse/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the data folder to a ClickHouse container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataBindMount(source string, options ...*WithDataBindMountOptions) ClickHouseServerResource", + "receiver": "ClickHouseServerResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source directory on the host to mount into the container." + } + ], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount." + } + ] + }, + "returnType": "ClickHouseServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.ClickHouse/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to a ClickHouse container resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) ClickHouseServerResource", + "receiver": "ClickHouseServerResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only volume." + } + ] + }, + "returnType": "ClickHouseServerResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.ClickHouse/Aspire.Hosting.ApplicationModel.ClickHouseServerResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ClickHouseServerResource" + ], + "appliesTo": [ + "ClickHouseServerResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.DevTunnels.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.DevTunnels.13.6.0.json new file mode 100644 index 0000000000..854093ba84 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.DevTunnels.13.6.0.json @@ -0,0 +1,427 @@ +{ + "package": { + "name": "Aspire.Hosting.DevTunnels", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddDevTunnel", + "capabilityId": "Aspire.Hosting.DevTunnels/addDevTunnel", + "qualifiedName": "addDevTunnel", + "description": "Adds a Dev Tunnel resource to the distributed application model.", + "kind": "Method", + "signature": "AddDevTunnel(name string, options ...*AddDevTunnelOptions) DevTunnelResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddDevTunnelOptions", + "fields": [ + { + "name": "TunnelId", + "jsonName": "tunnelId", + "type": "*string" + }, + { + "name": "AllowAnonymous", + "jsonName": "allowAnonymous", + "type": "*bool" + }, + { + "name": "Description", + "jsonName": "description", + "type": "*string" + }, + { + "name": "Labels", + "jsonName": "labels", + "type": "[]string" + } + ] + }, + "returnType": "DevTunnelResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "GetTunnelEndpoint", + "capabilityId": "Aspire.Hosting.DevTunnels/getEndpointByEndpointReference", + "qualifiedName": "getTunnelEndpoint", + "description": "Gets the tunnel endpoint reference for the specified target endpoint.", + "returns": "An `EndpointReference` representing the public tunnel endpoint.", + "kind": "Method", + "signature": "GetTunnelEndpoint(targetEndpointReference EndpointReference) EndpointReference", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "targetEndpointReference", + "type": "EndpointReference", + "description": "The target endpoint reference." + } + ], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithAnonymousAccess", + "capabilityId": "Aspire.Hosting.DevTunnels/withAnonymousAccess", + "qualifiedName": "withAnonymousAccess", + "description": "Allows the tunnel to be publicly accessed without authentication.", + "remarks": "Sets `AllowAnonymous` to `true` on `Options` .", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAnonymousAccess() DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithExpiration", + "capabilityId": "Aspire.Hosting.DevTunnels/withExpiration", + "qualifiedName": "withExpiration", + "description": "Configures how long the tunnel can remain unused or unmodified before it expires.", + "remarks": "Applies to both new and existing tunnels. This does not limit hosting duration or access-token lifetime.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExpiration(expirationHours float64) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "expirationHours", + "type": "float64", + "description": "The idle expiration period, in whole hours from one hour through 30 days, inclusive." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithTunnelReference", + "capabilityId": "Aspire.Hosting.DevTunnels/withReferenceEndpoint", + "qualifiedName": "withTunnelReference", + "description": "Exposes the specified endpoint via the dev tunnel.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTunnelReference(targetEndpoint EndpointReference) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "targetEndpoint", + "type": "EndpointReference", + "description": "The endpoint to expose via the dev tunnel." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithTunnelReferenceAll", + "capabilityId": "Aspire.Hosting.DevTunnels/withReferenceResourceAnonymous", + "qualifiedName": "withTunnelReferenceAll", + "description": "Adds ports on the dev tunnel for all endpoints found on the referenced resource and sets whether anonymous access is allowed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTunnelReferenceAll(resourceBuilder ResourceWithEndpoints, allowAnonymous bool) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "resourceBuilder", + "type": "ResourceWithEndpoints", + "description": "The resource builder for the referenced resource." + }, + { + "name": "allowAnonymous", + "type": "bool", + "description": "Whether anonymous access is allowed." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithTunnelReferenceAnonymous", + "capabilityId": "Aspire.Hosting.DevTunnels/withReferenceEndpointAnonymous", + "qualifiedName": "withTunnelReferenceAnonymous", + "description": "Exposes the specified endpoint via the dev tunnel and sets whether anonymous access is allowed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTunnelReferenceAnonymous(targetEndpoint EndpointReference, allowAnonymous bool) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "targetEndpoint", + "type": "EndpointReference", + "description": "The endpoint to expose via the dev tunnel." + }, + { + "name": "allowAnonymous", + "type": "bool", + "description": "Whether anonymous access is allowed." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + } + ], + "handleTypes": [ + { + "name": "DevTunnelResource", + "fullName": "Aspire.Hosting.DevTunnels.DevTunnelResource", + "kind": "handle", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "GetTunnelEndpoint", + "capabilityId": "Aspire.Hosting.DevTunnels/getEndpointByEndpointReference", + "qualifiedName": "getTunnelEndpoint", + "description": "Gets the tunnel endpoint reference for the specified target endpoint.", + "returns": "An `EndpointReference` representing the public tunnel endpoint.", + "kind": "Method", + "signature": "GetTunnelEndpoint(targetEndpointReference EndpointReference) EndpointReference", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "targetEndpointReference", + "type": "EndpointReference", + "description": "The target endpoint reference." + } + ], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithAnonymousAccess", + "capabilityId": "Aspire.Hosting.DevTunnels/withAnonymousAccess", + "qualifiedName": "withAnonymousAccess", + "description": "Allows the tunnel to be publicly accessed without authentication.", + "remarks": "Sets `AllowAnonymous` to `true` on `Options` .", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAnonymousAccess() DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithExpiration", + "capabilityId": "Aspire.Hosting.DevTunnels/withExpiration", + "qualifiedName": "withExpiration", + "description": "Configures how long the tunnel can remain unused or unmodified before it expires.", + "remarks": "Applies to both new and existing tunnels. This does not limit hosting duration or access-token lifetime.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithExpiration(expirationHours float64) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "expirationHours", + "type": "float64", + "description": "The idle expiration period, in whole hours from one hour through 30 days, inclusive." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithTunnelReference", + "capabilityId": "Aspire.Hosting.DevTunnels/withReferenceEndpoint", + "qualifiedName": "withTunnelReference", + "description": "Exposes the specified endpoint via the dev tunnel.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTunnelReference(targetEndpoint EndpointReference) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "targetEndpoint", + "type": "EndpointReference", + "description": "The endpoint to expose via the dev tunnel." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithTunnelReferenceAll", + "capabilityId": "Aspire.Hosting.DevTunnels/withReferenceResourceAnonymous", + "qualifiedName": "withTunnelReferenceAll", + "description": "Adds ports on the dev tunnel for all endpoints found on the referenced resource and sets whether anonymous access is allowed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTunnelReferenceAll(resourceBuilder ResourceWithEndpoints, allowAnonymous bool) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "resourceBuilder", + "type": "ResourceWithEndpoints", + "description": "The resource builder for the referenced resource." + }, + { + "name": "allowAnonymous", + "type": "bool", + "description": "Whether anonymous access is allowed." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + }, + { + "name": "WithTunnelReferenceAnonymous", + "capabilityId": "Aspire.Hosting.DevTunnels/withReferenceEndpointAnonymous", + "qualifiedName": "withTunnelReferenceAnonymous", + "description": "Exposes the specified endpoint via the dev tunnel and sets whether anonymous access is allowed.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTunnelReferenceAnonymous(targetEndpoint EndpointReference, allowAnonymous bool) DevTunnelResource", + "receiver": "DevTunnelResource", + "parameters": [ + { + "name": "targetEndpoint", + "type": "EndpointReference", + "description": "The endpoint to expose via the dev tunnel." + }, + { + "name": "allowAnonymous", + "type": "bool", + "description": "Whether anonymous access is allowed." + } + ], + "returnType": "DevTunnelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.DevTunnels/Aspire.Hosting.DevTunnels.DevTunnelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.DevTunnels.DevTunnelResource" + ], + "appliesTo": [ + "DevTunnelResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Docker.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Docker.13.6.0.json new file mode 100644 index 0000000000..28b176180d --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Docker.13.6.0.json @@ -0,0 +1,10691 @@ +{ + "package": { + "name": "Aspire.Hosting.Docker", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "DefaultValue", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.defaultValue", + "qualifiedName": "CapturedEnvironmentVariable.defaultValue", + "description": "Gets or sets the default value for the environment variable.", + "kind": "PropertyGetter", + "signature": "DefaultValue() (*string, error)", + "receiver": "CapturedEnvironmentVariable", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.description", + "qualifiedName": "CapturedEnvironmentVariable.description", + "description": "Gets or sets the description for the environment variable.", + "kind": "PropertyGetter", + "signature": "Description() (*string, error)", + "receiver": "CapturedEnvironmentVariable", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "SetDefaultValue", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.setDefaultValue", + "qualifiedName": "CapturedEnvironmentVariable.setDefaultValue", + "description": "Gets or sets the default value for the environment variable.", + "kind": "PropertySetter", + "signature": "SetDefaultValue(value *string) CapturedEnvironmentVariable", + "receiver": "CapturedEnvironmentVariable", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the default value for the environment variable." + } + ], + "returnType": "CapturedEnvironmentVariable", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "SetDescription", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.setDescription", + "qualifiedName": "CapturedEnvironmentVariable.setDescription", + "description": "Gets or sets the description for the environment variable.", + "kind": "PropertySetter", + "signature": "SetDescription(value *string) CapturedEnvironmentVariable", + "receiver": "CapturedEnvironmentVariable", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the description for the environment variable." + } + ], + "returnType": "CapturedEnvironmentVariable", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.setSource", + "qualifiedName": "CapturedEnvironmentVariable.setSource", + "description": "Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`.", + "kind": "PropertySetter", + "signature": "SetSource(value any) CapturedEnvironmentVariable", + "receiver": "CapturedEnvironmentVariable", + "parameters": [ + { + "name": "value", + "type": "any", + "allowedTypes": [ + "ParameterResource", + "ContainerMountAnnotation", + "ContainerImageReference", + "ContainerPortReference" + ], + "description": "Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`." + } + ], + "returnType": "CapturedEnvironmentVariable", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.source", + "qualifiedName": "CapturedEnvironmentVariable.source", + "description": "Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`.", + "kind": "PropertyGetter", + "signature": "Source() (any, error)", + "receiver": "CapturedEnvironmentVariable", + "parameters": [], + "returnType": "(any, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "Configs", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.configs", + "qualifiedName": "ComposeFile.configs", + "description": "Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details.", + "kind": "PropertyGetter", + "signature": "Configs() *Dict[string, Config]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Config]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Extensions", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.extensions", + "qualifiedName": "ComposeFile.extensions", + "description": "Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications.", + "kind": "PropertyGetter", + "signature": "Extensions() *Dict[string, any]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, any]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.name", + "qualifiedName": "ComposeFile.name", + "description": "Represents the name of the Docker Compose file or project.", + "remarks": "The name property is used to identify the Compose application\nor project when orchestrating Docker containers.", + "kind": "PropertyGetter", + "signature": "Name() (*string, error)", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Networks", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.networks", + "qualifiedName": "ComposeFile.networks", + "description": "Represents the collection of networks defined in a Docker Compose file.", + "remarks": "Each key in the dictionary represents the name of the network, and the value is an instance of the `Network` class,\nwhich encapsulates the details and configurations of the corresponding network.", + "kind": "PropertyGetter", + "signature": "Networks() *Dict[string, Network]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Network]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Secrets", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.secrets", + "qualifiedName": "ComposeFile.secrets", + "description": "Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file.", + "remarks": "Each secret is represented as a key-value pair, where the key is the name\nof the secret, and the value is an instance of the `Secret` class,\nwhich holds the details about the secret such as file location, external status,\nand additional metadata like labels.", + "kind": "PropertyGetter", + "signature": "Secrets() *Dict[string, Secret]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Secret]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.services", + "qualifiedName": "ComposeFile.services", + "description": "Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class.", + "remarks": "Services are a critical part of the Docker Compose ecosystem and are used to define\nindividual application components. These components can include images, commands,\nenvironment variables, ports, volumes, dependencies, and more.", + "kind": "PropertyGetter", + "signature": "Services() *Dict[string, Service]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Service]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetConfigs", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setConfigs", + "qualifiedName": "ComposeFile.setConfigs", + "description": "Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details.", + "kind": "PropertySetter", + "signature": "SetConfigs(value *Dict[string, Config]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Config]", + "description": "Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetExtensions", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setExtensions", + "qualifiedName": "ComposeFile.setExtensions", + "description": "Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications.", + "kind": "PropertySetter", + "signature": "SetExtensions(value *Dict[string, any]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, any]", + "description": "Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setName", + "qualifiedName": "ComposeFile.setName", + "description": "Represents the name of the Docker Compose file or project.", + "remarks": "The name property is used to identify the Compose application\nor project when orchestrating Docker containers.", + "kind": "PropertySetter", + "signature": "SetName(value *string) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the name of the Docker Compose file or project." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetNetworks", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setNetworks", + "qualifiedName": "ComposeFile.setNetworks", + "description": "Represents the collection of networks defined in a Docker Compose file.", + "remarks": "Each key in the dictionary represents the name of the network, and the value is an instance of the `Network` class,\nwhich encapsulates the details and configurations of the corresponding network.", + "kind": "PropertySetter", + "signature": "SetNetworks(value *Dict[string, Network]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Network]", + "description": "Represents the collection of networks defined in a Docker Compose file." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetSecrets", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setSecrets", + "qualifiedName": "ComposeFile.setSecrets", + "description": "Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file.", + "remarks": "Each secret is represented as a key-value pair, where the key is the name\nof the secret, and the value is an instance of the `Secret` class,\nwhich holds the details about the secret such as file location, external status,\nand additional metadata like labels.", + "kind": "PropertySetter", + "signature": "SetSecrets(value *Dict[string, Secret]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Secret]", + "description": "Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetServices", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setServices", + "qualifiedName": "ComposeFile.setServices", + "description": "Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class.", + "remarks": "Services are a critical part of the Docker Compose ecosystem and are used to define\nindividual application components. These components can include images, commands,\nenvironment variables, ports, volumes, dependencies, and more.", + "kind": "PropertySetter", + "signature": "SetServices(value *Dict[string, Service]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Service]", + "description": "Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetVersion", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setVersion", + "qualifiedName": "ComposeFile.setVersion", + "description": "Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors.", + "kind": "PropertySetter", + "signature": "SetVersion(value *string) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetVolumes", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setVolumes", + "qualifiedName": "ComposeFile.setVolumes", + "description": "Represents a collection of volume definitions within a Docker Compose file.", + "remarks": "The volumes are defined using a dictionary structure where the key represents the\nname of the volume, and the value is an instance of the `Volume` class.\nVolumes can be used to share data between containers or between a container and the host system.", + "kind": "PropertySetter", + "signature": "SetVolumes(value *Dict[string, Volume]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Volume]", + "description": "Represents a collection of volume definitions within a Docker Compose file." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Version", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.version", + "qualifiedName": "ComposeFile.version", + "description": "Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors.", + "kind": "PropertyGetter", + "signature": "Version() (*string, error)", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Volumes", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.volumes", + "qualifiedName": "ComposeFile.volumes", + "description": "Represents a collection of volume definitions within a Docker Compose file.", + "remarks": "The volumes are defined using a dictionary structure where the key represents the\nname of the volume, and the value is an instance of the `Volume` class.\nVolumes can be used to share data between containers or between a container and the host system.", + "kind": "PropertyGetter", + "signature": "Volumes() *Dict[string, Volume]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Volume]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Content", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.content", + "qualifiedName": "Config.content", + "description": "Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file.", + "kind": "PropertyGetter", + "signature": "Content() (*string, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.external", + "qualifiedName": "Config.external", + "description": "Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "File", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.file", + "qualifiedName": "Config.file", + "description": "Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component.", + "kind": "PropertyGetter", + "signature": "File() (*string, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.labels", + "qualifiedName": "Config.labels", + "description": "Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Config", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.name", + "qualifiedName": "Config.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetContent", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setContent", + "qualifiedName": "Config.setContent", + "description": "Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file.", + "kind": "PropertySetter", + "signature": "SetContent(value *string) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setExternal", + "qualifiedName": "Config.setExternal", + "description": "Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setFile", + "qualifiedName": "Config.setFile", + "description": "Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component.", + "kind": "PropertySetter", + "signature": "SetFile(value *string) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setLabels", + "qualifiedName": "Config.setLabels", + "description": "Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setName", + "qualifiedName": "Config.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "Gid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.gid", + "qualifiedName": "ConfigReference.gid", + "description": "Gets or sets the group ID (GID) used to identify the group of the referenced configuration.", + "remarks": "The GID is an optional integer parameter that specifies the group ownership\nfor the resource. If set, it defines the group to which the target resource belongs.", + "kind": "PropertyGetter", + "signature": "Gid() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Mode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.mode", + "qualifiedName": "ConfigReference.mode", + "description": "Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes.", + "kind": "PropertyGetter", + "signature": "Mode() (*UnixFileMode, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*UnixFileMode, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetGid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setGid", + "qualifiedName": "ConfigReference.setGid", + "description": "Gets or sets the group ID (GID) used to identify the group of the referenced configuration.", + "remarks": "The GID is an optional integer parameter that specifies the group ownership\nfor the resource. If set, it defines the group to which the target resource belongs.", + "kind": "PropertySetter", + "signature": "SetGid(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the group ID (GID) used to identify the group of the referenced configuration." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setMode", + "qualifiedName": "ConfigReference.setMode", + "description": "Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes.", + "kind": "PropertySetter", + "signature": "SetMode(value *UnixFileMode) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*UnixFileMode", + "description": "Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setSource", + "qualifiedName": "ConfigReference.setSource", + "description": "Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node.", + "kind": "PropertySetter", + "signature": "SetSource(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetTarget", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setTarget", + "qualifiedName": "ConfigReference.setTarget", + "description": "Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service.", + "kind": "PropertySetter", + "signature": "SetTarget(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetUid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setUid", + "qualifiedName": "ConfigReference.setUid", + "description": "Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target.", + "kind": "PropertySetter", + "signature": "SetUid(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.source", + "qualifiedName": "ConfigReference.source", + "description": "Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.target", + "qualifiedName": "ConfigReference.target", + "description": "Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service.", + "kind": "PropertyGetter", + "signature": "Target() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Uid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.uid", + "qualifiedName": "ConfigReference.uid", + "description": "Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target.", + "kind": "PropertyGetter", + "signature": "Uid() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "OtlpGrpcEndpoint", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeAspireDashboardResource.otlpGrpcEndpoint", + "qualifiedName": "DockerComposeAspireDashboardResource.otlpGrpcEndpoint", + "description": "Gets the OTLP gRPC endpoint for telemetry data.", + "kind": "PropertyGetter", + "signature": "OtlpGrpcEndpoint() EndpointReference", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "PrimaryEndpoint", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeAspireDashboardResource.primaryEndpoint", + "qualifiedName": "DockerComposeAspireDashboardResource.primaryEndpoint", + "description": "Gets the primary endpoint of the Aspire Dashboard.", + "kind": "PropertyGetter", + "signature": "PrimaryEndpoint() EndpointReference", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "DashboardEnabled", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.dashboardEnabled", + "qualifiedName": "DockerComposeEnvironmentResource.dashboardEnabled", + "description": "Determines whether to include an Aspire dashboard for telemetry visualization in this environment.", + "kind": "PropertyGetter", + "signature": "DashboardEnabled() (bool, error)", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "DefaultNetworkName", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.defaultNetworkName", + "qualifiedName": "DockerComposeEnvironmentResource.defaultNetworkName", + "description": "The name of an existing network to be used.", + "kind": "PropertyGetter", + "signature": "DefaultNetworkName() (*string, error)", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "GetHostAddressExpression", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.getHostAddressExpression", + "qualifiedName": "DockerComposeEnvironmentResource.getHostAddressExpression", + "description": "Invokes the GetHostAddressExpression method", + "kind": "InstanceMethod", + "signature": "GetHostAddressExpression(endpointReference EndpointReference) *ReferenceExpression", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "endpointReference", + "type": "EndpointReference" + } + ], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "SetDashboardEnabled", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.setDashboardEnabled", + "qualifiedName": "DockerComposeEnvironmentResource.setDashboardEnabled", + "description": "Determines whether to include an Aspire dashboard for telemetry visualization in this environment.", + "kind": "PropertySetter", + "signature": "SetDashboardEnabled(value bool) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Determines whether to include an Aspire dashboard for telemetry visualization in this environment." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "SetDefaultNetworkName", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.setDefaultNetworkName", + "qualifiedName": "DockerComposeEnvironmentResource.setDefaultNetworkName", + "description": "The name of an existing network to be used.", + "kind": "PropertySetter", + "signature": "SetDefaultNetworkName(value *string) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "The name of an existing network to be used." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeServiceResource.parent", + "qualifiedName": "DockerComposeServiceResource.parent", + "description": "Gets the Parent property", + "kind": "PropertyGetter", + "signature": "Parent() DockerComposeEnvironmentResource", + "receiver": "DockerComposeServiceResource", + "parameters": [], + "returnType": "DockerComposeEnvironmentResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeServiceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeServiceResource" + ], + "appliesTo": [ + "DockerComposeServiceResource" + ] + }, + { + "name": "Attachable", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.attachable", + "qualifiedName": "Network.attachable", + "description": "Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services.", + "kind": "PropertyGetter", + "signature": "Attachable() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Driver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.driver", + "qualifiedName": "Network.driver", + "description": "Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc.", + "kind": "PropertyGetter", + "signature": "Driver() (*string, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "DriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.driverOpts", + "qualifiedName": "Network.driverOpts", + "description": "Represents a dictionary of driver-specific options for the network configuration in a Docker service node.", + "remarks": "These options are key-value pairs that allow customization of network settings based on the specified driver.\nThey can control behaviors or features unique to the driver being used.", + "kind": "PropertyGetter", + "signature": "DriverOpts() *Dict[string, string]", + "receiver": "Network", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.external", + "qualifiedName": "Network.external", + "description": "Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Ingress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.ingress", + "qualifiedName": "Network.ingress", + "description": "Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker.", + "kind": "PropertyGetter", + "signature": "Ingress() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Internal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.internal", + "qualifiedName": "Network.internal", + "description": "Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.", + "kind": "PropertyGetter", + "signature": "Internal() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.labels", + "qualifiedName": "Network.labels", + "description": "Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Network", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.name", + "qualifiedName": "Network.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetAttachable", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setAttachable", + "qualifiedName": "Network.setAttachable", + "description": "Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services.", + "kind": "PropertySetter", + "signature": "SetAttachable(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetDriver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setDriver", + "qualifiedName": "Network.setDriver", + "description": "Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc.", + "kind": "PropertySetter", + "signature": "SetDriver(value *string) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetDriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setDriverOpts", + "qualifiedName": "Network.setDriverOpts", + "description": "Represents a dictionary of driver-specific options for the network configuration in a Docker service node.", + "remarks": "These options are key-value pairs that allow customization of network settings based on the specified driver.\nThey can control behaviors or features unique to the driver being used.", + "kind": "PropertySetter", + "signature": "SetDriverOpts(value *Dict[string, string]) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a dictionary of driver-specific options for the network configuration in a Docker service node." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setExternal", + "qualifiedName": "Network.setExternal", + "description": "Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetIngress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setIngress", + "qualifiedName": "Network.setIngress", + "description": "Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker.", + "kind": "PropertySetter", + "signature": "SetIngress(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetInternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setInternal", + "qualifiedName": "Network.setInternal", + "description": "Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.", + "kind": "PropertySetter", + "signature": "SetInternal(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setLabels", + "qualifiedName": "Network.setLabels", + "description": "Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setName", + "qualifiedName": "Network.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.external", + "qualifiedName": "Secret.external", + "description": "Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Secret", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "File", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.file", + "qualifiedName": "Secret.file", + "description": "Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container.", + "kind": "PropertyGetter", + "signature": "File() (*string, error)", + "receiver": "Secret", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.labels", + "qualifiedName": "Secret.labels", + "description": "Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Secret", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.name", + "qualifiedName": "Secret.name", + "description": "Gets or sets the name of the secret in the Docker Compose configuration.", + "kind": "PropertyGetter", + "signature": "Name() (*string, error)", + "receiver": "Secret", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setExternal", + "qualifiedName": "Secret.setExternal", + "description": "Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setFile", + "qualifiedName": "Secret.setFile", + "description": "Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container.", + "kind": "PropertySetter", + "signature": "SetFile(value *string) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setLabels", + "qualifiedName": "Secret.setLabels", + "description": "Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setName", + "qualifiedName": "Secret.setName", + "description": "Gets or sets the name of the secret in the Docker Compose configuration.", + "kind": "PropertySetter", + "signature": "SetName(value *string) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the name of the secret in the Docker Compose configuration." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "Gid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.gid", + "qualifiedName": "SecretReference.gid", + "description": "Represents the group ID (GID) associated with the secret reference in a Docker service node.", + "remarks": "This property defines the group ID of the user for accessing the secret. It is optional and may be null if not specified.", + "kind": "PropertyGetter", + "signature": "Gid() (*float64, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Mode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.mode", + "qualifiedName": "SecretReference.mode", + "description": "Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value.", + "kind": "PropertyGetter", + "signature": "Mode() (*float64, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetGid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setGid", + "qualifiedName": "SecretReference.setGid", + "description": "Represents the group ID (GID) associated with the secret reference in a Docker service node.", + "remarks": "This property defines the group ID of the user for accessing the secret. It is optional and may be null if not specified.", + "kind": "PropertySetter", + "signature": "SetGid(value *float64) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Represents the group ID (GID) associated with the secret reference in a Docker service node." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setMode", + "qualifiedName": "SecretReference.setMode", + "description": "Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value.", + "kind": "PropertySetter", + "signature": "SetMode(value *float64) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setSource", + "qualifiedName": "SecretReference.setSource", + "description": "Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived.", + "kind": "PropertySetter", + "signature": "SetSource(value *string) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetTarget", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setTarget", + "qualifiedName": "SecretReference.setTarget", + "description": "Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system.", + "kind": "PropertySetter", + "signature": "SetTarget(value *string) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetUid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setUid", + "qualifiedName": "SecretReference.setUid", + "description": "Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container.", + "kind": "PropertySetter", + "signature": "SetUid(value *float64) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.source", + "qualifiedName": "SecretReference.source", + "description": "Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.target", + "qualifiedName": "SecretReference.target", + "description": "Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system.", + "kind": "PropertyGetter", + "signature": "Target() (*string, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Uid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.uid", + "qualifiedName": "SecretReference.uid", + "description": "Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container.", + "kind": "PropertyGetter", + "signature": "Uid() (*float64, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "CapAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.capAdd", + "qualifiedName": "Service.capAdd", + "description": "Specifies a list of Linux capabilities to add to the container.", + "remarks": "Linux capabilities allow fine-grained control of the privileges assigned to a process.\nThis property provides the ability to add specific capabilities to the set of capabilities available to the container.\nEach capability should be specified as a string in the list. Use this property to enhance the container's permissions\nbeyond the default set provided by the Docker runtime, if required by the application running inside the container.", + "kind": "PropertyGetter", + "signature": "CapAdd() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "CapDrop", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.capDrop", + "qualifiedName": "Service.capDrop", + "description": "Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege.", + "kind": "PropertyGetter", + "signature": "CapDrop() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "CgroupParent", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.cgroupParent", + "qualifiedName": "Service.cgroupParent", + "description": "Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed.", + "kind": "PropertyGetter", + "signature": "CgroupParent() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Command", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.command", + "qualifiedName": "Service.command", + "description": "Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments.", + "kind": "PropertyGetter", + "signature": "Command() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Configs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.configs", + "qualifiedName": "Service.configs", + "description": "Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations.", + "kind": "PropertyGetter", + "signature": "Configs() *List[ConfigReference]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[ConfigReference]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ContainerName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.containerName", + "qualifiedName": "Service.containerName", + "description": "Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated.", + "kind": "PropertyGetter", + "signature": "ContainerName() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "DependsOn", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.dependsOn", + "qualifiedName": "Service.dependsOn", + "description": "Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service.", + "kind": "PropertyGetter", + "signature": "DependsOn() *Dict[string, ServiceDependency]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, ServiceDependency]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Devices", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.devices", + "qualifiedName": "Service.devices", + "description": "Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker.", + "kind": "PropertyGetter", + "signature": "Devices() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Dns", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.dns", + "qualifiedName": "Service.dns", + "description": "Gets or sets a list of custom DNS server IP addresses to be used by the service container.", + "kind": "PropertyGetter", + "signature": "Dns() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "DnsSearch", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.dnsSearch", + "qualifiedName": "Service.dnsSearch", + "description": "Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups.", + "kind": "PropertyGetter", + "signature": "DnsSearch() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "DomainName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.domainName", + "qualifiedName": "Service.domainName", + "description": "Represents the domain name of a service container.", + "kind": "PropertyGetter", + "signature": "DomainName() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Entrypoint", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.entrypoint", + "qualifiedName": "Service.entrypoint", + "description": "Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts.", + "kind": "PropertyGetter", + "signature": "Entrypoint() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "EnvFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.envFile", + "qualifiedName": "Service.envFile", + "description": "Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime.", + "kind": "PropertyGetter", + "signature": "EnvFile() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.environment", + "qualifiedName": "Service.environment", + "description": "Represents a collection of environment variables for the service container.", + "remarks": "The property allows for specifying environment variables as key-value pairs.\nThese variables can be used to configure the behavior of the container\nor pass information to the application running inside the container.", + "kind": "PropertyGetter", + "signature": "Environment() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Expose", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.expose", + "qualifiedName": "Service.expose", + "description": "Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network.", + "kind": "PropertyGetter", + "signature": "Expose() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ExternalLinks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.externalLinks", + "qualifiedName": "Service.externalLinks", + "description": "Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments.", + "kind": "PropertyGetter", + "signature": "ExternalLinks() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ExtraHosts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.extraHosts", + "qualifiedName": "Service.extraHosts", + "description": "Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers.", + "kind": "PropertyGetter", + "signature": "ExtraHosts() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "GroupAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.groupAdd", + "qualifiedName": "Service.groupAdd", + "description": "Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups.", + "kind": "PropertyGetter", + "signature": "GroupAdd() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Hostname", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.hostname", + "qualifiedName": "Service.hostname", + "description": "Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network.", + "kind": "PropertyGetter", + "signature": "Hostname() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Image", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.image", + "qualifiedName": "Service.image", + "description": "Specifies the Docker image to be used for the service.", + "remarks": "The image refers to the identifier of a container image hosted in a registry.\nThis property is required if no build instructions are provided for the service.\nIt may include an optional tag or digest to specify a particular version of the image.\nIf omitted, Docker will default to the `latest` tag.", + "kind": "PropertyGetter", + "signature": "Image() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Init", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.init", + "qualifiedName": "Service.init", + "description": "Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container.", + "kind": "PropertyGetter", + "signature": "Init() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Ipc", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.ipc", + "qualifiedName": "Service.ipc", + "description": "Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with.", + "kind": "PropertyGetter", + "signature": "Ipc() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Isolation", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.isolation", + "qualifiedName": "Service.isolation", + "description": "Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used.", + "kind": "PropertyGetter", + "signature": "Isolation() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.labels", + "qualifiedName": "Service.labels", + "description": "Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Links", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.links", + "qualifiedName": "Service.links", + "description": "Represents a service definition in a Docker Compose configuration file.", + "kind": "PropertyGetter", + "signature": "Links() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "MacAddress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.macAddress", + "qualifiedName": "Service.macAddress", + "description": "Specifies a custom MAC (Media Access Control) address for the container's network interface.", + "remarks": "A MAC address is a unique identifier assigned to a network interface controller (NIC).\nSetting this property allows for specifying a predefined MAC address instead of letting the system assign one dynamically.\nThis can be useful for use cases where a consistent MAC address is required, such as DHCP reservations or specific network configurations.", + "kind": "PropertyGetter", + "signature": "MacAddress() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.name", + "qualifiedName": "Service.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "NetworkMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.networkMode", + "qualifiedName": "Service.networkMode", + "description": "Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name.", + "kind": "PropertyGetter", + "signature": "NetworkMode() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Networks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.networks", + "qualifiedName": "Service.networks", + "description": "Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value.", + "kind": "PropertyGetter", + "signature": "Networks() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Pid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.pid", + "qualifiedName": "Service.pid", + "description": "Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them.", + "kind": "PropertyGetter", + "signature": "Pid() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Ports", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.ports", + "qualifiedName": "Service.ports", + "description": "Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port.", + "kind": "PropertyGetter", + "signature": "Ports() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Privileged", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.privileged", + "qualifiedName": "Service.privileged", + "description": "Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access.", + "kind": "PropertyGetter", + "signature": "Privileged() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Profiles", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.profiles", + "qualifiedName": "Service.profiles", + "description": "Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations.", + "kind": "PropertyGetter", + "signature": "Profiles() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "PullPolicy", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.pullPolicy", + "qualifiedName": "Service.pullPolicy", + "description": "Specifies the policy for pulling the Docker image.", + "remarks": "This property determines when the container runtime should pull the image.\nCommon values include \"always\", \"never\", \"missing\", \"if_not_present\", or \"build\".\nIf not specified, the default behavior depends on the container runtime configuration.", + "kind": "PropertyGetter", + "signature": "PullPolicy() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.readOnly", + "qualifiedName": "Service.readOnly", + "description": "Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs.", + "kind": "PropertyGetter", + "signature": "ReadOnly() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Restart", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.restart", + "qualifiedName": "Service.restart", + "description": "Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\".", + "kind": "PropertyGetter", + "signature": "Restart() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Secrets", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.secrets", + "qualifiedName": "Service.secrets", + "description": "Represents a collection of secret references used by the service.", + "remarks": "Each entry in the collection refers to a specific secret that is utilized by the service,\ntypically for managing sensitive information in a secure manner (e.g., credentials, tokens).", + "kind": "PropertyGetter", + "signature": "Secrets() *List[SecretReference]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[SecretReference]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SecurityOpt", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.securityOpt", + "qualifiedName": "Service.securityOpt", + "description": "Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior.", + "kind": "PropertyGetter", + "signature": "SecurityOpt() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCapAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCapAdd", + "qualifiedName": "Service.setCapAdd", + "description": "Specifies a list of Linux capabilities to add to the container.", + "remarks": "Linux capabilities allow fine-grained control of the privileges assigned to a process.\nThis property provides the ability to add specific capabilities to the set of capabilities available to the container.\nEach capability should be specified as a string in the list. Use this property to enhance the container's permissions\nbeyond the default set provided by the Docker runtime, if required by the application running inside the container.", + "kind": "PropertySetter", + "signature": "SetCapAdd(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies a list of Linux capabilities to add to the container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCapDrop", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCapDrop", + "qualifiedName": "Service.setCapDrop", + "description": "Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege.", + "kind": "PropertySetter", + "signature": "SetCapDrop(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCgroupParent", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCgroupParent", + "qualifiedName": "Service.setCgroupParent", + "description": "Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed.", + "kind": "PropertySetter", + "signature": "SetCgroupParent(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCommand", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCommand", + "qualifiedName": "Service.setCommand", + "description": "Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments.", + "kind": "PropertySetter", + "signature": "SetCommand(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetConfigs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setConfigs", + "qualifiedName": "Service.setConfigs", + "description": "Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations.", + "kind": "PropertySetter", + "signature": "SetConfigs(value *List[ConfigReference]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[ConfigReference]", + "description": "Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetContainerName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setContainerName", + "qualifiedName": "Service.setContainerName", + "description": "Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated.", + "kind": "PropertySetter", + "signature": "SetContainerName(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDependsOn", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDependsOn", + "qualifiedName": "Service.setDependsOn", + "description": "Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service.", + "kind": "PropertySetter", + "signature": "SetDependsOn(value *Dict[string, ServiceDependency]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, ServiceDependency]", + "description": "Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDevices", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDevices", + "qualifiedName": "Service.setDevices", + "description": "Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker.", + "kind": "PropertySetter", + "signature": "SetDevices(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDns", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDns", + "qualifiedName": "Service.setDns", + "description": "Gets or sets a list of custom DNS server IP addresses to be used by the service container.", + "kind": "PropertySetter", + "signature": "SetDns(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets a list of custom DNS server IP addresses to be used by the service container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDnsSearch", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDnsSearch", + "qualifiedName": "Service.setDnsSearch", + "description": "Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups.", + "kind": "PropertySetter", + "signature": "SetDnsSearch(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDomainName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDomainName", + "qualifiedName": "Service.setDomainName", + "description": "Represents the domain name of a service container.", + "kind": "PropertySetter", + "signature": "SetDomainName(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the domain name of a service container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetEntrypoint", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setEntrypoint", + "qualifiedName": "Service.setEntrypoint", + "description": "Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts.", + "kind": "PropertySetter", + "signature": "SetEntrypoint(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetEnvFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setEnvFile", + "qualifiedName": "Service.setEnvFile", + "description": "Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime.", + "kind": "PropertySetter", + "signature": "SetEnvFile(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetEnvironment", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setEnvironment", + "qualifiedName": "Service.setEnvironment", + "description": "Represents a collection of environment variables for the service container.", + "remarks": "The property allows for specifying environment variables as key-value pairs.\nThese variables can be used to configure the behavior of the container\nor pass information to the application running inside the container.", + "kind": "PropertySetter", + "signature": "SetEnvironment(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of environment variables for the service container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetExpose", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setExpose", + "qualifiedName": "Service.setExpose", + "description": "Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network.", + "kind": "PropertySetter", + "signature": "SetExpose(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetExternalLinks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setExternalLinks", + "qualifiedName": "Service.setExternalLinks", + "description": "Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments.", + "kind": "PropertySetter", + "signature": "SetExternalLinks(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetExtraHosts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setExtraHosts", + "qualifiedName": "Service.setExtraHosts", + "description": "Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers.", + "kind": "PropertySetter", + "signature": "SetExtraHosts(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetGroupAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setGroupAdd", + "qualifiedName": "Service.setGroupAdd", + "description": "Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups.", + "kind": "PropertySetter", + "signature": "SetGroupAdd(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetHostname", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setHostname", + "qualifiedName": "Service.setHostname", + "description": "Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network.", + "kind": "PropertySetter", + "signature": "SetHostname(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetImage", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setImage", + "qualifiedName": "Service.setImage", + "description": "Specifies the Docker image to be used for the service.", + "remarks": "The image refers to the identifier of a container image hosted in a registry.\nThis property is required if no build instructions are provided for the service.\nIt may include an optional tag or digest to specify a particular version of the image.\nIf omitted, Docker will default to the `latest` tag.", + "kind": "PropertySetter", + "signature": "SetImage(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the Docker image to be used for the service." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetInit", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setInit", + "qualifiedName": "Service.setInit", + "description": "Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container.", + "kind": "PropertySetter", + "signature": "SetInit(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetIpc", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setIpc", + "qualifiedName": "Service.setIpc", + "description": "Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with.", + "kind": "PropertySetter", + "signature": "SetIpc(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetIsolation", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setIsolation", + "qualifiedName": "Service.setIsolation", + "description": "Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used.", + "kind": "PropertySetter", + "signature": "SetIsolation(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setLabels", + "qualifiedName": "Service.setLabels", + "description": "Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetLinks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setLinks", + "qualifiedName": "Service.setLinks", + "description": "Represents a service definition in a Docker Compose configuration file.", + "kind": "PropertySetter", + "signature": "SetLinks(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a service definition in a Docker Compose configuration file." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetMacAddress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setMacAddress", + "qualifiedName": "Service.setMacAddress", + "description": "Specifies a custom MAC (Media Access Control) address for the container's network interface.", + "remarks": "A MAC address is a unique identifier assigned to a network interface controller (NIC).\nSetting this property allows for specifying a predefined MAC address instead of letting the system assign one dynamically.\nThis can be useful for use cases where a consistent MAC address is required, such as DHCP reservations or specific network configurations.", + "kind": "PropertySetter", + "signature": "SetMacAddress(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies a custom MAC (Media Access Control) address for the container's network interface." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setName", + "qualifiedName": "Service.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetNetworkMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setNetworkMode", + "qualifiedName": "Service.setNetworkMode", + "description": "Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name.", + "kind": "PropertySetter", + "signature": "SetNetworkMode(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetNetworks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setNetworks", + "qualifiedName": "Service.setNetworks", + "description": "Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value.", + "kind": "PropertySetter", + "signature": "SetNetworks(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPid", + "qualifiedName": "Service.setPid", + "description": "Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them.", + "kind": "PropertySetter", + "signature": "SetPid(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPorts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPorts", + "qualifiedName": "Service.setPorts", + "description": "Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port.", + "kind": "PropertySetter", + "signature": "SetPorts(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPrivileged", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPrivileged", + "qualifiedName": "Service.setPrivileged", + "description": "Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access.", + "kind": "PropertySetter", + "signature": "SetPrivileged(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetProfiles", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setProfiles", + "qualifiedName": "Service.setProfiles", + "description": "Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations.", + "kind": "PropertySetter", + "signature": "SetProfiles(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPullPolicy", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPullPolicy", + "qualifiedName": "Service.setPullPolicy", + "description": "Specifies the policy for pulling the Docker image.", + "remarks": "This property determines when the container runtime should pull the image.\nCommon values include \"always\", \"never\", \"missing\", \"if_not_present\", or \"build\".\nIf not specified, the default behavior depends on the container runtime configuration.", + "kind": "PropertySetter", + "signature": "SetPullPolicy(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the policy for pulling the Docker image." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setReadOnly", + "qualifiedName": "Service.setReadOnly", + "description": "Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs.", + "kind": "PropertySetter", + "signature": "SetReadOnly(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetRestart", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setRestart", + "qualifiedName": "Service.setRestart", + "description": "Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\".", + "kind": "PropertySetter", + "signature": "SetRestart(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\"." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetSecrets", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setSecrets", + "qualifiedName": "Service.setSecrets", + "description": "Represents a collection of secret references used by the service.", + "remarks": "Each entry in the collection refers to a specific secret that is utilized by the service,\ntypically for managing sensitive information in a secure manner (e.g., credentials, tokens).", + "kind": "PropertySetter", + "signature": "SetSecrets(value *List[SecretReference]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[SecretReference]", + "description": "Represents a collection of secret references used by the service." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetSecurityOpt", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setSecurityOpt", + "qualifiedName": "Service.setSecurityOpt", + "description": "Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior.", + "kind": "PropertySetter", + "signature": "SetSecurityOpt(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetShmSize", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setShmSize", + "qualifiedName": "Service.setShmSize", + "description": "Gets or sets the size of the `/dev/shm` partition for the container.", + "remarks": "The value is emitted as the Docker Compose `shm_size` service property, for example `128mb`.", + "kind": "PropertySetter", + "signature": "SetShmSize(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the size of the `/dev/shm` partition for the container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetStdinOpen", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setStdinOpen", + "qualifiedName": "Service.setStdinOpen", + "description": "Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected.", + "kind": "PropertySetter", + "signature": "SetStdinOpen(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetStopGracePeriod", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setStopGracePeriod", + "qualifiedName": "Service.setStopGracePeriod", + "description": "Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute.", + "kind": "PropertySetter", + "signature": "SetStopGracePeriod(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetStopSignal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setStopSignal", + "qualifiedName": "Service.setStopSignal", + "description": "Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM.", + "kind": "PropertySetter", + "signature": "SetStopSignal(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetSysctls", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setSysctls", + "qualifiedName": "Service.setSysctls", + "description": "Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`.", + "kind": "PropertySetter", + "signature": "SetSysctls(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetTmpfs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setTmpfs", + "qualifiedName": "Service.setTmpfs", + "description": "Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes.", + "kind": "PropertySetter", + "signature": "SetTmpfs(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetTty", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setTty", + "qualifiedName": "Service.setTty", + "description": "Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session.", + "kind": "PropertySetter", + "signature": "SetTty(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetUlimits", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setUlimits", + "qualifiedName": "Service.setUlimits", + "description": "Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size.", + "kind": "PropertySetter", + "signature": "SetUlimits(value *Dict[string, Ulimit]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Ulimit]", + "description": "Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetUser", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setUser", + "qualifiedName": "Service.setUser", + "description": "Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\").", + "kind": "PropertySetter", + "signature": "SetUser(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\")." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetVolumes", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setVolumes", + "qualifiedName": "Service.setVolumes", + "description": "Defines the list of volumes to be mounted into the service's container.", + "remarks": "Volumes provide a mechanism for persisting data used by the service or for sharing data between the host and the container.\nEach volume entry maps a source path on the host or an anonymous volume to a target path within the container.\nThis property can also include named volumes as defined in the Compose file's top-level `volumes` section.\nVolumes can specify additional options such as read-only access or volume drivers.", + "kind": "PropertySetter", + "signature": "SetVolumes(value *List[Volume]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[Volume]", + "description": "Defines the list of volumes to be mounted into the service's container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetWorkingDir", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setWorkingDir", + "qualifiedName": "Service.setWorkingDir", + "description": "Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file.", + "kind": "PropertySetter", + "signature": "SetWorkingDir(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ShmSize", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.shmSize", + "qualifiedName": "Service.shmSize", + "description": "Gets or sets the size of the `/dev/shm` partition for the container.", + "remarks": "The value is emitted as the Docker Compose `shm_size` service property, for example `128mb`.", + "kind": "PropertyGetter", + "signature": "ShmSize() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "StdinOpen", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.stdinOpen", + "qualifiedName": "Service.stdinOpen", + "description": "Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected.", + "kind": "PropertyGetter", + "signature": "StdinOpen() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "StopGracePeriod", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.stopGracePeriod", + "qualifiedName": "Service.stopGracePeriod", + "description": "Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute.", + "kind": "PropertyGetter", + "signature": "StopGracePeriod() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "StopSignal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.stopSignal", + "qualifiedName": "Service.stopSignal", + "description": "Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM.", + "kind": "PropertyGetter", + "signature": "StopSignal() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Sysctls", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.sysctls", + "qualifiedName": "Service.sysctls", + "description": "Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`.", + "kind": "PropertyGetter", + "signature": "Sysctls() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Tmpfs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.tmpfs", + "qualifiedName": "Service.tmpfs", + "description": "Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes.", + "kind": "PropertyGetter", + "signature": "Tmpfs() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Tty", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.tty", + "qualifiedName": "Service.tty", + "description": "Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session.", + "kind": "PropertyGetter", + "signature": "Tty() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Ulimits", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.ulimits", + "qualifiedName": "Service.ulimits", + "description": "Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size.", + "kind": "PropertyGetter", + "signature": "Ulimits() *Dict[string, Ulimit]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, Ulimit]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "User", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.user", + "qualifiedName": "Service.user", + "description": "Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\").", + "kind": "PropertyGetter", + "signature": "User() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Volumes", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.volumes", + "qualifiedName": "Service.volumes", + "description": "Defines the list of volumes to be mounted into the service's container.", + "remarks": "Volumes provide a mechanism for persisting data used by the service or for sharing data between the host and the container.\nEach volume entry maps a source path on the host or an anonymous volume to a target path within the container.\nThis property can also include named volumes as defined in the Compose file's top-level `volumes` section.\nVolumes can specify additional options such as read-only access or volume drivers.", + "kind": "PropertyGetter", + "signature": "Volumes() *List[Volume]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[Volume]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "WorkingDir", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.workingDir", + "qualifiedName": "Service.workingDir", + "description": "Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file.", + "kind": "PropertyGetter", + "signature": "WorkingDir() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Condition", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/ServiceDependency.condition", + "qualifiedName": "ServiceDependency.condition", + "description": "Gets or sets the condition under which the service should be started.", + "kind": "PropertyGetter", + "signature": "Condition() (*string, error)", + "receiver": "ServiceDependency", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency" + ], + "appliesTo": [ + "ServiceDependency" + ] + }, + { + "name": "SetCondition", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/ServiceDependency.setCondition", + "qualifiedName": "ServiceDependency.setCondition", + "description": "Gets or sets the condition under which the service should be started.", + "kind": "PropertySetter", + "signature": "SetCondition(value *string) ServiceDependency", + "receiver": "ServiceDependency", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the condition under which the service should be started." + } + ], + "returnType": "ServiceDependency", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency" + ], + "appliesTo": [ + "ServiceDependency" + ] + }, + { + "name": "Hard", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.hard", + "qualifiedName": "Ulimit.hard", + "description": "Gets or sets the hard limit for the resource control.", + "remarks": "The hard limit defines the maximum value that cannot be exceeded.\nIt is usually set by an administrator and imposes a strict upper boundary.\nThis property can be null, indicating no hard limit is set.", + "kind": "PropertyGetter", + "signature": "Hard() (*float64, error)", + "receiver": "Ulimit", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "SetHard", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.setHard", + "qualifiedName": "Ulimit.setHard", + "description": "Gets or sets the hard limit for the resource control.", + "remarks": "The hard limit defines the maximum value that cannot be exceeded.\nIt is usually set by an administrator and imposes a strict upper boundary.\nThis property can be null, indicating no hard limit is set.", + "kind": "PropertySetter", + "signature": "SetHard(value *float64) Ulimit", + "receiver": "Ulimit", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the hard limit for the resource control." + } + ], + "returnType": "Ulimit", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "SetSoft", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.setSoft", + "qualifiedName": "Ulimit.setSoft", + "description": "Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set.", + "kind": "PropertySetter", + "signature": "SetSoft(value *float64) Ulimit", + "receiver": "Ulimit", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set." + } + ], + "returnType": "Ulimit", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "Soft", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.soft", + "qualifiedName": "Ulimit.soft", + "description": "Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set.", + "kind": "PropertyGetter", + "signature": "Soft() (*float64, error)", + "receiver": "Ulimit", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "Driver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.driver", + "qualifiedName": "Volume.driver", + "description": "Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend.", + "kind": "PropertyGetter", + "signature": "Driver() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "DriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.driverOpts", + "qualifiedName": "Volume.driverOpts", + "description": "Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used.", + "kind": "PropertyGetter", + "signature": "DriverOpts() *Dict[string, string]", + "receiver": "Volume", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.external", + "qualifiedName": "Volume.external", + "description": "Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.labels", + "qualifiedName": "Volume.labels", + "description": "Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Volume", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.name", + "qualifiedName": "Volume.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "ReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.readOnly", + "qualifiedName": "Volume.readOnly", + "description": "Gets or sets a value indicating whether the volume is mounted as read-only.", + "remarks": "When set to true, the volume will be mounted with read-only permissions, preventing modification\nof the data within the container. This is commonly used to enforce data immutability for certain use cases.", + "kind": "PropertyGetter", + "signature": "ReadOnly() (*bool, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetDriver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setDriver", + "qualifiedName": "Volume.setDriver", + "description": "Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend.", + "kind": "PropertySetter", + "signature": "SetDriver(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetDriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setDriverOpts", + "qualifiedName": "Volume.setDriverOpts", + "description": "Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used.", + "kind": "PropertySetter", + "signature": "SetDriverOpts(value *Dict[string, string]) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setExternal", + "qualifiedName": "Volume.setExternal", + "description": "Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setLabels", + "qualifiedName": "Volume.setLabels", + "description": "Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setName", + "qualifiedName": "Volume.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setReadOnly", + "qualifiedName": "Volume.setReadOnly", + "description": "Gets or sets a value indicating whether the volume is mounted as read-only.", + "remarks": "When set to true, the volume will be mounted with read-only permissions, preventing modification\nof the data within the container. This is commonly used to enforce data immutability for certain use cases.", + "kind": "PropertySetter", + "signature": "SetReadOnly(value *bool) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Gets or sets a value indicating whether the volume is mounted as read-only." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setSource", + "qualifiedName": "Volume.setSource", + "description": "Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced.", + "kind": "PropertySetter", + "signature": "SetSource(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetTarget", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setTarget", + "qualifiedName": "Volume.setTarget", + "description": "Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data.", + "kind": "PropertySetter", + "signature": "SetTarget(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetType", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setType", + "qualifiedName": "Volume.setType", + "description": "Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker.", + "kind": "PropertySetter", + "signature": "SetType(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.source", + "qualifiedName": "Volume.source", + "description": "Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.target", + "qualifiedName": "Volume.target", + "description": "Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data.", + "kind": "PropertyGetter", + "signature": "Target() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Type", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.type", + "qualifiedName": "Volume.type", + "description": "Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker.", + "kind": "PropertyGetter", + "signature": "Type() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "AddConfig", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileConfig", + "qualifiedName": "addConfig", + "description": "Adds a top-level config definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddConfig(name string, options ...*AddConfigOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the config." + } + ], + "options": { + "typeName": "AddConfigOptions", + "fields": [ + { + "name": "File", + "jsonName": "file", + "type": "*string", + "description": "The path to the config file." + }, + { + "name": "Content", + "jsonName": "content", + "type": "*string", + "description": "The inline config content." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the config is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Config)", + "isCallback": true, + "callbackSignature": "func(obj Config)", + "description": "An optional callback for further config customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddDockerComposeEnvironment", + "capabilityId": "Aspire.Hosting.Docker/addDockerComposeEnvironment", + "qualifiedName": "addDockerComposeEnvironment", + "description": "Adds a Docker Compose environment to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddDockerComposeEnvironment(name string) DockerComposeEnvironmentResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Docker Compose environment resource." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddNetwork", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileNetwork", + "qualifiedName": "addNetwork", + "description": "Adds a top-level network definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddNetwork(name string, options ...*AddNetworkOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the network." + } + ], + "options": { + "typeName": "AddNetworkOptions", + "fields": [ + { + "name": "Driver", + "jsonName": "driver", + "type": "*string", + "description": "The network driver to use." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the network is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Network)", + "isCallback": true, + "callbackSignature": "func(obj Network)", + "description": "An optional callback for further network customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddSecret", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileSecret", + "qualifiedName": "addSecret", + "description": "Adds a top-level secret definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddSecret(name string, options ...*AddSecretOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret." + } + ], + "options": { + "typeName": "AddSecretOptions", + "fields": [ + { + "name": "File", + "jsonName": "file", + "type": "*string", + "description": "The path to the secret file." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the secret is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Secret)", + "isCallback": true, + "callbackSignature": "func(obj Secret)", + "description": "An optional callback for further secret customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddService", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileService", + "qualifiedName": "addService", + "description": "Adds a service definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddService(name string, options ...*AddServiceOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the service." + } + ], + "options": { + "typeName": "AddServiceOptions", + "fields": [ + { + "name": "Image", + "jsonName": "image", + "type": "*string", + "description": "The container image to use for the service." + }, + { + "name": "Configure", + "type": "func(obj Service)", + "isCallback": true, + "callbackSignature": "func(obj Service)", + "description": "An optional callback for further service customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddVolume", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileVolume", + "qualifiedName": "addVolume", + "description": "Adds a top-level volume definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddVolume(name string, options ...*AddVolumeOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the volume." + } + ], + "options": { + "typeName": "AddVolumeOptions", + "fields": [ + { + "name": "Driver", + "jsonName": "driver", + "type": "*string", + "description": "The volume driver to use." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the volume is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Volume)", + "isCallback": true, + "callbackSignature": "func(obj Volume)", + "description": "An optional callback for further volume customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddVolume", + "capabilityId": "Aspire.Hosting.Docker/addComposeServiceVolume", + "qualifiedName": "addVolume", + "description": "Adds a volume mount to a generated Docker Compose service.", + "returns": "The updated Docker Compose service.", + "kind": "Method", + "signature": "AddVolume(source string, target string, options ...*ServiceAddVolumeOptions) Service", + "receiver": "Service", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source volume name or host path." + }, + { + "name": "target", + "type": "string", + "description": "The target path inside the container." + } + ], + "options": { + "typeName": "ServiceAddVolumeOptions", + "fields": [ + { + "name": "Type", + "jsonName": "type", + "type": "*string", + "description": "The Docker Compose volume type, such as `volume` or `bind`." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A value indicating whether the volume is mounted as read-only." + }, + { + "name": "Configure", + "type": "func(obj Volume)", + "isCallback": true, + "callbackSignature": "func(obj Volume)", + "description": "An optional callback for further volume customization." + } + ] + }, + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "AsEnvironmentPlaceholder", + "capabilityId": "Aspire.Hosting.Docker/asEnvironmentPlaceholder", + "qualifiedName": "asEnvironmentPlaceholder", + "description": "Creates a Docker Compose environment variable placeholder from a parameter builder", + "returns": "A string representing the environment variable placeholder in Docker Compose syntax (e.g., `${ENV_VAR}`).", + "kind": "Method", + "signature": "AsEnvironmentPlaceholder(dockerComposeService DockerComposeServiceResource) (string, error)", + "receiver": "ParameterResource", + "parameters": [ + { + "name": "dockerComposeService", + "type": "DockerComposeServiceResource", + "description": "The Docker Compose service resource to associate the environment variable with." + } + ], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ParameterResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ParameterResource" + ], + "appliesTo": [ + "ParameterResource" + ] + }, + { + "name": "ConfigureComposeFile", + "capabilityId": "Aspire.Hosting.Docker/configureComposeFile", + "qualifiedName": "configureComposeFile", + "description": "Configures the Docker Compose file for the environment resource.", + "remarks": "This callback runs after the Docker Compose model has been generated and before it is written to disk.\nUse it to customize the generated `ComposeFile` for the environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureComposeFile(configure func(obj ComposeFile)) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj ComposeFile)", + "isCallback": true, + "callbackSignature": "func(obj ComposeFile)", + "description": "A method that can be used for customizing the `ComposeFile`." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "ConfigureDashboard", + "capabilityId": "Aspire.Hosting.Docker/configureDashboard", + "qualifiedName": "configureDashboard", + "description": "Configures the dashboard properties for this Docker Compose environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureDashboard(configure func(obj DockerComposeAspireDashboardResource)) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj DockerComposeAspireDashboardResource)", + "isCallback": true, + "callbackSignature": "func(obj DockerComposeAspireDashboardResource)", + "description": "A method that can be used for customizing the dashboard service." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "ConfigureEnvFile", + "capabilityId": "Aspire.Hosting.Docker/configureEnvFile", + "qualifiedName": "configureEnvFile", + "description": "Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.", + "remarks": "This callback is invoked during the prepare phase, allowing programmatic modification of the environment variables\nthat will be written to the environment-specific `.env` file adjacent to the Docker Compose file.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureEnvFile(configure func(obj *Dict[string, CapturedEnvironmentVariable])) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj *Dict[string, CapturedEnvironmentVariable])", + "isCallback": true, + "callbackSignature": "func(obj *Dict[string, CapturedEnvironmentVariable])", + "description": "A method that can be used for customizing the captured environment variables." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "PublishAsDockerComposeService", + "capabilityId": "Aspire.Hosting.Docker/publishAsDockerComposeService", + "qualifiedName": "publishAsDockerComposeService", + "description": "Publishes the specified resource as a Docker Compose service.", + "remarks": "This method checks if the application is in publish mode. If it is, it adds a customization annotation\nthat will be applied by the DockerComposeInfrastructure when generating the Docker Compose service.\n```\nbuilder.AddContainer(\"redis\", \"redis:alpine\").PublishAsDockerComposeService((resource, service) =>\n{\nservice.Name = \"redis\";\n});\n```", + "returns": "The updated resource builder.", + "kind": "Method", + "signature": "PublishAsDockerComposeService(configure func(arg1 DockerComposeServiceResource, arg2 Service)) IComputeResource", + "receiver": "IComputeResource", + "parameters": [ + { + "name": "configure", + "type": "func(arg1 DockerComposeServiceResource, arg2 Service)", + "isCallback": true, + "callbackSignature": "func(arg1 DockerComposeServiceResource, arg2 Service)", + "description": "The configuration action for the Docker Compose service." + } + ], + "returnType": "IComputeResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IComputeResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ContainerResource", + "DockerComposeAspireDashboardResource", + "DotnetToolResource", + "ExecutableResource", + "ProjectResource" + ] + }, + { + "name": "WithDashboard", + "capabilityId": "Aspire.Hosting.Docker/withDashboard", + "qualifiedName": "withDashboard", + "description": "Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDashboard(options ...*WithDashboardOptions) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithDashboardOptions", + "fields": [ + { + "name": "Enabled", + "jsonName": "enabled", + "type": "*bool", + "description": "Whether to enable the dashboard. Default is true." + } + ] + }, + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "WithForwardedHeaders", + "capabilityId": "Aspire.Hosting.Docker/withForwardedHeaders", + "qualifiedName": "withForwardedHeaders", + "description": "Configures whether forwarded headers processing is enabled for the Aspire dashboard container.", + "remarks": "This sets the `ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED` environment variable inside the dashboard\ncontainer. When enabled, the dashboard will process `X-Forwarded-Host` and `X-Forwarded-Proto`\nheaders which is required when the dashboard is accessed through a reverse proxy or load balancer.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithForwardedHeaders(options ...*WithForwardedHeadersOptions) DockerComposeAspireDashboardResource", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "options": { + "typeName": "WithForwardedHeadersOptions", + "fields": [ + { + "name": "Enabled", + "jsonName": "enabled", + "type": "*bool", + "description": "True to enable forwarded headers (`ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED=true`), false to disable it (sets the value to `false`)." + } + ] + }, + "returnType": "DockerComposeAspireDashboardResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Docker/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the port used to access the Aspire Dashboard from a browser.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(options ...*WithHostPortOptions) DockerComposeAspireDashboardResource", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "options": { + "typeName": "WithHostPortOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "The port to bind on the host. If non-null, the dashboard will be exposed on the host. If `null`, the dashboard will not be exposed on the host but will only be reachable within the container network." + } + ] + }, + "returnType": "DockerComposeAspireDashboardResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Docker/withProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of a Docker Compose environment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj DockerComposeEnvironmentResource)) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj DockerComposeEnvironmentResource)", + "isCallback": true, + "callbackSignature": "func(obj DockerComposeEnvironmentResource)", + "description": "A method that can be used for customizing the `DockerComposeEnvironmentResource`." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + } + ], + "handleTypes": [ + { + "name": "CapturedEnvironmentVariable", + "fullName": "Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "kind": "handle", + "description": "Represents a captured environment variable that will be written to the .env file adjacent to the Docker Compose file.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "DefaultValue", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.defaultValue", + "qualifiedName": "CapturedEnvironmentVariable.defaultValue", + "description": "Gets or sets the default value for the environment variable.", + "kind": "PropertyGetter", + "signature": "DefaultValue() (*string, error)", + "receiver": "CapturedEnvironmentVariable", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.description", + "qualifiedName": "CapturedEnvironmentVariable.description", + "description": "Gets or sets the description for the environment variable.", + "kind": "PropertyGetter", + "signature": "Description() (*string, error)", + "receiver": "CapturedEnvironmentVariable", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "SetDefaultValue", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.setDefaultValue", + "qualifiedName": "CapturedEnvironmentVariable.setDefaultValue", + "description": "Gets or sets the default value for the environment variable.", + "kind": "PropertySetter", + "signature": "SetDefaultValue(value *string) CapturedEnvironmentVariable", + "receiver": "CapturedEnvironmentVariable", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the default value for the environment variable." + } + ], + "returnType": "CapturedEnvironmentVariable", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "SetDescription", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.setDescription", + "qualifiedName": "CapturedEnvironmentVariable.setDescription", + "description": "Gets or sets the description for the environment variable.", + "kind": "PropertySetter", + "signature": "SetDescription(value *string) CapturedEnvironmentVariable", + "receiver": "CapturedEnvironmentVariable", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the description for the environment variable." + } + ], + "returnType": "CapturedEnvironmentVariable", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.setSource", + "qualifiedName": "CapturedEnvironmentVariable.setSource", + "description": "Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`.", + "kind": "PropertySetter", + "signature": "SetSource(value any) CapturedEnvironmentVariable", + "receiver": "CapturedEnvironmentVariable", + "parameters": [ + { + "name": "value", + "type": "any", + "allowedTypes": [ + "ParameterResource", + "ContainerMountAnnotation", + "ContainerImageReference", + "ContainerPortReference" + ], + "description": "Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`." + } + ], + "returnType": "CapturedEnvironmentVariable", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker/CapturedEnvironmentVariable.source", + "qualifiedName": "CapturedEnvironmentVariable.source", + "description": "Gets or sets the source object that originated this environment variable. This could be a `ParameterResource`, `ContainerMountAnnotation`, `ContainerImageReference`, or `ContainerPortReference`.", + "kind": "PropertyGetter", + "signature": "Source() (any, error)", + "receiver": "CapturedEnvironmentVariable", + "parameters": [], + "returnType": "(any, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.CapturedEnvironmentVariable", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.CapturedEnvironmentVariable" + ], + "appliesTo": [ + "CapturedEnvironmentVariable" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerComposeAspireDashboardResource", + "fullName": "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "kind": "handle", + "description": "Represents a resource for the Aspire Dashboard. This resource is used to visualize telemetry data in the Aspire Hosting environment.", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "OtlpGrpcEndpoint", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeAspireDashboardResource.otlpGrpcEndpoint", + "qualifiedName": "DockerComposeAspireDashboardResource.otlpGrpcEndpoint", + "description": "Gets the OTLP gRPC endpoint for telemetry data.", + "kind": "PropertyGetter", + "signature": "OtlpGrpcEndpoint() EndpointReference", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "PrimaryEndpoint", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeAspireDashboardResource.primaryEndpoint", + "qualifiedName": "DockerComposeAspireDashboardResource.primaryEndpoint", + "description": "Gets the primary endpoint of the Aspire Dashboard.", + "kind": "PropertyGetter", + "signature": "PrimaryEndpoint() EndpointReference", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "WithForwardedHeaders", + "capabilityId": "Aspire.Hosting.Docker/withForwardedHeaders", + "qualifiedName": "withForwardedHeaders", + "description": "Configures whether forwarded headers processing is enabled for the Aspire dashboard container.", + "remarks": "This sets the `ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED` environment variable inside the dashboard\ncontainer. When enabled, the dashboard will process `X-Forwarded-Host` and `X-Forwarded-Proto`\nheaders which is required when the dashboard is accessed through a reverse proxy or load balancer.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithForwardedHeaders(options ...*WithForwardedHeadersOptions) DockerComposeAspireDashboardResource", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "options": { + "typeName": "WithForwardedHeadersOptions", + "fields": [ + { + "name": "Enabled", + "jsonName": "enabled", + "type": "*bool", + "description": "True to enable forwarded headers (`ASPIRE_DASHBOARD_FORWARDEDHEADERS_ENABLED=true`), false to disable it (sets the value to `false`)." + } + ] + }, + "returnType": "DockerComposeAspireDashboardResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + }, + { + "name": "WithHostPort", + "capabilityId": "Aspire.Hosting.Docker/withHostPort", + "qualifiedName": "withHostPort", + "description": "Configures the port used to access the Aspire Dashboard from a browser.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithHostPort(options ...*WithHostPortOptions) DockerComposeAspireDashboardResource", + "receiver": "DockerComposeAspireDashboardResource", + "parameters": [], + "options": { + "typeName": "WithHostPortOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64", + "description": "The port to bind on the host. If non-null, the dashboard will be exposed on the host. If `null`, the dashboard will not be exposed on the host but will only be reachable within the container network." + } + ] + }, + "returnType": "DockerComposeAspireDashboardResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeAspireDashboardResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeAspireDashboardResource" + ], + "appliesTo": [ + "DockerComposeAspireDashboardResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerComposeEnvironmentResource", + "fullName": "Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "kind": "handle", + "description": "Represents a Docker Compose environment resource that can host application resources.", + "remarks": "Initializes a new instance of the `DockerComposeEnvironmentResource` class.", + "implementedInterfaces": [ + "ComputeEnvironmentResource", + "Resource" + ], + "capabilities": [ + { + "name": "DashboardEnabled", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.dashboardEnabled", + "qualifiedName": "DockerComposeEnvironmentResource.dashboardEnabled", + "description": "Determines whether to include an Aspire dashboard for telemetry visualization in this environment.", + "kind": "PropertyGetter", + "signature": "DashboardEnabled() (bool, error)", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "DefaultNetworkName", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.defaultNetworkName", + "qualifiedName": "DockerComposeEnvironmentResource.defaultNetworkName", + "description": "The name of an existing network to be used.", + "kind": "PropertyGetter", + "signature": "DefaultNetworkName() (*string, error)", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "GetHostAddressExpression", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.getHostAddressExpression", + "qualifiedName": "DockerComposeEnvironmentResource.getHostAddressExpression", + "description": "Invokes the GetHostAddressExpression method", + "kind": "InstanceMethod", + "signature": "GetHostAddressExpression(endpointReference EndpointReference) *ReferenceExpression", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "endpointReference", + "type": "EndpointReference" + } + ], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "SetDashboardEnabled", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.setDashboardEnabled", + "qualifiedName": "DockerComposeEnvironmentResource.setDashboardEnabled", + "description": "Determines whether to include an Aspire dashboard for telemetry visualization in this environment.", + "kind": "PropertySetter", + "signature": "SetDashboardEnabled(value bool) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Determines whether to include an Aspire dashboard for telemetry visualization in this environment." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "SetDefaultNetworkName", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeEnvironmentResource.setDefaultNetworkName", + "qualifiedName": "DockerComposeEnvironmentResource.setDefaultNetworkName", + "description": "The name of an existing network to be used.", + "kind": "PropertySetter", + "signature": "SetDefaultNetworkName(value *string) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "The name of an existing network to be used." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "ConfigureComposeFile", + "capabilityId": "Aspire.Hosting.Docker/configureComposeFile", + "qualifiedName": "configureComposeFile", + "description": "Configures the Docker Compose file for the environment resource.", + "remarks": "This callback runs after the Docker Compose model has been generated and before it is written to disk.\nUse it to customize the generated `ComposeFile` for the environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureComposeFile(configure func(obj ComposeFile)) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj ComposeFile)", + "isCallback": true, + "callbackSignature": "func(obj ComposeFile)", + "description": "A method that can be used for customizing the `ComposeFile`." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "ConfigureDashboard", + "capabilityId": "Aspire.Hosting.Docker/configureDashboard", + "qualifiedName": "configureDashboard", + "description": "Configures the dashboard properties for this Docker Compose environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureDashboard(configure func(obj DockerComposeAspireDashboardResource)) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj DockerComposeAspireDashboardResource)", + "isCallback": true, + "callbackSignature": "func(obj DockerComposeAspireDashboardResource)", + "description": "A method that can be used for customizing the dashboard service." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "ConfigureEnvFile", + "capabilityId": "Aspire.Hosting.Docker/configureEnvFile", + "qualifiedName": "configureEnvFile", + "description": "Configures the captured environment variables for the Docker Compose environment before they are written to the .env file.", + "remarks": "This callback is invoked during the prepare phase, allowing programmatic modification of the environment variables\nthat will be written to the environment-specific `.env` file adjacent to the Docker Compose file.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "ConfigureEnvFile(configure func(obj *Dict[string, CapturedEnvironmentVariable])) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj *Dict[string, CapturedEnvironmentVariable])", + "isCallback": true, + "callbackSignature": "func(obj *Dict[string, CapturedEnvironmentVariable])", + "description": "A method that can be used for customizing the captured environment variables." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "WithDashboard", + "capabilityId": "Aspire.Hosting.Docker/withDashboard", + "qualifiedName": "withDashboard", + "description": "Enables the Aspire dashboard for telemetry visualization in this Docker Compose environment.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDashboard(options ...*WithDashboardOptions) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [], + "options": { + "typeName": "WithDashboardOptions", + "fields": [ + { + "name": "Enabled", + "jsonName": "enabled", + "type": "*bool", + "description": "Whether to enable the dashboard. Default is true." + } + ] + }, + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Docker/withProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of a Docker Compose environment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj DockerComposeEnvironmentResource)) DockerComposeEnvironmentResource", + "receiver": "DockerComposeEnvironmentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj DockerComposeEnvironmentResource)", + "isCallback": true, + "callbackSignature": "func(obj DockerComposeEnvironmentResource)", + "description": "A method that can be used for customizing the `DockerComposeEnvironmentResource`." + } + ], + "returnType": "DockerComposeEnvironmentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeEnvironmentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeEnvironmentResource" + ], + "appliesTo": [ + "DockerComposeEnvironmentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "DockerComposeServiceResource", + "fullName": "Aspire.Hosting.Docker.DockerComposeServiceResource", + "kind": "handle", + "description": "Represents a compute resource for Docker Compose with strongly-typed properties.", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Docker/DockerComposeServiceResource.parent", + "qualifiedName": "DockerComposeServiceResource.parent", + "description": "Gets the Parent property", + "kind": "PropertyGetter", + "signature": "Parent() DockerComposeEnvironmentResource", + "receiver": "DockerComposeServiceResource", + "parameters": [], + "returnType": "DockerComposeEnvironmentResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.DockerComposeServiceResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.DockerComposeServiceResource" + ], + "appliesTo": [ + "DockerComposeServiceResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ComposeFile", + "fullName": "Aspire.Hosting.Docker.Resources.ComposeFile", + "kind": "handle", + "description": "Represents a Docker Compose file with properties and configurations for services, networks, volumes, secrets, configs, and custom extensions.", + "remarks": "This class is designed to encapsulate the structure of a Docker Compose file as a strongly-typed model.\nIt supports serialization to YAML format for usage in Docker Compose operations.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Configs", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.configs", + "qualifiedName": "ComposeFile.configs", + "description": "Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details.", + "kind": "PropertyGetter", + "signature": "Configs() *Dict[string, Config]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Config]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Extensions", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.extensions", + "qualifiedName": "ComposeFile.extensions", + "description": "Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications.", + "kind": "PropertyGetter", + "signature": "Extensions() *Dict[string, any]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, any]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.name", + "qualifiedName": "ComposeFile.name", + "description": "Represents the name of the Docker Compose file or project.", + "remarks": "The name property is used to identify the Compose application\nor project when orchestrating Docker containers.", + "kind": "PropertyGetter", + "signature": "Name() (*string, error)", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Networks", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.networks", + "qualifiedName": "ComposeFile.networks", + "description": "Represents the collection of networks defined in a Docker Compose file.", + "remarks": "Each key in the dictionary represents the name of the network, and the value is an instance of the `Network` class,\nwhich encapsulates the details and configurations of the corresponding network.", + "kind": "PropertyGetter", + "signature": "Networks() *Dict[string, Network]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Network]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Secrets", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.secrets", + "qualifiedName": "ComposeFile.secrets", + "description": "Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file.", + "remarks": "Each secret is represented as a key-value pair, where the key is the name\nof the secret, and the value is an instance of the `Secret` class,\nwhich holds the details about the secret such as file location, external status,\nand additional metadata like labels.", + "kind": "PropertyGetter", + "signature": "Secrets() *Dict[string, Secret]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Secret]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Services", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.services", + "qualifiedName": "ComposeFile.services", + "description": "Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class.", + "remarks": "Services are a critical part of the Docker Compose ecosystem and are used to define\nindividual application components. These components can include images, commands,\nenvironment variables, ports, volumes, dependencies, and more.", + "kind": "PropertyGetter", + "signature": "Services() *Dict[string, Service]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Service]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetConfigs", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setConfigs", + "qualifiedName": "ComposeFile.setConfigs", + "description": "Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details.", + "kind": "PropertySetter", + "signature": "SetConfigs(value *Dict[string, Config]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Config]", + "description": "Represents a collection of configuration objects within a Docker Compose file. Each key in the dictionary corresponds to a configuration name, and the value is an instance of the `Config` class that contains the associated configuration details." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetExtensions", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setExtensions", + "qualifiedName": "ComposeFile.setExtensions", + "description": "Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications.", + "kind": "PropertySetter", + "signature": "SetExtensions(value *Dict[string, any]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, any]", + "description": "Represents a collection of user-defined extension fields that can be added to the Compose file. These extensions are represented as a dictionary where the key is a string identifier for the extension, and the value is an object that holds the custom data relevant to the extension. This allows flexibility for including additional metadata or configuration outside the scope of standard Compose file specifications." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setName", + "qualifiedName": "ComposeFile.setName", + "description": "Represents the name of the Docker Compose file or project.", + "remarks": "The name property is used to identify the Compose application\nor project when orchestrating Docker containers.", + "kind": "PropertySetter", + "signature": "SetName(value *string) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the name of the Docker Compose file or project." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetNetworks", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setNetworks", + "qualifiedName": "ComposeFile.setNetworks", + "description": "Represents the collection of networks defined in a Docker Compose file.", + "remarks": "Each key in the dictionary represents the name of the network, and the value is an instance of the `Network` class,\nwhich encapsulates the details and configurations of the corresponding network.", + "kind": "PropertySetter", + "signature": "SetNetworks(value *Dict[string, Network]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Network]", + "description": "Represents the collection of networks defined in a Docker Compose file." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetSecrets", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setSecrets", + "qualifiedName": "ComposeFile.setSecrets", + "description": "Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file.", + "remarks": "Each secret is represented as a key-value pair, where the key is the name\nof the secret, and the value is an instance of the `Secret` class,\nwhich holds the details about the secret such as file location, external status,\nand additional metadata like labels.", + "kind": "PropertySetter", + "signature": "SetSecrets(value *Dict[string, Secret]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Secret]", + "description": "Represents the secrets section in a Docker Compose file. Contains a collection of secret definitions used within the Compose file." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetServices", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setServices", + "qualifiedName": "ComposeFile.setServices", + "description": "Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class.", + "remarks": "Services are a critical part of the Docker Compose ecosystem and are used to define\nindividual application components. These components can include images, commands,\nenvironment variables, ports, volumes, dependencies, and more.", + "kind": "PropertySetter", + "signature": "SetServices(value *Dict[string, Service]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Service]", + "description": "Represents a collection of services defined in a Docker Compose file. Each service is identified by a unique name and contains configuration details as defined by the `Service` class." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetVersion", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setVersion", + "qualifiedName": "ComposeFile.setVersion", + "description": "Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors.", + "kind": "PropertySetter", + "signature": "SetVersion(value *string) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "SetVolumes", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.setVolumes", + "qualifiedName": "ComposeFile.setVolumes", + "description": "Represents a collection of volume definitions within a Docker Compose file.", + "remarks": "The volumes are defined using a dictionary structure where the key represents the\nname of the volume, and the value is an instance of the `Volume` class.\nVolumes can be used to share data between containers or between a container and the host system.", + "kind": "PropertySetter", + "signature": "SetVolumes(value *Dict[string, Volume]) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Volume]", + "description": "Represents a collection of volume definitions within a Docker Compose file." + } + ], + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Version", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.version", + "qualifiedName": "ComposeFile.version", + "description": "Represents the version of the Docker Compose file format being used. This property specifies the format of the Compose file and determines the supported features and behaviors.", + "kind": "PropertyGetter", + "signature": "Version() (*string, error)", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "Volumes", + "capabilityId": "Aspire.Hosting.Docker.Resources/ComposeFile.volumes", + "qualifiedName": "ComposeFile.volumes", + "description": "Represents a collection of volume definitions within a Docker Compose file.", + "remarks": "The volumes are defined using a dictionary structure where the key represents the\nname of the volume, and the value is an instance of the `Volume` class.\nVolumes can be used to share data between containers or between a container and the host system.", + "kind": "PropertyGetter", + "signature": "Volumes() *Dict[string, Volume]", + "receiver": "ComposeFile", + "parameters": [], + "returnType": "*Dict[string, Volume]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddConfig", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileConfig", + "qualifiedName": "addConfig", + "description": "Adds a top-level config definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddConfig(name string, options ...*AddConfigOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the config." + } + ], + "options": { + "typeName": "AddConfigOptions", + "fields": [ + { + "name": "File", + "jsonName": "file", + "type": "*string", + "description": "The path to the config file." + }, + { + "name": "Content", + "jsonName": "content", + "type": "*string", + "description": "The inline config content." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the config is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Config)", + "isCallback": true, + "callbackSignature": "func(obj Config)", + "description": "An optional callback for further config customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddNetwork", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileNetwork", + "qualifiedName": "addNetwork", + "description": "Adds a top-level network definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddNetwork(name string, options ...*AddNetworkOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the network." + } + ], + "options": { + "typeName": "AddNetworkOptions", + "fields": [ + { + "name": "Driver", + "jsonName": "driver", + "type": "*string", + "description": "The network driver to use." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the network is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Network)", + "isCallback": true, + "callbackSignature": "func(obj Network)", + "description": "An optional callback for further network customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddSecret", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileSecret", + "qualifiedName": "addSecret", + "description": "Adds a top-level secret definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddSecret(name string, options ...*AddSecretOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the secret." + } + ], + "options": { + "typeName": "AddSecretOptions", + "fields": [ + { + "name": "File", + "jsonName": "file", + "type": "*string", + "description": "The path to the secret file." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the secret is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Secret)", + "isCallback": true, + "callbackSignature": "func(obj Secret)", + "description": "An optional callback for further secret customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddService", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileService", + "qualifiedName": "addService", + "description": "Adds a service definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddService(name string, options ...*AddServiceOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the service." + } + ], + "options": { + "typeName": "AddServiceOptions", + "fields": [ + { + "name": "Image", + "jsonName": "image", + "type": "*string", + "description": "The container image to use for the service." + }, + { + "name": "Configure", + "type": "func(obj Service)", + "isCallback": true, + "callbackSignature": "func(obj Service)", + "description": "An optional callback for further service customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + }, + { + "name": "AddVolume", + "capabilityId": "Aspire.Hosting.Docker/addComposeFileVolume", + "qualifiedName": "addVolume", + "description": "Adds a top-level volume definition to the Docker Compose file.", + "returns": "The updated Docker Compose file.", + "kind": "Method", + "signature": "AddVolume(name string, options ...*AddVolumeOptions) ComposeFile", + "receiver": "ComposeFile", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the volume." + } + ], + "options": { + "typeName": "AddVolumeOptions", + "fields": [ + { + "name": "Driver", + "jsonName": "driver", + "type": "*string", + "description": "The volume driver to use." + }, + { + "name": "External", + "jsonName": "external", + "type": "*bool", + "description": "A value indicating whether the volume is managed outside the generated Compose file." + }, + { + "name": "Configure", + "type": "func(obj Volume)", + "isCallback": true, + "callbackSignature": "func(obj Volume)", + "description": "An optional callback for further volume customization." + } + ] + }, + "returnType": "ComposeFile", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeFile", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeFile" + ], + "appliesTo": [ + "ComposeFile" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Config", + "fullName": "Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "kind": "handle", + "description": "Represents a configuration object in a Docker Compose file.", + "remarks": "This class models a configuration entry within a Docker Compose file, such as\nfile-based or external configurations. It includes properties to define the\nsource file, external flag, custom name, and additional labels for the configuration.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Content", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.content", + "qualifiedName": "Config.content", + "description": "Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file.", + "kind": "PropertyGetter", + "signature": "Content() (*string, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.external", + "qualifiedName": "Config.external", + "description": "Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "File", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.file", + "qualifiedName": "Config.file", + "description": "Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component.", + "kind": "PropertyGetter", + "signature": "File() (*string, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.labels", + "qualifiedName": "Config.labels", + "description": "Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Config", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.name", + "qualifiedName": "Config.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Config", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetContent", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setContent", + "qualifiedName": "Config.setContent", + "description": "Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file.", + "kind": "PropertySetter", + "signature": "SetContent(value *string) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the contents of the configuration file. This property is used to specify the actual configuration data that will be included in the Docker Compose file." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setExternal", + "qualifiedName": "Config.setExternal", + "description": "Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the configuration is external to the current project context. When set to true, the configuration will not be managed or created by the Compose file; instead, it references an existing resource outside the current scope. If null, the external status is not explicitly specified." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setFile", + "qualifiedName": "Config.setFile", + "description": "Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component.", + "kind": "PropertySetter", + "signature": "SetFile(value *string) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the path to the configuration file. This property is used to specify the file containing the configuration data for the service or component." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setLabels", + "qualifiedName": "Config.setLabels", + "description": "Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of key-value pairs used as metadata for configuration objects. The labels provide additional descriptive information, which can be utilized for tagging, grouping, or identification purposes." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Config.setName", + "qualifiedName": "Config.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Config", + "receiver": "Config", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Config", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Config", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Config" + ], + "appliesTo": [ + "Config" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Network", + "fullName": "Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "kind": "handle", + "description": "Represents a Docker network configuration as part of a Compose file.", + "remarks": "This class encapsulates the properties and options related to a network in a Docker Compose file.\nIt includes configurations such as driver type, options, labels, IPAM settings, and more.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Attachable", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.attachable", + "qualifiedName": "Network.attachable", + "description": "Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services.", + "kind": "PropertyGetter", + "signature": "Attachable() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Driver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.driver", + "qualifiedName": "Network.driver", + "description": "Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc.", + "kind": "PropertyGetter", + "signature": "Driver() (*string, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "DriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.driverOpts", + "qualifiedName": "Network.driverOpts", + "description": "Represents a dictionary of driver-specific options for the network configuration in a Docker service node.", + "remarks": "These options are key-value pairs that allow customization of network settings based on the specified driver.\nThey can control behaviors or features unique to the driver being used.", + "kind": "PropertyGetter", + "signature": "DriverOpts() *Dict[string, string]", + "receiver": "Network", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.external", + "qualifiedName": "Network.external", + "description": "Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Ingress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.ingress", + "qualifiedName": "Network.ingress", + "description": "Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker.", + "kind": "PropertyGetter", + "signature": "Ingress() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Internal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.internal", + "qualifiedName": "Network.internal", + "description": "Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.", + "kind": "PropertyGetter", + "signature": "Internal() (*bool, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.labels", + "qualifiedName": "Network.labels", + "description": "Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Network", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.name", + "qualifiedName": "Network.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Network", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetAttachable", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setAttachable", + "qualifiedName": "Network.setAttachable", + "description": "Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services.", + "kind": "PropertySetter", + "signature": "SetAttachable(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Gets or sets a value indicating whether the network is attachable. When this property is set to true, containers can dynamically attach to the network at runtime. This feature is primarily used in Docker Swarm mode to enable service discovery and communication between services." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetDriver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setDriver", + "qualifiedName": "Network.setDriver", + "description": "Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc.", + "kind": "PropertySetter", + "signature": "SetDriver(value *string) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the driver used for the network. The driver determines the networking implementation that the container network is based on. Examples include bridge, overlay, host, etc." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetDriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setDriverOpts", + "qualifiedName": "Network.setDriverOpts", + "description": "Represents a dictionary of driver-specific options for the network configuration in a Docker service node.", + "remarks": "These options are key-value pairs that allow customization of network settings based on the specified driver.\nThey can control behaviors or features unique to the driver being used.", + "kind": "PropertySetter", + "signature": "SetDriverOpts(value *Dict[string, string]) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a dictionary of driver-specific options for the network configuration in a Docker service node." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setExternal", + "qualifiedName": "Network.setExternal", + "description": "Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the network is external or managed by Docker outside of the application stack. When set to true, the network is assumed to be pre-existing and not defined by the application's configuration. When set to false or null, the network can be defined and created within the application scope." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetIngress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setIngress", + "qualifiedName": "Network.setIngress", + "description": "Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker.", + "kind": "PropertySetter", + "signature": "SetIngress(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Represents whether the network is configured as an ingress network. An ingress network is used to manage the internal routing and load balancing for swarm services in Docker." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetInternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setInternal", + "qualifiedName": "Network.setInternal", + "description": "Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally.", + "kind": "PropertySetter", + "signature": "SetInternal(value *bool) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Determines if the network is restricted to internal usage only. When set to true, the network is not accessible externally." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setLabels", + "qualifiedName": "Network.setLabels", + "description": "Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of metadata labels applied to the network configuration. These labels can be used to organize, manage, or identify network resources." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Network.setName", + "qualifiedName": "Network.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Network", + "receiver": "Network", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Network", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Network", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Network" + ], + "appliesTo": [ + "Network" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Secret", + "fullName": "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "kind": "handle", + "description": "Represents a Secret object in a Docker Compose configuration file.", + "remarks": "A Secret object is used to define sensitive information to be shared with containers,\nsuch as passwords, keys, or certificates. These secrets can either be externally managed\nor provided locally from a specific file.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.external", + "qualifiedName": "Secret.external", + "description": "Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Secret", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "File", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.file", + "qualifiedName": "Secret.file", + "description": "Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container.", + "kind": "PropertyGetter", + "signature": "File() (*string, error)", + "receiver": "Secret", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.labels", + "qualifiedName": "Secret.labels", + "description": "Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Secret", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.name", + "qualifiedName": "Secret.name", + "description": "Gets or sets the name of the secret in the Docker Compose configuration.", + "kind": "PropertyGetter", + "signature": "Name() (*string, error)", + "receiver": "Secret", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setExternal", + "qualifiedName": "Secret.setExternal", + "description": "Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the secret is managed externally. If set to true, the secret must already exist, as it will not be created or modified." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setFile", + "qualifiedName": "Secret.setFile", + "description": "Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container.", + "kind": "PropertySetter", + "signature": "SetFile(value *string) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the file path associated with the secret. This specifies the location of the file on the host system that will be used as the source for the secret in the container." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setLabels", + "qualifiedName": "Secret.setLabels", + "description": "Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Gets or sets a collection of key-value pairs representing metadata or additional information associated with the secret. These labels can be used for categorization, identification, or other purposes as determined by the user." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Secret.setName", + "qualifiedName": "Secret.setName", + "description": "Gets or sets the name of the secret in the Docker Compose configuration.", + "kind": "PropertySetter", + "signature": "SetName(value *string) Secret", + "receiver": "Secret", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the name of the secret in the Docker Compose configuration." + } + ], + "returnType": "Secret", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Secret", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Secret" + ], + "appliesTo": [ + "Secret" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Service", + "fullName": "Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "kind": "handle", + "description": "Represents a Docker Compose service definition.", + "remarks": "This class provides YAML mapping for various properties associated with a service in Docker Compose,\nsuch as image, container configuration, environment variables, networks, and more.\nIt is designed to map directly to the service properties defined in a Docker Compose YAML file.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "CapAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.capAdd", + "qualifiedName": "Service.capAdd", + "description": "Specifies a list of Linux capabilities to add to the container.", + "remarks": "Linux capabilities allow fine-grained control of the privileges assigned to a process.\nThis property provides the ability to add specific capabilities to the set of capabilities available to the container.\nEach capability should be specified as a string in the list. Use this property to enhance the container's permissions\nbeyond the default set provided by the Docker runtime, if required by the application running inside the container.", + "kind": "PropertyGetter", + "signature": "CapAdd() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "CapDrop", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.capDrop", + "qualifiedName": "Service.capDrop", + "description": "Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege.", + "kind": "PropertyGetter", + "signature": "CapDrop() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "CgroupParent", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.cgroupParent", + "qualifiedName": "Service.cgroupParent", + "description": "Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed.", + "kind": "PropertyGetter", + "signature": "CgroupParent() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Command", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.command", + "qualifiedName": "Service.command", + "description": "Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments.", + "kind": "PropertyGetter", + "signature": "Command() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Configs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.configs", + "qualifiedName": "Service.configs", + "description": "Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations.", + "kind": "PropertyGetter", + "signature": "Configs() *List[ConfigReference]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[ConfigReference]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ContainerName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.containerName", + "qualifiedName": "Service.containerName", + "description": "Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated.", + "kind": "PropertyGetter", + "signature": "ContainerName() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "DependsOn", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.dependsOn", + "qualifiedName": "Service.dependsOn", + "description": "Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service.", + "kind": "PropertyGetter", + "signature": "DependsOn() *Dict[string, ServiceDependency]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, ServiceDependency]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Devices", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.devices", + "qualifiedName": "Service.devices", + "description": "Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker.", + "kind": "PropertyGetter", + "signature": "Devices() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Dns", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.dns", + "qualifiedName": "Service.dns", + "description": "Gets or sets a list of custom DNS server IP addresses to be used by the service container.", + "kind": "PropertyGetter", + "signature": "Dns() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "DnsSearch", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.dnsSearch", + "qualifiedName": "Service.dnsSearch", + "description": "Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups.", + "kind": "PropertyGetter", + "signature": "DnsSearch() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "DomainName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.domainName", + "qualifiedName": "Service.domainName", + "description": "Represents the domain name of a service container.", + "kind": "PropertyGetter", + "signature": "DomainName() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Entrypoint", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.entrypoint", + "qualifiedName": "Service.entrypoint", + "description": "Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts.", + "kind": "PropertyGetter", + "signature": "Entrypoint() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "EnvFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.envFile", + "qualifiedName": "Service.envFile", + "description": "Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime.", + "kind": "PropertyGetter", + "signature": "EnvFile() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Environment", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.environment", + "qualifiedName": "Service.environment", + "description": "Represents a collection of environment variables for the service container.", + "remarks": "The property allows for specifying environment variables as key-value pairs.\nThese variables can be used to configure the behavior of the container\nor pass information to the application running inside the container.", + "kind": "PropertyGetter", + "signature": "Environment() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Expose", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.expose", + "qualifiedName": "Service.expose", + "description": "Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network.", + "kind": "PropertyGetter", + "signature": "Expose() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ExternalLinks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.externalLinks", + "qualifiedName": "Service.externalLinks", + "description": "Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments.", + "kind": "PropertyGetter", + "signature": "ExternalLinks() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ExtraHosts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.extraHosts", + "qualifiedName": "Service.extraHosts", + "description": "Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers.", + "kind": "PropertyGetter", + "signature": "ExtraHosts() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "GroupAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.groupAdd", + "qualifiedName": "Service.groupAdd", + "description": "Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups.", + "kind": "PropertyGetter", + "signature": "GroupAdd() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Hostname", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.hostname", + "qualifiedName": "Service.hostname", + "description": "Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network.", + "kind": "PropertyGetter", + "signature": "Hostname() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Image", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.image", + "qualifiedName": "Service.image", + "description": "Specifies the Docker image to be used for the service.", + "remarks": "The image refers to the identifier of a container image hosted in a registry.\nThis property is required if no build instructions are provided for the service.\nIt may include an optional tag or digest to specify a particular version of the image.\nIf omitted, Docker will default to the `latest` tag.", + "kind": "PropertyGetter", + "signature": "Image() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Init", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.init", + "qualifiedName": "Service.init", + "description": "Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container.", + "kind": "PropertyGetter", + "signature": "Init() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Ipc", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.ipc", + "qualifiedName": "Service.ipc", + "description": "Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with.", + "kind": "PropertyGetter", + "signature": "Ipc() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Isolation", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.isolation", + "qualifiedName": "Service.isolation", + "description": "Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used.", + "kind": "PropertyGetter", + "signature": "Isolation() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.labels", + "qualifiedName": "Service.labels", + "description": "Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Links", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.links", + "qualifiedName": "Service.links", + "description": "Represents a service definition in a Docker Compose configuration file.", + "kind": "PropertyGetter", + "signature": "Links() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "MacAddress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.macAddress", + "qualifiedName": "Service.macAddress", + "description": "Specifies a custom MAC (Media Access Control) address for the container's network interface.", + "remarks": "A MAC address is a unique identifier assigned to a network interface controller (NIC).\nSetting this property allows for specifying a predefined MAC address instead of letting the system assign one dynamically.\nThis can be useful for use cases where a consistent MAC address is required, such as DHCP reservations or specific network configurations.", + "kind": "PropertyGetter", + "signature": "MacAddress() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.name", + "qualifiedName": "Service.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "NetworkMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.networkMode", + "qualifiedName": "Service.networkMode", + "description": "Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name.", + "kind": "PropertyGetter", + "signature": "NetworkMode() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Networks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.networks", + "qualifiedName": "Service.networks", + "description": "Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value.", + "kind": "PropertyGetter", + "signature": "Networks() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Pid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.pid", + "qualifiedName": "Service.pid", + "description": "Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them.", + "kind": "PropertyGetter", + "signature": "Pid() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Ports", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.ports", + "qualifiedName": "Service.ports", + "description": "Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port.", + "kind": "PropertyGetter", + "signature": "Ports() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Privileged", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.privileged", + "qualifiedName": "Service.privileged", + "description": "Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access.", + "kind": "PropertyGetter", + "signature": "Privileged() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Profiles", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.profiles", + "qualifiedName": "Service.profiles", + "description": "Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations.", + "kind": "PropertyGetter", + "signature": "Profiles() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "PullPolicy", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.pullPolicy", + "qualifiedName": "Service.pullPolicy", + "description": "Specifies the policy for pulling the Docker image.", + "remarks": "This property determines when the container runtime should pull the image.\nCommon values include \"always\", \"never\", \"missing\", \"if_not_present\", or \"build\".\nIf not specified, the default behavior depends on the container runtime configuration.", + "kind": "PropertyGetter", + "signature": "PullPolicy() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.readOnly", + "qualifiedName": "Service.readOnly", + "description": "Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs.", + "kind": "PropertyGetter", + "signature": "ReadOnly() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Restart", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.restart", + "qualifiedName": "Service.restart", + "description": "Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\".", + "kind": "PropertyGetter", + "signature": "Restart() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Secrets", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.secrets", + "qualifiedName": "Service.secrets", + "description": "Represents a collection of secret references used by the service.", + "remarks": "Each entry in the collection refers to a specific secret that is utilized by the service,\ntypically for managing sensitive information in a secure manner (e.g., credentials, tokens).", + "kind": "PropertyGetter", + "signature": "Secrets() *List[SecretReference]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[SecretReference]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SecurityOpt", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.securityOpt", + "qualifiedName": "Service.securityOpt", + "description": "Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior.", + "kind": "PropertyGetter", + "signature": "SecurityOpt() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCapAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCapAdd", + "qualifiedName": "Service.setCapAdd", + "description": "Specifies a list of Linux capabilities to add to the container.", + "remarks": "Linux capabilities allow fine-grained control of the privileges assigned to a process.\nThis property provides the ability to add specific capabilities to the set of capabilities available to the container.\nEach capability should be specified as a string in the list. Use this property to enhance the container's permissions\nbeyond the default set provided by the Docker runtime, if required by the application running inside the container.", + "kind": "PropertySetter", + "signature": "SetCapAdd(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies a list of Linux capabilities to add to the container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCapDrop", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCapDrop", + "qualifiedName": "Service.setCapDrop", + "description": "Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege.", + "kind": "PropertySetter", + "signature": "SetCapDrop(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a list of Linux capabilities to be dropped from the service's container. This property can be used to restrict specific capabilities that the container should not have access to, enhancing security by implementing the principle of least privilege." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCgroupParent", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCgroupParent", + "qualifiedName": "Service.setCgroupParent", + "description": "Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed.", + "kind": "PropertySetter", + "signature": "SetCgroupParent(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the parent Cgroup for the container. This property defines the name of the Cgroup under which the container's resource constraints are managed." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetCommand", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setCommand", + "qualifiedName": "Service.setCommand", + "description": "Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments.", + "kind": "PropertySetter", + "signature": "SetCommand(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents the command to override the default command specified in the image's Dockerfile. This property allows specifying how the container should run by defining an executable and its arguments." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetConfigs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setConfigs", + "qualifiedName": "Service.setConfigs", + "description": "Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations.", + "kind": "PropertySetter", + "signature": "SetConfigs(value *List[ConfigReference]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[ConfigReference]", + "description": "Represents a collection of configuration references associated with the service. Each configuration is defined as a reference to an external configuration resource, which can be used to manage application configurations." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetContainerName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setContainerName", + "qualifiedName": "Service.setContainerName", + "description": "Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated.", + "kind": "PropertySetter", + "signature": "SetContainerName(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the name of the container to be used. This property maps to the \"container_name\" field in a Docker Compose file. If set, the container will have the specified name; otherwise, a name will be automatically generated." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDependsOn", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDependsOn", + "qualifiedName": "Service.setDependsOn", + "description": "Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service.", + "kind": "PropertySetter", + "signature": "SetDependsOn(value *Dict[string, ServiceDependency]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, ServiceDependency]", + "description": "Specifies a list of services that this service depends on. The dependencies are expressed as service names with optional conditions. Supported conditions are: \"service_started\", \"service_healthy\", \"service_completed_successfully\" This property defines the order in which services should be started, ensuring that the specified services are initialized before the current service." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDevices", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDevices", + "qualifiedName": "Service.setDevices", + "description": "Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker.", + "kind": "PropertySetter", + "signature": "SetDevices(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a collection of device mappings for the service container. This property defines the host-to-container device paths in Docker." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDns", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDns", + "qualifiedName": "Service.setDns", + "description": "Gets or sets a list of custom DNS server IP addresses to be used by the service container.", + "kind": "PropertySetter", + "signature": "SetDns(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets a list of custom DNS server IP addresses to be used by the service container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDnsSearch", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDnsSearch", + "qualifiedName": "Service.setDnsSearch", + "description": "Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups.", + "kind": "PropertySetter", + "signature": "SetDnsSearch(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies the domain search options for the service's container. This property allows you to define one or more domain search suffixes that will be appended to unqualified DNS queries performed by the container. Typically used to configure how DNS resolution should behave in specific network setups." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetDomainName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setDomainName", + "qualifiedName": "Service.setDomainName", + "description": "Represents the domain name of a service container.", + "kind": "PropertySetter", + "signature": "SetDomainName(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Represents the domain name of a service container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetEntrypoint", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setEntrypoint", + "qualifiedName": "Service.setEntrypoint", + "description": "Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts.", + "kind": "PropertySetter", + "signature": "SetEntrypoint(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies the entrypoint to be used for the container. This property allows overriding the default entrypoint of the image and defines the executable or command that is run when the container starts." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetEnvFile", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setEnvFile", + "qualifiedName": "Service.setEnvFile", + "description": "Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime.", + "kind": "PropertySetter", + "signature": "SetEnvFile(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a collection of paths to environment variable files used by the service. These files contain key-value pairs of environment variables that will be loaded and applied to the service configuration at runtime." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetEnvironment", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setEnvironment", + "qualifiedName": "Service.setEnvironment", + "description": "Represents a collection of environment variables for the service container.", + "remarks": "The property allows for specifying environment variables as key-value pairs.\nThese variables can be used to configure the behavior of the container\nor pass information to the application running inside the container.", + "kind": "PropertySetter", + "signature": "SetEnvironment(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of environment variables for the service container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetExpose", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setExpose", + "qualifiedName": "Service.setExpose", + "description": "Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network.", + "kind": "PropertySetter", + "signature": "SetExpose(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets a list of ports to expose from the container without publishing them to the host machine. This property defines internal ports that the container makes available to linked services or other containers within the same network, but these ports are not accessible from outside the container’s network." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetExternalLinks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setExternalLinks", + "qualifiedName": "Service.setExternalLinks", + "description": "Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments.", + "kind": "PropertySetter", + "signature": "SetExternalLinks(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets the external links for the service. External links are references to services defined outside the current Docker Compose file, enabling communication with containers in other projects or environments." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetExtraHosts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setExtraHosts", + "qualifiedName": "Service.setExtraHosts", + "description": "Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers.", + "kind": "PropertySetter", + "signature": "SetExtraHosts(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents additional hostname-to-IP mappings for the service. These mappings allow you to manually define hostnames and corresponding IP addresses, effectively augmenting the DNS resolution for the service's containers." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetGroupAdd", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setGroupAdd", + "qualifiedName": "Service.setGroupAdd", + "description": "Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups.", + "kind": "PropertySetter", + "signature": "SetGroupAdd(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Gets or sets a list of additional group IDs to add to the container's process. This allows the container to have access to resources or permissions associated with the specified groups." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetHostname", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setHostname", + "qualifiedName": "Service.setHostname", + "description": "Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network.", + "kind": "PropertySetter", + "signature": "SetHostname(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the hostname for the service container. This defines the hostname that will be assigned to the container and can be used for network identification within the container's network." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetImage", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setImage", + "qualifiedName": "Service.setImage", + "description": "Specifies the Docker image to be used for the service.", + "remarks": "The image refers to the identifier of a container image hosted in a registry.\nThis property is required if no build instructions are provided for the service.\nIt may include an optional tag or digest to specify a particular version of the image.\nIf omitted, Docker will default to the `latest` tag.", + "kind": "PropertySetter", + "signature": "SetImage(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the Docker image to be used for the service." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetInit", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setInit", + "qualifiedName": "Service.setInit", + "description": "Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container.", + "kind": "PropertySetter", + "signature": "SetInit(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the init binary should be used as the container's init process. When set to true, the init process is used to ensure proper reaping of zombie processes and signal forwarding inside the container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetIpc", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setIpc", + "qualifiedName": "Service.setIpc", + "description": "Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with.", + "kind": "PropertySetter", + "signature": "SetIpc(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the IPC (Inter-Process Communication) mode for the service. This property determines how IPC namespaces are shared between containers and the host. It can be set to values such as \"none\", \"host\", or a specific container ID to share IPC resources with." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetIsolation", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setIsolation", + "qualifiedName": "Service.setIsolation", + "description": "Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used.", + "kind": "PropertySetter", + "signature": "SetIsolation(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the isolation mode for the container. This property determines the level of isolation between the container and the host system. Common values include \"default\", \"process\", or \"hyperv\", and the supported options may depend on the container runtime or the platform being used." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setLabels", + "qualifiedName": "Service.setLabels", + "description": "Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a set of metadata labels for the service. These key-value pairs can be used to organize and identify objects within the service configuration." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetLinks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setLinks", + "qualifiedName": "Service.setLinks", + "description": "Represents a service definition in a Docker Compose configuration file.", + "kind": "PropertySetter", + "signature": "SetLinks(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a service definition in a Docker Compose configuration file." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetMacAddress", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setMacAddress", + "qualifiedName": "Service.setMacAddress", + "description": "Specifies a custom MAC (Media Access Control) address for the container's network interface.", + "remarks": "A MAC address is a unique identifier assigned to a network interface controller (NIC).\nSetting this property allows for specifying a predefined MAC address instead of letting the system assign one dynamically.\nThis can be useful for use cases where a consistent MAC address is required, such as DHCP reservations or specific network configurations.", + "kind": "PropertySetter", + "signature": "SetMacAddress(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies a custom MAC (Media Access Control) address for the container's network interface." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setName", + "qualifiedName": "Service.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetNetworkMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setNetworkMode", + "qualifiedName": "Service.setNetworkMode", + "description": "Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name.", + "kind": "PropertySetter", + "signature": "SetNetworkMode(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the network mode to be used for the container. This property determines the networking configuration, such as whether the container shares the network stack with the host, uses a predefined network, or operates in isolation. The value is typically a string that matches a network mode supported by the environment, such as 'bridge', 'host', 'none', or a custom network name." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetNetworks", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setNetworks", + "qualifiedName": "Service.setNetworks", + "description": "Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value.", + "kind": "PropertySetter", + "signature": "SetNetworks(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Defines the collection of networks that the service is connected to. This property specifies the names of the networks the service should be attached to. Each entry in this list represents a network defined in the Docker Compose file or an externally defined network. Connecting a service to one or more networks allows inter-service communication across those networks, as well as communication with external systems configured on those same networks. If no network is specified, the service is connected to the default network that is automatically created by Docker Compose for the project unless `network_mode` is set to another value." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPid", + "qualifiedName": "Service.setPid", + "description": "Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them.", + "kind": "PropertySetter", + "signature": "SetPid(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the PID (Process Identifier) namespace configuration for the container. This property determines whether the container shares the PID namespace with the host or other containers, allowing process visibility and signal sending between them." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPorts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPorts", + "qualifiedName": "Service.setPorts", + "description": "Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port.", + "kind": "PropertySetter", + "signature": "SetPorts(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a collection of port mappings for the service. Each mapping specifies how a container port is bound to a host port." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPrivileged", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPrivileged", + "qualifiedName": "Service.setPrivileged", + "description": "Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access.", + "kind": "PropertySetter", + "signature": "SetPrivileged(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the container should run in privileged mode. When set to true, the container is granted extended Linux capabilities and device access." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetProfiles", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setProfiles", + "qualifiedName": "Service.setProfiles", + "description": "Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations.", + "kind": "PropertySetter", + "signature": "SetProfiles(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Defines a list of profiles associated with the service. Profiles allow grouping of services and provide the ability to selectively enable services based on specified runtime profiles. If no profiles are specified, the service will be active in all configurations." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetPullPolicy", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setPullPolicy", + "qualifiedName": "Service.setPullPolicy", + "description": "Specifies the policy for pulling the Docker image.", + "remarks": "This property determines when the container runtime should pull the image.\nCommon values include \"always\", \"never\", \"missing\", \"if_not_present\", or \"build\".\nIf not specified, the default behavior depends on the container runtime configuration.", + "kind": "PropertySetter", + "signature": "SetPullPolicy(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the policy for pulling the Docker image." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setReadOnly", + "qualifiedName": "Service.setReadOnly", + "description": "Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs.", + "kind": "PropertySetter", + "signature": "SetReadOnly(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Defines whether the service containers should be run in read-only mode. If set to true, the containers will have a read-only file system, limiting write operations to specific directories defined by writable mounts or tempfs." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetRestart", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setRestart", + "qualifiedName": "Service.setRestart", + "description": "Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\".", + "kind": "PropertySetter", + "signature": "SetRestart(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the restart policy for the container. This property determines how the container should behave in case of a crash or termination. Common values include \"no\", \"always\", \"on-failure\", and \"unless-stopped\"." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetSecrets", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setSecrets", + "qualifiedName": "Service.setSecrets", + "description": "Represents a collection of secret references used by the service.", + "remarks": "Each entry in the collection refers to a specific secret that is utilized by the service,\ntypically for managing sensitive information in a secure manner (e.g., credentials, tokens).", + "kind": "PropertySetter", + "signature": "SetSecrets(value *List[SecretReference]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[SecretReference]", + "description": "Represents a collection of secret references used by the service." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetSecurityOpt", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setSecurityOpt", + "qualifiedName": "Service.setSecurityOpt", + "description": "Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior.", + "kind": "PropertySetter", + "signature": "SetSecurityOpt(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Represents a list of security options that can be applied to the container. This is used to configure security-related settings specific to the container such as SELinux labels or AppArmor profiles, providing fine-grained control over the container's security behavior." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetShmSize", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setShmSize", + "qualifiedName": "Service.setShmSize", + "description": "Gets or sets the size of the `/dev/shm` partition for the container.", + "remarks": "The value is emitted as the Docker Compose `shm_size` service property, for example `128mb`.", + "kind": "PropertySetter", + "signature": "SetShmSize(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the size of the `/dev/shm` partition for the container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetStdinOpen", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setStdinOpen", + "qualifiedName": "Service.setStdinOpen", + "description": "Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected.", + "kind": "PropertySetter", + "signature": "SetStdinOpen(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetStopGracePeriod", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setStopGracePeriod", + "qualifiedName": "Service.setStopGracePeriod", + "description": "Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute.", + "kind": "PropertySetter", + "signature": "SetStopGracePeriod(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetStopSignal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setStopSignal", + "qualifiedName": "Service.setStopSignal", + "description": "Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM.", + "kind": "PropertySetter", + "signature": "SetStopSignal(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetSysctls", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setSysctls", + "qualifiedName": "Service.setSysctls", + "description": "Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`.", + "kind": "PropertySetter", + "signature": "SetSysctls(value *Dict[string, string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetTmpfs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setTmpfs", + "qualifiedName": "Service.setTmpfs", + "description": "Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes.", + "kind": "PropertySetter", + "signature": "SetTmpfs(value *List[string]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[string]", + "description": "Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetTty", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setTty", + "qualifiedName": "Service.setTty", + "description": "Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session.", + "kind": "PropertySetter", + "signature": "SetTty(value *bool) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetUlimits", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setUlimits", + "qualifiedName": "Service.setUlimits", + "description": "Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size.", + "kind": "PropertySetter", + "signature": "SetUlimits(value *Dict[string, Ulimit]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, Ulimit]", + "description": "Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetUser", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setUser", + "qualifiedName": "Service.setUser", + "description": "Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\").", + "kind": "PropertySetter", + "signature": "SetUser(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\")." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetVolumes", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setVolumes", + "qualifiedName": "Service.setVolumes", + "description": "Defines the list of volumes to be mounted into the service's container.", + "remarks": "Volumes provide a mechanism for persisting data used by the service or for sharing data between the host and the container.\nEach volume entry maps a source path on the host or an anonymous volume to a target path within the container.\nThis property can also include named volumes as defined in the Compose file's top-level `volumes` section.\nVolumes can specify additional options such as read-only access or volume drivers.", + "kind": "PropertySetter", + "signature": "SetVolumes(value *List[Volume]) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*List[Volume]", + "description": "Defines the list of volumes to be mounted into the service's container." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "SetWorkingDir", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.setWorkingDir", + "qualifiedName": "Service.setWorkingDir", + "description": "Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file.", + "kind": "PropertySetter", + "signature": "SetWorkingDir(value *string) Service", + "receiver": "Service", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file." + } + ], + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "ShmSize", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.shmSize", + "qualifiedName": "Service.shmSize", + "description": "Gets or sets the size of the `/dev/shm` partition for the container.", + "remarks": "The value is emitted as the Docker Compose `shm_size` service property, for example `128mb`.", + "kind": "PropertyGetter", + "signature": "ShmSize() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "StdinOpen", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.stdinOpen", + "qualifiedName": "Service.stdinOpen", + "description": "Indicates whether standard input (stdin) should remain open and be attached to the service container, even if no terminal is connected.", + "kind": "PropertyGetter", + "signature": "StdinOpen() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "StopGracePeriod", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.stopGracePeriod", + "qualifiedName": "Service.stopGracePeriod", + "description": "Gets or sets the stop grace period for the container. This specifies the amount of time to wait before forcing a container to stop after the stop or shutdown signal is sent. The value can be defined in a time duration format, such as \"10s\" for 10 seconds or \"1m\" for 1 minute.", + "kind": "PropertyGetter", + "signature": "StopGracePeriod() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "StopSignal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.stopSignal", + "qualifiedName": "Service.stopSignal", + "description": "Specifies the signal that will be used to stop the container. This property allows you to define a custom stop signal other than the default SIGTERM.", + "kind": "PropertyGetter", + "signature": "StopSignal() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Sysctls", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.sysctls", + "qualifiedName": "Service.sysctls", + "description": "Represents a set of kernel parameters, specified as key-value pairs, that can be applied to the container at runtime. This property allows customization of specific Linux kernel settings (sysctl parameters) for the container, enabling fine-tuned control over its behavior. Common use cases include tuning network parameters or configuring shared memory limits. Note: Supported kernel parameters will vary based on the Docker daemon and the host system. Unsupported parameters will result in an error. Example: Use this property to set parameters like `net.ipv4.tcp_syncookies` or `net.core.somaxconn`.", + "kind": "PropertyGetter", + "signature": "Sysctls() *Dict[string, string]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Tmpfs", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.tmpfs", + "qualifiedName": "Service.tmpfs", + "description": "Specifies a list of temporary file systems (tmpfs) to be mounted inside the container. Each entry represents a directory on the container's filesystem, mounted as a tmpfs, which resides in-memory and is typically used for ephemeral storage or caching purposes.", + "kind": "PropertyGetter", + "signature": "Tmpfs() *List[string]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Tty", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.tty", + "qualifiedName": "Service.tty", + "description": "Specifies whether a pseudo-TTY (teletypewriter) should be allocated for the container. When set to true, it enables the container to run with an interactive terminal session.", + "kind": "PropertyGetter", + "signature": "Tty() (*bool, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Ulimits", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.ulimits", + "qualifiedName": "Service.ulimits", + "description": "Represents a collection of ulimit constraints for the service. Ulimits specify system resource limitations to be applied to the container, such as maximum number of open files or maximum stack size.", + "kind": "PropertyGetter", + "signature": "Ulimits() *Dict[string, Ulimit]", + "receiver": "Service", + "parameters": [], + "returnType": "*Dict[string, Ulimit]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "User", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.user", + "qualifiedName": "Service.user", + "description": "Specifies the user that the container will run as. The value can be set to a numeric UID, a string for the username, or a combination of both (e.g., \"UID:GID\").", + "kind": "PropertyGetter", + "signature": "User() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "Volumes", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.volumes", + "qualifiedName": "Service.volumes", + "description": "Defines the list of volumes to be mounted into the service's container.", + "remarks": "Volumes provide a mechanism for persisting data used by the service or for sharing data between the host and the container.\nEach volume entry maps a source path on the host or an anonymous volume to a target path within the container.\nThis property can also include named volumes as defined in the Compose file's top-level `volumes` section.\nVolumes can specify additional options such as read-only access or volume drivers.", + "kind": "PropertyGetter", + "signature": "Volumes() *List[Volume]", + "receiver": "Service", + "parameters": [], + "returnType": "*List[Volume]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "WorkingDir", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/Service.workingDir", + "qualifiedName": "Service.workingDir", + "description": "Gets or sets the working directory of the container. Specifies the directory in which commands are run inside the container. Corresponds to the \"working_dir\" property in a Docker Compose file.", + "kind": "PropertyGetter", + "signature": "WorkingDir() (*string, error)", + "receiver": "Service", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + }, + { + "name": "AddVolume", + "capabilityId": "Aspire.Hosting.Docker/addComposeServiceVolume", + "qualifiedName": "addVolume", + "description": "Adds a volume mount to a generated Docker Compose service.", + "returns": "The updated Docker Compose service.", + "kind": "Method", + "signature": "AddVolume(source string, target string, options ...*ServiceAddVolumeOptions) Service", + "receiver": "Service", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source volume name or host path." + }, + { + "name": "target", + "type": "string", + "description": "The target path inside the container." + } + ], + "options": { + "typeName": "ServiceAddVolumeOptions", + "fields": [ + { + "name": "Type", + "jsonName": "type", + "type": "*string", + "description": "The Docker Compose volume type, such as `volume` or `bind`." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A value indicating whether the volume is mounted as read-only." + }, + { + "name": "Configure", + "type": "func(obj Volume)", + "isCallback": true, + "callbackSignature": "func(obj Volume)", + "description": "An optional callback for further volume customization." + } + ] + }, + "returnType": "Service", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.Service", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.Service" + ], + "appliesTo": [ + "Service" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ServiceDependency", + "fullName": "Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency", + "kind": "handle", + "description": "Represents a service dependency in a Docker Compose file.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Condition", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/ServiceDependency.condition", + "qualifiedName": "ServiceDependency.condition", + "description": "Gets or sets the condition under which the service should be started.", + "kind": "PropertyGetter", + "signature": "Condition() (*string, error)", + "receiver": "ServiceDependency", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency" + ], + "appliesTo": [ + "ServiceDependency" + ] + }, + { + "name": "SetCondition", + "capabilityId": "Aspire.Hosting.Docker.Resources.ComposeNodes/ServiceDependency.setCondition", + "qualifiedName": "ServiceDependency.setCondition", + "description": "Gets or sets the condition under which the service should be started.", + "kind": "PropertySetter", + "signature": "SetCondition(value *string) ServiceDependency", + "receiver": "ServiceDependency", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the condition under which the service should be started." + } + ], + "returnType": "ServiceDependency", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ComposeNodes.ServiceDependency" + ], + "appliesTo": [ + "ServiceDependency" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ConfigReference", + "fullName": "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "kind": "handle", + "description": "Represents a reference to a configuration used within a service resource.", + "remarks": "This class is typically used to define configurations associated with a\nservice in a containerized environment. It includes information about\nthe configuration source, target, ownership, and permissions.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Gid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.gid", + "qualifiedName": "ConfigReference.gid", + "description": "Gets or sets the group ID (GID) used to identify the group of the referenced configuration.", + "remarks": "The GID is an optional integer parameter that specifies the group ownership\nfor the resource. If set, it defines the group to which the target resource belongs.", + "kind": "PropertyGetter", + "signature": "Gid() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Mode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.mode", + "qualifiedName": "ConfigReference.mode", + "description": "Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes.", + "kind": "PropertyGetter", + "signature": "Mode() (*UnixFileMode, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*UnixFileMode, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetGid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setGid", + "qualifiedName": "ConfigReference.setGid", + "description": "Gets or sets the group ID (GID) used to identify the group of the referenced configuration.", + "remarks": "The GID is an optional integer parameter that specifies the group ownership\nfor the resource. If set, it defines the group to which the target resource belongs.", + "kind": "PropertySetter", + "signature": "SetGid(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the group ID (GID) used to identify the group of the referenced configuration." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setMode", + "qualifiedName": "ConfigReference.setMode", + "description": "Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes.", + "kind": "PropertySetter", + "signature": "SetMode(value *UnixFileMode) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*UnixFileMode", + "description": "Represents the access mode for the configuration reference in the form of an integer value. This property determines the permissions or access level for the configuration being referenced. Typical values might correspond to standard file permission modes." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setSource", + "qualifiedName": "ConfigReference.setSource", + "description": "Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node.", + "kind": "PropertySetter", + "signature": "SetSource(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetTarget", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setTarget", + "qualifiedName": "ConfigReference.setTarget", + "description": "Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service.", + "kind": "PropertySetter", + "signature": "SetTarget(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "SetUid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.setUid", + "qualifiedName": "ConfigReference.setUid", + "description": "Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target.", + "kind": "PropertySetter", + "signature": "SetUid(value *string) ConfigReference", + "receiver": "ConfigReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target." + } + ], + "returnType": "ConfigReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.source", + "qualifiedName": "ConfigReference.source", + "description": "Gets or sets the source configuration reference. This property specifies the origin of the configuration file or data required by the service node.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.target", + "qualifiedName": "ConfigReference.target", + "description": "Specifies the target location where the referenced configuration data will be applied or mounted in the context of the Docker service.", + "kind": "PropertyGetter", + "signature": "Target() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + }, + { + "name": "Uid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/ConfigReference.uid", + "qualifiedName": "ConfigReference.uid", + "description": "Gets or sets the user identifier (UID) associated with the configuration reference. Optional property that specifies the user ID for accessing the configuration target.", + "kind": "PropertyGetter", + "signature": "Uid() (*string, error)", + "receiver": "ConfigReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.ConfigReference" + ], + "appliesTo": [ + "ConfigReference" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "SecretReference", + "fullName": "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "kind": "handle", + "description": "Represents a reference to a secret within a Docker service configuration.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Gid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.gid", + "qualifiedName": "SecretReference.gid", + "description": "Represents the group ID (GID) associated with the secret reference in a Docker service node.", + "remarks": "This property defines the group ID of the user for accessing the secret. It is optional and may be null if not specified.", + "kind": "PropertyGetter", + "signature": "Gid() (*float64, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Mode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.mode", + "qualifiedName": "SecretReference.mode", + "description": "Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value.", + "kind": "PropertyGetter", + "signature": "Mode() (*float64, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetGid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setGid", + "qualifiedName": "SecretReference.setGid", + "description": "Represents the group ID (GID) associated with the secret reference in a Docker service node.", + "remarks": "This property defines the group ID of the user for accessing the secret. It is optional and may be null if not specified.", + "kind": "PropertySetter", + "signature": "SetGid(value *float64) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Represents the group ID (GID) associated with the secret reference in a Docker service node." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetMode", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setMode", + "qualifiedName": "SecretReference.setMode", + "description": "Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value.", + "kind": "PropertySetter", + "signature": "SetMode(value *float64) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the file mode for the secret reference. The mode defines the file permissions that will be applied to the secret when mounted. This is represented as an integer value." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setSource", + "qualifiedName": "SecretReference.setSource", + "description": "Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived.", + "kind": "PropertySetter", + "signature": "SetSource(value *string) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetTarget", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setTarget", + "qualifiedName": "SecretReference.setTarget", + "description": "Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system.", + "kind": "PropertySetter", + "signature": "SetTarget(value *string) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "SetUid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.setUid", + "qualifiedName": "SecretReference.setUid", + "description": "Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container.", + "kind": "PropertySetter", + "signature": "SetUid(value *float64) SecretReference", + "receiver": "SecretReference", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container." + } + ], + "returnType": "SecretReference", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.source", + "qualifiedName": "SecretReference.source", + "description": "Gets or sets the name of the source secret reference. This property is used to specify the source from which a secret or configuration is derived.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.target", + "qualifiedName": "SecretReference.target", + "description": "Gets or sets the target path where the secret will be mounted within the container. This path is used to specify the destination location of the secret in the container's file system.", + "kind": "PropertyGetter", + "signature": "Target() (*string, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + }, + { + "name": "Uid", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/SecretReference.uid", + "qualifiedName": "SecretReference.uid", + "description": "Gets or sets the user ID (UID) associated with the secret reference. This property allows specifying the UID that will be assigned to the secret when it is mounted within a container.", + "kind": "PropertyGetter", + "signature": "Uid() (*float64, error)", + "receiver": "SecretReference", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.SecretReference" + ], + "appliesTo": [ + "SecretReference" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Ulimit", + "fullName": "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "kind": "handle", + "description": "Represents the configuration for system resource limits (ulimits) for a container.", + "remarks": "This class is typically used to specify soft and hard limits for resources\nsuch as file descriptors or process count for Docker containers.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Hard", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.hard", + "qualifiedName": "Ulimit.hard", + "description": "Gets or sets the hard limit for the resource control.", + "remarks": "The hard limit defines the maximum value that cannot be exceeded.\nIt is usually set by an administrator and imposes a strict upper boundary.\nThis property can be null, indicating no hard limit is set.", + "kind": "PropertyGetter", + "signature": "Hard() (*float64, error)", + "receiver": "Ulimit", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "SetHard", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.setHard", + "qualifiedName": "Ulimit.setHard", + "description": "Gets or sets the hard limit for the resource control.", + "remarks": "The hard limit defines the maximum value that cannot be exceeded.\nIt is usually set by an administrator and imposes a strict upper boundary.\nThis property can be null, indicating no hard limit is set.", + "kind": "PropertySetter", + "signature": "SetHard(value *float64) Ulimit", + "receiver": "Ulimit", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Gets or sets the hard limit for the resource control." + } + ], + "returnType": "Ulimit", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "SetSoft", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.setSoft", + "qualifiedName": "Ulimit.setSoft", + "description": "Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set.", + "kind": "PropertySetter", + "signature": "SetSoft(value *float64) Ulimit", + "receiver": "Ulimit", + "parameters": [ + { + "name": "value", + "type": "*float64", + "description": "Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set." + } + ], + "returnType": "Ulimit", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + }, + { + "name": "Soft", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Ulimit.soft", + "qualifiedName": "Ulimit.soft", + "description": "Defines the soft limit for the Ulimit configuration. The soft limit is the value for resource restrictions that a process is allowed to increase up to the hard limit. This property is nullable, which indicates that this configuration might not be set.", + "kind": "PropertyGetter", + "signature": "Soft() (*float64, error)", + "receiver": "Ulimit", + "parameters": [], + "returnType": "(*float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Ulimit" + ], + "appliesTo": [ + "Ulimit" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "Volume", + "fullName": "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "kind": "handle", + "description": "Represents a volume definition in a Docker Compose configuration file.", + "remarks": "The `Volume` class is used to define properties and options for volumes in a Docker environment.\nVolumes are used to persist data beyond the lifecycle of a container and can be shared among multiple containers.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Driver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.driver", + "qualifiedName": "Volume.driver", + "description": "Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend.", + "kind": "PropertyGetter", + "signature": "Driver() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "DriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.driverOpts", + "qualifiedName": "Volume.driverOpts", + "description": "Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used.", + "kind": "PropertyGetter", + "signature": "DriverOpts() *Dict[string, string]", + "receiver": "Volume", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "External", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.external", + "qualifiedName": "Volume.external", + "description": "Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior.", + "kind": "PropertyGetter", + "signature": "External() (*bool, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Labels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.labels", + "qualifiedName": "Volume.labels", + "description": "Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services.", + "kind": "PropertyGetter", + "signature": "Labels() *Dict[string, string]", + "receiver": "Volume", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Name", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.name", + "qualifiedName": "Volume.name", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertyGetter", + "signature": "Name() (string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "ReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.readOnly", + "qualifiedName": "Volume.readOnly", + "description": "Gets or sets a value indicating whether the volume is mounted as read-only.", + "remarks": "When set to true, the volume will be mounted with read-only permissions, preventing modification\nof the data within the container. This is commonly used to enforce data immutability for certain use cases.", + "kind": "PropertyGetter", + "signature": "ReadOnly() (*bool, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetDriver", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setDriver", + "qualifiedName": "Volume.setDriver", + "description": "Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend.", + "kind": "PropertySetter", + "signature": "SetDriver(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the name of the driver used for the volume. The driver is responsible for managing the volume and its storage backend." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetDriverOpts", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setDriverOpts", + "qualifiedName": "Volume.setDriverOpts", + "description": "Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used.", + "kind": "PropertySetter", + "signature": "SetDriverOpts(value *Dict[string, string]) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Represents a collection of driver-specific options for the volume. These options are passed as key-value pairs to the volume driver, allowing customization or configuration specific to the driver being used." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetExternal", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setExternal", + "qualifiedName": "Volume.setExternal", + "description": "Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior.", + "kind": "PropertySetter", + "signature": "SetExternal(value *bool) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Indicates whether the volume is external to the current scope or environment. A value of `true` specifies that the volume is managed outside the scope of the current application or configuration. A value of `false`, or a null value, indicates that the volume is managed internally or by default behavior." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetLabels", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setLabels", + "qualifiedName": "Volume.setLabels", + "description": "Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services.", + "kind": "PropertySetter", + "signature": "SetLabels(value *Dict[string, string]) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*Dict[string, string]", + "description": "Gets or sets a dictionary of labels associated with the volume. Labels are key-value pairs that can be used for metadata purposes or for organizing and identifying volumes within Docker services." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetName", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setName", + "qualifiedName": "Volume.setName", + "description": "Gets or sets the name of the Docker Compose member.", + "remarks": "This property is used to uniquely identify the member (e.g., network, service) within\nthe Docker Compose configuration. It must be explicitly defined for all derived types.", + "kind": "PropertySetter", + "signature": "SetName(value string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the Docker Compose member." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetReadOnly", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setReadOnly", + "qualifiedName": "Volume.setReadOnly", + "description": "Gets or sets a value indicating whether the volume is mounted as read-only.", + "remarks": "When set to true, the volume will be mounted with read-only permissions, preventing modification\nof the data within the container. This is commonly used to enforce data immutability for certain use cases.", + "kind": "PropertySetter", + "signature": "SetReadOnly(value *bool) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*bool", + "description": "Gets or sets a value indicating whether the volume is mounted as read-only." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetSource", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setSource", + "qualifiedName": "Volume.setSource", + "description": "Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced.", + "kind": "PropertySetter", + "signature": "SetSource(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetTarget", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setTarget", + "qualifiedName": "Volume.setTarget", + "description": "Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data.", + "kind": "PropertySetter", + "signature": "SetTarget(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "SetType", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.setType", + "qualifiedName": "Volume.setType", + "description": "Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker.", + "kind": "PropertySetter", + "signature": "SetType(value *string) Volume", + "receiver": "Volume", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker." + } + ], + "returnType": "Volume", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Source", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.source", + "qualifiedName": "Volume.source", + "description": "Gets or sets the source property of the volume. The source defines the location on the host system or the specific resource from which the volume is sourced.", + "kind": "PropertyGetter", + "signature": "Source() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Target", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.target", + "qualifiedName": "Volume.target", + "description": "Gets or sets the target path inside the container where the volume is mounted. This specifies the container location for the volume's data.", + "kind": "PropertyGetter", + "signature": "Target() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + }, + { + "name": "Type", + "capabilityId": "Aspire.Hosting.Docker.Resources.ServiceNodes/Volume.type", + "qualifiedName": "Volume.type", + "description": "Gets or sets the type of volume. This specifies the method of volume provisioning such as bind mounts, named volumes, or other supported volume types in Docker.", + "kind": "PropertyGetter", + "signature": "Type() (*string, error)", + "receiver": "Volume", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Docker/Aspire.Hosting.Docker.Resources.ServiceNodes.Volume", + "expandedTargetTypes": [ + "Aspire.Hosting.Docker.Resources.ServiceNodes.Volume" + ], + "appliesTo": [ + "Volume" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Dotnet.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Dotnet.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..d534c9107b --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Dotnet.13.6.0-preview.1.26478.8.json @@ -0,0 +1,315 @@ +{ + "package": { + "name": "Aspire.Hosting.Dotnet", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddDotnetProject", + "capabilityId": "Aspire.Hosting.Dotnet/addDotnetProject", + "qualifiedName": "addDotnetProject", + "description": "Adds a C# application resource.", + "kind": "Method", + "signature": "AddDotnetProject(name string, path string, options ...*DotnetProjectOptions) DotnetProjectResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "path", + "type": "string" + } + ], + "options": { + "typeName": "DotnetProjectOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "DotnetProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "DisableForwardedHeaders", + "capabilityId": "Aspire.Hosting.Dotnet/disableDotnetProjectForwardedHeaders", + "qualifiedName": "disableForwardedHeaders", + "description": "Disables forwarded headers for a .NET project in polyglot AppHosts.", + "kind": "Method", + "signature": "DisableForwardedHeaders() DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithBuildEnvironment", + "capabilityId": "Aspire.Hosting.Dotnet/withBuildEnvironment", + "qualifiedName": "withBuildEnvironment", + "description": "Adds an environment variable to the build process for a .NET project.", + "remarks": "This method supports project files (`.csproj`) only. File-based C# apps (`.cs`) do not support\nbuild-only environment variables.\nThe variable is available while Aspire builds the project but is not added to the environment of the\nlaunched project. Use `WithEnvironment` separately when the same variable is also needed at runtime.\nConfiguring a build environment causes Aspire to build this project separately from traversal groups.\nWhen publishing a container, do not use this API to set MSBuild properties that control the output artifact's\nidentity, destination, format, or target platform. Aspire rejects those properties because downstream\npublishing steps use the values configured with `WithContainerBuildOptions`.\nDo not use this API for secrets. Aspire must carry the value in IDE launch metadata and process environments,\nand the value can appear in build diagnostics. Protected temporary MSBuild response files preserve\nglobal-property semantics without exposing values in process command lines, but they are not a general-purpose\nsecret transport.", + "returns": "A reference to the `IResourceBuilder`1` for chaining additional configuration.", + "kind": "Method", + "signature": "WithBuildEnvironment(name string, value string) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the environment variable." + }, + { + "name": "value", + "type": "string", + "description": "The value of the environment variable." + } + ], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithEndpointsInEnvironment", + "capabilityId": "Aspire.Hosting.Dotnet/withDotnetProjectEndpointsInEnvironment", + "qualifiedName": "withEndpointsInEnvironment", + "description": "Configures endpoint environment-variable injection for a .NET project in polyglot AppHosts.", + "kind": "Method", + "signature": "WithEndpointsInEnvironment(endpointNames []string) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "endpointNames", + "type": "[]string" + } + ], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithReplicas", + "capabilityId": "Aspire.Hosting.Dotnet/withDotnetProjectReplicas", + "qualifiedName": "withReplicas", + "description": "Configures the number of .NET project replicas for polyglot AppHosts.", + "kind": "Method", + "signature": "WithReplicas(replicas float64) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "replicas", + "type": "float64" + } + ], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + } + ], + "handleTypes": [ + { + "name": "DotnetProjectResource", + "fullName": "Aspire.Hosting.Dotnet.DotnetProjectResource", + "kind": "handle", + "description": "A resource that represents a specified C# project or file-based app added by path.", + "remarks": "A `DotnetProjectResource` is added by path and is\nlaunched as an executable: `dotnet run --project ` for a project file, or\n`dotnet run --file ` for a file-based app (a `.cs` file).\nResources created by `AddDotnetProject` support the same .NET SDK container-publishing pipeline as\nresources created by `AddProject`. A directly constructed resource must be given project metadata and\nexplicitly configured for publishing by its builder.", + "implementedInterfaces": [ + "DotnetProgramResource", + "IComputeResource", + "IContainerFilesDestinationResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "DisableForwardedHeaders", + "capabilityId": "Aspire.Hosting.Dotnet/disableDotnetProjectForwardedHeaders", + "qualifiedName": "disableForwardedHeaders", + "description": "Disables forwarded headers for a .NET project in polyglot AppHosts.", + "kind": "Method", + "signature": "DisableForwardedHeaders() DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithBuildEnvironment", + "capabilityId": "Aspire.Hosting.Dotnet/withBuildEnvironment", + "qualifiedName": "withBuildEnvironment", + "description": "Adds an environment variable to the build process for a .NET project.", + "remarks": "This method supports project files (`.csproj`) only. File-based C# apps (`.cs`) do not support\nbuild-only environment variables.\nThe variable is available while Aspire builds the project but is not added to the environment of the\nlaunched project. Use `WithEnvironment` separately when the same variable is also needed at runtime.\nConfiguring a build environment causes Aspire to build this project separately from traversal groups.\nWhen publishing a container, do not use this API to set MSBuild properties that control the output artifact's\nidentity, destination, format, or target platform. Aspire rejects those properties because downstream\npublishing steps use the values configured with `WithContainerBuildOptions`.\nDo not use this API for secrets. Aspire must carry the value in IDE launch metadata and process environments,\nand the value can appear in build diagnostics. Protected temporary MSBuild response files preserve\nglobal-property semantics without exposing values in process command lines, but they are not a general-purpose\nsecret transport.", + "returns": "A reference to the `IResourceBuilder`1` for chaining additional configuration.", + "kind": "Method", + "signature": "WithBuildEnvironment(name string, value string) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the environment variable." + }, + { + "name": "value", + "type": "string", + "description": "The value of the environment variable." + } + ], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithEndpointsInEnvironment", + "capabilityId": "Aspire.Hosting.Dotnet/withDotnetProjectEndpointsInEnvironment", + "qualifiedName": "withEndpointsInEnvironment", + "description": "Configures endpoint environment-variable injection for a .NET project in polyglot AppHosts.", + "kind": "Method", + "signature": "WithEndpointsInEnvironment(endpointNames []string) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "endpointNames", + "type": "[]string" + } + ], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + }, + { + "name": "WithReplicas", + "capabilityId": "Aspire.Hosting.Dotnet/withDotnetProjectReplicas", + "qualifiedName": "withReplicas", + "description": "Configures the number of .NET project replicas for polyglot AppHosts.", + "kind": "Method", + "signature": "WithReplicas(replicas float64) DotnetProjectResource", + "receiver": "DotnetProjectResource", + "parameters": [ + { + "name": "replicas", + "type": "float64" + } + ], + "returnType": "DotnetProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Dotnet/Aspire.Hosting.Dotnet.DotnetProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Dotnet.DotnetProjectResource" + ], + "appliesTo": [ + "DotnetProjectResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "DotnetProjectOptions", + "fullName": "Aspire.Hosting.Dotnet.DotnetProjectOptions", + "kind": "dto", + "description": "Launch options for a .NET project in a polyglot AppHost.", + "fields": [ + { + "name": "LaunchProfileName", + "jsonName": "LaunchProfileName", + "type": "*string", + "isOptional": true, + "description": "The launch profile to use. If omitted or null, the default launch profile is used." + }, + { + "name": "ExcludeLaunchProfile", + "jsonName": "ExcludeLaunchProfile", + "type": "*bool", + "isOptional": true, + "description": "Whether to disable launch profiles. When true, the launch profile name is ignored." + }, + { + "name": "ExcludeKestrelEndpoints", + "jsonName": "ExcludeKestrelEndpoints", + "type": "*bool", + "isOptional": true, + "description": "Whether to ignore endpoints from Kestrel configuration." + } + ] + } + ], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.EntityFrameworkCore.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.EntityFrameworkCore.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..37305d74d6 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.EntityFrameworkCore.13.6.0-preview.1.26478.8.json @@ -0,0 +1,1427 @@ +{ + "package": { + "name": "Aspire.Hosting.EntityFrameworkCore", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "BundleBaseImage", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.bundleBaseImage", + "qualifiedName": "EFMigrationResource.bundleBaseImage", + "description": "Gets or sets the base container image for the migration bundle container.", + "remarks": "When set, this overrides the default base image selection entirely. Use this when the\ndefault image (derived from the project's target framework) isn't suitable — for example\nwhen targeting a preview SDK or a custom base image with extra dependencies.\nExample: `\"mcr.microsoft.com/dotnet/runtime:11.0-preview\"`.", + "kind": "PropertyGetter", + "signature": "BundleBaseImage() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "BundleSelfContained", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.bundleSelfContained", + "qualifiedName": "EFMigrationResource.bundleSelfContained", + "description": "Gets or sets whether the migration bundle should be self-contained.", + "kind": "PropertyGetter", + "signature": "BundleSelfContained() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "BundleTargetRuntime", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.bundleTargetRuntime", + "qualifiedName": "EFMigrationResource.bundleTargetRuntime", + "description": "Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\").", + "kind": "PropertyGetter", + "signature": "BundleTargetRuntime() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "DbContextTypeName", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.dbContextTypeName", + "qualifiedName": "EFMigrationResource.dbContextTypeName", + "description": "Gets the fully qualified name of the DbContext type to use for migrations, or null to auto-detect.", + "remarks": "This property is used to specify which DbContext to use when the project contains multiple DbContext types.\nWhen null, the EF Core tools will auto-detect the DbContext to use.", + "kind": "PropertyGetter", + "signature": "DbContextTypeName() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "MigrationNamespace", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.migrationNamespace", + "qualifiedName": "EFMigrationResource.migrationNamespace", + "description": "Gets or sets the namespace for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, the namespace will be derived from the project's default namespace.", + "kind": "PropertyGetter", + "signature": "MigrationNamespace() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "MigrationOutputDirectory", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.migrationOutputDirectory", + "qualifiedName": "EFMigrationResource.migrationOutputDirectory", + "description": "Gets or sets the output directory for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, migrations will be placed in the default 'Migrations' directory.", + "kind": "PropertyGetter", + "signature": "MigrationOutputDirectory() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "MigrationsProjectPath", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.migrationsProjectPath", + "qualifiedName": "EFMigrationResource.migrationsProjectPath", + "description": "Gets or sets the path to the project containing the migrations, when it's not the same as the startup project.", + "remarks": "If not specified, migrations are assumed to be in the startup project.\nWhen specified, this project's path will be used as the target for migration operations.", + "kind": "PropertyGetter", + "signature": "MigrationsProjectPath() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "ProjectResource", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.projectResource", + "qualifiedName": "EFMigrationResource.projectResource", + "description": "Gets the parent project resource that contains the DbContext.", + "remarks": "This property is retained for compatibility with migration resources created from legacy\n`ProjectResource` instances. Use `StartupProjectResource` for resources created from\nany .NET program model.", + "kind": "PropertyGetter", + "signature": "ProjectResource() ProjectResource", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "ProjectResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "PublishBundleContainer", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.publishBundleContainer", + "qualifiedName": "EFMigrationResource.publishBundleContainer", + "description": "Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time.", + "remarks": "When `true`, the resource is materialized as a `ContainerResource`\ncarrying a generated `Dockerfile` that wraps the migration bundle. The compute environment\n(Docker Compose, Azure Container Apps, Kubernetes, Azure App Service, Azure Functions, etc.)\ndeploys it alongside the other compute resources and supplies the connection string from any\n`IResourceWithConnectionString` dependency declared via `WithReference` or\n`WaitFor`.", + "kind": "PropertyGetter", + "signature": "PublishBundleContainer() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "ScriptIdempotent", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.scriptIdempotent", + "qualifiedName": "EFMigrationResource.scriptIdempotent", + "description": "Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks).", + "kind": "PropertyGetter", + "signature": "ScriptIdempotent() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "ScriptNoTransactions", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.scriptNoTransactions", + "qualifiedName": "EFMigrationResource.scriptNoTransactions", + "description": "Gets or sets whether to omit transaction statements from the migration script.", + "kind": "PropertyGetter", + "signature": "ScriptNoTransactions() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetBundleBaseImage", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setBundleBaseImage", + "qualifiedName": "EFMigrationResource.setBundleBaseImage", + "description": "Gets or sets the base container image for the migration bundle container.", + "remarks": "When set, this overrides the default base image selection entirely. Use this when the\ndefault image (derived from the project's target framework) isn't suitable — for example\nwhen targeting a preview SDK or a custom base image with extra dependencies.\nExample: `\"mcr.microsoft.com/dotnet/runtime:11.0-preview\"`.", + "kind": "PropertySetter", + "signature": "SetBundleBaseImage(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the base container image for the migration bundle container." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetBundleSelfContained", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setBundleSelfContained", + "qualifiedName": "EFMigrationResource.setBundleSelfContained", + "description": "Gets or sets whether the migration bundle should be self-contained.", + "kind": "PropertySetter", + "signature": "SetBundleSelfContained(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the migration bundle should be self-contained." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetBundleTargetRuntime", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setBundleTargetRuntime", + "qualifiedName": "EFMigrationResource.setBundleTargetRuntime", + "description": "Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\").", + "kind": "PropertySetter", + "signature": "SetBundleTargetRuntime(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\")." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetMigrationNamespace", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setMigrationNamespace", + "qualifiedName": "EFMigrationResource.setMigrationNamespace", + "description": "Gets or sets the namespace for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, the namespace will be derived from the project's default namespace.", + "kind": "PropertySetter", + "signature": "SetMigrationNamespace(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the namespace for new migrations. Used by the Add Migration command." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetMigrationOutputDirectory", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setMigrationOutputDirectory", + "qualifiedName": "EFMigrationResource.setMigrationOutputDirectory", + "description": "Gets or sets the output directory for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, migrations will be placed in the default 'Migrations' directory.", + "kind": "PropertySetter", + "signature": "SetMigrationOutputDirectory(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the output directory for new migrations. Used by the Add Migration command." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetMigrationsProjectPath", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setMigrationsProjectPath", + "qualifiedName": "EFMigrationResource.setMigrationsProjectPath", + "description": "Gets or sets the path to the project containing the migrations, when it's not the same as the startup project.", + "remarks": "If not specified, migrations are assumed to be in the startup project.\nWhen specified, this project's path will be used as the target for migration operations.", + "kind": "PropertySetter", + "signature": "SetMigrationsProjectPath(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the path to the project containing the migrations, when it's not the same as the startup project." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetPublishBundleContainer", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setPublishBundleContainer", + "qualifiedName": "EFMigrationResource.setPublishBundleContainer", + "description": "Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time.", + "remarks": "When `true`, the resource is materialized as a `ContainerResource`\ncarrying a generated `Dockerfile` that wraps the migration bundle. The compute environment\n(Docker Compose, Azure Container Apps, Kubernetes, Azure App Service, Azure Functions, etc.)\ndeploys it alongside the other compute resources and supplies the connection string from any\n`IResourceWithConnectionString` dependency declared via `WithReference` or\n`WaitFor`.", + "kind": "PropertySetter", + "signature": "SetPublishBundleContainer(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetScriptIdempotent", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setScriptIdempotent", + "qualifiedName": "EFMigrationResource.setScriptIdempotent", + "description": "Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks).", + "kind": "PropertySetter", + "signature": "SetScriptIdempotent(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks)." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetScriptNoTransactions", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setScriptNoTransactions", + "qualifiedName": "EFMigrationResource.setScriptNoTransactions", + "description": "Gets or sets whether to omit transaction statements from the migration script.", + "kind": "PropertySetter", + "signature": "SetScriptNoTransactions(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether to omit transaction statements from the migration script." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "StartupProjectResource", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.startupProjectResource", + "qualifiedName": "EFMigrationResource.startupProjectResource", + "description": "Gets the startup .NET program resource that contains the DbContext configuration.", + "kind": "PropertyGetter", + "signature": "StartupProjectResource() DotnetProgramResource", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "DotnetProgramResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "AddEFMigrations", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/addEFMigrations", + "qualifiedName": "addEFMigrations", + "description": "Adds EF Core migration management for polyglot AppHosts.", + "kind": "Method", + "signature": "AddEFMigrations(name string, options ...*AddEFMigrationsOptions) EFMigrationResource", + "receiver": "DotnetProgramResource", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddEFMigrationsOptions", + "fields": [ + { + "name": "DbContextTypeName", + "jsonName": "dbContextTypeName", + "type": "*string" + } + ] + }, + "returnType": "EFMigrationResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IDotnetProgramResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource" + ], + "appliesTo": [ + "CSharpAppResource", + "ProjectResource" + ] + }, + { + "name": "PublishAsMigrationBundle", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/publishAsMigrationBundle", + "qualifiedName": "publishAsMigrationBundle", + "description": "Configures the EF migration resource to generate a migration bundle during publishing.", + "remarks": "During `aspire publish`, the bundle executable is written to the publish output directory\nunder the `efmigrations` folder. When `publishContainer` is\n`true`, Aspire also generates a `Dockerfile` that packages the bundle into\na container image; the container reads the connection string from a\n`ConnectionStrings__` environment variable injected automatically for a\n`IResourceWithConnectionString` that the migration resource references or waits on.\nThe startup project (the project on which `AddEFMigrations` was invoked) and the\nmigrations project (configured via `WithMigrationsProject`\nor `WithMigrationsProject``1`, if\ndifferent) must both list the target runtime in their `` MSBuild property.\nIf `publishContainer` = `true`, by default this means\nadding at minimum `linux-x64` to\nboth projects.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "PublishAsMigrationBundle(options ...*PublishAsMigrationBundleOptions) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "options": { + "typeName": "PublishAsMigrationBundleOptions", + "fields": [ + { + "name": "TargetRuntime", + "jsonName": "targetRuntime", + "type": "*string", + "description": "The target runtime identifier for the bundle (e.g., `linux-x64`, `win-x64`). If `null` and `publishContainer` is `true`, defaults to `linux-x64` to match the default Linux base container image used for the generated `Dockerfile`. If `null` and `publishContainer` is `false`, the bundle targets the runtime hosting `aspire publish`." + }, + { + "name": "SelfContained", + "jsonName": "selfContained", + "type": "*bool", + "description": "If `true`, creates a self-contained bundle that includes the .NET runtime." + }, + { + "name": "PublishContainer", + "jsonName": "publishContainer", + "type": "*bool", + "description": "If `true`, the bundle is published as a container image that applies migrations at deploy time. The resource becomes a compute resource; each target environment deploys it the same way it deploys any other container (supplying connection strings from referenced `IResourceWithConnectionString` dependencies via the standard `WithReference` mechanism)." + }, + { + "name": "BaseImage", + "jsonName": "baseImage", + "type": "*string", + "description": "Overrides the base container image for the generated `Dockerfile`. When `null` (the default), the image is derived from the project's target framework — for example, `mcr.microsoft.com/dotnet/runtime:10.0` for a `net10.0` framework-dependent bundle. Set this when the default is not suitable, e.g. for preview SDKs or custom base images. Only meaningful when `publishContainer` is `true`." + } + ] + }, + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "PublishAsMigrationScript", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/publishAsMigrationScript", + "qualifiedName": "publishAsMigrationScript", + "description": "Configures the EF migration resource to generate a migration script during publishing.", + "remarks": "During `aspire publish`, the generated SQL script is written to the publish output directory under\nthe `efmigrations` folder. The script is included as a deployment artifact, but it is not executed\nautomatically during deployment.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "PublishAsMigrationScript(options ...*PublishAsMigrationScriptOptions) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "options": { + "typeName": "PublishAsMigrationScriptOptions", + "fields": [ + { + "name": "Idempotent", + "jsonName": "idempotent", + "type": "*bool", + "description": "If `true` (the default), generates an idempotent script with `IF NOT EXISTS` checks so it can be safely re-run against a database that has already had some or all of the migrations applied." + }, + { + "name": "NoTransactions", + "jsonName": "noTransactions", + "type": "*bool", + "description": "If `true`, omits transaction statements from the script." + } + ] + }, + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "RunDatabaseUpdateOnStart", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/runDatabaseUpdateOnStart", + "qualifiedName": "runDatabaseUpdateOnStart", + "description": "Configures the EF migration resource to run database update when the AppHost starts.", + "remarks": "When enabled, migrations are applied during AppHost startup. This only affects local\nrun-mode execution. The migrations resource is not deployed with the app, so this method\nhas no effect during publish or deployment.\nA health check is automatically registered for this resource, allowing other resources to use\n`.WaitFor()` to wait until migrations complete before starting.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "RunDatabaseUpdateOnStart() EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "WithMigrationNamespace", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/withMigrationNamespace", + "qualifiedName": "withMigrationNamespace", + "description": "Configures the namespace for new migrations created with the Add Migration command.", + "remarks": "If not specified, the namespace will be derived from the project's default namespace.\nExample: `MyApp.Data.Migrations` or `MyApp.Infrastructure.Migrations`.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithMigrationNamespace(namespace string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "namespace", + "type": "string", + "description": "The namespace for generated migrations." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "WithMigrationOutputDirectory", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/withMigrationOutputDirectory", + "qualifiedName": "withMigrationOutputDirectory", + "description": "Configures the output directory for new migrations created with the Add Migration command.", + "remarks": "If not specified, migrations will be placed in the default `Migrations` directory.\nExample: `Data/Migrations` or `Infrastructure/Migrations`.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithMigrationOutputDirectory(outputDirectory string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "outputDirectory", + "type": "string", + "description": "The output directory path relative to the project root." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "WithMigrationsProject", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/withMigrationsProject", + "qualifiedName": "withMigrationsProject", + "description": "Configures a separate project containing migrations for polyglot AppHosts.", + "kind": "Method", + "signature": "WithMigrationsProject(options ...*WithMigrationsProjectOptions) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "options": { + "typeName": "WithMigrationsProjectOptions", + "fields": [ + { + "name": "MigrationsProject", + "jsonName": "migrationsProject", + "type": "any" + } + ] + }, + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + } + ], + "handleTypes": [ + { + "name": "EFMigrationResource", + "fullName": "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "kind": "handle", + "description": "Represents an EF Core migration resource associated with a project.", + "implementedInterfaces": [ + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "BundleBaseImage", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.bundleBaseImage", + "qualifiedName": "EFMigrationResource.bundleBaseImage", + "description": "Gets or sets the base container image for the migration bundle container.", + "remarks": "When set, this overrides the default base image selection entirely. Use this when the\ndefault image (derived from the project's target framework) isn't suitable — for example\nwhen targeting a preview SDK or a custom base image with extra dependencies.\nExample: `\"mcr.microsoft.com/dotnet/runtime:11.0-preview\"`.", + "kind": "PropertyGetter", + "signature": "BundleBaseImage() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "BundleSelfContained", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.bundleSelfContained", + "qualifiedName": "EFMigrationResource.bundleSelfContained", + "description": "Gets or sets whether the migration bundle should be self-contained.", + "kind": "PropertyGetter", + "signature": "BundleSelfContained() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "BundleTargetRuntime", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.bundleTargetRuntime", + "qualifiedName": "EFMigrationResource.bundleTargetRuntime", + "description": "Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\").", + "kind": "PropertyGetter", + "signature": "BundleTargetRuntime() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "DbContextTypeName", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.dbContextTypeName", + "qualifiedName": "EFMigrationResource.dbContextTypeName", + "description": "Gets the fully qualified name of the DbContext type to use for migrations, or null to auto-detect.", + "remarks": "This property is used to specify which DbContext to use when the project contains multiple DbContext types.\nWhen null, the EF Core tools will auto-detect the DbContext to use.", + "kind": "PropertyGetter", + "signature": "DbContextTypeName() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "MigrationNamespace", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.migrationNamespace", + "qualifiedName": "EFMigrationResource.migrationNamespace", + "description": "Gets or sets the namespace for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, the namespace will be derived from the project's default namespace.", + "kind": "PropertyGetter", + "signature": "MigrationNamespace() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "MigrationOutputDirectory", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.migrationOutputDirectory", + "qualifiedName": "EFMigrationResource.migrationOutputDirectory", + "description": "Gets or sets the output directory for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, migrations will be placed in the default 'Migrations' directory.", + "kind": "PropertyGetter", + "signature": "MigrationOutputDirectory() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "MigrationsProjectPath", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.migrationsProjectPath", + "qualifiedName": "EFMigrationResource.migrationsProjectPath", + "description": "Gets or sets the path to the project containing the migrations, when it's not the same as the startup project.", + "remarks": "If not specified, migrations are assumed to be in the startup project.\nWhen specified, this project's path will be used as the target for migration operations.", + "kind": "PropertyGetter", + "signature": "MigrationsProjectPath() (*string, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "ProjectResource", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.projectResource", + "qualifiedName": "EFMigrationResource.projectResource", + "description": "Gets the parent project resource that contains the DbContext.", + "remarks": "This property is retained for compatibility with migration resources created from legacy\n`ProjectResource` instances. Use `StartupProjectResource` for resources created from\nany .NET program model.", + "kind": "PropertyGetter", + "signature": "ProjectResource() ProjectResource", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "ProjectResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "PublishBundleContainer", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.publishBundleContainer", + "qualifiedName": "EFMigrationResource.publishBundleContainer", + "description": "Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time.", + "remarks": "When `true`, the resource is materialized as a `ContainerResource`\ncarrying a generated `Dockerfile` that wraps the migration bundle. The compute environment\n(Docker Compose, Azure Container Apps, Kubernetes, Azure App Service, Azure Functions, etc.)\ndeploys it alongside the other compute resources and supplies the connection string from any\n`IResourceWithConnectionString` dependency declared via `WithReference` or\n`WaitFor`.", + "kind": "PropertyGetter", + "signature": "PublishBundleContainer() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "ScriptIdempotent", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.scriptIdempotent", + "qualifiedName": "EFMigrationResource.scriptIdempotent", + "description": "Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks).", + "kind": "PropertyGetter", + "signature": "ScriptIdempotent() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "ScriptNoTransactions", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.scriptNoTransactions", + "qualifiedName": "EFMigrationResource.scriptNoTransactions", + "description": "Gets or sets whether to omit transaction statements from the migration script.", + "kind": "PropertyGetter", + "signature": "ScriptNoTransactions() (bool, error)", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "(bool, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetBundleBaseImage", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setBundleBaseImage", + "qualifiedName": "EFMigrationResource.setBundleBaseImage", + "description": "Gets or sets the base container image for the migration bundle container.", + "remarks": "When set, this overrides the default base image selection entirely. Use this when the\ndefault image (derived from the project's target framework) isn't suitable — for example\nwhen targeting a preview SDK or a custom base image with extra dependencies.\nExample: `\"mcr.microsoft.com/dotnet/runtime:11.0-preview\"`.", + "kind": "PropertySetter", + "signature": "SetBundleBaseImage(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the base container image for the migration bundle container." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetBundleSelfContained", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setBundleSelfContained", + "qualifiedName": "EFMigrationResource.setBundleSelfContained", + "description": "Gets or sets whether the migration bundle should be self-contained.", + "kind": "PropertySetter", + "signature": "SetBundleSelfContained(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the migration bundle should be self-contained." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetBundleTargetRuntime", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setBundleTargetRuntime", + "qualifiedName": "EFMigrationResource.setBundleTargetRuntime", + "description": "Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\").", + "kind": "PropertySetter", + "signature": "SetBundleTargetRuntime(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the target runtime identifier for the migration bundle (e.g., \"linux-x64\", \"win-x64\")." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetMigrationNamespace", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setMigrationNamespace", + "qualifiedName": "EFMigrationResource.setMigrationNamespace", + "description": "Gets or sets the namespace for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, the namespace will be derived from the project's default namespace.", + "kind": "PropertySetter", + "signature": "SetMigrationNamespace(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the namespace for new migrations. Used by the Add Migration command." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetMigrationOutputDirectory", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setMigrationOutputDirectory", + "qualifiedName": "EFMigrationResource.setMigrationOutputDirectory", + "description": "Gets or sets the output directory for new migrations. Used by the Add Migration command.", + "remarks": "If not specified, migrations will be placed in the default 'Migrations' directory.", + "kind": "PropertySetter", + "signature": "SetMigrationOutputDirectory(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the output directory for new migrations. Used by the Add Migration command." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetMigrationsProjectPath", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setMigrationsProjectPath", + "qualifiedName": "EFMigrationResource.setMigrationsProjectPath", + "description": "Gets or sets the path to the project containing the migrations, when it's not the same as the startup project.", + "remarks": "If not specified, migrations are assumed to be in the startup project.\nWhen specified, this project's path will be used as the target for migration operations.", + "kind": "PropertySetter", + "signature": "SetMigrationsProjectPath(value *string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the path to the project containing the migrations, when it's not the same as the startup project." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetPublishBundleContainer", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setPublishBundleContainer", + "qualifiedName": "EFMigrationResource.setPublishBundleContainer", + "description": "Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time.", + "remarks": "When `true`, the resource is materialized as a `ContainerResource`\ncarrying a generated `Dockerfile` that wraps the migration bundle. The compute environment\n(Docker Compose, Azure Container Apps, Kubernetes, Azure App Service, Azure Functions, etc.)\ndeploys it alongside the other compute resources and supplies the connection string from any\n`IResourceWithConnectionString` dependency declared via `WithReference` or\n`WaitFor`.", + "kind": "PropertySetter", + "signature": "SetPublishBundleContainer(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the migration bundle should be published as a container image that applies the migrations to the database at deploy time." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetScriptIdempotent", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setScriptIdempotent", + "qualifiedName": "EFMigrationResource.setScriptIdempotent", + "description": "Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks).", + "kind": "PropertySetter", + "signature": "SetScriptIdempotent(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether the migration script should be idempotent (include IF NOT EXISTS checks)." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "SetScriptNoTransactions", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.setScriptNoTransactions", + "qualifiedName": "EFMigrationResource.setScriptNoTransactions", + "description": "Gets or sets whether to omit transaction statements from the migration script.", + "kind": "PropertySetter", + "signature": "SetScriptNoTransactions(value bool) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "value", + "type": "bool", + "description": "Gets or sets whether to omit transaction statements from the migration script." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "StartupProjectResource", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/EFMigrationResource.startupProjectResource", + "qualifiedName": "EFMigrationResource.startupProjectResource", + "description": "Gets the startup .NET program resource that contains the DbContext configuration.", + "kind": "PropertyGetter", + "signature": "StartupProjectResource() DotnetProgramResource", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "DotnetProgramResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "PublishAsMigrationBundle", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/publishAsMigrationBundle", + "qualifiedName": "publishAsMigrationBundle", + "description": "Configures the EF migration resource to generate a migration bundle during publishing.", + "remarks": "During `aspire publish`, the bundle executable is written to the publish output directory\nunder the `efmigrations` folder. When `publishContainer` is\n`true`, Aspire also generates a `Dockerfile` that packages the bundle into\na container image; the container reads the connection string from a\n`ConnectionStrings__` environment variable injected automatically for a\n`IResourceWithConnectionString` that the migration resource references or waits on.\nThe startup project (the project on which `AddEFMigrations` was invoked) and the\nmigrations project (configured via `WithMigrationsProject`\nor `WithMigrationsProject``1`, if\ndifferent) must both list the target runtime in their `` MSBuild property.\nIf `publishContainer` = `true`, by default this means\nadding at minimum `linux-x64` to\nboth projects.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "PublishAsMigrationBundle(options ...*PublishAsMigrationBundleOptions) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "options": { + "typeName": "PublishAsMigrationBundleOptions", + "fields": [ + { + "name": "TargetRuntime", + "jsonName": "targetRuntime", + "type": "*string", + "description": "The target runtime identifier for the bundle (e.g., `linux-x64`, `win-x64`). If `null` and `publishContainer` is `true`, defaults to `linux-x64` to match the default Linux base container image used for the generated `Dockerfile`. If `null` and `publishContainer` is `false`, the bundle targets the runtime hosting `aspire publish`." + }, + { + "name": "SelfContained", + "jsonName": "selfContained", + "type": "*bool", + "description": "If `true`, creates a self-contained bundle that includes the .NET runtime." + }, + { + "name": "PublishContainer", + "jsonName": "publishContainer", + "type": "*bool", + "description": "If `true`, the bundle is published as a container image that applies migrations at deploy time. The resource becomes a compute resource; each target environment deploys it the same way it deploys any other container (supplying connection strings from referenced `IResourceWithConnectionString` dependencies via the standard `WithReference` mechanism)." + }, + { + "name": "BaseImage", + "jsonName": "baseImage", + "type": "*string", + "description": "Overrides the base container image for the generated `Dockerfile`. When `null` (the default), the image is derived from the project's target framework — for example, `mcr.microsoft.com/dotnet/runtime:10.0` for a `net10.0` framework-dependent bundle. Set this when the default is not suitable, e.g. for preview SDKs or custom base images. Only meaningful when `publishContainer` is `true`." + } + ] + }, + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "PublishAsMigrationScript", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/publishAsMigrationScript", + "qualifiedName": "publishAsMigrationScript", + "description": "Configures the EF migration resource to generate a migration script during publishing.", + "remarks": "During `aspire publish`, the generated SQL script is written to the publish output directory under\nthe `efmigrations` folder. The script is included as a deployment artifact, but it is not executed\nautomatically during deployment.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "PublishAsMigrationScript(options ...*PublishAsMigrationScriptOptions) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "options": { + "typeName": "PublishAsMigrationScriptOptions", + "fields": [ + { + "name": "Idempotent", + "jsonName": "idempotent", + "type": "*bool", + "description": "If `true` (the default), generates an idempotent script with `IF NOT EXISTS` checks so it can be safely re-run against a database that has already had some or all of the migrations applied." + }, + { + "name": "NoTransactions", + "jsonName": "noTransactions", + "type": "*bool", + "description": "If `true`, omits transaction statements from the script." + } + ] + }, + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "RunDatabaseUpdateOnStart", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/runDatabaseUpdateOnStart", + "qualifiedName": "runDatabaseUpdateOnStart", + "description": "Configures the EF migration resource to run database update when the AppHost starts.", + "remarks": "When enabled, migrations are applied during AppHost startup. This only affects local\nrun-mode execution. The migrations resource is not deployed with the app, so this method\nhas no effect during publish or deployment.\nA health check is automatically registered for this resource, allowing other resources to use\n`.WaitFor()` to wait until migrations complete before starting.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "RunDatabaseUpdateOnStart() EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "WithMigrationNamespace", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/withMigrationNamespace", + "qualifiedName": "withMigrationNamespace", + "description": "Configures the namespace for new migrations created with the Add Migration command.", + "remarks": "If not specified, the namespace will be derived from the project's default namespace.\nExample: `MyApp.Data.Migrations` or `MyApp.Infrastructure.Migrations`.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithMigrationNamespace(namespace string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "namespace", + "type": "string", + "description": "The namespace for generated migrations." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "WithMigrationOutputDirectory", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/withMigrationOutputDirectory", + "qualifiedName": "withMigrationOutputDirectory", + "description": "Configures the output directory for new migrations created with the Add Migration command.", + "remarks": "If not specified, migrations will be placed in the default `Migrations` directory.\nExample: `Data/Migrations` or `Infrastructure/Migrations`.", + "returns": "The resource builder for chaining.", + "kind": "Method", + "signature": "WithMigrationOutputDirectory(outputDirectory string) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [ + { + "name": "outputDirectory", + "type": "string", + "description": "The output directory path relative to the project root." + } + ], + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + }, + { + "name": "WithMigrationsProject", + "capabilityId": "Aspire.Hosting.EntityFrameworkCore/withMigrationsProject", + "qualifiedName": "withMigrationsProject", + "description": "Configures a separate project containing migrations for polyglot AppHosts.", + "kind": "Method", + "signature": "WithMigrationsProject(options ...*WithMigrationsProjectOptions) EFMigrationResource", + "receiver": "EFMigrationResource", + "parameters": [], + "options": { + "typeName": "WithMigrationsProjectOptions", + "fields": [ + { + "name": "MigrationsProject", + "jsonName": "migrationsProject", + "type": "any" + } + ] + }, + "returnType": "EFMigrationResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.EntityFrameworkCore/Aspire.Hosting.EntityFrameworkCore.EFMigrationResource", + "expandedTargetTypes": [ + "Aspire.Hosting.EntityFrameworkCore.EFMigrationResource" + ], + "appliesTo": [ + "EFMigrationResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Foundry.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Foundry.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..b7cfbb8539 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Foundry.13.6.0-preview.1.26478.8.json @@ -0,0 +1,6081 @@ +{ + "package": { + "name": "Aspire.Hosting.Foundry", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.connectionStringExpression", + "qualifiedName": "AzurePromptAgentResource.connectionStringExpression", + "description": "Gets the ConnectionStringExpression property", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.description", + "qualifiedName": "AzurePromptAgentResource.description", + "description": "Gets or sets a description of the agent.", + "kind": "PropertyGetter", + "signature": "Description() (string, error)", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Instructions", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.instructions", + "qualifiedName": "AzurePromptAgentResource.instructions", + "description": "Gets or sets the system instructions for the agent.", + "kind": "PropertyGetter", + "signature": "Instructions() (*string, error)", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Metadata", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.metadata", + "qualifiedName": "AzurePromptAgentResource.metadata", + "description": "Gets the metadata to associate with the agent.", + "kind": "PropertyGetter", + "signature": "Metadata() *Dict[string, string]", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.model", + "qualifiedName": "AzurePromptAgentResource.model", + "description": "Gets or sets the model deployment name used by this agent.", + "kind": "PropertyGetter", + "signature": "Model() (string, error)", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "SetDescription", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.setDescription", + "qualifiedName": "AzurePromptAgentResource.setDescription", + "description": "Gets or sets a description of the agent.", + "kind": "PropertySetter", + "signature": "SetDescription(value string) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets a description of the agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "SetInstructions", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.setInstructions", + "qualifiedName": "AzurePromptAgentResource.setInstructions", + "description": "Gets or sets the system instructions for the agent.", + "kind": "PropertySetter", + "signature": "SetInstructions(value *string) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the system instructions for the agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "SetModel", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.setModel", + "qualifiedName": "AzurePromptAgentResource.setModel", + "description": "Gets or sets the model deployment name used by this agent.", + "kind": "PropertySetter", + "signature": "SetModel(value string) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the model deployment name used by this agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.connectionStringExpression", + "qualifiedName": "FoundryDeploymentResource.connectionStringExpression", + "description": "Gets the connection string expression for the Microsoft Foundry resource with model/deployment information.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "DeploymentName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.deploymentName", + "qualifiedName": "FoundryDeploymentResource.deploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `ModelName`, but allows for a different deployment name in Azure.\nWhen using Foundry Local, this is the model id.", + "kind": "PropertyGetter", + "signature": "DeploymentName() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "Format", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.format", + "qualifiedName": "FoundryDeploymentResource.format", + "description": "Gets or sets the format of deployment model.", + "remarks": "Typical values are \"OpenAI\", \"Microsoft\", \"xAi\", \"Deepseek\".", + "kind": "PropertyGetter", + "signature": "Format() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "LocalModelId", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.localModelId", + "qualifiedName": "FoundryDeploymentResource.localModelId", + "description": "Gets or sets the model identifier used by Foundry Local.", + "remarks": "Aspire resolves this value automatically when it manages Foundry Local. Set it explicitly\nwhen connecting to an existing Foundry Local service and `ModelName` is an alias\nrather than the identifier reported by the service.", + "kind": "PropertyGetter", + "signature": "LocalModelId() (*string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "ModelName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.modelName", + "qualifiedName": "FoundryDeploymentResource.modelName", + "description": "Gets or sets the name of the model.", + "kind": "PropertyGetter", + "signature": "ModelName() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "ModelVersion", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.modelVersion", + "qualifiedName": "FoundryDeploymentResource.modelVersion", + "description": "Gets or sets the version of the model.", + "kind": "PropertyGetter", + "signature": "ModelVersion() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.parent", + "qualifiedName": "FoundryDeploymentResource.parent", + "description": "Gets the parent Microsoft Foundry resource.", + "kind": "PropertyGetter", + "signature": "Parent() FoundryResource", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "FoundryResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetDeploymentName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setDeploymentName", + "qualifiedName": "FoundryDeploymentResource.setDeploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `ModelName`, but allows for a different deployment name in Azure.\nWhen using Foundry Local, this is the model id.", + "kind": "PropertySetter", + "signature": "SetDeploymentName(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the deployment." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetFormat", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setFormat", + "qualifiedName": "FoundryDeploymentResource.setFormat", + "description": "Gets or sets the format of deployment model.", + "remarks": "Typical values are \"OpenAI\", \"Microsoft\", \"xAi\", \"Deepseek\".", + "kind": "PropertySetter", + "signature": "SetFormat(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the format of deployment model." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetLocalModelId", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setLocalModelId", + "qualifiedName": "FoundryDeploymentResource.setLocalModelId", + "description": "Gets or sets the model identifier used by Foundry Local.", + "remarks": "Aspire resolves this value automatically when it manages Foundry Local. Set it explicitly\nwhen connecting to an existing Foundry Local service and `ModelName` is an alias\nrather than the identifier reported by the service.", + "kind": "PropertySetter", + "signature": "SetLocalModelId(value *string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the model identifier used by Foundry Local." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetModelName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setModelName", + "qualifiedName": "FoundryDeploymentResource.setModelName", + "description": "Gets or sets the name of the model.", + "kind": "PropertySetter", + "signature": "SetModelName(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the model." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetModelVersion", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setModelVersion", + "qualifiedName": "FoundryDeploymentResource.setModelVersion", + "description": "Gets or sets the version of the model.", + "kind": "PropertySetter", + "signature": "SetModelVersion(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the version of the model." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetParent", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setParent", + "qualifiedName": "FoundryDeploymentResource.setParent", + "description": "Gets the parent Microsoft Foundry resource.", + "kind": "PropertySetter", + "signature": "SetParent(value FoundryResource) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "FoundryResource", + "description": "Gets the parent Microsoft Foundry resource." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetSkuCapacity", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setSkuCapacity", + "qualifiedName": "FoundryDeploymentResource.setSkuCapacity", + "description": "Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM).", + "remarks": "For example, a value of 10 means 10,000 tokens per minute. Exceeding this rate\nlimit results in HTTP 429 responses. See\nAzure AI quota management\nfor more information.", + "kind": "PropertySetter", + "signature": "SetSkuCapacity(value float64) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM)." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetSkuName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setSkuName", + "qualifiedName": "FoundryDeploymentResource.setSkuName", + "description": "Gets or sets the name of the SKU.", + "kind": "PropertySetter", + "signature": "SetSkuName(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the SKU." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SkuCapacity", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.skuCapacity", + "qualifiedName": "FoundryDeploymentResource.skuCapacity", + "description": "Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM).", + "remarks": "For example, a value of 10 means 10,000 tokens per minute. Exceeding this rate\nlimit results in HTTP 429 responses. See\nAzure AI quota management\nfor more information.", + "kind": "PropertyGetter", + "signature": "SkuCapacity() (float64, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SkuName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.skuName", + "qualifiedName": "FoundryDeploymentResource.skuName", + "description": "Gets or sets the name of the SKU.", + "kind": "PropertyGetter", + "signature": "SkuName() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "Cpu", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.cpu", + "qualifiedName": "HostedAgentConfiguration.cpu", + "description": "CPU allocation for each hosted agent instance, in vCPU cores.", + "kind": "PropertyGetter", + "signature": "Cpu() (float64, error)", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.description", + "qualifiedName": "HostedAgentConfiguration.description", + "description": "The description of the hosted agent.", + "kind": "PropertyGetter", + "signature": "Description() (string, error)", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "EnvironmentVariables", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.environmentVariables", + "qualifiedName": "HostedAgentConfiguration.environmentVariables", + "description": "Environment variables to set in the hosted agent container.", + "kind": "PropertyGetter", + "signature": "EnvironmentVariables() *Dict[string, string]", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "Memory", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.memory", + "qualifiedName": "HostedAgentConfiguration.memory", + "description": "Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation.", + "kind": "PropertyGetter", + "signature": "Memory() (float64, error)", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "Metadata", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.metadata", + "qualifiedName": "HostedAgentConfiguration.metadata", + "description": "Additional metadata to associate with the hosted agent.", + "kind": "PropertyGetter", + "signature": "Metadata() *Dict[string, string]", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "SetCpu", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.setCpu", + "qualifiedName": "HostedAgentConfiguration.setCpu", + "description": "CPU allocation for each hosted agent instance, in vCPU cores.", + "kind": "PropertySetter", + "signature": "SetCpu(value float64) HostedAgentConfiguration", + "receiver": "HostedAgentConfiguration", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "CPU allocation for each hosted agent instance, in vCPU cores." + } + ], + "returnType": "HostedAgentConfiguration", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "SetDescription", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.setDescription", + "qualifiedName": "HostedAgentConfiguration.setDescription", + "description": "The description of the hosted agent.", + "kind": "PropertySetter", + "signature": "SetDescription(value string) HostedAgentConfiguration", + "receiver": "HostedAgentConfiguration", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The description of the hosted agent." + } + ], + "returnType": "HostedAgentConfiguration", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "SetMemory", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.setMemory", + "qualifiedName": "HostedAgentConfiguration.setMemory", + "description": "Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation.", + "kind": "PropertySetter", + "signature": "SetMemory(value float64) HostedAgentConfiguration", + "receiver": "HostedAgentConfiguration", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation." + } + ], + "returnType": "HostedAgentConfiguration", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "AddAISearchTool", + "capabilityId": "Aspire.Hosting.Foundry/addAISearchTool", + "qualifiedName": "addAISearchTool", + "description": "Adds an Azure AI Search tool to a Microsoft Foundry project, enabling agents to ground their responses using data from an Azure AI Search index.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAISearchTool(name string, options ...*AddAISearchToolOptions) AzureAISearchToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "options": { + "typeName": "AddAISearchToolOptions", + "fields": [ + { + "name": "IndexName", + "jsonName": "indexName", + "type": "*string", + "description": "Optional name of the search index to query. If not specified, the agent must be told which index to use." + } + ] + }, + "returnType": "AzureAISearchToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddAzureFunctionTool", + "capabilityId": "Aspire.Hosting.Foundry/addAzureFunctionTool", + "qualifiedName": "addAzureFunctionTool", + "description": "Adds an Azure Function tool to a Microsoft Foundry project, enabling agents to invoke a serverless Azure Function with queue-based input/output bindings.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureFunctionTool(name string, functionName string, description string, parametersJson string, inputQueueEndpoint string, inputQueueName string, outputQueueEndpoint string, outputQueueName string) AzureFunctionToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "functionName", + "type": "string", + "description": "The name of the Azure Function." + }, + { + "name": "description", + "type": "string", + "description": "A description of what the function does." + }, + { + "name": "parametersJson", + "type": "string", + "description": "The JSON schema defining the function parameters as a JSON string." + }, + { + "name": "inputQueueEndpoint", + "type": "string", + "description": "The Azure Storage Queue endpoint for input binding." + }, + { + "name": "inputQueueName", + "type": "string", + "description": "The queue name for input binding." + }, + { + "name": "outputQueueEndpoint", + "type": "string", + "description": "The Azure Storage Queue endpoint for output binding." + }, + { + "name": "outputQueueName", + "type": "string", + "description": "The queue name for output binding." + } + ], + "returnType": "AzureFunctionToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddBingGroundingConnection", + "capabilityId": "Aspire.Hosting.Foundry/addBingGroundingConnection", + "qualifiedName": "addBingGroundingConnection", + "description": "Adds a Grounding with Bing Search connection to a Microsoft Foundry project.", + "remarks": "The Bing Search resource (`Microsoft.Bing/accounts`) cannot be provisioned through Aspire\nor Bicep. It must be created manually in the\nAzure portal.\nOnce the Bing resource exists, pass its resource ID to this method. The connection is\ncreated in the Foundry project using API key authentication with\n`category: \"ApiKey\"` and `metadata.Type: \"bing_grounding\"`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBingGroundingConnection(name string, bingResourceId string) BingGroundingConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the connection resource." + }, + { + "name": "bingResourceId", + "type": "string", + "description": "The full Azure resource ID of the Bing Search resource (e.g., `/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Bing/accounts/{name}`)." + } + ], + "returnType": "BingGroundingConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddBingGroundingConnectionFromParameter", + "capabilityId": "Aspire.Hosting.Foundry/addBingGroundingConnectionFromParameter", + "qualifiedName": "addBingGroundingConnectionFromParameter", + "description": "Adds a Grounding with Bing Search connection to a Microsoft Foundry project using a parameter resource for the Bing resource ID.", + "remarks": "This overload allows the Bing resource ID to be supplied as a parameter (e.g., from user secrets\nor configuration) rather than a hardcoded string. The parameter value is resolved at deployment time\nand embedded in the Bicep template.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBingGroundingConnectionFromParameter(name string, bingResourceId ParameterResource) BingGroundingConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the connection resource." + }, + { + "name": "bingResourceId", + "type": "ParameterResource", + "description": "A parameter resource containing the full Azure resource ID of the Bing Search resource." + } + ], + "returnType": "BingGroundingConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddBingGroundingTool", + "capabilityId": "Aspire.Hosting.Foundry/addBingGroundingTool", + "qualifiedName": "addBingGroundingTool", + "description": "Adds a Bing Grounding tool to a Microsoft Foundry project, enabling agents to ground their responses using Bing Search results.", + "remarks": "After creating the tool, call one of the `WithReference` overloads\nto link it to a Bing Search resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBingGroundingTool(name string) BingGroundingToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "BingGroundingToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddCapabilityHost", + "capabilityId": "Aspire.Hosting.Foundry/addCapabilityHostProject", + "qualifiedName": "addCapabilityHost", + "description": "Adds a capability host to the Microsoft Foundry project.", + "returns": "A reference to the project builder for chaining capability host configuration.", + "kind": "Method", + "signature": "AddCapabilityHost(name string) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the capability host." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddCodeInterpreterTool", + "capabilityId": "Aspire.Hosting.Foundry/addCodeInterpreterTool", + "qualifiedName": "addCodeInterpreterTool", + "description": "Adds a Code Interpreter tool to a Microsoft Foundry project, enabling agents to write and run Python code in a sandboxed environment for data analysis, math, and chart generation.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddCodeInterpreterTool(name string) CodeInterpreterToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "CodeInterpreterToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddComputerUseTool", + "capabilityId": "Aspire.Hosting.Foundry/addComputerUseTool", + "qualifiedName": "addComputerUseTool", + "description": "Adds a Computer Use tool to a Microsoft Foundry project, enabling agents to interact with a computer desktop by taking screenshots, moving the mouse, clicking, and typing.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddComputerUseTool(name string, options ...*AddComputerUseToolOptions) ComputerToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "options": { + "typeName": "AddComputerUseToolOptions", + "fields": [ + { + "name": "DisplayWidth", + "jsonName": "displayWidth", + "type": "*float64", + "description": "The width of the display in pixels." + }, + { + "name": "DisplayHeight", + "jsonName": "displayHeight", + "type": "*float64", + "description": "The height of the display in pixels." + }, + { + "name": "Environment", + "jsonName": "environment", + "type": "*string", + "description": "The environment identifier. Defaults to \"browser\"." + } + ] + }, + "returnType": "ComputerToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddConnection", + "capabilityId": "Aspire.Hosting.Foundry/addConnection", + "qualifiedName": "addConnection", + "description": "Adds a connection to a Microsoft Foundry project.", + "kind": "Method", + "signature": "AddConnection(resource any) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "resource", + "type": "any", + "allowedTypes": [ + "AzureCosmosDBResource", + "AzureStorageResource", + "AzureContainerRegistryResource", + "AzureKeyVaultResource" + ] + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddContainerRegistryConnection", + "capabilityId": "Aspire.Hosting.Foundry/addContainerRegistryConnection", + "qualifiedName": "addContainerRegistryConnection", + "description": "Adds a container registry connection to the Microsoft Foundry project.", + "kind": "Method", + "signature": "AddContainerRegistryConnection(registry AzureContainerRegistryResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "registry", + "type": "AzureContainerRegistryResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddCosmosConnection", + "capabilityId": "Aspire.Hosting.Foundry/addCosmosConnection", + "qualifiedName": "addCosmosConnection", + "description": "Adds CosmosDB to a project as a connection", + "kind": "Method", + "signature": "AddCosmosConnection(db AzureCosmosDBResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "db", + "type": "AzureCosmosDBResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddDeployment", + "capabilityId": "Aspire.Hosting.Foundry/addDeployment", + "qualifiedName": "addDeployment", + "description": "Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.", + "kind": "Method", + "signature": "AddDeployment(name string, model any, options ...*AddDeploymentOptions) FoundryDeploymentResource", + "receiver": "FoundryResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "model", + "type": "any", + "allowedTypes": [ + "*FoundryModel", + "string" + ] + } + ], + "options": { + "typeName": "AddDeploymentOptions", + "fields": [ + { + "name": "ModelVersion", + "jsonName": "modelVersion", + "type": "*string" + }, + { + "name": "Format", + "jsonName": "format", + "type": "*string" + } + ] + }, + "returnType": "FoundryDeploymentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryResource" + ], + "appliesTo": [ + "FoundryResource" + ] + }, + { + "name": "AddFabricTool", + "capabilityId": "Aspire.Hosting.Foundry/addFabricTool", + "qualifiedName": "addFabricTool", + "description": "Adds a Microsoft Fabric data agent tool to a Microsoft Foundry project, enabling agents to query data through Fabric data agents.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFabricTool(name string, projectConnectionIds []string) FabricToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "projectConnectionIds", + "type": "[]string", + "description": "The Foundry project connection IDs for the Fabric data agents." + } + ], + "returnType": "FabricToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddFileSearchTool", + "capabilityId": "Aspire.Hosting.Foundry/addFileSearchTool", + "qualifiedName": "addFileSearchTool", + "description": "Adds a File Search tool to a Microsoft Foundry project, enabling agents to search uploaded files and proprietary documents using vector search.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFileSearchTool(name string, vectorStoreIds []string) FileSearchToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "vectorStoreIds", + "type": "[]string", + "description": "Optional vector store IDs to search. If empty, the agent's default stores are used." + } + ], + "returnType": "FileSearchToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddFoundry", + "capabilityId": "Aspire.Hosting.Foundry/addFoundry", + "qualifiedName": "addFoundry", + "description": "Adds a Microsoft Foundry resource to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFoundry(name string) FoundryResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + } + ], + "returnType": "FoundryResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddFunctionTool", + "capabilityId": "Aspire.Hosting.Foundry/addFunctionTool", + "qualifiedName": "addFunctionTool", + "description": "Adds a function calling tool to a Microsoft Foundry project, enabling agents to call application-defined functions with structured parameters.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFunctionTool(name string, functionName string, parametersJson string, options ...*AddFunctionToolOptions) FunctionToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "functionName", + "type": "string", + "description": "The name of the function." + }, + { + "name": "parametersJson", + "type": "string", + "description": "The JSON schema defining the function parameters as a JSON string." + } + ], + "options": { + "typeName": "AddFunctionToolOptions", + "fields": [ + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "A description of what the function does." + }, + { + "name": "StrictModeEnabled", + "jsonName": "strictModeEnabled", + "type": "*bool", + "description": "Whether to enable strict mode for parameter validation." + } + ] + }, + "returnType": "FunctionToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddImageGenerationTool", + "capabilityId": "Aspire.Hosting.Foundry/addImageGenerationTool", + "qualifiedName": "addImageGenerationTool", + "description": "Adds an Image Generation tool to a Microsoft Foundry project, enabling agents to generate and edit images.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddImageGenerationTool(name string) ImageGenerationToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "ImageGenerationToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddKeyVaultConnection", + "capabilityId": "Aspire.Hosting.Foundry/addKeyVaultConnection", + "qualifiedName": "addKeyVaultConnection", + "description": "Adds a Key Vault connection to the Microsoft Foundry project.", + "remarks": "This connection allows the Microsoft Foundry project to store secrets for various other connections.\nAs such, we recommend adding this connection *before* any others, so that those connections\ncan leverage the Key Vault connection for secret storage.", + "kind": "Method", + "signature": "AddKeyVaultConnection(keyVault AzureKeyVaultResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "keyVault", + "type": "AzureKeyVaultResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddModelDeployment", + "capabilityId": "Aspire.Hosting.Foundry/addModelDeployment", + "qualifiedName": "addModelDeployment", + "description": "Adds a model deployment to the parent Microsoft Foundry resource.", + "kind": "Method", + "signature": "AddModelDeployment(name string, model any, options ...*AddModelDeploymentOptions) FoundryDeploymentResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "model", + "type": "any", + "allowedTypes": [ + "*FoundryModel", + "string" + ] + } + ], + "options": { + "typeName": "AddModelDeploymentOptions", + "fields": [ + { + "name": "ModelVersion", + "jsonName": "modelVersion", + "type": "*string" + }, + { + "name": "Format", + "jsonName": "format", + "type": "*string" + } + ] + }, + "returnType": "FoundryDeploymentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddProject", + "capabilityId": "Aspire.Hosting.Foundry/addProject", + "qualifiedName": "addProject", + "description": "Adds a Microsoft Foundry project resource to the application model. This will also attach the project as a deployment target for agents.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddProject(name string) AzureCognitiveServicesProjectResource", + "receiver": "FoundryResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Microsoft Foundry project resource." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryResource" + ], + "appliesTo": [ + "FoundryResource" + ] + }, + { + "name": "AddPromptAgent", + "capabilityId": "Aspire.Hosting.Foundry/addPromptAgent", + "qualifiedName": "addPromptAgent", + "description": "Adds a prompt agent to a Microsoft Foundry project with the specified tools.", + "remarks": "Prompt agents are always deployed to Azure Foundry, even during local development\n(`aspire run`). Local services communicate with the cloud-provisioned agent\nusing the project endpoint and agent name injected as environment variables.\nTools are project-level resources created with `Add*Tool` methods and can be\nreused across multiple agents in the same project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPromptAgent(name string, model FoundryDeploymentResource, options ...*AddPromptAgentOptions) AzurePromptAgentResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the prompt agent. This will be the agent name in Foundry." + }, + { + "name": "model", + "type": "FoundryDeploymentResource", + "description": "The model deployment to use for this agent." + } + ], + "options": { + "typeName": "AddPromptAgentOptions", + "fields": [ + { + "name": "Instructions", + "jsonName": "instructions", + "type": "*string", + "description": "Optional system instructions for the agent." + } + ] + }, + "returnType": "AzurePromptAgentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddSearchConnection", + "capabilityId": "Aspire.Hosting.Foundry/addSearchConnection", + "qualifiedName": "addSearchConnection", + "description": "Adds an Azure AI Search connection to a Microsoft Foundry project.", + "kind": "Method", + "signature": "AddSearchConnection(search AzureSearchResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "search", + "type": "AzureSearchResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddSharePointTool", + "capabilityId": "Aspire.Hosting.Foundry/addSharePointTool", + "qualifiedName": "addSharePointTool", + "description": "Adds a SharePoint grounding tool to a Microsoft Foundry project, enabling agents to search data from SharePoint sites configured as Foundry project connections.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddSharePointTool(name string, projectConnectionIds []string) SharePointToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "projectConnectionIds", + "type": "[]string", + "description": "The Foundry project connection IDs for the SharePoint sites." + } + ], + "returnType": "SharePointToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddStorageConnection", + "capabilityId": "Aspire.Hosting.Foundry/addStorageConnection", + "qualifiedName": "addStorageConnection", + "description": "Adds an Azure Storage account to a project as a connection.", + "kind": "Method", + "signature": "AddStorageConnection(storage AzureStorageResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "storage", + "type": "AzureStorageResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddToolbox", + "capabilityId": "Aspire.Hosting.Foundry/addToolbox", + "qualifiedName": "addToolbox", + "description": "Adds a Microsoft Foundry Toolbox endpoint to a Microsoft Foundry project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddToolbox(name string, options ...*FoundryToolboxOptions) FoundryToolboxResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Toolbox name." + } + ], + "options": { + "typeName": "FoundryToolboxOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "FoundryToolboxResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddWebSearchTool", + "capabilityId": "Aspire.Hosting.Foundry/addWebSearchTool", + "qualifiedName": "addWebSearchTool", + "description": "Adds a Web Search tool to a Microsoft Foundry project, enabling agents to retrieve real-time information from the public web and return answers with inline citations.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddWebSearchTool(name string) WebSearchToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "WebSearchToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Foundry/asExisting", + "qualifiedName": "asExisting", + "description": "Uses an existing Microsoft Foundry Toolbox during local runs and deployment.", + "remarks": "Existing mode validates that the remote Toolbox and optional pinned\n`Version` exist without resolving locally modeled tools or\nmutating the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsExisting() FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "AsHostedAgent", + "capabilityId": "Aspire.Hosting.Foundry/asHostedAgent", + "qualifiedName": "asHostedAgent", + "description": "Configures the resource to run and publish as a hosted agent in Microsoft Foundry using the Responses protocol version 2.0.0.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsHostedAgent(project AzureCognitiveServicesProjectResource, options ...*HostedAgentOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "project", + "type": "AzureCognitiveServicesProjectResource", + "description": "The Microsoft Foundry project the hosted agent is deployed into." + } + ], + "options": { + "typeName": "HostedAgentOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Foundry.FoundryResource", + "Aspire.Hosting.AzureCosmosDBResource", + "Aspire.Hosting.Azure.AzureStorageResource", + "Aspire.Hosting.Azure.AzureKeyVaultResource", + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource", + "AzureCosmosDBResource", + "AzureKeyVaultResource", + "AzureStorageEmulatorResource", + "AzureStorageResource", + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "FoundryResource", + "ProjectResource" + ] + }, + { + "name": "AsHostedAgentWithProtocol", + "capabilityId": "Aspire.Hosting.Foundry/asHostedAgentWithProtocol", + "qualifiedName": "asHostedAgentWithProtocol", + "description": "Configures the resource to run and publish as a hosted agent in Microsoft Foundry using an explicit protocol and version.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsHostedAgentWithProtocol(project AzureCognitiveServicesProjectResource, protocol HostedAgentProtocol, protocolVersion string, options ...*HostedAgentOptions) ResourceWithEndpoints", + "receiver": "ResourceWithEndpoints", + "parameters": [ + { + "name": "project", + "type": "AzureCognitiveServicesProjectResource", + "description": "The Microsoft Foundry project the hosted agent is deployed into." + }, + { + "name": "protocol", + "type": "HostedAgentProtocol", + "description": "The protocol exposed by the hosted agent container." + }, + { + "name": "protocolVersion", + "type": "string", + "description": "The version of the protocol exposed by the hosted agent container." + } + ], + "options": { + "typeName": "HostedAgentOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "ResourceWithEndpoints", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResourceWithEndpoints", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Foundry.FoundryResource", + "Aspire.Hosting.AzureCosmosDBResource", + "Aspire.Hosting.Azure.AzureStorageResource", + "Aspire.Hosting.Azure.AzureKeyVaultResource", + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "Aspire.Hosting.Azure.AzureStorageEmulatorResource" + ], + "appliesTo": [ + "AzureCosmosDBEmulatorResource", + "AzureCosmosDBResource", + "AzureKeyVaultResource", + "AzureStorageEmulatorResource", + "AzureStorageResource", + "CSharpAppResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "FoundryResource", + "ProjectResource" + ] + }, + { + "name": "PublishAsExisting", + "capabilityId": "Aspire.Hosting.Foundry/publishAsExisting", + "qualifiedName": "publishAsExisting", + "description": "Reconciles a Microsoft Foundry Toolbox during local runs and uses an existing Toolbox during deployment.", + "remarks": "Existing mode validates that the remote Toolbox and optional pinned\n`Version` exist without resolving locally modeled tools or\nmutating the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsExisting() FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "RunAsExisting", + "capabilityId": "Aspire.Hosting.Foundry/runAsExisting", + "qualifiedName": "runAsExisting", + "description": "Uses an existing Microsoft Foundry Toolbox during local runs and reconciles it during deployment.", + "remarks": "Existing mode validates that the remote Toolbox and optional pinned\n`Version` exist without resolving locally modeled tools or\nmutating the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsExisting() FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "RunAsFoundryLocal", + "capabilityId": "Aspire.Hosting.Foundry/runAsFoundryLocal", + "qualifiedName": "runAsFoundryLocal", + "description": "Configures a Microsoft Foundry resource to use an Aspire-managed or existing Foundry Local service.", + "remarks": "When `endpoint` is provided, Aspire connects to that existing\nFoundry Local service without starting, stopping, downloading, or loading anything on its host.\nModels configured on the resource must already be loaded by the existing service.", + "returns": "The configured Microsoft Foundry resource builder.", + "kind": "Method", + "signature": "RunAsFoundryLocal(options ...*RunAsFoundryLocalOptions) FoundryResource", + "receiver": "FoundryResource", + "parameters": [], + "options": { + "typeName": "RunAsFoundryLocalOptions", + "fields": [ + { + "name": "Endpoint", + "jsonName": "endpoint", + "type": "*string", + "description": "The endpoint of an existing Foundry Local service, or `null` for an Aspire-managed service." + } + ] + }, + "returnType": "FoundryResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryResource" + ], + "appliesTo": [ + "FoundryResource" + ] + }, + { + "name": "WithAISearchTool", + "capabilityId": "Aspire.Hosting.Foundry/withAISearchTool", + "qualifiedName": "withAISearchTool", + "description": "Adds an Azure AI Search tool definition to the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAISearchTool(name string, search AzureSearchResource, indexName string, options ...*WithAISearchToolOptions) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The tool name." + }, + { + "name": "search", + "type": "AzureSearchResource", + "description": "The Azure AI Search resource backing the tool." + }, + { + "name": "indexName", + "type": "string", + "description": "The search index name." + } + ], + "options": { + "typeName": "WithAISearchToolOptions", + "fields": [ + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "An optional description of the Azure AI Search tool." + } + ] + }, + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithAppInsights", + "capabilityId": "Aspire.Hosting.Foundry/withAppInsights", + "qualifiedName": "withAppInsights", + "description": "Adds an Application Insights resource to the Microsoft Foundry project, overriding the default (which is to create a new Application Insights resource).", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAppInsights(appInsights AzureApplicationInsightsResource) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "appInsights", + "type": "AzureApplicationInsightsResource", + "description": "The Application Insights resource to associate with the project." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "WithCapabilityHost", + "capabilityId": "Aspire.Hosting.Foundry/withCapabilityHost", + "qualifiedName": "withCapabilityHost", + "description": "Associates a supported resource with a capability host on a Microsoft Foundry project.", + "returns": "A reference to the project builder for chaining capability host configuration.", + "kind": "Method", + "signature": "WithCapabilityHost(resource any) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "resource", + "type": "any", + "allowedTypes": [ + "AzureCosmosDBResource", + "AzureStorageResource", + "AzureSearchResource", + "FoundryResource" + ], + "description": "The supported capability host resource." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "WithDescription", + "capabilityId": "Aspire.Hosting.Foundry/withDescription", + "qualifiedName": "withDescription", + "description": "Sets the description persisted with each Toolbox version.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDescription(description string) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [ + { + "name": "description", + "type": "string", + "description": "The Toolbox description." + } + ], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithFoundryRoleAssignments", + "capabilityId": "Aspire.Hosting.Foundry/withFoundryRoleAssignments", + "qualifiedName": "withFoundryRoleAssignments", + "description": "Assigns the specified roles to the given resource, granting it the necessary permissions on the target Microsoft Foundry resource. This replaces the default role assignments for the resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithFoundryRoleAssignments(target FoundryResource, roles []FoundryRole) Resource", + "receiver": "Resource", + "parameters": [ + { + "name": "target", + "type": "FoundryResource", + "description": "The target Microsoft Foundry resource." + }, + { + "name": "roles", + "type": "[]FoundryRole", + "description": "The Microsoft Foundry roles to be assigned (for example, `CognitiveServicesOpenAIUser`)." + } + ], + "returnType": "Resource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.ContainerResource", + "Aspire.Hosting.ApplicationModel.ExecutableResource", + "Aspire.Hosting.ApplicationModel.ProjectResource", + "Aspire.Hosting.ApplicationModel.ParameterResource", + "Aspire.Hosting.ApplicationModel.ContainerRegistryResource", + "Aspire.Hosting.ApplicationModel.DotnetToolResource", + "Aspire.Hosting.ExternalServiceResource", + "Aspire.Hosting.ApplicationModel.CSharpAppResource", + "Aspire.Hosting.Foundry.FoundryDeploymentResource", + "Aspire.Hosting.Foundry.FoundryResource", + "Aspire.Hosting.Foundry.BingGroundingConnectionResource", + "Aspire.Hosting.Foundry.AzurePromptAgentResource", + "Aspire.Hosting.Foundry.FoundryToolboxResource", + "Aspire.Hosting.Foundry.AzureAISearchToolResource", + "Aspire.Hosting.Foundry.AzureFunctionToolResource", + "Aspire.Hosting.Foundry.BingGroundingToolResource", + "Aspire.Hosting.Foundry.CodeInterpreterToolResource", + "Aspire.Hosting.Foundry.FileSearchToolResource", + "Aspire.Hosting.Foundry.WebSearchToolResource", + "Aspire.Hosting.Foundry.ImageGenerationToolResource", + "Aspire.Hosting.Foundry.ComputerToolResource", + "Aspire.Hosting.Foundry.SharePointToolResource", + "Aspire.Hosting.Foundry.FabricToolResource", + "Aspire.Hosting.Foundry.FoundryToolResource", + "Aspire.Hosting.Foundry.FunctionToolResource", + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "Aspire.Hosting.AzureCosmosDBResource", + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectConnectionResource", + "Aspire.Hosting.Azure.AzureStorageResource", + "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "Aspire.Hosting.Azure.AzureSearchResource", + "Aspire.Hosting.Azure.AzureKeyVaultResource", + "Aspire.Hosting.Azure.AzureApplicationInsightsResource", + "Aspire.Hosting.Azure.AzureBicepResource", + "Aspire.Hosting.Azure.AzureProvisioningResource", + "Aspire.Hosting.Azure.AzureEnvironmentResource", + "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceResource", + "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource", + "Aspire.Hosting.Azure.AzureCosmosDBContainerResource", + "Aspire.Hosting.Azure.AzureKeyVaultSecretResource", + "Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "Aspire.Hosting.Azure.AzureBlobStorageResource", + "Aspire.Hosting.Azure.AzureDataLakeStorageResource", + "Aspire.Hosting.Azure.AzureBlobStorageContainerResource", + "Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource", + "Aspire.Hosting.Azure.AzureTableStorageResource", + "Aspire.Hosting.Azure.AzureQueueStorageResource", + "Aspire.Hosting.Azure.AzureQueueStorageQueueResource" + ], + "appliesTo": [ + "AzureAISearchToolResource", + "AzureApplicationInsightsResource", + "AzureBicepResource", + "AzureBlobStorageContainerResource", + "AzureBlobStorageResource", + "AzureCognitiveServicesProjectConnectionResource", + "AzureCognitiveServicesProjectResource", + "AzureContainerRegistryResource", + "AzureCosmosDBContainerResource", + "AzureCosmosDBDatabaseResource", + "AzureCosmosDBEmulatorResource", + "AzureCosmosDBResource", + "AzureDataLakeStorageFileSystemResource", + "AzureDataLakeStorageResource", + "AzureEnvironmentResource", + "AzureFunctionToolResource", + "AzureKeyVaultResource", + "AzureKeyVaultSecretResource", + "AzureLogAnalyticsWorkspaceResource", + "AzurePromptAgentResource", + "AzureProvisioningResource", + "AzureQueueStorageQueueResource", + "AzureQueueStorageResource", + "AzureSearchResource", + "AzureStorageEmulatorResource", + "AzureStorageResource", + "AzureTableStorageResource", + "AzureUserAssignedIdentityResource", + "BingGroundingConnectionResource", + "BingGroundingToolResource", + "CSharpAppResource", + "CodeInterpreterToolResource", + "ComputerToolResource", + "ContainerRegistryResource", + "ContainerResource", + "DotnetToolResource", + "ExecutableResource", + "ExternalServiceResource", + "FabricToolResource", + "FileSearchToolResource", + "FoundryDeploymentResource", + "FoundryResource", + "FoundryToolResource", + "FoundryToolboxResource", + "FunctionToolResource", + "ImageGenerationToolResource", + "ParameterResource", + "ProjectResource", + "SharePointToolResource", + "WebSearchToolResource" + ] + }, + { + "name": "WithKeyVault", + "capabilityId": "Aspire.Hosting.Foundry/withKeyVault", + "qualifiedName": "withKeyVault", + "description": "Adds a Key Vault connection to the Microsoft Foundry project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithKeyVault(keyVault AzureKeyVaultResource) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "keyVault", + "type": "AzureKeyVaultResource", + "description": "The Key Vault resource to associate with the project." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "WithMcpTool", + "capabilityId": "Aspire.Hosting.Foundry/withMcpTool", + "qualifiedName": "withMcpTool", + "description": "Adds an MCP tool definition to the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithMcpTool(name string, endpoint any, options ...*FoundryToolboxMcpToolOptions) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The tool name." + }, + { + "name": "endpoint", + "type": "any", + "allowedTypes": [ + "string", + "EndpointReference", + "*ReferenceExpression" + ], + "description": "The MCP endpoint. A string URI, an `EndpointReference` pointing at a resource endpoint, or a `ReferenceExpression` for cases where the endpoint URL needs to be composed (for example, appending the MCP server's mount path or chaining through a public ingress like a dev tunnel)." + } + ], + "options": { + "typeName": "FoundryToolboxMcpToolOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Foundry/withFoundryDeploymentProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of a Microsoft Foundry Deployment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj FoundryDeploymentResource)) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj FoundryDeploymentResource)", + "isCallback": true, + "callbackSignature": "func(obj FoundryDeploymentResource)", + "description": "A method that can be used for customizing the `FoundryDeploymentResource`." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "WithReference", + "capabilityId": "Aspire.Hosting.Foundry/withBingReference", + "qualifiedName": "withReference", + "description": "Links a Bing Grounding tool to a Bing Search resource or connection.", + "kind": "Method", + "signature": "WithReference(bingReference any) BingGroundingToolResource", + "receiver": "BingGroundingToolResource", + "parameters": [ + { + "name": "bingReference", + "type": "any", + "allowedTypes": [ + "BingGroundingConnectionResource", + "string", + "ParameterResource" + ] + } + ], + "returnType": "BingGroundingToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.BingGroundingToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.BingGroundingToolResource" + ], + "appliesTo": [ + "BingGroundingToolResource" + ] + }, + { + "name": "WithReference", + "capabilityId": "Aspire.Hosting.Foundry/withReference", + "qualifiedName": "withReference", + "description": "Links an Azure AI Search tool to a backing search resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithReference(search AzureSearchResource) AzureAISearchToolResource", + "receiver": "AzureAISearchToolResource", + "parameters": [ + { + "name": "search", + "type": "AzureSearchResource", + "description": "The Azure AI Search resource to use for grounding." + } + ], + "returnType": "AzureAISearchToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureAISearchToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureAISearchToolResource" + ], + "appliesTo": [ + "AzureAISearchToolResource" + ] + }, + { + "name": "WithTool", + "capabilityId": "Aspire.Hosting.Foundry/withTool", + "qualifiedName": "withTool", + "description": "Adds a tool to a prompt agent.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTool(tool FoundryToolResource) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "tool", + "type": "FoundryToolResource", + "description": "The tool resource to attach to this agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "WithWebSearchTool", + "capabilityId": "Aspire.Hosting.Foundry/withWebSearchTool", + "qualifiedName": "withWebSearchTool", + "description": "Adds a web search tool definition to the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWebSearchTool(options ...*WithWebSearchToolOptions) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "options": { + "typeName": "WithWebSearchToolOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The tool name." + }, + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "An optional description of the web search tool." + } + ] + }, + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + } + ], + "handleTypes": [ + { + "name": "AzureApplicationInsightsResource", + "fullName": "Aspire.Hosting.Azure.AzureApplicationInsightsResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBicepResource", + "fullName": "Aspire.Hosting.Azure.AzureBicepResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBlobStorageContainerResource", + "fullName": "Aspire.Hosting.Azure.AzureBlobStorageContainerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureBlobStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureBlobStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureContainerRegistryResource", + "fullName": "Aspire.Hosting.Azure.AzureContainerRegistryResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBContainerResource", + "fullName": "Aspire.Hosting.Azure.AzureCosmosDBContainerResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBDatabaseResource", + "fullName": "Aspire.Hosting.Azure.AzureCosmosDBDatabaseResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureCosmosDBEmulatorResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureDataLakeStorageFileSystemResource", + "fullName": "Aspire.Hosting.Azure.AzureDataLakeStorageFileSystemResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureDataLakeStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureDataLakeStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureEnvironmentResource", + "fullName": "Aspire.Hosting.Azure.AzureEnvironmentResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultResource", + "fullName": "Aspire.Hosting.Azure.AzureKeyVaultResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureKeyVaultSecretResource", + "fullName": "Aspire.Hosting.Azure.AzureKeyVaultSecretResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureLogAnalyticsWorkspaceResource", + "fullName": "Aspire.Hosting.Azure.AzureLogAnalyticsWorkspaceResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureProvisioningResource", + "fullName": "Aspire.Hosting.Azure.AzureProvisioningResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureQueueStorageQueueResource", + "fullName": "Aspire.Hosting.Azure.AzureQueueStorageQueueResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureQueueStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureQueueStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureSearchResource", + "fullName": "Aspire.Hosting.Azure.AzureSearchResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageEmulatorResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageEmulatorResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureTableStorageResource", + "fullName": "Aspire.Hosting.Azure.AzureTableStorageResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureUserAssignedIdentityResource", + "fullName": "Aspire.Hosting.Azure.AzureUserAssignedIdentityResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCosmosDBResource", + "fullName": "Aspire.Hosting.AzureCosmosDBResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureAISearchToolResource", + "fullName": "Aspire.Hosting.Foundry.AzureAISearchToolResource", + "kind": "handle", + "description": "A Foundry tool resource that grounds an agent's responses using data from an Azure AI Search index.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithReference", + "capabilityId": "Aspire.Hosting.Foundry/withReference", + "qualifiedName": "withReference", + "description": "Links an Azure AI Search tool to a backing search resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithReference(search AzureSearchResource) AzureAISearchToolResource", + "receiver": "AzureAISearchToolResource", + "parameters": [ + { + "name": "search", + "type": "AzureSearchResource", + "description": "The Azure AI Search resource to use for grounding." + } + ], + "returnType": "AzureAISearchToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureAISearchToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureAISearchToolResource" + ], + "appliesTo": [ + "AzureAISearchToolResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureCognitiveServicesProjectConnectionResource", + "fullName": "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectConnectionResource", + "kind": "handle", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzureCognitiveServicesProjectResource", + "fullName": "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "kind": "handle", + "implementedInterfaces": [ + "ComputeEnvironmentResource", + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "AddAISearchTool", + "capabilityId": "Aspire.Hosting.Foundry/addAISearchTool", + "qualifiedName": "addAISearchTool", + "description": "Adds an Azure AI Search tool to a Microsoft Foundry project, enabling agents to ground their responses using data from an Azure AI Search index.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAISearchTool(name string, options ...*AddAISearchToolOptions) AzureAISearchToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "options": { + "typeName": "AddAISearchToolOptions", + "fields": [ + { + "name": "IndexName", + "jsonName": "indexName", + "type": "*string", + "description": "Optional name of the search index to query. If not specified, the agent must be told which index to use." + } + ] + }, + "returnType": "AzureAISearchToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddAzureFunctionTool", + "capabilityId": "Aspire.Hosting.Foundry/addAzureFunctionTool", + "qualifiedName": "addAzureFunctionTool", + "description": "Adds an Azure Function tool to a Microsoft Foundry project, enabling agents to invoke a serverless Azure Function with queue-based input/output bindings.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddAzureFunctionTool(name string, functionName string, description string, parametersJson string, inputQueueEndpoint string, inputQueueName string, outputQueueEndpoint string, outputQueueName string) AzureFunctionToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "functionName", + "type": "string", + "description": "The name of the Azure Function." + }, + { + "name": "description", + "type": "string", + "description": "A description of what the function does." + }, + { + "name": "parametersJson", + "type": "string", + "description": "The JSON schema defining the function parameters as a JSON string." + }, + { + "name": "inputQueueEndpoint", + "type": "string", + "description": "The Azure Storage Queue endpoint for input binding." + }, + { + "name": "inputQueueName", + "type": "string", + "description": "The queue name for input binding." + }, + { + "name": "outputQueueEndpoint", + "type": "string", + "description": "The Azure Storage Queue endpoint for output binding." + }, + { + "name": "outputQueueName", + "type": "string", + "description": "The queue name for output binding." + } + ], + "returnType": "AzureFunctionToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddBingGroundingConnection", + "capabilityId": "Aspire.Hosting.Foundry/addBingGroundingConnection", + "qualifiedName": "addBingGroundingConnection", + "description": "Adds a Grounding with Bing Search connection to a Microsoft Foundry project.", + "remarks": "The Bing Search resource (`Microsoft.Bing/accounts`) cannot be provisioned through Aspire\nor Bicep. It must be created manually in the\nAzure portal.\nOnce the Bing resource exists, pass its resource ID to this method. The connection is\ncreated in the Foundry project using API key authentication with\n`category: \"ApiKey\"` and `metadata.Type: \"bing_grounding\"`.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBingGroundingConnection(name string, bingResourceId string) BingGroundingConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the connection resource." + }, + { + "name": "bingResourceId", + "type": "string", + "description": "The full Azure resource ID of the Bing Search resource (e.g., `/subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.Bing/accounts/{name}`)." + } + ], + "returnType": "BingGroundingConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddBingGroundingConnectionFromParameter", + "capabilityId": "Aspire.Hosting.Foundry/addBingGroundingConnectionFromParameter", + "qualifiedName": "addBingGroundingConnectionFromParameter", + "description": "Adds a Grounding with Bing Search connection to a Microsoft Foundry project using a parameter resource for the Bing resource ID.", + "remarks": "This overload allows the Bing resource ID to be supplied as a parameter (e.g., from user secrets\nor configuration) rather than a hardcoded string. The parameter value is resolved at deployment time\nand embedded in the Bicep template.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBingGroundingConnectionFromParameter(name string, bingResourceId ParameterResource) BingGroundingConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the connection resource." + }, + { + "name": "bingResourceId", + "type": "ParameterResource", + "description": "A parameter resource containing the full Azure resource ID of the Bing Search resource." + } + ], + "returnType": "BingGroundingConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddBingGroundingTool", + "capabilityId": "Aspire.Hosting.Foundry/addBingGroundingTool", + "qualifiedName": "addBingGroundingTool", + "description": "Adds a Bing Grounding tool to a Microsoft Foundry project, enabling agents to ground their responses using Bing Search results.", + "remarks": "After creating the tool, call one of the `WithReference` overloads\nto link it to a Bing Search resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddBingGroundingTool(name string) BingGroundingToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "BingGroundingToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddCapabilityHost", + "capabilityId": "Aspire.Hosting.Foundry/addCapabilityHostProject", + "qualifiedName": "addCapabilityHost", + "description": "Adds a capability host to the Microsoft Foundry project.", + "returns": "A reference to the project builder for chaining capability host configuration.", + "kind": "Method", + "signature": "AddCapabilityHost(name string) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the capability host." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddCodeInterpreterTool", + "capabilityId": "Aspire.Hosting.Foundry/addCodeInterpreterTool", + "qualifiedName": "addCodeInterpreterTool", + "description": "Adds a Code Interpreter tool to a Microsoft Foundry project, enabling agents to write and run Python code in a sandboxed environment for data analysis, math, and chart generation.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddCodeInterpreterTool(name string) CodeInterpreterToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "CodeInterpreterToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddComputerUseTool", + "capabilityId": "Aspire.Hosting.Foundry/addComputerUseTool", + "qualifiedName": "addComputerUseTool", + "description": "Adds a Computer Use tool to a Microsoft Foundry project, enabling agents to interact with a computer desktop by taking screenshots, moving the mouse, clicking, and typing.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddComputerUseTool(name string, options ...*AddComputerUseToolOptions) ComputerToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "options": { + "typeName": "AddComputerUseToolOptions", + "fields": [ + { + "name": "DisplayWidth", + "jsonName": "displayWidth", + "type": "*float64", + "description": "The width of the display in pixels." + }, + { + "name": "DisplayHeight", + "jsonName": "displayHeight", + "type": "*float64", + "description": "The height of the display in pixels." + }, + { + "name": "Environment", + "jsonName": "environment", + "type": "*string", + "description": "The environment identifier. Defaults to \"browser\"." + } + ] + }, + "returnType": "ComputerToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddConnection", + "capabilityId": "Aspire.Hosting.Foundry/addConnection", + "qualifiedName": "addConnection", + "description": "Adds a connection to a Microsoft Foundry project.", + "kind": "Method", + "signature": "AddConnection(resource any) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "resource", + "type": "any", + "allowedTypes": [ + "AzureCosmosDBResource", + "AzureStorageResource", + "AzureContainerRegistryResource", + "AzureKeyVaultResource" + ] + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddContainerRegistryConnection", + "capabilityId": "Aspire.Hosting.Foundry/addContainerRegistryConnection", + "qualifiedName": "addContainerRegistryConnection", + "description": "Adds a container registry connection to the Microsoft Foundry project.", + "kind": "Method", + "signature": "AddContainerRegistryConnection(registry AzureContainerRegistryResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "registry", + "type": "AzureContainerRegistryResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddCosmosConnection", + "capabilityId": "Aspire.Hosting.Foundry/addCosmosConnection", + "qualifiedName": "addCosmosConnection", + "description": "Adds CosmosDB to a project as a connection", + "kind": "Method", + "signature": "AddCosmosConnection(db AzureCosmosDBResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "db", + "type": "AzureCosmosDBResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddFabricTool", + "capabilityId": "Aspire.Hosting.Foundry/addFabricTool", + "qualifiedName": "addFabricTool", + "description": "Adds a Microsoft Fabric data agent tool to a Microsoft Foundry project, enabling agents to query data through Fabric data agents.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFabricTool(name string, projectConnectionIds []string) FabricToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "projectConnectionIds", + "type": "[]string", + "description": "The Foundry project connection IDs for the Fabric data agents." + } + ], + "returnType": "FabricToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddFileSearchTool", + "capabilityId": "Aspire.Hosting.Foundry/addFileSearchTool", + "qualifiedName": "addFileSearchTool", + "description": "Adds a File Search tool to a Microsoft Foundry project, enabling agents to search uploaded files and proprietary documents using vector search.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFileSearchTool(name string, vectorStoreIds []string) FileSearchToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "vectorStoreIds", + "type": "[]string", + "description": "Optional vector store IDs to search. If empty, the agent's default stores are used." + } + ], + "returnType": "FileSearchToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddFunctionTool", + "capabilityId": "Aspire.Hosting.Foundry/addFunctionTool", + "qualifiedName": "addFunctionTool", + "description": "Adds a function calling tool to a Microsoft Foundry project, enabling agents to call application-defined functions with structured parameters.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddFunctionTool(name string, functionName string, parametersJson string, options ...*AddFunctionToolOptions) FunctionToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "functionName", + "type": "string", + "description": "The name of the function." + }, + { + "name": "parametersJson", + "type": "string", + "description": "The JSON schema defining the function parameters as a JSON string." + } + ], + "options": { + "typeName": "AddFunctionToolOptions", + "fields": [ + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "A description of what the function does." + }, + { + "name": "StrictModeEnabled", + "jsonName": "strictModeEnabled", + "type": "*bool", + "description": "Whether to enable strict mode for parameter validation." + } + ] + }, + "returnType": "FunctionToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddImageGenerationTool", + "capabilityId": "Aspire.Hosting.Foundry/addImageGenerationTool", + "qualifiedName": "addImageGenerationTool", + "description": "Adds an Image Generation tool to a Microsoft Foundry project, enabling agents to generate and edit images.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddImageGenerationTool(name string) ImageGenerationToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "ImageGenerationToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddKeyVaultConnection", + "capabilityId": "Aspire.Hosting.Foundry/addKeyVaultConnection", + "qualifiedName": "addKeyVaultConnection", + "description": "Adds a Key Vault connection to the Microsoft Foundry project.", + "remarks": "This connection allows the Microsoft Foundry project to store secrets for various other connections.\nAs such, we recommend adding this connection *before* any others, so that those connections\ncan leverage the Key Vault connection for secret storage.", + "kind": "Method", + "signature": "AddKeyVaultConnection(keyVault AzureKeyVaultResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "keyVault", + "type": "AzureKeyVaultResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddModelDeployment", + "capabilityId": "Aspire.Hosting.Foundry/addModelDeployment", + "qualifiedName": "addModelDeployment", + "description": "Adds a model deployment to the parent Microsoft Foundry resource.", + "kind": "Method", + "signature": "AddModelDeployment(name string, model any, options ...*AddModelDeploymentOptions) FoundryDeploymentResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "model", + "type": "any", + "allowedTypes": [ + "*FoundryModel", + "string" + ] + } + ], + "options": { + "typeName": "AddModelDeploymentOptions", + "fields": [ + { + "name": "ModelVersion", + "jsonName": "modelVersion", + "type": "*string" + }, + { + "name": "Format", + "jsonName": "format", + "type": "*string" + } + ] + }, + "returnType": "FoundryDeploymentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddPromptAgent", + "capabilityId": "Aspire.Hosting.Foundry/addPromptAgent", + "qualifiedName": "addPromptAgent", + "description": "Adds a prompt agent to a Microsoft Foundry project with the specified tools.", + "remarks": "Prompt agents are always deployed to Azure Foundry, even during local development\n(`aspire run`). Local services communicate with the cloud-provisioned agent\nusing the project endpoint and agent name injected as environment variables.\nTools are project-level resources created with `Add*Tool` methods and can be\nreused across multiple agents in the same project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddPromptAgent(name string, model FoundryDeploymentResource, options ...*AddPromptAgentOptions) AzurePromptAgentResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the prompt agent. This will be the agent name in Foundry." + }, + { + "name": "model", + "type": "FoundryDeploymentResource", + "description": "The model deployment to use for this agent." + } + ], + "options": { + "typeName": "AddPromptAgentOptions", + "fields": [ + { + "name": "Instructions", + "jsonName": "instructions", + "type": "*string", + "description": "Optional system instructions for the agent." + } + ] + }, + "returnType": "AzurePromptAgentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddSearchConnection", + "capabilityId": "Aspire.Hosting.Foundry/addSearchConnection", + "qualifiedName": "addSearchConnection", + "description": "Adds an Azure AI Search connection to a Microsoft Foundry project.", + "kind": "Method", + "signature": "AddSearchConnection(search AzureSearchResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "search", + "type": "AzureSearchResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddSharePointTool", + "capabilityId": "Aspire.Hosting.Foundry/addSharePointTool", + "qualifiedName": "addSharePointTool", + "description": "Adds a SharePoint grounding tool to a Microsoft Foundry project, enabling agents to search data from SharePoint sites configured as Foundry project connections.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddSharePointTool(name string, projectConnectionIds []string) SharePointToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + }, + { + "name": "projectConnectionIds", + "type": "[]string", + "description": "The Foundry project connection IDs for the SharePoint sites." + } + ], + "returnType": "SharePointToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddStorageConnection", + "capabilityId": "Aspire.Hosting.Foundry/addStorageConnection", + "qualifiedName": "addStorageConnection", + "description": "Adds an Azure Storage account to a project as a connection.", + "kind": "Method", + "signature": "AddStorageConnection(storage AzureStorageResource) AzureCognitiveServicesProjectConnectionResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "storage", + "type": "AzureStorageResource" + } + ], + "returnType": "AzureCognitiveServicesProjectConnectionResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddToolbox", + "capabilityId": "Aspire.Hosting.Foundry/addToolbox", + "qualifiedName": "addToolbox", + "description": "Adds a Microsoft Foundry Toolbox endpoint to a Microsoft Foundry project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddToolbox(name string, options ...*FoundryToolboxOptions) FoundryToolboxResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The Toolbox name." + } + ], + "options": { + "typeName": "FoundryToolboxOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "FoundryToolboxResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "AddWebSearchTool", + "capabilityId": "Aspire.Hosting.Foundry/addWebSearchTool", + "qualifiedName": "addWebSearchTool", + "description": "Adds a Web Search tool to a Microsoft Foundry project, enabling agents to retrieve real-time information from the public web and return answers with inline citations.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddWebSearchTool(name string) WebSearchToolResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the tool resource." + } + ], + "returnType": "WebSearchToolResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "WithAppInsights", + "capabilityId": "Aspire.Hosting.Foundry/withAppInsights", + "qualifiedName": "withAppInsights", + "description": "Adds an Application Insights resource to the Microsoft Foundry project, overriding the default (which is to create a new Application Insights resource).", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAppInsights(appInsights AzureApplicationInsightsResource) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "appInsights", + "type": "AzureApplicationInsightsResource", + "description": "The Application Insights resource to associate with the project." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "WithCapabilityHost", + "capabilityId": "Aspire.Hosting.Foundry/withCapabilityHost", + "qualifiedName": "withCapabilityHost", + "description": "Associates a supported resource with a capability host on a Microsoft Foundry project.", + "returns": "A reference to the project builder for chaining capability host configuration.", + "kind": "Method", + "signature": "WithCapabilityHost(resource any) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "resource", + "type": "any", + "allowedTypes": [ + "AzureCosmosDBResource", + "AzureStorageResource", + "AzureSearchResource", + "FoundryResource" + ], + "description": "The supported capability host resource." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + }, + { + "name": "WithKeyVault", + "capabilityId": "Aspire.Hosting.Foundry/withKeyVault", + "qualifiedName": "withKeyVault", + "description": "Adds a Key Vault connection to the Microsoft Foundry project.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithKeyVault(keyVault AzureKeyVaultResource) AzureCognitiveServicesProjectResource", + "receiver": "AzureCognitiveServicesProjectResource", + "parameters": [ + { + "name": "keyVault", + "type": "AzureKeyVaultResource", + "description": "The Key Vault resource to associate with the project." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzureCognitiveServicesProjectResource" + ], + "appliesTo": [ + "AzureCognitiveServicesProjectResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "AzureFunctionToolResource", + "fullName": "Aspire.Hosting.Foundry.AzureFunctionToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to invoke an Azure Function.", + "remarks": "Azure Functions tools allow agents to call serverless functions as tools.\nThe function definition includes the function name, parameters schema,\nand input/output bindings for Azure Storage queues.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "AzurePromptAgentResource", + "fullName": "Aspire.Hosting.Foundry.AzurePromptAgentResource", + "kind": "handle", + "description": "Represents a Microsoft Foundry prompt agent resource that is provisioned on Azure.", + "remarks": "Unlike hosted agents (which run as containers), prompt agents are configuration-only\nagents defined by a model, system instructions, and optional tools. They are always\ndeployed to Azure Foundry via the data plane API, even during local development\n(`aspire run`). Local services communicate with the cloud-provisioned agent\nusing the Foundry project endpoint and agent name.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEnvironment" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.connectionStringExpression", + "qualifiedName": "AzurePromptAgentResource.connectionStringExpression", + "description": "Gets the ConnectionStringExpression property", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.description", + "qualifiedName": "AzurePromptAgentResource.description", + "description": "Gets or sets a description of the agent.", + "kind": "PropertyGetter", + "signature": "Description() (string, error)", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Instructions", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.instructions", + "qualifiedName": "AzurePromptAgentResource.instructions", + "description": "Gets or sets the system instructions for the agent.", + "kind": "PropertyGetter", + "signature": "Instructions() (*string, error)", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Metadata", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.metadata", + "qualifiedName": "AzurePromptAgentResource.metadata", + "description": "Gets the metadata to associate with the agent.", + "kind": "PropertyGetter", + "signature": "Metadata() *Dict[string, string]", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "Model", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.model", + "qualifiedName": "AzurePromptAgentResource.model", + "description": "Gets or sets the model deployment name used by this agent.", + "kind": "PropertyGetter", + "signature": "Model() (string, error)", + "receiver": "AzurePromptAgentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "SetDescription", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.setDescription", + "qualifiedName": "AzurePromptAgentResource.setDescription", + "description": "Gets or sets a description of the agent.", + "kind": "PropertySetter", + "signature": "SetDescription(value string) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets a description of the agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "SetInstructions", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.setInstructions", + "qualifiedName": "AzurePromptAgentResource.setInstructions", + "description": "Gets or sets the system instructions for the agent.", + "kind": "PropertySetter", + "signature": "SetInstructions(value *string) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the system instructions for the agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "SetModel", + "capabilityId": "Aspire.Hosting.Foundry/AzurePromptAgentResource.setModel", + "qualifiedName": "AzurePromptAgentResource.setModel", + "description": "Gets or sets the model deployment name used by this agent.", + "kind": "PropertySetter", + "signature": "SetModel(value string) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the model deployment name used by this agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + }, + { + "name": "WithTool", + "capabilityId": "Aspire.Hosting.Foundry/withTool", + "qualifiedName": "withTool", + "description": "Adds a tool to a prompt agent.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithTool(tool FoundryToolResource) AzurePromptAgentResource", + "receiver": "AzurePromptAgentResource", + "parameters": [ + { + "name": "tool", + "type": "FoundryToolResource", + "description": "The tool resource to attach to this agent." + } + ], + "returnType": "AzurePromptAgentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.AzurePromptAgentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.AzurePromptAgentResource" + ], + "appliesTo": [ + "AzurePromptAgentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "BingGroundingConnectionResource", + "fullName": "Aspire.Hosting.Foundry.BingGroundingConnectionResource", + "kind": "handle", + "description": "A Foundry project connection resource specifically for Grounding with Bing Search connections.", + "remarks": "This type is used to distinguish Bing grounding connections from other connection types,\nensuring that only connections created by `AddBingGroundingConnection`\ncan be linked to a `BingGroundingToolResource`.", + "implementedInterfaces": [ + "Resource", + "ResourceWithParent" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "BingGroundingToolResource", + "fullName": "Aspire.Hosting.Foundry.BingGroundingToolResource", + "kind": "handle", + "description": "A Foundry tool resource that grounds an agent's responses using Bing Search.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [ + { + "name": "WithReference", + "capabilityId": "Aspire.Hosting.Foundry/withBingReference", + "qualifiedName": "withReference", + "description": "Links a Bing Grounding tool to a Bing Search resource or connection.", + "kind": "Method", + "signature": "WithReference(bingReference any) BingGroundingToolResource", + "receiver": "BingGroundingToolResource", + "parameters": [ + { + "name": "bingReference", + "type": "any", + "allowedTypes": [ + "BingGroundingConnectionResource", + "string", + "ParameterResource" + ] + } + ], + "returnType": "BingGroundingToolResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.BingGroundingToolResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.BingGroundingToolResource" + ], + "appliesTo": [ + "BingGroundingToolResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "CodeInterpreterToolResource", + "fullName": "Aspire.Hosting.Foundry.CodeInterpreterToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to write and run Python code in a sandboxed environment for data analysis, math, and chart generation.", + "remarks": "This tool requires no Azure provisioning or project connections.\nIt is automatically available in all Foundry projects.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "ComputerToolResource", + "fullName": "Aspire.Hosting.Foundry.ComputerToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to interact with a computer desktop by taking screenshots, moving the mouse, clicking, and typing.", + "remarks": "The computer tool requires specifying the display dimensions and environment.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "FabricToolResource", + "fullName": "Aspire.Hosting.Foundry.FabricToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to query data using a Microsoft Fabric data agent.", + "remarks": "Fabric connections must be configured in the Foundry project beforehand.\nThis tool references existing connections by their Foundry project connection IDs.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "FileSearchToolResource", + "fullName": "Aspire.Hosting.Foundry.FileSearchToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to search uploaded files and proprietary documents using vector search.", + "remarks": "This tool requires no Azure provisioning or project connections.\nVector store IDs can optionally be configured for specific document collections.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "FoundryDeploymentResource", + "fullName": "Aspire.Hosting.Foundry.FoundryDeploymentResource", + "kind": "handle", + "description": "Represents a Microsoft Foundry Deployment.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithParent" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.connectionStringExpression", + "qualifiedName": "FoundryDeploymentResource.connectionStringExpression", + "description": "Gets the connection string expression for the Microsoft Foundry resource with model/deployment information.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "DeploymentName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.deploymentName", + "qualifiedName": "FoundryDeploymentResource.deploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `ModelName`, but allows for a different deployment name in Azure.\nWhen using Foundry Local, this is the model id.", + "kind": "PropertyGetter", + "signature": "DeploymentName() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "Format", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.format", + "qualifiedName": "FoundryDeploymentResource.format", + "description": "Gets or sets the format of deployment model.", + "remarks": "Typical values are \"OpenAI\", \"Microsoft\", \"xAi\", \"Deepseek\".", + "kind": "PropertyGetter", + "signature": "Format() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "LocalModelId", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.localModelId", + "qualifiedName": "FoundryDeploymentResource.localModelId", + "description": "Gets or sets the model identifier used by Foundry Local.", + "remarks": "Aspire resolves this value automatically when it manages Foundry Local. Set it explicitly\nwhen connecting to an existing Foundry Local service and `ModelName` is an alias\nrather than the identifier reported by the service.", + "kind": "PropertyGetter", + "signature": "LocalModelId() (*string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(*string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "ModelName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.modelName", + "qualifiedName": "FoundryDeploymentResource.modelName", + "description": "Gets or sets the name of the model.", + "kind": "PropertyGetter", + "signature": "ModelName() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "ModelVersion", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.modelVersion", + "qualifiedName": "FoundryDeploymentResource.modelVersion", + "description": "Gets or sets the version of the model.", + "kind": "PropertyGetter", + "signature": "ModelVersion() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "Parent", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.parent", + "qualifiedName": "FoundryDeploymentResource.parent", + "description": "Gets the parent Microsoft Foundry resource.", + "kind": "PropertyGetter", + "signature": "Parent() FoundryResource", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "FoundryResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetDeploymentName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setDeploymentName", + "qualifiedName": "FoundryDeploymentResource.setDeploymentName", + "description": "Gets or sets the name of the deployment.", + "remarks": "This defaults to `ModelName`, but allows for a different deployment name in Azure.\nWhen using Foundry Local, this is the model id.", + "kind": "PropertySetter", + "signature": "SetDeploymentName(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the deployment." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetFormat", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setFormat", + "qualifiedName": "FoundryDeploymentResource.setFormat", + "description": "Gets or sets the format of deployment model.", + "remarks": "Typical values are \"OpenAI\", \"Microsoft\", \"xAi\", \"Deepseek\".", + "kind": "PropertySetter", + "signature": "SetFormat(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the format of deployment model." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetLocalModelId", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setLocalModelId", + "qualifiedName": "FoundryDeploymentResource.setLocalModelId", + "description": "Gets or sets the model identifier used by Foundry Local.", + "remarks": "Aspire resolves this value automatically when it manages Foundry Local. Set it explicitly\nwhen connecting to an existing Foundry Local service and `ModelName` is an alias\nrather than the identifier reported by the service.", + "kind": "PropertySetter", + "signature": "SetLocalModelId(value *string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "*string", + "description": "Gets or sets the model identifier used by Foundry Local." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetModelName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setModelName", + "qualifiedName": "FoundryDeploymentResource.setModelName", + "description": "Gets or sets the name of the model.", + "kind": "PropertySetter", + "signature": "SetModelName(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the model." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetModelVersion", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setModelVersion", + "qualifiedName": "FoundryDeploymentResource.setModelVersion", + "description": "Gets or sets the version of the model.", + "kind": "PropertySetter", + "signature": "SetModelVersion(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the version of the model." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetParent", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setParent", + "qualifiedName": "FoundryDeploymentResource.setParent", + "description": "Gets the parent Microsoft Foundry resource.", + "kind": "PropertySetter", + "signature": "SetParent(value FoundryResource) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "FoundryResource", + "description": "Gets the parent Microsoft Foundry resource." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetSkuCapacity", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setSkuCapacity", + "qualifiedName": "FoundryDeploymentResource.setSkuCapacity", + "description": "Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM).", + "remarks": "For example, a value of 10 means 10,000 tokens per minute. Exceeding this rate\nlimit results in HTTP 429 responses. See\nAzure AI quota management\nfor more information.", + "kind": "PropertySetter", + "signature": "SetSkuCapacity(value float64) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM)." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SetSkuName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.setSkuName", + "qualifiedName": "FoundryDeploymentResource.setSkuName", + "description": "Gets or sets the name of the SKU.", + "kind": "PropertySetter", + "signature": "SetSkuName(value string) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "Gets or sets the name of the SKU." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SkuCapacity", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.skuCapacity", + "qualifiedName": "FoundryDeploymentResource.skuCapacity", + "description": "Gets or sets the capacity of the SKU, in thousands of tokens per minute (TPM).", + "remarks": "For example, a value of 10 means 10,000 tokens per minute. Exceeding this rate\nlimit results in HTTP 429 responses. See\nAzure AI quota management\nfor more information.", + "kind": "PropertyGetter", + "signature": "SkuCapacity() (float64, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "SkuName", + "capabilityId": "Aspire.Hosting.Foundry/FoundryDeploymentResource.skuName", + "qualifiedName": "FoundryDeploymentResource.skuName", + "description": "Gets or sets the name of the SKU.", + "kind": "PropertyGetter", + "signature": "SkuName() (string, error)", + "receiver": "FoundryDeploymentResource", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + }, + { + "name": "WithProperties", + "capabilityId": "Aspire.Hosting.Foundry/withFoundryDeploymentProperties", + "qualifiedName": "withProperties", + "description": "Allows setting the properties of a Microsoft Foundry Deployment resource.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithProperties(configure func(obj FoundryDeploymentResource)) FoundryDeploymentResource", + "receiver": "FoundryDeploymentResource", + "parameters": [ + { + "name": "configure", + "type": "func(obj FoundryDeploymentResource)", + "isCallback": true, + "callbackSignature": "func(obj FoundryDeploymentResource)", + "description": "A method that can be used for customizing the `FoundryDeploymentResource`." + } + ], + "returnType": "FoundryDeploymentResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryDeploymentResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryDeploymentResource" + ], + "appliesTo": [ + "FoundryDeploymentResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "FoundryResource", + "fullName": "Aspire.Hosting.Foundry.FoundryResource", + "kind": "handle", + "description": "Represents a Microsoft Foundry resource. This corresponds to the Azure Cognitive Services account with Microsoft Foundry capabilities enabled.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString", + "ResourceWithEndpoints" + ], + "capabilities": [ + { + "name": "AddDeployment", + "capabilityId": "Aspire.Hosting.Foundry/addDeployment", + "qualifiedName": "addDeployment", + "description": "Adds a Microsoft Foundry deployment resource to a Microsoft Foundry resource.", + "kind": "Method", + "signature": "AddDeployment(name string, model any, options ...*AddDeploymentOptions) FoundryDeploymentResource", + "receiver": "FoundryResource", + "parameters": [ + { + "name": "name", + "type": "string" + }, + { + "name": "model", + "type": "any", + "allowedTypes": [ + "*FoundryModel", + "string" + ] + } + ], + "options": { + "typeName": "AddDeploymentOptions", + "fields": [ + { + "name": "ModelVersion", + "jsonName": "modelVersion", + "type": "*string" + }, + { + "name": "Format", + "jsonName": "format", + "type": "*string" + } + ] + }, + "returnType": "FoundryDeploymentResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryResource" + ], + "appliesTo": [ + "FoundryResource" + ] + }, + { + "name": "AddProject", + "capabilityId": "Aspire.Hosting.Foundry/addProject", + "qualifiedName": "addProject", + "description": "Adds a Microsoft Foundry project resource to the application model. This will also attach the project as a deployment target for agents.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddProject(name string) AzureCognitiveServicesProjectResource", + "receiver": "FoundryResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the Microsoft Foundry project resource." + } + ], + "returnType": "AzureCognitiveServicesProjectResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryResource" + ], + "appliesTo": [ + "FoundryResource" + ] + }, + { + "name": "RunAsFoundryLocal", + "capabilityId": "Aspire.Hosting.Foundry/runAsFoundryLocal", + "qualifiedName": "runAsFoundryLocal", + "description": "Configures a Microsoft Foundry resource to use an Aspire-managed or existing Foundry Local service.", + "remarks": "When `endpoint` is provided, Aspire connects to that existing\nFoundry Local service without starting, stopping, downloading, or loading anything on its host.\nModels configured on the resource must already be loaded by the existing service.", + "returns": "The configured Microsoft Foundry resource builder.", + "kind": "Method", + "signature": "RunAsFoundryLocal(options ...*RunAsFoundryLocalOptions) FoundryResource", + "receiver": "FoundryResource", + "parameters": [], + "options": { + "typeName": "RunAsFoundryLocalOptions", + "fields": [ + { + "name": "Endpoint", + "jsonName": "endpoint", + "type": "*string", + "description": "The endpoint of an existing Foundry Local service, or `null` for an Aspire-managed service." + } + ] + }, + "returnType": "FoundryResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryResource" + ], + "appliesTo": [ + "FoundryResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "FoundryToolResource", + "fullName": "Aspire.Hosting.Foundry.FoundryToolResource", + "kind": "handle", + "description": "Base class for Foundry tool resources that participate in the Aspire application model.", + "remarks": "All Foundry tools are modeled as project-level resources, enabling dashboard visibility,\nreusability across agents, and consistent lifecycle management. Create tool instances using\nthe `Add*Tool` extension methods on `AzureCognitiveServicesProjectResource`.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "FoundryToolboxResource", + "fullName": "Aspire.Hosting.Foundry.FoundryToolboxResource", + "kind": "handle", + "description": "Represents a Microsoft Foundry Toolbox endpoint associated with a Foundry project.", + "remarks": "Toolboxes are Foundry data-plane resources with no ARM or Bicep representation. Aspire\nreconciles the desired tool definitions after the parent project is provisioned, reuses the\ncurrent default version when its configuration matches, and promotes a new immutable version\nwhen the configuration changes.", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "AsExisting", + "capabilityId": "Aspire.Hosting.Foundry/asExisting", + "qualifiedName": "asExisting", + "description": "Uses an existing Microsoft Foundry Toolbox during local runs and deployment.", + "remarks": "Existing mode validates that the remote Toolbox and optional pinned\n`Version` exist without resolving locally modeled tools or\nmutating the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AsExisting() FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "PublishAsExisting", + "capabilityId": "Aspire.Hosting.Foundry/publishAsExisting", + "qualifiedName": "publishAsExisting", + "description": "Reconciles a Microsoft Foundry Toolbox during local runs and uses an existing Toolbox during deployment.", + "remarks": "Existing mode validates that the remote Toolbox and optional pinned\n`Version` exist without resolving locally modeled tools or\nmutating the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "PublishAsExisting() FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "RunAsExisting", + "capabilityId": "Aspire.Hosting.Foundry/runAsExisting", + "qualifiedName": "runAsExisting", + "description": "Uses an existing Microsoft Foundry Toolbox during local runs and reconciles it during deployment.", + "remarks": "Existing mode validates that the remote Toolbox and optional pinned\n`Version` exist without resolving locally modeled tools or\nmutating the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "RunAsExisting() FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithAISearchTool", + "capabilityId": "Aspire.Hosting.Foundry/withAISearchTool", + "qualifiedName": "withAISearchTool", + "description": "Adds an Azure AI Search tool definition to the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAISearchTool(name string, search AzureSearchResource, indexName string, options ...*WithAISearchToolOptions) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The tool name." + }, + { + "name": "search", + "type": "AzureSearchResource", + "description": "The Azure AI Search resource backing the tool." + }, + { + "name": "indexName", + "type": "string", + "description": "The search index name." + } + ], + "options": { + "typeName": "WithAISearchToolOptions", + "fields": [ + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "An optional description of the Azure AI Search tool." + } + ] + }, + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithDescription", + "capabilityId": "Aspire.Hosting.Foundry/withDescription", + "qualifiedName": "withDescription", + "description": "Sets the description persisted with each Toolbox version.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDescription(description string) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [ + { + "name": "description", + "type": "string", + "description": "The Toolbox description." + } + ], + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithMcpTool", + "capabilityId": "Aspire.Hosting.Foundry/withMcpTool", + "qualifiedName": "withMcpTool", + "description": "Adds an MCP tool definition to the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithMcpTool(name string, endpoint any, options ...*FoundryToolboxMcpToolOptions) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The tool name." + }, + { + "name": "endpoint", + "type": "any", + "allowedTypes": [ + "string", + "EndpointReference", + "*ReferenceExpression" + ], + "description": "The MCP endpoint. A string URI, an `EndpointReference` pointing at a resource endpoint, or a `ReferenceExpression` for cases where the endpoint URL needs to be composed (for example, appending the MCP server's mount path or chaining through a public ingress like a dev tunnel)." + } + ], + "options": { + "typeName": "FoundryToolboxMcpToolOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + }, + { + "name": "WithWebSearchTool", + "capabilityId": "Aspire.Hosting.Foundry/withWebSearchTool", + "qualifiedName": "withWebSearchTool", + "description": "Adds a web search tool definition to the Toolbox.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithWebSearchTool(options ...*WithWebSearchToolOptions) FoundryToolboxResource", + "receiver": "FoundryToolboxResource", + "parameters": [], + "options": { + "typeName": "WithWebSearchToolOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The tool name." + }, + { + "name": "Description", + "jsonName": "description", + "type": "*string", + "description": "An optional description of the web search tool." + } + ] + }, + "returnType": "FoundryToolboxResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.FoundryToolboxResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.FoundryToolboxResource" + ], + "appliesTo": [ + "FoundryToolboxResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "FunctionToolResource", + "fullName": "Aspire.Hosting.Foundry.FunctionToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to call a user-defined function.", + "remarks": "Function calling tools allow agents to invoke functions defined by the application.\nThe agent decides when to call the function based on the function name, description,\nand parameter schema, then returns a structured function call request that the\napplication handles.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "HostedAgentConfiguration", + "fullName": "Aspire.Hosting.Foundry.HostedAgentConfiguration", + "kind": "handle", + "description": "A configuration helper for hosted agents.", + "remarks": "This type is used instead of `ProjectsAgentVersionCreationOptions` to provide a strongly typed\nconfiguration surface for hosted agent definitions. When used from polyglot AppHosts, only the\nATS-compatible properties are exported; Azure SDK-specific members remain .NET-only.", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "Cpu", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.cpu", + "qualifiedName": "HostedAgentConfiguration.cpu", + "description": "CPU allocation for each hosted agent instance, in vCPU cores.", + "kind": "PropertyGetter", + "signature": "Cpu() (float64, error)", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "Description", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.description", + "qualifiedName": "HostedAgentConfiguration.description", + "description": "The description of the hosted agent.", + "kind": "PropertyGetter", + "signature": "Description() (string, error)", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "(string, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "EnvironmentVariables", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.environmentVariables", + "qualifiedName": "HostedAgentConfiguration.environmentVariables", + "description": "Environment variables to set in the hosted agent container.", + "kind": "PropertyGetter", + "signature": "EnvironmentVariables() *Dict[string, string]", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "Memory", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.memory", + "qualifiedName": "HostedAgentConfiguration.memory", + "description": "Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation.", + "kind": "PropertyGetter", + "signature": "Memory() (float64, error)", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "(float64, error)", + "errorModel": "returned", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "Metadata", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.metadata", + "qualifiedName": "HostedAgentConfiguration.metadata", + "description": "Additional metadata to associate with the hosted agent.", + "kind": "PropertyGetter", + "signature": "Metadata() *Dict[string, string]", + "receiver": "HostedAgentConfiguration", + "parameters": [], + "returnType": "*Dict[string, string]", + "errorModel": "none", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "SetCpu", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.setCpu", + "qualifiedName": "HostedAgentConfiguration.setCpu", + "description": "CPU allocation for each hosted agent instance, in vCPU cores.", + "kind": "PropertySetter", + "signature": "SetCpu(value float64) HostedAgentConfiguration", + "receiver": "HostedAgentConfiguration", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "CPU allocation for each hosted agent instance, in vCPU cores." + } + ], + "returnType": "HostedAgentConfiguration", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "SetDescription", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.setDescription", + "qualifiedName": "HostedAgentConfiguration.setDescription", + "description": "The description of the hosted agent.", + "kind": "PropertySetter", + "signature": "SetDescription(value string) HostedAgentConfiguration", + "receiver": "HostedAgentConfiguration", + "parameters": [ + { + "name": "value", + "type": "string", + "description": "The description of the hosted agent." + } + ], + "returnType": "HostedAgentConfiguration", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + }, + { + "name": "SetMemory", + "capabilityId": "Aspire.Hosting.Foundry/HostedAgentConfiguration.setMemory", + "qualifiedName": "HostedAgentConfiguration.setMemory", + "description": "Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation.", + "kind": "PropertySetter", + "signature": "SetMemory(value float64) HostedAgentConfiguration", + "receiver": "HostedAgentConfiguration", + "parameters": [ + { + "name": "value", + "type": "float64", + "description": "Memory allocation for each hosted agent instance, in GiB. Must be 2x the CPU allocation." + } + ], + "returnType": "HostedAgentConfiguration", + "returnsReceiver": true, + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Foundry/Aspire.Hosting.Foundry.HostedAgentConfiguration", + "expandedTargetTypes": [ + "Aspire.Hosting.Foundry.HostedAgentConfiguration" + ], + "appliesTo": [ + "HostedAgentConfiguration" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "ImageGenerationToolResource", + "fullName": "Aspire.Hosting.Foundry.ImageGenerationToolResource", + "kind": "handle", + "description": "A Foundry tool resource that enables an agent to generate and edit images.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "SharePointToolResource", + "fullName": "Aspire.Hosting.Foundry.SharePointToolResource", + "kind": "handle", + "description": "A Foundry tool resource that grounds an agent's responses using SharePoint data.", + "remarks": "SharePoint connections must be configured in the Foundry project beforehand.\nThis tool references existing connections by their Foundry project connection IDs.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + }, + { + "name": "WebSearchToolResource", + "fullName": "Aspire.Hosting.Foundry.WebSearchToolResource", + "kind": "handle", + "description": "A Foundry tool resource that retrieves real-time information from the public web and returns answers with inline citations.", + "remarks": "This is the recommended way to add web grounding to an agent.\nNo Azure provisioning is required — the tool is provided by the Foundry Agent Service.", + "implementedInterfaces": [ + "Resource" + ], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "FoundryModel", + "fullName": "Aspire.Hosting.Foundry.FoundryModel", + "kind": "dto", + "description": "Describes a model that can be deployed to Microsoft Foundry.", + "fields": [ + { + "name": "Name", + "jsonName": "Name", + "type": "string", + "description": "The name of the model." + }, + { + "name": "Version", + "jsonName": "Version", + "type": "string", + "description": "The version of the model." + }, + { + "name": "Format", + "jsonName": "Format", + "type": "string", + "description": "The format or provider of the model (e.g., OpenAI, Microsoft, xAi, Deepseek)." + } + ] + }, + { + "name": "FoundryToolboxMcpApprovalFilter", + "fullName": "Aspire.Hosting.Foundry.FoundryToolboxMcpApprovalFilter", + "kind": "dto", + "description": "Selects MCP tools by name or read-only status for an approval policy.", + "fields": [ + { + "name": "ToolNames", + "jsonName": "ToolNames", + "type": "[]string", + "description": "Gets or sets the names of the MCP tools selected by this filter." + }, + { + "name": "ReadOnly", + "jsonName": "ReadOnly", + "type": "*bool", + "isOptional": true, + "description": "Gets or sets whether this filter selects read-only or non-read-only MCP tools." + } + ] + }, + { + "name": "FoundryToolboxMcpApprovalPolicy", + "fullName": "Aspire.Hosting.Foundry.FoundryToolboxMcpApprovalPolicy", + "kind": "dto", + "description": "Declares which tools discovered from an MCP server require approval.", + "fields": [ + { + "name": "Global", + "jsonName": "Global", + "type": "*FoundryToolboxMcpGlobalApprovalMode", + "isOptional": true, + "description": "Gets or sets a policy that applies to every tool exposed by the MCP server." + }, + { + "name": "Always", + "jsonName": "Always", + "type": "*FoundryToolboxMcpApprovalFilter", + "description": "Gets or sets the filter for MCP tools that always require approval." + }, + { + "name": "Never", + "jsonName": "Never", + "type": "*FoundryToolboxMcpApprovalFilter", + "description": "Gets or sets the filter for MCP tools that never require approval." + } + ] + }, + { + "name": "FoundryToolboxMcpToolOptions", + "fullName": "Aspire.Hosting.Foundry.FoundryToolboxMcpToolOptions", + "kind": "dto", + "description": "Options for an MCP tool in a Microsoft Foundry Toolbox.", + "fields": [ + { + "name": "ServerLabel", + "jsonName": "ServerLabel", + "type": "*string", + "description": "Gets or sets the label that identifies the MCP server in the Toolbox and prefixes its discovered tool names. The Toolbox tool name is used when unset." + }, + { + "name": "ServerDescription", + "jsonName": "ServerDescription", + "type": "*string", + "description": "Gets or sets a description of the MCP server." + }, + { + "name": "ApprovalPolicy", + "jsonName": "ApprovalPolicy", + "type": "*FoundryToolboxMcpApprovalPolicy", + "description": "Gets or sets the declared approval policy for tools discovered from the MCP server." + } + ] + }, + { + "name": "FoundryToolboxOptions", + "fullName": "Aspire.Hosting.Foundry.FoundryToolboxOptions", + "kind": "dto", + "description": "Options used when adding a Microsoft Foundry Toolbox resource to a project.", + "fields": [ + { + "name": "Version", + "jsonName": "Version", + "type": "*string", + "description": "Gets or sets the optional Toolbox version to reference. When unset, the default Toolbox version is used." + } + ] + }, + { + "name": "HostedAgentOptions", + "fullName": "Aspire.Hosting.Foundry.HostedAgentOptions", + "kind": "dto", + "description": "Options that control how a compute resource is deployed as a Microsoft Foundry hosted agent. All properties are optional; unset properties fall back to the Foundry hosted agent defaults.", + "fields": [ + { + "name": "Description", + "jsonName": "Description", + "type": "*string", + "description": "Human-readable description of the hosted agent surfaced in the Microsoft Foundry portal. When not set, the hosted agent default description is used." + }, + { + "name": "Cpu", + "jsonName": "Cpu", + "type": "*float64", + "isOptional": true, + "description": "CPU allocation for each hosted agent instance, in vCPU cores. Must be between 0.5 and 3.5 in increments of 0.25. When not set, the hosted agent default CPU allocation is used." + }, + { + "name": "Memory", + "jsonName": "Memory", + "type": "*float64", + "isOptional": true, + "description": "Memory allocation for each hosted agent instance, in GiB. Must be between 1 and 7 in increments of 0.5 and equal to twice the CPU value. When not set, the hosted agent default memory allocation is used." + }, + { + "name": "Metadata", + "jsonName": "Metadata", + "type": "map[string]string", + "isOptional": true, + "description": "Additional metadata key/value pairs to attach to the hosted agent definition. Entries with the same key as an existing metadata entry overwrite it." + }, + { + "name": "EnvironmentVariables", + "jsonName": "EnvironmentVariables", + "type": "map[string]string", + "isOptional": true, + "description": "Environment variables to set on the hosted agent container at runtime. Entries with the same key as an existing environment variable overwrite it." + } + ] + } + ], + "enumTypes": [ + { + "name": "FoundryToolboxMcpGlobalApprovalMode", + "fullName": "Aspire.Hosting.Foundry.FoundryToolboxMcpGlobalApprovalMode", + "kind": "enum", + "description": "Declares a global approval requirement for tools discovered from an MCP server.", + "members": [ + { + "name": "FoundryToolboxMcpGlobalApprovalModeNever", + "value": "Never", + "description": "No discovered tool requires approval." + }, + { + "name": "FoundryToolboxMcpGlobalApprovalModeAlways", + "value": "Always", + "description": "Every discovered tool requires approval." + } + ] + }, + { + "name": "HostedAgentProtocol", + "fullName": "Aspire.Hosting.Foundry.HostedAgentProtocol", + "kind": "enum", + "description": "Protocols supported by Microsoft Foundry hosted agent containers.", + "members": [ + { + "name": "HostedAgentProtocolResponses", + "value": "Responses", + "description": "The hosted agent container exposes the Responses protocol." + }, + { + "name": "HostedAgentProtocolInvocations", + "value": "Invocations", + "description": "The hosted agent container exposes the Invocations protocol." + } + ] + }, + { + "name": "FoundryRole", + "fullName": "Aspire.Hosting.FoundryRole", + "kind": "enum", + "description": "Represents ATS-compatible Microsoft Foundry roles.", + "members": [ + { + "name": "FoundryRoleCognitiveServicesOpenAIContributor", + "value": "CognitiveServicesOpenAIContributor", + "description": "Allows full management of Azure OpenAI resources." + }, + { + "name": "FoundryRoleCognitiveServicesOpenAIUser", + "value": "CognitiveServicesOpenAIUser", + "description": "Allows using Azure OpenAI models for inference." + }, + { + "name": "FoundryRoleCognitiveServicesUser", + "value": "CognitiveServicesUser", + "description": "Allows access to Azure Cognitive Services resources." + } + ] + } + ], + "exportedValues": [ + { + "name": "FoundryModels", + "fullName": "FoundryModels", + "kind": "exportedValue", + "values": [ + { + "path": "Anthropic.ClaudeFable5", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-fable-5\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeFable51", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-fable-5-1\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeHaiku45", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-haiku-4-5\",\"Version\":\"2\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeMythos5", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-mythos-5\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeMythos51", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-mythos-5-1\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeMythosPreview", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-mythos-preview\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeOpus45", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-opus-4-5\",\"Version\":\"20251101\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeOpus46", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-opus-4-6\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeOpus47", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-opus-4-7\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeOpus48", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-opus-4-8\",\"Version\":\"2\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeOpus5", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-opus-5\",\"Version\":\"2\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeSonnet45", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-sonnet-4-5\",\"Version\":\"20250929\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeSonnet46", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-sonnet-4-6\",\"Version\":\"1\",\"Format\":\"Anthropic\"}" + }, + { + "path": "Anthropic.ClaudeSonnet5", + "type": "*FoundryModel", + "value": "{\"Name\":\"claude-sonnet-5\",\"Version\":\"2\",\"Format\":\"Anthropic\"}" + }, + { + "path": "BlackForestLabs.Flux11Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"FLUX-1.1-pro\",\"Version\":\"1\",\"Format\":\"Black Forest Labs\"}" + }, + { + "path": "BlackForestLabs.Flux1KontextPro", + "type": "*FoundryModel", + "value": "{\"Name\":\"FLUX.1-Kontext-pro\",\"Version\":\"1\",\"Format\":\"Black Forest Labs\"}" + }, + { + "path": "BlackForestLabs.Flux2Flex", + "type": "*FoundryModel", + "value": "{\"Name\":\"FLUX.2-flex\",\"Version\":\"1\",\"Format\":\"Black Forest Labs\"}" + }, + { + "path": "BlackForestLabs.Flux2Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"FLUX.2-pro\",\"Version\":\"1\",\"Format\":\"Black Forest Labs\"}" + }, + { + "path": "Cohere.CohereCommandA", + "type": "*FoundryModel", + "value": "{\"Name\":\"cohere-command-a\",\"Version\":\"4\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.CohereCommandAPlus052026", + "type": "*FoundryModel", + "value": "{\"Name\":\"Cohere-command-a-plus-05-2026\",\"Version\":\"1\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.CohereEmbedV3English", + "type": "*FoundryModel", + "value": "{\"Name\":\"Cohere-embed-v3-english\",\"Version\":\"1\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.CohereEmbedV3Multilingual", + "type": "*FoundryModel", + "value": "{\"Name\":\"Cohere-embed-v3-multilingual\",\"Version\":\"1\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.CohereParseV5", + "type": "*FoundryModel", + "value": "{\"Name\":\"Cohere-parse-v5\",\"Version\":\"1\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.CohereRerankV40Fast", + "type": "*FoundryModel", + "value": "{\"Name\":\"Cohere-rerank-v4.0-fast\",\"Version\":\"2\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.CohereRerankV40Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"Cohere-rerank-v4.0-pro\",\"Version\":\"1\",\"Format\":\"Cohere\"}" + }, + { + "path": "Cohere.EmbedV40", + "type": "*FoundryModel", + "value": "{\"Name\":\"embed-v-4-0\",\"Version\":\"6\",\"Format\":\"Cohere\"}" + }, + { + "path": "DeepSeek.DeepSeekV32", + "type": "*FoundryModel", + "value": "{\"Name\":\"DeepSeek-V3.2\",\"Version\":\"1\",\"Format\":\"DeepSeek\"}" + }, + { + "path": "DeepSeek.DeepSeekV32Speciale", + "type": "*FoundryModel", + "value": "{\"Name\":\"DeepSeek-V3.2-Speciale\",\"Version\":\"1\",\"Format\":\"DeepSeek\"}" + }, + { + "path": "DeepSeek.DeepSeekV4Flash", + "type": "*FoundryModel", + "value": "{\"Name\":\"DeepSeek-V4-Flash\",\"Version\":\"2026-04-23\",\"Format\":\"DeepSeek\"}" + }, + { + "path": "DeepSeek.DeepSeekV4Flash0731", + "type": "*FoundryModel", + "value": "{\"Name\":\"DeepSeek-V4-Flash-0731\",\"Version\":\"2026-07-31\",\"Format\":\"DeepSeek\"}" + }, + { + "path": "DeepSeek.DeepSeekV4Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"DeepSeek-V4-Pro\",\"Version\":\"2026-04-23\",\"Format\":\"DeepSeek\"}" + }, + { + "path": "Local.DeepseekR114b", + "type": "*FoundryModel", + "value": "{\"Name\":\"deepseek-r1-14b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.DeepseekR115b", + "type": "*FoundryModel", + "value": "{\"Name\":\"deepseek-r1-1.5b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.DeepseekR17b", + "type": "*FoundryModel", + "value": "{\"Name\":\"deepseek-r1-7b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Gemma4E2bIt", + "type": "*FoundryModel", + "value": "{\"Name\":\"gemma-4-e2b-it\",\"Version\":\"3\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.GptOss20b", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-oss-20b\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Ministral33bInstruct2512", + "type": "*FoundryModel", + "value": "{\"Name\":\"ministral-3-3b-instruct-2512\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Mistral7bV02", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-7b-v0.2\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.MistralNemo12bInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-nemo-12b-instruct\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Nemotron35AsrStreaming06b", + "type": "*FoundryModel", + "value": "{\"Name\":\"nemotron-3.5-asr-streaming-0.6b\",\"Version\":\"3\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.NemotronSpeechStreamingEn06b", + "type": "*FoundryModel", + "value": "{\"Name\":\"nemotron-speech-streaming-en-0.6b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.NemotronSpeechStreamingEs06b", + "type": "*FoundryModel", + "value": "{\"Name\":\"nemotron-speech-streaming-es-0.6b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Olmo37bInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"olmo-3-7b-instruct\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.ParakeetTdt06bV2", + "type": "*FoundryModel", + "value": "{\"Name\":\"parakeet-tdt-0.6b-v2\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Phi35Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"phi-3.5-mini\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Phi3Mini128k", + "type": "*FoundryModel", + "value": "{\"Name\":\"phi-3-mini-128k\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Phi3Mini4k", + "type": "*FoundryModel", + "value": "{\"Name\":\"phi-3-mini-4k\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Phi4", + "type": "*FoundryModel", + "value": "{\"Name\":\"phi-4\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Phi4Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"phi-4-mini\",\"Version\":\"5\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Phi4MiniReasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"phi-4-mini-reasoning\",\"Version\":\"3\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen2505b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-0.5b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen2514b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-14b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen2515b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-1.5b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen257b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-7b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen25Coder05b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-coder-0.5b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen25Coder14b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-coder-14b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen25Coder15b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-coder-1.5b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen25Coder3b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-coder-3b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen25Coder7b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen2.5-coder-7b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen306b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-0.6b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen314b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-14b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen317b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-1.7b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen34b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-4b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen3508b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3.5-0.8b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen352b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3.5-2b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen352bText", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3.5-2b-text\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen354b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3.5-4b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen359b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3.5-9b\",\"Version\":\"4\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen38b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-8b\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen3Embedding06b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-embedding-0.6b\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen3Embedding8b", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-embedding-8b\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen3Vl2bInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-vl-2b-instruct\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen3Vl4bInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-vl-4b-instruct\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Qwen3Vl8bInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"qwen3-vl-8b-instruct\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Local.Smollm33b", + "type": "*FoundryModel", + "value": "{\"Name\":\"smollm3-3b\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Meta.Llama3211BVisionInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Llama-3.2-11B-Vision-Instruct\",\"Version\":\"6\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.Llama3290BVisionInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Llama-3.2-90B-Vision-Instruct\",\"Version\":\"5\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.Llama3370BInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Llama-3.3-70B-Instruct\",\"Version\":\"10\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.Llama4Maverick17B128EInstructFP8", + "type": "*FoundryModel", + "value": "{\"Name\":\"Llama-4-Maverick-17B-128E-Instruct-FP8\",\"Version\":\"5\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.Llama4Scout17B16EInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Llama-4-Scout-17B-16E-Instruct\",\"Version\":\"4\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.MetaLlama31405BInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Meta-Llama-3.1-405B-Instruct\",\"Version\":\"1\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.MetaLlama318BInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Meta-Llama-3.1-8B-Instruct\",\"Version\":\"6\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.MuseSpark", + "type": "*FoundryModel", + "value": "{\"Name\":\"Muse-Spark\",\"Version\":\"1\",\"Format\":\"Meta\"}" + }, + { + "path": "Meta.MuseSpark13", + "type": "*FoundryModel", + "value": "{\"Name\":\"Muse-Spark-1.3\",\"Version\":\"1\",\"Format\":\"Meta\"}" + }, + { + "path": "Microsoft.AzureAIContentSafety", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-AI-Content-Safety\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureAIContentUnderstanding", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-AI-Content-Understanding\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureAIDocumentIntelligence", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-AI-Document-Intelligence\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureAIVision", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-AI-Vision\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureContentUnderstandingLayout", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Content-Understanding-Layout\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureContentUnderstandingRead", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Content-Understanding-Read\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureLanguageConversationalPiiRedaction", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Language-Conversational-PII-redaction\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureLanguageDocumentPiiRedaction", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Language-Document-PII-redaction\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureLanguageLanguageDetection", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Language-Language-detection\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureLanguageTextAnalyticsForHealth", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Language-Text-Analytics-for-Health\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureLanguageTextPiiRedaction", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Language-Text-PII-redaction\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureSpeechSpeechToText", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Speech-Speech-to-text\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureSpeechSpeechTranslation", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Speech-Speech-Translation\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureSpeechTextToSpeech", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Speech-Text-to-speech\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureSpeechTextToSpeechAvatar", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Speech-Text-to-speech-Avatar\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureSpeechVoiceLive", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Speech-Voice-Live\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureTranslatorDocumentTranslation", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Translator-Document-translation\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.AzureTranslatorTextTranslation", + "type": "*FoundryModel", + "value": "{\"Name\":\"Azure-Translator-Text-translation\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.MaiTranscribe1", + "type": "*FoundryModel", + "value": "{\"Name\":\"MAI-Transcribe-1\",\"Version\":\"2026-01-23\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.MaiTranscribe15", + "type": "*FoundryModel", + "value": "{\"Name\":\"MAI-Transcribe-1.5\",\"Version\":\"2026-06-02\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.MaiTranscribe2", + "type": "*FoundryModel", + "value": "{\"Name\":\"MAI-Transcribe-2\",\"Version\":\"2026-09-03\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.MaiVoice1", + "type": "*FoundryModel", + "value": "{\"Name\":\"MAI-Voice-1\",\"Version\":\"2025-12-18\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.MaiVoice2", + "type": "*FoundryModel", + "value": "{\"Name\":\"MAI-Voice-2\",\"Version\":\"2026-06-02\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.MaiVoice2Flash", + "type": "*FoundryModel", + "value": "{\"Name\":\"MAI-Voice-2-Flash\",\"Version\":\"2026-07-22\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.ModelRouter", + "type": "*FoundryModel", + "value": "{\"Name\":\"model-router\",\"Version\":\"2025-11-18\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi3Small8kInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-3-small-8k-instruct\",\"Version\":\"6\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi3Vision128kInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-3-vision-128k-instruct\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi4", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-4\",\"Version\":\"7\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi4MiniInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-4-mini-instruct\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi4MiniReasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-4-mini-reasoning\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi4MultimodalInstruct", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-4-multimodal-instruct\",\"Version\":\"2\",\"Format\":\"Microsoft\"}" + }, + { + "path": "Microsoft.Phi4Reasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"Phi-4-reasoning\",\"Version\":\"1\",\"Format\":\"Microsoft\"}" + }, + { + "path": "MistralAI.Codestral2501", + "type": "*FoundryModel", + "value": "{\"Name\":\"Codestral-2501\",\"Version\":\"2\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.Ministral3B", + "type": "*FoundryModel", + "value": "{\"Name\":\"Ministral-3B\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.MistralDocumentAi2512", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-document-ai-2512\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.MistralLarge3", + "type": "*FoundryModel", + "value": "{\"Name\":\"Mistral-Large-3\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.MistralMedium2505", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-medium-2505\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.MistralMedium35", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-medium-3-5\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.MistralOcr40", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-ocr-4-0\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "MistralAI.MistralSmall2503", + "type": "*FoundryModel", + "value": "{\"Name\":\"mistral-small-2503\",\"Version\":\"1\",\"Format\":\"Mistral AI\"}" + }, + { + "path": "OpenAI.CodexMini", + "type": "*FoundryModel", + "value": "{\"Name\":\"codex-mini\",\"Version\":\"2025-05-16\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.ComputerUsePreview", + "type": "*FoundryModel", + "value": "{\"Name\":\"computer-use-preview\",\"Version\":\"2025-03-11\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt41", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4.1\",\"Version\":\"2025-04-14\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt41Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4.1-mini\",\"Version\":\"2025-04-14\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt41Nano", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4.1-nano\",\"Version\":\"2025-04-14\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt4o", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4o\",\"Version\":\"2024-11-20\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt4oMini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4o-mini\",\"Version\":\"2024-07-18\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt4oMiniTranscribe", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4o-mini-transcribe\",\"Version\":\"2025-12-15\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt4oMiniTts", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4o-mini-tts\",\"Version\":\"2025-12-15\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt4oTranscribe", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4o-transcribe\",\"Version\":\"2025-03-20\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt4oTranscribeDiarize", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-4o-transcribe-diarize\",\"Version\":\"2025-10-15\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt5", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5\",\"Version\":\"2025-08-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt51", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.1\",\"Version\":\"2025-11-13\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt51Codex", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.1-codex\",\"Version\":\"2025-11-13\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt51CodexMax", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.1-codex-max\",\"Version\":\"2025-12-04\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt51CodexMini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.1-codex-mini\",\"Version\":\"2025-11-13\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt52", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.2\",\"Version\":\"2025-12-11\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt52Codex", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.2-codex\",\"Version\":\"2026-01-14\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt53Codex", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.3-codex\",\"Version\":\"2026-02-24\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt54", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.4\",\"Version\":\"2026-03-05\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt54Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.4-mini\",\"Version\":\"2026-03-17\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt54Nano", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.4-nano\",\"Version\":\"2026-03-17\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt54Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.4-pro\",\"Version\":\"2026-03-05\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt55", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.5\",\"Version\":\"2026-04-24\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt56Luna", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.6-luna\",\"Version\":\"2026-07-09\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt56Sol", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.6-sol\",\"Version\":\"2026-07-09\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt56Terra", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5.6-terra\",\"Version\":\"2026-07-09\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt5Codex", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5-codex\",\"Version\":\"2025-09-15\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt5Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5-mini\",\"Version\":\"2025-08-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt5Nano", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5-nano\",\"Version\":\"2025-08-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt5Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-5-pro\",\"Version\":\"2025-10-06\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Gpt6Astra", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-6-astra\",\"Version\":\"2026-09-03\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptAudio", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-audio\",\"Version\":\"2025-08-28\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptAudio15", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-audio-1.5\",\"Version\":\"2026-02-23\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptAudioMini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-audio-mini\",\"Version\":\"2025-10-06\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptChatLatest", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-chat-latest\",\"Version\":\"2026-08-06\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptImage15", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-image-1.5\",\"Version\":\"2025-12-16\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptImage1Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-image-1-mini\",\"Version\":\"2025-10-06\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptImage2", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-image-2\",\"Version\":\"2026-04-21\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptImage25Flare", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-image-2.5-flare\",\"Version\":\"2026-09-08\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptImage25Sunburst", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-image-2.5-sunburst\",\"Version\":\"2026-09-08\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptLive1", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-live-1\",\"Version\":\"2026-09-10\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptLiveTranscribe", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-live-transcribe\",\"Version\":\"2026-07-28\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptOss120b", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-oss-120b\",\"Version\":\"4\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptOss20b", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-oss-20b\",\"Version\":\"11\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtime", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime\",\"Version\":\"2025-08-28\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtime15", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-1.5\",\"Version\":\"2026-02-23\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtime2", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-2\",\"Version\":\"2026-05-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtime21", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-2.1\",\"Version\":\"2026-07-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtime21Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-2.1-mini\",\"Version\":\"2026-07-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtimeMini", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-mini\",\"Version\":\"2025-12-15\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtimeTranslate", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-translate\",\"Version\":\"2026-05-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptRealtimeWhisper", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-realtime-whisper\",\"Version\":\"2026-05-07\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.GptTranscribe", + "type": "*FoundryModel", + "value": "{\"Name\":\"gpt-transcribe\",\"Version\":\"2026-07-28\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.O1", + "type": "*FoundryModel", + "value": "{\"Name\":\"o1\",\"Version\":\"2024-12-17\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.O3", + "type": "*FoundryModel", + "value": "{\"Name\":\"o3\",\"Version\":\"2025-04-16\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.O3DeepResearch", + "type": "*FoundryModel", + "value": "{\"Name\":\"o3-deep-research\",\"Version\":\"2025-06-26\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.O3Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"o3-mini\",\"Version\":\"2025-01-31\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.O3Pro", + "type": "*FoundryModel", + "value": "{\"Name\":\"o3-pro\",\"Version\":\"2025-06-10\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.O4Mini", + "type": "*FoundryModel", + "value": "{\"Name\":\"o4-mini\",\"Version\":\"2025-04-16\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.TextEmbedding3Large", + "type": "*FoundryModel", + "value": "{\"Name\":\"text-embedding-3-large\",\"Version\":\"1\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.TextEmbedding3Small", + "type": "*FoundryModel", + "value": "{\"Name\":\"text-embedding-3-small\",\"Version\":\"1\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.TextEmbeddingAda002", + "type": "*FoundryModel", + "value": "{\"Name\":\"text-embedding-ada-002\",\"Version\":\"2\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Tts", + "type": "*FoundryModel", + "value": "{\"Name\":\"tts\",\"Version\":\"001\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.TtsHd", + "type": "*FoundryModel", + "value": "{\"Name\":\"tts-hd\",\"Version\":\"001\",\"Format\":\"OpenAI\"}" + }, + { + "path": "OpenAI.Whisper", + "type": "*FoundryModel", + "value": "{\"Name\":\"whisper\",\"Version\":\"001\",\"Format\":\"OpenAI\"}" + }, + { + "path": "StabilityAI.StableDiffusion35Large", + "type": "*FoundryModel", + "value": "{\"Name\":\"Stable-Diffusion-3.5-Large\",\"Version\":\"1\",\"Format\":\"StabilityAI\"}" + }, + { + "path": "StabilityAI.StableImageCore", + "type": "*FoundryModel", + "value": "{\"Name\":\"Stable-Image-Core\",\"Version\":\"1\",\"Format\":\"StabilityAI\"}" + }, + { + "path": "StabilityAI.StableImageUltra", + "type": "*FoundryModel", + "value": "{\"Name\":\"Stable-Image-Ultra\",\"Version\":\"1\",\"Format\":\"StabilityAI\"}" + }, + { + "path": "XAI.Grok4", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.Grok41FastNonReasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4-1-fast-non-reasoning\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.Grok41FastReasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4-1-fast-reasoning\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.Grok420NonReasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4-20-non-reasoning\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.Grok420Reasoning", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4-20-reasoning\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.Grok43", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4.3\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.Grok46", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-4.6\",\"Version\":\"1\",\"Format\":\"xAI\"}" + }, + { + "path": "XAI.GrokCodeFast1", + "type": "*FoundryModel", + "value": "{\"Name\":\"grok-code-fast-1\",\"Version\":\"1\",\"Format\":\"xAI\"}" + } + ] + } + ] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Garnet.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Garnet.13.6.0.json new file mode 100644 index 0000000000..f22a38abbc --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Garnet.13.6.0.json @@ -0,0 +1,528 @@ +{ + "package": { + "name": "Aspire.Hosting.Garnet", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.connectionStringExpression", + "qualifiedName": "GarnetResource.connectionStringExpression", + "description": "Gets the connection string expression for the Garnet server.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "Host", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.host", + "qualifiedName": "GarnetResource.host", + "description": "Gets the host endpoint reference for this resource.", + "kind": "PropertyGetter", + "signature": "Host() EndpointReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "PasswordParameter", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.passwordParameter", + "qualifiedName": "GarnetResource.passwordParameter", + "description": "Gets the parameter that contains the Garnet server password.", + "kind": "PropertyGetter", + "signature": "PasswordParameter() ParameterResource", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "ParameterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.port", + "qualifiedName": "GarnetResource.port", + "description": "Gets the port endpoint reference for this resource.", + "kind": "PropertyGetter", + "signature": "Port() EndpointReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "PrimaryEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.primaryEndpoint", + "qualifiedName": "GarnetResource.primaryEndpoint", + "description": "Gets the primary endpoint for the Garnet server.", + "kind": "PropertyGetter", + "signature": "PrimaryEndpoint() EndpointReference", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.uriExpression", + "qualifiedName": "GarnetResource.uriExpression", + "description": "Gets the connection URI expression for the Garnet server.", + "remarks": "Format: `redis://[:{password}@]{host}:{port}`. The password segment is omitted when no password is configured.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "AddGarnet", + "capabilityId": "Aspire.Hosting.Garnet/addGarnet", + "qualifiedName": "addGarnet", + "description": "Adds a Garnet container resource to the application model.", + "kind": "Method", + "signature": "AddGarnet(name string, options ...*AddGarnetOptions) GarnetResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string" + } + ], + "options": { + "typeName": "AddGarnetOptions", + "fields": [ + { + "name": "Port", + "jsonName": "port", + "type": "*float64" + }, + { + "name": "Password", + "jsonName": "password", + "type": "*ParameterResource" + } + ] + }, + "returnType": "GarnetResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.Garnet/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the data folder to a Garnet container resource and enables Garnet persistence.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataBindMount(source string, options ...*WithDataBindMountOptions) GarnetResource", + "receiver": "GarnetResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source directory on the host to mount into the container." + } + ], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount. Setting this to `true` will disable Garnet persistence. Defaults to `false`." + } + ] + }, + "returnType": "GarnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Garnet/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to a Garnet container resource and enables Garnet persistence.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) GarnetResource", + "receiver": "GarnetResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only volume. Setting this to `true` will disable Garnet persistence. Defaults to `false`." + } + ] + }, + "returnType": "GarnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "WithPersistence", + "capabilityId": "Aspire.Hosting.Garnet/withPersistence", + "qualifiedName": "withPersistence", + "description": "Configures a Garnet container resource for persistence.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPersistence(options ...*WithPersistenceOptions) GarnetResource", + "receiver": "GarnetResource", + "parameters": [], + "options": { + "typeName": "WithPersistenceOptions", + "fields": [ + { + "name": "Interval", + "jsonName": "interval", + "type": "*float64", + "description": "The interval between snapshot exports. Defaults to 60 seconds." + } + ] + }, + "returnType": "GarnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + } + ], + "handleTypes": [ + { + "name": "GarnetResource", + "fullName": "Aspire.Hosting.ApplicationModel.GarnetResource", + "kind": "handle", + "description": "A resource that represents a Garnet resource independent of the hosting model.", + "implementedInterfaces": [ + "ExpressionValue", + "IComputeResource", + "Resource", + "ResourceWithArgs", + "ResourceWithConnectionString", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "ConnectionStringExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.connectionStringExpression", + "qualifiedName": "GarnetResource.connectionStringExpression", + "description": "Gets the connection string expression for the Garnet server.", + "kind": "PropertyGetter", + "signature": "ConnectionStringExpression() *ReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "Host", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.host", + "qualifiedName": "GarnetResource.host", + "description": "Gets the host endpoint reference for this resource.", + "kind": "PropertyGetter", + "signature": "Host() EndpointReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "PasswordParameter", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.passwordParameter", + "qualifiedName": "GarnetResource.passwordParameter", + "description": "Gets the parameter that contains the Garnet server password.", + "kind": "PropertyGetter", + "signature": "PasswordParameter() ParameterResource", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "ParameterResource", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "Port", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.port", + "qualifiedName": "GarnetResource.port", + "description": "Gets the port endpoint reference for this resource.", + "kind": "PropertyGetter", + "signature": "Port() EndpointReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "EndpointReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "PrimaryEndpoint", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.primaryEndpoint", + "qualifiedName": "GarnetResource.primaryEndpoint", + "description": "Gets the primary endpoint for the Garnet server.", + "kind": "PropertyGetter", + "signature": "PrimaryEndpoint() EndpointReference", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "EndpointReference", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "UriExpression", + "capabilityId": "Aspire.Hosting.ApplicationModel/GarnetResource.uriExpression", + "qualifiedName": "GarnetResource.uriExpression", + "description": "Gets the connection URI expression for the Garnet server.", + "remarks": "Format: `redis://[:{password}@]{host}:{port}`. The password segment is omitted when no password is configured.", + "kind": "PropertyGetter", + "signature": "UriExpression() *ReferenceExpression", + "receiver": "GarnetResource", + "parameters": [], + "returnType": "*ReferenceExpression", + "errorModel": "deferred", + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "WithDataBindMount", + "capabilityId": "Aspire.Hosting.Garnet/withDataBindMount", + "qualifiedName": "withDataBindMount", + "description": "Adds a bind mount for the data folder to a Garnet container resource and enables Garnet persistence.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataBindMount(source string, options ...*WithDataBindMountOptions) GarnetResource", + "receiver": "GarnetResource", + "parameters": [ + { + "name": "source", + "type": "string", + "description": "The source directory on the host to mount into the container." + } + ], + "options": { + "typeName": "WithDataBindMountOptions", + "fields": [ + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only mount. Setting this to `true` will disable Garnet persistence. Defaults to `false`." + } + ] + }, + "returnType": "GarnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "WithDataVolume", + "capabilityId": "Aspire.Hosting.Garnet/withDataVolume", + "qualifiedName": "withDataVolume", + "description": "Adds a named volume for the data folder to a Garnet container resource and enables Garnet persistence.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDataVolume(options ...*WithDataVolumeOptions) GarnetResource", + "receiver": "GarnetResource", + "parameters": [], + "options": { + "typeName": "WithDataVolumeOptions", + "fields": [ + { + "name": "Name", + "jsonName": "name", + "type": "*string", + "description": "The name of the volume. Defaults to an auto-generated name based on the application and resource names." + }, + { + "name": "IsReadOnly", + "jsonName": "isReadOnly", + "type": "*bool", + "description": "A flag that indicates if this is a read-only volume. Setting this to `true` will disable Garnet persistence. Defaults to `false`." + } + ] + }, + "returnType": "GarnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + }, + { + "name": "WithPersistence", + "capabilityId": "Aspire.Hosting.Garnet/withPersistence", + "qualifiedName": "withPersistence", + "description": "Configures a Garnet container resource for persistence.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithPersistence(options ...*WithPersistenceOptions) GarnetResource", + "receiver": "GarnetResource", + "parameters": [], + "options": { + "typeName": "WithPersistenceOptions", + "fields": [ + { + "name": "Interval", + "jsonName": "interval", + "type": "*float64", + "description": "The interval between snapshot exports. Defaults to 60 seconds." + } + ] + }, + "returnType": "GarnetResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Garnet/Aspire.Hosting.ApplicationModel.GarnetResource", + "expandedTargetTypes": [ + "Aspire.Hosting.ApplicationModel.GarnetResource" + ], + "appliesTo": [ + "GarnetResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.GitHub.Models.13.5.4.json b/src/frontend/src/data/go-modules/Aspire.Hosting.GitHub.Models.13.5.4.json new file mode 100644 index 0000000000..cd34b277bf --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.GitHub.Models.13.5.4.json @@ -0,0 +1,442 @@ +{ + "package": { + "name": "Aspire.Hosting.GitHub.Models", + "version": "13.5.4", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "9c1b401dd67746739044f68959cbf4d3d7af93a6" + }, + "functions": [ + { + "name": "AddGitHubModel", + "capabilityId": "Aspire.Hosting.GitHub.Models/addGitHubModel", + "qualifiedName": "addGitHubModel", + "description": "Adds a GitHub Model resource to the distributed application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddGitHubModel(name string, model GitHubModelName, options ...*AddGitHubModelOptions) GitHubModelResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + }, + { + "name": "model", + "type": "GitHubModelName", + "description": "The known model name from the `GitHubModelName` enumeration." + } + ], + "options": { + "typeName": "AddGitHubModelOptions", + "fields": [ + { + "name": "Organization", + "jsonName": "organization", + "type": "*ParameterResource", + "description": "The organization login associated with the organization to which the request is to be attributed." + } + ] + }, + "returnType": "GitHubModelResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddGitHubModelById", + "capabilityId": "Aspire.Hosting.GitHub.Models/addGitHubModelById", + "qualifiedName": "addGitHubModelById", + "description": "Adds a GitHub Model resource to the application model using a model identifier string.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddGitHubModelById(name string, modelId string, options ...*AddGitHubModelByIdOptions) GitHubModelResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource. This name will be used as the connection string name when referenced in a dependency." + }, + { + "name": "modelId", + "type": "string", + "description": "The model identifier string, for example `\"openai/gpt-4o\"`." + } + ], + "options": { + "typeName": "AddGitHubModelByIdOptions", + "fields": [ + { + "name": "Organization", + "jsonName": "organization", + "type": "*ParameterResource", + "description": "The organization login associated with the organization to which the request is to be attributed." + } + ] + }, + "returnType": "GitHubModelResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "EnableHealthCheck", + "capabilityId": "Aspire.Hosting.GitHub.Models/enableHealthCheck", + "qualifiedName": "enableHealthCheck", + "description": "Adds a health check to the GitHub Model resource.", + "remarks": "This method adds a health check that verifies the GitHub Models endpoint is accessible,\nthe API key is valid, and the specified model is available. The health check will:\n-\n-\n-\nBecause health checks are included in the rate limit of the GitHub Models API,\nit is recommended to use this health check sparingly, such as when you are having issues understanding the reason\nthe model is not working as expected. Furthermore, the health check will run a single time per application instance.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "EnableHealthCheck() GitHubModelResource", + "receiver": "GitHubModelResource", + "parameters": [], + "returnType": "GitHubModelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.GitHub.Models/Aspire.Hosting.GitHub.Models.GitHubModelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.GitHub.Models.GitHubModelResource" + ], + "appliesTo": [ + "GitHubModelResource" + ] + }, + { + "name": "WithApiKey", + "capabilityId": "Aspire.Hosting.GitHub.Models/withApiKey", + "qualifiedName": "withApiKey", + "description": "Configures the API key for the GitHub Model resource from a parameter.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithApiKey(apiKey ParameterResource) GitHubModelResource", + "receiver": "GitHubModelResource", + "parameters": [ + { + "name": "apiKey", + "type": "ParameterResource", + "description": "The API key parameter." + } + ], + "returnType": "GitHubModelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.GitHub.Models/Aspire.Hosting.GitHub.Models.GitHubModelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.GitHub.Models.GitHubModelResource" + ], + "appliesTo": [ + "GitHubModelResource" + ] + } + ], + "handleTypes": [ + { + "name": "GitHubModelResource", + "fullName": "Aspire.Hosting.GitHub.Models.GitHubModelResource", + "kind": "handle", + "implementedInterfaces": [ + "ExpressionValue", + "Resource", + "ResourceWithConnectionString" + ], + "capabilities": [ + { + "name": "EnableHealthCheck", + "capabilityId": "Aspire.Hosting.GitHub.Models/enableHealthCheck", + "qualifiedName": "enableHealthCheck", + "description": "Adds a health check to the GitHub Model resource.", + "remarks": "This method adds a health check that verifies the GitHub Models endpoint is accessible,\nthe API key is valid, and the specified model is available. The health check will:\n-\n-\n-\nBecause health checks are included in the rate limit of the GitHub Models API,\nit is recommended to use this health check sparingly, such as when you are having issues understanding the reason\nthe model is not working as expected. Furthermore, the health check will run a single time per application instance.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "EnableHealthCheck() GitHubModelResource", + "receiver": "GitHubModelResource", + "parameters": [], + "returnType": "GitHubModelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.GitHub.Models/Aspire.Hosting.GitHub.Models.GitHubModelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.GitHub.Models.GitHubModelResource" + ], + "appliesTo": [ + "GitHubModelResource" + ] + }, + { + "name": "WithApiKey", + "capabilityId": "Aspire.Hosting.GitHub.Models/withApiKey", + "qualifiedName": "withApiKey", + "description": "Configures the API key for the GitHub Model resource from a parameter.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithApiKey(apiKey ParameterResource) GitHubModelResource", + "receiver": "GitHubModelResource", + "parameters": [ + { + "name": "apiKey", + "type": "ParameterResource", + "description": "The API key parameter." + } + ], + "returnType": "GitHubModelResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.GitHub.Models/Aspire.Hosting.GitHub.Models.GitHubModelResource", + "expandedTargetTypes": [ + "Aspire.Hosting.GitHub.Models.GitHubModelResource" + ], + "appliesTo": [ + "GitHubModelResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [ + { + "name": "GitHubModelName", + "fullName": "Aspire.Hosting.GitHub.GitHubModelName", + "kind": "enum", + "description": "Enumerates known GitHub model names for polyglot AppHost support.", + "members": [ + { + "name": "GitHubModelNameAI21Jamba15Large", + "value": "AI21Jamba15Large", + "description": "A 398B parameters (94B active) multilingual model, offering a 256K long context window, function calling, structured output, and grounded generation." + }, + { + "name": "GitHubModelNameCohereCommandA", + "value": "CohereCommandA", + "description": "Command A is a highly efficient generative model that excels at agentic and multilingual use cases." + }, + { + "name": "GitHubModelNameCohereCommandR082024", + "value": "CohereCommandR082024", + "description": "Command R is a scalable generative model targeting RAG and Tool Use to enable production-scale AI for enterprise." + }, + { + "name": "GitHubModelNameCohereCommandRPlus082024", + "value": "CohereCommandRPlus082024", + "description": "Command R+ is a state-of-the-art RAG-optimized model designed to tackle enterprise-grade workloads." + }, + { + "name": "GitHubModelNameDeepSeekR1", + "value": "DeepSeekR1", + "description": "DeepSeek-R1 excels at reasoning tasks using a step-by-step training process, such as language, scientific reasoning, and coding tasks." + }, + { + "name": "GitHubModelNameDeepSeekR10528", + "value": "DeepSeekR10528", + "description": "The DeepSeek R1 0528 model has improved reasoning capabilities, this version also offers a reduced hallucination rate, enhanced support for function calling, and better experience for vibe coding." + }, + { + "name": "GitHubModelNameDeepSeekV30324", + "value": "DeepSeekV30324", + "description": "DeepSeek-V3-0324 demonstrates notable improvements over its predecessor, DeepSeek-V3, in several key aspects, including enhanced reasoning, improved function calling, and superior code generation capabilities." + }, + { + "name": "GitHubModelNameLlama4Maverick17B128EInstructFP8", + "value": "Llama4Maverick17B128EInstructFP8", + "description": "Llama 4 Maverick 17B 128E Instruct FP8 is great at precise image understanding and creative writing, offering high quality at a lower price compared to Llama 3.3 70B" + }, + { + "name": "GitHubModelNameLlama4Scout17B16EInstruct", + "value": "Llama4Scout17B16EInstruct", + "description": "Llama 4 Scout 17B 16E Instruct is great at multi-document summarization, parsing extensive user activity for personalized tasks, and reasoning over vast codebases." + }, + { + "name": "GitHubModelNameLlama3211BVisionInstruct", + "value": "Llama3211BVisionInstruct", + "description": "Excels in image reasoning capabilities on high-res images for visual understanding apps." + }, + { + "name": "GitHubModelNameLlama3290BVisionInstruct", + "value": "Llama3290BVisionInstruct", + "description": "Advanced image reasoning capabilities for visual understanding agentic apps." + }, + { + "name": "GitHubModelNameLlama3370BInstruct", + "value": "Llama3370BInstruct", + "description": "Llama 3.3 70B Instruct offers enhanced reasoning, math, and instruction following with performance comparable to Llama 3.1 405B." + }, + { + "name": "GitHubModelNameMetaLlama31405BInstruct", + "value": "MetaLlama31405BInstruct", + "description": "The Llama 3.1 instruction tuned text only models are optimized for multilingual dialogue use cases and outperform many of the available open source and closed chat models on common industry benchmarks." + }, + { + "name": "GitHubModelNameMetaLlama318BInstruct", + "value": "MetaLlama318BInstruct", + "description": "The Llama 3.1 instruction tuned text only models are optimized for multilingual dialogue use cases and outperform many of the available open source and closed chat models on common industry benchmarks." + }, + { + "name": "GitHubModelNameMaiDSR1", + "value": "MaiDSR1", + "description": "MAI-DS-R1 is a DeepSeek-R1 reasoning model that has been post-trained by the Microsoft AI team to fill in information gaps in the previous version of the model and improve its harm protections while maintaining R1 reasoning capabilities." + }, + { + "name": "GitHubModelNamePhi4", + "value": "Phi4", + "description": "Phi-4 14B, a highly capable model for low latency scenarios." + }, + { + "name": "GitHubModelNamePhi4MiniInstruct", + "value": "Phi4MiniInstruct", + "description": "3.8B parameters Small Language Model outperforming larger models in reasoning, math, coding, and function-calling" + }, + { + "name": "GitHubModelNamePhi4MiniReasoning", + "value": "Phi4MiniReasoning", + "description": "Lightweight math reasoning model optimized for multi-step problem solving" + }, + { + "name": "GitHubModelNamePhi4MultimodalInstruct", + "value": "Phi4MultimodalInstruct", + "description": "First small multimodal model to have 3 modality inputs (text, audio, image), excelling in quality and efficiency" + }, + { + "name": "GitHubModelNamePhi4Reasoning", + "value": "Phi4Reasoning", + "description": "State-of-the-art open-weight reasoning model." + }, + { + "name": "GitHubModelNameCodestral2501", + "value": "Codestral2501", + "description": "Codestral 25.01 by Mistral AI is designed for code generation, supporting 80+ programming languages, and optimized for tasks like code completion and fill-in-the-middle" + }, + { + "name": "GitHubModelNameMinistral3B", + "value": "Ministral3B", + "description": "Ministral 3B is a state-of-the-art Small Language Model (SLM) optimized for edge computing and on-device applications. As it is designed for low-latency and compute-efficient inference, it it also the perfect model for standard GenAI applications that have" + }, + { + "name": "GitHubModelNameMistralMedium32505", + "value": "MistralMedium32505", + "description": "Mistral Medium 3 is an advanced Large Language Model (LLM) with state-of-the-art reasoning, knowledge, coding and vision capabilities." + }, + { + "name": "GitHubModelNameMistralSmall31", + "value": "MistralSmall31", + "description": "Enhanced Mistral Small 3 with multimodal capabilities and a 128k context length." + }, + { + "name": "GitHubModelNameOpenAIGpt41", + "value": "OpenAIGpt41", + "description": "gpt-4.1 outperforms gpt-4o across the board, with major gains in coding, instruction following, and long-context understanding" + }, + { + "name": "GitHubModelNameOpenAIGpt41Mini", + "value": "OpenAIGpt41Mini", + "description": "gpt-4.1-mini outperform gpt-4o-mini across the board, with major gains in coding, instruction following, and long-context handling" + }, + { + "name": "GitHubModelNameOpenAIGpt41Nano", + "value": "OpenAIGpt41Nano", + "description": "gpt-4.1-nano provides gains in coding, instruction following, and long-context handling along with lower latency and cost" + }, + { + "name": "GitHubModelNameOpenAIGpt4o", + "value": "OpenAIGpt4o", + "description": "OpenAI's most advanced multimodal model in the gpt-4o family. Can handle both text and image inputs." + }, + { + "name": "GitHubModelNameOpenAIGpt4oMini", + "value": "OpenAIGpt4oMini", + "description": "An affordable, efficient AI solution for diverse text and image tasks." + }, + { + "name": "GitHubModelNameOpenAIGpt5", + "value": "OpenAIGpt5", + "description": "gpt-5 is designed for logic-heavy and multi-step tasks." + }, + { + "name": "GitHubModelNameOpenAIGpt5ChatPreview", + "value": "OpenAIGpt5ChatPreview", + "description": "gpt-5-chat (preview) is an advanced, natural, multimodal, and context-aware conversations for enterprise applications." + }, + { + "name": "GitHubModelNameOpenAIGpt5Mini", + "value": "OpenAIGpt5Mini", + "description": "gpt-5-mini is a lightweight version for cost-sensitive applications." + }, + { + "name": "GitHubModelNameOpenAIGpt5Nano", + "value": "OpenAIGpt5Nano", + "description": "gpt-5-nano is optimized for speed, ideal for applications requiring low latency." + }, + { + "name": "GitHubModelNameOpenAIO1", + "value": "OpenAIO1", + "description": "Focused on advanced reasoning and solving complex problems, including math and science tasks. Ideal for applications that require deep contextual understanding and agentic workflows." + }, + { + "name": "GitHubModelNameOpenAIO1Mini", + "value": "OpenAIO1Mini", + "description": "Smaller, faster, and 80% cheaper than o1-preview, performs well at code generation and small context operations." + }, + { + "name": "GitHubModelNameOpenAIO1Preview", + "value": "OpenAIO1Preview", + "description": "Focused on advanced reasoning and solving complex problems, including math and science tasks. Ideal for applications that require deep contextual understanding and agentic workflows." + }, + { + "name": "GitHubModelNameOpenAIO3", + "value": "OpenAIO3", + "description": "o3 includes significant improvements on quality and safety while supporting the existing features of o1 and delivering comparable or better performance." + }, + { + "name": "GitHubModelNameOpenAIO3Mini", + "value": "OpenAIO3Mini", + "description": "o3-mini includes the o1 features with significant cost-efficiencies for scenarios requiring high performance." + }, + { + "name": "GitHubModelNameOpenAIO4Mini", + "value": "OpenAIO4Mini", + "description": "o4-mini includes significant improvements on quality and safety while supporting the existing features of o3-mini and delivering comparable or better performance." + }, + { + "name": "GitHubModelNameOpenAITextEmbedding3Large", + "value": "OpenAITextEmbedding3Large", + "description": "Text-embedding-3 series models are the latest and most capable embedding model from OpenAI." + }, + { + "name": "GitHubModelNameOpenAITextEmbedding3Small", + "value": "OpenAITextEmbedding3Small", + "description": "Text-embedding-3 series models are the latest and most capable embedding model from OpenAI." + }, + { + "name": "GitHubModelNameGrok3", + "value": "Grok3", + "description": "Grok 3 is xAI's debut model, pretrained by Colossus at supermassive scale to excel in specialized domains like finance, healthcare, and the law." + }, + { + "name": "GitHubModelNameGrok3Mini", + "value": "Grok3Mini", + "description": "Grok 3 Mini is a lightweight model that thinks before responding. Trained on mathematic and scientific problems, it is great for logic-based tasks." + } + ] + } + ], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Go.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Go.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..5823d7b30d --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Go.13.6.0-preview.1.26478.8.json @@ -0,0 +1,546 @@ +{ + "package": { + "name": "Aspire.Hosting.Go", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddGoApp", + "capabilityId": "Aspire.Hosting.Go/addGoApp", + "qualifiedName": "addGoApp", + "description": "Adds a Go application to the application model. The Go toolchain must be available on the PATH.", + "remarks": "This method executes the Go application using `go run .`. The Go toolchain resolves the\nentry point from the package in `appDirectory`.\nGo applications automatically have VS Code debugging support enabled via Delve.\nUse `WithModTidy``1`, `WithModVendor``1`, or `WithModDownload``1`\nto manage module dependencies before startup, and `WithVetTool``1` to run static analysis.\nUse `WithAppArgs``1` to pass runtime program arguments, and\n`WithDelveServer``1` to enable remote debugging via a headless Delve server.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddGoApp(name string, appDirectory string, options ...*AddGoAppOptions) GoAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "appDirectory", + "type": "string", + "description": "The path to the directory that acts as both the Go module root (where `go.mod` lives) and the Docker build context for `aspire publish`." + } + ], + "options": { + "typeName": "AddGoAppOptions", + "fields": [ + { + "name": "PackagePath", + "jsonName": "packagePath", + "type": "*string", + "description": "The Go package to run or build, relative to `appDirectory`. Defaults to `\".\"` (the module root itself). Use a sub-path such as `\"./cmd/server\"` when the main package is not at the module root (e.g. `api/cmd/server/main.go` with `api/go.mod`). This value is passed to `go run`, `dlv debug`, and `go build` consistently." + }, + { + "name": "BuildTags", + "jsonName": "buildTags", + "type": "[]string", + "description": "Optional build tags passed to the compiler via `-tags` (e.g. `\"netgo\"`, `\"integration\"`)." + }, + { + "name": "LdFlags", + "jsonName": "ldFlags", + "type": "*string", + "description": "Optional linker flags passed via `-ldflags` (e.g. `\"-X main.version=1.0.0\"`)." + }, + { + "name": "GcFlags", + "jsonName": "gcFlags", + "type": "*string", + "description": "Optional compiler flags passed via `-gcflags` (e.g. `\"all=-N -l\"` to disable optimisations for Delve)." + }, + { + "name": "RaceDetector", + "jsonName": "raceDetector", + "type": "*bool", + "description": "When `true`, enables the Go race detector by passing `-race` to `go run`." + } + ] + }, + "returnType": "GoAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithAppArgs", + "capabilityId": "Aspire.Hosting.Go/withAppArgs", + "qualifiedName": "withAppArgs", + "description": "Passes extra arguments to the Go program at runtime. In normal run mode they appear after `go run .`; in Delve mode after the `--` separator.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAppArgs(args []any) GoAppResource", + "receiver": "GoAppResource", + "parameters": [ + { + "name": "args", + "type": "[]any", + "description": "The program arguments (e.g., `\"serve\"`, `\"--config\"`, `\"prod.yaml\"`)." + } + ], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithDelveServer", + "capabilityId": "Aspire.Hosting.Go/withDelveServer", + "qualifiedName": "withDelveServer", + "description": "Starts a configurable headless Delve debug server so that DAP-compatible clients can attach remotely. The application is launched with `dlv debug` instead of `go run`. Delve must be available on the PATH.", + "remarks": "The server listens on `127.0.0.1` and accepts a single debugger client by default.\nSet `AcceptMultiClient` to `true` only when\nmultiple clients or reconnections are required.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDelveServer(options ...*DelveServerOptions) GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "options": { + "typeName": "DelveServerOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithGoPrivate", + "capabilityId": "Aspire.Hosting.Go/withGoPrivate", + "qualifiedName": "withGoPrivate", + "description": "Configures private Go module authentication for publish-time Dockerfile generation.", + "remarks": "Only affects the generated Dockerfile — has no effect in run mode, where the local\nGo toolchain picks up credentials from the developer's own `~/.netrc` or git\ncredential helper.\nThe generated build stage writes a temporary `.netrc` file from the username\nbuild-arg and the token secret, runs `go mod download`, then removes the file —\nall in a single layer so credentials never persist in the image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithGoPrivate(privatePatterns []string, authHost string, options ...*WithGoPrivateOptions) GoAppResource", + "receiver": "GoAppResource", + "parameters": [ + { + "name": "privatePatterns", + "type": "[]string", + "description": "One or more module path patterns that should bypass the public proxy and checksum database, e.g. `\"*.mycompany.com\"` or `\"github.com/myorg\"`. Passed verbatim to `GOPRIVATE`, which implicitly covers `GONOSUMCHECK` and `GONOPROXY`." + }, + { + "name": "authHost", + "type": "string", + "description": "The Git host that requires authentication, e.g. `\"github.com\"`." + } + ], + "options": { + "typeName": "WithGoPrivateOptions", + "fields": [ + { + "name": "UsernameArgName", + "jsonName": "usernameArgName", + "type": "*string", + "description": "The Docker build-arg name for the Git username. Defaults to `\"GIT_USER\"`. Pass it at build time with `--build-arg GIT_USER=myuser`." + }, + { + "name": "TokenSecretId", + "jsonName": "tokenSecretId", + "type": "*string", + "description": "The BuildKit secret ID for the Git access token. Defaults to `\"gittoken\"`. Pass it at build time with `--secret id=gittoken,src=/path/to/token`." + } + ] + }, + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithModDownload", + "capabilityId": "Aspire.Hosting.Go/withModDownload", + "qualifiedName": "withModDownload", + "description": "Runs `go mod download` before starting the application, pre-fetching all module dependencies into the local module cache without modifying `go.sum`. The main application waits for the download step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithModDownload() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithModTidy", + "capabilityId": "Aspire.Hosting.Go/withModTidy", + "qualifiedName": "withModTidy", + "description": "Runs `go mod tidy` before starting the application, ensuring `go.sum` is up to date. The main application waits for the tidy step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithModTidy() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithModVendor", + "capabilityId": "Aspire.Hosting.Go/withModVendor", + "qualifiedName": "withModVendor", + "description": "Runs `go mod vendor` before starting the application, caching all module dependencies in the local `vendor/` directory. The main application waits for the vendor step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithModVendor() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithVetTool", + "capabilityId": "Aspire.Hosting.Go/withVetTool", + "qualifiedName": "withVetTool", + "description": "Runs `go vet ./...` before starting the application to catch static analysis issues. The main application waits for the vet step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithVetTool() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + } + ], + "handleTypes": [ + { + "name": "GoAppResource", + "fullName": "Aspire.Hosting.Go.GoAppResource", + "kind": "handle", + "description": "Represents a Go application resource in the distributed application model.", + "remarks": "This resource allows Go applications to run as part of a distributed application. The resource\nmanages the Go toolchain, working directory, and lifecycle of the Go application.\nGo applications can expose HTTP endpoints, communicate with other services, and participate\nin service discovery like other Aspire resources. They support automatic OpenTelemetry\ninstrumentation when configured with the appropriate Go packages.", + "implementedInterfaces": [ + "IComputeResource", + "IContainerFilesDestinationResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithAppArgs", + "capabilityId": "Aspire.Hosting.Go/withAppArgs", + "qualifiedName": "withAppArgs", + "description": "Passes extra arguments to the Go program at runtime. In normal run mode they appear after `go run .`; in Delve mode after the `--` separator.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithAppArgs(args []any) GoAppResource", + "receiver": "GoAppResource", + "parameters": [ + { + "name": "args", + "type": "[]any", + "description": "The program arguments (e.g., `\"serve\"`, `\"--config\"`, `\"prod.yaml\"`)." + } + ], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithDelveServer", + "capabilityId": "Aspire.Hosting.Go/withDelveServer", + "qualifiedName": "withDelveServer", + "description": "Starts a configurable headless Delve debug server so that DAP-compatible clients can attach remotely. The application is launched with `dlv debug` instead of `go run`. Delve must be available on the PATH.", + "remarks": "The server listens on `127.0.0.1` and accepts a single debugger client by default.\nSet `AcceptMultiClient` to `true` only when\nmultiple clients or reconnections are required.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithDelveServer(options ...*DelveServerOptions) GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "options": { + "typeName": "DelveServerOptions", + "isDirect": true, + "fields": [] + }, + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithGoPrivate", + "capabilityId": "Aspire.Hosting.Go/withGoPrivate", + "qualifiedName": "withGoPrivate", + "description": "Configures private Go module authentication for publish-time Dockerfile generation.", + "remarks": "Only affects the generated Dockerfile — has no effect in run mode, where the local\nGo toolchain picks up credentials from the developer's own `~/.netrc` or git\ncredential helper.\nThe generated build stage writes a temporary `.netrc` file from the username\nbuild-arg and the token secret, runs `go mod download`, then removes the file —\nall in a single layer so credentials never persist in the image.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithGoPrivate(privatePatterns []string, authHost string, options ...*WithGoPrivateOptions) GoAppResource", + "receiver": "GoAppResource", + "parameters": [ + { + "name": "privatePatterns", + "type": "[]string", + "description": "One or more module path patterns that should bypass the public proxy and checksum database, e.g. `\"*.mycompany.com\"` or `\"github.com/myorg\"`. Passed verbatim to `GOPRIVATE`, which implicitly covers `GONOSUMCHECK` and `GONOPROXY`." + }, + { + "name": "authHost", + "type": "string", + "description": "The Git host that requires authentication, e.g. `\"github.com\"`." + } + ], + "options": { + "typeName": "WithGoPrivateOptions", + "fields": [ + { + "name": "UsernameArgName", + "jsonName": "usernameArgName", + "type": "*string", + "description": "The Docker build-arg name for the Git username. Defaults to `\"GIT_USER\"`. Pass it at build time with `--build-arg GIT_USER=myuser`." + }, + { + "name": "TokenSecretId", + "jsonName": "tokenSecretId", + "type": "*string", + "description": "The BuildKit secret ID for the Git access token. Defaults to `\"gittoken\"`. Pass it at build time with `--secret id=gittoken,src=/path/to/token`." + } + ] + }, + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithModDownload", + "capabilityId": "Aspire.Hosting.Go/withModDownload", + "qualifiedName": "withModDownload", + "description": "Runs `go mod download` before starting the application, pre-fetching all module dependencies into the local module cache without modifying `go.sum`. The main application waits for the download step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithModDownload() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithModTidy", + "capabilityId": "Aspire.Hosting.Go/withModTidy", + "qualifiedName": "withModTidy", + "description": "Runs `go mod tidy` before starting the application, ensuring `go.sum` is up to date. The main application waits for the tidy step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithModTidy() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithModVendor", + "capabilityId": "Aspire.Hosting.Go/withModVendor", + "qualifiedName": "withModVendor", + "description": "Runs `go mod vendor` before starting the application, caching all module dependencies in the local `vendor/` directory. The main application waits for the vendor step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithModVendor() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + }, + { + "name": "WithVetTool", + "capabilityId": "Aspire.Hosting.Go/withVetTool", + "qualifiedName": "withVetTool", + "description": "Runs `go vet ./...` before starting the application to catch static analysis issues. The main application waits for the vet step to complete successfully before launching.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "WithVetTool() GoAppResource", + "receiver": "GoAppResource", + "parameters": [], + "returnType": "GoAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Go/Aspire.Hosting.Go.GoAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Go.GoAppResource" + ], + "appliesTo": [ + "GoAppResource" + ] + } + ], + "synthesizedMembers": [] + } + ], + "dtoTypes": [ + { + "name": "DelveServerOptions", + "fullName": "Aspire.Hosting.Go.DelveServerOptions", + "kind": "dto", + "description": "Configures the headless Delve debug server used for remote debugging of a Go application.", + "remarks": "The server listens on the loopback interface. By default, it accepts a single debugger client\nand relies on Delve's default same-user connection policy.\nSet `AcceptMultiClient` only when the server must remain available after a debugger\ndisconnects or when multiple debugger clients need to attach.", + "fields": [ + { + "name": "Port", + "jsonName": "Port", + "type": "*float64", + "isOptional": true, + "description": "Gets the TCP port on which Delve listens. The default is `2345`." + }, + { + "name": "AcceptMultiClient", + "jsonName": "AcceptMultiClient", + "type": "*bool", + "isOptional": true, + "description": "Gets a value indicating whether Delve accepts multiple debugger clients. The default is `false`." + }, + { + "name": "OnlySameUser", + "jsonName": "OnlySameUser", + "type": "*bool", + "isOptional": true, + "description": "Gets a value indicating whether Delve allows connections only from the same operating system user. When `null`, Delve's default same-user policy is used." + }, + { + "name": "ContinueOnStart", + "jsonName": "ContinueOnStart", + "type": "*bool", + "isOptional": true, + "description": "Gets a value indicating whether Delve continues the application immediately after startup. The default is `false`." + }, + { + "name": "Log", + "jsonName": "Log", + "type": "*bool", + "isOptional": true, + "description": "Gets a value indicating whether Delve server logging is enabled. The default is `false`." + }, + { + "name": "LogOutput", + "jsonName": "LogOutput", + "type": "*string", + "isOptional": true, + "description": "Gets the Delve logging components enabled when `Log` is `true`. When `null` or empty, Delve uses its default logging components." + } + ] + } + ], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.Java.13.6.0-preview.1.26478.8.json b/src/frontend/src/data/go-modules/Aspire.Hosting.Java.13.6.0-preview.1.26478.8.json new file mode 100644 index 0000000000..ccdbf20a7d --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.Java.13.6.0-preview.1.26478.8.json @@ -0,0 +1,840 @@ +{ + "package": { + "name": "Aspire.Hosting.Java", + "version": "13.6.0-preview.1.26478.8", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddJavaApp", + "capabilityId": "Aspire.Hosting.Java/addJavaApp", + "qualifiedName": "addJavaApp", + "description": "Adds a Java application to the application model, launched with `java`.", + "remarks": "Combine with `WithMavenGoal``1` or\n`WithGradleTask``1` to run the application through a build tool,\nor use the overload that accepts a `jarPath` to run a prebuilt JAR with `java -jar`.\nExactly one of those three launch modes must be configured.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "AddJavaApp(name string, appDirectory string) JavaAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "appDirectory", + "type": "string", + "description": "The application directory. Relative paths are resolved against the AppHost directory." + } + ], + "returnType": "JavaAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddJavaAppWithJar", + "capabilityId": "Aspire.Hosting.Java/addJavaAppWithJar", + "qualifiedName": "addJavaAppWithJar", + "description": "Adds a Java application that runs a prebuilt JAR with `java -jar`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "AddJavaAppWithJar(name string, appDirectory string, jarPath string, args []string) JavaAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "appDirectory", + "type": "string", + "description": "The application directory. Relative paths are resolved against the AppHost directory." + }, + { + "name": "jarPath", + "type": "string", + "description": "The path to the JAR file to execute. Relative paths are resolved against `appDirectory`." + }, + { + "name": "args", + "type": "[]string", + "description": "Arguments passed to the Java application after the JAR path." + } + ], + "returnType": "JavaAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddJavaContainer", + "capabilityId": "Aspire.Hosting.Java/addJavaContainer", + "qualifiedName": "addJavaContainer", + "description": "Adds a Java application that runs from an existing container image.", + "remarks": "Use this when the image is built elsewhere — by a separate CI pipeline, or by a team that ships the\napplication as a container. Aspire runs the image as-is and never rebuilds it, so the JAR, the JDK,\nand any OpenTelemetry agent all come from the image. Use\n`AddJavaApp` instead when Aspire should\nbuild and run the application from source.\nNo endpoint is declared, because the port the image listens on is a property of the image. Add one\nwith `WithHttpEndpoint(targetPort: 8080)`, using whichever port the application binds — 8080\nfor a default Spring Boot or Quarkus image.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "AddJavaContainer(name string, image string, options ...*AddJavaContainerOptions) JavaContainerResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "image", + "type": "string", + "description": "The container image that runs the application, for example `mycompany/catalog`." + } + ], + "options": { + "typeName": "AddJavaContainerOptions", + "fields": [ + { + "name": "Tag", + "jsonName": "tag", + "type": "*string", + "description": "The image tag. Defaults to the image's `latest` tag." + } + ] + }, + "returnType": "JavaContainerResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddQuarkusApp", + "capabilityId": "Aspire.Hosting.Java/addQuarkusApp", + "qualifiedName": "addQuarkusApp", + "description": "Adds a Quarkus application to the application model, built and launched with its own Maven or Gradle wrapper.", + "remarks": "The build tool is detected when the resource starts, the application runs in Quarkus dev mode\n(`quarkus:dev` or `quarkusDev`) so live coding works, and an HTTP endpoint is declared through\n`QUARKUS_HTTP_PORT`, the environment variable Quarkus reads for its listening port. Everything else\nbehaves like `AddJavaApp`.\nThe dev-mode goal compiles the application itself, so Aspire does not add a separate build resource before it.\nThere are two exceptions. `WithOtelAgent``1` with a build-produced agent\ncannot be loaded until a build has written it, and a debug session launches the packaged fast JAR rather\nthan the dev-mode wrapper, which no build has written on a clean checkout.\nQuarkus Dev Services are left enabled but do not activate for anything Aspire supplies: Dev Services only\nstart a container when the corresponding configuration is missing, and a `WithReference` to a database\nor broker provides it. That means Aspire's resources are used rather than a second set started underneath.\n`QUARKUS_PROFILE` is set to `dev` in run mode. Dev mode already selects that profile; setting it\nexplicitly means a debugger, which launches the packaged application rather than the dev-mode wrapper,\nresolves the same `%dev.` configuration the application would see when run normally.\nIn run mode the application is bound to all interfaces. Quarkus enables Host header validation\nwhenever it binds a localhost name, and that filter rejects the hostname Aspire publishes, which\nmakes the endpoint link in the dashboard return `400`. Published output is left alone, where\nthe application already binds all interfaces.\nNo health check is added. `/q/health` only exists when the application depends on\n`quarkus-smallrye-health`, and adding it unconditionally would leave applications without that\nextension permanently unhealthy and silently stall every `WaitFor` on them. Add\n`WithHttpHealthCheck(\"/q/health\")` when the extension is present.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "AddQuarkusApp(name string, appDirectory string) JavaAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "appDirectory", + "type": "string", + "description": "The application directory, containing `pom.xml`, `build.gradle`, `build.gradle.kts`, `settings.gradle`, or `settings.gradle.kts`. Relative paths are resolved against the AppHost directory." + } + ], + "returnType": "JavaAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "AddSpringBootApp", + "capabilityId": "Aspire.Hosting.Java/addSpringBootApp", + "qualifiedName": "addSpringBootApp", + "description": "Adds a Spring Boot application to the application model, built and launched with its own Maven or Gradle wrapper.", + "remarks": "This is `AddJavaApp` with the common\nSpring Boot configuration already applied: the build tool is detected when the resource starts, the\napplication is launched through that tool's Spring Boot plugin (`spring-boot:run` or `bootRun`),\nand an HTTP endpoint is declared through `SERVER_PORT`, which is the environment\nvariable Spring Boot reads for its listening port. Everything else is the same, so any `With…` method\nthat works on `AddJavaApp` works here too.\nThe launch goal compiles the application itself, so Aspire does not add a separate build resource before\nit. Publishing still packages the application with tests skipped (`-DskipTests` for Maven,\n`-x test` for Gradle). Call `WithMavenBuild``1` or\n`WithGradleBuild``1` afterwards to customize those package arguments.\nThe one thing that does add a build resource is\n`WithOtelAgent``1` with a build-produced agent, which cannot be\nloaded until a build has written it.\nNo health check is added. `/actuator/health` only exists when the application depends on\n`spring-boot-starter-actuator`, and adding it unconditionally would leave applications without that\ndependency permanently unhealthy and silently stall every `WaitFor` on them. Add\n`WithHttpHealthCheck(\"/actuator/health\")` when the actuator is present.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "AddSpringBootApp(name string, appDirectory string) JavaAppResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [ + { + "name": "name", + "type": "string", + "description": "The name of the resource." + }, + { + "name": "appDirectory", + "type": "string", + "description": "The application directory, containing `pom.xml`, `build.gradle`, `build.gradle.kts`, `settings.gradle`, or `settings.gradle.kts`. Relative paths are resolved against the AppHost directory." + } + ], + "returnType": "JavaAppResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": [ + "Aspire.Hosting.IDistributedApplicationBuilder" + ], + "appliesTo": [ + "DistributedApplicationBuilder" + ] + }, + { + "name": "WithGradleBuild", + "capabilityId": "Aspire.Hosting.Java/withGradleBuild", + "qualifiedName": "withGradleBuild", + "description": "Runs a Gradle build before the Java application starts.", + "remarks": "When the application launches with `WithGradleTask``1`,\nthat task performs the local compilation, so these arguments normally configure publishing without adding a\nsecond run-mode build. Otherwise, the build step is a child resource that the application waits for.\nNo child is created when publishing because the generated container image performs the build.\nThis runs a build before the application starts. To launch the application through Gradle,\nuse `WithGradleTask``1` instead.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithGradleBuild(args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "Arguments passed to the Gradle wrapper. Defaults to `clean build`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithGradleTask", + "capabilityId": "Aspire.Hosting.Java/withGradleTask", + "qualifiedName": "withGradleTask", + "description": "Launches the Java application through a Gradle task instead of `java`, for example `bootRun`.", + "remarks": "The wrapper defaults to `gradlew` (`gradlew.bat` on Windows) in the resource's working\ndirectory and can be overridden with `WithWrapperPath``1`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithGradleTask(task string, args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "task", + "type": "string", + "description": "The Gradle task to execute." + }, + { + "name": "args", + "type": "[]string", + "description": "Additional arguments passed to the Gradle wrapper after the task." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithJarArtifact", + "capabilityId": "Aspire.Hosting.Java/withJarArtifact", + "qualifiedName": "withJarArtifact", + "description": "Selects the JAR the generated container image runs, for projects whose build produces more than one.", + "remarks": "Only affects publishing, and only when the application is built in the image. Without it the\ncontainer build selects the single JAR that is not a `-plain`, `-sources`, or\n`-javadoc` artifact, and fails the build if that is ambiguous.\nThis takes precedence over the JAR named by the `jarPath` overload of\n`AddJavaApp`, so a\nresource can run one JAR locally and publish another. It has no effect on an application published\nfrom a prebuilt JAR, because nothing is built in the image for it to select from.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithJarArtifact(jarPath string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "jarPath", + "type": "string", + "description": "The path to the JAR produced by the build, relative to the application directory, for example `target/app.jar`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithJvmArgs", + "capabilityId": "Aspire.Hosting.Java/withJvmArgs", + "qualifiedName": "withJvmArgs", + "description": "Adds arguments to the Java Virtual Machine that runs the application.", + "remarks": "Arguments are passed through the `JAVA_TOOL_OPTIONS` environment variable, which the JVM reads\nhowever it was started — `java -jar`, a Maven goal, a Gradle task, or a container image's own\nentrypoint, including the JVM those build tools fork. Values containing spaces are quoted, because\nthe JVM splits this variable on whitespace.\nThis is also how a container image that already carries the OpenTelemetry Java agent turns it on,\nsince `WithOtelAgent``1` copies an agent from the build\ncontext and so applies only to applications Aspire itself launches or builds:\n`WithJvmArgs(\"-javaagent:/app/opentelemetry-javaagent.jar\")`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithJvmArgs(args []string) IJavaAppResource", + "receiver": "IJavaAppResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "The JVM arguments, for example `-Xmx512m`." + } + ], + "returnType": "IJavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.IJavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource", + "Aspire.Hosting.Java.JavaContainerResource" + ], + "appliesTo": [ + "JavaAppResource", + "JavaContainerResource" + ] + }, + { + "name": "WithMainClass", + "capabilityId": "Aspire.Hosting.Java/withMainClass", + "qualifiedName": "withMainClass", + "description": "Sets the main class an IDE launches when running or debugging this application. Has no effect on how Aspire starts the process, which is decided by the JAR path, Maven goal, or Gradle task.", + "remarks": "Only affects IDE execution. When omitted, the IDE resolves the main class from the project's build\nfiles; set it explicitly when a project declares more than one class with a `main` method.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithMainClass(mainClass string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "mainClass", + "type": "string", + "description": "The fully qualified name of the class declaring `main`, for example `com.example.Application`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithMavenBuild", + "capabilityId": "Aspire.Hosting.Java/withMavenBuild", + "qualifiedName": "withMavenBuild", + "description": "Runs a Maven build before the Java application starts.", + "remarks": "When the application launches with `WithMavenGoal``1`,\nthat goal performs the local compilation, so these arguments normally configure publishing without adding a\nsecond run-mode build. Otherwise, the build step is a child resource that the application waits for.\nNo child is created when publishing because the generated container image performs the build.\nThis runs a build before the application starts. To launch the application through Maven,\nuse `WithMavenGoal``1` instead.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithMavenBuild(args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "Arguments passed to the Maven wrapper. Defaults to `clean package`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithMavenGoal", + "capabilityId": "Aspire.Hosting.Java/withMavenGoal", + "qualifiedName": "withMavenGoal", + "description": "Launches the Java application through a Maven goal instead of `java`, for example `spring-boot:run`.", + "remarks": "The wrapper defaults to `mvnw` (`mvnw.cmd` on Windows) in the resource's working directory\nand can be overridden with `WithWrapperPath``1`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithMavenGoal(goal string, args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "goal", + "type": "string", + "description": "The Maven goal to execute." + }, + { + "name": "args", + "type": "[]string", + "description": "Additional arguments passed to the Maven wrapper after the goal." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithOtelAgent", + "capabilityId": "Aspire.Hosting.Java/withOtelAgent", + "qualifiedName": "withOtelAgent", + "description": "Runs the application with the OpenTelemetry Java agent so it exports traces, metrics, and logs to Aspire.", + "remarks": "The agent is not downloaded. Obtain it as a build dependency, or from\nhttps://github.com/open-telemetry/opentelemetry-java-instrumentation/releases, and point this at the\nresulting file. The OTLP exporter is configured by `AddJavaApp` regardless of whether an agent\nis used, so call this only when you want the agent's automatic instrumentation.\nA relative `agentPath` is resolved against the application directory and made absolute\nwhen running locally. This is required, not cosmetic: `JAVA_TOOL_OPTIONS` is inherited by every JVM\nstarted beneath the resource, and build tools start JVMs whose working directory is not the application\ndirectory. The Gradle daemon, for example, starts from its own distribution directory, so a relative\n`-javaagent:` path fails to resolve and the daemon dies during VM initialization with\n\"Error opening zip file or JAR manifest missing\".\nA relative path names a file the build produces, so Aspire runs that build as its own resource in run\nmode and holds the application until it finishes. An absolute path names a file that exists\nindependently of the build, so no build resource is added.\nIn publish mode a relative path is rewritten to the location the generated Dockerfile copies the\nagent to, because the path has to be interpreted inside the container rather than on the build\nmachine. An absolute path is emitted unchanged, since it cannot have come from the build context\nand must be supplied by the base image or a mount.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithOtelAgent(agentPath string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "agentPath", + "type": "string", + "description": "The path to the `opentelemetry-javaagent.jar` file." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithOtelAgentDefaultPath", + "capabilityId": "Aspire.Hosting.Java/withOtelAgentDefaultPath", + "qualifiedName": "withOtelAgentDefaultPath", + "description": "Runs the application with the OpenTelemetry Java agent from the location the build tool writes it to.", + "remarks": "The agent is expected at `target/agent/opentelemetry-javaagent.jar` for Maven and\n`build/agent/opentelemetry-javaagent.jar` for Gradle — the conventional output directory of each tool\nwith an `agent` subdirectory. The build has to put it there; nothing is downloaded. With Maven, copy it\nwith `maven-dependency-plugin`'s `copy` goal bound to `process-resources`; with Gradle,\ndeclare the agent in its own configuration and add a `Copy` task that `compileJava` depends on.\nMay be called before or after the build tool is configured: which directory the agent is read from is\ndecided when the application model is built, so the result does not depend on the order of builder calls.\nBecause the build writes the agent, Aspire runs that build as its own resource in run mode and holds\nthe application until it finishes — including for Spring Boot and Quarkus, whose launch goals would\notherwise be the only build. This is required rather than an optimization: `JAVA_TOOL_OPTIONS` is\nread by every JVM started beneath the resource, and the first of those is the wrapper's own, so an\nagent the build has not written yet kills that JVM during VM initialization with \"Error opening zip\nfile or JAR manifest missing\" before the launch goal runs.\nUse `WithOtelAgent``1` when the agent lives anywhere else, including\nwhen it is committed to the repository or supplied by the container base image.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithOtelAgentDefaultPath() JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithWrapperPath", + "capabilityId": "Aspire.Hosting.Java/withWrapperPath", + "qualifiedName": "withWrapperPath", + "description": "Overrides the build tool wrapper script path, for repositories whose wrapper is not in the default location or does not use the default name.", + "remarks": "May be called before or after the build tool is configured. A later call re-points anything that\nalready resolved the default wrapper, so the result does not depend on the order of builder calls.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithWrapperPath(wrapperPath string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "wrapperPath", + "type": "string", + "description": "The path to the wrapper script, absolute or relative to the resource's working directory." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + } + ], + "handleTypes": [ + { + "name": "IJavaAppResource", + "fullName": "Aspire.Hosting.Java.IJavaAppResource", + "kind": "handle", + "implementedInterfaces": [], + "capabilities": [ + { + "name": "WithJvmArgs", + "capabilityId": "Aspire.Hosting.Java/withJvmArgs", + "qualifiedName": "withJvmArgs", + "description": "Adds arguments to the Java Virtual Machine that runs the application.", + "remarks": "Arguments are passed through the `JAVA_TOOL_OPTIONS` environment variable, which the JVM reads\nhowever it was started — `java -jar`, a Maven goal, a Gradle task, or a container image's own\nentrypoint, including the JVM those build tools fork. Values containing spaces are quoted, because\nthe JVM splits this variable on whitespace.\nThis is also how a container image that already carries the OpenTelemetry Java agent turns it on,\nsince `WithOtelAgent``1` copies an agent from the build\ncontext and so applies only to applications Aspire itself launches or builds:\n`WithJvmArgs(\"-javaagent:/app/opentelemetry-javaagent.jar\")`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithJvmArgs(args []string) IJavaAppResource", + "receiver": "IJavaAppResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "The JVM arguments, for example `-Xmx512m`." + } + ], + "returnType": "IJavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.IJavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource", + "Aspire.Hosting.Java.JavaContainerResource" + ], + "appliesTo": [ + "JavaAppResource", + "JavaContainerResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "JavaAppResource", + "fullName": "Aspire.Hosting.Java.JavaAppResource", + "kind": "handle", + "description": "Represents a Java application resource in the distributed application model.", + "remarks": "The command is always `java`. When the application is launched through a Maven goal or a Gradle\ntask, the wrapper script replaces that command; see `WithMavenGoal` and `WithGradleTask`.", + "implementedInterfaces": [ + "IComputeResource", + "IContainerFilesDestinationResource", + "IJavaAppResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [ + { + "name": "WithGradleBuild", + "capabilityId": "Aspire.Hosting.Java/withGradleBuild", + "qualifiedName": "withGradleBuild", + "description": "Runs a Gradle build before the Java application starts.", + "remarks": "When the application launches with `WithGradleTask``1`,\nthat task performs the local compilation, so these arguments normally configure publishing without adding a\nsecond run-mode build. Otherwise, the build step is a child resource that the application waits for.\nNo child is created when publishing because the generated container image performs the build.\nThis runs a build before the application starts. To launch the application through Gradle,\nuse `WithGradleTask``1` instead.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithGradleBuild(args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "Arguments passed to the Gradle wrapper. Defaults to `clean build`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithGradleTask", + "capabilityId": "Aspire.Hosting.Java/withGradleTask", + "qualifiedName": "withGradleTask", + "description": "Launches the Java application through a Gradle task instead of `java`, for example `bootRun`.", + "remarks": "The wrapper defaults to `gradlew` (`gradlew.bat` on Windows) in the resource's working\ndirectory and can be overridden with `WithWrapperPath``1`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithGradleTask(task string, args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "task", + "type": "string", + "description": "The Gradle task to execute." + }, + { + "name": "args", + "type": "[]string", + "description": "Additional arguments passed to the Gradle wrapper after the task." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithJarArtifact", + "capabilityId": "Aspire.Hosting.Java/withJarArtifact", + "qualifiedName": "withJarArtifact", + "description": "Selects the JAR the generated container image runs, for projects whose build produces more than one.", + "remarks": "Only affects publishing, and only when the application is built in the image. Without it the\ncontainer build selects the single JAR that is not a `-plain`, `-sources`, or\n`-javadoc` artifact, and fails the build if that is ambiguous.\nThis takes precedence over the JAR named by the `jarPath` overload of\n`AddJavaApp`, so a\nresource can run one JAR locally and publish another. It has no effect on an application published\nfrom a prebuilt JAR, because nothing is built in the image for it to select from.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithJarArtifact(jarPath string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "jarPath", + "type": "string", + "description": "The path to the JAR produced by the build, relative to the application directory, for example `target/app.jar`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithMainClass", + "capabilityId": "Aspire.Hosting.Java/withMainClass", + "qualifiedName": "withMainClass", + "description": "Sets the main class an IDE launches when running or debugging this application. Has no effect on how Aspire starts the process, which is decided by the JAR path, Maven goal, or Gradle task.", + "remarks": "Only affects IDE execution. When omitted, the IDE resolves the main class from the project's build\nfiles; set it explicitly when a project declares more than one class with a `main` method.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithMainClass(mainClass string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "mainClass", + "type": "string", + "description": "The fully qualified name of the class declaring `main`, for example `com.example.Application`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithMavenBuild", + "capabilityId": "Aspire.Hosting.Java/withMavenBuild", + "qualifiedName": "withMavenBuild", + "description": "Runs a Maven build before the Java application starts.", + "remarks": "When the application launches with `WithMavenGoal``1`,\nthat goal performs the local compilation, so these arguments normally configure publishing without adding a\nsecond run-mode build. Otherwise, the build step is a child resource that the application waits for.\nNo child is created when publishing because the generated container image performs the build.\nThis runs a build before the application starts. To launch the application through Maven,\nuse `WithMavenGoal``1` instead.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithMavenBuild(args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "args", + "type": "[]string", + "description": "Arguments passed to the Maven wrapper. Defaults to `clean package`." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithMavenGoal", + "capabilityId": "Aspire.Hosting.Java/withMavenGoal", + "qualifiedName": "withMavenGoal", + "description": "Launches the Java application through a Maven goal instead of `java`, for example `spring-boot:run`.", + "remarks": "The wrapper defaults to `mvnw` (`mvnw.cmd` on Windows) in the resource's working directory\nand can be overridden with `WithWrapperPath``1`.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithMavenGoal(goal string, args []string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "goal", + "type": "string", + "description": "The Maven goal to execute." + }, + { + "name": "args", + "type": "[]string", + "description": "Additional arguments passed to the Maven wrapper after the goal." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithOtelAgent", + "capabilityId": "Aspire.Hosting.Java/withOtelAgent", + "qualifiedName": "withOtelAgent", + "description": "Runs the application with the OpenTelemetry Java agent so it exports traces, metrics, and logs to Aspire.", + "remarks": "The agent is not downloaded. Obtain it as a build dependency, or from\nhttps://github.com/open-telemetry/opentelemetry-java-instrumentation/releases, and point this at the\nresulting file. The OTLP exporter is configured by `AddJavaApp` regardless of whether an agent\nis used, so call this only when you want the agent's automatic instrumentation.\nA relative `agentPath` is resolved against the application directory and made absolute\nwhen running locally. This is required, not cosmetic: `JAVA_TOOL_OPTIONS` is inherited by every JVM\nstarted beneath the resource, and build tools start JVMs whose working directory is not the application\ndirectory. The Gradle daemon, for example, starts from its own distribution directory, so a relative\n`-javaagent:` path fails to resolve and the daemon dies during VM initialization with\n\"Error opening zip file or JAR manifest missing\".\nA relative path names a file the build produces, so Aspire runs that build as its own resource in run\nmode and holds the application until it finishes. An absolute path names a file that exists\nindependently of the build, so no build resource is added.\nIn publish mode a relative path is rewritten to the location the generated Dockerfile copies the\nagent to, because the path has to be interpreted inside the container rather than on the build\nmachine. An absolute path is emitted unchanged, since it cannot have come from the build context\nand must be supplied by the base image or a mount.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithOtelAgent(agentPath string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "agentPath", + "type": "string", + "description": "The path to the `opentelemetry-javaagent.jar` file." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithOtelAgentDefaultPath", + "capabilityId": "Aspire.Hosting.Java/withOtelAgentDefaultPath", + "qualifiedName": "withOtelAgentDefaultPath", + "description": "Runs the application with the OpenTelemetry Java agent from the location the build tool writes it to.", + "remarks": "The agent is expected at `target/agent/opentelemetry-javaagent.jar` for Maven and\n`build/agent/opentelemetry-javaagent.jar` for Gradle — the conventional output directory of each tool\nwith an `agent` subdirectory. The build has to put it there; nothing is downloaded. With Maven, copy it\nwith `maven-dependency-plugin`'s `copy` goal bound to `process-resources`; with Gradle,\ndeclare the agent in its own configuration and add a `Copy` task that `compileJava` depends on.\nMay be called before or after the build tool is configured: which directory the agent is read from is\ndecided when the application model is built, so the result does not depend on the order of builder calls.\nBecause the build writes the agent, Aspire runs that build as its own resource in run mode and holds\nthe application until it finishes — including for Spring Boot and Quarkus, whose launch goals would\notherwise be the only build. This is required rather than an optimization: `JAVA_TOOL_OPTIONS` is\nread by every JVM started beneath the resource, and the first of those is the wrapper's own, so an\nagent the build has not written yet kills that JVM during VM initialization with \"Error opening zip\nfile or JAR manifest missing\" before the launch goal runs.\nUse `WithOtelAgent``1` when the agent lives anywhere else, including\nwhen it is committed to the repository or supplied by the container base image.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithOtelAgentDefaultPath() JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + }, + { + "name": "WithWrapperPath", + "capabilityId": "Aspire.Hosting.Java/withWrapperPath", + "qualifiedName": "withWrapperPath", + "description": "Overrides the build tool wrapper script path, for repositories whose wrapper is not in the default location or does not use the default name.", + "remarks": "May be called before or after the build tool is configured. A later call re-points anything that\nalready resolved the default wrapper, so the result does not depend on the order of builder calls.", + "returns": "A reference to the `IResourceBuilder`1`.", + "kind": "Method", + "signature": "WithWrapperPath(wrapperPath string) JavaAppResource", + "receiver": "JavaAppResource", + "parameters": [ + { + "name": "wrapperPath", + "type": "string", + "description": "The path to the wrapper script, absolute or relative to the resource's working directory." + } + ], + "returnType": "JavaAppResource", + "returnsReceiver": true, + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting.Java/Aspire.Hosting.Java.JavaAppResource", + "expandedTargetTypes": [ + "Aspire.Hosting.Java.JavaAppResource" + ], + "appliesTo": [ + "JavaAppResource" + ] + } + ], + "synthesizedMembers": [] + }, + { + "name": "JavaContainerResource", + "fullName": "Aspire.Hosting.Java.JavaContainerResource", + "kind": "handle", + "description": "Represents a Java application that runs from a prebuilt container image.", + "implementedInterfaces": [ + "IComputeResource", + "IJavaAppResource", + "Resource", + "ResourceWithArgs", + "ResourceWithEndpoints", + "ResourceWithEnvironment", + "ResourceWithWaitSupport" + ], + "capabilities": [], + "synthesizedMembers": [] + } + ], + "dtoTypes": [], + "enumTypes": [], + "exportedValues": [] +} \ No newline at end of file diff --git a/src/frontend/src/data/go-modules/Aspire.Hosting.JavaScript.13.6.0.json b/src/frontend/src/data/go-modules/Aspire.Hosting.JavaScript.13.6.0.json new file mode 100644 index 0000000000..caeb19ca43 --- /dev/null +++ b/src/frontend/src/data/go-modules/Aspire.Hosting.JavaScript.13.6.0.json @@ -0,0 +1,2635 @@ +{ + "package": { + "name": "Aspire.Hosting.JavaScript", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire", + "sourceCommit": "f4c27f2d43ddc1cacd0dd083b30d1fea1cee7a62" + }, + "functions": [ + { + "name": "AddBunApp", + "capabilityId": "Aspire.Hosting.JavaScript/addBunApp", + "qualifiedName": "addBunApp", + "description": "Adds a Bun application to the application model. Bun should be available on the PATH.", + "remarks": "This method executes the script directly using `bun + + diff --git a/src/frontend/src/pages/reference/api/go/[module]/index.astro b/src/frontend/src/pages/reference/api/go/[module]/index.astro new file mode 100644 index 0000000000..5cdb3f4654 --- /dev/null +++ b/src/frontend/src/pages/reference/api/go/[module]/index.astro @@ -0,0 +1,781 @@ +--- +/** + * /reference/api/go/[module]/ — Go module landing page. + * + * Lists the handles, structs (DTOs), enums, standalone functions and exported values + * declared by one contributing package, with an in-page search scoped to that module. + */ +import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro'; +import { + countGoHandleMembers, + getGoModules, + goModuleSlug, + groupGoFunctionsByReceiver, +} from '@utils/go-modules'; +import { getGoApiReferenceSidebar } from '@utils/go-api-sidebar'; +import { buildGoApiSearchIndex } from '@utils/go-api-search'; +import { truncateGoDocText } from '@utils/go-doc-text'; +import { getGoFunctionDisplayLabel } from '@utils/go-api-function-kind'; +import { + getGoItemSlug, + getGoStandaloneFunctions, + getGoTopLevelRouteItems, + goSlugify, +} from '@utils/go-api-routes'; +import InpageSearch from '@components/api-reference/InpageSearch.astro'; +import GoDocText from '@components/api-reference/GoDocText.astro'; +import Breadcrumb from '@components/Breadcrumb.astro'; + +export async function getStaticPaths() { + const packages = await getGoModules(); + return packages.map(pkg => ({ + params: { module: goModuleSlug(pkg.data.package.name) }, + props: { pkg: pkg.data }, + })); +} + +const { pkg } = Astro.props; +const base = import.meta.env.BASE_URL.replace(/\/$/, ''); +const pkgSlug = goModuleSlug(pkg.package.name); +const isOfficial = pkg.package.name.startsWith('Aspire.'); +const topLevelItems = getGoTopLevelRouteItems(pkg); + +const byName = (a: { name: string }, b: { name: string }) => a.name.localeCompare(b.name); +const handles = [...(pkg.handleTypes ?? [])].sort(byName); +const dtos = [...(pkg.dtoTypes ?? [])].sort(byName); +const enums = [...(pkg.enumTypes ?? [])].sort(byName); +const functionGroups = [...groupGoFunctionsByReceiver(getGoStandaloneFunctions(pkg))]; +const functionCount = functionGroups.reduce((total, [, functions]) => total + functions.length, 0); +const exportedValues = (pkg.exportedValues ?? []).flatMap(group => + (group.values ?? []).map(entry => ({ ...entry, label: `${group.name}.${entry.path}` })) +); + +/* ── Stats ───────────────────────────────────────────────────── */ +const totalTypeCount = handles.length + dtos.length + enums.length; + +/* ── Headings for the sidebar section links ──────────────────── */ +const headings: { depth: 2; slug: string; text: string }[] = []; +if (handles.length > 0) headings.push({ depth: 2, slug: 'handles', text: 'Handles' }); +if (dtos.length > 0) headings.push({ depth: 2, slug: 'dtos', text: 'DTOs' }); +if (enums.length > 0) headings.push({ depth: 2, slug: 'enums', text: 'Enums' }); +if (functionCount > 0) headings.push({ depth: 2, slug: 'functions', text: 'Functions' }); +if (exportedValues.length > 0) headings.push({ depth: 2, slug: 'exported-values', text: 'Exported values' }); +const goSidebar = await getGoApiReferenceSidebar({ packageName: pkg.package.name, headings }); + +/* ── Module-scoped search index ──────────────────────────────── */ +// The module index is the global index narrowed to one module, so both searches agree on +// which entries exist and where they link. `m` marks members declared on a handle. +const globalEntries = buildGoApiSearchIndex([pkg], base); +const memberCount = globalEntries.filter(entry => entry.m).length; +const pkgIndex = globalEntries.map(({ n, f, k, s, t, h }) => ({ + n, + f, + k, + s: truncateGoDocText(s, 160), + h, + ...(t ? { t } : {}), +})); + +const allKinds = [...new Set(pkgIndex.map(e => e.k))].sort(); +const pkgIndexJson = JSON.stringify(pkgIndex); +const defaultStatsText = `${totalTypeCount.toLocaleString()} types, ${functionCount.toLocaleString()} functions and ${memberCount.toLocaleString()} members`; +--- + + + + +
+ {isOfficial && ( +
+ + Official +
+ )} +
+
+ 📦 {pkg.package.name} + {pkg.package.version && v{pkg.package.version}} +
+
+ {pkg.package.importPath && ( +
+ Import path + {pkg.package.importPath} +
+ )} +
+
+
+ {functionCount} + Functions +
+
+ {totalTypeCount} + Types +
+
+
+
+ + +
+ + + diff --git a/src/frontend/src/pages/reference/api/go/index.astro b/src/frontend/src/pages/reference/api/go/index.astro new file mode 100644 index 0000000000..1eec5b4b3f --- /dev/null +++ b/src/frontend/src/pages/reference/api/go/index.astro @@ -0,0 +1,513 @@ +--- +/** + * /reference/api/go/ — Go API Reference landing page with search. + * + * Lists all Go API modules with a client-side search bar that lets + * users filter across functions, methods, properties, handles, structs, and enums. + */ +import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro'; +import { getGoImportPaths, getGoModules, goModuleSlug } from '@utils/go-modules'; +import { getGoApiReferenceSidebar } from '@utils/go-api-sidebar'; +import { buildGoApiSearchIndex } from '@utils/go-api-search'; +import { formatGoApiSearchStats, getGoApiSearchStats } from '@utils/go-api-search-stats'; +import { getGoStandaloneFunctions } from '@utils/go-api-routes'; +import ApiSearchBar from '@components/api-reference/ApiSearchBar.astro'; +import Breadcrumb from '@components/Breadcrumb.astro'; + +const goSidebar = await getGoApiReferenceSidebar(); +const packages = await getGoModules(); +const sorted = packages + .map(p => p.data) + .sort((a, b) => a.package.name.localeCompare(b.package.name)); + +const base = import.meta.env.BASE_URL.replace(/\/$/, ''); + +/* ── Collect unique versions for the filter ─────────────────────── */ +const allGoVersions = [...new Set(sorted.map(p => p.package.version).filter(Boolean))] as string[]; + +/* ── Build the search index ─────────────────────────────────────── */ +const index = buildGoApiSearchIndex(sorted, base); +const defaultStats = getGoApiSearchStats(index); + +const allKinds = [...new Set(index.map(e => e.k))].sort(); +const indexJson = JSON.stringify(index); +const importPaths = getGoImportPaths(sorted); +--- + + + + +
+ + + diff --git a/src/frontend/src/styles/api-reference.css b/src/frontend/src/styles/api-reference.css index ede3c5c123..2e4f7c1031 100644 --- a/src/frontend/src/styles/api-reference.css +++ b/src/frontend/src/styles/api-reference.css @@ -317,6 +317,46 @@ a.api-list-item:hover { margin: 0; } +/* Inline `code` and API references in Go descriptions; also rendered into search results */ +.go-doc-code, +.go-doc-ref, +.go-doc-ref-link { + display: inline; + padding: 0.15em 0.35em; + border-radius: var(--api-radius-sm); + font-size: 0.9em; + white-space: normal; + overflow-wrap: anywhere; +} +.go-doc-code { + background: var(--sl-color-gray-5); + color: var(--sl-color-gray-1); +} +.go-doc-ref { + background: var(--sl-color-gray-5); + color: var(--sl-color-gray-2); +} +.go-doc-ref-link { + background: color-mix(in srgb, var(--api-accent-text) 10%, transparent); + color: inherit; +} +a.go-doc-link { + color: var(--api-accent-text); + text-decoration: underline; + text-underline-offset: 0.2em; +} +a.go-doc-link:hover { + text-decoration-thickness: 2px; +} +:root[data-theme='light'] .go-doc-code, +:root[data-theme='light'] .go-doc-ref { + color: var(--sl-color-gray-1, #24292e); + background: var(--sl-color-gray-6, #f0f0f0); +} +:root[data-theme='light'] .go-doc-ref-link { + background: color-mix(in srgb, var(--api-accent-text) 12%, var(--sl-color-gray-6, #f0f0f0)); +} + /* Compact meta values shown inline (version, type count, enum value…) */ .api-list-meta { font-size: var(--api-text-sm); diff --git a/src/frontend/src/styles/site.css b/src/frontend/src/styles/site.css index c81e6bf15f..8d691ee3f6 100644 --- a/src/frontend/src/styles/site.css +++ b/src/frontend/src/styles/site.css @@ -956,6 +956,11 @@ li a.external-link::after { --sl-sidebar-width: 30rem; } +/* Same narrower sidebar for Go API reference pages */ +:root:has(.topics-sidebar[data-api-lang='go']) { + --sl-sidebar-width: 30rem; +} + /* Remove parent top padding so the sticky wrapper sits flush at the top */ :root:has(.topics-sidebar[data-api-ref]) #starlight__sidebar .sidebar-content { padding-top: 0; diff --git a/src/frontend/src/utils/api-reference-routes.ts b/src/frontend/src/utils/api-reference-routes.ts index 8969eddd4f..c126c99219 100644 --- a/src/frontend/src/utils/api-reference-routes.ts +++ b/src/frontend/src/utils/api-reference-routes.ts @@ -36,5 +36,5 @@ export function stripApiReferenceLocale(pathname: string): string | undefined { export function normalizeApiReferenceSidebarHref(href: string): string { const canonical = stripApiReferenceLocale(href) ?? href; // Starlight's trailingSlash formatting also appends "/" after section fragments. - return canonical.replace(/^(\/reference\/api\/typescript\/[^#]*#[\w-]+)\/$/, '$1'); + return canonical.replace(/^(\/reference\/api\/(?:typescript|go)\/[^#]*#[\w-]+)\/$/, '$1'); } diff --git a/src/frontend/src/utils/go-api-function-kind.ts b/src/frontend/src/utils/go-api-function-kind.ts new file mode 100644 index 0000000000..6f0c390716 --- /dev/null +++ b/src/frontend/src/utils/go-api-function-kind.ts @@ -0,0 +1,22 @@ +import type { GoFunction } from './go-modules'; + +type GoFunctionLike = Pick; + +/** Go methods carry a receiver type; package-level functions such as CreateBuilder have none. */ +export function isGoMethodStyleFunction(fn: Pick): boolean { + return typeof fn.receiver === 'string' && fn.receiver.length > 0; +} + +export function getGoFunctionDisplayKind(fn: Pick): 'function' | 'method' { + return isGoMethodStyleFunction(fn) ? 'method' : 'function'; +} + +export function getGoFunctionDisplayLabel(fn: Pick): 'Function' | 'Method' { + return isGoMethodStyleFunction(fn) ? 'Method' : 'Function'; +} + +/** The receiver is part of the identity: one capability can be specialised for several receiver types. */ +export function getGoCallableIdentityKey(callable: GoFunctionLike): string { + const identity = callable.capabilityId ?? `${callable.qualifiedName ?? callable.name}::${callable.signature ?? ''}`; + return `${identity}::${callable.receiver ?? ''}`; +} diff --git a/src/frontend/src/utils/go-api-markdown.ts b/src/frontend/src/utils/go-api-markdown.ts new file mode 100644 index 0000000000..20599bb0d1 --- /dev/null +++ b/src/frontend/src/utils/go-api-markdown.ts @@ -0,0 +1,475 @@ +import { + GO_MARKER_NOTE, + buildGoDtoDefinition, + buildGoEnumDefinition, + buildGoFunctionDefinition, + buildGoHandleDefinition, + buildGoHandleMemberDefinition, + closeUnclosedCodeFences, + countGoHandleMembers, + describeGoErrorModel, + formatGoSignature, + getGoHandleAppliesTo, + getGoImportPaths, + getGoModules, + getGoOptionsParameterName, + getGoPropertyValueType, + goModuleSlug, + groupGoFunctionsByReceiver, + parseGoTypeReference, +} from '@utils/go-modules'; +import type { + GoApiDocument, + GoDtoType, + GoEnumType, + GoFunction, + GoFunctionParameter, + GoHandleType, +} from '@utils/go-modules'; +import { + bulletList, + codeBlock, + dedentText, + finalizeMarkdown, + indentMarkdown, + inlineCode, + keyValueBullets, + link, + normalizeBase, + section, +} from '@utils/api-markdown-shared'; +import { getGoFunctionDisplayKind, getGoFunctionDisplayLabel } from '@utils/go-api-function-kind'; +import { normalizeGoDocMarkdown } from '@utils/go-doc-text'; +import { + getGoItemSlug, + getGoMethods, + getGoMethodSlug, + getGoStandaloneFunctions, + getGoTopLevelRouteItems, + getGoTypeByName, +} from '@utils/go-api-routes'; + +type GoItemKind = 'handle' | 'dto' | 'enum' | 'function'; +type GoItem = GoHandleType | GoDtoType | GoEnumType | GoFunction; + +export function goIndexMdHref(base: string): string { + return `${normalizeBase(base)}/reference/api/go.md`; +} + +export function goModuleMdHref(base: string, moduleName: string): string { + return `${normalizeBase(base)}/reference/api/go/${goModuleSlug(moduleName)}.md`; +} + +export function goItemMdHref(base: string, moduleName: string, itemSlug: string): string { + return `${normalizeBase(base)}/reference/api/go/${goModuleSlug(moduleName)}/${itemSlug}.md`; +} + +export function goMemberMdHref( + base: string, + moduleName: string, + itemSlug: string, + memberSlug: string +): string { + return `${normalizeBase(base)}/reference/api/go/${goModuleSlug(moduleName)}/${itemSlug}/${memberSlug}.md`; +} + +export function renderGoIndexMarkdown(modules: GoApiDocument[], base: string): string { + const sorted = [...modules].sort((left, right) => left.package.name.localeCompare(right.package.name)); + + const lines = sorted.map((pkg) => { + const functionCount = getGoStandaloneFunctions(pkg).length; + const typeCount = (pkg.handleTypes ?? []).length + (pkg.dtoTypes ?? []).length + (pkg.enumTypes ?? []).length; + const summary = [pkg.package.version ? `v${pkg.package.version}` : null, `${functionCount} functions`, `${typeCount} types`] + .filter(Boolean) + .join(' · '); + + return `- ${link(pkg.package.name, goModuleMdHref(base, pkg.package.name))} — ${summary}`; + }); + + const importPaths = getGoImportPaths(sorted); + const importSentence = importPaths.length === 0 + ? '' + : importPaths.length === 1 + ? `Every module is part of one flat Go package, imported as ${inlineCode(importPaths[0])}.` + : `Modules are imported as ${importPaths.map(inlineCode).join(', ')}.`; + + return finalizeMarkdown([ + '# Go API Reference', + `Browse the Go APIs available when writing an Aspire Go AppHost. ${importSentence}`, + section('Modules', bulletList(lines)), + ]); +} + +export function renderGoModuleMarkdown(pkg: GoApiDocument, base: string): string { + const sourceHref = getGoSourceHref(pkg); + const items = getGoTopLevelRouteItems(pkg); + const handles = [...(pkg.handleTypes ?? [])].sort(compareByName); + const dtos = [...(pkg.dtoTypes ?? [])].sort(compareByName); + const enums = [...(pkg.enumTypes ?? [])].sort(compareByName); + const standaloneFunctions = [...groupGoFunctionsByReceiver(getGoStandaloneFunctions(pkg)).values()].flat(); + + const metadata = keyValueBullets([ + { label: 'Module', value: inlineCode(pkg.package.name) }, + { label: 'Version', value: pkg.package.version ? inlineCode(pkg.package.version) : null }, + { label: 'Import path', value: pkg.package.importPath ? inlineCode(pkg.package.importPath) : null }, + { label: 'Source', value: sourceHref ? link('GitHub', sourceHref) : null }, + { label: 'Functions', value: inlineCode(String(standaloneFunctions.length)) }, + { label: 'Types', value: inlineCode(String(handles.length + dtos.length + enums.length)) }, + ]); + + const handleLines = handles.map((item) => { + const kinds = [inlineCode(item.isInterface ? 'interface' : 'handle'), item.isMarker ? inlineCode('marker') : null] + .filter(Boolean) + .join(' '); + const count = countGoHandleMembers(item); + return `- ${link(item.name, goItemMdHref(base, pkg.package.name, getGoItemSlug(item, items)))} — ${kinds} · ${count} members${summaryOf(item.description)}`; + }); + + const dtoLines = dtos.map((item) => + `- ${link(item.name, goItemMdHref(base, pkg.package.name, getGoItemSlug(item, items)))} — ${inlineCode('struct')} · ${item.fields?.length ?? 0} fields${summaryOf(item.description)}` + ); + + const enumLines = enums.map((item) => + `- ${link(item.name, goItemMdHref(base, pkg.package.name, getGoItemSlug(item, items)))} — ${inlineCode('enum')} · ${(item.members ?? []).length} values${summaryOf(item.description)}` + ); + + const functionLines = standaloneFunctions.map((fn) => { + const receiver = fn.receiver ? ` · on ${inlineCode(fn.receiver)}` : ''; + return `- ${link(fn.name, goItemMdHref(base, pkg.package.name, getGoItemSlug(fn, items)))} — ${inlineCode(getGoFunctionDisplayKind(fn))}${receiver}${summaryOf(fn.description)}`; + }); + + return finalizeMarkdown([ + `# ${pkg.package.name}`, + metadata, + section('Handles', bulletList(handleLines)), + section('DTOs', bulletList(dtoLines)), + section('Enums', bulletList(enumLines)), + section('Functions', bulletList(functionLines)), + section('Exported values', renderExportedValuesMarkdown(pkg)), + ]); +} + +export function renderGoItemMarkdown( + pkg: GoApiDocument, + item: GoItem, + itemKind: GoItemKind, + base: string +): string { + const handleItem = itemKind === 'handle' ? (item as GoHandleType) : null; + const dtoItem = itemKind === 'dto' ? (item as GoDtoType) : null; + const enumItem = itemKind === 'enum' ? (item as GoEnumType) : null; + const functionItem = itemKind === 'function' ? (item as GoFunction) : null; + const sourceHref = getGoSourceHref(pkg); + const metadata = keyValueBullets([ + { label: 'Module', value: link(pkg.package.name, goModuleMdHref(base, pkg.package.name)) }, + { label: 'Version', value: pkg.package.version ? inlineCode(pkg.package.version) : null }, + { label: 'Kind', value: inlineCode(getItemKindLabel(itemKind, handleItem, functionItem).toLowerCase()) }, + { + label: 'Defined on', + value: functionItem?.receiver ? formatGoTypeReferenceMarkdown(functionItem.receiver, pkg, base) : null, + }, + { label: 'Source', value: sourceHref ? link('GitHub', sourceHref) : null }, + ]); + + return finalizeMarkdown([ + `# ${item.name}`, + metadata, + describe(item.description), + section('Remarks', describe(item.remarks)), + section('Definition', codeBlock(buildGoDeclaration(item, itemKind), 'go')), + handleItem ? section('Embeds', renderEmbedsMarkdown(handleItem.implementedInterfaces ?? [], pkg, base)) : '', + handleItem ? section('Properties', renderHandlePropertiesMarkdown(handleItem, pkg, base)) : '', + handleItem ? section('Methods', renderHandleMethodsMarkdown(handleItem, pkg, base)) : '', + dtoItem ? section('Fields', renderDtoFieldsMarkdown(dtoItem, pkg, base)) : '', + enumItem ? section('Values', renderEnumValuesMarkdown(enumItem)) : '', + functionItem ? section('Parameters', renderGoParametersMarkdown(functionItem, pkg, base)) : '', + functionItem ? section('Options', renderGoOptionsMarkdown(functionItem, pkg, base)) : '', + functionItem ? section('Returns', renderGoReturnMarkdown(functionItem, pkg, base)) : '', + handleItem && (handleItem.isInterface || handleItem.isMarker) + ? section('Applies to', renderAppliesToMarkdown(getGoHandleAppliesTo(handleItem), pkg, base)) + : '', + functionItem ? section('Applies to', renderAppliesToMarkdown(functionItem.appliesTo ?? [], pkg, base)) : '', + ]); +} + +export function renderGoMemberMarkdownPage( + pkg: GoApiDocument, + parentType: GoHandleType, + method: GoFunction, + base: string +): string { + const parentSlug = getGoItemSlug(parentType, getGoTopLevelRouteItems(pkg)); + const metadata = keyValueBullets([ + { label: 'Module', value: link(pkg.package.name, goModuleMdHref(base, pkg.package.name)) }, + { + label: 'Defined on', + value: link(parentType.name, goItemMdHref(base, pkg.package.name, parentSlug)), + }, + { label: 'Version', value: pkg.package.version ? inlineCode(pkg.package.version) : null }, + { label: 'Kind', value: inlineCode('method') }, + ]); + + const definedOn = bulletList([ + `- ${link(parentType.name, goItemMdHref(base, pkg.package.name, parentSlug))} — ${inlineCode( + parentType.isMarker ? 'marker' : parentType.isInterface ? 'interface' : 'handle' + )}`, + ]); + + return finalizeMarkdown([ + `# ${parentType.name}.${method.name}`, + metadata, + describe(method.description), + section('Remarks', describe(method.remarks)), + section('Definition', codeBlock(buildGoHandleMemberDefinition(parentType, method), 'go')), + section('Signature', codeBlock(formatGoSignature(method.signature ?? ''), 'go')), + section('Parameters', renderGoParametersMarkdown(method, pkg, base)), + section('Options', renderGoOptionsMarkdown(method, pkg, base)), + section('Returns', renderGoReturnMarkdown(method, pkg, base)), + section('Defined on', parentType.isMarker ? `${GO_MARKER_NOTE}\n\n${definedOn}` : definedOn), + parentType.isMarker ? section('Applies to', renderAppliesToMarkdown(method.appliesTo ?? [], pkg, base)) : '', + ]); +} + +function getItemKindLabel( + itemKind: GoItemKind, + handleItem: GoHandleType | null, + functionItem: GoFunction | null +): string { + if (itemKind === 'handle') { + return handleItem?.isInterface ? 'Interface' : 'Handle'; + } + + if (itemKind === 'dto') { + return 'Struct'; + } + + if (itemKind === 'function') { + return getGoFunctionDisplayLabel(functionItem ?? { receiver: null }); + } + + return 'Enum'; +} + +function buildGoDeclaration(item: GoItem, itemKind: GoItemKind): string { + if (itemKind === 'handle') { + return buildGoHandleDefinition(item); + } + + if (itemKind === 'dto') { + return buildGoDtoDefinition(item); + } + + if (itemKind === 'enum') { + return buildGoEnumDefinition(item); + } + + return buildGoFunctionDefinition(item); +} + +function renderEmbedsMarkdown(names: string[], pkg: GoApiDocument, base: string): string { + return bulletList(names.map((name) => `- ${formatGoTypeReferenceMarkdown(name, pkg, base)}`)); +} + +function renderHandlePropertiesMarkdown(item: GoHandleType, pkg: GoApiDocument, base: string): string { + const getters = (item.capabilities ?? []).filter(isPropertyGetter).sort(compareByName); + const setters = (item.capabilities ?? []).filter(isPropertySetter).sort(compareByName); + if (getters.length === 0 && setters.length === 0) { + return ''; + } + + const getterLines = getters.map((getter) => { + const hasSetter = setters.some((setter) => normalizeSetterName(setter.name) === getter.name.toLowerCase()); + const access = hasSetter ? 'get/set' : 'get'; + return `- ${inlineCode(getter.name)}: ${formatGoTypeReferenceMarkdown(getGoPropertyValueType(getter), pkg, base)} ${inlineCode(access)}${summaryOf(getter.description)}`; + }); + + const setterLines = setters + .filter((setter) => !getters.some((getter) => getter.name.toLowerCase() === normalizeSetterName(setter.name))) + .map((setter) => + `- ${inlineCode(setter.name)}(${formatGoTypeReferenceMarkdown(getGoPropertyValueType(setter), pkg, base)}) ${inlineCode('set')}${summaryOf(setter.description)}` + ); + + return bulletList([...getterLines, ...setterLines]); +} + +function renderHandleMethodsMarkdown(item: GoHandleType, pkg: GoApiDocument, base: string): string { + const methods = getGoMethods(item); + const synthesized = item.synthesizedMembers ?? []; + if (methods.length === 0 && synthesized.length === 0) { + return ''; + } + + const itemSlug = getGoItemSlug(item, getGoTopLevelRouteItems(pkg)); + const methodLines = getGoMethods(item, true).map((method) => { + const href = goMemberMdHref(base, pkg.package.name, itemSlug, getGoMethodSlug(method, methods, item.name)); + return `- ${link(method.name, href)} — ${inlineCode('method')}${summaryOf(method.description)}\n${indentMarkdown(codeBlock(method.signature ?? '', 'go'), ' ')}`; + }); + + // Hand-written SDK helpers have no capability behind them, so they get no pages. + const synthesizedLines = synthesized.map((member) => + `- ${inlineCode(member.name)} — ${inlineCode('method')}${summaryOf(member.description)}${ + member.signature ? `\n${indentMarkdown(codeBlock(member.signature, 'go'), ' ')}` : '' + }` + ); + + const entries = bulletList([...methodLines, ...synthesizedLines]); + return item.isMarker && methods.length > 0 ? `${GO_MARKER_NOTE}\n\n${entries}` : entries; +} + +function renderDtoFieldsMarkdown(item: GoDtoType, pkg: GoApiDocument, base: string): string { + const fields = item.fields ?? []; + if (fields.length === 0) { + return ''; + } + + return bulletList( + fields.map((field) => { + const badges = [ + field.isOptional ? inlineCode('optional') : null, + field.isCallback ? inlineCode('callback') : null, + ] + .filter(Boolean) + .join(' '); + return `- ${inlineCode(field.name)}: ${formatGoTypeReferenceMarkdown(field.type, pkg, base)}${badges ? ` ${badges}` : ''}${summaryOf(field.description)}`; + }) + ); +} + +function renderEnumValuesMarkdown(item: GoEnumType): string { + const members = item.members ?? []; + if (members.length === 0) { + return ''; + } + + return bulletList( + members.map((member) => `- ${inlineCode(member.name)} = ${inlineCode(JSON.stringify(member.value))}${summaryOf(member.description)}`) + ); +} + +function renderExportedValuesMarkdown(pkg: GoApiDocument): string { + return bulletList( + (pkg.exportedValues ?? []).flatMap((group) => + (group.values ?? []).map((entry) => { + const type = entry.type ? `: ${inlineCode(entry.type)}` : ''; + const value = entry.value ? ` = ${inlineCode(entry.value)}` : ''; + return `- ${inlineCode(`${group.name}.${entry.path}`)}${type}${value}${summaryOf(entry.description)}`; + }) + ) + ); +} + +function renderGoParametersMarkdown(callable: GoFunction, pkg: GoApiDocument, base: string): string { + const parameters = callable.parameters ?? []; + const lines = parameters.map((parameter: GoFunctionParameter) => + `- ${inlineCode(parameter.name)} (${formatGoTypeReferenceMarkdown(parameter.type, pkg, base)})${summaryOf(parameter.description)}` + ); + + if (callable.options?.typeName) { + const optionsName = getGoOptionsParameterName(callable); + lines.push( + `- ${inlineCode(optionsName)} (${inlineCode(`...*${callable.options.typeName}`)}) — optional settings, see ${link('Options', '#options')}` + ); + } + + return bulletList(lines); +} + +function renderGoOptionsMarkdown(callable: GoFunction, pkg: GoApiDocument, base: string): string { + const options = callable.options; + if (!options?.typeName) { + return ''; + } + + if (options.isDirect) { + return `Optional parameters are passed as the existing ${formatGoTypeReferenceMarkdown(`*${options.typeName}`, pkg, base)} struct.`; + } + + const fields = options.fields ?? []; + const lines = fields.map((field) => { + const type = field.isCallback && field.callbackSignature + ? inlineCode(field.callbackSignature) + : formatGoTypeReferenceMarkdown(field.type, pkg, base); + const callback = field.isCallback ? ` ${inlineCode('callback')}` : ''; + return `- ${inlineCode(field.name)} (${type})${callback}${summaryOf(field.description)}`; + }); + + return [ + `Optional parameters are passed in a trailing ${inlineCode(`${getGoOptionsParameterName(callable)} ...*${options.typeName}`)} argument.`, + bulletList(lines), + ] + .filter(Boolean) + .join('\n\n'); +} + +function renderGoReturnMarkdown(callable: GoFunction, pkg: GoApiDocument, base: string): string { + const returnType = callable.returnType?.trim(); + const typeLine = returnType + ? `${formatGoTypeReferenceMarkdown(returnType, pkg, base)}${summaryOf(callable.returns)}` + : describe(callable.returns); + + return [typeLine, describeGoErrorModel(callable)].filter(Boolean).join('\n\n'); +} + +function renderAppliesToMarkdown(targetTypes: string[], pkg: GoApiDocument, base: string): string { + return bulletList(targetTypes.map((targetType) => `- ${formatGoTypeReferenceMarkdown(targetType, pkg, base)}`)); +} + +/** + * Link a Go type to its page when it is declared in the same module. Types such as + * `string`, `*List[string]`, `map[string]any` or types from other modules render as code. + */ +function formatGoTypeReferenceMarkdown(typeRef: string | undefined, pkg: GoApiDocument, base: string): string { + const text = typeRef?.trim(); + if (!text) { + return inlineCode('any'); + } + + const parsed = parseGoTypeReference(text); + const item = parsed ? getGoTypeByName(pkg, parsed.name) : undefined; + + return item + ? link(inlineCode(text), goItemMdHref(base, pkg.package.name, getGoItemSlug(item, getGoTopLevelRouteItems(pkg)))) + : inlineCode(text); +} + +/** Description and remarks can hold an unterminated ``` fence; close it so later sections survive. */ +function describe(text: string | undefined): string { + return text ? closeUnclosedCodeFences(dedentText(normalizeGoDocMarkdown(text))) : ''; +} + +/** Single-line ` — description` suffix for list entries. */ +function summaryOf(text: string | undefined): string { + const oneLine = text ? normalizeGoDocMarkdown(text).replace(/\s+/g, ' ').trim() : ''; + return oneLine ? ` — ${oneLine}` : ''; +} + +function compareByName(left: T, right: T): number { + return left.name.localeCompare(right.name); +} + +function isPropertyGetter(capability: GoFunction): boolean { + return capability.kind === 'PropertyGetter'; +} + +function isPropertySetter(capability: GoFunction): boolean { + return capability.kind === 'PropertySetter'; +} + +function normalizeSetterName(name: string): string { + return name.replace(/^Set/, '').toLowerCase(); +} + +function getGoSourceHref(pkg: GoApiDocument): string | undefined { + if (!pkg.package.sourceRepository) { + return undefined; + } + + return pkg.package.sourceCommit + ? `${pkg.package.sourceRepository}/tree/${pkg.package.sourceCommit}` + : pkg.package.sourceRepository; +} + +export async function getGoMarkdownRouteProps(): Promise { + const packages = await getGoModules(); + return packages.map((entry) => entry.data); +} diff --git a/src/frontend/src/utils/go-api-routes.ts b/src/frontend/src/utils/go-api-routes.ts new file mode 100644 index 0000000000..6ec89a4cc9 --- /dev/null +++ b/src/frontend/src/utils/go-api-routes.ts @@ -0,0 +1,294 @@ +export interface GoRouteParameterLike { + name?: string; + type?: string; + callbackSignature?: string; + isCallback?: boolean; +} + +export interface GoRouteCallableLike { + name: string; + kind?: string; + description?: string; + signature?: string; + qualifiedName?: string; + receiver?: string | null; + targetTypeId?: string; + expandedTargetTypes?: string[]; + parameters?: GoRouteParameterLike[]; +} + +export interface GoTopLevelRouteItemLike extends GoRouteCallableLike { + fullName?: string; + capabilities?: GoRouteCallableLike[]; +} + +export interface GoApiDocumentRouteLike { + functions?: GoTopLevelRouteItemLike[]; + handleTypes?: GoTopLevelRouteItemLike[]; + dtoTypes?: GoTopLevelRouteItemLike[]; + enumTypes?: GoTopLevelRouteItemLike[]; +} + +const stableDocuments = new WeakSet(); +const stableCollections = new WeakSet(); +const standaloneFunctions = new WeakMap(); +const topLevelItems = new WeakMap(); +const typesByName = new WeakMap>(); +const methodCollections = new WeakMap>(); +const itemIndexes = new WeakMap>(); +const methodIndexes = new WeakMap>>(); + +/** + * Opt production collection data into route reuse. Freeze the JSON graph first: + * array identity alone cannot detect edits to names, parameters or nested types. + * Development and caller-owned mutable documents never enter these caches. + * Weak keys keep indexes scoped to the lifetime of the loaded collection. + */ +export function prepareGoApiRoutes(doc: GoApiDocumentRouteLike): void { + if (stableDocuments.has(doc)) return; + freezeRouteData(doc); + stableDocuments.add(doc); + getGoTopLevelRouteItems(doc); +} + +function freezeRouteData(value: object, seen = new WeakSet()): void { + if (seen.has(value)) return; + seen.add(value); + for (const child of Object.values(value) as unknown[]) { + if (child && typeof child === 'object') freezeRouteData(child, seen); + } + Object.freeze(value); +} + +function stableCollection(items: T[]): T[] { + Object.freeze(items); + stableCollections.add(items); + return items; +} + +/** Keep source ordering for URLs; sorted presentation has its own collision order. */ +export function getGoMethods( + handle: { capabilities?: T[] }, + sorted = false +): T[] { + const capabilities = handle.capabilities; + const cached = capabilities && methodCollections.get(capabilities)?.get(sorted); + if (cached) return cached as T[]; + const methods = (capabilities ?? []).filter( + (candidate) => candidate.kind === 'Method' || candidate.kind === 'InstanceMethod' + ); + if (sorted) methods.sort((left, right) => left.name.localeCompare(right.name)); + if (capabilities && stableCollections.has(capabilities)) { + const collections = methodCollections.get(capabilities) ?? new Map(); + collections.set(sorted, stableCollection(methods)); + methodCollections.set(capabilities, collections); + } + return methods; +} + +export function goSlugify(name: string): string { + return name + .toLowerCase() + .replace(/[^a-z0-9]+/g, '-') + .replace(/^-|-$/g, ''); +} + +export function getGoMemberAnchor(name: string): string { + return name.toLowerCase().replace(/[^a-z0-9]/g, '-'); +} + +/** Top-level functions without a dotted ATS name: `CreateBuilder`, `AddRedis`, `WithDataVolume`, ... */ +export function getGoStandaloneFunctions( + doc: { functions?: T[] } +): T[] { + const cached = standaloneFunctions.get(doc); + if (cached) return cached as T[]; + const functions = (doc.functions ?? []).filter( + (fn) => !fn.qualifiedName || !fn.qualifiedName.includes('.') + ); + if (stableDocuments.has(doc)) standaloneFunctions.set(doc, stableCollection(functions)); + return functions; +} + +/** Resolve the first type with this display name, in the original catalog order. */ +export function getGoTypeByName(doc: GoApiDocumentRouteLike, name: string): GoTopLevelRouteItemLike | undefined { + let index = typesByName.get(doc); + if (!index && stableDocuments.has(doc)) { + index = new Map(); + for (const collection of [doc.handleTypes, doc.dtoTypes, doc.enumTypes]) { + for (const item of collection ?? []) { + if (!index.has(item.name)) index.set(item.name, item); + } + } + typesByName.set(doc, index); + } + return index + ? index.get(name) + : doc.handleTypes?.find((item) => item.name === name) + ?? doc.dtoTypes?.find((item) => item.name === name) + ?? doc.enumTypes?.find((item) => item.name === name); +} + +export function getGoTopLevelRouteItems(doc: GoApiDocumentRouteLike): GoTopLevelRouteItemLike[] { + const cached = topLevelItems.get(doc); + if (cached) return cached; + const items = [ + ...(doc.handleTypes ?? []), + ...(doc.dtoTypes ?? []), + ...(doc.enumTypes ?? []), + ...getGoStandaloneFunctions(doc), + ]; + if (stableDocuments.has(doc)) { + topLevelItems.set(doc, stableCollection(items)); + for (const handle of doc.handleTypes ?? []) { + if (handle.capabilities) stableCollections.add(handle.capabilities); + } + } + return items; +} + +export function getGoItemSlug( + item: GoTopLevelRouteItemLike, + allItems: GoTopLevelRouteItemLike[] +): string { + let index = itemIndexes.get(allItems); + if (!index) { + index = createSlugIndex(allItems, getTopLevelDisambiguator); + if (stableCollections.has(allItems)) itemIndexes.set(allItems, index); + } + return index.get(item); +} + +export function getGoMethodSlug( + method: GoRouteCallableLike, + siblingMethods: GoRouteCallableLike[], + parentName?: string +): string { + let index = methodIndexes.get(siblingMethods)?.get(parentName); + if (!index) { + index = createSlugIndex(siblingMethods, (candidate) => + getCallableDisambiguator(candidate, { includeTarget: false, parentName }) + ); + if (stableCollections.has(siblingMethods)) { + const contexts = methodIndexes.get(siblingMethods) ?? new Map>(); + contexts.set(parentName, index); + methodIndexes.set(siblingMethods, contexts); + } + } + return index.get(method); +} + +interface SlugIndex { + get(item: T): string; +} + +function createSlugIndex( + siblings: T[], + getDisambiguator: (candidate: T) => string +): SlugIndex { + const groups = new Map(); + const slugs = new Map(); + for (const item of siblings) { + const base = goSlugify(item.name); + const group = groups.get(base); + if (group) group.push(item); + else groups.set(base, [item]); + } + + for (const [base, group] of groups) { + if (group.length === 1) { + slugs.set(group[0], base); + continue; + } + const occurrences = new Map(); + for (const item of group) { + const slug = appendDisambiguator(base, getDisambiguator(item)); + const occurrence = (occurrences.get(slug) ?? 0) + 1; + occurrences.set(slug, occurrence); + // Repeated references count as occurrences, but identity resolves to the first. + if (!slugs.has(item)) slugs.set(item, occurrence > 1 ? `${slug}-${occurrence}` : slug); + } + } + + return { + get(item) { + const known = slugs.get(item); + if (known !== undefined) return known; + const base = goSlugify(item.name); + // A caller may supply an equivalent object not present in the collection. + return (groups.get(base)?.length ?? 0) > 1 + ? appendDisambiguator(base, getDisambiguator(item)) + : base; + }, + }; +} + +function appendDisambiguator(baseSlug: string, disambiguator: string): string { + return disambiguator ? `${baseSlug}-${disambiguator}` : baseSlug; +} + +function getTopLevelDisambiguator(item: GoTopLevelRouteItemLike): string { + if (isCallableItem(item)) { + return getCallableDisambiguator(item, { includeTarget: true }); + } + + return goSlugify(item.fullName ?? item.name); +} + +function isCallableItem(item: GoTopLevelRouteItemLike): boolean { + return Array.isArray(item.parameters) + || Array.isArray(item.expandedTargetTypes) + || typeof item.targetTypeId === 'string' + || typeof item.qualifiedName === 'string' + || typeof item.signature === 'string'; +} + +function getCallableDisambiguator( + callable: GoRouteCallableLike, + options: { includeTarget: boolean; parentName?: string } +): string { + const parts: string[] = []; + + if (options.parentName) { + parts.push(options.parentName); + } + + if (options.includeTarget) { + // Go methods carry their receiver type; only package-level functions such as + // CreateBuilder have none, and those fall back to the ATS target when present. + const targetRef = callable.receiver + ?? callable.expandedTargetTypes?.[0] + ?? callable.targetTypeId + ?? getQualifiedNameContainer(callable.qualifiedName); + + if (targetRef) { + parts.push(targetRef); + } + } + + const parameterTypes = (callable.parameters ?? []) + .map((parameter) => parameter.callbackSignature ?? parameter.type) + .filter((value): value is string => Boolean(value)); + + if (parameterTypes.length > 0) { + parts.push(...parameterTypes); + } else { + parts.push('noargs'); + } + + const candidate = parts.map((part) => goSlugify(part)).filter(Boolean).join('-'); + if (candidate) { + return candidate; + } + + return goSlugify(callable.signature ?? callable.qualifiedName ?? callable.name); +} + +function getQualifiedNameContainer(qualifiedName?: string): string | undefined { + if (!qualifiedName) { + return undefined; + } + + const lastDot = qualifiedName.lastIndexOf('.'); + return lastDot > 0 ? qualifiedName.slice(0, lastDot) : undefined; +} diff --git a/src/frontend/src/utils/go-api-search-stats.ts b/src/frontend/src/utils/go-api-search-stats.ts new file mode 100644 index 0000000000..1c76847f91 --- /dev/null +++ b/src/frontend/src/utils/go-api-search-stats.ts @@ -0,0 +1,38 @@ +export interface GoApiSearchIndexEntry { + n: string; + f: string; + k: string; + p: string; + s: string; + h: string; + t?: string; + v?: string; + m?: boolean; +} + +export interface GoApiSearchStats { + packageCount: number; + capabilityCount: number; + typeCount: number; +} + +const capabilityKinds = new Set(['function', 'method', 'property']); + +export function getGoApiSearchStats( + index: ReadonlyArray, + versions: ReadonlySet | null = null +): GoApiSearchStats { + const visibleEntries = versions === null + ? index + : index.filter((entry) => entry.v && versions.has(entry.v)); + + return { + packageCount: new Set(visibleEntries.map((entry) => entry.p)).size, + capabilityCount: visibleEntries.filter((entry) => capabilityKinds.has(entry.k)).length, + typeCount: visibleEntries.filter((entry) => !capabilityKinds.has(entry.k)).length, + }; +} + +export function formatGoApiSearchStats(stats: GoApiSearchStats): string { + return `${stats.capabilityCount.toLocaleString()} capabilities and ${stats.typeCount.toLocaleString()} types across ${stats.packageCount.toLocaleString()} modules`; +} diff --git a/src/frontend/src/utils/go-api-search.ts b/src/frontend/src/utils/go-api-search.ts new file mode 100644 index 0000000000..df1a2de36d --- /dev/null +++ b/src/frontend/src/utils/go-api-search.ts @@ -0,0 +1,212 @@ +import type { GoApiDocument, GoFunction, GoHandleType } from './go-modules'; +import type { GoApiSearchIndexEntry } from './go-api-search-stats'; +import { goModuleSlug } from './go-modules'; +import { toSearchGoDocText } from './go-doc-text'; +import { + getGoCallableIdentityKey, + getGoFunctionDisplayKind, +} from './go-api-function-kind'; +import { + getGoItemSlug, + getGoMemberAnchor, + getGoMethods, + getGoMethodSlug, + getGoStandaloneFunctions, + getGoTopLevelRouteItems, +} from './go-api-routes'; + +export type { GoApiSearchIndexEntry } from './go-api-search-stats'; + +export function buildGoApiSearchIndex(packages: GoApiDocument[], base = ''): GoApiSearchIndexEntry[] { + const normalizedBase = base.replace(/\/$/, ''); + const index: GoApiSearchIndexEntry[] = []; + + for (const pkg of packages) { + const pkgName = pkg.package.name; + const pkgSlug = goModuleSlug(pkgName); + const topLevelItems = getGoTopLevelRouteItems(pkg); + const version = pkg.package.version; + const withVersion = version ? { v: version } : {}; + const standaloneFunctions = getGoStandaloneFunctions(pkg); + const standaloneFunctionKeys = new Set( + standaloneFunctions.map((fn) => getGoCallableIdentityKey(fn)) + ); + + for (const fn of standaloneFunctions) { + const itemSlug = getGoItemSlug(fn, topLevelItems); + if (!itemSlug) { + continue; + } + + const signature = fn.signature ?? fn.qualifiedName ?? fn.name; + // Go has no free-standing builder functions: the receiver identifies which + // `WithHostPort` a result is, so it is part of the full name and parent label. + index.push({ + n: fn.name, + f: fn.receiver ? `${fn.receiver}.${signature}` : signature, + k: getGoFunctionDisplayKind(fn), + p: pkgName, + s: toSearchGoDocText(fn.description ?? ''), + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/`, + ...(fn.receiver ? { t: fn.receiver } : {}), + ...withVersion, + }); + } + + for (const handle of pkg.handleTypes ?? []) { + const itemSlug = getGoItemSlug(handle, topLevelItems); + if (!itemSlug) { + continue; + } + + const qualifiers = [handle.isInterface && 'interface', handle.isMarker && 'marker'].filter(Boolean); + index.push({ + n: handle.name, + f: handle.fullName ?? handle.name, + k: handle.isInterface ? 'interface' : 'handle', + p: pkgName, + s: toSearchGoDocText(handle.description ?? `Handle type${qualifiers.length > 0 ? ` (${qualifiers.join(', ')})` : ''}`), + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/`, + ...withVersion, + }); + + addHandleMemberEntries(index, handle, pkgName, pkgSlug, itemSlug, normalizedBase, withVersion, standaloneFunctionKeys); + } + + for (const dto of pkg.dtoTypes ?? []) { + const itemSlug = getGoItemSlug(dto, topLevelItems); + if (!itemSlug) { + continue; + } + + index.push({ + n: dto.name, + f: dto.fullName ?? dto.name, + k: 'struct', + p: pkgName, + s: toSearchGoDocText(dto.description ?? `Struct with ${dto.fields?.length ?? 0} fields`), + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/`, + ...withVersion, + }); + } + + for (const enumType of pkg.enumTypes ?? []) { + const itemSlug = getGoItemSlug(enumType, topLevelItems); + if (!itemSlug) { + continue; + } + + index.push({ + n: enumType.name, + f: enumType.fullName ?? enumType.name, + k: 'enum', + p: pkgName, + s: toSearchGoDocText(enumType.description ?? `Enum: ${(enumType.members ?? []).map((member) => member.name).join(', ')}`), + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/`, + ...withVersion, + }); + } + } + + return index; +} + +/** `SetFoo` writes the property read by the `Foo` getter. */ +function propertyNameOf(setterName: string): string { + return setterName.replace(/^Set/, '').toLowerCase(); +} + +function addHandleMemberEntries( + index: GoApiSearchIndexEntry[], + handle: GoHandleType, + pkgName: string, + pkgSlug: string, + itemSlug: string, + normalizedBase: string, + withVersion: { v?: string }, + standaloneFunctionKeys: Set +): void { + const capabilities = handle.capabilities ?? []; + const getters = capabilities.filter((capability) => capability.kind === 'PropertyGetter'); + const setters = capabilities.filter((capability) => capability.kind === 'PropertySetter'); + const methods = getGoMethods(handle); + + for (const getter of getters) { + const hasSetter = setters.some( + (setter) => propertyNameOf(setter.name) === getter.name.toLowerCase() + ); + + index.push({ + n: getter.name, + f: `${handle.name}.${getter.signature ?? getter.name}`, + k: 'property', + p: pkgName, + s: toSearchGoDocText(getter.description ?? `Property on ${handle.name}${hasSetter ? ' (get/set)' : ''}`), + t: handle.name, + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/#${getGoMemberAnchor(getter.name)}`, + m: true, + ...withVersion, + }); + } + + for (const setter of setters) { + const hasGetter = getters.some( + (getter) => getter.name.toLowerCase() === propertyNameOf(setter.name) + ); + + if (hasGetter) { + continue; + } + + index.push({ + n: setter.name, + f: `${handle.name}.${setter.signature ?? setter.name}`, + k: 'property', + p: pkgName, + s: toSearchGoDocText(setter.description ?? `Write-only property on ${handle.name}`), + t: handle.name, + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/#${getGoMemberAnchor(setter.name)}`, + m: true, + ...withVersion, + }); + } + + for (const method of methods) { + addHandleMethodEntry(index, method, methods, handle, pkgName, pkgSlug, itemSlug, normalizedBase, withVersion, standaloneFunctionKeys); + } +} + +function addHandleMethodEntry( + index: GoApiSearchIndexEntry[], + method: GoFunction, + methods: GoFunction[], + handle: GoHandleType, + pkgName: string, + pkgSlug: string, + itemSlug: string, + normalizedBase: string, + withVersion: { v?: string }, + standaloneFunctionKeys: Set +): void { + // The standalone function is the canonical, searchable entry for a capability. + if (standaloneFunctionKeys.has(getGoCallableIdentityKey(method))) { + return; + } + + const memberSlug = getGoMethodSlug(method, methods, handle.name); + if (!memberSlug) { + return; + } + + index.push({ + n: method.name, + f: `${handle.name}.${method.signature ?? method.qualifiedName ?? method.name}`, + k: 'method', + p: pkgName, + s: toSearchGoDocText(method.description ?? ''), + t: handle.name, + h: `${normalizedBase}/reference/api/go/${pkgSlug}/${itemSlug}/${memberSlug}/`, + m: true, + ...withVersion, + }); +} diff --git a/src/frontend/src/utils/go-api-sidebar.ts b/src/frontend/src/utils/go-api-sidebar.ts new file mode 100644 index 0000000000..f881a1ea8c --- /dev/null +++ b/src/frontend/src/utils/go-api-sidebar.ts @@ -0,0 +1,94 @@ +/* ------------------------------------------------------------------ */ +/* Build sidebar configuration for Go API reference pages. */ +/* ------------------------------------------------------------------ */ + +import { goModuleSlug, getGoModules } from './go-modules'; + +interface SidebarLinkItem { + label: string; + link: string; +} + +interface SidebarGroupItem { + label: string; + collapsed: boolean; + items: Array; +} + +type SidebarItem = SidebarLinkItem | SidebarGroupItem; + +let goApiSidebarPromise: Promise | undefined; +const shouldCacheGoApiSidebar = import.meta.env.PROD; + +interface SidebarPage { + name: string; + slug: string; +} + +type GoApiSidebarOptions = { + packageName: string; + headings: readonly { slug: string; text: string }[]; +} & ( + | { item?: never; member?: never } + | { item: SidebarPage; member?: SidebarPage } +); + +function buildModuleSidebarEntry(options: GoApiSidebarOptions): SidebarGroupItem { + const modulePath = `/reference/api/go/${goModuleSlug(options.packageName)}/`; + const items: SidebarItem[] = [{ label: 'Overview', link: modulePath }]; + let currentItems = items; + let currentPath = modulePath; + + for (const page of [options.item, options.member]) { + if (!page) continue; + currentPath += `${page.slug}/`; + const pageItems: SidebarItem[] = [{ label: 'Overview', link: currentPath }]; + currentItems.push({ + label: page.name, + collapsed: false, + items: pageItems, + }); + currentItems = pageItems; + } + + // The catalog lives on the module overview; other pages link to it rather + // than embedding its full tree again. Section links reuse the page's headings. + currentItems.push(...options.headings.map(({ slug, text }) => ({ + label: text, + link: `${currentPath}#${slug}`, + }))); + + return { + label: options.packageName, + collapsed: false, + items, + }; +} + +async function buildGoApiReferenceSidebar(options?: GoApiSidebarOptions) { + const sidebarRoot = { label: 'Search Go APIs', link: '/reference/api/go/' }; + + if (options) { + return [sidebarRoot, buildModuleSidebarEntry(options)]; + } + + const modules = await getGoModules(); + const sorted = modules + .map((p) => p.data) + .sort((a, b) => a.package.name.localeCompare(b.package.name)); + + return [sidebarRoot, ...sorted.map((mod) => ({ + label: mod.package.name, + link: `/reference/api/go/${goModuleSlug(mod.package.name)}/`, + }))]; +} + +export function getGoApiReferenceSidebar(options?: GoApiSidebarOptions) { + // Only the shared module index needs caching, not thousands of tiny page trees. + if (options || !shouldCacheGoApiSidebar) { + return buildGoApiReferenceSidebar(options); + } + + goApiSidebarPromise ??= buildGoApiReferenceSidebar(); + return goApiSidebarPromise; +} diff --git a/src/frontend/src/utils/go-doc-refs.ts b/src/frontend/src/utils/go-doc-refs.ts new file mode 100644 index 0000000000..2f88056b86 --- /dev/null +++ b/src/frontend/src/utils/go-doc-refs.ts @@ -0,0 +1,63 @@ +import { getGoItemSlug, getGoStandaloneFunctions, getGoTopLevelRouteItems } from './go-api-routes'; +import type { GoApiDocumentRouteLike, GoTopLevelRouteItemLike } from './go-api-routes'; +import type { GoDocRefKind } from './go-doc-text'; + +export interface GoDocRefTarget { + /** The Go spelling to show, e.g. `Resource` for the C# `IResource`. */ + label: string; + /** Page of the item inside its module, with a trailing slash. */ + path: string; +} + +/** `Aspire.Hosting.ApplicationModel.IResource` and `IResourceBuilder`1` both reduce to the simple C# name. */ +function getClrSimpleName(fullName: string): string { + return (fullName.split(/[.+]/).pop() ?? fullName).replace(/`\d+$/, ''); +} + +/** + * Resolve an `{@ats-ref}` marker to a page of the same module. Types of other modules + * have no page here, like every other Go type reference, so they stay plain code. + */ +export function resolveGoDocRef( + doc: GoApiDocumentRouteLike, + refKind: GoDocRefKind, + target: string +): GoDocRefTarget | undefined { + const items = getGoTopLevelRouteItems(doc); + + if (refKind === 'type') { + const clrName = target.replace(/`\d+$/, ''); + const type = [ + ...(doc.handleTypes ?? []), + ...(doc.dtoTypes ?? []), + ...(doc.enumTypes ?? []), + ].find((candidate) => getClrSimpleName(candidate.fullName ?? candidate.name) === clrName); + return type && toRefTarget(type, items); + } + + if (refKind === 'method') { + // Extension methods are exported as package functions, so `KubernetesEnvironmentExtensions.withNodePool` + // is the `WithNodePool` function. Instance members of other classes have no page of their own. + const dot = target.lastIndexOf('.'); + const owner = getClrSimpleName(target.slice(0, Math.max(dot, 0))); + if (!owner.endsWith('Extensions')) { + return undefined; + } + + const memberName = target.slice(dot + 1).toLowerCase(); + const matches = getGoStandaloneFunctions(doc).filter( + (candidate) => candidate.name.toLowerCase() === memberName + ); + // Overloads on several receivers share a name; linking one of them would be a guess. + return matches.length === 1 ? toRefTarget(matches[0], items) : undefined; + } + + return undefined; +} + +function toRefTarget( + item: GoTopLevelRouteItemLike, + items: GoTopLevelRouteItemLike[] +): GoDocRefTarget { + return { label: item.name, path: `${getGoItemSlug(item, items)}/` }; +} diff --git a/src/frontend/src/utils/go-doc-text.ts b/src/frontend/src/utils/go-doc-text.ts new file mode 100644 index 0000000000..b99f3dfecd --- /dev/null +++ b/src/frontend/src/utils/go-doc-text.ts @@ -0,0 +1,168 @@ +/** + * Inline markup in Go API descriptions. + * + * Descriptions are single-line strings generated from XML documentation. Besides + * plain text they carry: + * + * `error` inline code + * `IResourceBuilder`1` CLR type arity: one code span, shown without the arity + * `WithModTidy``1` CLR method arity: one code span, shown without the arity + * ``` var x = 1; ``` a code sample flattened onto one line + * {@ats-ref type:Resource} a reference to another API item + * {@ats-ref method:Owner.member} a reference to a method + * [RFC 7239](https://example.com) an external link + * + * Anything else, including a lone backtick, stays plain text. This module has no + * imports so the client-side search scripts can bundle it. + */ + +export type GoDocRefKind = 'type' | 'method' | 'field'; + +export type GoDocSegment = + | { kind: 'text'; text: string } + | { kind: 'code'; text: string } + | { kind: 'ref'; refKind: GoDocRefKind; target: string; label: string } + | { kind: 'link'; text: string; href: string }; + +const FENCE = /```([^`]+)```/; +// The CLR arity suffix is part of the name and contains backticks: one for a type +// (`Name`1`) and two for a method (`Name``1`). A run of one or two backticks followed +// by digits and another backtick therefore does not end the span. +const INLINE_CODE = /`((?:[^`\n]|`{1,2}\d+(?=`))+)`/; +const REF = /\{@ats-ref\s+(type|method|field):([^\s|}]+)(?:\|([^}]*))?\}/; +// Only http(s) targets become links, so a description cannot smuggle in a javascript: URL. +const LINK = /\[([^\]\n]+)\]\((https?:\/\/[^)\s]+)\)/; + +// Alternatives are ordered so a fence is not read as three empty code spans. +// Capture groups: 1 fence, 2 inline code, 3-5 ref (kind, target, label), 6-7 link (text, href). +const TOKEN_PATTERN = new RegExp( + [FENCE, INLINE_CODE, REF, LINK].map((pattern) => pattern.source).join('|'), + 'g' +); +const REF_PATTERN = new RegExp(REF.source, 'g'); +const ARITY_CODE_PATTERN = /`([^`\s]+)`{1,2}\d+`/g; + +const HTML_ESCAPES: Record = { + '&': '&', + '<': '<', + '>': '>', + '"': '"', + "'": ''', +}; + +function escapeHtml(text: string): string { + return text.replace(/[&<>"']/g, (character) => HTML_ESCAPES[character] ?? character); +} + +function stripClrArity(name: string): string { + return name.replace(/`{1,2}\d+$/, ''); +} + +export function parseGoDocText(text: string): GoDocSegment[] { + const segments: GoDocSegment[] = []; + let cursor = 0; + + for (const match of text.matchAll(TOKEN_PATTERN)) { + const [token, fenced, inline, refKind, refTarget, refLabel, linkText, linkHref] = match; + const start = match.index ?? 0; + if (start > cursor) { + segments.push({ kind: 'text', text: text.slice(cursor, start) }); + } + + if (fenced !== undefined) { + segments.push({ kind: 'code', text: fenced.trim() }); + } else if (inline !== undefined) { + segments.push({ kind: 'code', text: stripClrArity(inline) }); + } else if (refKind !== undefined) { + segments.push({ + kind: 'ref', + refKind: refKind as GoDocRefKind, + target: refTarget, + label: refLabel?.trim() || refTarget, + }); + } else { + segments.push({ kind: 'link', text: linkText, href: linkHref }); + } + cursor = start + token.length; + } + + if (cursor < text.length) { + segments.push({ kind: 'text', text: text.slice(cursor) }); + } + return segments; +} + +function formatGoDocText( + text: string, + formatLink: (label: string, href: string) => string +): string { + return parseGoDocText(text) + .map((segment) => { + switch (segment.kind) { + case 'text': + return segment.text; + case 'code': + return `\`${segment.text}\``; + case 'ref': + return `\`${segment.label}\``; + case 'link': + return formatLink(segment.text, segment.href); + } + }) + .join(''); +} + +/** + * Search entries keep a description as text with `code` spans, so one string serves + * matching and display. A result row is itself a link, so external links keep only their label. + */ +export function toSearchGoDocText(text: string): string { + return formatGoDocText(text, (label) => label); +} + +/** Cut a search summary without leaving half of a `code` span behind. */ +export function truncateGoDocText(text: string, max: number): string { + if (text.length <= max) { + return text; + } + + let cut = text.slice(0, max); + if ((cut.match(/`/g) ?? []).length % 2 === 1) { + cut = cut.slice(0, cut.lastIndexOf('`')); + } + return cut.trimEnd(); +} + +/** + * Render search-entry text for the result rows, which are built as HTML strings. + * Every value is escaped and no anchors are emitted: the row is already an anchor. + */ +export function renderGoDocTextHtml(text: string): string { + return parseGoDocText(text) + .map((segment) => { + switch (segment.kind) { + case 'text': + return escapeHtml(segment.text); + case 'code': + return `${escapeHtml(segment.text)}`; + case 'ref': + return `${escapeHtml(segment.label)}`; + case 'link': + return escapeHtml(segment.text); + } + }) + .join(''); +} + +/** + * Markdown output keeps its own code spans, fenced blocks and links, so only the two + * Go-specific markers are rewritten: references become code and CLR arity is dropped. + */ +export function normalizeGoDocMarkdown(text: string): string { + return text + .replace( + REF_PATTERN, + (_match, _kind: string, target: string, label?: string) => `\`${label?.trim() || target}\`` + ) + .replace(ARITY_CODE_PATTERN, '`$1`'); +} diff --git a/src/frontend/src/utils/go-modules.ts b/src/frontend/src/utils/go-modules.ts new file mode 100644 index 0000000000..b4327d7d8f --- /dev/null +++ b/src/frontend/src/utils/go-modules.ts @@ -0,0 +1,590 @@ +/* ------------------------------------------------------------------ */ +/* Shared helpers for the auto-generated Go API reference. */ +/* ------------------------------------------------------------------ */ + +import type { CollectionEntry } from 'astro:content'; +import { getCollection } from 'astro:content'; +import { + getGoItemSlug, + getGoTopLevelRouteItems, + getGoTypeByName, + goSlugify, + prepareGoApiRoutes, +} from '@utils/go-api-routes'; + +export { goSlugify }; + +/** + * Shown where a marker interface lists functions. A marker declares no methods of its own in Go: + * each function is declared on the concrete types it applies to, so these entries are + * applicability metadata rather than members of the marker. + */ +export const GO_MARKER_NOTE: string = + 'A marker interface declares no methods of its own in Go. Its functions are declared on the concrete types they apply to.'; + +/** Group name for functions that have no receiver, such as `CreateBuilder`. */ +export const GO_PACKAGE_FUNCTIONS_GROUP = 'Package functions'; + +export interface GoFunctionParameter { + name: string; + type?: string; + isCallback?: boolean; + callbackSignature?: string; + description?: string; +} + +export interface GoOptionField { + name: string; + jsonName?: string; + type?: string; + isCallback?: boolean; + callbackSignature?: string; + description?: string; +} + +/** Optional parameters collapse into a trailing `opts ...*XxxOptions` struct. */ +export interface GoCallableOptions { + typeName: string; + /** True when the options type is an existing DTO rather than a generated struct. */ + isDirect?: boolean; + fields?: GoOptionField[]; +} + +export interface GoFunction { + name: string; + kind?: string; + qualifiedName?: string; + capabilityId?: string; + targetTypeId?: string; + expandedTargetTypes?: string[]; + appliesTo?: string[]; + /** The Go type carrying the method. Only package-level functions such as `CreateBuilder` have none. */ + receiver?: string | null; + signature?: string; + description?: string; + remarks?: string; + parameters?: GoFunctionParameter[]; + options?: GoCallableOptions | null; + returnType?: string; + returns?: string; + /** `returned` = `(T, error)`; `deferred` = handle result, check `Err()` later; `none`. */ + errorModel?: string; + returnsReceiver?: boolean; + returnsBuilder?: boolean; +} + +export interface GoNamedItem { + name: string; + fullName?: string; + kind?: string; + description?: string; + remarks?: string; +} + +export interface GoSynthesizedMember { + name: string; + signature?: string; + description?: string; +} + +export interface GoHandleType extends GoNamedItem { + kind?: 'handle'; + isInterface?: boolean; + isMarker?: boolean; + implementedInterfaces?: string[]; + capabilities?: GoFunction[]; + synthesizedMembers?: GoSynthesizedMember[]; +} + +export interface GoField { + name: string; + jsonName?: string; + type?: string; + isOptional?: boolean; + isCallback?: boolean; + description?: string; +} + +export interface GoDtoType extends GoNamedItem { + kind?: 'dto'; + fields?: GoField[]; +} + +export interface GoEnumMember { + name: string; + value: string; + description?: string; + remarks?: string; +} + +export interface GoEnumType extends GoNamedItem { + kind?: 'enum'; + members?: GoEnumMember[]; +} + +export interface GoExportedValueEntry { + path: string; + type?: string; + /** A Go literal such as `"\"build\""`. */ + value?: string; + description?: string; +} + +/** Exposed by the SDK as `WellKnownPipelineSteps.Build`; they have no pages of their own. */ +export interface GoExportedValue extends GoNamedItem { + kind?: 'exportedValue'; + values?: GoExportedValueEntry[]; +} + +export interface GoModulePackage { + name: string; + version?: string; + language?: string; + importPath?: string; + sourceRepository?: string; + sourceCommit?: string; +} + +export interface GoApiDocument { + package: GoModulePackage; + functions?: GoFunction[]; + handleTypes?: GoHandleType[]; + dtoTypes?: GoDtoType[]; + enumTypes?: GoEnumType[]; + exportedValues?: GoExportedValue[]; +} + +export type GoModuleCollectionEntry = Omit, 'data'> & { + data: GoApiDocument; +}; + +let goModulesPromise: Promise | undefined; +const shouldCacheGoModules = import.meta.env.PROD; + +/** + * Fetch all Go module entries from the content collection. + * Memoized so Astro's many API routes reuse a single collection load. + */ +export function getGoModules(): Promise { + if (!shouldCacheGoModules) { + return getCollection('goModules'); + } + + goModulesPromise ??= getCollection('goModules').then((entries) => { + for (const entry of entries) prepareGoApiRoutes(entry.data); + return entries; + }); + return goModulesPromise; +} + +/** Normalize a module name for use in a URL path segment. */ +export function goModuleSlug(name: string): string { + return name.toLowerCase(); +} + +/* ---- Capability kind helpers ---------------------------------------- */ + +/** Ordered list of capability kinds for consistent display. */ +export const goCapabilityKindOrder = [ + 'Method', + 'InstanceMethod', + 'PropertyGetter', + 'PropertySetter', +] as const; + +export const goCapabilityKindLabels: Record = { + Method: 'Methods', + InstanceMethod: 'Instance Methods', + PropertyGetter: 'Property Getters', + PropertySetter: 'Property Setters', +}; + +/* ---- Type kind helpers ---------------------------------------------- */ + +export const goTypeKindOrder = ['handle', 'dto', 'enum'] as const; + +export const goTypeKindLabels: Record = { + handle: 'Handles', + dto: 'DTOs', + enum: 'Enums', +}; + +/* ---- Grouping helpers ----------------------------------------------- */ + +/** + * Group standalone functions by the Go type that carries them. Functions without a + * receiver (`CreateBuilder`) form a `Package functions` group, listed first. + */ +export function groupGoFunctionsByReceiver(functions: GoFunction[]): Map { + const byReceiver = new Map(); + for (const func of functions) { + const receiver = func.receiver || GO_PACKAGE_FUNCTIONS_GROUP; + const existing = byReceiver.get(receiver) ?? []; + existing.push(func); + byReceiver.set(receiver, existing); + } + + const names = [...byReceiver.keys()].sort((left, right) => { + if (left === GO_PACKAGE_FUNCTIONS_GROUP) return right === GO_PACKAGE_FUNCTIONS_GROUP ? 0 : -1; + if (right === GO_PACKAGE_FUNCTIONS_GROUP) return 1; + return left.localeCompare(right); + }); + + const groups = new Map(); + for (const name of names) { + const funcs = byReceiver.get(name) ?? []; + funcs.sort((a, b) => a.name.localeCompare(b.name)); + groups.set(name, funcs); + } + + return groups; +} + +/** + * Types an interface or marker handle applies to: the union of its capabilities' + * `appliesTo`, sorted. Handles without capabilities have an empty list. + */ +export function getGoHandleAppliesTo(handle: GoHandleType): string[] { + const names = new Set(); + for (const capability of handle.capabilities ?? []) { + for (const name of capability.appliesTo ?? []) names.add(name); + } + return [...names].sort((left, right) => left.localeCompare(right)); +} + +/** + * Number of members a handle page lists: a getter and its `SetX` setter are one property, + * and the hand-written SDK helpers count as methods. + */ +export function countGoHandleMembers(handle: GoHandleType): number { + const capabilities = handle.capabilities ?? []; + const getterNames = new Set(); + let getters = 0; + let methods = 0; + for (const capability of capabilities) { + if (capability.kind === 'PropertyGetter') { + getters++; + getterNames.add(capability.name.toLowerCase()); + } else if (capability.kind === 'Method' || capability.kind === 'InstanceMethod') { + methods++; + } + } + const setterOnly = capabilities.filter( + (capability) => + capability.kind === 'PropertySetter' && !getterNames.has(capability.name.replace(/^Set/, '').toLowerCase()) + ).length; + return getters + setterOnly + methods + (handle.synthesizedMembers?.length ?? 0); +} + +/** + * Distinct `package.importPath` values across modules, sorted. Every module currently + * shares one flat import path, but the index copy must not assume that. + */ +export function getGoImportPaths(modules: GoApiDocument[]): string[] { + const paths = new Set(); + for (const doc of modules) { + if (doc.package.importPath) paths.add(doc.package.importPath); + } + return [...paths].sort((left, right) => left.localeCompare(right)); +} + +/** + * Name of the trailing variadic options parameter, read from the signature because it + * differs per callable: `opts ...*WithDataVolumeOptions` vs `options ...*CreateBuilderOptions`. + */ +export function getGoOptionsParameterName(callable: Pick): string { + const typeName = callable.options?.typeName; + if (typeName && callable.signature) { + const match = new RegExp(`([A-Za-z_][A-Za-z0-9_]*)\\s+\\.\\.\\.\\*?${typeName}\\b`).exec(callable.signature); + if (match) return match[1]; + } + return 'opts'; +} + +/** + * Value type of a property accessor. A getter returns `(T, error)` or, for deferred + * results, a bare `T`; a setter takes the value as its first parameter. + */ +export function getGoPropertyValueType( + accessor: Pick +): string | undefined { + if (accessor.kind === 'PropertySetter') { + return accessor.parameters?.[0]?.type; + } + + const returnType = accessor.returnType?.trim(); + if (!returnType) { + return undefined; + } + + // `(*float64, error)` -> `*float64`; only the trailing `, error)` is removed so + // generic arguments such as `*Dictionary[string, string]` stay intact. + const tuple = /^\((.+),\s*error\)$/.exec(returnType); + return tuple ? tuple[1].trim() : returnType; +} + +/* ---- Link helpers --------------------------------------------------- */ + +/** + * Build an absolute href for a Go API module page. + */ +export function goModuleHref(base: string, moduleName: string): string { + const b = base.replace(/\/$/, ''); + return `${b}/reference/api/go/${goModuleSlug(moduleName)}/`; +} + +/** + * Build an absolute href for a Go API type/function page. + */ +export function goItemHref(base: string, moduleName: string, itemName: string): string { + const b = base.replace(/\/$/, ''); + return `${b}/reference/api/go/${goModuleSlug(moduleName)}/${goSlugify(itemName)}/`; +} + +/** + * Resolve the page of a type declared in the same module, honouring slug + * disambiguation. Types declared in other modules have no page here. + */ +export function getGoTypeHref(base: string, doc: GoApiDocument, typeName: string): string | undefined { + const type = getGoTypeByName(doc, typeName); + if (!type) return undefined; + const slug = getGoItemSlug(type, getGoTopLevelRouteItems(doc)); + const b = base.replace(/\/$/, ''); + return `${b}/reference/api/go/${goModuleSlug(doc.package.name)}/${slug}/`; +} + +/** + * Split a Go type reference such as `*RedisResource` or `[]DistributedApplicationBuilder` + * into its pointer/slice prefix and the type name. Returns undefined for anything + * more complex (`map[string]string`, `*List[string]`, `func(...)`, tuples). + */ +export function parseGoTypeReference(typeText: string | undefined): { prefix: string; name: string } | undefined { + const match = /^((?:\*|\[\])*)([A-Za-z_][A-Za-z0-9_]*)$/.exec((typeText ?? '').trim()); + return match ? { prefix: match[1], name: match[2] } : undefined; +} + +/* ---- Text helpers --------------------------------------------------- */ + +/** + * Close an unterminated ``` fence. Descriptions and remarks come from XML docs and + * can contain an odd number of fences; left alone, the dangling fence would swallow + * every section that follows it in the generated page. + */ +export function closeUnclosedCodeFences(text: string): string { + let openFence: string | undefined; + for (const line of text.split(/\r?\n/)) { + if (openFence) { + const close = /^ {0,3}(`{3,})[ \t]*$/.exec(line); + if (close && close[1].length >= openFence.length) openFence = undefined; + continue; + } + + const open = /^ {0,3}(`{3,})[^`]*$/.exec(line); + if (open) openFence = open[1]; + } + + return openFence ? `${text.replace(/\s+$/, '')}\n${openFence}` : text; +} + +/* ---- Error model ---------------------------------------------------- */ + +/** + * Plain-words description of how a callable reports failure. + * + * `errorModel` values: + * deferred - returns a handle; failures surface later via `Err()` + * returned - returns `(T, error)` (or just `error`) + * none - no error is reported + */ +export function describeGoErrorModel(callable: Pick): string { + const returnType = callable.returnType?.trim() ?? ''; + + if (returnType === 'error') { + return 'Returns `error`.'; + } + + switch (callable.errorModel) { + case 'deferred': + return 'Returns a handle; failures surface later via `Err()`.'; + case 'returned': { + const tuple = returnType.startsWith('(') ? returnType : `(${returnType || 'T'}, error)`; + return `Returns \`${tuple}\`.`; + } + default: + return returnType + ? `Returns \`${returnType}\`; no error is reported.` + : 'No error is reported.'; + } +} + +/* ---- Signature formatting ------------------------------------------- */ + +const OPENING_BRACKETS = '([{'; +const CLOSING_BRACKETS = ')]}'; + +/** + * Format a Go signature (no `func` keyword) for display. + * With 2+ parameters each one goes on its own line with a trailing comma and a + * 4-space indent, matching the C# and TypeScript reference formatting: + * + * WithDataBindMount(source string, opts ...*Options) RedisInsightResource + * WithDataBindMount( + * source string, + * opts ...*Options, + * ) RedisInsightResource + */ +export function formatGoSignature(sig: string): string { + if (!sig) return sig; + + // The parameter list opens at the first `(` outside type parameters (`Name[T any](...)`). + let openIdx = -1; + let bracketDepth = 0; + for (let i = 0; i < sig.length; i++) { + const ch = sig[i]; + if (ch === '[') bracketDepth++; + else if (ch === ']') bracketDepth--; + else if (ch === '(' && bracketDepth === 0) { + openIdx = i; + break; + } + } + if (openIdx < 0) return sig; + + // Find the matching close paren (respecting nested callback types) + let depth = 0; + let closeIdx = -1; + for (let i = openIdx; i < sig.length; i++) { + const ch = sig[i]; + if (OPENING_BRACKETS.includes(ch)) depth++; + else if (CLOSING_BRACKETS.includes(ch)) depth--; + if (depth === 0) { + closeIdx = i; + break; + } + } + if (closeIdx <= openIdx) return sig; + + const prefix = sig.slice(0, openIdx + 1); + const suffix = sig.slice(closeIdx); + const paramStr = sig.slice(openIdx + 1, closeIdx); + + // Split params respecting nested parens/brackets (callback types, maps, generics) + const params: string[] = []; + let current = ''; + depth = 0; + for (const ch of paramStr) { + if (OPENING_BRACKETS.includes(ch)) depth++; + else if (CLOSING_BRACKETS.includes(ch)) depth--; + if (ch === ',' && depth === 0) { + params.push(current.trim()); + current = ''; + } else { + current += ch; + } + } + if (current.trim()) params.push(current.trim()); + + // Single param or empty - keep inline + if (params.length <= 1) return sig; + + // Multi-param - wrap each on its own line (gofmt requires the trailing comma) + const indent = ' '; + return `${prefix}\n${params.map((p) => `${indent}${p},`).join('\n')}\n${suffix}`; +} + +/* ---- Definition snippets -------------------------------------------- */ + +const DEFINITION_INDENT = ' '; + +function padRight(value: string, width: number): string { + return value + ' '.repeat(Math.max(0, width - value.length)); +} + +/** `type Name interface { }`; members are listed on the page, not in the fence. */ +export function buildGoHandleDefinition(handle: Pick): string { + const embedded = handle.implementedInterfaces ?? []; + if (embedded.length === 0) { + return `type ${handle.name} interface{}`; + } + + return [ + `type ${handle.name} interface {`, + ...embedded.map((name) => `${DEFINITION_INDENT}${name}`), + '}', + ].join('\n'); +} + +/** A struct with `json:"jsonName"` tags, aligned the way gofmt would. */ +export function buildGoDtoDefinition(dto: Pick): string { + const fields = dto.fields ?? []; + if (fields.length === 0) { + return `type ${dto.name} struct{}`; + } + + const nameWidth = Math.max(...fields.map((field) => field.name.length)); + const typeWidth = Math.max(...fields.map((field) => (field.type ?? 'any').length)); + return [ + `type ${dto.name} struct {`, + ...fields.map( + (field) => + `${DEFINITION_INDENT}${padRight(field.name, nameWidth)} ${padRight(field.type ?? 'any', typeWidth)} \`json:"${field.jsonName ?? field.name}"\`` + ), + '}', + ].join('\n'); +} + +/** `type X string` plus a `const ( ... )` block whose names are already the Go constant names. */ +export function buildGoEnumDefinition(enumType: Pick): string { + const members = enumType.members ?? []; + const declaration = `type ${enumType.name} string`; + if (members.length === 0) { + return declaration; + } + + const nameWidth = Math.max(...members.map((member) => member.name.length)); + return [ + declaration, + '', + 'const (', + ...members.map( + (member) => + `${DEFINITION_INDENT}${padRight(member.name, nameWidth)} ${enumType.name} = ${JSON.stringify(member.value)}` + ), + ')', + ].join('\n'); +} + +/** `func () `, or `func ` for receiver-less package functions. */ +export function buildGoFunctionDefinition(fn: Pick): string { + const signature = formatGoSignature(fn.signature ?? `${fn.name}()`); + return fn.receiver ? `func (${fn.receiver}) ${signature}` : `func ${signature}`; +} + +/** The method as it appears inside its handle interface, with the other members elided. */ +export function buildGoMemberDefinition( + parentName: string, + method: Pick +): string { + const signature = formatGoSignature(method.signature ?? `${method.name}()`) + .split('\n') + .map((line) => `${DEFINITION_INDENT}${line}`) + .join('\n'); + return [ + `type ${parentName} interface {`, + `${DEFINITION_INDENT}// ... omitted for brevity`, + signature, + '}', + ].join('\n'); +} + +/** + * Definition shown on a handle's method page. Marker interfaces declare no methods in Go + * (their definition is `type X interface{}`), so their functions use the same receiver + * notation as standalone functions instead of appearing inside the marker interface. + */ +export function buildGoHandleMemberDefinition( + handle: Pick, + method: Pick +): string { + return handle.isMarker ? buildGoFunctionDefinition(method) : buildGoMemberDefinition(handle.name, method); +} diff --git a/src/frontend/tests/e2e/api-cross-language-navigation.spec.ts b/src/frontend/tests/e2e/api-cross-language-navigation.spec.ts index 894c632f18..cdbc182455 100644 --- a/src/frontend/tests/e2e/api-cross-language-navigation.spec.ts +++ b/src/frontend/tests/e2e/api-cross-language-navigation.spec.ts @@ -14,7 +14,7 @@ test.beforeEach(async ({ page, isMobile }) => { } }); -type Language = 'csharp' | 'typescript'; +type Language = 'csharp' | 'typescript' | 'go'; const packagePath = (language: Language) => `/reference/api/${language}/aspire.hosting.redis/`; const typePath = (language: Language) => `${packagePath(language)}redisresource/`; const rootSelector = '[data-api-search-language][data-api-search-kind]'; @@ -80,7 +80,7 @@ async function expectLanguageResults(page: Page, prefix: string, language: Langu return results; } -for (const firstLanguage of ['csharp', 'typescript'] as const) { +for (const firstLanguage of ['csharp', 'typescript', 'go'] as const) { test(`API package, type and member links survive ${firstLanguage}-first cross-language navigation`, async ({ page }) => { test.setTimeout(120_000); const errors = trackPageErrors(page); @@ -115,7 +115,7 @@ for (const firstLanguage of ['csharp', 'typescript'] as const) { await clickClientLink(page, detailLink); await expect(page.locator(rootSelector)).toHaveCount(0); await navigateClient(page, packagePath(language)); - const query = language === 'csharp' ? 'WithHostPort' : 'withModule'; + const query = language === 'csharp' ? 'WithHostPort' : language === 'go' ? 'WithModule' : 'withModule'; await page.locator('#pkg-search-input').fill(query); const members = await expectLanguageResults(page, 'pkg', language); await expect(members.first()).toHaveAttribute('href', language === 'csharp' @@ -138,16 +138,18 @@ test('API landing searches and query filters survive language changes and histor await dismissCookieConsentIfVisible(page); await markClientSession(page); - for (const language of ['csharp', 'typescript', 'csharp'] as const) { + for (const language of ['csharp', 'typescript', 'go', 'csharp'] as const) { const landing = `/reference/api/${language}/${query}`; if (new URL(page.url()).pathname !== `/reference/api/${language}/`) { await navigateClient(page, landing); } - const prefix = language === 'csharp' ? 'api' : 'ts-api'; + const prefix = language === 'csharp' ? 'api' : language === 'go' ? 'go-api' : 'ts-api'; await expect(page.locator(`#${prefix}-search-input`)).toHaveValue('RedisResource'); const results = await expectLanguageResults(page, prefix, language); await clickClientLink(page, results.first()); - await expect(page.locator('#type-search-input')).toBeVisible(); + // Go lists referenced-only handles (no capabilities) in their own modules, so the first same-name hit + // can be a member-less page that has no in-page search. + await expect(language === 'go' ? page.locator('main h1') : page.locator('#type-search-input')).toBeVisible(); await page.goBack(); await expect(page.locator(`#${prefix}-search-input`)).toHaveValue('RedisResource'); await expect(page.locator('html[data-astro-transition]')).toHaveCount(0); @@ -171,7 +173,7 @@ test('API landing searches and query filters survive language changes and histor expect(errors).toEqual([]); }); -test('all six API search surfaces cancel pending input when leaving, including non-API destinations', async ({ page }) => { +test('all nine API search surfaces cancel pending input when leaving, including non-API destinations', async ({ page }) => { test.setTimeout(120_000); const errors = trackPageErrors(page); const surfaces = [ @@ -181,6 +183,9 @@ test('all six API search surfaces cancel pending input when leaving, including n { path: typePath('typescript'), prefix: 'type' }, { path: packagePath('typescript'), prefix: 'pkg' }, { path: '/reference/api/typescript/', prefix: 'ts-api' }, + { path: '/reference/api/go/', prefix: 'go-api' }, + { path: packagePath('go'), prefix: 'pkg' }, + { path: typePath('go'), prefix: 'type' }, ]; await page.goto(surfaces[0].path); await dismissCookieConsentIfVisible(page); diff --git a/src/frontend/tests/e2e/api-markdown-routes.spec.ts b/src/frontend/tests/e2e/api-markdown-routes.spec.ts index ffdbcae740..94c526f113 100644 --- a/src/frontend/tests/e2e/api-markdown-routes.spec.ts +++ b/src/frontend/tests/e2e/api-markdown-routes.spec.ts @@ -57,6 +57,51 @@ const markdownRoutes = [ name: 'TypeScript member route', path: '/reference/api/typescript/aspire.hosting/idistributedapplicationbuilder/addconnectionstring.md', }, + { + expectedText: '# Go API Reference', + name: 'Go API index', + path: '/reference/api/go.md', + }, + { + expectedText: '# Aspire.Hosting', + name: 'Go module route', + path: '/reference/api/go/aspire.hosting.md', + }, + { + expectedText: '# DistributedApplicationBuilder', + name: 'Go handle route', + path: '/reference/api/go/aspire.hosting/distributedapplicationbuilder.md', + }, + { + expectedText: '# CommandOptions', + name: 'Go DTO route', + path: '/reference/api/go/aspire.hosting/commandoptions.md', + }, + { + expectedText: '# CertificateTrustScope', + name: 'Go enum route', + path: '/reference/api/go/aspire.hosting/certificatetrustscope.md', + }, + { + expectedText: '# AddConnectionString', + name: 'Go function route', + path: '/reference/api/go/aspire.hosting/addconnectionstring.md', + }, + { + expectedText: '# DistributedApplicationBuilder.AddConnectionString', + name: 'Go member route', + path: '/reference/api/go/aspire.hosting/distributedapplicationbuilder/addconnectionstring.md', + }, + { + expectedText: 'A marker interface declares no methods of its own in Go.', + name: 'Go marker route', + path: '/reference/api/go/aspire.hosting/resource.md', + }, + { + expectedText: 'func (Resource) ExcludeFromManifest() Resource', + name: 'Go marker member route', + path: '/reference/api/go/aspire.hosting/resource/excludefrommanifest.md', + }, { // Samples reuse the same shared `markdownResponse` helper as the API // routes and have the same trailing-slash redirect treatment from diff --git a/src/frontend/tests/e2e/api-search-contract.spec.ts b/src/frontend/tests/e2e/api-search-contract.spec.ts index 43c00d7ae2..4ffe4c7680 100644 --- a/src/frontend/tests/e2e/api-search-contract.spec.ts +++ b/src/frontend/tests/e2e/api-search-contract.spec.ts @@ -11,6 +11,9 @@ const surfaces = [ { path: 'typescript/', prefix: 'ts-api' }, { path: 'typescript/aspire.hosting/', prefix: 'pkg' }, { path: 'typescript/aspire.hosting/idistributedapplicationbuilder/', prefix: 'type' }, + { path: 'go/', prefix: 'go-api' }, + { path: 'go/aspire.hosting/', prefix: 'pkg' }, + { path: 'go/aspire.hosting/distributedapplicationbuilder/', prefix: 'type' }, ]; async function navigateAwayAndBack(page: Page) { @@ -192,7 +195,7 @@ for (const { path, prefix } of surfaces) { }); } -for (const { path, prefix } of [surfaces[0], surfaces[3]]) { +for (const { path, prefix } of [surfaces[0], surfaces[3], surfaces[6]]) { test(`API version-only empty recovery persists defaults: ${path}`, async ({ page }) => { await page.goto(`/reference/api/${path}?versions=&keep=1`); await dismissCookieConsentIfVisible(page); diff --git a/src/frontend/tests/e2e/dev-layout.spec.ts b/src/frontend/tests/e2e/dev-layout.spec.ts index fcb61b65fe..90b99e8018 100644 --- a/src/frontend/tests/e2e/dev-layout.spec.ts +++ b/src/frontend/tests/e2e/dev-layout.spec.ts @@ -1106,7 +1106,7 @@ test('Developer Hub remains browsable without JavaScript and reflows at narrow w const context = await browser.newContext({ javaScriptEnabled: false, baseURL }); const staticPage = await context.newPage(); await staticPage.goto('/hub/'); - await expect(staticPage.locator('.onboarding-options > li, .language-links > li, .cloud-links > li, .featured-samples > li, .reference-links > li, #dashboard, .video-links > li, .blog-links > li')).toHaveCount(30); + await expect(staticPage.locator('.onboarding-options > li, .language-links > li, .cloud-links > li, .featured-samples > li, .reference-links > li, #dashboard, .video-links > li, .blog-links > li')).toHaveCount(31); await expect(staticPage.getByRole('button', { name: 'Search Aspire documentation' })).toBeDisabled(); await context.close(); for (const width of [320, 390, 640, 1024, 1440]) { diff --git a/src/frontend/tests/e2e/filter-navigation.spec.ts b/src/frontend/tests/e2e/filter-navigation.spec.ts index fceda7c048..f5a9f3213c 100644 --- a/src/frontend/tests/e2e/filter-navigation.spec.ts +++ b/src/frontend/tests/e2e/filter-navigation.spec.ts @@ -61,10 +61,10 @@ async function back(page: Page) { await expectClientNavigation(page); } -test('version dropdowns rebind across API languages and repeated visits', async ({ page }) => { +async function expectVersionFiltersRebind(page: Page, paths: readonly string[]) { await start(page, '/reference/api/csharp/'); - for (const path of ['/reference/api/csharp/', '/reference/api/typescript/', '/reference/api/csharp/']) { + for (const path of paths) { if (new URL(page.url()).pathname !== path) await navigate(page, path); const button = page.locator('.version-filter-btn'); const all = page.locator('.version-filter-cb[data-version="__all__"]'); @@ -84,7 +84,13 @@ test('version dropdowns rebind across API languages and repeated visits', async await button.click(); await expect(button).toHaveAttribute('aria-expanded', 'true'); await page.keyboard.press('Escape'); - const input = page.locator(path.includes('/typescript/') ? '#ts-api-search-input' : '#api-search-input'); + const input = page.locator( + path.includes('/typescript/') + ? '#ts-api-search-input' + : path.includes('/go/') + ? '#go-api-search-input' + : '#api-search-input' + ); await input.fill('Redis'); await expect(page).toHaveURL(/q=Redis/); await navigate(page, '/reference/overview/'); @@ -94,6 +100,15 @@ test('version dropdowns rebind across API languages and repeated visits', async await expect(button).toHaveAttribute('aria-expanded', 'true'); await page.keyboard.press('Escape'); } +} + +test('version dropdowns rebind across API languages and repeated visits', async ({ page }) => { + await expectVersionFiltersRebind(page, ['/reference/api/csharp/', '/reference/api/typescript/', '/reference/api/csharp/']); +}); + +// Go has its own test so each language's version-dropdown scenario keeps a separate timeout budget. +test('version dropdowns rebind on the Go API reference', async ({ page }) => { + await expectVersionFiltersRebind(page, ['/reference/api/go/']); }); test('integration filters restore on Back and cancel input when leaving', async ({ page }) => { diff --git a/src/frontend/tests/e2e/go-api-search.spec.ts b/src/frontend/tests/e2e/go-api-search.spec.ts new file mode 100644 index 0000000000..3e32905360 --- /dev/null +++ b/src/frontend/tests/e2e/go-api-search.spec.ts @@ -0,0 +1,47 @@ +import { expect, test } from '@playwright/test'; +import { dismissCookieConsentIfVisible, isNarrowViewport } from '@tests/e2e/helpers'; + +test('Go API search keeps result names visible on narrow viewports', async ({ page }) => { + test.skip(!isNarrowViewport(page), 'This regression only applies to narrow/mobile viewports.'); + + await page.goto('/reference/api/go/?q=AddRedis'); + await dismissCookieConsentIfVisible(page); + + const results = page.locator('#go-api-search-results .api-search-result'); + await expect(results.first()).toBeVisible(); + + const firstResult = results.first(); + const resultName = firstResult.locator('.api-search-result-name'); + const resultKind = firstResult.locator('.api-kind-micro'); + const resultPackage = firstResult.locator('.trailing .api-list-meta'); + + await expect(firstResult).toBeVisible(); + await expect(resultName).toHaveText('AddRedis'); + await expect(resultName).toBeVisible(); + await expect(resultKind).toContainText(/method/i); + await expect(resultKind).toBeVisible(); + await expect(resultPackage).toContainText('Aspire.Hosting.Redis'); + await expect(resultPackage).toBeVisible(); + + await expect + .poll(async () => { + const box = await resultName.boundingBox(); + return Math.round(box?.width ?? 0); + }) + .toBeGreaterThan(20); +}); + +test('Go API search results name the receiver and link to the module-local page', async ({ page }) => { + await page.goto('/reference/api/go/?q=AddRedis'); + await dismissCookieConsentIfVisible(page); + + const result = page + .locator('#go-api-search-results .api-search-result', { + has: page.locator('.api-search-result-name', { hasText: /^AddRedis$/ }), + }) + .first(); + + await expect(result).toBeVisible(); + await expect(result).toHaveAttribute('href', '/reference/api/go/aspire.hosting.redis/addredis/'); + await expect(result.locator('.api-result-parent')).toHaveText('DistributedApplicationBuilder'); +}); diff --git a/src/frontend/tests/e2e/go-api-sidebar.spec.ts b/src/frontend/tests/e2e/go-api-sidebar.spec.ts new file mode 100644 index 0000000000..315aed74fc --- /dev/null +++ b/src/frontend/tests/e2e/go-api-sidebar.spec.ts @@ -0,0 +1,109 @@ +import { expect, test, type Locator, type Page } from '@playwright/test'; +import { dismissCookieConsentIfVisible } from '@tests/e2e/helpers'; + +const modulePath = '/reference/api/go/aspire.hosting.redis/'; +const itemPath = `${modulePath}redisresource/`; +const sidebarSelector = '.topics-sidebar[data-api-ref] sl-sidebar-state-persist'; + +test.beforeEach(async ({ page, isMobile }) => { + // Exercise ClientRouter's touch fallback, as in the cross-language API suite. + if (isMobile) { + await page.addInitScript(() => { + Object.defineProperty(document, 'startViewTransition', { + configurable: true, + value: undefined, + }); + }); + } +}); + +async function setMobileMenuOpen(page: Page, open: boolean): Promise { + const menu = page.locator('starlight-menu-button'); + const button = menu.locator('button'); + if (await button.isVisible() && ((await menu.getAttribute('aria-expanded')) === 'true') !== open) { + await button.click(); + await expect(menu).toHaveAttribute('aria-expanded', String(open)); + } +} + +async function sidebarOn(page: Page): Promise { + await expect(page.locator('html[data-astro-transition]')).toHaveCount(0); + await expect.poll(() => page.evaluate(() => + document.documentElement.hasAttribute('data-api-sidebar-ready'), + )).toBe(true); + await dismissCookieConsentIfVisible(page); + await setMobileMenuOpen(page, true); + const expandButton = page.locator('#sidebar-expand-btn'); + if (await expandButton.isVisible()) await expandButton.click(); + return page.locator(sidebarSelector); +} + +async function expectLocalAnchors(page: Page, sidebar: Locator): Promise { + const broken = await sidebar.locator('a[href*="#"]').evaluateAll((anchors) => + anchors.flatMap((anchor) => { + const url = new URL(anchor.getAttribute('href')!, location.href); + return url.pathname === location.pathname && !document.getElementById(decodeURIComponent(url.hash.slice(1))) + ? [url.href] + : []; + }), + ); + expect(broken).toEqual([]); +} + +test('a module catalog is shared through overview links, not repeated on detail pages', async ({ page }) => { + const errors: string[] = []; + page.on('pageerror', (error) => errors.push(error.message)); + await page.goto(itemPath); + let sidebar = await sidebarOn(page); + + // Search root + module overview + item overview + the item's own section links. + const sectionLinkCount = await sidebar.locator('a[href*="#"]').count(); + expect(sectionLinkCount).toBeGreaterThan(0); + await expect(sidebar.locator('a')).toHaveCount(3 + sectionLinkCount); + await expect(sidebar.locator('a[aria-current="page"]')).toHaveAttribute('href', itemPath); + await expect(sidebar.locator(`a[href="${modulePath}"]`)).toHaveCount(1); + await expect(sidebar.locator('a[href="/reference/api/go/"]')).toHaveCount(1); + await expect(sidebar.getByRole('link', { name: 'Methods', exact: true })).toHaveCount(1); + await expectLocalAnchors(page, sidebar); + + const filter = page.locator('#sidebar-filter-input'); + await filter.fill('no-such-navigation-link'); + await expect(page.locator('#sidebar-filter-empty')).toBeVisible(); + await page.locator('#sidebar-filter-clear').click(); + await expect(page.locator('#sidebar-filter-empty')).toBeHidden(); + await setMobileMenuOpen(page, false); + + // Follow an actual generated method URL, including any overload suffix. + const firstMethod = page.locator(`#type-content-sections a[href^="${itemPath}"]`).first(); + const methodHref = await firstMethod.getAttribute('href'); + expect(methodHref).toBeTruthy(); + await firstMethod.click(); + await expect(page).toHaveURL(new URL(methodHref!, page.url()).href); + sidebar = await sidebarOn(page); + // Search root + module, item and member overviews + the member's Signature and Defined on sections. + await expect(sidebar.locator('a')).toHaveCount(6); + await expect(sidebar.locator('a[aria-current="page"]')).toHaveAttribute('href', methodHref!); + await expectLocalAnchors(page, sidebar); + + await sidebar.locator(`a[href="${itemPath}"]`).click(); + await expect(page).toHaveURL(itemPath); + sidebar = await sidebarOn(page); + await sidebar.locator(`a[href="${modulePath}"]`).click(); + await expect(page).toHaveURL(modulePath); + sidebar = await sidebarOn(page); + await expect(sidebar.locator('a[aria-current="page"]')).toHaveAttribute('href', modulePath); + expect(await page.locator('#pkg-namespace-list a').count()).toBeGreaterThan(5); + await expectLocalAnchors(page, sidebar); + await setMobileMenuOpen(page, false); + await page.locator('#pkg-search-input').fill('RedisResource'); + await expect(page.locator(`#pkg-search-results a[title="RedisResource"][href="${itemPath}"]`)).toBeVisible(); + expect(errors).toEqual([]); +}); + +test('the Go landing sidebar lists modules and marks the API search as current', async ({ page }) => { + await page.goto('/reference/api/go/'); + const sidebar = await sidebarOn(page); + + await expect(sidebar.locator('a[aria-current="page"]')).toHaveAttribute('href', '/reference/api/go/'); + await expect(sidebar.locator(`a[href="${modulePath}"]`)).toHaveCount(1); +}); diff --git a/src/frontend/tests/e2e/mobile-ux.spec.ts b/src/frontend/tests/e2e/mobile-ux.spec.ts index 63fb61d1e1..5704e9aedd 100644 --- a/src/frontend/tests/e2e/mobile-ux.spec.ts +++ b/src/frontend/tests/e2e/mobile-ux.spec.ts @@ -77,6 +77,10 @@ const pageFamilies = [ '/reference/api/typescript/aspire.hosting.redis/', '/reference/api/typescript/aspire.hosting.redis/redisresource/', '/reference/api/typescript/aspire.hosting.redis/redisresource/withmodule/', + '/reference/api/go/', + '/reference/api/go/aspire.hosting.redis/', + '/reference/api/go/aspire.hosting.redis/redisresource/', + '/reference/api/go/aspire.hosting.redis/redisresource/withmodule/', ]; test('all page families stay within their phone, tablet and desktop viewport', async ({ page }) => { @@ -129,7 +133,7 @@ test('shared menus announce state, keep filters usable and restore focus after n page, }) => { await page.setViewportSize({ width: 390, height: 844 }); - for (const path of ['/', '/hub/', '/get-started/install-cli/', '/reference/api/typescript/']) { + for (const path of ['/', '/hub/', '/get-started/install-cli/', '/reference/api/typescript/', '/reference/api/go/']) { await open(page, path); const menu = page.locator('starlight-menu-button button'); await menu.click(); @@ -260,6 +264,7 @@ test('technical titles and breadcrumbs wrap whole identifier segments', async ({ ['/hub/glossary/resourcenotificationservice/', 'ResourceNotificationService'], ['/reference/api/csharp/aspire.hosting.redis/redisbuilderextensions/methods/', 'RedisBuilderExtensions Methods'], ['/reference/api/typescript/aspire.hosting.redis/redisresource/withmodule/', 'RedisResource.withModule'], + ['/reference/api/go/aspire.hosting.redis/redisresource/withmodule/', 'RedisResource.WithModule'], ]) { for (const width of [320, 390]) { await page.setViewportSize({ width, height: 844 }); @@ -407,6 +412,7 @@ test('API identifiers and the translation table reflow without clipping content' '/reference/api/csharp/aspire.hosting.redis/redisresource/', '/reference/api/csharp/aspire.hosting.redis/redisbuilderextensions/methods/', '/reference/api/typescript/aspire.hosting.redis/redisresource/', + '/reference/api/go/aspire.hosting.redis/redisresource/', ]) { await open(page, path); for (const width of [320, 390, 768]) { diff --git a/src/frontend/tests/e2e/og-metadata.spec.ts b/src/frontend/tests/e2e/og-metadata.spec.ts index 02a0daa1b9..f831e27d69 100644 --- a/src/frontend/tests/e2e/og-metadata.spec.ts +++ b/src/frontend/tests/e2e/og-metadata.spec.ts @@ -273,3 +273,23 @@ test('falls back to the site-wide image for generated API reference pages', asyn const imageResponse = await request.get(new URL('/og-image.png', baseURL).toString()); expect(imageResponse.ok(), 'the fallback /og-image.png must exist').toBe(true); }); + +test('falls back to the site-wide image for generated Go API reference pages', async ({ + request, + baseURL, +}) => { + const response = await request.get('/reference/api/go/aspire.hosting.redis/'); + expect(response.ok(), 'Go API reference page should return 200').toBe(true); + const html = await response.text(); + + expect(html).toMatch( + new RegExp( + `]*property="og:image"[^>]*content="[^"]*${escape('/og-image.png')}"`, + 'i' + ) + ); + expect(html).not.toMatch(/\/og\/reference\/api\/go\//i); + + const imageResponse = await request.get(new URL('/og-image.png', baseURL).toString()); + expect(imageResponse.ok(), 'the fallback /og-image.png must exist').toBe(true); +}); diff --git a/src/frontend/tests/e2e/search-visual-parity.spec.ts b/src/frontend/tests/e2e/search-visual-parity.spec.ts index ba96221ff6..401afddd6d 100644 --- a/src/frontend/tests/e2e/search-visual-parity.spec.ts +++ b/src/frontend/tests/e2e/search-visual-parity.spec.ts @@ -70,6 +70,7 @@ test.beforeEach(async ({ page }) => { for (const route of [ '/reference/api/typescript/', + '/reference/api/go/', '/reference/api/csharp/', '/integrations/gallery/', '/reference/samples/', diff --git a/src/frontend/tests/e2e/site-search.spec.ts b/src/frontend/tests/e2e/site-search.spec.ts index b7f84f38bc..e1fe1e4fb2 100644 --- a/src/frontend/tests/e2e/site-search.spec.ts +++ b/src/frontend/tests/e2e/site-search.spec.ts @@ -192,7 +192,7 @@ test.describe('site search dialog', () => { await expect(message).toHaveCSS('font-style', 'normal'); await expect(message).toHaveCSS('line-height', '21px'); const apiLinks = page.locator('site-search dialog[open]'); - for (const language of ['csharp', 'typescript']) { + for (const language of ['csharp', 'typescript', 'go']) { await expect(apiLinks.locator(`a[data-api-lang="${language}"]`)).toHaveAttribute( 'href', `/reference/api/${language}/?q=${encodeURIComponent(missingSearchQuery)}`, ); @@ -200,7 +200,7 @@ test.describe('site search dialog', () => { await clear.click(); await expect(input).toHaveValue(''); await expect(input).toBeFocused(); - for (const language of ['csharp', 'typescript']) { + for (const language of ['csharp', 'typescript', 'go']) { await expect(apiLinks.locator(`a[data-api-lang="${language}"]`)).toHaveAttribute( 'href', `/reference/api/${language}/`, ); @@ -513,7 +513,7 @@ test.describe('site search dialog', () => { await expect(input).toHaveAttribute('aria-expanded', 'false'); }); - test('arrow nav also cycles through the C#/TypeScript API buttons', async ({ page }) => { + test('arrow nav also cycles through the C#/TypeScript/Go API buttons', async ({ page }) => { await page.goto('/'); await dismissCookieConsentIfVisible(page); @@ -526,23 +526,30 @@ test.describe('site search dialog', () => { const results = dialog.locator('.pagefind-ui__result-link'); const csharpBtn = dialog.locator('a[data-api-search-link][data-api-lang="csharp"]'); const tsBtn = dialog.locator('a[data-api-search-link][data-api-lang="typescript"]'); + const goBtn = dialog.locator('a[data-api-search-link][data-api-lang="go"]'); await expect(results.first()).toBeVisible({ timeout: 15000 }); await expect(csharpBtn).toBeVisible(); + await expect(goBtn).toBeVisible(); // Press End to jump to the last keyboard target — that should be the - // TypeScript API button (last item in DOM order: results → load-more - // → C# button → TS button). Home/End are deliberately ignored while - // the caret is in the input (they keep native text-editing behaviour - // there), so we ArrowDown into the results first to move focus out - // of the search field. + // Go API button (last item in DOM order: results → load-more → C# + // button → TS button → Go button). Home/End are deliberately ignored + // while the caret is in the input (they keep native text-editing + // behaviour there), so we ArrowDown into the results first to move + // focus out of the search field. const input = dialog.locator('input.pagefind-ui__search-input'); await input.press('ArrowDown'); await page.keyboard.press('End'); + await expect(goBtn).toHaveAttribute('data-search-active', 'true'); + await expect(goBtn).toBeFocused(); + + // ArrowUp from the Go button should land on the TS button, then the C# button. + await page.keyboard.press('ArrowUp'); await expect(tsBtn).toHaveAttribute('data-search-active', 'true'); await expect(tsBtn).toBeFocused(); + await expect(goBtn).not.toHaveAttribute('data-search-active', 'true'); - // ArrowUp from TS button should land on the C# button. await page.keyboard.press('ArrowUp'); await expect(csharpBtn).toHaveAttribute('data-search-active', 'true'); await expect(csharpBtn).toBeFocused(); @@ -571,28 +578,33 @@ test.describe('site search dialog', () => { const results = dialog.locator('.pagefind-ui__result-link'); const csharpBtn = dialog.locator('a[data-api-search-link][data-api-lang="csharp"]'); const tsBtn = dialog.locator('a[data-api-search-link][data-api-lang="typescript"]'); + const goBtn = dialog.locator('a[data-api-search-link][data-api-lang="go"]'); await expect(results.first()).toBeVisible({ timeout: 15000 }); // Pressing Home/End while focus is in the input must NOT move the - // active marker to the C#/TypeScript API buttons (or any other + // active marker to the C#/TypeScript/Go API buttons (or any other // out-of-listbox target). This is the regression that previously // stole the caret away from the search field whenever the user // tried to jump to the start/end of their query text. await input.press('Home'); await expect(csharpBtn).not.toHaveAttribute('data-search-active', 'true'); await expect(tsBtn).not.toHaveAttribute('data-search-active', 'true'); + await expect(goBtn).not.toHaveAttribute('data-search-active', 'true'); await expect(csharpBtn).not.toBeFocused(); await expect(tsBtn).not.toBeFocused(); + await expect(goBtn).not.toBeFocused(); await input.press('End'); await expect(csharpBtn).not.toHaveAttribute('data-search-active', 'true'); await expect(tsBtn).not.toHaveAttribute('data-search-active', 'true'); + await expect(goBtn).not.toHaveAttribute('data-search-active', 'true'); await expect(csharpBtn).not.toBeFocused(); await expect(tsBtn).not.toBeFocused(); + await expect(goBtn).not.toBeFocused(); }); - test('typed query is forwarded to the C# and TypeScript API buttons', async ({ page }) => { + test('typed query is forwarded to the C#, TypeScript and Go API buttons', async ({ page }) => { await page.goto('/'); await dismissCookieConsentIfVisible(page); @@ -602,13 +614,16 @@ test.describe('site search dialog', () => { const dialog = page.locator('site-search dialog[open]'); const csharpBtn = dialog.locator('a[data-api-search-link][data-api-lang="csharp"]'); const tsBtn = dialog.locator('a[data-api-search-link][data-api-lang="typescript"]'); + const goBtn = dialog.locator('a[data-api-search-link][data-api-lang="go"]'); await expect(csharpBtn).toBeVisible(); await expect(tsBtn).toBeVisible(); + await expect(goBtn).toBeVisible(); // Pre-typing: hrefs should be the bare landing pages. await expect(csharpBtn).toHaveAttribute('href', /\/reference\/api\/csharp\/$/); await expect(tsBtn).toHaveAttribute('href', /\/reference\/api\/typescript\/$/); + await expect(goBtn).toHaveAttribute('href', /\/reference\/api\/go\/$/); // Use a query the TS API search index actually contains so the hand-off // can be verified end-to-end. @@ -616,6 +631,7 @@ test.describe('site search dialog', () => { await expect(csharpBtn).toHaveAttribute('href', /\/reference\/api\/csharp\/\?q=withBun$/); await expect(tsBtn).toHaveAttribute('href', /\/reference\/api\/typescript\/\?q=withBun$/); + await expect(goBtn).toHaveAttribute('href', /\/reference\/api\/go\/\?q=withBun$/); // Click the TypeScript button — it should land on the TS API landing // page with the query pre-applied via InpageSearchSync. @@ -631,6 +647,29 @@ test.describe('site search dialog', () => { await expect(tsResults.first()).toBeVisible({ timeout: 10000 }); }); + test('the Go API button hands the typed query to the Go API landing page', async ({ page }) => { + await page.goto('/'); + await dismissCookieConsentIfVisible(page); + + const ready = await openSearchDialog(page); + test.skip(!ready, 'Pagefind input is required to type into; runs against astro preview.'); + + const dialog = page.locator('site-search dialog[open]'); + const goBtn = dialog.locator('a[data-api-search-link][data-api-lang="go"]'); + + // AddRedis is a stable Go anchor in Aspire.Hosting.Redis. + await typeSearchQuery(page, 'AddRedis'); + await expect(goBtn).toHaveAttribute('href', /\/reference\/api\/go\/\?q=AddRedis$/); + + await goBtn.click(); + await page.waitForURL(/\/reference\/api\/go\/\?q=AddRedis/); + + await dismissCookieConsentIfVisible(page); + + await expect(page.locator('#go-api-search-input')).toHaveValue('AddRedis'); + await expect(page.locator('#go-api-search-results .api-search-result').first()).toBeVisible({ timeout: 10000 }); + }); + test('clearing the search input restores the default API button hrefs', async ({ page }) => { await page.goto('/'); await dismissCookieConsentIfVisible(page); @@ -641,12 +680,15 @@ test.describe('site search dialog', () => { const dialog = page.locator('site-search dialog[open]'); const csharpBtn = dialog.locator('a[data-api-search-link][data-api-lang="csharp"]'); const tsBtn = dialog.locator('a[data-api-search-link][data-api-lang="typescript"]'); + const goBtn = dialog.locator('a[data-api-search-link][data-api-lang="go"]'); await typeSearchQuery(page, 'withBun'); await expect(csharpBtn).toHaveAttribute('href', /\?q=withBun$/); + await expect(goBtn).toHaveAttribute('href', /\?q=withBun$/); await typeSearchQuery(page, ''); await expect(csharpBtn).toHaveAttribute('href', /\/reference\/api\/csharp\/$/); await expect(tsBtn).toHaveAttribute('href', /\/reference\/api\/typescript\/$/); + await expect(goBtn).toHaveAttribute('href', /\/reference\/api\/go\/$/); }); }); diff --git a/src/frontend/tests/unit/api-reference-routes.vitest.test.ts b/src/frontend/tests/unit/api-reference-routes.vitest.test.ts index c44c87a780..44f699eb82 100644 --- a/src/frontend/tests/unit/api-reference-routes.vitest.test.ts +++ b/src/frontend/tests/unit/api-reference-routes.vitest.test.ts @@ -9,6 +9,7 @@ import { test('isApiReferencePath recognizes API page and markdown routes', () => { expect(isApiReferencePath('/reference/api/csharp/')).toBe(true); expect(isApiReferencePath('/reference/api/typescript/aspire.hosting.md')).toBe(true); + expect(isApiReferencePath('/reference/api/go/aspire.hosting.md')).toBe(true); expect(isApiReferencePath('/fr/reference/api/csharp/')).toBe(true); expect(isApiReferencePath('reference/api/csharp/')).toBe(true); expect(isApiReferencePath('/reference/overview/')).toBe(false); @@ -17,6 +18,9 @@ test('isApiReferencePath recognizes API page and markdown routes', () => { test('stripApiReferenceLocale returns the canonical API path for localized API URLs', () => { expect(stripApiReferenceLocale('/fr/reference/api/csharp/')).toBe('/reference/api/csharp/'); expect(stripApiReferenceLocale('/ja/reference/api/typescript/')).toBe('/reference/api/typescript/'); + expect(stripApiReferenceLocale('/ko/reference/api/go/aspire.hosting.redis/')).toBe( + '/reference/api/go/aspire.hosting.redis/' + ); expect(stripApiReferenceLocale('/zh-CN/reference/api/csharp/communitytoolkit.aspire.hosting.activemq.md')).toBe( '/reference/api/csharp/communitytoolkit.aspire.hosting.activemq.md' ); @@ -43,3 +47,14 @@ test('sidebar canonicalization preserves TypeScript section anchors after Starli expect(normalizeApiReferenceSidebarHref('/docs/#heading/')).toBe('/docs/#heading/'); expect(normalizeApiReferenceSidebarHref('https://example.com/#heading/')).toBe('https://example.com/#heading/'); }); + +test('sidebar canonicalization preserves Go section anchors after Starlight formatting', () => { + const typePath = '/reference/api/go/aspire.hosting.redis/redisresource/'; + expect(normalizeApiReferenceSidebarHref(`${typePath}#properties/`)).toBe(`${typePath}#properties`); + expect(normalizeApiReferenceSidebarHref(`/de${typePath}#methods/`)).toBe(`${typePath}#methods`); + expect(normalizeApiReferenceSidebarHref(`${typePath}withdatavolume/#defined-on/`)).toBe( + `${typePath}withdatavolume/#defined-on` + ); + expect(normalizeApiReferenceSidebarHref(`${typePath}#methods`)).toBe(`${typePath}#methods`); + expect(normalizeApiReferenceSidebarHref(typePath)).toBe(typePath); +}); diff --git a/src/frontend/tests/unit/api-search-lifecycle.vitest.test.ts b/src/frontend/tests/unit/api-search-lifecycle.vitest.test.ts index 75723724e9..957d4a1491 100644 --- a/src/frontend/tests/unit/api-search-lifecycle.vitest.test.ts +++ b/src/frontend/tests/unit/api-search-lifecycle.vitest.test.ts @@ -9,6 +9,7 @@ import rehypeParse from 'rehype-parse'; import { unified } from 'unified'; import { readApiSearchIndex, registerApiSearch } from '@components/api-reference/search-lifecycle'; import * as searchStats from '@utils/ts-api-search-stats'; +import * as goSearchStats from '@utils/go-api-search-stats'; import { ApiSearchPresentation, withApiSearchFallback } from '../../src/pages/reference/api/_search-presentation'; const surfaces = [ @@ -18,6 +19,9 @@ const surfaces = [ ['typescript', 'landing'], ['typescript', 'module'], ['typescript', 'item'], + ['go', 'landing'], + ['go', 'module'], + ['go', 'item'], ] as const; type MountSearch = (root: HTMLElement, signal: AbortSignal) => void; @@ -176,7 +180,7 @@ describe('API search navigation lifecycle', () => { vi.useFakeTimers(); const events = new EventTarget(); const root = new SearchElement(); - const prefix = kind === 'landing' ? language === 'csharp' ? 'api' : 'ts-api' + const prefix = kind === 'landing' ? language === 'csharp' ? 'api' : language === 'go' ? 'go-api' : 'ts-api' : kind === 'type' || kind === 'item' ? 'type' : 'pkg'; for (const suffix of ['search-input', 'search-clear', 'search-results', 'search-status', 'search-count', 'kind-filters', 'clear-filters', 'package-list']) { @@ -227,6 +231,7 @@ describe('API search navigation lifecycle', () => { }, }, '@utils/ts-api-search-stats': searchStats, + '@utils/go-api-search-stats': goSearchStats, '../_search-presentation': { ApiSearchPresentation, withApiSearchFallback }, '../../_search-presentation': { ApiSearchPresentation, withApiSearchFallback }, '../../../_search-presentation': { ApiSearchPresentation, withApiSearchFallback }, diff --git a/src/frontend/tests/unit/api-search-recovery.vitest.test.ts b/src/frontend/tests/unit/api-search-recovery.vitest.test.ts index e5c0251e22..ca0d272128 100644 --- a/src/frontend/tests/unit/api-search-recovery.vitest.test.ts +++ b/src/frontend/tests/unit/api-search-recovery.vitest.test.ts @@ -11,6 +11,9 @@ const routes = [ 'typescript/index.astro', 'typescript/[module]/index.astro', 'typescript/[module]/[item]/index.astro', + 'go/index.astro', + 'go/[module]/index.astro', + 'go/[module]/[item]/index.astro', ]; interface Entry { @@ -75,7 +78,7 @@ describe.each(routes)('API recovery uses actual matching predicates: %s', route expect(controller.activeKinds).toEqual(new Set(['property'])); }); - if (route === 'csharp/index.astro' || route === 'typescript/index.astro') { + if (route === 'csharp/index.astro' || route === 'typescript/index.astro' || route === 'go/index.astro') { it('restores the supported catalog version default instead of retaining selected versions', () => { const { controller, renderEmpty } = createController(route); controller.activeVersions = new Set(['13.5.0']); diff --git a/src/frontend/tests/unit/go-api-markdown.vitest.test.ts b/src/frontend/tests/unit/go-api-markdown.vitest.test.ts new file mode 100644 index 0000000000..ad1d2d8fcb --- /dev/null +++ b/src/frontend/tests/unit/go-api-markdown.vitest.test.ts @@ -0,0 +1,1213 @@ +import { readFileSync, readdirSync } from 'node:fs'; +import { join } from 'node:path'; +import { fileURLToPath } from 'node:url'; +import type { APIRoute } from 'astro'; +import { describe, expect, test, vi } from 'vitest'; +import { + goIndexMdHref, + goItemMdHref, + goMemberMdHref, + goModuleMdHref, + renderGoIndexMarkdown, + renderGoItemMarkdown, + renderGoMemberMarkdownPage, + renderGoModuleMarkdown, +} from '@utils/go-api-markdown'; +import { prepareGoApiRoutes } from '@utils/go-api-routes'; +import { GO_MARKER_NOTE } from '@utils/go-modules'; +import type { + GoApiDocument, + GoDtoType, + GoEnumType, + GoFunction, + GoHandleType, +} from '@utils/go-modules'; +import { GET as getIndex } from '../../src/pages/reference/api/go.md'; +import { GET as getModule, getStaticPaths as modulePaths } from '../../src/pages/reference/api/go/[module].md'; +import { GET as getItem, getStaticPaths as itemPaths } from '../../src/pages/reference/api/go/[module]/[item].md'; +import { + GET as getMember, + getStaticPaths as memberPaths, +} from '../../src/pages/reference/api/go/[module]/[item]/[member].md'; + +vi.mock('astro:content', () => ({ + getCollection: () => { + const directory = fileURLToPath(new URL('../../src/data/go-modules/', import.meta.url)); + return Promise.resolve( + readdirSync(directory) + .filter((name) => name.endsWith('.json')) + .sort() + .map((file) => { + const data = JSON.parse(readFileSync(join(directory, file), 'utf8')) as GoApiDocument; + prepareGoApiRoutes(data); + return { id: file, data }; + }) + ); + }, +})); + +/* ---- Inline fixture: a small Redis-like module ---------------------- */ + +const hostGetter: GoFunction = { + name: 'Host', + qualifiedName: 'RedisResource.host', + kind: 'PropertyGetter', + signature: 'Host() (string, error)', + receiver: 'RedisResource', + returnType: '(string, error)', + errorModel: 'returned', + description: 'The host name.', +}; + +const portGetter: GoFunction = { + name: 'Port', + qualifiedName: 'RedisResource.port', + kind: 'PropertyGetter', + signature: 'Port() (*float64, error)', + receiver: 'RedisResource', + returnType: '(*float64, error)', + errorModel: 'returned', +}; + +const portSetter: GoFunction = { + name: 'SetPort', + qualifiedName: 'RedisResource.setPort', + kind: 'PropertySetter', + signature: 'SetPort(value *float64) error', + receiver: 'RedisResource', + parameters: [{ name: 'value', type: '*float64' }], + returnType: 'error', + errorModel: 'returned', +}; + +const tokenSetter: GoFunction = { + name: 'SetToken', + qualifiedName: 'RedisResource.setToken', + kind: 'PropertySetter', + signature: 'SetToken(value string) error', + receiver: 'RedisResource', + parameters: [{ name: 'value', type: 'string' }], + returnType: 'error', + errorModel: 'returned', + description: 'Sets the token.', +}; + +const withModule: GoFunction = { + name: 'WithModule', + capabilityId: 'Aspire.Hosting.Redis/withModule', + qualifiedName: 'withModule', + kind: 'Method', + signature: 'WithModule(path string) RedisResource', + receiver: 'RedisResource', + parameters: [{ name: 'path', type: 'string', description: 'The module path.' }], + returnType: 'RedisResource', + returns: 'The same resource, for chaining.', + errorModel: 'deferred', + appliesTo: ['RedisResource'], + description: 'Adds a Redis module.', +}; + +const withDataVolume: GoFunction = { + name: 'WithDataVolume', + capabilityId: 'Aspire.Hosting.Redis/withDataVolume', + qualifiedName: 'withDataVolume', + kind: 'Method', + signature: 'WithDataVolume(opts ...*WithDataVolumeOptions) RedisResource', + receiver: 'RedisResource', + options: { + typeName: 'WithDataVolumeOptions', + fields: [ + { name: 'Name', jsonName: 'name', type: '*string', description: 'The volume name.' }, + { + name: 'Configure', + jsonName: 'configure', + type: 'func(volume Volume)', + isCallback: true, + callbackSignature: 'func(volume Volume) error', + description: 'Configures the volume.', + }, + ], + }, + returnType: 'RedisResource', + errorModel: 'deferred', + appliesTo: ['RedisResource'], +}; + +const ping: GoFunction = { + name: 'Ping', + qualifiedName: 'RedisResource.ping', + kind: 'InstanceMethod', + signature: 'Ping() (bool, error)', + receiver: 'RedisResource', + returnType: '(bool, error)', + returns: 'Whether the server answered.', + errorModel: 'returned', +}; + +const close: GoFunction = { + name: 'Close', + qualifiedName: 'RedisResource.close', + kind: 'InstanceMethod', + signature: 'Close() error', + receiver: 'RedisResource', + returnType: 'error', + errorModel: 'returned', +}; + +const count: GoFunction = { + name: 'Count', + qualifiedName: 'RedisResource.count', + kind: 'InstanceMethod', + signature: 'Count() int', + receiver: 'RedisResource', + returnType: 'int', + errorModel: 'none', +}; + +const withEnvironment: GoFunction = { + name: 'WithEnvironment', + qualifiedName: 'withEnvironment', + kind: 'Method', + signature: 'WithEnvironment(name string, value string) ResourceWithEnvironment', + receiver: 'ResourceWithEnvironment', + parameters: [ + { name: 'name', type: 'string' }, + { name: 'value', type: 'string' }, + ], + returnType: 'ResourceWithEnvironment', + errorModel: 'deferred', + appliesTo: ['RedisResource', 'ContainerResource'], + description: 'Sets an environment variable.', +}; + +const addRedis: GoFunction = { + name: 'AddRedis', + capabilityId: 'Aspire.Hosting.Redis/addRedis', + qualifiedName: 'addRedis', + kind: 'Method', + signature: 'AddRedis(name string, options ...*AddRedisOptions) RedisResource', + receiver: 'DistributedApplicationBuilder', + parameters: [{ name: 'name', type: 'string', description: 'The resource name.' }], + options: { + typeName: 'AddRedisOptions', + fields: [ + { name: 'Port', jsonName: 'port', type: '*float64', description: 'The host port.' }, + { name: 'Mode', jsonName: 'mode', type: '*RedisMode' }, + ], + }, + returnType: 'RedisResource', + returns: 'A builder for the Redis resource.', + errorModel: 'deferred', + appliesTo: ['DistributedApplicationBuilder'], + description: 'Adds a Redis container resource.', +}; + +const configureRedis: GoFunction = { + name: 'ConfigureRedis', + qualifiedName: 'configureRedis', + kind: 'Method', + signature: 'ConfigureRedis(options ...*RedisOptions) (RedisResource, error)', + receiver: 'DistributedApplicationBuilder', + options: { typeName: 'RedisOptions', isDirect: true }, + returnType: '(RedisResource, error)', + errorModel: 'returned', + appliesTo: ['DistributedApplicationBuilder'], +}; + +const createRedisBuilder: GoFunction = { + name: 'CreateRedisBuilder', + qualifiedName: 'createRedisBuilder', + kind: 'Method', + signature: 'CreateRedisBuilder() (DistributedApplicationBuilder, error)', + returnType: '(DistributedApplicationBuilder, error)', + errorModel: 'returned', + description: 'Creates a builder.', +}; + +const redisResource: GoHandleType = { + name: 'RedisResource', + fullName: 'Aspire.Hosting.Redis.RedisResource', + kind: 'handle', + description: 'Represents a Redis container resource.', + // The fence below is intentionally never closed, like real XML-doc remarks. + remarks: 'Chain calls on the builder:\n\n```go\nredis := builder.AddRedis("cache")\nredis.WithModule("x")\n', + implementedInterfaces: ['Resource', 'ResourceWithEnvironment', 'ExternalType'], + capabilities: [hostGetter, portGetter, portSetter, tokenSetter, withModule, withDataVolume, ping, close, count], +}; + +const resourceWithEnvironment: GoHandleType = { + name: 'ResourceWithEnvironment', + kind: 'handle', + isInterface: true, + description: 'Resources that accept environment variables.', + implementedInterfaces: ['Resource'], + capabilities: [withEnvironment], +}; + +const resource: GoHandleType = { + name: 'Resource', + kind: 'handle', + isInterface: true, + isMarker: true, + description: 'Any resource.', + implementedInterfaces: [], + capabilities: [], +}; + +const excludeFromManifest: GoFunction = { + name: 'ExcludeFromManifest', + capabilityId: 'Aspire.Hosting/excludeFromManifest', + qualifiedName: 'excludeFromManifest', + kind: 'Method', + signature: 'ExcludeFromManifest() Resource', + receiver: 'Resource', + returnType: 'Resource', + returnsReceiver: true, + errorModel: 'deferred', + appliesTo: ['ContainerResource', 'RedisResource'], + description: 'Excludes the resource from the deployment manifest.', +}; + +// Markers declare no methods in Go; the generator still attaches the functions that apply to every resource. +const markerWithFunctions: GoHandleType = { ...resource, capabilities: [excludeFromManifest] }; + +const inputCollection: GoHandleType = { + name: 'InputCollection', + kind: 'handle', + description: 'A collection of inputs.', + implementedInterfaces: [], + capabilities: [], + synthesizedMembers: [ + { + name: 'Get', + signature: 'Get(name string) (*Input, error)', + description: 'Get returns the input with the specified name,\nor nil if no input matches.', + }, + ], +}; + +const redisOptions: GoDtoType = { + name: 'RedisOptions', + fullName: 'Aspire.Hosting.Redis.RedisOptions', + kind: 'dto', + description: 'Options for Redis.', + fields: [ + { name: 'Port', jsonName: 'port', type: '*float64', isOptional: true, description: 'The host port.' }, + { name: 'Modules', jsonName: 'modules', type: '[]RedisMode' }, + { name: 'OnReady', jsonName: 'onReady', type: 'func()', isCallback: true, description: 'Called when ready.' }, + ], +}; + +const redisMode: GoEnumType = { + name: 'RedisMode', + fullName: 'Aspire.Hosting.Redis.RedisMode', + kind: 'enum', + description: 'Redis modes.', + members: [ + { name: 'RedisModeStandalone', value: 'Standalone', description: 'A single node.' }, + { name: 'RedisModeCluster', value: 'Cluster' }, + ], +}; + +const redisDoc: GoApiDocument = { + package: { + name: 'Aspire.Hosting.Redis', + version: '13.6.0', + language: 'go', + importPath: 'apphost/modules/aspire', + sourceRepository: 'https://github.com/microsoft/aspire', + sourceCommit: 'abc1234', + }, + functions: [ + addRedis, + configureRedis, + createRedisBuilder, + withModule, + withDataVolume, + withEnvironment, + hostGetter, + portGetter, + portSetter, + tokenSetter, + ping, + close, + count, + ], + handleTypes: [redisResource, resourceWithEnvironment, resource, inputCollection], + dtoTypes: [redisOptions], + enumTypes: [redisMode], + exportedValues: [ + { + name: 'RedisModules', + fullName: 'Aspire.Hosting.Redis.RedisModules', + kind: 'exportedValue', + values: [{ path: 'Json', type: 'string', value: '"redis/redis-stack"', description: 'The JSON module.' }], + }, + ], +}; + +const hostingDoc: GoApiDocument = { + package: { name: 'Aspire.Hosting', version: '13.6.0', language: 'go', importPath: 'apphost/modules/aspire' }, + functions: [{ name: 'CreateBuilder', signature: 'CreateBuilder() error', returnType: 'error' }], + handleTypes: [{ name: 'DistributedApplicationBuilder' }], +}; + +const markerDoc: GoApiDocument = { + ...redisDoc, + functions: [...(redisDoc.functions ?? []), excludeFromManifest], + handleTypes: [redisResource, resourceWithEnvironment, markerWithFunctions, inputCollection], +}; + +/* ---- Helpers --------------------------------------------------------- */ + +const base = ''; +const redisModuleHref = '/reference/api/go/aspire.hosting.redis'; + +// The markdown CLI parser reads index and module bullets with this shape. +const cliBullet = /^-\s+\[(?[^\]]+)\]\((?[^)]+)\)(?.*)$/; + +function sectionOf(markdown: string, title: string): string { + const parts = markdown.split(/^## /m).slice(1); + const found = parts.find((part) => part.startsWith(`${title}\n`)); + if (!found) { + throw new Error(`Missing "## ${title}" section.`); + } + + return found.slice(title.length + 1).trim(); +} + +function bulletEntries(markdown: string, title: string): Array<{ name: string; href: string; tail: string }> { + return sectionOf(markdown, title) + .split('\n') + .filter((line) => line.startsWith('- ')) + .map((line) => { + const groups = cliBullet.exec(line)?.groups; + if (!groups) { + throw new Error(`Not a CLI-parseable bullet: ${line}`); + } + + return { name: groups.name, href: groups.href, tail: groups.tail }; + }); +} + +function headingsOutsideFences(markdown: string): string[] { + const headings: string[] = []; + let inFence = false; + for (const line of markdown.split('\n')) { + if (/^\s*```/.test(line)) { + inFence = !inFence; + continue; + } + + if (!inFence && /^#{1,6} /.test(line)) { + headings.push(line); + } + } + + return headings; +} + +function hasDanglingFence(markdown: string): boolean { + let openLength: number | undefined; + for (const line of markdown.split('\n')) { + const match = /^ {0,3}(`{3,})(.*)$/.exec(line); + if (openLength === undefined) { + if (match && !match[2].includes('`')) openLength = match[1].length; + } else if (match && match[1].length >= openLength && match[2].trim() === '') { + openLength = undefined; + } + } + + return openLength !== undefined; +} + +/* ---- Hrefs ------------------------------------------------------------ */ + +describe('Go markdown hrefs', () => { + test('build module-local .md routes and honour the base path', () => { + expect(goIndexMdHref('')).toBe('/reference/api/go.md'); + expect(goModuleMdHref('', 'Aspire.Hosting.Redis')).toBe(`${redisModuleHref}.md`); + expect(goItemMdHref('', 'Aspire.Hosting.Redis', 'redisresource')).toBe(`${redisModuleHref}/redisresource.md`); + expect(goMemberMdHref('', 'Aspire.Hosting.Redis', 'redisresource', 'withmodule')).toBe( + `${redisModuleHref}/redisresource/withmodule.md` + ); + expect(goIndexMdHref('/docs/')).toBe('/docs/reference/api/go.md'); + expect(goModuleMdHref('/docs/', 'Aspire.Hosting.Redis')).toBe('/docs/reference/api/go/aspire.hosting.redis.md'); + }); +}); + +/* ---- Index and module pages ------------------------------------------- */ + +describe('Go index markdown', () => { + const markdown = renderGoIndexMarkdown([redisDoc, hostingDoc], base); + + test('introduces the flat import path without a preview notice', () => { + expect(markdown.startsWith('# Go API Reference\n')).toBe(true); + expect(markdown).toContain('imported as `apphost/modules/aspire`.'); + expect(markdown).not.toContain('experimental'); + }); + + test('lists modules as "- [Name](href) -- detail" bullets sorted by name', () => { + const entries = bulletEntries(markdown, 'Modules'); + expect(entries.map((entry) => entry.name)).toEqual(['Aspire.Hosting', 'Aspire.Hosting.Redis']); + expect(entries.map((entry) => entry.href)).toEqual([ + '/reference/api/go/aspire.hosting.md', + `${redisModuleHref}.md`, + ]); + + const functionCount = redisDoc.functions?.filter((fn) => !fn.qualifiedName?.includes('.')).length; + const typeCount = + (redisDoc.handleTypes?.length ?? 0) + (redisDoc.dtoTypes?.length ?? 0) + (redisDoc.enumTypes?.length ?? 0); + expect(entries[1].tail).toBe(` -- v13.6.0 - ${functionCount} functions - ${typeCount} types`); + }); + + test('uses the plain separators the markdown normaliser produces', () => { + expect(markdown).not.toMatch(/[·—–…]/); + }); + + test('names every distinct import path when modules disagree', () => { + const other: GoApiDocument = { package: { name: 'Other', importPath: 'apphost/modules/other' } }; + expect(renderGoIndexMarkdown([redisDoc, other], base)).toContain( + 'Modules are imported as `apphost/modules/aspire`, `apphost/modules/other`.' + ); + }); + + test('tolerates an empty module list', () => { + const empty = renderGoIndexMarkdown([], base); + expect(empty).toContain('# Go API Reference'); + expect(empty).not.toContain('## Modules'); + }); + + test('prefixes every link with the site base', () => { + const prefixed = renderGoIndexMarkdown([redisDoc], '/docs/'); + expect(bulletEntries(prefixed, 'Modules')[0].href).toBe('/docs/reference/api/go/aspire.hosting.redis.md'); + }); +}); + +describe('Go module markdown', () => { + const markdown = renderGoModuleMarkdown(redisDoc, base); + + test('states the module metadata and import path without a preview notice', () => { + expect(markdown.startsWith('# Aspire.Hosting.Redis\n')).toBe(true); + expect(markdown).not.toContain('experimental'); + expect(markdown).toContain('- Module: `Aspire.Hosting.Redis`'); + expect(markdown).toContain('- Version: `13.6.0`'); + expect(markdown).toContain('- Import path: `apphost/modules/aspire`'); + expect(markdown).toContain('- Source: [GitHub](https://github.com/microsoft/aspire/tree/abc1234)'); + expect(markdown).toContain('- Functions: `6`'); + expect(markdown).toContain('- Types: `6`'); + }); + + test('groups handles, DTOs, enums, functions and exported values in that order', () => { + expect(headingsOutsideFences(markdown)).toEqual([ + '# Aspire.Hosting.Redis', + '## Handles', + '## DTOs', + '## Enums', + '## Functions', + '## Exported values', + ]); + }); + + test('lists handles with their kind, marker flag, member count and summary', () => { + const entries = bulletEntries(markdown, 'Handles'); + expect(entries.map((entry) => entry.name)).toEqual([ + 'InputCollection', + 'RedisResource', + 'Resource', + 'ResourceWithEnvironment', + ]); + + const byName = new Map(entries.map((entry) => [entry.name, entry])); + expect(byName.get('RedisResource')).toEqual({ + name: 'RedisResource', + href: `${redisModuleHref}/redisresource.md`, + // Nine capabilities, but `SetPort` is the setter of the `Port` getter: one property. + tail: ' -- `handle` - 8 members -- Represents a Redis container resource.', + }); + expect(byName.get('Resource')?.tail).toBe(' -- `interface` `marker` - 0 members -- Any resource.'); + expect(byName.get('ResourceWithEnvironment')?.tail).toBe( + ' -- `interface` - 1 members -- Resources that accept environment variables.' + ); + // Synthesized helpers count as members. + expect(byName.get('InputCollection')?.tail).toBe(' -- `handle` - 1 members -- A collection of inputs.'); + }); + + test('lists DTOs and enums', () => { + expect(bulletEntries(markdown, 'DTOs')).toEqual([ + { + name: 'RedisOptions', + href: `${redisModuleHref}/redisoptions.md`, + tail: ' -- `struct` - 3 fields -- Options for Redis.', + }, + ]); + expect(bulletEntries(markdown, 'Enums')).toEqual([ + { + name: 'RedisMode', + href: `${redisModuleHref}/redismode.md`, + tail: ' -- `enum` - 2 values -- Redis modes.', + }, + ]); + }); + + test('groups standalone functions by receiver, package functions first', () => { + const entries = bulletEntries(markdown, 'Functions'); + expect(entries.map((entry) => entry.name)).toEqual([ + 'CreateRedisBuilder', + 'AddRedis', + 'ConfigureRedis', + 'WithDataVolume', + 'WithModule', + 'WithEnvironment', + ]); + expect(entries[0]).toEqual({ + name: 'CreateRedisBuilder', + href: `${redisModuleHref}/createredisbuilder.md`, + tail: ' -- `function` -- Creates a builder.', + }); + expect(entries[1]).toEqual({ + name: 'AddRedis', + href: `${redisModuleHref}/addredis.md`, + tail: ' -- `method` - on `DistributedApplicationBuilder` -- Adds a Redis container resource.', + }); + // Property-style capabilities (dotted qualifiedName) are never listed as functions. + expect(entries.map((entry) => entry.name)).not.toContain('Host'); + }); + + test('renders exported values on the module page only', () => { + expect(sectionOf(markdown, 'Exported values')).toBe( + '- `RedisModules.Json`: `string` = `"redis/redis-stack"` -- The JSON module.' + ); + expect(renderGoModuleMarkdown(hostingDoc, base)).not.toContain('## Exported values'); + }); + + test('every list entry follows the " -- " bullet grammar the CLI expects', () => { + for (const title of ['Handles', 'DTOs', 'Enums', 'Functions']) { + const entries = bulletEntries(markdown, title); + expect(entries.length, title).toBeGreaterThan(0); + for (const entry of entries) { + expect(entry.href, entry.name).toMatch(/^\/reference\/api\/go\/aspire\.hosting\.redis\/[a-z0-9-]+\.md$/); + expect(entry.tail.startsWith(' -- '), entry.name).toBe(true); + } + } + expect(markdown).not.toMatch(/[·—–…]/); + }); + + test('links same-name standalone functions to distinct pages', () => { + const collisions: GoApiDocument = { + package: { name: 'Aspire.Hosting.Collisions', importPath: 'apphost/modules/aspire' }, + functions: [ + { name: 'WithDataVolume', qualifiedName: 'withDataVolume', kind: 'Method', receiver: 'RedisResource' }, + { name: 'WithDataVolume', qualifiedName: 'withDataVolume', kind: 'Method', receiver: 'PostgresServerResource' }, + ], + }; + + const hrefs = bulletEntries(renderGoModuleMarkdown(collisions, base), 'Functions').map((entry) => entry.href); + expect(hrefs).toHaveLength(2); + expect(new Set(hrefs).size).toBe(2); + }); + + test('prefixes every link with the site base', () => { + const prefixed = renderGoModuleMarkdown(redisDoc, '/docs/'); + for (const entry of bulletEntries(prefixed, 'Handles')) { + expect(entry.href.startsWith('/docs/reference/api/go/aspire.hosting.redis/')).toBe(true); + } + }); +}); + +/* ---- Item pages -------------------------------------------------------- */ + +describe('Go handle markdown', () => { + const markdown = renderGoItemMarkdown(redisDoc, redisResource, 'handle', base); + + test('defines the handle as an interface embedding its interfaces, without listing members', () => { + expect(sectionOf(markdown, 'Definition')).toBe( + [ + '```go', + 'type RedisResource interface {', + ' Resource', + ' ResourceWithEnvironment', + ' ExternalType', + '}', + '```', + ].join('\n') + ); + }); + + test('orders the sections and keeps every heading outside code fences', () => { + expect(headingsOutsideFences(markdown)).toEqual([ + '# RedisResource', + '## Remarks', + '## Definition', + '## Embeds', + '## Properties', + '## Methods', + ]); + expect(markdown).toContain('- Module: [Aspire.Hosting.Redis](/reference/api/go/aspire.hosting.redis.md)'); + expect(markdown).toContain('- Kind: `handle`'); + }); + + test('links embedded interfaces declared in the same module and leaves others as code', () => { + expect(sectionOf(markdown, 'Embeds')).toBe( + [ + `- [\`Resource\`](${redisModuleHref}/resource.md)`, + `- [\`ResourceWithEnvironment\`](${redisModuleHref}/resourcewithenvironment.md)`, + '- `ExternalType`', + ].join('\n') + ); + }); + + test('renders getters, getter/setter pairs and write-only setters as properties', () => { + expect(sectionOf(markdown, 'Properties')).toBe( + [ + '- `Host`: `string` `get` -- The host name.', + '- `Port`: `*float64` `get/set`', + '- `SetToken`(`string`) `set` -- Sets the token.', + ].join('\n') + ); + }); + + test('links methods to member pages with their signature, and never lists properties there', () => { + const methods = sectionOf(markdown, 'Methods'); + expect(methods).toContain( + [ + `- [WithModule](${redisModuleHref}/redisresource/withmodule.md) -- \`method\` -- Adds a Redis module.`, + ' ```go', + ' WithModule(path string) RedisResource', + ' ```', + ].join('\n') + ); + expect(methods.match(/^- \[/gm)?.length).toBe(5); + expect(methods).not.toContain('Host'); + expect(methods).not.toContain('SetToken'); + }); + + test('closes an unterminated fence in the remarks so later sections survive', () => { + expect(hasDanglingFence(redisResource.remarks ?? '')).toBe(true); + expect(hasDanglingFence(markdown)).toBe(false); + expect(sectionOf(markdown, 'Remarks')).toBe( + [ + 'Chain calls on the builder:', + '', + '```go', + 'redis := builder.AddRedis("cache")', + 'redis.WithModule("x")', + '```', + ].join('\n') + ); + }); + + test('also closes an unterminated fence in a description', () => { + const noisy: GoHandleType = { name: 'Noisy', description: 'Intro\n```\ncode without a closing fence' }; + const page = renderGoItemMarkdown({ package: { name: 'Noisy.Module' }, handleTypes: [noisy] }, noisy, 'handle', base); + expect(hasDanglingFence(page)).toBe(false); + expect(headingsOutsideFences(page)).toEqual(['# Noisy', '## Definition']); + }); + + test('renders hand-written SDK helpers as plain, unlinked entries', () => { + const page = renderGoItemMarkdown(redisDoc, inputCollection, 'handle', base); + expect(sectionOf(page, 'Methods')).toBe( + [ + '- `Get` -- `method` -- Get returns the input with the specified name, or nil if no input matches.', + ' ```go', + ' Get(name string) (*Input, error)', + ' ```', + ].join('\n') + ); + expect(page).not.toContain('](/reference/api/go/aspire.hosting.redis/inputcollection/get.md)'); + }); + + test('interface handles list the types they apply to', () => { + const page = renderGoItemMarkdown(redisDoc, resourceWithEnvironment, 'handle', base); + expect(page).toContain('- Kind: `interface`'); + expect(sectionOf(page, 'Applies to')).toBe( + ['- `ContainerResource`', `- [\`RedisResource\`](${redisModuleHref}/redisresource.md)`].join('\n') + ); + expect(sectionOf(page, 'Embeds')).toBe(`- [\`Resource\`](${redisModuleHref}/resource.md)`); + }); + + test('marker handles are an empty interface without member sections', () => { + const page = renderGoItemMarkdown(redisDoc, resource, 'handle', base); + expect(headingsOutsideFences(page)).toEqual(['# Resource', '## Definition']); + expect(sectionOf(page, 'Definition')).toBe('```go\ntype Resource interface{}\n```'); + expect(page).toContain('- Kind: `interface`'); + }); + + test('marker handles that list functions keep an empty definition and present them as applicability metadata', () => { + const page = renderGoItemMarkdown(markerDoc, markerWithFunctions, 'handle', base); + expect(headingsOutsideFences(page)).toEqual(['# Resource', '## Definition', '## Methods', '## Applies to']); + expect(sectionOf(page, 'Definition')).toBe('```go\ntype Resource interface{}\n```'); + expect(sectionOf(page, 'Methods')).toBe( + [ + GO_MARKER_NOTE, + '', + `- [ExcludeFromManifest](${redisModuleHref}/resource/excludefrommanifest.md) -- \`method\` -- Excludes the resource from the deployment manifest.`, + ' ```go', + ' ExcludeFromManifest() Resource', + ' ```', + ].join('\n') + ); + expect(sectionOf(page, 'Applies to')).toBe( + ['- `ContainerResource`', `- [\`RedisResource\`](${redisModuleHref}/redisresource.md)`].join('\n') + ); + }); + + test('the marker note leaves the method bullets parseable by the CLI', () => { + const entries = bulletEntries(renderGoItemMarkdown(markerDoc, markerWithFunctions, 'handle', base), 'Methods'); + expect(entries.map((entry) => [entry.name, entry.href])).toEqual([ + ['ExcludeFromManifest', `${redisModuleHref}/resource/excludefrommanifest.md`], + ]); + expect(entries[0].tail.startsWith(' -- ')).toBe(true); + }); + + test('handles that are not markers never carry the marker note', () => { + for (const handle of [redisResource, resourceWithEnvironment, inputCollection]) { + expect(renderGoItemMarkdown(markerDoc, handle, 'handle', base)).not.toContain(GO_MARKER_NOTE); + } + }); +}); + +describe('Go DTO and enum markdown', () => { + test('DTO pages define a struct with json tags and list its fields', () => { + const markdown = renderGoItemMarkdown(redisDoc, redisOptions, 'dto', base); + expect(headingsOutsideFences(markdown)).toEqual(['# RedisOptions', '## Definition', '## Fields']); + expect(markdown).toContain('- Kind: `struct`'); + expect(sectionOf(markdown, 'Definition')).toBe( + [ + '```go', + 'type RedisOptions struct {', + ' Port *float64 `json:"port"`', + ' Modules []RedisMode `json:"modules"`', + ' OnReady func() `json:"onReady"`', + '}', + '```', + ].join('\n') + ); + expect(sectionOf(markdown, 'Fields')).toBe( + [ + '- `Port`: `*float64` `optional` -- The host port.', + `- \`Modules\`: [\`[]RedisMode\`](${redisModuleHref}/redismode.md)`, + '- `OnReady`: `func()` `callback` -- Called when ready.', + ].join('\n') + ); + }); + + test('enum pages define a string type with a const block and list its values', () => { + const markdown = renderGoItemMarkdown(redisDoc, redisMode, 'enum', base); + expect(headingsOutsideFences(markdown)).toEqual(['# RedisMode', '## Definition', '## Values']); + expect(markdown).toContain('- Kind: `enum`'); + expect(sectionOf(markdown, 'Definition')).toBe( + [ + '```go', + 'type RedisMode string', + '', + 'const (', + ' RedisModeStandalone RedisMode = "Standalone"', + ' RedisModeCluster RedisMode = "Cluster"', + ')', + '```', + ].join('\n') + ); + expect(sectionOf(markdown, 'Values')).toBe( + ['- `RedisModeStandalone` = `"Standalone"` -- A single node.', '- `RedisModeCluster` = `"Cluster"`'].join('\n') + ); + }); +}); + +describe('Go standalone function markdown', () => { + test('defines a method-style function on its receiver and documents parameters, options and returns', () => { + const markdown = renderGoItemMarkdown(redisDoc, addRedis, 'function', base); + expect(headingsOutsideFences(markdown)).toEqual([ + '# AddRedis', + '## Definition', + '## Parameters', + '## Options', + '## Returns', + '## Applies to', + ]); + expect(markdown).toContain('- Kind: `method`'); + expect(markdown).toContain('- Defined on: `DistributedApplicationBuilder`'); + expect(sectionOf(markdown, 'Definition')).toBe( + [ + '```go', + 'func (DistributedApplicationBuilder) AddRedis(', + ' name string,', + ' options ...*AddRedisOptions,', + ') RedisResource', + '```', + ].join('\n') + ); + expect(sectionOf(markdown, 'Parameters')).toBe( + [ + '- `name` (`string`) -- The resource name.', + '- `options` (`...*AddRedisOptions`) -- optional settings, see [Options](#options)', + ].join('\n') + ); + expect(sectionOf(markdown, 'Options')).toBe( + [ + 'Optional parameters are passed in a trailing `options ...*AddRedisOptions` argument.', + '', + '- `Port` (`*float64`) -- The host port.', + `- \`Mode\` ([\`*RedisMode\`](${redisModuleHref}/redismode.md))`, + ].join('\n') + ); + expect(sectionOf(markdown, 'Returns')).toBe( + [ + `[\`RedisResource\`](${redisModuleHref}/redisresource.md) -- A builder for the Redis resource.`, + '', + 'Returns a handle; failures surface later via `Err()`.', + ].join('\n') + ); + expect(sectionOf(markdown, 'Applies to')).toBe('- `DistributedApplicationBuilder`'); + }); + + test('links the receiver and applies-to types that live in the same module', () => { + const markdown = renderGoItemMarkdown(redisDoc, withModule, 'function', base); + expect(markdown).toContain(`- Defined on: [\`RedisResource\`](${redisModuleHref}/redisresource.md)`); + expect(sectionOf(markdown, 'Applies to')).toBe(`- [\`RedisResource\`](${redisModuleHref}/redisresource.md)`); + }); + + test('receiver-less package functions use "func Name" and have no "Defined on"', () => { + const markdown = renderGoItemMarkdown(redisDoc, createRedisBuilder, 'function', base); + expect(markdown).toContain('- Kind: `function`'); + expect(markdown).not.toContain('- Defined on:'); + expect(sectionOf(markdown, 'Definition')).toBe( + '```go\nfunc CreateRedisBuilder() (DistributedApplicationBuilder, error)\n```' + ); + expect(sectionOf(markdown, 'Returns')).toBe( + ['`(DistributedApplicationBuilder, error)`', '', 'Returns `(DistributedApplicationBuilder, error)`.'].join('\n') + ); + }); + + test('a direct options type is referenced as the existing struct', () => { + const markdown = renderGoItemMarkdown(redisDoc, configureRedis, 'function', base); + expect(sectionOf(markdown, 'Options')).toBe( + `Optional parameters are passed as the existing [\`*RedisOptions\`](${redisModuleHref}/redisoptions.md) struct.` + ); + expect(sectionOf(markdown, 'Parameters')).toBe( + '- `options` (`...*RedisOptions`) -- optional settings, see [Options](#options)' + ); + }); +}); + +/* ---- Member pages ------------------------------------------------------ */ + +describe('Go member markdown', () => { + test('documents the definition, signature, parameters and owning handle', () => { + const markdown = renderGoMemberMarkdownPage(redisDoc, redisResource, withModule, base); + expect(markdown.startsWith('# RedisResource.WithModule\n')).toBe(true); + expect(markdown).toContain('- Module: [Aspire.Hosting.Redis](/reference/api/go/aspire.hosting.redis.md)'); + expect(markdown).toContain(`- Defined on: [RedisResource](${redisModuleHref}/redisresource.md)`); + expect(markdown).toContain('- Kind: `method`'); + expect(markdown).toContain('Adds a Redis module.'); + expect(headingsOutsideFences(markdown)).toEqual([ + '# RedisResource.WithModule', + '## Definition', + '## Signature', + '## Parameters', + '## Returns', + '## Defined on', + ]); + expect(sectionOf(markdown, 'Definition')).toBe( + [ + '```go', + 'type RedisResource interface {', + ' // ... omitted for brevity', + ' WithModule(path string) RedisResource', + '}', + '```', + ].join('\n') + ); + expect(sectionOf(markdown, 'Signature')).toBe('```go\nWithModule(path string) RedisResource\n```'); + expect(sectionOf(markdown, 'Parameters')).toBe('- `path` (`string`) -- The module path.'); + expect(sectionOf(markdown, 'Defined on')).toBe(`- [RedisResource](${redisModuleHref}/redisresource.md) -- \`handle\``); + }); + + test('lists optional parameters as an options struct with callback signatures', () => { + const markdown = renderGoMemberMarkdownPage(redisDoc, redisResource, withDataVolume, base); + expect(sectionOf(markdown, 'Parameters')).toBe( + '- `opts` (`...*WithDataVolumeOptions`) -- optional settings, see [Options](#options)' + ); + expect(sectionOf(markdown, 'Options')).toBe( + [ + 'Optional parameters are passed in a trailing `opts ...*WithDataVolumeOptions` argument.', + '', + '- `Name` (`*string`) -- The volume name.', + '- `Configure` (`func(volume Volume) error`) `callback` -- Configures the volume.', + ].join('\n') + ); + }); + + test('wraps multi-parameter signatures one parameter per line', () => { + const markdown = renderGoMemberMarkdownPage(redisDoc, resourceWithEnvironment, withEnvironment, base); + expect(sectionOf(markdown, 'Signature')).toBe( + [ + '```go', + 'WithEnvironment(', + ' name string,', + ' value string,', + ') ResourceWithEnvironment', + '```', + ].join('\n') + ); + expect(sectionOf(markdown, 'Defined on')).toBe( + `- [ResourceWithEnvironment](${redisModuleHref}/resourcewithenvironment.md) -- \`interface\`` + ); + }); + + test.each([ + ['deferred', withModule, 'Returns a handle; failures surface later via `Err()`.'], + ['returned tuple', ping, 'Returns `(bool, error)`.'], + ['error only', close, 'Returns `error`.'], + ['none', count, 'Returns `int`; no error is reported.'], + ] as Array<[string, GoFunction, string]>)('states the %s error model in plain words', (_label, method, sentence) => { + const markdown = renderGoMemberMarkdownPage(redisDoc, redisResource, method, base); + expect(sectionOf(markdown, 'Returns').endsWith(sentence)).toBe(true); + }); + + test('keeps the documented return text next to the return type', () => { + expect(sectionOf(renderGoMemberMarkdownPage(redisDoc, redisResource, ping, base), 'Returns')).toBe( + ['`(bool, error)` -- Whether the server answered.', '', 'Returns `(bool, error)`.'].join('\n') + ); + }); + + test('closes unterminated fences in member remarks', () => { + const noisy: GoFunction = { + ...withModule, + remarks: 'Example:\n\n```go\nredis.WithModule("x")', + }; + const markdown = renderGoMemberMarkdownPage(redisDoc, redisResource, noisy, base); + expect(hasDanglingFence(markdown)).toBe(false); + expect(headingsOutsideFences(markdown)).toContain('## Defined on'); + }); + + test('a marker function is defined with its receiver and lists the types it applies to', () => { + const markdown = renderGoMemberMarkdownPage(markerDoc, markerWithFunctions, excludeFromManifest, base); + expect(headingsOutsideFences(markdown)).toEqual([ + '# Resource.ExcludeFromManifest', + '## Definition', + '## Signature', + '## Returns', + '## Defined on', + '## Applies to', + ]); + expect(sectionOf(markdown, 'Definition')).toBe('```go\nfunc (Resource) ExcludeFromManifest() Resource\n```'); + expect(sectionOf(markdown, 'Signature')).toBe('```go\nExcludeFromManifest() Resource\n```'); + expect(sectionOf(markdown, 'Defined on')).toBe( + [GO_MARKER_NOTE, '', `- [Resource](${redisModuleHref}/resource.md) -- \`marker\``].join('\n') + ); + expect(sectionOf(markdown, 'Applies to')).toBe( + ['- `ContainerResource`', `- [\`RedisResource\`](${redisModuleHref}/redisresource.md)`].join('\n') + ); + expect(markdown).not.toContain('omitted for brevity'); + }); + + test('functions on handles and interfaces that are not markers keep the interface definition', () => { + for (const [parent, method] of [ + [redisResource, withModule], + [resourceWithEnvironment, withEnvironment], + ] as Array<[GoHandleType, GoFunction]>) { + const markdown = renderGoMemberMarkdownPage(markerDoc, parent, method, base); + expect(sectionOf(markdown, 'Definition')).toContain(`type ${parent.name} interface {`); + expect(markdown).not.toContain(GO_MARKER_NOTE); + expect(headingsOutsideFences(markdown)).not.toContain('## Applies to'); + } + }); + + test('prefixes every link with the site base', () => { + const markdown = renderGoMemberMarkdownPage(redisDoc, redisResource, withModule, '/docs/'); + expect(markdown).toContain('- Module: [Aspire.Hosting.Redis](/docs/reference/api/go/aspire.hosting.redis.md)'); + expect(markdown).toContain('- Defined on: [RedisResource](/docs/reference/api/go/aspire.hosting.redis/redisresource.md)'); + }); +}); + +/* ---- Route handlers against the real seed ----------------------------- */ + +type Props = Record; + +function context(props?: Props): Parameters[0] { + return { props } as unknown as Parameters[0]; +} + +async function read(responsePromise: Response | Promise): Promise { + const response = await responsePromise; + expect(response.headers.get('content-type')).toContain('text/markdown'); + return response.text(); +} + +async function moduleProps(moduleSlug: string): Promise { + const route = (await modulePaths()).find(({ params }) => params.module === moduleSlug); + expect(route, `Expected a module route for ${moduleSlug}.`).toBeTruthy(); + return route!.props; +} + +async function itemProps(moduleSlug: string, itemSlug: string): Promise { + const route = (await itemPaths()).find(({ params }) => params.module === moduleSlug && params.item === itemSlug); + expect(route, `Expected an item route for ${moduleSlug}/${itemSlug}.`).toBeTruthy(); + return route!.props; +} + +async function memberProps(moduleSlug: string, itemSlug: string, memberSlug: string): Promise { + const route = (await memberPaths()).find( + ({ params }) => params.module === moduleSlug && params.item === itemSlug && params.member === memberSlug + ); + expect(route, `Expected a member route for ${moduleSlug}/${itemSlug}/${memberSlug}.`).toBeTruthy(); + return route!.props; +} + +describe('Go markdown routes (real seed anchors)', () => { + test('the index route lists modules', async () => { + const markdown = await read(getIndex(context())); + expect(markdown).toContain('# Go API Reference'); + expect(markdown).not.toContain('experimental'); + expect(markdown).toContain('(/reference/api/go/aspire.hosting.redis.md)'); + expect(markdown).not.toMatch(/[·—]/); + }); + + test('the Aspire.Hosting.Redis module route lists its handles, functions and exported values', async () => { + const markdown = await read(getModule(context(await moduleProps('aspire.hosting.redis')))); + expect(markdown).toContain('# Aspire.Hosting.Redis'); + expect(markdown).toContain('- Import path: `apphost/modules/aspire`'); + expect(markdown).not.toContain('experimental'); + expect(markdown).toContain('[RedisResource](/reference/api/go/aspire.hosting.redis/redisresource.md)'); + expect(markdown).toContain('[AddRedis](/reference/api/go/aspire.hosting.redis/addredis.md)'); + expect(markdown).toContain('## Exported values'); + expect(markdown).toContain('`RedisModules.'); + }); + + test('CreateBuilder is a receiver-less function that returns (T, error)', async () => { + const markdown = await read(getItem(context(await itemProps('aspire.hosting', 'createbuilder')))); + expect(markdown).toContain('# CreateBuilder'); + expect(markdown).toContain('- Kind: `function`'); + expect(markdown).toContain('```go\nfunc CreateBuilder('); + expect(markdown).toMatch(/Returns `\(DistributedApplicationBuilder, error\)`\./); + }); + + test('AddRedis is a deferred method on the application builder', async () => { + const markdown = await read(getItem(context(await itemProps('aspire.hosting.redis', 'addredis')))); + expect(markdown).toContain('# AddRedis'); + expect(markdown).toContain('- Kind: `method`'); + expect(markdown).toContain('func (DistributedApplicationBuilder) AddRedis('); + expect(markdown).toContain('Returns a handle; failures surface later via `Err()`.'); + expect(markdown).toContain('## Options'); + }); + + test('RedisResource lists properties, methods that link to member pages, and embedded interfaces', async () => { + const markdown = await read(getItem(context(await itemProps('aspire.hosting.redis', 'redisresource')))); + expect(markdown).toContain('# RedisResource'); + expect(markdown).toContain('```go\ntype RedisResource interface {'); + expect(markdown).toContain('## Embeds'); + expect(markdown).toContain('## Properties'); + expect(markdown).toContain('## Methods'); + expect(markdown).toContain('(/reference/api/go/aspire.hosting.redis/redisresource/withmodule.md)'); + }); + + test('InteractionInputCollection lists its synthesized helpers without pages', async () => { + const markdown = await read(getItem(context(await itemProps('aspire.hosting', 'interactioninputcollection')))); + expect(markdown).toContain('## Methods'); + expect(markdown).toMatch(/^- `Get` -- `method`/m); + expect(markdown).not.toContain('/interactioninputcollection/get.md'); + }); + + test('CertificateTrustScope is rendered as a string type with a const block', async () => { + const markdown = await read(getItem(context(await itemProps('aspire.hosting', 'certificatetrustscope')))); + expect(markdown).toContain('- Kind: `enum`'); + expect(markdown).toContain('```go\ntype CertificateTrustScope string\n\nconst ('); + expect(markdown).toContain('CertificateTrustScope = "Append"'); + expect(markdown).toContain('## Values'); + }); + + test('the WithModule member route documents the method on RedisResource', async () => { + const markdown = await read( + getMember(context(await memberProps('aspire.hosting.redis', 'redisresource', 'withmodule'))) + ); + expect(markdown).toContain('# RedisResource.WithModule'); + expect(markdown).toContain('## Signature'); + expect(markdown).toContain('- Defined on: [RedisResource](/reference/api/go/aspire.hosting.redis/redisresource.md)'); + expect(markdown).toContain('Returns a handle; failures surface later via `Err()`.'); + }); + + test('the Aspire.Hosting Resource marker presents its functions as applicability metadata', async () => { + const page = await read(getItem(context(await itemProps('aspire.hosting', 'resource')))); + expect(sectionOf(page, 'Definition')).toBe('```go\ntype Resource interface{}\n```'); + expect(sectionOf(page, 'Methods').startsWith(`${GO_MARKER_NOTE}\n\n- [`)).toBe(true); + expect(headingsOutsideFences(page)).toContain('## Applies to'); + + const memberRoutes = (await memberPaths()).filter( + ({ params }) => params.module === 'aspire.hosting' && params.item === 'resource' + ); + expect(memberRoutes.length).toBeGreaterThan(0); + for (const { props } of memberRoutes) { + const markdown = await read(getMember(context(props))); + expect(sectionOf(markdown, 'Definition').startsWith('```go\nfunc (Resource) ')).toBe(true); + expect(sectionOf(markdown, 'Defined on').startsWith(GO_MARKER_NOTE)).toBe(true); + } + }); +}); + +describe('Go markdown pages across the whole seed', () => { + test('every page has balanced code fences and links only to existing routes', async () => { + const modules = await modulePaths(); + const items = await itemPaths(); + const members = await memberPaths(); + + const validPaths = new Set(['/reference/api/go.md']); + for (const { params } of modules) validPaths.add(`/reference/api/go/${params.module}.md`); + for (const { params } of items) validPaths.add(`/reference/api/go/${params.module}/${params.item}.md`); + for (const { params } of members) { + validPaths.add(`/reference/api/go/${params.module}/${params.item}/${params.member}.md`); + } + + const pages: Array<[string, string]> = [['index', await read(getIndex(context()))]]; + for (const { params, props } of modules) { + pages.push([`${params.module}`, renderGoModuleMarkdown(props.pkg, base)]); + } + for (const { params, props } of items) { + pages.push([`${params.module}/${params.item}`, renderGoItemMarkdown(props.pkg, props.item, props.itemKind, base)]); + } + for (const { params, props } of members) { + pages.push([ + `${params.module}/${params.item}/${params.member}`, + renderGoMemberMarkdownPage(props.pkg, props.parentType, props.method, base), + ]); + } + + const dangling: string[] = []; + const missingTitle: string[] = []; + const brokenLinks: string[] = []; + let checkedLinks = 0; + for (const [label, markdown] of pages) { + if (hasDanglingFence(markdown)) dangling.push(label); + if (!markdown.startsWith('# ')) missingTitle.push(label); + for (const match of markdown.matchAll(/\]\((\/reference\/api\/go[^)\s]*)\)/g)) { + checkedLinks++; + if (!validPaths.has(match[1])) brokenLinks.push(`${label} -> ${match[1]}`); + } + } + + expect(pages.length).toBeGreaterThan(modules.length + items.length + members.length); + expect(checkedLinks).toBeGreaterThan(pages.length); + expect(dangling).toEqual([]); + expect(missingTitle).toEqual([]); + expect(brokenLinks.slice(0, 10)).toEqual([]); + }); + + test('every exported value renders as a single bullet line without carriage returns', async () => { + const withCarriageReturn: string[] = []; + const notSingleLine: string[] = []; + let checkedValues = 0; + for (const { params, props } of await modulePaths()) { + const markdown = renderGoModuleMarkdown(props.pkg, base); + if (markdown.includes('\r')) withCarriageReturn.push(params.module); + if (!markdown.includes('\n## Exported values\n')) continue; + for (const line of sectionOf(markdown, 'Exported values').split('\n')) { + checkedValues++; + if (!line.startsWith('- ')) notSingleLine.push(`${params.module}: ${line}`); + } + } + + expect(checkedValues).toBeGreaterThan(0); + expect(withCarriageReturn).toEqual([]); + expect(notSingleLine.slice(0, 5)).toEqual([]); + }); +}); diff --git a/src/frontend/tests/unit/go-api-route-catalog.vitest.test.ts b/src/frontend/tests/unit/go-api-route-catalog.vitest.test.ts new file mode 100644 index 0000000000..82bf694e88 --- /dev/null +++ b/src/frontend/tests/unit/go-api-route-catalog.vitest.test.ts @@ -0,0 +1,153 @@ +import { readFileSync, readdirSync } from 'node:fs'; +import { fileURLToPath } from 'node:url'; +import { join } from 'node:path'; +import { expect, test, vi } from 'vitest'; +import type { GoApiDocument } from '@utils/go-modules'; +import { + getGoItemSlug, + getGoMethods, + getGoMethodSlug, + getGoTopLevelRouteItems, + prepareGoApiRoutes, +} from '@utils/go-api-routes'; +import { renderGoItemMarkdown, renderGoModuleMarkdown } from '@utils/go-api-markdown'; +import { getStaticPaths as modulePaths } from '../../src/pages/reference/api/go/[module].md'; +import { getStaticPaths as itemPaths } from '../../src/pages/reference/api/go/[module]/[item].md'; +import { getStaticPaths as memberPaths } from '../../src/pages/reference/api/go/[module]/[item]/[member].md'; + +vi.mock('astro:content', () => ({ + getCollection: () => { + const directory = fileURLToPath(new URL('../../src/data/go-modules/', import.meta.url)); + return Promise.resolve(readdirSync(directory).filter((name) => name.endsWith('.json')).sort().map((file) => { + const data = JSON.parse(readFileSync(join(directory, file), 'utf8')) as GoApiDocument; + prepareGoApiRoutes(data); + return { id: file, data }; + })); + }, +})); + +function duplicates(values: string[]): string[] { + const seen = new Set(); + const repeated = new Set(); + for (const value of values) { + if (seen.has(value)) repeated.add(value); + seen.add(value); + } + return [...repeated]; +} + +test('every route path is unique across the whole catalog, including a case-insensitive check', async () => { + const modules = await modulePaths(); + const items = await itemPaths(); + const members = await memberPaths(); + const moduleRoutes = modules.map(({ params }) => params.module); + const itemRoutes = items.map(({ params }) => `${params.module}/${params.item}`); + const memberRoutes = members.map(({ params }) => `${params.module}/${params.item}/${params.member}`); + + expect(moduleRoutes.length).toBeGreaterThan(0); + expect(itemRoutes.length).toBeGreaterThan(0); + expect(duplicates(moduleRoutes)).toEqual([]); + expect(duplicates(itemRoutes)).toEqual([]); + expect(duplicates(memberRoutes)).toEqual([]); + + const routePaths = [ + '/reference/api/go/', + ...moduleRoutes.map((route) => `/reference/api/go/${route}/`), + ...itemRoutes.map((route) => `/reference/api/go/${route}/`), + ...memberRoutes.map((route) => `/reference/api/go/${route}/`), + ]; + expect(duplicates(routePaths)).toEqual([]); + expect(duplicates(routePaths.map((route) => route.toLowerCase()))).toEqual([]); + + // Every route segment must be a usable, already-slugified path segment. + for (const route of [...moduleRoutes, ...itemRoutes, ...memberRoutes]) { + expect(route.split('/').every((segment) => /^[a-z0-9][a-z0-9.-]*$/.test(segment)), route).toBe(true); + } + + console.info( + `Go route catalog: ${moduleRoutes.length} modules, ${itemRoutes.length} item routes, ${memberRoutes.length} member routes ` + + `(${routePaths.length} HTML pages including the index, each with a .md twin).` + ); +}); + +test('item and member routes match the slug indexes for every module', async () => { + const modules = await modulePaths(); + const items = await itemPaths(); + const members = await memberPaths(); + const itemRoutes = new Set(items.map(({ params }) => `${params.module}/${params.item}`)); + const memberRoutes = new Set(members.map(({ params }) => `${params.module}/${params.item}/${params.member}`)); + const expectedItems = new Set(); + const expectedMembers = new Set(); + + for (const { props } of modules) { + const doc = props.pkg; + const module = doc.package.name.toLowerCase(); + const topLevel = getGoTopLevelRouteItems(doc); + for (const item of topLevel) { + expectedItems.add(`${module}/${getGoItemSlug(item, topLevel)}`); + } + for (const handle of doc.handleTypes ?? []) { + const itemSlug = getGoItemSlug(handle, topLevel); + const methods = getGoMethods(handle); + for (const method of methods) { + expectedMembers.add(`${module}/${itemSlug}/${getGoMethodSlug(method, methods, handle.name)}`); + } + } + } + + expect([...expectedItems].filter((route) => !itemRoutes.has(route))).toEqual([]); + expect([...itemRoutes].filter((route) => !expectedItems.has(route))).toEqual([]); + expect([...expectedMembers].filter((route) => !memberRoutes.has(route))).toEqual([]); + expect([...memberRoutes].filter((route) => !expectedMembers.has(route))).toEqual([]); +}); + +test('stable anchors resolve to their documented routes', async () => { + const items = await itemPaths(); + const members = await memberPaths(); + const itemRoutes = new Set(items.map(({ params }) => `${params.module}/${params.item}`)); + const memberRoutes = new Set(members.map(({ params }) => `${params.module}/${params.item}/${params.member}`)); + + expect(itemRoutes.has('aspire.hosting/createbuilder')).toBe(true); + expect(itemRoutes.has('aspire.hosting.redis/addredis')).toBe(true); + expect(itemRoutes.has('aspire.hosting.redis/redisresource')).toBe(true); + expect(memberRoutes.has('aspire.hosting.redis/redisresource/withmodule')).toBe(true); + + const createBuilder = items.find(({ params }) => params.module === 'aspire.hosting' && params.item === 'createbuilder'); + expect(createBuilder?.props.itemKind).toBe('function'); + const redisResource = items.find(({ params }) => params.module === 'aspire.hosting.redis' && params.item === 'redisresource'); + expect(redisResource?.props.itemKind).toBe('handle'); +}); + +test('property accessors and options structs do not get routes of their own', async () => { + const items = await itemPaths(); + const members = await memberPaths(); + const memberKinds = new Set(members.map(({ props }) => props.method.kind)); + expect([...memberKinds].filter((kind) => kind !== 'Method' && kind !== 'InstanceMethod')).toEqual([]); + + const itemKinds = new Set(items.map(({ props }) => props.itemKind)); + expect([...itemKinds].filter((kind) => !['handle', 'dto', 'enum', 'function'].includes(kind))).toEqual([]); +}); + +test('Markdown links retain object identity through display sorting and resolve overloaded methods', () => { + const doc: GoApiDocument = { + package: { name: 'Test', importPath: 'apphost/modules/aspire' }, + handleTypes: [ + { name: 'Thing', capabilities: [ + { name: 'Run', kind: 'Method', receiver: 'Thing', parameters: [], signature: 'Run() Thing' }, + { name: 'Run', kind: 'Method', receiver: 'Thing', parameters: [], signature: 'Run() Thing' }, + { name: '!!!', kind: 'Method', receiver: 'Thing', parameters: [] }, + { name: '???', kind: 'Method', receiver: 'Thing', parameters: [] }, + ] }, + { name: 'Thing', capabilities: [] }, + ], + }; + prepareGoApiRoutes(doc); + const markdown = renderGoModuleMarkdown(doc, '/base'); + expect(markdown).toContain('/base/reference/api/go/test/thing-thing.md'); + expect(markdown).toContain('/base/reference/api/go/test/thing-thing-2.md'); + const handle = doc.handleTypes![0]; + const detail = renderGoItemMarkdown(doc, handle, 'handle', '/base'); + expect(detail).toContain('/base/reference/api/go/test/thing-thing/run-thing-noargs.md'); + expect(detail).toContain('/base/reference/api/go/test/thing-thing/run-thing-noargs-2.md'); + expect(detail).toContain('/base/reference/api/go/test/thing-thing/-thing-noargs.md'); +}); diff --git a/src/frontend/tests/unit/go-api-routes-reference.ts b/src/frontend/tests/unit/go-api-routes-reference.ts new file mode 100644 index 0000000000..cdfa44084a --- /dev/null +++ b/src/frontend/tests/unit/go-api-routes-reference.ts @@ -0,0 +1,49 @@ +import type { GoRouteCallableLike, GoTopLevelRouteItemLike } from '@utils/go-api-routes'; + +// Pre-indexing implementation, intentionally confined to the equivalence oracle. +export function referenceSlug( + item: GoTopLevelRouteItemLike, + siblings: GoTopLevelRouteItemLike[], + options?: { parentName?: string }, + countNormalization: () => void = () => {} +): string { + const slugify = (name: string) => { + countNormalization(); + return name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, ''); + }; + const callableDisambiguator = (callable: GoRouteCallableLike, includeTarget: boolean) => { + const parts: string[] = []; + if (options?.parentName) parts.push(options.parentName); + if (includeTarget) { + const lastDot = callable.qualifiedName?.lastIndexOf('.') ?? -1; + const container = lastDot > 0 ? callable.qualifiedName?.slice(0, lastDot) : undefined; + const target = callable.receiver ?? callable.expandedTargetTypes?.[0] ?? callable.targetTypeId ?? container; + if (target) parts.push(target); + } + const types = (callable.parameters ?? []) + .map((parameter) => parameter.callbackSignature ?? parameter.type) + .filter((value): value is string => Boolean(value)); + if (types.length) parts.push(...types); + else parts.push('noargs'); + return parts.map(slugify).filter(Boolean).join('-') + || slugify(callable.signature ?? callable.qualifiedName ?? callable.name); + }; + const disambiguator = (candidate: GoTopLevelRouteItemLike) => { + if (options) return callableDisambiguator(candidate, false); + const callable = Array.isArray(candidate.parameters) + || Array.isArray(candidate.expandedTargetTypes) + || typeof candidate.targetTypeId === 'string' + || typeof candidate.qualifiedName === 'string' + || typeof candidate.signature === 'string'; + return callable ? callableDisambiguator(candidate, true) : slugify(candidate.fullName ?? candidate.name); + }; + const append = (base: string, suffix: string) => suffix ? `${base}-${suffix}` : base; + const base = slugify(item.name); + const conflicts = siblings.filter((candidate) => slugify(candidate.name) === base); + if (conflicts.length <= 1) return base; + const slug = append(base, disambiguator(item)); + const same = conflicts.filter((candidate) => append(base, disambiguator(candidate)) === slug); + if (same.length <= 1) return slug; + const occurrence = same.findIndex((candidate) => candidate === item); + return occurrence > 0 ? `${slug}-${occurrence + 1}` : slug; +} diff --git a/src/frontend/tests/unit/go-api-routes.vitest.test.ts b/src/frontend/tests/unit/go-api-routes.vitest.test.ts new file mode 100644 index 0000000000..4b3b780a60 --- /dev/null +++ b/src/frontend/tests/unit/go-api-routes.vitest.test.ts @@ -0,0 +1,328 @@ +import { expect, test } from 'vitest'; +import { readFileSync, readdirSync } from 'node:fs'; +import { fileURLToPath } from 'node:url'; +import { join } from 'node:path'; +import type { GoApiDocument } from '@utils/go-modules'; +import type { GoRouteCallableLike } from '@utils/go-api-routes'; +import { referenceSlug } from './go-api-routes-reference'; + +import { + getGoItemSlug, + getGoMethodSlug, + getGoMethods, + getGoMemberAnchor, + getGoStandaloneFunctions, + getGoTopLevelRouteItems, + getGoTypeByName, + goSlugify, + prepareGoApiRoutes, +} from '../../src/utils/go-api-routes'; + +test('getGoItemSlug keeps unique names unchanged', () => { + const doc = { + handleTypes: [{ name: 'ContainerResource' }], + functions: [{ name: 'AddRedis', qualifiedName: 'addRedis' }], + }; + + const items = getGoTopLevelRouteItems(doc); + expect(getGoItemSlug(items[0], items)).toBe('containerresource'); + expect(getGoItemSlug(items[1], items)).toBe('addredis'); +}); + +test('goSlugify lowercases and collapses non-alphanumerics', () => { + expect(goSlugify('RedisResource')).toBe('redisresource'); + expect(goSlugify('[]*Foo Bar!')).toBe('foo-bar'); + expect(goSlugify('???')).toBe(''); +}); + +test('indexes preserve collisions, missing identity, repeated references and parent contexts', () => { + const repeated = { name: 'Run!', kind: 'Method', parameters: [{ type: 'Thing' }] }; + const capabilities: GoRouteCallableLike[] = [ + repeated, + { ...repeated, name: 'run?' }, + repeated, + { ...repeated }, + { name: 'run', kind: 'InstanceMethod', parameters: [{ isCallback: true, callbackSignature: 'func(a A) B' }] }, + { name: 'run', kind: 'Method', parameters: [{ type: '[]*Thing' }] }, + { name: 'run', kind: 'Method', parameters: [] }, + { name: '!!!', kind: 'Method', parameters: [] }, + { name: '???', kind: 'Method', parameters: [] }, + ]; + const doc = { + handleTypes: [{ name: 'Parent', capabilities }], + dtoTypes: [{ name: 'same?', fullName: 'A/Same' }, { name: 'SAME!', fullName: 'B/Same' }], + functions: capabilities, + }; + prepareGoApiRoutes(doc); + const items = getGoTopLevelRouteItems(doc); + for (const item of [...items, { ...items[1] }, { name: 'unknown' }]) { + expect(getGoItemSlug(item, items)).toBe(referenceSlug(item, items)); + } + for (const sorted of [false, true]) { + const methods = getGoMethods(doc.handleTypes[0], sorted); + for (const parentName of [undefined, '', 'Parent', 'Other Parent', '???']) { + for (const method of [...methods, { ...methods[0] }, { name: 'outside' }]) { + expect(getGoMethodSlug(method, methods, parentName)).toBe(referenceSlug(method, methods, { parentName })); + } + } + } + expect(getGoMethodSlug(capabilities[3], getGoMethods(doc.handleTypes[0]), 'Parent')).toBe('run-parent-thing-4'); +}); + +test('mutable development inputs are never cached, including nested edits and reordering', () => { + const doc = { + handleTypes: [{ name: 'Parent', capabilities: [ + { name: 'run', kind: 'Method', parameters: [{ type: 'string' }] }, + { name: 'run', kind: 'Method', parameters: [{ type: 'string' }] }, + ] }], + functions: [{ name: 'fn', qualifiedName: 'fn' }], + }; + const handle = doc.handleTypes[0]; + const check = () => { + const items = getGoTopLevelRouteItems(doc); + for (const item of items) expect(getGoItemSlug(item, items)).toBe(referenceSlug(item, items)); + const methods = getGoMethods(handle); + for (const method of methods) expect(getGoMethodSlug(method, methods, handle.name)) + .toBe(referenceSlug(method, methods, { parentName: handle.name })); + }; + check(); + handle.capabilities.reverse(); + handle.capabilities[0].parameters[0].type = 'int'; + handle.name = 'Renamed'; + doc.functions[0].qualifiedName = 'Container.fn'; + doc.functions.push({ name: 'Renamed', qualifiedName: 'renamed' }); + check(); + expect(getGoStandaloneFunctions(doc)).toHaveLength(1); + expect(getGoTypeByName(doc, 'Parent')).toBeUndefined(); + expect(getGoTypeByName(doc, 'Renamed')).toBe(handle); + const shallowFrozen = Object.freeze({ functions: doc.functions }); + getGoTopLevelRouteItems(shallowFrozen); + doc.functions[1].name = 'Edited after shallow freeze'; + expect(getGoTopLevelRouteItems(shallowFrozen)[0].name).toBe('Edited after shallow freeze'); +}); + +test('production collections are reused and cannot silently become stale', () => { + const doc = { handleTypes: [{ name: 'Type', capabilities: [ + { name: 'method', kind: 'Method', parameters: [{ type: 'string' }] }, + ] }], functions: [{ name: 'fn' }] }; + prepareGoApiRoutes(doc); + prepareGoApiRoutes(doc); + expect(getGoTopLevelRouteItems(doc)).toBe(getGoTopLevelRouteItems(doc)); + expect(getGoStandaloneFunctions(doc)).toBe(getGoStandaloneFunctions(doc)); + expect(getGoMethods(doc.handleTypes[0])).toBe(getGoMethods(doc.handleTypes[0])); + expect(getGoMethods(doc.handleTypes[0], true)).toBe(getGoMethods(doc.handleTypes[0], true)); + expect(() => doc.handleTypes[0].capabilities[0].parameters[0].type = 'int').toThrow(); + expect(() => getGoTopLevelRouteItems(doc).reverse()).toThrow(); + expect(() => getGoMethods(doc.handleTypes[0]).push({ name: 'new', kind: 'Method', parameters: [] })).toThrow(); + const replacement = structuredClone(doc); + replacement.handleTypes[0].name = 'New'; + prepareGoApiRoutes(replacement); + expect(getGoTopLevelRouteItems(replacement)).not.toBe(getGoTopLevelRouteItems(doc)); + expect(getGoItemSlug(replacement.handleTypes[0], getGoTopLevelRouteItems(replacement))).toBe('new'); + const mutableWrapper = { capabilities: doc.handleTypes[0].capabilities }; + expect(getGoMethods(mutableWrapper)).toBe(getGoMethods(doc.handleTypes[0])); + mutableWrapper.capabilities = [{ name: 'replacement', kind: 'Method', parameters: [] }]; + expect(getGoMethods(mutableWrapper).map((method) => method.name)).toEqual(['replacement']); +}); + +test('whole catalog URLs and sorted heading anchors match the pre-indexing implementation', () => { + const directory = fileURLToPath(new URL('../../src/data/go-modules/', import.meta.url)); + let routes = 0; + let anchors = 0; + let modules = 0; + for (const file of readdirSync(directory).filter((name) => name.endsWith('.json')).sort()) { + modules++; + const doc = JSON.parse(readFileSync(join(directory, file), 'utf8')) as GoApiDocument; + prepareGoApiRoutes(doc); + const items = getGoTopLevelRouteItems(doc); + expect(items).toEqual([ + ...(doc.handleTypes ?? []), ...(doc.dtoTypes ?? []), ...(doc.enumTypes ?? []), + ...(doc.functions ?? []).filter((fn) => !fn.qualifiedName || !fn.qualifiedName.includes('.')), + ]); + const prefix = `/reference/api/go/${doc.package.name.toLowerCase()}/`; + const expected: string[] = []; + const actual: string[] = []; + for (const item of items) { + expected.push(`${prefix}${referenceSlug(item, items)}/`); + actual.push(`${prefix}${getGoItemSlug(item, items)}/`); + routes++; + } + for (const handle of doc.handleTypes ?? []) { + const expectedItem = referenceSlug(handle, items); + const actualItem = getGoItemSlug(handle, items); + for (const sorted of [false, true]) { + const methods = getGoMethods(handle, sorted); + for (const method of methods) { + const reference = referenceSlug(method, methods, { parentName: handle.name }); + const indexed = getGoMethodSlug(method, methods, handle.name); + expected.push(`${prefix}${expectedItem}/${sorted ? '#' : ''}${reference}${sorted ? '' : '/'}`); + actual.push(`${prefix}${actualItem}/${sorted ? '#' : ''}${indexed}${sorted ? '' : '/'}`); + if (sorted) anchors++; + else routes++; + } + } + for (const property of (handle.capabilities ?? []).filter((member) => member.kind?.startsWith('Property'))) { + expect(getGoMemberAnchor(property.name)).toBe(property.name.toLowerCase().replace(/[^a-z0-9]/g, '-')); + anchors++; + } + } + expect(actual, file).toEqual(expected); + } + expect(modules).toBeGreaterThan(0); + expect(routes).toBeGreaterThan(0); + console.info(`Go catalog equivalence: ${routes} item/member routes and ${anchors} anchors (${routes + modules + 1} HTML pages including module/index pages).`); +}); + +test('route name work grows linearly and repeat lookups do not rescan siblings', () => { + for (const size of [100, 1000, 4000]) { + let reads = 0; + const doc = { dtoTypes: Array.from({ length: size }, (_, i) => ({ + get name() { reads++; return `Type${i}`; }, + })) }; + prepareGoApiRoutes(doc); + const items = getGoTopLevelRouteItems(doc); + reads = 0; + for (let pass = 0; pass < 3; pass++) { + for (const item of items) getGoItemSlug(item, items); + } + expect(reads).toBe(size); + let oldNormalizations = 0; + for (const item of items) referenceSlug(item, items, undefined, () => oldNormalizations++); + expect(oldNormalizations).toBe(size * (size + 1)); + console.info(`Go slug work n=${size}: indexed=${size} name reads (3 passes); old=${oldNormalizations} normalizations (1 pass).`); + } +}); + +test('large collision groups are indexed once per method parent context', () => { + let reads = 0; + const size = 1000; + const handle = { name: 'Parent', capabilities: Array.from({ length: size }, () => ({ + get name() { reads++; return 'run'; }, + kind: 'Method', + parameters: [{ type: 'string' }], + })) }; + prepareGoApiRoutes({ handleTypes: [handle] }); + const methods = getGoMethods(handle); + reads = 0; + for (const parentName of ['Parent', 'Other']) { + for (let pass = 0; pass < 3; pass++) { + methods.forEach((method, i) => { + expect(getGoMethodSlug(method, methods, parentName)) + .toBe(`run-${parentName.toLowerCase()}-string${i > 0 ? `-${i + 1}` : ''}`); + }); + } + } + expect(reads).toBe(size * 2); +}); + +test('getGoItemSlug disambiguates duplicate standalone functions by receiver, then parameters', () => { + const doc = { + functions: [ + { name: 'WithHostPort', receiver: 'PgAdminResource', parameters: [{ type: 'int' }] }, + { name: 'WithHostPort', receiver: 'PgWebResource', parameters: [{ type: 'int' }] }, + { name: 'WithHostPort', receiver: 'RedisResource', parameters: [] }, + { name: 'WithHostPort', receiver: 'RedisResource', parameters: [] }, + { name: 'WithHostPort', receiver: 'RedisResource', parameters: [] }, + ], + }; + + const items = getGoTopLevelRouteItems(doc); + expect(getGoStandaloneFunctions(doc)).toHaveLength(5); + expect(items.map((item) => getGoItemSlug(item, items))).toEqual([ + 'withhostport-pgadminresource-int', + 'withhostport-pgwebresource-int', + 'withhostport-redisresource-noargs', + 'withhostport-redisresource-noargs-2', + 'withhostport-redisresource-noargs-3', + ]); +}); + +test('standalone function disambiguation falls back from receiver to the ATS target', () => { + const doc = { + functions: [ + { name: 'WithThing', receiver: null, expandedTargetTypes: ['Assembly/First'], parameters: [] }, + { name: 'WithThing', receiver: null, targetTypeId: 'Assembly/Second', parameters: [] }, + // A dotted ATS name is property-style, so it never becomes a standalone item. + { name: 'WithThing', receiver: null, qualifiedName: 'Container.Third', parameters: [] }, + { name: 'WithThing', receiver: null, parameters: [] }, + ], + }; + + const items = getGoTopLevelRouteItems(doc); + expect(items.map((item) => getGoItemSlug(item, items))).toEqual([ + 'withthing-assembly-first-noargs', + 'withthing-assembly-second-noargs', + 'withthing-noargs', + ]); +}); + +test('callback parameters disambiguate by their callback signature', () => { + const methods = [ + { name: 'WithCallback', kind: 'Method', parameters: [{ type: 'func', isCallback: true, callbackSignature: 'func(ctx *Context) error' }] }, + { name: 'WithCallback', kind: 'Method', parameters: [{ type: 'func', isCallback: true, callbackSignature: 'func() error' }] }, + ]; + + expect(getGoMethodSlug(methods[0], methods, 'Thing')).toBe('withcallback-thing-func-ctx-context-error'); + expect(getGoMethodSlug(methods[1], methods, 'Thing')).toBe('withcallback-thing-func-error'); +}); + +test('getGoMethodSlug disambiguates overloads by parameter types', () => { + const methods = [ + { name: 'WithPersistence', parameters: [] }, + { name: 'WithPersistence', parameters: [{ type: 'time.Duration' }, { type: 'int' }] }, + ]; + + expect(getGoMethodSlug(methods[0], methods, 'RedisResource')).toBe('withpersistence-redisresource-noargs'); + expect(getGoMethodSlug(methods[1], methods, 'RedisResource')).toBe('withpersistence-redisresource-time-duration-int'); +}); + +test('getGoMethods keeps methods only, in source order unless sorted', () => { + const handle = { + name: 'RedisResource', + capabilities: [ + { name: 'Host', kind: 'PropertyGetter' }, + { name: 'WithPassword', kind: 'Method' }, + { name: 'SetPasswordParameter', kind: 'PropertySetter' }, + { name: 'WithModule', kind: 'InstanceMethod' }, + { name: 'WithDataVolume', kind: 'Method' }, + ], + }; + + expect(getGoMethods(handle).map((method) => method.name)).toEqual(['WithPassword', 'WithModule', 'WithDataVolume']); + expect(getGoMethods(handle, true).map((method) => method.name)).toEqual(['WithDataVolume', 'WithModule', 'WithPassword']); + expect(getGoMethods({})).toEqual([]); +}); + +test('getGoStandaloneFunctions keeps undotted ATS names and drops property-style ones', () => { + const doc = { + functions: [ + { name: 'CreateBuilder' }, + { name: 'AddRedis', qualifiedName: 'addRedis' }, + { name: 'Host', qualifiedName: 'RedisResource.host' }, + { name: 'Run', qualifiedName: 'run' }, + ], + }; + + expect(getGoStandaloneFunctions(doc).map((fn) => fn.name)).toEqual(['CreateBuilder', 'AddRedis', 'Run']); +}); + +test('getGoTypeByName resolves handles before DTOs before enums', () => { + const handle = { name: 'Shared' }; + const dto = { name: 'Shared' }; + const enumType = { name: 'OnlyEnum' }; + const doc = { handleTypes: [handle], dtoTypes: [dto], enumTypes: [enumType] }; + + expect(getGoTypeByName(doc, 'Shared')).toBe(handle); + expect(getGoTypeByName(doc, 'OnlyEnum')).toBe(enumType); + expect(getGoTypeByName(doc, 'Missing')).toBeUndefined(); + + prepareGoApiRoutes(doc); + expect(getGoTypeByName(doc, 'Shared')).toBe(handle); + expect(getGoTypeByName(doc, 'OnlyEnum')).toBe(enumType); + expect(getGoTypeByName(doc, 'Missing')).toBeUndefined(); +}); + +test('getGoMemberAnchor lowercases and replaces non-alphanumerics with single dashes', () => { + expect(getGoMemberAnchor('SetPasswordParameter')).toBe('setpasswordparameter'); + expect(getGoMemberAnchor('Foo_Bar')).toBe('foo-bar'); +}); diff --git a/src/frontend/tests/unit/go-api-search.vitest.test.ts b/src/frontend/tests/unit/go-api-search.vitest.test.ts new file mode 100644 index 0000000000..1dd34274a0 --- /dev/null +++ b/src/frontend/tests/unit/go-api-search.vitest.test.ts @@ -0,0 +1,277 @@ +import { expect, test } from 'vitest'; + +import { buildGoApiSearchIndex } from '../../src/utils/go-api-search'; +import { formatGoApiSearchStats, getGoApiSearchStats } from '../../src/utils/go-api-search-stats'; +import type { GoApiDocument } from '../../src/utils/go-modules'; + +const redisDocument: GoApiDocument = { + package: { + name: 'Aspire.Hosting.Redis', + version: '13.6.0', + language: 'go', + importPath: 'apphost/modules/aspire', + }, + functions: [ + { + name: 'WithDataVolume', + capabilityId: 'Aspire.Hosting.Redis/withDataVolume', + qualifiedName: 'withDataVolume', + kind: 'Method', + receiver: 'RedisResource', + signature: 'WithDataVolume(opts ...*WithDataVolumeOptions) RedisResource', + description: 'Adds a named volume for the data folder to a Redis container resource.', + appliesTo: ['RedisResource'], + options: { + typeName: 'WithDataVolumeOptions', + fields: [{ name: 'Name', type: 'string' }], + }, + returnType: 'RedisResource', + errorModel: 'deferred', + }, + { + name: 'AddRedis', + capabilityId: 'Aspire.Hosting.Redis/addRedis', + qualifiedName: 'addRedis', + kind: 'Method', + receiver: 'DistributedApplicationBuilder', + signature: 'AddRedis(name string) RedisResource', + description: 'Adds a Redis container to the application model.', + parameters: [{ name: 'name', type: 'string' }], + returnType: 'RedisResource', + errorModel: 'deferred', + }, + ], + handleTypes: [ + { + name: 'RedisResource', + fullName: 'Aspire.Hosting.Redis.RedisResource', + kind: 'handle', + capabilities: [ + { + name: 'Host', + kind: 'PropertyGetter', + receiver: 'RedisResource', + signature: 'Host() EndpointReferenceExpression', + description: 'Gets the Host property', + }, + { + name: 'SetPasswordParameter', + kind: 'PropertySetter', + receiver: 'RedisResource', + signature: 'SetPasswordParameter(value ParameterResource) error', + }, + { + name: 'WithDataVolume', + capabilityId: 'Aspire.Hosting.Redis/withDataVolume', + qualifiedName: 'withDataVolume', + kind: 'Method', + receiver: 'RedisResource', + signature: 'WithDataVolume(opts ...*WithDataVolumeOptions) RedisResource', + description: 'Adds a named volume for the data folder to a Redis container resource.', + }, + { + name: 'WithModule', + capabilityId: 'Aspire.Hosting.Redis/withModule', + qualifiedName: 'RedisResource.withModule', + kind: 'InstanceMethod', + receiver: 'RedisResource', + signature: 'WithModule(module string) RedisResource', + description: 'Loads a Redis module.', + parameters: [{ name: 'module', type: 'string' }], + }, + ], + }, + ], + dtoTypes: [ + { + name: 'RedisModule', + fullName: 'Aspire.Hosting.Redis.RedisModule', + kind: 'dto', + fields: [{ name: 'Name', jsonName: 'name', type: 'string' }], + }, + ], + enumTypes: [ + { + name: 'RedisMode', + fullName: 'Aspire.Hosting.Redis.RedisMode', + kind: 'enum', + members: [ + { name: 'RedisModeStandalone', value: 'Standalone' }, + { name: 'RedisModeCluster', value: 'Cluster' }, + ], + }, + ], +}; + +test('buildGoApiSearchIndex produces canonical hrefs for standalone functions and handle members', () => { + const index = buildGoApiSearchIndex([redisDocument]); + + expect(index).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + n: 'AddRedis', + k: 'method', + t: 'DistributedApplicationBuilder', + h: '/reference/api/go/aspire.hosting.redis/addredis/', + v: '13.6.0', + }), + expect.objectContaining({ + n: 'WithDataVolume', + k: 'method', + t: 'RedisResource', + h: '/reference/api/go/aspire.hosting.redis/withdatavolume/', + v: '13.6.0', + }), + expect.objectContaining({ + n: 'Host', + k: 'property', + t: 'RedisResource', + h: '/reference/api/go/aspire.hosting.redis/redisresource/#host', + m: true, + v: '13.6.0', + }), + expect.objectContaining({ + n: 'SetPasswordParameter', + k: 'property', + h: '/reference/api/go/aspire.hosting.redis/redisresource/#setpasswordparameter', + m: true, + }), + expect.objectContaining({ + n: 'WithModule', + k: 'method', + t: 'RedisResource', + h: '/reference/api/go/aspire.hosting.redis/redisresource/withmodule/', + m: true, + }), + ]) + ); +}); + +test('buildGoApiSearchIndex lists each capability once when a standalone function covers the handle method', () => { + const index = buildGoApiSearchIndex([redisDocument]); + + expect(index.filter((entry) => entry.n === 'WithDataVolume')).toHaveLength(1); +}); + +test('buildGoApiSearchIndex indexes handles, structs and enums with their own kinds', () => { + const index = buildGoApiSearchIndex([redisDocument], '/base/'); + + expect(index).toEqual( + expect.arrayContaining([ + expect.objectContaining({ + n: 'RedisResource', + k: 'handle', + h: '/base/reference/api/go/aspire.hosting.redis/redisresource/', + }), + expect.objectContaining({ + n: 'RedisModule', + k: 'struct', + s: 'Struct with 1 fields', + h: '/base/reference/api/go/aspire.hosting.redis/redismodule/', + }), + expect.objectContaining({ + n: 'RedisMode', + k: 'enum', + s: 'Enum: RedisModeStandalone, RedisModeCluster', + h: '/base/reference/api/go/aspire.hosting.redis/redismode/', + }), + ]) + ); +}); + +test('buildGoApiSearchIndex marks interface handles and keeps the language-specific detail', () => { + const index = buildGoApiSearchIndex([ + { + package: { name: 'Aspire.Hosting', version: '13.6.0' }, + handleTypes: [ + { name: 'ResourceWithEnvironment', isInterface: true }, + { name: 'IResourceMarker', isInterface: true, isMarker: true }, + ], + }, + ]); + + expect(index.find((entry) => entry.n === 'ResourceWithEnvironment')).toMatchObject({ + k: 'interface', + s: 'Handle type (interface)', + }); + expect(index.find((entry) => entry.n === 'IResourceMarker')).toMatchObject({ + k: 'interface', + s: 'Handle type (interface, marker)', + }); +}); + +test('buildGoApiSearchIndex tells same-named standalone functions apart by receiver', () => { + const index = buildGoApiSearchIndex([ + { + package: { name: 'Aspire.Hosting.Redis', version: '13.6.0' }, + functions: [ + { name: 'WithHostPort', kind: 'Method', receiver: 'RedisResource', signature: 'WithHostPort(port int) RedisResource', parameters: [{ name: 'port', type: 'int' }] }, + { name: 'WithHostPort', kind: 'Method', receiver: 'RedisInsightResource', signature: 'WithHostPort(port int) RedisInsightResource', parameters: [{ name: 'port', type: 'int' }] }, + ], + }, + ]); + + expect(index.map((entry) => entry.f)).toEqual([ + 'RedisResource.WithHostPort(port int) RedisResource', + 'RedisInsightResource.WithHostPort(port int) RedisInsightResource', + ]); + expect(new Set(index.map((entry) => entry.h)).size).toBe(2); +}); + +test('buildGoApiSearchIndex handles a standalone function without a receiver', () => { + const index = buildGoApiSearchIndex([ + { + package: { name: 'Aspire.Hosting', version: '13.6.0' }, + functions: [ + { name: 'CreateBuilder', kind: 'Method', signature: 'CreateBuilder() (DistributedApplicationBuilder, error)' }, + ], + }, + ]); + + expect(index).toEqual([ + expect.objectContaining({ + n: 'CreateBuilder', + f: 'CreateBuilder() (DistributedApplicationBuilder, error)', + k: 'function', + h: '/reference/api/go/aspire.hosting/createbuilder/', + }), + ]); + expect(index[0]).not.toHaveProperty('t'); +}); + +test('buildGoApiSearchIndex keeps code spans in summaries and flattens references and links', () => { + const index = buildGoApiSearchIndex([ + { + package: { name: 'Aspire.Hosting', version: '13.6.0' }, + functions: [ + { + name: 'AddThing', + kind: 'Method', + signature: 'AddThing(name string) Thing', + description: + 'Wraps `IResourceBuilder`1` values for {@ats-ref type:IResource}. See [RFC 7239](https://tools.ietf.org/html/rfc7239).', + }, + ], + }, + ]); + + expect(index[0].s).toBe('Wraps `IResourceBuilder` values for `IResource`. See RFC 7239.'); +}); + +test('getGoApiSearchStats counts capabilities from indexed members and properties', () => { + const index = buildGoApiSearchIndex([redisDocument]); + + expect(getGoApiSearchStats(index)).toEqual({ + packageCount: 1, + capabilityCount: 5, + typeCount: 3, + }); + expect(getGoApiSearchStats(index, new Set(['0.0.0']))).toEqual({ + packageCount: 0, + capabilityCount: 0, + typeCount: 0, + }); + expect(formatGoApiSearchStats(getGoApiSearchStats(index))).toBe( + '5 capabilities and 3 types across 1 modules' + ); +}); diff --git a/src/frontend/tests/unit/go-api-sidebar.vitest.test.ts b/src/frontend/tests/unit/go-api-sidebar.vitest.test.ts new file mode 100644 index 0000000000..9377a19ad0 --- /dev/null +++ b/src/frontend/tests/unit/go-api-sidebar.vitest.test.ts @@ -0,0 +1,168 @@ +import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest'; + +const { getCollection } = vi.hoisted(() => ({ + getCollection: vi.fn(), +})); +vi.mock('astro:content', () => ({ getCollection })); + +type SidebarItem = { label: string; link: string } | { + label: string; + collapsed: boolean; + items: SidebarItem[]; +}; + +function links(items: SidebarItem[]): string[] { + return items.flatMap((item) => 'link' in item ? [item.link] : links(item.items)); +} + +const packageName = 'Aspire.Hosting.Redis'; +const modulePath = '/reference/api/go/aspire.hosting.redis/'; + +beforeEach(() => { + vi.resetModules(); + getCollection.mockReset(); +}); + +afterEach(() => { + vi.unstubAllEnvs(); +}); + +test('the global sidebar lists modules without traversing their catalogs', async () => { + const module = (name: string) => ({ + package: { name }, + get handleTypes(): never { throw new Error('Do not expand the module catalog in a sidebar.'); }, + get dtoTypes(): never { throw new Error('Do not expand the module catalog in a sidebar.'); }, + get enumTypes(): never { throw new Error('Do not expand the module catalog in a sidebar.'); }, + get functions(): never { throw new Error('Do not expand the module catalog in a sidebar.'); }, + }); + getCollection.mockResolvedValue([ + { data: module('Aspire.Hosting.Redis') }, + { data: module('Aspire.Hosting') }, + ]); + const { getGoApiReferenceSidebar } = await import('../../src/utils/go-api-sidebar'); + + expect(await getGoApiReferenceSidebar()).toEqual([ + { label: 'Search Go APIs', link: '/reference/api/go/' }, + { label: 'Aspire.Hosting', link: '/reference/api/go/aspire.hosting/' }, + { label: packageName, link: modulePath }, + ]); + expect(getCollection).toHaveBeenCalledTimes(1); + expect(getCollection).toHaveBeenCalledWith('goModules'); +}); + +test('the module overview sidebar links to catalog sections instead of duplicating the catalog', async () => { + const { getGoApiReferenceSidebar } = await import('../../src/utils/go-api-sidebar'); + const sidebar = await getGoApiReferenceSidebar({ + packageName, + headings: [ + { slug: 'handles', text: 'Handles' }, + { slug: 'functions', text: 'Functions' }, + { slug: 'enums', text: 'Enums' }, + ], + }); + + expect(links(sidebar)).toEqual([ + '/reference/api/go/', + modulePath, + `${modulePath}#handles`, + `${modulePath}#functions`, + `${modulePath}#enums`, + ]); + expect(getCollection).not.toHaveBeenCalled(); +}); + +test.each([ + { name: 'RedisResource', slug: 'redisresource', sections: ['properties', 'methods'] }, + { name: 'RedisModule', slug: 'redismodule', sections: ['fields'] }, + { name: 'RedisMode', slug: 'redismode', sections: ['values'] }, + { name: 'AddRedis', slug: 'addredis', sections: ['parameters', 'returns', 'applies-to'] }, + { name: 'EmptyType', slug: 'emptytype', sections: [] }, +])('item sidebar contains only $name and its actual sections', async ({ name, slug, sections }) => { + const { getGoApiReferenceSidebar } = await import('../../src/utils/go-api-sidebar'); + const sidebar = await getGoApiReferenceSidebar({ + packageName, + item: { name, slug }, + headings: sections.map((section) => ({ slug: section, text: section })), + }); + + expect(links(sidebar)).toEqual([ + '/reference/api/go/', + modulePath, + `${modulePath}${slug}/`, + ...sections.map((section) => `${modulePath}${slug}/#${section}`), + ]); + expect(links(sidebar).length).toBeLessThanOrEqual(6); + expect(JSON.stringify(sidebar).length).toBeLessThan(1024); + expect(getCollection).not.toHaveBeenCalled(); +}); + +test('member sidebars preserve the exact parent and overloaded member route slugs', async () => { + const { getGoApiReferenceSidebar } = await import('../../src/utils/go-api-sidebar'); + const item = { name: 'RedisResource', slug: 'redisresource' }; + const member = { name: 'WithModule', slug: 'withmodule-redisresource-string' }; + const headings = [{ slug: 'signature', text: 'Signature' }, { slug: 'defined-on', text: 'Defined on' }]; + const sidebar = await getGoApiReferenceSidebar({ packageName, item, member, headings }); + const parentPath = `${modulePath}${item.slug}/`; + const memberPath = `${parentPath}${member.slug}/`; + + expect(links(sidebar)).toEqual([ + '/reference/api/go/', + modulePath, + parentPath, + memberPath, + `${memberPath}#signature`, + `${memberPath}#defined-on`, + ]); + expect(getCollection).not.toHaveBeenCalled(); +}); + +describe('production sidebars', () => { + beforeEach(() => vi.stubEnv('PROD', true)); + + test('builds the shared module index once', async () => { + getCollection.mockResolvedValue([{ data: { package: { name: packageName } } }]); + const { getGoApiReferenceSidebar } = await import('../../src/utils/go-api-sidebar'); + const first = getGoApiReferenceSidebar(); + expect(getGoApiReferenceSidebar()).toBe(first); + expect(links(await first)).toEqual(['/reference/api/go/', modulePath]); + expect(getCollection).toHaveBeenCalledTimes(1); + }); + + test('keeps local trees isolated without retaining one cache entry per generated page', async () => { + const { getGoApiReferenceSidebar } = await import('../../src/utils/go-api-sidebar'); + const options = { + packageName, + item: { name: 'Resource', slug: 'resource' }, + member: { name: 'Configure', slug: 'configure-string' }, + headings: [{ slug: 'signature', text: 'Signature' }], + }; + const first = getGoApiReferenceSidebar(options); + expect(getGoApiReferenceSidebar(options)).not.toBe(first); + const original = await first; + const snapshot = structuredClone(original); + + const alternate = await getGoApiReferenceSidebar({ + ...options, + member: { name: 'Configure', slug: 'configure-number' }, + }); + const otherItem = await getGoApiReferenceSidebar({ + ...options, + item: { name: 'AnotherResource', slug: 'anotherresource' }, + }); + const otherModule = await getGoApiReferenceSidebar({ + ...options, + packageName: 'Aspire.Hosting', + }); + const module = await getGoApiReferenceSidebar({ packageName, headings: [] }); + + expect(original).toEqual(snapshot); + expect(alternate).not.toBe(original); + expect(otherItem).not.toBe(original); + expect(otherModule).not.toBe(original); + expect(module).not.toBe(original); + expect(links(alternate)).toContain(`${modulePath}resource/configure-number/`); + expect(links(otherItem)).toContain(`${modulePath}anotherresource/configure-string/`); + expect(links(otherModule)).toContain('/reference/api/go/aspire.hosting/resource/configure-string/'); + expect(getCollection).not.toHaveBeenCalled(); + }); +}); diff --git a/src/frontend/tests/unit/go-doc-refs.vitest.test.ts b/src/frontend/tests/unit/go-doc-refs.vitest.test.ts new file mode 100644 index 0000000000..839be9d6e3 --- /dev/null +++ b/src/frontend/tests/unit/go-doc-refs.vitest.test.ts @@ -0,0 +1,102 @@ +import { describe, expect, test } from 'vitest'; + +import { getGoItemSlug, getGoTopLevelRouteItems } from '@utils/go-api-routes'; +import type { GoApiDocumentRouteLike } from '@utils/go-api-routes'; +import { resolveGoDocRef } from '@utils/go-doc-refs'; + +const doc: GoApiDocumentRouteLike = { + functions: [ + { + name: 'WithNodePool', + qualifiedName: 'withNodePool', + kind: 'Method', + receiver: 'KubernetesEnvironmentResource', + }, + { + name: 'WithHostPort', + qualifiedName: 'withHostPort', + kind: 'Method', + receiver: 'RedisResource', + }, + { + name: 'WithHostPort', + qualifiedName: 'withHostPort', + kind: 'Method', + receiver: 'RedisInsightResource', + }, + { + name: 'WithModule', + qualifiedName: 'RedisResource.withModule', + kind: 'InstanceMethod', + receiver: 'RedisResource', + }, + ], + handleTypes: [ + { name: 'Resource', fullName: 'Aspire.Hosting.ApplicationModel.IResource' }, + { name: 'DistributedApplication', fullName: 'Aspire.Hosting.DistributedApplication' }, + { name: 'ResourceBuilder', fullName: 'Aspire.Hosting.ApplicationModel.IResourceBuilder`1' }, + ], + dtoTypes: [ + { + name: 'ReferenceExpression', + fullName: 'Aspire.Hosting.ApplicationModel.ReferenceExpression', + }, + ], + enumTypes: [ + { name: 'ContainerLifetime', fullName: 'Aspire.Hosting.ApplicationModel.ContainerLifetime' }, + ], +}; + +describe('resolveGoDocRef', () => { + test.each([ + ['IResource', 'Resource', 'resource/'], + ['DistributedApplication', 'DistributedApplication', 'distributedapplication/'], + ['ReferenceExpression', 'ReferenceExpression', 'referenceexpression/'], + ['ContainerLifetime', 'ContainerLifetime', 'containerlifetime/'], + ['IResourceBuilder`1', 'ResourceBuilder', 'resourcebuilder/'], + ])('resolves type:%s to the Go page named %s', (target, label, path) => { + expect(resolveGoDocRef(doc, 'type', target)).toEqual({ label, path }); + }); + + test.each([ + ['IHost', 'a type with no Go page'], + ['Resource', 'the Go name instead of the C# name'], + ['', 'an empty target'], + ])('leaves type:%s unresolved for %s', (target) => { + expect(resolveGoDocRef(doc, 'type', target)).toBeUndefined(); + }); + + test('resolves an extension method to its package function', () => { + expect(resolveGoDocRef(doc, 'method', 'KubernetesEnvironmentExtensions.withNodePool')).toEqual({ + label: 'WithNodePool', + path: 'withnodepool/', + }); + }); + + test.each([ + ['ResourceCommandAnnotation.ExecuteCommand', 'an instance member of another class'], + ['RedisBuilderExtensions.withHostPort', 'an overload shared by several receivers'], + ['RedisBuilderExtensions.withModule', 'an instance method that has no page of its own'], + ['KubernetesEnvironmentExtensions.missing', 'an unknown function'], + ['withNodePool', 'a name without an owner'], + ])('leaves method:%s unresolved for %s', (target) => { + expect(resolveGoDocRef(doc, 'method', target)).toBeUndefined(); + }); + + test('does not resolve fields', () => { + expect(resolveGoDocRef(doc, 'field', 'ResourceCommandAnnotation.Name')).toBeUndefined(); + }); + + test('uses the page slug when a function and a type share a name', () => { + const colliding: GoApiDocumentRouteLike = { + functions: [{ name: 'Thing', qualifiedName: 'thing', kind: 'Method', receiver: 'Owner' }], + handleTypes: [{ name: 'Thing', fullName: 'Aspire.Hosting.IThing' }], + }; + const [handle] = colliding.handleTypes ?? []; + + const resolved = resolveGoDocRef(colliding, 'type', 'IThing'); + + expect(resolved?.path).toBe(`${getGoItemSlug(handle, getGoTopLevelRouteItems(colliding))}/`); + expect(resolved?.path).not.toBe('thing/'); + }); +}); diff --git a/src/frontend/tests/unit/go-doc-text-component.vitest.test.ts b/src/frontend/tests/unit/go-doc-text-component.vitest.test.ts new file mode 100644 index 0000000000..aa9a4a41e0 --- /dev/null +++ b/src/frontend/tests/unit/go-doc-text-component.vitest.test.ts @@ -0,0 +1,86 @@ +import { describe, expect, test } from 'vitest'; + +import GoDocText from '@components/api-reference/GoDocText.astro'; +import type { GoApiDocument } from '@utils/go-modules'; +import { normalizeHtml, renderComponent } from './astro-test-utils'; + +// ReadableText inserts hints inside identifiers; drop them so the markup reads as written. +async function render(props: Record): Promise { + const html = await renderComponent(GoDocText, { props }); + return normalizeHtml(html.replace(//g, '')); +} + +const hostingModule: GoApiDocument = { + package: { name: 'Aspire.Hosting' }, + handleTypes: [{ name: 'Resource', fullName: 'Aspire.Hosting.ApplicationModel.IResource' }], +}; + +describe('GoDocText', () => { + test('renders plain text and escapes markup-like text', async () => { + expect(await render({ text: 'Wraps values & more.' })).toBe( + 'Wraps <T> values & more.' + ); + }); + + test('renders inline code as styled code and keeps the spaces around it', async () => { + expect(await render({ text: 'Returns `error`.' })).toBe( + 'Returns error.' + ); + expect(await render({ text: 'Use `a` or `b` here' })).toBe( + 'Use a or b here' + ); + }); + + test('shows a CLR generic arity span without the arity', async () => { + expect(await render({ text: 'Wraps `IResourceBuilder`1` values.' })).toBe( + 'Wraps IResourceBuilder values.' + ); + }); + + test('renders a reference as plain code when no module is given', async () => { + expect(await render({ text: 'See {@ats-ref type:IResource}.' })).toBe( + 'See IResource.' + ); + }); + + test('links a reference to a type of the module, shows its Go name and keeps the text after it', async () => { + const html = await render({ + text: 'The {@ats-ref type:IResource} name.', + module: hostingModule, + base: '/docs', + }); + + expect(html).toBe( + 'The ' + + 'Resource name.' + ); + }); + + test('keeps a reference that the module does not declare as plain code', async () => { + expect(await render({ text: '{@ats-ref type:IHost}', module: hostingModule })).toBe( + 'IHost' + ); + }); + + test('does not nest anchors inside another link but still shows the Go name', async () => { + const html = await render({ + text: '{@ats-ref type:IResource} and [RFC 7239](https://tools.ietf.org/html/rfc7239)', + module: hostingModule, + link: false, + }); + + expect(html).toBe('Resource and RFC 7239'); + }); + + test('opens external links in a new tab without leaking the opener', async () => { + expect(await render({ text: 'See [RFC 7239](https://tools.ietf.org/html/rfc7239).' })).toBe( + 'See RFC 7239.' + ); + }); + + test('leaves a link with an unsupported scheme as text', async () => { + expect(await render({ text: 'Click [here](javascript:alert(1)).' })).toBe( + 'Click [here](javascript:alert(1)).' + ); + }); +}); diff --git a/src/frontend/tests/unit/go-doc-text.vitest.test.ts b/src/frontend/tests/unit/go-doc-text.vitest.test.ts new file mode 100644 index 0000000000..c362bc7c5a --- /dev/null +++ b/src/frontend/tests/unit/go-doc-text.vitest.test.ts @@ -0,0 +1,186 @@ +import { describe, expect, test } from 'vitest'; + +import { + normalizeGoDocMarkdown, + parseGoDocText, + renderGoDocTextHtml, + toSearchGoDocText, + truncateGoDocText, +} from '@utils/go-doc-text'; + +describe('parseGoDocText', () => { + test('keeps plain text as one segment', () => { + expect(parseGoDocText('Adds a Redis resource.')).toEqual([ + { kind: 'text', text: 'Adds a Redis resource.' }, + ]); + }); + + test('turns inline code into a code segment and keeps the text around it', () => { + expect(parseGoDocText('Returns `error`.')).toEqual([ + { kind: 'text', text: 'Returns ' }, + { kind: 'code', text: 'error' }, + { kind: 'text', text: '.' }, + ]); + }); + + test('reads a CLR arity suffix as part of one code span and drops it', () => { + expect(parseGoDocText('Wraps `IResourceBuilder`1` values.')).toEqual([ + { kind: 'text', text: 'Wraps ' }, + { kind: 'code', text: 'IResourceBuilder' }, + { kind: 'text', text: ' values.' }, + ]); + }); + + test('reads a method arity suffix, which uses two backticks, the same way', () => { + expect(parseGoDocText('Use `WithModTidy``1`, `WithModVendor``2`, or `Plain`.')).toEqual([ + { kind: 'text', text: 'Use ' }, + { kind: 'code', text: 'WithModTidy' }, + { kind: 'text', text: ', ' }, + { kind: 'code', text: 'WithModVendor' }, + { kind: 'text', text: ', or ' }, + { kind: 'code', text: 'Plain' }, + { kind: 'text', text: '.' }, + ]); + }); + + test('reads several adjacent code spans separately', () => { + expect(parseGoDocText('`a` and `b`')).toEqual([ + { kind: 'code', text: 'a' }, + { kind: 'text', text: ' and ' }, + { kind: 'code', text: 'b' }, + ]); + }); + + test('leaves a lone backtick as text', () => { + expect(parseGoDocText('A stray ` backtick.')).toEqual([ + { kind: 'text', text: 'A stray ` backtick.' }, + ]); + }); + + test('reads a flattened fence as one code segment, not three empty spans', () => { + expect(parseGoDocText('Example: ``` var x = 1; ``` end')).toEqual([ + { kind: 'text', text: 'Example: ' }, + { kind: 'code', text: 'var x = 1;' }, + { kind: 'text', text: ' end' }, + ]); + }); + + test.each([ + ['{@ats-ref type:Resource}', 'type', 'Resource', 'Resource'], + ['{@ats-ref method:Owner.member}', 'method', 'Owner.member', 'Owner.member'], + ['{@ats-ref field:Thing.value|the value}', 'field', 'Thing.value', 'the value'], + ])('reads %s as a reference', (text, refKind, target, label) => { + expect(parseGoDocText(text)).toEqual([{ kind: 'ref', refKind, target, label }]); + }); + + test('keeps text that follows a reference, such as a possessive', () => { + expect(parseGoDocText("The {@ats-ref type:IResource}'s name")).toEqual([ + { kind: 'text', text: 'The ' }, + { kind: 'ref', refKind: 'type', target: 'IResource', label: 'IResource' }, + { kind: 'text', text: "'s name" }, + ]); + }); + + test('ignores a marker that is not a known reference kind', () => { + expect(parseGoDocText('{@ats-ref other:Thing}')).toEqual([ + { kind: 'text', text: '{@ats-ref other:Thing}' }, + ]); + }); + + test('reads an http(s) markdown link and ignores any other scheme', () => { + expect(parseGoDocText('See [RFC 7239](https://tools.ietf.org/html/rfc7239).')).toEqual([ + { kind: 'text', text: 'See ' }, + { kind: 'link', text: 'RFC 7239', href: 'https://tools.ietf.org/html/rfc7239' }, + { kind: 'text', text: '.' }, + ]); + expect(parseGoDocText('[x](javascript:alert(1))')).toEqual([ + { kind: 'text', text: '[x](javascript:alert(1))' }, + ]); + }); + + test('returns no segments for empty text', () => { + expect(parseGoDocText('')).toEqual([]); + }); +}); + +describe('toSearchGoDocText', () => { + test('keeps code spans, resolves references to their label and unwraps links', () => { + expect( + toSearchGoDocText( + 'Use `error` with {@ats-ref type:Resource} per [RFC](https://example.com/rfc) and `IResourceBuilder`1`.' + ) + ).toBe('Use `error` with `Resource` per RFC and `IResourceBuilder`.'); + }); + + test('leaves plain text unchanged', () => { + expect(toSearchGoDocText('Property on RedisResource (get/set)')).toBe( + 'Property on RedisResource (get/set)' + ); + }); + + test('drops the arity of a method name so the text can be cut and matched', () => { + expect(toSearchGoDocText('Call `WithModTidy``1` first.')).toBe('Call `WithModTidy` first.'); + }); +}); + +describe('truncateGoDocText', () => { + test('returns short text unchanged', () => { + expect(truncateGoDocText('Short `text`.', 160)).toBe('Short `text`.'); + }); + + test('cuts long text and trims the end', () => { + expect(truncateGoDocText('alpha beta gamma', 11)).toBe('alpha beta'); + }); + + test('never leaves half of a code span behind', () => { + expect(truncateGoDocText('Call `WithDataVolume` now', 12)).toBe('Call'); + }); + + test('keeps a complete code span that fits', () => { + expect(truncateGoDocText('Call `Go` now', 9)).toBe('Call `Go`'); + }); +}); + +describe('renderGoDocTextHtml', () => { + test('escapes text and wraps code and references without emitting anchors', () => { + const html = renderGoDocTextHtml( + 'a < b & `xx<y Foo RFC' + ); + expect(html).not.toContain(' { + expect(renderGoDocTextHtml(`say "hi" it's`)).toBe('say "hi" it's'); + }); + + test('escapes the label of a reference', () => { + expect(renderGoDocTextHtml('{@ats-ref type:A|}')).toBe( + '<b>' + ); + }); +}); + +describe('normalizeGoDocMarkdown', () => { + test('rewrites references to code and drops CLR arity', () => { + expect( + normalizeGoDocMarkdown( + 'Wraps `IResourceBuilder`1` for {@ats-ref type:Resource} and {@ats-ref method:A.b|b}.' + ) + ).toBe('Wraps `IResourceBuilder` for `Resource` and `b`.'); + }); + + test('drops the arity of a method name', () => { + expect(normalizeGoDocMarkdown('Call `WithModTidy``1` then `WithModVendor``2`.')).toBe( + 'Call `WithModTidy` then `WithModVendor`.' + ); + }); + + test('keeps markdown code, fences and links as they are', () => { + const text = 'See [RFC](https://example.com/rfc) and `x`.\n\n```go\nvar x = 1\n```'; + expect(normalizeGoDocMarkdown(text)).toBe(text); + }); +}); diff --git a/src/frontend/tests/unit/go-member-card.vitest.test.ts b/src/frontend/tests/unit/go-member-card.vitest.test.ts new file mode 100644 index 0000000000..bfc63e269b --- /dev/null +++ b/src/frontend/tests/unit/go-member-card.vitest.test.ts @@ -0,0 +1,245 @@ +import { describe, expect, test } from 'vitest'; + +import GoMemberCard from '@components/api-reference/GoMemberCard.astro'; +import { renderComponent, normalizeHtml } from './astro-test-utils'; + +// ReadableText inserts hints inside identifiers and Astro scopes every class with a +// generated suffix; drop both so the markup reads as written in the component. +async function render(props: Record): Promise { + const html = await renderComponent(GoMemberCard, { props }); + return normalizeHtml( + html + .replace(//g, '') + .replace(/\s*\bastro-[a-z0-9]+\b/g, '') + .replace(/\sclass=""/g, '') + ); +} + +const addRedis = { + name: 'AddRedis', + description: 'Adds a Redis container resource.', + signature: 'AddRedis(name string, options ...*AddRedisOptions) RedisResource', + parameters: [{ name: 'name', type: 'string', description: 'The resource name.' }], + options: { + typeName: 'AddRedisOptions', + fields: [ + { name: 'Port', type: '*float64', description: 'The host port.' }, + { + name: 'Configure', + type: 'func(cache Redis)', + isCallback: true, + callbackSignature: 'func(cache Redis) error', + description: 'Configures the cache.', + }, + ], + }, + returnType: 'RedisResource', + returns: 'A builder for the Redis resource.', + errorModel: 'deferred', +}; + +describe('GoMemberCard', () => { + test('renders a callable with its kind, description, signature, parameters, options and returns', async () => { + const html = await render({ member: addRedis, variant: 'method' }); + + expect(html).toContain('class="api-kind-pill kind-method"'); + expect(html).toContain('>method'); + expect(html).toContain('AddRedis'); + expect(html).toContain('Adds a Redis container resource.'); + expect(html).toContain('data-language="go"'); + expect(html).toContain('Parameters

'); + expect(html).toContain('The resource name.'); + expect(html).toContain('Options

'); + expect(html).toContain('Returns

'); + expect(html).toContain('A builder for the Redis resource.'); + }); + + test('adds the trailing options struct to the parameters and explains it under Options', async () => { + const html = await render({ member: addRedis }); + + expect(html).toContain('options'); + expect(html).toContain('...*AddRedisOptions'); + expect(html).toContain('Optional settings, described under Options.'); + expect(html).toContain('Optional parameters are passed in a trailing options ...*AddRedisOptions argument.'); + expect(html).toContain('The host port.'); + expect(html).toContain('Configures the cache.'); + }); + + test('shows callback option fields with their callback signature and badge', async () => { + const html = await render({ member: addRedis }); + + expect(html).toContain('func(cache Redis) error'); + expect(html).toContain('callback'); + }); + + test('uses the default opts name when the signature does not name the options parameter', async () => { + const html = await render({ + member: { + name: 'WithDataVolume', + signature: 'WithDataVolume(opts ...*WithDataVolumeOptions) RedisResource', + options: { typeName: 'WithDataVolumeOptions', fields: [{ name: 'Name', type: '*string' }] }, + returnType: 'RedisResource', + errorModel: 'deferred', + }, + }); + + expect(html).toContain('opts ...*WithDataVolumeOptions'); + }); + + test('a direct options type is described as the existing struct', async () => { + const html = await render({ + member: { + name: 'CreateBuilder', + signature: 'CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)', + options: { typeName: 'CreateBuilderOptions', isDirect: true, fields: [] }, + returnType: '(DistributedApplicationBuilder, error)', + errorModel: 'returned', + }, + }); + + expect(html).toContain('Optional parameters are passed as the existing *CreateBuilderOptions struct.'); + expect(html).not.toContain('in a trailing'); + }); + + test.each([ + ['deferred', 'RedisResource', 'Returns a handle; failures surface later via Err().'], + ['returned', '(bool, error)', 'Returns (bool, error).'], + ['returned', 'error', 'Returns error.'], + ['none', 'int', 'Returns int; no error is reported.'], + ])('states the %s error model for %s in plain words', async (errorModel, returnType, sentence) => { + const html = await render({ member: { name: 'Do', signature: 'Do() X', returnType, errorModel } }); + + expect(html).toContain(sentence); + expect(html).toContain('mc-go-error-model'); + }); + + test('omits the Returns section when a callable declares neither a result nor an error model', async () => { + const html = await render({ member: { name: 'Do', signature: 'Do()' } }); + + expect(html).not.toContain('Returns

'); + expect(html).not.toContain('Parameters

'); + expect(html).not.toContain('Options

'); + }); + + test('renders a linked name and the builder badge', async () => { + const html = await render({ + member: { ...addRedis, returnsBuilder: true }, + href: '/reference/api/go/aspire.hosting.redis/addredis/', + }); + + expect(html).toContain(''); + expect(html).toContain('builder'); + }); + + test('a function page can relabel the kind pill', async () => { + const html = await render({ member: addRedis, variant: 'function', kindLabel: 'function' }); + + expect(html).toContain('>function'); + expect(html).not.toContain('>method'); + }); + + test('a property shows its type in the header, both accessor signatures and no callable sections', async () => { + const html = await render({ + member: { + name: 'Port', + signature: 'Port() (*float64, error)', + returnType: '*float64', + description: 'The host port.', + // Callable-only data on a property must not leak into the card. + parameters: [{ name: 'ignored', type: 'string' }], + errorModel: 'returned', + }, + variant: 'property', + badges: ['get', 'set'], + relatedSignatures: ['SetPort(value *float64) error'], + }); + + expect(html).toContain('class="api-kind-pill kind-property"'); + expect(html).toContain('>property'); + expect(html).toContain('*float64'); + expect(html).toContain('get'); + expect(html).toContain('set'); + expect(html).toContain('SetPort'); + expect(html).not.toContain('Parameters

'); + expect(html).not.toContain('Returns

'); + expect(html).not.toContain('mc-go-error-model'); + }); + + test('a struct field has no kind pill or signature and shows its type and modifiers', async () => { + const html = await render({ + member: { name: 'OnReady', returnType: 'func()', signature: 'should not render' }, + variant: 'field', + badges: ['optional', 'callback'], + }); + + expect(html).not.toContain('api-kind-pill'); + expect(html).toContain('func()'); + expect(html).toContain('optional'); + expect(html).toContain('callback'); + expect(html).not.toContain('data-language="go"'); + }); + + test('breaks a long signature onto one parameter per line', async () => { + const html = await renderComponent(GoMemberCard, { + props: { + member: { + name: 'WithEnvironment', + signature: 'WithEnvironment(name string, value string) ResourceWithEnvironment', + }, + }, + }); + + // Expressive Code renders one element per source line. + expect(html.match(/class="ec-line"/g)?.length).toBe(4); + }); + + test('renders code spans in the description, parameters, option fields and returns without raw backticks', async () => { + const html = await render({ + member: { + name: 'WithPort', + description: 'Sets the `Port` option.', + signature: 'WithPort(port int, options ...*WithPortOptions) RedisResource', + parameters: [{ name: 'port', type: 'int', description: 'Use `0` for a random port.' }], + options: { + typeName: 'WithPortOptions', + fields: [{ name: 'Name', type: '*string', description: 'Overrides the `name` annotation.' }], + }, + returnType: 'RedisResource', + returns: 'The `RedisResource` builder.', + errorModel: 'deferred', + }, + }); + + expect(html).toContain('Sets the Port option.'); + expect(html).toContain('Use 0 for a random port.'); + expect(html).toContain('Overrides the name annotation.'); + expect(html).toContain('The RedisResource builder.'); + expect(html).not.toContain('`'); + }); + + test('keeps the space around a code span at the end of a sentence', async () => { + const html = await render({ member: { name: 'Do', signature: 'Do() error', description: 'Returns `error`.' } }); + + expect(html).toContain('Returns error.'); + }); + + test('links references to pages of the module and falls back to code without a module', async () => { + const member = { + name: 'AddRedis', + description: 'Adds a {@ats-ref type:IResource} and a {@ats-ref type:IHost}.', + signature: 'AddRedis() RedisResource', + }; + const module = { + package: { name: 'Aspire.Hosting' }, + handleTypes: [{ name: 'Resource', fullName: 'Aspire.Hosting.ApplicationModel.IResource' }], + }; + + expect(await render({ member, module, base: '/docs' })).toContain( + 'Adds a
' + + 'Resource and a IHost.' + ); + expect(await render({ member })).toContain( + 'Adds a IResource and a IHost.' + ); + }); +}); diff --git a/src/frontend/tests/unit/go-modules-cache.vitest.test.ts b/src/frontend/tests/unit/go-modules-cache.vitest.test.ts new file mode 100644 index 0000000000..57512794c8 --- /dev/null +++ b/src/frontend/tests/unit/go-modules-cache.vitest.test.ts @@ -0,0 +1,45 @@ +import { afterEach, expect, test, vi } from 'vitest'; + +const collection = vi.hoisted(() => ({ + getCollection: vi.fn(), +})); +vi.mock('astro:content', () => collection); + +afterEach(() => { + vi.unstubAllEnvs(); + vi.resetModules(); + collection.getCollection.mockReset(); +}); + +test('production loader prepares route data once while reusing its existing collection promise', async () => { + vi.stubEnv('PROD', true); + vi.resetModules(); + const data = { package: { name: 'Test' }, functions: [{ name: 'Fn' }] }; + collection.getCollection.mockResolvedValue([{ id: 'test', data }]); + const { getGoModules } = await import('@utils/go-modules'); + const { getGoTopLevelRouteItems } = await import('@utils/go-api-routes'); + const [first, second] = await Promise.all([getGoModules(), getGoModules()]); + expect(first).toBe(second); + expect(collection.getCollection).toHaveBeenCalledTimes(1); + expect(collection.getCollection).toHaveBeenCalledWith('goModules'); + expect(Object.isFrozen(data.functions[0])).toBe(true); + expect(getGoTopLevelRouteItems(data)).toBe(getGoTopLevelRouteItems(data)); +}); + +test('development loader reloads mutable documents and sees route edits', async () => { + vi.stubEnv('PROD', false); + vi.resetModules(); + const data = { package: { name: 'Test' }, functions: [{ name: 'Fn' }] }; + collection.getCollection.mockResolvedValue([{ id: 'test', data }]); + const { getGoModules } = await import('@utils/go-modules'); + const { getGoItemSlug, getGoTopLevelRouteItems } = await import('@utils/go-api-routes'); + await getGoModules(); + const before = getGoTopLevelRouteItems(data); + expect(getGoItemSlug(data.functions[0], before)).toBe('fn'); + data.functions[0].name = 'Changed'; + await getGoModules(); + const after = getGoTopLevelRouteItems(data); + expect(after).not.toBe(before); + expect(getGoItemSlug(data.functions[0], after)).toBe('changed'); + expect(collection.getCollection).toHaveBeenCalledTimes(2); +}); diff --git a/src/frontend/tests/unit/go-modules.vitest.test.ts b/src/frontend/tests/unit/go-modules.vitest.test.ts new file mode 100644 index 0000000000..7f13eb3a83 --- /dev/null +++ b/src/frontend/tests/unit/go-modules.vitest.test.ts @@ -0,0 +1,431 @@ +import { describe, expect, test, vi } from 'vitest'; +import { + GO_PACKAGE_FUNCTIONS_GROUP, + buildGoDtoDefinition, + buildGoEnumDefinition, + buildGoFunctionDefinition, + buildGoHandleDefinition, + buildGoHandleMemberDefinition, + buildGoMemberDefinition, + closeUnclosedCodeFences, + countGoHandleMembers, + describeGoErrorModel, + formatGoSignature, + getGoHandleAppliesTo, + getGoImportPaths, + getGoOptionsParameterName, + getGoPropertyValueType, + getGoTypeHref, + goItemHref, + goModuleHref, + goModuleSlug, + groupGoFunctionsByReceiver, + parseGoTypeReference, + type GoApiDocument, + type GoFunction, + type GoHandleType, +} from '@utils/go-modules'; + +vi.mock('astro:content', () => ({ getCollection: vi.fn() })); + +describe('Go error model wording', () => { + test('deferred results are checked later through Err()', () => { + expect(describeGoErrorModel({ errorModel: 'deferred', returnType: 'RedisResource' })).toBe( + 'Returns a handle; failures surface later via `Err()`.' + ); + }); + + test('returned results are reported as a (T, error) tuple', () => { + expect( + describeGoErrorModel({ errorModel: 'returned', returnType: '(DistributedApplicationBuilder, error)' }) + ).toBe('Returns `(DistributedApplicationBuilder, error)`.'); + expect(describeGoErrorModel({ errorModel: 'returned', returnType: 'string' })).toBe( + 'Returns `(string, error)`.' + ); + expect(describeGoErrorModel({ errorModel: 'returned' })).toBe('Returns `(T, error)`.'); + }); + + test('a bare error return type always reads as "Returns `error`"', () => { + expect(describeGoErrorModel({ errorModel: 'returned', returnType: 'error' })).toBe('Returns `error`.'); + expect(describeGoErrorModel({ errorModel: 'none', returnType: 'error' })).toBe('Returns `error`.'); + expect(describeGoErrorModel({ returnType: ' error ' })).toBe('Returns `error`.'); + }); + + test('callables without an error model say that no error is reported', () => { + expect(describeGoErrorModel({ errorModel: 'none', returnType: 'bool' })).toBe( + 'Returns `bool`; no error is reported.' + ); + expect(describeGoErrorModel({ errorModel: 'none' })).toBe('No error is reported.'); + expect(describeGoErrorModel({})).toBe('No error is reported.'); + }); +}); + +describe('closeUnclosedCodeFences', () => { + test('leaves balanced fences and fence-free text alone', () => { + const balanced = 'Intro\n\n```go\nx := 1\n```\n\nOutro'; + expect(closeUnclosedCodeFences(balanced)).toBe(balanced); + expect(closeUnclosedCodeFences('No fences here.')).toBe('No fences here.'); + expect(closeUnclosedCodeFences('')).toBe(''); + }); + + test('closes an odd fence with the same fence length', () => { + expect(closeUnclosedCodeFences('Intro\n```go\nx := 1')).toBe('Intro\n```go\nx := 1\n```'); + expect(closeUnclosedCodeFences('Intro\n````\nx := 1\n\n')).toBe('Intro\n````\nx := 1\n````'); + }); + + test('a shorter fence inside a longer one does not close it', () => { + const nested = '````md\n```go\nx := 1\n```\n````'; + expect(closeUnclosedCodeFences(nested)).toBe(nested); + expect(closeUnclosedCodeFences('````md\n```go\nx := 1\n```')).toBe('````md\n```go\nx := 1\n```\n````'); + }); + + test('normalises CRLF text the same way', () => { + expect(closeUnclosedCodeFences('Intro\r\n```\r\ncode')).toBe('Intro\r\n```\r\ncode\n```'); + }); +}); + +describe('formatGoSignature', () => { + test('keeps empty, parameterless and single-parameter signatures inline', () => { + expect(formatGoSignature('')).toBe(''); + expect(formatGoSignature('Name')).toBe('Name'); + expect(formatGoSignature('Run() error')).toBe('Run() error'); + expect(formatGoSignature('WithModule(path string) RedisResource')).toBe('WithModule(path string) RedisResource'); + expect(formatGoSignature('CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)')).toBe( + 'CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)' + ); + }); + + test('puts every parameter on its own line, with the trailing comma gofmt expects', () => { + expect( + formatGoSignature('WithDataBindMount(source string, opts ...*WithDataBindMountOptions) RedisInsightResource') + ).toBe( + [ + 'WithDataBindMount(', + ' source string,', + ' opts ...*WithDataBindMountOptions,', + ') RedisInsightResource', + ].join('\n') + ); + }); + + test('keeps a tuple return type after the wrapped parameter list', () => { + expect(formatGoSignature('Get(a string, b int) (string, error)')).toBe( + ['Get(', ' a string,', ' b int,', ') (string, error)'].join('\n') + ); + }); + + test('does not split inside callback, map or generic types', () => { + expect(formatGoSignature('WithCallback(name string, cb func(ctx Context, n int) error) Resource')).toBe( + ['WithCallback(', ' name string,', ' cb func(ctx Context, n int) error,', ') Resource'].join('\n') + ); + expect(formatGoSignature('Merge(values map[string]string, extra int) error')).toBe( + ['Merge(', ' values map[string]string,', ' extra int,', ') error'].join('\n') + ); + expect(formatGoSignature('Of[T any](first T, second T) T')).toBe( + ['Of[T any](', ' first T,', ' second T,', ') T'].join('\n') + ); + }); +}); + +describe('Go definition snippets', () => { + test('handle definition embeds its interfaces and lists no members', () => { + expect(buildGoHandleDefinition({ name: 'Resource' })).toBe('type Resource interface{}'); + expect(buildGoHandleDefinition({ name: 'Resource', implementedInterfaces: [] })).toBe('type Resource interface{}'); + expect( + buildGoHandleDefinition({ + name: 'RedisResource', + implementedInterfaces: ['Resource', 'ResourceWithEnvironment'], + }) + ).toBe(['type RedisResource interface {', ' Resource', ' ResourceWithEnvironment', '}'].join('\n')); + }); + + test('DTO definition is a gofmt-aligned struct with json tags', () => { + expect( + buildGoDtoDefinition({ + name: 'CreateBuilderOptions', + fields: [ + { name: 'Args', jsonName: 'args', type: '[]string' }, + { name: 'ProjectDirectory', jsonName: 'projectDirectory', type: '*string' }, + ], + }) + ).toBe( + [ + 'type CreateBuilderOptions struct {', + ' Args []string `json:"args"`', + ' ProjectDirectory *string `json:"projectDirectory"`', + '}', + ].join('\n') + ); + }); + + test('DTO definition falls back to the field name for the tag and to any for the type', () => { + expect(buildGoDtoDefinition({ name: 'Loose', fields: [{ name: 'Value' }] })).toBe( + ['type Loose struct {', ' Value any `json:"Value"`', '}'].join('\n') + ); + expect(buildGoDtoDefinition({ name: 'Empty' })).toBe('type Empty struct{}'); + expect(buildGoDtoDefinition({ name: 'Empty', fields: [] })).toBe('type Empty struct{}'); + }); + + test('enum definition is a string type plus a const block of the Go constant names', () => { + expect( + buildGoEnumDefinition({ + name: 'CertificateTrustScope', + members: [ + { name: 'CertificateTrustScopeNone', value: 'None' }, + { name: 'CertificateTrustScopeAppend', value: 'Append' }, + ], + }) + ).toBe( + [ + 'type CertificateTrustScope string', + '', + 'const (', + ' CertificateTrustScopeNone CertificateTrustScope = "None"', + ' CertificateTrustScopeAppend CertificateTrustScope = "Append"', + ')', + ].join('\n') + ); + }); + + test('enum values are emitted as escaped Go string literals', () => { + expect(buildGoEnumDefinition({ name: 'Quote', members: [{ name: 'QuoteOdd', value: 'a"b\\c' }] })).toBe( + ['type Quote string', '', 'const (', ' QuoteOdd Quote = "a\\"b\\\\c"', ')'].join('\n') + ); + expect(buildGoEnumDefinition({ name: 'Nothing' })).toBe('type Nothing string'); + }); + + test('function definition uses the receiver type, or none for package functions', () => { + expect( + buildGoFunctionDefinition({ + name: 'AddRedis', + receiver: 'DistributedApplicationBuilder', + signature: 'AddRedis(name string, options ...*AddRedisOptions) RedisResource', + }) + ).toBe( + [ + 'func (DistributedApplicationBuilder) AddRedis(', + ' name string,', + ' options ...*AddRedisOptions,', + ') RedisResource', + ].join('\n') + ); + expect( + buildGoFunctionDefinition({ + name: 'CreateBuilder', + receiver: null, + signature: 'CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)', + }) + ).toBe('func CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)'); + expect(buildGoFunctionDefinition({ name: 'Bare' })).toBe('func Bare()'); + }); + + test('member definition shows the method inside its parent interface', () => { + expect(buildGoMemberDefinition('RedisResource', { name: 'WithModule', signature: 'WithModule(path string) RedisResource' })).toBe( + ['type RedisResource interface {', ' // ... omitted for brevity', ' WithModule(path string) RedisResource', '}'].join('\n') + ); + expect( + buildGoMemberDefinition('RedisResource', { + name: 'WithPassword', + signature: 'WithPassword(password ParameterResource, opts ...*WithPasswordOptions) RedisResource', + }) + ).toBe( + [ + 'type RedisResource interface {', + ' // ... omitted for brevity', + ' WithPassword(', + ' password ParameterResource,', + ' opts ...*WithPasswordOptions,', + ' ) RedisResource', + '}', + ].join('\n') + ); + }); + + test('a method page shows a marker function with its receiver instead of inside the empty marker', () => { + const marker = { name: 'Resource', isMarker: true }; + + expect( + buildGoHandleMemberDefinition(marker, { + name: 'ExcludeFromManifest', + receiver: 'Resource', + signature: 'ExcludeFromManifest() Resource', + }) + ).toBe('func (Resource) ExcludeFromManifest() Resource'); + expect( + buildGoHandleMemberDefinition(marker, { + name: 'WithRoleAssignments', + receiver: 'Resource', + signature: 'WithRoleAssignments(target AzureSearchResource, roles []AzureSearchRole) Resource', + }) + ).toBe( + [ + 'func (Resource) WithRoleAssignments(', + ' target AzureSearchResource,', + ' roles []AzureSearchRole,', + ') Resource', + ].join('\n') + ); + }); + + test('a method page keeps the interface fence for handles that are not markers', () => { + const method = { name: 'WithModule', receiver: 'RedisResource', signature: 'WithModule(path string) RedisResource' }; + + expect(buildGoHandleMemberDefinition({ name: 'RedisResource' }, method)).toBe( + buildGoMemberDefinition('RedisResource', method) + ); + expect(buildGoHandleMemberDefinition({ name: 'RedisResource', isMarker: false }, method)).toBe( + ['type RedisResource interface {', ' // ... omitted for brevity', ' WithModule(path string) RedisResource', '}'].join('\n') + ); + }); +}); + +describe('Go grouping and counting helpers', () => { + test('functions are grouped by receiver with package functions first', () => { + const groups = groupGoFunctionsByReceiver([ + { name: 'WithB', receiver: 'B' }, + { name: 'CreateBuilder' }, + { name: 'WithA', receiver: 'A' }, + { name: 'Init', receiver: null }, + { name: 'AddA', receiver: 'A' }, + ]); + + expect([...groups.keys()]).toEqual([GO_PACKAGE_FUNCTIONS_GROUP, 'A', 'B']); + expect(groups.get(GO_PACKAGE_FUNCTIONS_GROUP)?.map((fn) => fn.name)).toEqual(['CreateBuilder', 'Init']); + expect(groups.get('A')?.map((fn) => fn.name)).toEqual(['AddA', 'WithA']); + expect(groups.get('B')?.map((fn) => fn.name)).toEqual(['WithB']); + expect(groupGoFunctionsByReceiver([]).size).toBe(0); + }); + + test('a handle applies to the sorted union of its capabilities appliesTo', () => { + const handle: GoHandleType = { + name: 'ResourceWithEnvironment', + capabilities: [ + { name: 'WithEnvironment', appliesTo: ['RedisResource', 'ContainerResource'] }, + { name: 'WithReference', appliesTo: ['ContainerResource', 'ProjectResource'] }, + { name: 'NoTargets' }, + ], + }; + + expect(getGoHandleAppliesTo(handle)).toEqual(['ContainerResource', 'ProjectResource', 'RedisResource']); + expect(getGoHandleAppliesTo({ name: 'Plain' })).toEqual([]); + }); + + test('member counts merge a getter with its setter and include synthesized helpers', () => { + const capabilities: GoFunction[] = [ + { name: 'Host', kind: 'PropertyGetter' }, + { name: 'Port', kind: 'PropertyGetter' }, + { name: 'SetPort', kind: 'PropertySetter' }, + { name: 'SetToken', kind: 'PropertySetter' }, + { name: 'WithThing', kind: 'Method' }, + { name: 'Start', kind: 'InstanceMethod' }, + ]; + + expect( + countGoHandleMembers({ + name: 'Sample', + capabilities, + synthesizedMembers: [{ name: 'Get' }, { name: 'Required' }], + }) + ).toBe(7); + expect(countGoHandleMembers({ name: 'Marker', isMarker: true })).toBe(0); + }); + + test('import paths are distinct, sorted and tolerate modules without one', () => { + const modules: GoApiDocument[] = [ + { package: { name: 'B', importPath: 'apphost/modules/aspire' } }, + { package: { name: 'A', importPath: 'apphost/modules/aspire' } }, + { package: { name: 'C' } }, + { package: { name: 'D', importPath: 'apphost/modules/other' } }, + ]; + + expect(getGoImportPaths(modules)).toEqual(['apphost/modules/aspire', 'apphost/modules/other']); + expect(getGoImportPaths([])).toEqual([]); + }); +}); + +describe('Go callable helpers', () => { + test('the options parameter name is read from the signature', () => { + expect( + getGoOptionsParameterName({ + signature: 'WithDataVolume(opts ...*WithDataVolumeOptions) RedisResource', + options: { typeName: 'WithDataVolumeOptions' }, + }) + ).toBe('opts'); + expect( + getGoOptionsParameterName({ + signature: 'CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)', + options: { typeName: 'CreateBuilderOptions', isDirect: true }, + }) + ).toBe('options'); + }); + + test('the options parameter name falls back to opts and never matches a longer type name', () => { + expect(getGoOptionsParameterName({})).toBe('opts'); + expect(getGoOptionsParameterName({ signature: 'Run()' , options: { typeName: 'RunOptions' } })).toBe('opts'); + expect( + getGoOptionsParameterName({ + signature: 'Run(extra ...*RunOptionsExtra)', + options: { typeName: 'RunOptions' }, + }) + ).toBe('opts'); + }); + + test('a property value type comes from the setter parameter or the getter return type', () => { + expect(getGoPropertyValueType({ kind: 'PropertySetter', parameters: [{ name: 'value', type: 'string' }] })).toBe('string'); + expect(getGoPropertyValueType({ kind: 'PropertySetter', parameters: [] })).toBeUndefined(); + expect(getGoPropertyValueType({ kind: 'PropertyGetter', returnType: '(*float64, error)' })).toBe('*float64'); + expect(getGoPropertyValueType({ kind: 'PropertyGetter', returnType: 'ReferenceExpression' })).toBe( + 'ReferenceExpression' + ); + expect(getGoPropertyValueType({ kind: 'PropertyGetter', returnType: '(*Dictionary[string, string], error)' })).toBe( + '*Dictionary[string, string]' + ); + expect(getGoPropertyValueType({ kind: 'PropertyGetter' })).toBeUndefined(); + expect(getGoPropertyValueType({ kind: 'PropertyGetter', returnType: ' ' })).toBeUndefined(); + }); + + test('type references resolve only simple pointer, slice and plain identifiers', () => { + expect(parseGoTypeReference('*RedisResource')).toEqual({ prefix: '*', name: 'RedisResource' }); + expect(parseGoTypeReference('[]DistributedApplicationBuilder')).toEqual({ + prefix: '[]', + name: 'DistributedApplicationBuilder', + }); + expect(parseGoTypeReference('[]*Foo')).toEqual({ prefix: '[]*', name: 'Foo' }); + expect(parseGoTypeReference(' string ')).toEqual({ prefix: '', name: 'string' }); + expect(parseGoTypeReference('map[string]string')).toBeUndefined(); + expect(parseGoTypeReference('*List[string]')).toBeUndefined(); + expect(parseGoTypeReference('func(a int) error')).toBeUndefined(); + expect(parseGoTypeReference('(Foo, error)')).toBeUndefined(); + expect(parseGoTypeReference('')).toBeUndefined(); + expect(parseGoTypeReference(undefined)).toBeUndefined(); + }); +}); + +describe('Go links and shared constants', () => { + const doc: GoApiDocument = { + package: { name: 'Aspire.Hosting.Redis' }, + handleTypes: [{ name: 'RedisResource' }], + dtoTypes: [{ name: 'RedisOptions' }], + enumTypes: [{ name: 'RedisMode' }], + functions: [{ name: 'AddRedis' }], + }; + + test('module and item hrefs are lowercase, module-local and honour the base path', () => { + expect(goModuleSlug('Aspire.Hosting.Redis')).toBe('aspire.hosting.redis'); + expect(goModuleHref('', 'Aspire.Hosting.Redis')).toBe('/reference/api/go/aspire.hosting.redis/'); + expect(goModuleHref('/docs/', 'Aspire.Hosting.Redis')).toBe('/docs/reference/api/go/aspire.hosting.redis/'); + expect(goItemHref('', 'Aspire.Hosting.Redis', 'RedisResource')).toBe( + '/reference/api/go/aspire.hosting.redis/redisresource/' + ); + }); + + test('type hrefs resolve handles, DTOs and enums of the same module only', () => { + expect(getGoTypeHref('', doc, 'RedisResource')).toBe('/reference/api/go/aspire.hosting.redis/redisresource/'); + expect(getGoTypeHref('', doc, 'RedisOptions')).toBe('/reference/api/go/aspire.hosting.redis/redisoptions/'); + expect(getGoTypeHref('', doc, 'RedisMode')).toBe('/reference/api/go/aspire.hosting.redis/redismode/'); + expect(getGoTypeHref('', doc, 'ContainerResource')).toBeUndefined(); + expect(getGoTypeHref('/docs', doc, 'RedisResource')).toBe( + '/docs/reference/api/go/aspire.hosting.redis/redisresource/' + ); + }); +}); diff --git a/src/frontend/tests/unit/navigation-preferences.vitest.test.ts b/src/frontend/tests/unit/navigation-preferences.vitest.test.ts index fa60377f0e..ad52df09db 100644 --- a/src/frontend/tests/unit/navigation-preferences.vitest.test.ts +++ b/src/frontend/tests/unit/navigation-preferences.vitest.test.ts @@ -54,6 +54,7 @@ test('restores destination preferences before sidebar initialization without dup for (const [path, language, apiCollapsed, topicCollapsed] of [ ['/reference/api/typescript/', 'csharp', true, false], + ['/reference/api/go/', 'csharp', true, false], ['/get-started/app-host/?aspire-lang=typescript', 'typescript', false, true], ['/reference/api/csharp/', 'typescript', true, false], ] as const) { diff --git a/src/tools/AtsJsonGenerator/BatchGenerateCommand.cs b/src/tools/AtsJsonGenerator/BatchGenerateCommand.cs index d445486249..8fa4ea87e8 100644 --- a/src/tools/AtsJsonGenerator/BatchGenerateCommand.cs +++ b/src/tools/AtsJsonGenerator/BatchGenerateCommand.cs @@ -43,6 +43,8 @@ internal static class BatchGenerateCommand Description = "Source commit SHA.", }; + private static readonly Option s_languageOption = GenerateCommand.CreateLanguageOption(); + public static Command GetCommand() { var command = new Command("batch", "Process multiple ATS dump files or discover packages from an Aspire repo clone.") @@ -53,6 +55,7 @@ public static Command GetCommand() s_versionOption, s_sourceRepoOption, s_sourceCommitOption, + s_languageOption, }; command.SetAction(static parseResult => @@ -63,8 +66,9 @@ public static Command GetCommand() var version = parseResult.GetValue(s_versionOption); var sourceRepo = parseResult.GetValue(s_sourceRepoOption); var sourceCommit = parseResult.GetValue(s_sourceCommitOption); + var language = parseResult.GetValue(s_languageOption)!; - return RunBatch(outputDir, aspireRepo, inputFiles, version, sourceRepo, sourceCommit); + return RunBatch(outputDir, aspireRepo, inputFiles, version, sourceRepo, sourceCommit, language); }); return command; @@ -76,7 +80,8 @@ private static int RunBatch( string[]? inputFiles, string? version, string? sourceRepo, - string? sourceCommit) + string? sourceCommit, + string language) { if (!Directory.Exists(outputDir)) { @@ -125,7 +130,7 @@ private static int RunBatch( { var outputPath = Path.Combine(outputDir, $"{packageName}.json"); var result = GenerateCommand.TransformFile( - path, outputPath, packageName, version, sourceRepo, sourceCommit); + path, outputPath, packageName, version, sourceRepo, sourceCommit, language: language); if (result == 0) { diff --git a/src/tools/AtsJsonGenerator/GenerateCommand.cs b/src/tools/AtsJsonGenerator/GenerateCommand.cs index 03c7ce3d51..c42dff720e 100644 --- a/src/tools/AtsJsonGenerator/GenerateCommand.cs +++ b/src/tools/AtsJsonGenerator/GenerateCommand.cs @@ -1,4 +1,5 @@ using System.CommandLine; +using System.Diagnostics.CodeAnalysis; using System.Text.Encodings.Web; using System.Text.Json; using AtsJsonGenerator.Helpers; @@ -11,6 +12,20 @@ namespace AtsJsonGenerator; /// internal static class GenerateCommand { + internal const string TypeScriptLanguage = "typescript"; + internal const string GoLanguage = "go"; + + // Match the C# packages JSON output: emit characters like `, <, >, ', + and other + // non-ASCII content as their literal UTF-8 bytes rather than \uXXXX escape sequences. + // The output is read by Astro at build time, not embedded in HTML, so the relaxed + // encoder is safe and keeps diffs human-readable. + private static readonly JsonSerializerOptions s_outputSerializerOptions = new() + { + WriteIndented = true, + DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingDefault, + Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, + }; + private static readonly Option s_inputOption = new("--input", "-i") { Required = true, @@ -23,6 +38,8 @@ internal static class GenerateCommand Description = "Path to write the transformed docs-site JSON file.", }; + private static readonly Option s_languageOption = CreateLanguageOption(); + private static readonly Option s_packageNameOption = new("--package-name") { Description = "Package name override. Defaults to inferring from the input file name.", @@ -54,12 +71,29 @@ internal static class GenerateCommand Description = "Accept error diagnostics caused by known ATS scanner defects and report each one. Any other error diagnostic still fails.", }; + /// + /// Creates the --language option. Each command needs its own instance because an option + /// belongs to the command it is added to. + /// + internal static Option CreateLanguageOption() + { + var option = new Option("--language", "-l") + { + Description = $"Language of the docs-site JSON to generate: '{TypeScriptLanguage}' or '{GoLanguage}'.", + DefaultValueFactory = static _ => TypeScriptLanguage, + }; + option.AcceptOnlyFromAmong(TypeScriptLanguage, GoLanguage); + + return option; + } + public static RootCommand GetCommand() { var command = new RootCommand("Transforms 'aspire sdk dump --format json' output into docs-site JSON.") { s_inputOption, s_outputOption, + s_languageOption, s_packageNameOption, s_versionOption, s_sourceRepoOption, @@ -72,6 +106,7 @@ public static RootCommand GetCommand() { var input = parseResult.GetValue(s_inputOption)!; var output = parseResult.GetValue(s_outputOption)!; + var language = parseResult.GetValue(s_languageOption)!; var packageName = parseResult.GetValue(s_packageNameOption); var version = parseResult.GetValue(s_versionOption); var sourceRepo = parseResult.GetValue(s_sourceRepoOption); @@ -80,7 +115,7 @@ public static RootCommand GetCommand() var tolerateKnownScannerDiagnostics = parseResult.GetValue(s_tolerateKnownScannerDiagnosticsOption); return TransformFile( - input, output, packageName, version, sourceRepo, sourceCommit, basePaths, tolerateKnownScannerDiagnostics); + input, output, packageName, version, sourceRepo, sourceCommit, basePaths, tolerateKnownScannerDiagnostics, language); }); return command; @@ -94,7 +129,8 @@ internal static int TransformFile( string? sourceRepo, string? sourceCommit, string[]? basePaths = null, - bool tolerateKnownScannerDiagnostics = false) + bool tolerateKnownScannerDiagnostics = false, + string language = TypeScriptLanguage) { if (!File.Exists(inputPath)) { @@ -113,23 +149,50 @@ internal static int TransformFile( return 1; } + var exitCode = language switch + { + TypeScriptLanguage => WriteTypeScriptPackage( + dump, outputPath, packageName, version, sourceRepo, sourceCommit, basePaths, tolerateKnownScannerDiagnostics), + GoLanguage => WriteGoPackage( + dump, outputPath, packageName, version, sourceRepo, sourceCommit, basePaths, tolerateKnownScannerDiagnostics), + _ => ReportUnsupportedLanguage(language), + }; + + if (exitCode == 0 && tolerateKnownScannerDiagnostics) + { + foreach (var message in KnownScannerDiagnostics.GetToleratedErrors(dump)) + { + Console.WriteLine($"{KnownScannerDiagnostics.ToleratedOutputPrefix} {message}"); + } + } + + return exitCode; + } + + private static int ReportUnsupportedLanguage(string language) + { + Console.Error.WriteLine($"Unsupported language '{language}'. Expected '{TypeScriptLanguage}' or '{GoLanguage}'."); + return 1; + } + + private static int WriteTypeScriptPackage( + AtsDumpRoot dump, + string outputPath, + string packageName, + string? version, + string? sourceRepo, + string? sourceCommit, + string[]? basePaths, + bool tolerateKnownScannerDiagnostics) + { var result = AtsTransformer.Transform( dump, packageName, version, sourceRepo, sourceCommit, tolerateKnownScannerDiagnostics); // Supporting packages contribute scan targets, not APIs owned by this package. foreach (var basePath in basePaths ?? []) { - if (!File.Exists(basePath)) + if (!TryReadBaseModel(basePath, out var baseModel)) { - Console.Error.WriteLine($"Base file not found: {basePath}"); - return 1; - } - - var baseJson = File.ReadAllText(basePath); - var baseModel = JsonSerializer.Deserialize(baseJson); - if (baseModel is null) - { - Console.Error.WriteLine($"Failed to deserialize base file: {basePath}"); return 1; } @@ -150,34 +213,115 @@ internal static int TransformFile( } } - var outputDir = Path.GetDirectoryName(outputPath); - if (!string.IsNullOrEmpty(outputDir) && !Directory.Exists(outputDir)) + var wroteFile = WriteModel(outputPath, result); + + Console.WriteLine($"{(wroteFile ? "Generated" : "Unchanged")}: {outputPath} ({result.Functions.Count} functions, {result.HandleTypes.Count} handles, {result.DtoTypes.Count} DTOs, {result.EnumTypes.Count} enums)"); + + return 0; + } + + private static int WriteGoPackage( + AtsDumpRoot dump, + string outputPath, + string packageName, + string? version, + string? sourceRepo, + string? sourceCommit, + string[]? basePaths, + bool tolerateKnownScannerDiagnostics) + { + // Supporting packages are read first because they decide the names of the types they share with this package. + var baseModels = new List(); + foreach (var basePath in basePaths ?? []) { - Directory.CreateDirectory(outputDir); + if (!TryReadBaseModel(basePath, out var baseModel)) + { + return 1; + } + + baseModels.Add(baseModel); } - var options = new JsonSerializerOptions + var result = GoTransformer.Transform( + dump, packageName, version, sourceRepo, sourceCommit, tolerateKnownScannerDiagnostics, new GoKnownTypes(baseModels)); + + // Supporting packages contribute scan targets, not APIs owned by this package. + foreach (var baseModel in baseModels) { - WriteIndented = true, - DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingDefault, - // Match the C# packages JSON output: emit characters like `, <, >, ', + and other - // non-ASCII content as their literal UTF-8 bytes rather than \uXXXX escape sequences. - // The output is read by Astro at build time, not embedded in HTML, so the relaxed - // encoder is safe and keeps diffs human-readable. - Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, - }; - var wroteFile = StableFileWriter.WriteIfChanged(outputPath, JsonSerializer.Serialize(result, options)); + var baseFuncIds = new HashSet(baseModel.Functions.Select(f => f.CapabilityId), StringComparer.Ordinal); + var baseHandleIds = new HashSet(baseModel.HandleTypes.Select(h => h.FullName), StringComparer.Ordinal); + var baseDtoIds = new HashSet(baseModel.DtoTypes.Select(d => d.FullName), StringComparer.Ordinal); + var baseEnumIds = new HashSet(baseModel.EnumTypes.Select(e => e.FullName), StringComparer.Ordinal); + var baseExportedValueKeys = new HashSet( + baseModel.ExportedValues.SelectMany(g => g.Values.Select(v => GetExportedValueKey(g, v))), + StringComparer.Ordinal); - Console.WriteLine($"{(wroteFile ? "Generated" : "Unchanged")}: {outputPath} ({result.Functions.Count} functions, {result.HandleTypes.Count} handles, {result.DtoTypes.Count} DTOs, {result.EnumTypes.Count} enums)"); + result.Functions.RemoveAll(f => baseFuncIds.Contains(f.CapabilityId)); + result.HandleTypes.RemoveAll(h => baseHandleIds.Contains(h.FullName)); + result.DtoTypes.RemoveAll(d => baseDtoIds.Contains(d.FullName)); + result.EnumTypes.RemoveAll(e => baseEnumIds.Contains(e.FullName)); - if (tolerateKnownScannerDiagnostics) - { - foreach (var message in KnownScannerDiagnostics.GetToleratedErrors(dump)) + // Exported values are grouped by their root name, so a supporting package can own + // individual values of a group that the base package also contributes to. + foreach (var group in result.ExportedValues) { - Console.WriteLine($"{KnownScannerDiagnostics.ToleratedOutputPrefix} {message}"); + group.Values.RemoveAll(v => baseExportedValueKeys.Contains(GetExportedValueKey(group, v))); + } + + result.ExportedValues.RemoveAll(g => g.Values.Count == 0); + + foreach (var handle in result.HandleTypes) + { + handle.Capabilities.RemoveAll(c => baseFuncIds.Contains(c.CapabilityId)); } } + var wroteFile = WriteModel(outputPath, result); + + Console.WriteLine($"{(wroteFile ? "Generated" : "Unchanged")}: {outputPath} ({result.Functions.Count} functions, {result.HandleTypes.Count} handles, {result.DtoTypes.Count} DTOs, {result.EnumTypes.Count} enums)"); + + if (result.SkippedCapabilityIds.Count > 0) + { + // Capabilities that no concrete Go type carries are absent from the generated SDK, so they have no reference page. + Console.WriteLine($"Skipped {result.SkippedCapabilityIds.Count} capabilities without a concrete Go type: {string.Join(", ", result.SkippedCapabilityIds)}"); + } + return 0; } + + private static string GetExportedValueKey(GoExportedValueModel group, GoExportedValueEntryModel entry) => + $"{group.FullName}.{entry.Path}"; + + private static bool TryReadBaseModel(string basePath, [NotNullWhen(true)] out TModel? baseModel) + where TModel : class + { + baseModel = null; + + if (!File.Exists(basePath)) + { + Console.Error.WriteLine($"Base file not found: {basePath}"); + return false; + } + + var baseJson = File.ReadAllText(basePath); + baseModel = JsonSerializer.Deserialize(baseJson); + if (baseModel is null) + { + Console.Error.WriteLine($"Failed to deserialize base file: {basePath}"); + return false; + } + + return true; + } + + private static bool WriteModel(string outputPath, TModel model) + { + var outputDir = Path.GetDirectoryName(outputPath); + if (!string.IsNullOrEmpty(outputDir) && !Directory.Exists(outputDir)) + { + Directory.CreateDirectory(outputDir); + } + + return StableFileWriter.WriteIfChanged(outputPath, JsonSerializer.Serialize(model, s_outputSerializerOptions)); + } } diff --git a/src/tools/AtsJsonGenerator/Helpers/AtsTransformer.cs b/src/tools/AtsJsonGenerator/Helpers/AtsTransformer.cs index 906c979e6e..c6c65b818e 100644 --- a/src/tools/AtsJsonGenerator/Helpers/AtsTransformer.cs +++ b/src/tools/AtsJsonGenerator/Helpers/AtsTransformer.cs @@ -22,20 +22,10 @@ public static TsPackageModel Transform( string? sourceCommit = null, bool tolerateKnownScannerDiagnostics = false) { - var errors = GetErrorDiagnostics(dump) - .Where(message => !tolerateKnownScannerDiagnostics || !KnownScannerDiagnostics.IsInheritedDuplicateCapability(message, dump)) - .ToArray(); - if (errors.Length > 0) - { - throw new InvalidOperationException($"ATS dump contains error diagnostics: {string.Join("; ", errors)}"); - } + ThrowIfErrorDiagnostics(dump, tolerateKnownScannerDiagnostics); sourceRepository = NormalizeSourceRepository(sourceRepository); - - // Fall back to the version from the dump's Packages metadata if not explicitly provided - version ??= dump.Packages - .FirstOrDefault(p => string.Equals(p.Name, packageName, StringComparison.OrdinalIgnoreCase)) - ?.Version; + version = ResolvePackageVersion(dump, packageName, version); // Transform handle types var handleModels = dump.HandleTypes @@ -101,7 +91,31 @@ internal static IEnumerable GetErrorDiagnostics(AtsDumpRoot dump) => .Where(diagnostic => diagnostic.Severity.Equals("Error", StringComparison.OrdinalIgnoreCase)) .Select(diagnostic => diagnostic.Message); - private static string? NormalizeSourceRepository(string? sourceRepository) + /// + /// Fails the transform when the dump carries error diagnostics, apart from the ones + /// attributes to known scanner defects when tolerated. + /// + internal static void ThrowIfErrorDiagnostics(AtsDumpRoot dump, bool tolerateKnownScannerDiagnostics) + { + var errors = GetErrorDiagnostics(dump) + .Where(message => !tolerateKnownScannerDiagnostics || !KnownScannerDiagnostics.IsInheritedDuplicateCapability(message, dump)) + .ToArray(); + if (errors.Length > 0) + { + throw new InvalidOperationException($"ATS dump contains error diagnostics: {string.Join("; ", errors)}"); + } + } + + /// + /// Returns when provided, otherwise the version recorded for the + /// package in the dump's Packages metadata. + /// + internal static string? ResolvePackageVersion(AtsDumpRoot dump, string packageName, string? version) => + version ?? dump.Packages + .FirstOrDefault(p => string.Equals(p.Name, packageName, StringComparison.OrdinalIgnoreCase)) + ?.Version; + + internal static string? NormalizeSourceRepository(string? sourceRepository) { if (string.IsNullOrWhiteSpace(sourceRepository)) { @@ -275,7 +289,7 @@ private static TsEnumTypeModel TransformEnum(AtsDumpEnumType e) /// Treat whitespace-only XML doc strings as missing so they're omitted from /// the output JSON rather than serialized as empty strings. /// - private static string? NormalizeDoc(string? value) + internal static string? NormalizeDoc(string? value) => string.IsNullOrWhiteSpace(value) ? null : value; /// @@ -574,7 +588,7 @@ private static int FindTopLevelComma(string value) /// /// Extract the simple name from a fully-qualified name. /// - private static string SimpleName(string fullName) + internal static string SimpleName(string fullName) { // Handle generic types: don't split inside angle brackets if (fullName.Contains('<')) diff --git a/src/tools/AtsJsonGenerator/Helpers/AtsTypeCategories.cs b/src/tools/AtsJsonGenerator/Helpers/AtsTypeCategories.cs new file mode 100644 index 0000000000..4ed6286739 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/AtsTypeCategories.cs @@ -0,0 +1,18 @@ +namespace AtsJsonGenerator.Helpers; + +/// +/// The Category values the dump emits for an . They are the names of +/// AtsTypeCategory in Aspire.TypeSystem, serialized as strings. +/// +internal static class AtsTypeCategories +{ + public const string Primitive = "Primitive"; + public const string Enum = "Enum"; + public const string Handle = "Handle"; + public const string Dto = "Dto"; + public const string Callback = "Callback"; + public const string Array = "Array"; + public const string List = "List"; + public const string Dict = "Dict"; + public const string Union = "Union"; +} diff --git a/src/tools/AtsJsonGenerator/Helpers/GoKnownTypes.cs b/src/tools/AtsJsonGenerator/Helpers/GoKnownTypes.cs new file mode 100644 index 0000000000..0befcc5e63 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/GoKnownTypes.cs @@ -0,0 +1,67 @@ +using System.Diagnostics.CodeAnalysis; + +namespace AtsJsonGenerator.Helpers; + +/// +/// The types that supporting packages (the core package, for example) already document. The Go SDK is one +/// flat package, so the name a supporting package gave a type is the name that every package built on it uses. +/// +/// +/// A package dump lists only the handles, DTOs and enums that its own assemblies define, so it cannot tell +/// whether a type from another assembly is exported (ILogger becomes Logger) or only a generic +/// constraint (IComputeResource keeps its prefix). The supporting package knows. +/// +internal sealed class GoKnownTypes +{ + private readonly Dictionary _handles = new(StringComparer.Ordinal); + private readonly Dictionary _dtos = new(StringComparer.Ordinal); + private readonly Dictionary _enums = new(StringComparer.Ordinal); + + /// + /// A package that has no supporting packages, such as the core package. + /// + public static GoKnownTypes None { get; } = new([]); + + /// The supporting packages in priority order. The first to declare a type wins. + public GoKnownTypes(IEnumerable supportingModels) + { + foreach (var model in supportingModels) + { + foreach (var handle in model.HandleTypes) + { + _handles.TryAdd(handle.FullName, new GoKnownHandle(handle.Name, handle.IsInterface, HasImplementation: !handle.IsMarker)); + } + + foreach (var dto in model.DtoTypes) + { + _dtos.TryAdd(dto.FullName, dto.Name); + } + + foreach (var enumType in model.EnumTypes) + { + _enums.TryAdd(enumType.FullName, enumType.Name); + } + } + } + + public IEnumerable Handles => _handles.Values; + + public IEnumerable DtoNames => _dtos.Values; + + public IEnumerable EnumNames => _enums.Values; + + public bool TryGetHandle(string typeId, [NotNullWhen(true)] out GoKnownHandle? handle) => + _handles.TryGetValue(AtsTransformer.StripAssemblyPrefix(typeId), out handle); + + public string? GetDtoName(string typeId) => + _dtos.GetValueOrDefault(AtsTransformer.StripAssemblyPrefix(typeId)); + + // A dump identifies an enum as "enum:Full.Name", while a supporting package records the bare full name. + public string? GetEnumName(string typeId) => + _enums.GetValueOrDefault(AtsTransformer.StripAssemblyPrefix(GoNaming.StripEnumPrefix(typeId))); +} + +/// The Go interface name the supporting package gave the type. +/// True when the type is an exported interface, whose name lost its "I" prefix. +/// True when the type has a concrete implementation, which reserves its unexported name too. +internal sealed record GoKnownHandle(string Name, bool IsInterface, bool HasImplementation); diff --git a/src/tools/AtsJsonGenerator/Helpers/GoModels.cs b/src/tools/AtsJsonGenerator/Helpers/GoModels.cs new file mode 100644 index 0000000000..b5b71633e5 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/GoModels.cs @@ -0,0 +1,457 @@ +using System.Text.Json.Serialization; + +namespace AtsJsonGenerator; + +// ════════════════════════════════════════════════════════════════════ +// GO OUTPUT MODELS — serialized to JSON for the docs site +// +// The Go SDK exposes every ATS capability as a method on a generated Go interface, so +// these models describe the Go surface (Go identifiers, Go type syntax, Go error model) +// rather than the ATS surface the TypeScript models describe. +// ════════════════════════════════════════════════════════════════════ + +/// +/// Root model for a Go API package JSON file consumed by the docs site. +/// +internal sealed class GoPackageModel +{ + [JsonPropertyName("package")] + public required GoPackageInfo Package { get; init; } + + /// + /// Every capability the Go SDK emits, including those also listed under a handle's + /// . + /// + [JsonPropertyName("functions")] + public List Functions { get; init; } = []; + + [JsonPropertyName("handleTypes")] + public List HandleTypes { get; init; } = []; + + [JsonPropertyName("dtoTypes")] + public List DtoTypes { get; init; } = []; + + [JsonPropertyName("enumTypes")] + public List EnumTypes { get; init; } = []; + + [JsonPropertyName("exportedValues")] + public List ExportedValues { get; init; } = []; + + /// + /// Capabilities in the dump that the Go SDK does not expose because no concrete Go type carries them. + /// Runtime-provided collection and ReferenceExpression capabilities are expected and not listed. + /// Reported by the generator but never written to the JSON. + /// + [JsonIgnore] + public List SkippedCapabilityIds { get; init; } = []; +} + +/// +/// The values of . +/// +internal static class GoErrorModels +{ + /// The method returns a trailing error. + public const string Returned = "returned"; + + /// The method returns a fluent handle; a failure is stored on it and read with Err(). + public const string Deferred = "deferred"; + + /// The method cannot fail. + public const string None = "none"; +} + +internal sealed class GoPackageInfo +{ + /// + /// The Go SDK emits every type into one flat package regardless of the NuGet package + /// that contributes it, so all modules share this import path. + /// + internal const string SdkImportPath = "apphost/modules/aspire"; + + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("version")] + public string? Version { get; init; } + + [JsonPropertyName("language")] + public string Language => "go"; + + [JsonPropertyName("importPath")] + public string ImportPath => SdkImportPath; + + [JsonPropertyName("sourceRepository")] + public string? SourceRepository { get; init; } + + [JsonPropertyName("sourceCommit")] + public string? SourceCommit { get; init; } +} + +internal sealed class GoFunctionModel +{ + /// + /// The Go method name, for example AddRedis. + /// + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("capabilityId")] + public required string CapabilityId { get; init; } + + /// + /// The ATS qualified name. Names without a '.' are standalone (extension) exports; + /// dotted names are members of a handle type. + /// + [JsonPropertyName("qualifiedName")] + public required string QualifiedName { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } + + [JsonPropertyName("remarks")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Remarks { get; init; } + + [JsonPropertyName("returns")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Returns { get; init; } + + /// + /// The ATS capability kind: Method, InstanceMethod, PropertyGetter or PropertySetter. + /// + [JsonPropertyName("kind")] + public required string Kind { get; init; } + + /// + /// The Go method signature without the func keyword, for example + /// AddRedis(name string, options ...*AddRedisOptions) RedisResource. + /// + [JsonPropertyName("signature")] + public required string Signature { get; init; } + + /// + /// The Go name of the type that declares the method. Absent for package-level functions. + /// + [JsonPropertyName("receiver")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Receiver { get; init; } + + /// + /// Required positional parameters. Optional parameters live in . + /// + [JsonPropertyName("parameters")] + public List Parameters { get; init; } = []; + + [JsonPropertyName("options")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public GoOptionsModel? Options { get; init; } + + /// + /// The Go return clause, for example error, (string, error) or RedisResource. + /// + [JsonPropertyName("returnType")] + public required string ReturnType { get; init; } + + /// + /// True when the method returns the type it was called on, so each concrete type in + /// substitutes its own name for . + /// + [JsonPropertyName("returnsReceiver")] + public bool ReturnsReceiver { get; init; } + + /// + /// How failures surface: returned (the trailing error result), deferred + /// (fluent handle returns; check Err() on the result) or none. + /// + [JsonPropertyName("errorModel")] + public required string ErrorModel { get; init; } + + [JsonPropertyName("returnsBuilder")] + public bool ReturnsBuilder { get; init; } + + [JsonPropertyName("targetTypeId")] + public string? TargetTypeId { get; init; } + + [JsonPropertyName("expandedTargetTypes")] + public List ExpandedTargetTypes { get; init; } = []; + + /// + /// The Go names of the concrete types that expose this method, sorted ordinally. + /// + [JsonPropertyName("appliesTo")] + public List AppliesTo { get; init; } = []; +} + +internal sealed class GoParameterModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("type")] + public required string Type { get; init; } + + [JsonPropertyName("isCallback")] + public bool IsCallback { get; init; } + + [JsonPropertyName("callbackSignature")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? CallbackSignature { get; init; } + + /// + /// For union parameters, the Go types the value may take. The parameter itself is any. + /// + [JsonPropertyName("allowedTypes")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public List? AllowedTypes { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } +} + +/// +/// The trailing variadic options ...*T parameter that carries optional values. +/// +internal sealed class GoOptionsModel +{ + /// + /// The Go struct passed through the variadic parameter. + /// + [JsonPropertyName("typeName")] + public required string TypeName { get; init; } + + /// + /// True when is an existing DTO passed directly; its fields are + /// documented on the DTO and is empty. + /// + [JsonPropertyName("isDirect")] + public bool IsDirect { get; init; } + + [JsonPropertyName("fields")] + public List Fields { get; init; } = []; +} + +internal sealed class GoOptionFieldModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + /// + /// The JSON tag name. Absent for callbacks and cancellation tokens, which are tagged json:"-". + /// + [JsonPropertyName("jsonName")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? JsonName { get; init; } + + [JsonPropertyName("type")] + public required string Type { get; init; } + + [JsonPropertyName("isCallback")] + public bool IsCallback { get; init; } + + [JsonPropertyName("callbackSignature")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? CallbackSignature { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } +} + +internal sealed class GoHandleTypeModel +{ + /// + /// The Go interface name, for example RedisResource. + /// + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("fullName")] + public required string FullName { get; init; } + + [JsonPropertyName("kind")] + public string Kind => "handle"; + + [JsonPropertyName("isInterface")] + public bool IsInterface { get; init; } + + /// + /// True for interface-metadata types that carry no methods of their own in Go; their methods + /// are declared on each concrete type that implements them. + /// + [JsonPropertyName("isMarker")] + public bool IsMarker { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } + + [JsonPropertyName("remarks")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Remarks { get; init; } + + /// + /// The Go interfaces this type implements. Go has no inheritance, so a CLR interface or base class + /// the Go SDK does not expose (IDisposable, an unexported base type) is not listed. + /// + [JsonPropertyName("implementedInterfaces")] + public List ImplementedInterfaces { get; init; } = []; + + /// + /// Capabilities that target this handle type directly. Methods that reach this type through an + /// interface are listed on the function's instead. + /// + [JsonPropertyName("capabilities")] + public List Capabilities { get; init; } = []; + + /// + /// Hand-authored members the Go SDK adds on top of the generated capabilities. + /// + [JsonPropertyName("synthesizedMembers")] + public List SynthesizedMembers { get; init; } = []; +} + +internal sealed class GoSynthesizedMemberModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("signature")] + public required string Signature { get; init; } + + [JsonPropertyName("description")] + public required string Description { get; init; } +} + +internal sealed class GoDtoTypeModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("fullName")] + public required string FullName { get; init; } + + [JsonPropertyName("kind")] + public string Kind => "dto"; + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } + + [JsonPropertyName("remarks")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Remarks { get; init; } + + [JsonPropertyName("fields")] + public List Fields { get; init; } = []; +} + +internal sealed class GoDtoFieldModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("jsonName")] + public required string JsonName { get; init; } + + [JsonPropertyName("type")] + public required string Type { get; init; } + + [JsonPropertyName("isOptional")] + public bool IsOptional { get; init; } + + [JsonPropertyName("isCallback")] + public bool IsCallback { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } +} + +internal sealed class GoEnumTypeModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("fullName")] + public required string FullName { get; init; } + + [JsonPropertyName("kind")] + public string Kind => "enum"; + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } + + [JsonPropertyName("remarks")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Remarks { get; init; } + + [JsonPropertyName("members")] + public List Members { get; init; } = []; +} + +internal sealed class GoEnumMemberModel +{ + /// + /// The Go constant name, for example ContainerLifetimePersistent. + /// + [JsonPropertyName("name")] + public required string Name { get; init; } + + /// + /// The string value the constant holds on the wire. + /// + [JsonPropertyName("value")] + public required string Value { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } + + [JsonPropertyName("remarks")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Remarks { get; init; } +} + +/// +/// A package-level Go variable that groups related constants, such as WellKnownPipelineSteps. +/// +internal sealed class GoExportedValueModel +{ + [JsonPropertyName("name")] + public required string Name { get; init; } + + [JsonPropertyName("fullName")] + public required string FullName { get; init; } + + [JsonPropertyName("kind")] + public string Kind => "exportedValue"; + + [JsonPropertyName("values")] + public List Values { get; init; } = []; +} + +internal sealed class GoExportedValueEntryModel +{ + /// + /// The dotted field path below the group, for example Publish. + /// + [JsonPropertyName("path")] + public required string Path { get; init; } + + [JsonPropertyName("type")] + public required string Type { get; init; } + + /// + /// The value rendered as a Go literal. Values with no scalar Go literal render as JSON text. + /// + [JsonPropertyName("value")] + public required string Value { get; init; } + + [JsonPropertyName("description")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? Description { get; init; } +} diff --git a/src/tools/AtsJsonGenerator/Helpers/GoNaming.cs b/src/tools/AtsJsonGenerator/Helpers/GoNaming.cs new file mode 100644 index 0000000000..bf1d61acc0 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/GoNaming.cs @@ -0,0 +1,105 @@ +using System.Text; + +namespace AtsJsonGenerator.Helpers; + +/// +/// Go identifier rules used by the Go SDK generator (AtsGoCodeGenerator in microsoft/aspire). +/// The documented names must match the generated SDK exactly, so these helpers reproduce the +/// generator's behavior character for character instead of applying general Go conventions. +/// +internal static class GoNaming +{ + private const string EnumPrefix = "enum:"; + + private static readonly HashSet s_goKeywords = new(StringComparer.Ordinal) + { + "break", "case", "chan", "const", "continue", "default", "defer", "else", "fallthrough", + "for", "func", "go", "goto", "if", "import", "interface", "map", "package", "range", + "return", "select", "struct", "switch", "type", "var", + // Predeclared identifiers the generator also treats as reserved. + "any", "true", "false", "nil", "iota" + }; + + /// + /// Extracts the simple type name from an ATS type id such as + /// Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource. Nested types use + /// + as the delimiter, for example Outer+Inner. + /// + public static string ExtractTypeName(string typeId) + { + var slashIndex = typeId.IndexOf('/', StringComparison.Ordinal); + var typeName = slashIndex >= 0 ? typeId[(slashIndex + 1)..] : typeId; + var lastDot = typeName.LastIndexOf('.'); + var plusIndex = typeName.LastIndexOf('+'); + var delimiterIndex = Math.Max(lastDot, plusIndex); + return delimiterIndex >= 0 ? typeName[(delimiterIndex + 1)..] : typeName; + } + + /// + /// Removes the enum: marker from an enum type id (enum:Aspire.Hosting.ApplicationModel.ContainerLifetime), + /// which leaves the full type name that the documented models record for the enum. + /// + public static string StripEnumPrefix(string typeId) => + typeId.StartsWith(EnumPrefix, StringComparison.Ordinal) ? typeId[EnumPrefix.Length..] : typeId; + + public static string SanitizeIdentifier(string name) + { + if (string.IsNullOrWhiteSpace(name)) + { + return "_"; + } + + var builder = new StringBuilder(name.Length); + foreach (var ch in name) + { + builder.Append(char.IsLetterOrDigit(ch) || ch == '_' ? ch : '_'); + } + + if (!char.IsLetter(builder[0]) && builder[0] != '_') + { + builder.Insert(0, '_'); + } + + var sanitized = builder.ToString(); + return s_goKeywords.Contains(sanitized) ? sanitized + "_" : sanitized; + } + + /// + /// The identifier used for a parameter or local variable. + /// + public static string GetLocalIdentifier(string name) => SanitizeIdentifier(ToCamelCase(name)); + + public static string ToPascalCase(string name) + { + if (string.IsNullOrEmpty(name) || char.IsUpper(name[0])) + { + return name; + } + + return char.ToUpperInvariant(name[0]) + name[1..]; + } + + public static string ToCamelCase(string name) + { + if (string.IsNullOrEmpty(name) || char.IsLower(name[0])) + { + return name; + } + + return char.ToLowerInvariant(name[0]) + name[1..]; + } + + /// + /// Drops the .NET I prefix from interface names, for example IResource becomes + /// Resource. Names such as Item or IO are left alone. + /// + public static string StripInterfacePrefix(string name, bool isInterface) + { + if (!isInterface || name.Length < 2 || name[0] != 'I' || !char.IsUpper(name[1])) + { + return name; + } + + return name[1..]; + } +} diff --git a/src/tools/AtsJsonGenerator/Helpers/GoSdkResolver.Types.cs b/src/tools/AtsJsonGenerator/Helpers/GoSdkResolver.Types.cs new file mode 100644 index 0000000000..9981094e88 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/GoSdkResolver.Types.cs @@ -0,0 +1,238 @@ +using System.Text; +using static AtsJsonGenerator.Helpers.GoNaming; + +namespace AtsJsonGenerator.Helpers; + +// Type and signature rendering. These rules reproduce the Go SDK generator's output so the documented +// signatures can be pasted into an AppHost. +internal sealed partial class GoSdkResolver +{ + public string MapTypeRefToGo(AtsDumpTypeRef? typeRef, bool isOptional) + { + if (typeRef is null) + { + return "any"; + } + + if (typeRef.TypeId == ReferenceExpressionTypeId) + { + return "*ReferenceExpression"; + } + + var baseType = typeRef.Category switch + { + AtsTypeCategories.Primitive => MapPrimitiveType(typeRef.TypeId), + AtsTypeCategories.Enum => MapEnumType(typeRef.TypeId), + AtsTypeCategories.Handle => MapHandleType(typeRef.TypeId), + AtsTypeCategories.Dto => "*" + MapDtoType(typeRef.TypeId), + + // The dump records no signature for a callback that is a DTO property, so it can only be shown loosely typed. + AtsTypeCategories.Callback => "func(...any) any", + AtsTypeCategories.Array => $"[]{MapTypeRefToGo(typeRef.ElementType, false)}", + AtsTypeCategories.List => typeRef.IsReadOnly + ? $"[]{MapTypeRefToGo(typeRef.ElementType, false)}" + : $"*List[{MapTypeRefToGo(typeRef.ElementType, false)}]", + AtsTypeCategories.Dict => typeRef.IsReadOnly + ? $"map[{MapTypeRefToGo(typeRef.KeyType, false)}]{MapTypeRefToGo(typeRef.ValueType, false)}" + : $"*Dict[{MapTypeRefToGo(typeRef.KeyType, false)}, {MapTypeRefToGo(typeRef.ValueType, false)}]", + _ => "any" + }; + + if ((isOptional || ShouldApplyNullableType(typeRef)) && !IsNilableGoType(baseType)) + { + return $"*{baseType}"; + } + + return baseType; + } + + /// + /// DTO fields keep collections as plain slices and maps because DTOs are serialized as JSON. + /// + public string MapDtoPropertyTypeToGo(AtsDumpTypeRef? typeRef, bool isOptional) + { + if (typeRef is null) + { + return "any"; + } + + if (typeRef.TypeId == ReferenceExpressionTypeId) + { + return "*ReferenceExpression"; + } + + var baseType = typeRef.Category switch + { + AtsTypeCategories.Array or AtsTypeCategories.List => $"[]{MapDtoPropertyTypeToGo(typeRef.ElementType, false)}", + AtsTypeCategories.Dict => $"map[{MapDtoPropertyTypeToGo(typeRef.KeyType, false)}]{MapDtoPropertyTypeToGo(typeRef.ValueType, false)}", + AtsTypeCategories.Union => "any", + _ => MapTypeRefToGo(typeRef, isOptional: false) + }; + + if (isOptional && !IsNilableGoType(baseType)) + { + return $"*{baseType}"; + } + + return baseType; + } + + public string RenderParameterType(AtsDumpParameter parameter) + { + if (parameter.IsCallback) + { + return RenderCallbackType(parameter); + } + + if (IsCancellationToken(parameter)) + { + return "*CancellationToken"; + } + + return MapTypeRefToGo(parameter.Type, parameter.IsOptional); + } + + /// + /// The type of a field in a generated options struct. Optional values are pointers so an unset field is distinguishable. + /// + public string RenderOptionsFieldType(AtsDumpParameter parameter) + { + if (parameter.IsCallback) + { + return RenderCallbackType(parameter); + } + + if (IsCancellationToken(parameter)) + { + return "*CancellationToken"; + } + + return MapTypeRefToGo(parameter.Type, isOptional: true); + } + + public string RenderCallbackType(AtsDumpParameter parameter) + { + var builder = new StringBuilder("func("); + + if (parameter.CallbackParameters is { Count: > 0 } callbackParameters) + { + builder.AppendJoin(", ", callbackParameters.Select(p => $"{GetLocalIdentifier(p.Name)} {MapTypeRefToGo(p.Type, false)}")); + } + else + { + builder.Append("...any"); + } + + builder.Append(')'); + + var returnType = parameter.CallbackReturnType; + if (returnType is not null && returnType.TypeId != VoidTypeId) + { + builder.Append(' ').Append(MapTypeRefToGo(returnType, false)); + } + else if (parameter.CallbackParameters is null) + { + // Without recorded parameters the callback is only known to be a function, so it is shown with a loosely typed result. + builder.Append(" any"); + } + + return builder.ToString(); + } + + /// + /// The comma-separated parameter list of the Go method: required parameters in order, then the + /// trailing variadic options argument when the capability has optional parameters. + /// + public string RenderParameterList(IReadOnlyList required, GoOptionsInfo? options) + { + var parts = required + .Select(p => $"{GetLocalIdentifier(p.Name)} {RenderParameterType(p)}") + .ToList(); + + if (options is not null) + { + parts.Add($"options ...*{options.TypeName}"); + } + + return string.Join(", ", parts); + } + + /// + /// Describes what the Go method returns and how a failure surfaces. + /// + public GoReturnInfo RenderReturn(AtsDumpCapability capability) + { + var returnType = capability.ReturnType; + if (returnType is null || returnType.TypeId == VoidTypeId) + { + return new GoReturnInfo("error", GoErrorModels.Returned, ReturnsReceiver: false); + } + + if (returnType.Category != AtsTypeCategories.Handle) + { + return new GoReturnInfo($"({MapTypeRefToGo(returnType, false)}, error)", GoErrorModels.Returned, ReturnsReceiver: false); + } + + // Handle results are fluent: the call never returns an error, the failure is stored on the result and read with Err(). + var returnsReceiver = string.Equals(returnType.TypeId, capability.TargetTypeId, StringComparison.Ordinal); + return new GoReturnInfo(MapTypeRefToGo(returnType, false), GoErrorModels.Deferred, returnsReceiver); + } + + /// + /// The Go types a union parameter accepts. The parameter itself is declared as any. + /// + public List GetUnionAllowedTypes(AtsDumpTypeRef typeRef) + { + var allowed = typeRef.UnionTypes + .Select(unionType => MapTypeRefToGo(unionType, false)) + .Distinct(StringComparer.Ordinal) + .ToList(); + + return allowed.Count > 0 ? allowed : ["any"]; + } + + private string MapHandleType(string typeId) => + _interfaceNames.TryGetValue(typeId, out var name) ? name : "handleReference"; + + private string MapDtoType(string typeId) => + _dtoNames.TryGetValue(typeId, out var name) ? name : _knownTypes.GetDtoName(typeId) ?? "map[string]any"; + + private string MapEnumType(string typeId) => + _enumNames.TryGetValue(typeId, out var name) ? name : "string"; + + // Primitive ids are the literals in Aspire.TypeSystem/AtsConstants.cs. Dates and times are plain + // strings on the wire and a TimeSpan is a number of milliseconds. + private static string MapPrimitiveType(string typeId) => typeId switch + { + "string" or "char" => "string", + "number" => "float64", + "boolean" => "bool", + VoidTypeId => "", + "any" => "any", + "datetime" or "datetimeoffset" or "dateonly" or "timeonly" => "string", + "timespan" => "float64", + "guid" or "uri" => "string", + CancellationTokenTypeId => "*CancellationToken", + _ => "any" + }; + + private static bool IsNilableGoType(string typeName) => + typeName.StartsWith('*') + || typeName.StartsWith("[]", StringComparison.Ordinal) + || typeName.StartsWith("map[", StringComparison.Ordinal) + || typeName == "any" + || typeName.StartsWith("func(", StringComparison.Ordinal); + + private static bool ShouldApplyNullableType(AtsDumpTypeRef typeRef) => + typeRef.IsNullable + && typeRef.Category is AtsTypeCategories.Primitive or AtsTypeCategories.Enum + && typeRef.TypeId is not (VoidTypeId or "any" or CancellationTokenTypeId); +} + +/// +/// The Go return clause of a method. +/// +/// The clause as written after the parameter list, for example error or (string, error). +/// One of . +/// True when the method returns the type it was called on. +internal sealed record GoReturnInfo(string ReturnType, string ErrorModel, bool ReturnsReceiver); diff --git a/src/tools/AtsJsonGenerator/Helpers/GoSdkResolver.cs b/src/tools/AtsJsonGenerator/Helpers/GoSdkResolver.cs new file mode 100644 index 0000000000..f2be6a00a8 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/GoSdkResolver.cs @@ -0,0 +1,672 @@ +using System.Diagnostics.CodeAnalysis; +using static AtsJsonGenerator.Helpers.GoNaming; + +namespace AtsJsonGenerator.Helpers; + +/// +/// Resolves the Go names and type syntax that the Go SDK generator (AtsGoCodeGenerator in +/// microsoft/aspire) emits for an ATS dump, so the API reference documents the exact surface that +/// aspire sdk generate -l go produces. +/// +/// +/// The SDK is a single flat Go package, so every type shares one namespace. The first type to claim +/// a name keeps it and later colliding types get a prefix or numeric suffix. That makes naming +/// depend on which packages are referenced and on the order types are visited, which is why the +/// dump is walked in the same order as the generator. A per-package dump lists only the handles +/// its own assemblies export plus the types its signatures mention, so it resolves names the way +/// an AppHost that references just that integration would. +/// +internal sealed partial class GoSdkResolver +{ + // Well-known ids from Aspire.TypeSystem/AtsConstants.cs in microsoft/aspire. + internal const string ReferenceExpressionTypeId = "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpression"; + internal const string BuilderTypeId = "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder"; + internal const string ApplicationTypeId = "Aspire.Hosting/Aspire.Hosting.DistributedApplication"; + internal const string BuildCapabilityId = "Aspire.Hosting/build"; + internal const string CreateBuilderCapabilityId = "Aspire.Hosting/createBuilder"; + internal const string InteractionInputCollectionTypeId = "Aspire.Hosting/Aspire.Hosting.InteractionInputCollection"; + + private const string CancellationTokenTypeId = "cancellationToken"; + private const string VoidTypeId = "void"; + private const string DefaultTargetParameterName = "builder"; + private const string CreateBuilderOptionsDtoName = "CreateBuilderOptions"; + + private readonly AtsDumpRoot _dump; + private readonly GoKnownTypes _knownTypes; + private readonly Dictionary _enumNames = new(StringComparer.Ordinal); + private readonly Dictionary _dtoNames = new(StringComparer.Ordinal); + private readonly Dictionary _interfaceNames = new(StringComparer.Ordinal); + private readonly Dictionary _implNames = new(StringComparer.Ordinal); + private readonly Dictionary _isInterfaceType = new(StringComparer.Ordinal); + private readonly Dictionary _optionsTypeNames = new(StringComparer.Ordinal); + private readonly HashSet _reservedNames = new(StringComparer.Ordinal); + + /// The dump being documented. + /// The types that supporting packages already document. + public GoSdkResolver(AtsDumpRoot dump, GoKnownTypes knownTypes) + { + _dump = dump; + _knownTypes = knownTypes; + BuildNameMaps(); + } + + /// + /// Every handle type the Go SDK emits, keyed by its raw ATS type id (including the assembly prefix). + /// + public IReadOnlyDictionary InterfaceNames => _interfaceNames; + + public string? GetEnumName(string typeId) => _enumNames.GetValueOrDefault(typeId); + + public string? GetDtoName(string typeId) => _dtoNames.GetValueOrDefault(typeId); + + public bool IsInterface(string typeId) => _isInterfaceType.TryGetValue(typeId, out var isInterface) && isInterface; + + /// + /// True when the handle has a concrete implementation that carries capability methods. Interfaces + /// without one are markers that only exist for type assertions. + /// + public bool HasImplementation(string typeId) => _implNames.ContainsKey(typeId); + + /// + /// The Go interface name of a handle type. Types that were never discovered as handles fall back to + /// the name the generator would derive from the type id. + /// + public string GetHandleName(AtsDumpTypeRef typeRef) => + _interfaceNames.TryGetValue(typeRef.TypeId, out var name) + ? name + : SanitizeIdentifier(StripInterfacePrefix(ExtractTypeName(typeRef.TypeId), typeRef.IsInterface)); + + /// + /// The Go name of a type in a handle's CLR hierarchy, or when the Go SDK has no type + /// for it (IDisposable, IEnumerable<T>, an interface that no capability mentions). + /// A type that a supporting package already documents keeps that package's name. + /// + public string? FindHandleName(AtsDumpTypeRef typeRef) + { + if (_interfaceNames.TryGetValue(typeRef.TypeId, out var name)) + { + return name; + } + + return _knownTypes.TryGetHandle(typeRef.TypeId, out var known) ? known.Name : null; + } + + public string BuilderInterfaceName => _interfaceNames.GetValueOrDefault(BuilderTypeId) ?? "DistributedApplicationBuilder"; + + public string ApplicationInterfaceName => _interfaceNames.GetValueOrDefault(ApplicationTypeId) ?? "DistributedApplication"; + + /// + /// The DTO that CreateBuilder accepts, or when the AppHost model does not define one. + /// + public string? CreateBuilderOptionsName => + _dump.DtoTypes + .Where(dto => string.Equals(dto.Name, CreateBuilderOptionsDtoName, StringComparison.Ordinal)) + .Select(dto => _dtoNames.GetValueOrDefault(dto.TypeId)) + .FirstOrDefault(name => name is not null); + + /// + /// Capabilities the generator emits by hand (Build and CreateBuilder) instead of from metadata. + /// + public static bool IsSpecialCased(AtsDumpCapability capability) => + string.Equals(capability.CapabilityId, BuildCapabilityId, StringComparison.Ordinal) + || string.Equals(capability.CapabilityId, CreateBuilderCapabilityId, StringComparison.Ordinal); + + /// + /// Capabilities of the collection wrappers and ReferenceExpression. The Go SDK supplies those types in + /// its hand-written runtime files (List, Dict, ReferenceExpression) instead of generating + /// them, so there is no generated Go type to document the capability on. + /// + public static bool IsRuntimeProvided(AtsDumpCapability capability) => + string.Equals(capability.TargetTypeId, ReferenceExpressionTypeId, StringComparison.Ordinal) + || capability.TargetType?.Category is AtsTypeCategories.List or AtsTypeCategories.Dict; + + /// + /// The concrete Go types that carry the capability's method. An interface target contributes each + /// of its expansions; a capability with no concrete target is not exposed by the Go SDK. + /// + public IReadOnlyList GetImplementingTypeIds(AtsDumpCapability capability) + { + if (string.IsNullOrEmpty(capability.TargetTypeId)) + { + return []; + } + + IReadOnlyList targets = capability.ExpandedTargetTypes.Count > 0 + ? capability.ExpandedTargetTypes + : capability.TargetType is not null ? [capability.TargetType] : []; + + return targets + .Select(target => target.TypeId) + .Where(typeId => !string.IsNullOrEmpty(typeId) && _implNames.ContainsKey(typeId)) + .Distinct(StringComparer.Ordinal) + .ToList(); + } + + /// + /// True for a parameterless getter of a mutable list or dictionary. The Go SDK exposes these as + /// *List[T] or *Dict[K, V] accessors that cannot fail. + /// + public static bool IsListOrDictAccessor(AtsDumpCapability capability) + { + var targetParameterName = capability.TargetParameterName ?? DefaultTargetParameterName; + var hasOtherParameters = capability.Parameters + .Any(p => !string.Equals(p.Name, targetParameterName, StringComparison.Ordinal)); + + return !hasOtherParameters + && capability.ReturnType is { Category: AtsTypeCategories.List or AtsTypeCategories.Dict, IsReadOnly: false }; + } + + /// + /// Splits the capability's parameters (minus the target) into the positional ones and the ones + /// that move into the trailing variadic options argument. + /// + public static (List Required, List Optional) SplitParameters(AtsDumpCapability capability) + { + var targetParameterName = capability.TargetParameterName ?? DefaultTargetParameterName; + var required = new List(); + var optional = new List(); + + foreach (var parameter in capability.Parameters) + { + if (string.Equals(parameter.Name, targetParameterName, StringComparison.Ordinal)) + { + continue; + } + + if (IsCancellationToken(parameter) || parameter.IsOptional) + { + optional.Add(parameter); + } + else + { + required.Add(parameter); + } + } + + return (required, optional); + } + + /// + /// Describes the trailing options ...*T argument for the capability, or + /// when the capability has no optional parameters. + /// + public GoOptionsInfo? GetOptions(AtsDumpCapability capability) + { + var (_, optional) = SplitParameters(capability); + if (optional.Count == 0) + { + return null; + } + + if (TryGetDirectOptionsParameter(optional, out var directOptionsParameter)) + { + return new GoOptionsInfo(MapDtoType(directOptionsParameter.Type.TypeId), IsDirect: true, optional); + } + + return new GoOptionsInfo(GetOptionsTypeName(capability), IsDirect: false, optional); + } + + private string GetOptionsTypeName(AtsDumpCapability capability) => + _optionsTypeNames.TryGetValue(capability.CapabilityId, out var name) + ? name + : $"{ToPascalCase(capability.MethodName)}Options"; + + private void BuildNameMaps() + { + ReserveKnownNames(); + + // A supporting package that already documents a type keeps its name, even when this dump declares + // the type again, so that the types left in this package still refer to it by that name. + foreach (var enumType in _dump.EnumTypes) + { + _enumNames[enumType.TypeId] = _knownTypes.GetEnumName(enumType.TypeId) + ?? ReserveName(SanitizeIdentifier(enumType.Name), takenLowercase: false); + } + + // The dump lists only the enums its own assemblies define, but the Go generator sees every enum in + // the app model, so an enum from another assembly (ProtocolType, HealthStatus) that a signature or + // DTO field mentions is still declared and named in the SDK. + foreach (var typeId in GetReferencedEnumTypeIds().Where(id => !_enumNames.ContainsKey(id)).Order(StringComparer.Ordinal)) + { + _enumNames[typeId] = _knownTypes.GetEnumName(typeId) + ?? ReserveName(SanitizeIdentifier(ExtractTypeName(typeId)), takenLowercase: false); + } + + foreach (var dto in _dump.DtoTypes) + { + if (dto.TypeId == ReferenceExpressionTypeId) + { + // ReferenceExpression is part of the Go SDK runtime, so it never gets a generated type. + continue; + } + + _dtoNames[dto.TypeId] = _knownTypes.GetDtoName(dto.TypeId) + ?? ReserveName(SanitizeIdentifier(dto.Name), takenLowercase: false); + } + + // Handle types come from the dump's handle list and from every type a capability mentions, + // because a type that is only referenced still needs a Go interface to be named in signatures. + var handleTypeIds = new HashSet(StringComparer.Ordinal); + foreach (var handleType in _dump.HandleTypes) + { + if (handleType.AtsTypeId == ReferenceExpressionTypeId || IsCancellationTokenTypeId(handleType.AtsTypeId)) + { + continue; + } + + handleTypeIds.Add(handleType.AtsTypeId); + _isInterfaceType[handleType.AtsTypeId] = handleType.IsInterface; + } + + // An interface that appears as an expansion target (IDistributedApplicationBuilder expands to + // itself) still needs a concrete implementation to host its capability methods. + var expansionTargetIds = new HashSet(StringComparer.Ordinal); + var referencedInterfaceIds = new HashSet(StringComparer.Ordinal); + foreach (var capability in _dump.Capabilities) + { + CollectHandleTypeIds(handleTypeIds, referencedInterfaceIds, capability.TargetType); + CollectHandleTypeIds(handleTypeIds, referencedInterfaceIds, capability.ReturnType); + + foreach (var parameter in capability.Parameters) + { + CollectHandleTypeIds(handleTypeIds, referencedInterfaceIds, parameter.Type); + + if (parameter.IsCallback && parameter.CallbackParameters is not null) + { + foreach (var callbackParameter in parameter.CallbackParameters) + { + CollectHandleTypeIds(handleTypeIds, referencedInterfaceIds, callbackParameter.Type); + } + } + } + + foreach (var expanded in capability.ExpandedTargetTypes) + { + CollectHandleTypeIds(handleTypeIds, referencedInterfaceIds, expanded); + + if (!string.IsNullOrEmpty(expanded.TypeId)) + { + expansionTargetIds.Add(expanded.TypeId); + } + } + } + + MarkReferencedInterfaces(referencedInterfaceIds); + + // A supporting package's answer is authoritative, so it also overrides what the dump says. + foreach (var typeId in handleTypeIds) + { + if (_knownTypes.TryGetHandle(typeId, out var known)) + { + _isInterfaceType[typeId] = known.IsInterface; + } + } + + // Interfaces reserve their names first so they get the bare name and concrete types fall back + // to a prefix or numeric suffix when they collide. + var ordered = handleTypeIds + .OrderBy(id => IsInterface(id) ? 0 : 1) + .ThenBy(id => id, StringComparer.Ordinal) + .ToList(); + + foreach (var typeId in ordered) + { + var isInterface = IsInterface(typeId); + + // The supporting package already reserved the name when it declared the type. + if (_knownTypes.TryGetHandle(typeId, out var knownHandle)) + { + _interfaceNames[typeId] = knownHandle.Name; + if (knownHandle.HasImplementation) + { + _implNames[typeId] = ToCamelCase(knownHandle.Name); + } + + continue; + } + + var needsImpl = !isInterface || expansionTargetIds.Contains(typeId); + var sanitized = SanitizeIdentifier(StripInterfacePrefix(ExtractTypeName(typeId), isInterface)); + + string interfaceName; + if (isInterface && !needsImpl) + { + interfaceName = ReserveName(sanitized, takenLowercase: false); + } + else if (!_reservedNames.Contains(sanitized)) + { + interfaceName = ReserveName(sanitized, takenLowercase: true); + } + else + { + var assemblyPrefix = SanitizeIdentifier(typeId.Split('/')[0]); + var prefixed = $"{assemblyPrefix}{sanitized}"; + interfaceName = !_reservedNames.Contains(prefixed) + ? ReserveName(prefixed, takenLowercase: true) + : ReserveName(sanitized, takenLowercase: true); + } + + _interfaceNames[typeId] = interfaceName; + if (needsImpl) + { + _implNames[typeId] = ToCamelCase(interfaceName); + } + } + + BuildOptionsTypeNames(); + } + + /// + /// Claims the names that supporting packages already use, so a type in this dump that collides with one + /// of them is the one that gets a prefix or suffix, as it would when the packages are combined. + /// + private void ReserveKnownNames() + { + foreach (var handle in _knownTypes.Handles) + { + _reservedNames.Add(handle.Name); + if (handle.HasImplementation) + { + _reservedNames.Add(ToCamelCase(handle.Name)); + } + } + + foreach (var name in _knownTypes.DtoNames.Concat(_knownTypes.EnumNames)) + { + _reservedNames.Add(name); + } + } + + /// + /// Resolves the wrapper struct name for each capability that has optional parameters. Runs after + /// enums, DTOs and handles are named so collisions with them are detected. + /// + private void BuildOptionsTypeNames() + { + var optionsNamesInUse = new HashSet(StringComparer.Ordinal); + + // The first capability to claim each name, so later ones can check their fields are compatible before sharing it. + var optionsNameFirstCapability = new Dictionary(StringComparer.Ordinal); + + foreach (var capability in _dump.Capabilities) + { + var optional = GetOptionalParameters(capability); + if (optional.Count == 0) + { + continue; + } + + // A direct options DTO is passed as-is, so there is no wrapper struct to name. + if (TryGetDirectOptionsParameter(optional, out _)) + { + continue; + } + + var simpleName = $"{ToPascalCase(capability.MethodName)}Options"; + string resolvedName; + + if (!_reservedNames.Contains(simpleName) && !optionsNamesInUse.Contains(simpleName)) + { + resolvedName = simpleName; + optionsNamesInUse.Add(simpleName); + optionsNameFirstCapability[simpleName] = capability; + } + else if (optionsNamesInUse.Contains(simpleName) && !_reservedNames.Contains(simpleName)) + { + // The same method name on another type. Sharing the struct is only safe when the optional + // fields have identical types; for example RunAsEmulator on two resources can take + // different emulator callback types, which need separate structs. + if (optionsNameFirstCapability.TryGetValue(simpleName, out var firstCapability) + && AreOptionsCompatible(capability, firstCapability)) + { + resolvedName = simpleName; + } + else + { + resolvedName = GetOptionsQualifiedName(capability, simpleName); + optionsNamesInUse.Add(resolvedName); + optionsNameFirstCapability[resolvedName] = capability; + } + } + else + { + // The simple name collides with an enum, DTO or handle type. + resolvedName = GetOptionsQualifiedName(capability, simpleName); + optionsNamesInUse.Add(resolvedName); + optionsNameFirstCapability[resolvedName] = capability; + } + + _optionsTypeNames[capability.CapabilityId] = resolvedName; + } + } + + private string GetOptionsQualifiedName(AtsDumpCapability capability, string simpleName) + { + var targetName = capability.TargetTypeId is { } targetTypeId && _interfaceNames.TryGetValue(targetTypeId, out var name) + ? name + : capability.TargetTypeId ?? "Unknown"; + + return $"{targetName}{simpleName}"; + } + + private bool AreOptionsCompatible(AtsDumpCapability first, AtsDumpCapability second) + { + var firstOptionals = GetOptionalParameters(first).OrderBy(p => p.Name, StringComparer.Ordinal).ToList(); + var secondOptionals = GetOptionalParameters(second).OrderBy(p => p.Name, StringComparer.Ordinal).ToList(); + if (firstOptionals.Count != secondOptionals.Count) + { + return false; + } + + for (var i = 0; i < firstOptionals.Count; i++) + { + if (!string.Equals(firstOptionals[i].Name, secondOptionals[i].Name, StringComparison.Ordinal) + || !string.Equals(RenderOptionsFieldType(firstOptionals[i]), RenderOptionsFieldType(secondOptionals[i]), StringComparison.Ordinal)) + { + return false; + } + } + + return true; + } + + private static List GetOptionalParameters(AtsDumpCapability capability) => + SplitParameters(capability).Optional; + + /// + /// A single optional options DTO is passed directly instead of through a generated wrapper. + /// Go allows one trailing variadic, so a coexisting cancellation token prevents flattening. + /// + private static bool TryGetDirectOptionsParameter( + IReadOnlyList optionalParameters, + [NotNullWhen(true)] out AtsDumpParameter? directOptionsParameter) + { + directOptionsParameter = null; + + if (optionalParameters.Count != 1) + { + return false; + } + + var candidate = optionalParameters[0]; + if (candidate.IsCallback + || IsCancellationToken(candidate) + || !string.Equals(candidate.Name, "options", StringComparison.Ordinal) + || candidate.Type.Category != AtsTypeCategories.Dto) + { + return false; + } + + directOptionsParameter = candidate; + return true; + } + + private HashSet GetReferencedEnumTypeIds() + { + var typeIds = new HashSet(StringComparer.Ordinal); + + foreach (var capability in _dump.Capabilities) + { + CollectEnumTypeIds(typeIds, capability.ReturnType); + + foreach (var parameter in capability.Parameters) + { + CollectEnumTypeIds(typeIds, parameter.Type); + CollectEnumTypeIds(typeIds, parameter.CallbackReturnType); + + foreach (var callbackParameter in parameter.CallbackParameters ?? []) + { + CollectEnumTypeIds(typeIds, callbackParameter.Type); + } + } + } + + foreach (var dto in _dump.DtoTypes) + { + foreach (var property in dto.Properties) + { + CollectEnumTypeIds(typeIds, property.Type); + } + } + + return typeIds; + } + + private static void CollectEnumTypeIds(HashSet typeIds, AtsDumpTypeRef? typeRef) + { + if (typeRef is null) + { + return; + } + + if (typeRef.Category == AtsTypeCategories.Enum) + { + typeIds.Add(typeRef.TypeId); + } + + CollectEnumTypeIds(typeIds, typeRef.ElementType); + CollectEnumTypeIds(typeIds, typeRef.KeyType); + CollectEnumTypeIds(typeIds, typeRef.ValueType); + + foreach (var unionType in typeRef.UnionTypes) + { + CollectEnumTypeIds(typeIds, unionType); + } + } + + /// + /// The dump lists only the handles that its own assemblies define, while the Go generator sees every + /// handle in the app model. A foreign interface that is only referenced from a signature (ILogger, + /// IConfiguration) is one of those exported handles, so it is an interface that loses its "I" prefix. + /// A type from a dumped assembly that is missing from the list was never exported, as with a generic + /// constraint such as IComputeResource, so the generator keeps its name as written. + /// + /// + /// A dump cannot tell those two cases apart for a type from another assembly, so a supporting package + /// that already documents the type decides instead. Without one, a foreign interface is assumed to be + /// an exported handle. + /// + private void MarkReferencedInterfaces(HashSet referencedInterfaceIds) + { + var ownedAssemblies = _dump.HandleTypes + .Select(handleType => handleType.AtsTypeId) + .Concat(_dump.DtoTypes.Select(dto => dto.TypeId)) + .Select(GetAssemblyName) + .OfType() + .ToHashSet(StringComparer.Ordinal); + + foreach (var typeId in referencedInterfaceIds) + { + if (_isInterfaceType.ContainsKey(typeId) || _knownTypes.TryGetHandle(typeId, out _)) + { + continue; + } + + var assemblyName = GetAssemblyName(typeId); + if (assemblyName is not null && ownedAssemblies.Contains(assemblyName)) + { + continue; + } + + _isInterfaceType[typeId] = true; + } + } + + // Type ids look like "Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource"; the part before the + // slash is the assembly. Ids without a slash (enums, primitives) have none. + private static string? GetAssemblyName(string typeId) + { + var slash = typeId.IndexOf('/'); + return slash > 0 ? typeId[..slash] : null; + } + + private static void CollectHandleTypeIds(HashSet typeIds, HashSet interfaceTypeIds, AtsDumpTypeRef? typeRef) + { + if (typeRef is null) + { + return; + } + + if (typeRef.TypeId == ReferenceExpressionTypeId || IsCancellationTokenTypeId(typeRef.TypeId)) + { + return; + } + + if (typeRef.Category == AtsTypeCategories.Handle) + { + typeIds.Add(typeRef.TypeId); + + if (typeRef.IsInterface) + { + interfaceTypeIds.Add(typeRef.TypeId); + } + } + + CollectHandleTypeIds(typeIds, interfaceTypeIds, typeRef.ElementType); + CollectHandleTypeIds(typeIds, interfaceTypeIds, typeRef.KeyType); + CollectHandleTypeIds(typeIds, interfaceTypeIds, typeRef.ValueType); + + foreach (var unionType in typeRef.UnionTypes) + { + CollectHandleTypeIds(typeIds, interfaceTypeIds, unionType); + } + } + + private bool IsNameTaken(string name) => _reservedNames.Contains(name); + + private string ReserveName(string candidate, bool takenLowercase) + { + var name = candidate; + var counter = 2; + + // A concrete type also reserves its lowercase implementation name, so a collision on either spelling forces a suffix. + while (_reservedNames.Contains(name) + || (takenLowercase && _reservedNames.Contains(ToCamelCase(name)))) + { + name = $"{candidate}{counter}"; + counter++; + } + + _reservedNames.Add(name); + if (takenLowercase) + { + _reservedNames.Add(ToCamelCase(name)); + } + + return name; + } + + public static bool IsCancellationToken(AtsDumpParameter parameter) => IsCancellationTokenTypeId(parameter.Type.TypeId); + + private static bool IsCancellationTokenTypeId(string? typeId) => + string.Equals(typeId, CancellationTokenTypeId, StringComparison.Ordinal) + || (typeId?.EndsWith("/System.Threading.CancellationToken", StringComparison.Ordinal) ?? false); +} + +/// +/// The trailing options ...*T argument of a Go method. +/// +/// The Go struct passed through the variadic. +/// True when is an existing DTO rather than a generated wrapper. +/// The optional ATS parameters the argument carries, in capability order. +internal sealed record GoOptionsInfo(string TypeName, bool IsDirect, IReadOnlyList Parameters); diff --git a/src/tools/AtsJsonGenerator/Helpers/GoTransformer.cs b/src/tools/AtsJsonGenerator/Helpers/GoTransformer.cs new file mode 100644 index 0000000000..5856701454 --- /dev/null +++ b/src/tools/AtsJsonGenerator/Helpers/GoTransformer.cs @@ -0,0 +1,476 @@ +using System.Text.Encodings.Web; +using System.Text.Json; +using static AtsJsonGenerator.Helpers.GoNaming; + +namespace AtsJsonGenerator.Helpers; + +/// +/// Transforms the raw aspire sdk dump --format json output into the Go API model for the docs site. +/// +/// +/// The Go SDK generator in microsoft/aspire (AtsGoCodeGenerator) is the source of truth for the +/// surface that is documented here: every name, signature and error model is derived by +/// with the same rules, so the reference matches the generated SDK. +/// +internal static class GoTransformer +{ + // Go interpreted string literals use the same escapes as JSON strings, so a serialized string is a valid + // literal. Relaxed escaping keeps characters such as '+' and '<' readable instead of \u002B and \u003C. + private static readonly JsonSerializerOptions s_literalOptions = new() + { + Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping + }; + + // The Go SDK generator writes these accessors by hand on InteractionInputCollection, so the dump + // carries no record of them. + private static readonly GoSynthesizedMemberModel[] s_interactionInputCollectionMembers = + [ + new() + { + Name = "Get", + Signature = "Get(name string) (*InteractionInput, error)", + Description = "Get returns the input with the specified name, or nil if no input matches." + }, + new() + { + Name = "Required", + Signature = "Required(name string) (*InteractionInput, error)", + Description = "Required returns the input with the specified name, or an error if no input matches." + }, + new() + { + Name = "Value", + Signature = "Value(name string) (string, error)", + Description = "Value returns the value of the input with the specified name, or an empty string if no input matches or it has no value." + }, + new() + { + Name = "RequiredValue", + Signature = "RequiredValue(name string) (string, error)", + Description = "RequiredValue returns the value of the input with the specified name, or an error if no input matches." + }, + ]; + + /// + /// Transform the deserialized dump output into a . + /// + /// + /// Accept error diagnostics that attributes to known scanner defects. + /// Any other error diagnostic still fails the transform. + /// + /// + /// The types that supporting packages already document. Names and interface-ness come from them so the types + /// this package shares with those packages are named the same way in every module. + /// + public static GoPackageModel Transform( + AtsDumpRoot dump, + string packageName, + string? version = null, + string? sourceRepository = null, + string? sourceCommit = null, + bool tolerateKnownScannerDiagnostics = false, + GoKnownTypes? knownTypes = null) + { + AtsTransformer.ThrowIfErrorDiagnostics(dump, tolerateKnownScannerDiagnostics); + + sourceRepository = AtsTransformer.NormalizeSourceRepository(sourceRepository); + version = AtsTransformer.ResolvePackageVersion(dump, packageName, version); + + var resolver = new GoSdkResolver(dump, knownTypes ?? GoKnownTypes.None); + var handleModels = TransformHandles(dump, resolver); + + var functionModels = new List(); + var skippedCapabilityIds = new List(); + foreach (var capability in dump.Capabilities) + { + if (TransformCapability(capability, resolver) is { } function) + { + functionModels.Add(function); + } + else if (!GoSdkResolver.IsRuntimeProvided(capability)) + { + skippedCapabilityIds.Add(capability.CapabilityId); + } + } + + functionModels = functionModels + .OrderBy(f => f.QualifiedName, StringComparer.Ordinal) + .ThenBy(f => f.CapabilityId, StringComparer.Ordinal) + .ToList(); + + foreach (var function in functionModels) + { + if (function.TargetTypeId is { } targetTypeId && handleModels.TryGetValue(targetTypeId, out var handle)) + { + handle.Capabilities.Add(function); + } + } + + return new GoPackageModel + { + Package = new GoPackageInfo + { + Name = packageName, + Version = version, + SourceRepository = sourceRepository, + SourceCommit = sourceCommit, + }, + Functions = functionModels, + HandleTypes = handleModels.Values + .OrderBy(h => h.FullName, StringComparer.Ordinal) + .ThenBy(h => h.Name, StringComparer.Ordinal) + .ToList(), + DtoTypes = dump.DtoTypes + .Where(dto => resolver.GetDtoName(dto.TypeId) is not null) + .Select(dto => TransformDto(dto, resolver)) + .OrderBy(d => d.FullName, StringComparer.Ordinal) + .ToList(), + EnumTypes = dump.EnumTypes + .Select(e => TransformEnum(e, resolver)) + .OrderBy(e => e.FullName, StringComparer.Ordinal) + .ToList(), + ExportedValues = TransformExportedValues(dump, resolver), + SkippedCapabilityIds = skippedCapabilityIds.Order(StringComparer.Ordinal).ToList(), + }; + } + + private static Dictionary TransformHandles(AtsDumpRoot dump, GoSdkResolver resolver) + { + var dumpHandles = new Dictionary(StringComparer.Ordinal); + foreach (var handle in dump.HandleTypes) + { + dumpHandles.TryAdd(handle.AtsTypeId, handle); + } + + // Types that only appear in capability signatures have no handle entry in the dump, so they + // are documented without a description. + var models = new Dictionary(StringComparer.Ordinal); + foreach (var (typeId, name) in resolver.InterfaceNames) + { + dumpHandles.TryGetValue(typeId, out var dumpHandle); + var isInterface = resolver.IsInterface(typeId); + + models[typeId] = new GoHandleTypeModel + { + Name = name, + FullName = AtsTransformer.StripAssemblyPrefix(typeId), + IsInterface = isInterface, + IsMarker = isInterface && !resolver.HasImplementation(typeId), + Description = AtsTransformer.NormalizeDoc(dumpHandle?.Documentation?.Summary), + Remarks = AtsTransformer.NormalizeDoc(dumpHandle?.Documentation?.Remarks), + ImplementedInterfaces = dumpHandle?.ImplementedInterfaces + .Select(resolver.FindHandleName) + .OfType() + .Distinct(StringComparer.Ordinal) + .Order(StringComparer.Ordinal) + .ToList() ?? [], + SynthesizedMembers = typeId == GoSdkResolver.InteractionInputCollectionTypeId + ? [.. s_interactionInputCollectionMembers] + : [], + }; + } + + return models; + } + + /// + /// Returns when the Go SDK does not expose the capability. + /// + private static GoFunctionModel? TransformCapability(AtsDumpCapability capability, GoSdkResolver resolver) + { + if (capability.CapabilityId == GoSdkResolver.CreateBuilderCapabilityId) + { + return TransformCreateBuilder(capability, resolver); + } + + if (capability.CapabilityId == GoSdkResolver.BuildCapabilityId) + { + return TransformBuild(capability, resolver); + } + + var implementingTypeIds = resolver.GetImplementingTypeIds(capability); + if (implementingTypeIds.Count == 0) + { + return null; + } + + var (required, _) = GoSdkResolver.SplitParameters(capability); + var options = resolver.GetOptions(capability); + var returnType = GoSdkResolver.IsListOrDictAccessor(capability) + ? new GoReturnInfo(resolver.MapTypeRefToGo(capability.ReturnType, false), GoErrorModels.None, ReturnsReceiver: false) + : resolver.RenderReturn(capability); + + var name = ToPascalCase(capability.MethodName); + + return CreateFunctionModel( + capability, + name, + signature: $"{name}({resolver.RenderParameterList(required, options)}) {returnType.ReturnType}", + returnType, + receiver: GetReceiverName(capability, resolver), + parameters: TransformParameters(required, capability, resolver), + options: TransformOptions(options, capability, resolver), + appliesTo: implementingTypeIds + .Select(typeId => resolver.InterfaceNames[typeId]) + .Order(StringComparer.Ordinal) + .ToList()); + } + + // The Go SDK writes CreateBuilder by hand because it connects to the AppHost rather than calling a capability. + private static GoFunctionModel TransformCreateBuilder(AtsDumpCapability capability, GoSdkResolver resolver) + { + var optionsName = resolver.CreateBuilderOptionsName; + var returnType = new GoReturnInfo($"({resolver.BuilderInterfaceName}, error)", GoErrorModels.Returned, ReturnsReceiver: false); + + return CreateFunctionModel( + capability, + name: "CreateBuilder", + signature: optionsName is null + ? $"CreateBuilder() {returnType.ReturnType}" + : $"CreateBuilder(options ...*{optionsName}) {returnType.ReturnType}", + returnType, + receiver: null, + parameters: [], + options: optionsName is null ? null : new GoOptionsModel { TypeName = optionsName, IsDirect = true }, + appliesTo: [], + fallbackDescription: "CreateBuilder establishes a connection to the AppHost and returns a new builder."); + } + + // Build is written by hand because it returns the application interface instead of the fluent builder. + private static GoFunctionModel TransformBuild(AtsDumpCapability capability, GoSdkResolver resolver) + { + var returnType = new GoReturnInfo($"({resolver.ApplicationInterfaceName}, error)", GoErrorModels.Returned, ReturnsReceiver: false); + + return CreateFunctionModel( + capability, + name: "Build", + signature: $"Build() {returnType.ReturnType}", + returnType, + receiver: resolver.BuilderInterfaceName, + parameters: [], + options: null, + appliesTo: [resolver.BuilderInterfaceName], + fallbackDescription: "Build invokes the build capability and returns the running application."); + } + + private static GoFunctionModel CreateFunctionModel( + AtsDumpCapability capability, + string name, + string signature, + GoReturnInfo returnType, + string? receiver, + List parameters, + GoOptionsModel? options, + List appliesTo, + string? fallbackDescription = null) + { + return new GoFunctionModel + { + Name = name, + CapabilityId = capability.CapabilityId, + QualifiedName = capability.QualifiedMethodName, + + // Prefer the richer Documentation.Summary; fall back to the legacy Description field for + // older dumps that don't ship Documentation. + Description = AtsTransformer.NormalizeDoc(capability.Documentation?.Summary) + ?? AtsTransformer.NormalizeDoc(capability.Description) + ?? fallbackDescription, + Remarks = AtsTransformer.NormalizeDoc(capability.Documentation?.Remarks), + Returns = AtsTransformer.NormalizeDoc(capability.Documentation?.Returns), + Kind = capability.CapabilityKind, + Signature = signature, + Receiver = receiver, + Parameters = parameters, + Options = options, + ReturnType = returnType.ReturnType, + ReturnsReceiver = returnType.ReturnsReceiver, + ErrorModel = returnType.ErrorModel, + ReturnsBuilder = capability.ReturnsBuilder, + TargetTypeId = capability.TargetTypeId, + ExpandedTargetTypes = capability.ExpandedTargetTypes + .Select(t => AtsTransformer.StripAssemblyPrefix(t.TypeId)) + .ToList(), + AppliesTo = appliesTo, + }; + } + + private static string? GetReceiverName(AtsDumpCapability capability, GoSdkResolver resolver) + { + if (capability.TargetTypeId is { } targetTypeId && resolver.InterfaceNames.TryGetValue(targetTypeId, out var name)) + { + return name; + } + + return capability.TargetType is { } targetType ? resolver.GetHandleName(targetType) : null; + } + + private static List TransformParameters( + IReadOnlyList parameters, + AtsDumpCapability capability, + GoSdkResolver resolver) + { + var docs = GetParameterDocs(capability); + + return parameters.Select(p => new GoParameterModel + { + Name = GetLocalIdentifier(p.Name), + Type = resolver.RenderParameterType(p), + IsCallback = p.IsCallback, + CallbackSignature = p.IsCallback ? resolver.RenderCallbackType(p) : null, + AllowedTypes = !p.IsCallback && p.Type.Category == AtsTypeCategories.Union + ? resolver.GetUnionAllowedTypes(p.Type) + : null, + Description = GetParameterDescription(p, docs), + }).ToList(); + } + + private static GoOptionsModel? TransformOptions(GoOptionsInfo? options, AtsDumpCapability capability, GoSdkResolver resolver) + { + if (options is null) + { + return null; + } + + // A direct options DTO is documented once on the DTO itself. + if (options.IsDirect) + { + return new GoOptionsModel { TypeName = options.TypeName, IsDirect = true }; + } + + var docs = GetParameterDocs(capability); + + return new GoOptionsModel + { + TypeName = options.TypeName, + Fields = options.Parameters.Select(p => new GoOptionFieldModel + { + Name = ToPascalCase(p.Name), + + // Callbacks and cancellation tokens cannot be serialized, so the SDK tags them json:"-". + JsonName = p.IsCallback || GoSdkResolver.IsCancellationToken(p) ? null : p.Name, + Type = resolver.RenderOptionsFieldType(p), + IsCallback = p.IsCallback, + CallbackSignature = p.IsCallback ? resolver.RenderCallbackType(p) : null, + Description = GetParameterDescription(p, docs), + }).ToList(), + }; + } + + // Parameter descriptions come from the capability's documentation block, keyed by ATS parameter name. + private static Dictionary GetParameterDocs(AtsDumpCapability capability) => + capability.Documentation?.Parameters + .Where(d => !string.IsNullOrWhiteSpace(d.Description)) + .GroupBy(d => d.Name, StringComparer.Ordinal) + .ToDictionary(g => g.Key, g => g.First().Description, StringComparer.Ordinal) + ?? new Dictionary(StringComparer.Ordinal); + + private static string? GetParameterDescription(AtsDumpParameter parameter, Dictionary docs) => + docs.TryGetValue(parameter.Name, out var description) + ? AtsTransformer.NormalizeDoc(description) + : AtsTransformer.NormalizeDoc(parameter.Documentation?.Summary); + + private static GoDtoTypeModel TransformDto(AtsDumpDtoType dto, GoSdkResolver resolver) + { + return new GoDtoTypeModel + { + Name = resolver.GetDtoName(dto.TypeId) ?? SanitizeIdentifier(dto.Name), + FullName = AtsTransformer.StripAssemblyPrefix(dto.TypeId), + Description = AtsTransformer.NormalizeDoc(dto.Documentation?.Summary) ?? AtsTransformer.NormalizeDoc(dto.Description), + Remarks = AtsTransformer.NormalizeDoc(dto.Documentation?.Remarks), + Fields = dto.Properties.Select(p => new GoDtoFieldModel + { + Name = ToPascalCase(p.Name), + JsonName = p.Name, + Type = resolver.MapDtoPropertyTypeToGo(p.Type, p.IsOptional), + IsOptional = p.IsOptional, + IsCallback = p.Type.Category == AtsTypeCategories.Callback, + Description = AtsTransformer.NormalizeDoc(p.Documentation?.Summary) ?? AtsTransformer.NormalizeDoc(p.Description), + }).ToList(), + }; + } + + private static GoEnumTypeModel TransformEnum(AtsDumpEnumType enumType, GoSdkResolver resolver) + { + var fullName = StripEnumPrefix(enumType.TypeId); + + var goName = resolver.GetEnumName(enumType.TypeId) ?? SanitizeIdentifier(enumType.Name); + + var valueDocs = new Dictionary(StringComparer.Ordinal); + foreach (var valueInfo in enumType.ValueInfos) + { + valueDocs.TryAdd(valueInfo.Name, valueInfo); + } + + return new GoEnumTypeModel + { + Name = goName, + FullName = fullName, + Description = AtsTransformer.NormalizeDoc(enumType.Documentation?.Summary), + Remarks = AtsTransformer.NormalizeDoc(enumType.Documentation?.Remarks), + Members = enumType.Values.Select(value => + { + valueDocs.TryGetValue(value, out var valueInfo); + + return new GoEnumMemberModel + { + Name = $"{goName}{ToPascalCase(value)}", + Value = value, + Description = AtsTransformer.NormalizeDoc(valueInfo?.Documentation?.Summary), + Remarks = AtsTransformer.NormalizeDoc(valueInfo?.Documentation?.Remarks), + }; + }).ToList(), + }; + } + + // The Go SDK emits each group as `var Name = struct { Child T }{ Child: value }`, so the first path + // segment is the variable and the rest address a field inside it. + private static List TransformExportedValues(AtsDumpRoot dump, GoSdkResolver resolver) + { + return dump.ExportedValues + .Where(value => value.PathSegments.Count > 0) + .GroupBy(value => value.PathSegments[0], StringComparer.Ordinal) + .OrderBy(group => group.Key, StringComparer.Ordinal) + .Select(group => new GoExportedValueModel + { + Name = group.Key, + FullName = group.Key, + Values = group + .Select(value => new GoExportedValueEntryModel + { + Path = string.Join('.', value.PathSegments.Skip(1)), + Type = resolver.MapTypeRefToGo(value.Type, false), + Value = FormatExportedValue(value, resolver), + Description = AtsTransformer.NormalizeDoc(value.Documentation?.Summary) ?? AtsTransformer.NormalizeDoc(value.Description), + }) + .OrderBy(entry => entry.Path, StringComparer.Ordinal) + .ToList(), + }) + .ToList(); + } + + // Scalars render as Go literals. Anything else (DTOs, collections) renders as its JSON text because + // the reference only needs to show what the value is, not reproduce the SDK's composite literal. + // Composites are re-serialized rather than copied with GetRawText(): the dump keeps its indentation and + // the line endings of the OS that produced it, which would make the generated data differ per platform + // and split a value across several lines of the one-line-per-value markdown lists. + private static string FormatExportedValue(AtsDumpExportedValue exported, GoSdkResolver resolver) + { + if (exported.Value is not { } json || json.ValueKind is JsonValueKind.Null or JsonValueKind.Undefined) + { + return "nil"; + } + + var literal = json.ValueKind switch + { + JsonValueKind.String => JsonSerializer.Serialize(json.GetString(), s_literalOptions), + JsonValueKind.True => "true", + JsonValueKind.False => "false", + JsonValueKind.Object or JsonValueKind.Array => JsonSerializer.Serialize(json, s_literalOptions), + _ => json.GetRawText() + }; + + return exported.Type.Category == AtsTypeCategories.Enum && resolver.GetEnumName(exported.Type.TypeId) is { } enumName + ? $"{enumName}({literal})" + : literal; + } +} diff --git a/src/tools/AtsJsonGenerator/Helpers/Models.cs b/src/tools/AtsJsonGenerator/Helpers/Models.cs index 062986c5ad..fb167419a2 100644 --- a/src/tools/AtsJsonGenerator/Helpers/Models.cs +++ b/src/tools/AtsJsonGenerator/Helpers/Models.cs @@ -1,3 +1,4 @@ +using System.Text.Json; using System.Text.Json.Serialization; namespace AtsJsonGenerator; @@ -23,10 +24,36 @@ internal sealed class AtsDumpRoot [JsonPropertyName("EnumTypes")] public List EnumTypes { get; init; } = []; + [JsonPropertyName("ExportedValues")] + public List ExportedValues { get; init; } = []; + [JsonPropertyName("Diagnostics")] public List Diagnostics { get; init; } = []; } +/// +/// A constant exported by an integration (for example WellKnownPipelineSteps.Publish). +/// +internal sealed class AtsDumpExportedValue +{ + // The first segment is the exported root (for example "WellKnownPipelineSteps"); later + // segments describe nested members. + [JsonPropertyName("PathSegments")] + public List PathSegments { get; init; } = []; + + [JsonPropertyName("Type")] + public required AtsDumpTypeRef Type { get; init; } + + [JsonPropertyName("Value")] + public JsonElement? Value { get; init; } + + [JsonPropertyName("Description")] + public string? Description { get; init; } + + [JsonPropertyName("Documentation")] + public AtsDumpDocumentation? Documentation { get; init; } +} + internal sealed class AtsDumpDiagnostic { public required string Severity { get; init; } @@ -74,6 +101,9 @@ internal sealed class AtsDumpCapability [JsonPropertyName("ReturnsBuilder")] public bool ReturnsBuilder { get; init; } + [JsonPropertyName("IsExperimental")] + public bool IsExperimental { get; init; } + [JsonPropertyName("Parameters")] public List Parameters { get; init; } = []; @@ -139,6 +169,9 @@ internal sealed class AtsDumpParameter [JsonPropertyName("CallbackReturnType")] public AtsDumpTypeRef? CallbackReturnType { get; init; } + + [JsonPropertyName("Documentation")] + public AtsDumpDocumentation? Documentation { get; init; } } internal sealed class AtsDumpCallbackParam @@ -164,9 +197,18 @@ internal sealed class AtsDumpTypeRef [JsonPropertyName("IsReadOnly")] public bool IsReadOnly { get; init; } + [JsonPropertyName("IsNullable")] + public bool IsNullable { get; init; } + [JsonPropertyName("ElementType")] public AtsDumpTypeRef? ElementType { get; init; } + [JsonPropertyName("KeyType")] + public AtsDumpTypeRef? KeyType { get; init; } + + [JsonPropertyName("ValueType")] + public AtsDumpTypeRef? ValueType { get; init; } + [JsonPropertyName("UnionTypes")] public List UnionTypes { get; init; } = []; } diff --git a/src/tools/AtsJsonGenerator/README.md b/src/tools/AtsJsonGenerator/README.md index dbdab3042f..328bfe3dcd 100644 --- a/src/tools/AtsJsonGenerator/README.md +++ b/src/tools/AtsJsonGenerator/README.md @@ -1,12 +1,12 @@ # AtsJsonGenerator -Transforms `aspire sdk dump --format json` output into structured JSON files for the aspire.dev TypeScript API reference pages. +Transforms `aspire sdk dump --format json` output into structured JSON files for the aspire.dev TypeScript and Go API reference pages. ## Overview -The Aspire CLI can emit a JSON description of all TypeScript-accessible capabilities for any hosting package via `aspire sdk dump --format json`. This tool transforms that output into a docs-friendly JSON format suitable for consumption by Astro's content collections. +The Aspire CLI can emit a JSON description of all polyglot-accessible capabilities for any hosting package via `aspire sdk dump --format json`. This tool transforms that output into a docs-friendly JSON format suitable for consumption by Astro's content collections. `--language typescript` (the default) writes the TypeScript modules and `--language go` writes the [Go modules](#go-output). -The companion `generate-ts-api-json.ps1` script reads the generated C# package JSON files in `src/frontend/src/data/pkgs/` and regenerates TypeScript API JSON using the same `Aspire.Hosting*` and `CommunityToolkit.Aspire.Hosting*` package/version sets. Modules with no generated functions or types are omitted so empty packages don't appear in the TypeScript API reference. +The companion `generate-ts-api-json.ps1` script reads the generated C# package JSON files in `src/frontend/src/data/pkgs/` and regenerates TypeScript API JSON using the same `Aspire.Hosting*` and `CommunityToolkit.Aspire.Hosting*` package/version sets. Modules with no generated functions or types are omitted so empty packages don't appear in the API reference. Pass `-Language go` to generate the Go modules into `src/frontend/src/data/go-modules/` from the same package/version sets; the concurrency, timeout, retry and diagnostic behavior below applies to both languages. ### Script behavior @@ -98,6 +98,106 @@ The generated JSON follows this schema: - **PropertySetter** — Property mutation on handle types (e.g., `ExecuteCommandContext.setResourceName`) - **InstanceMethod** — Methods called on handle instances (e.g., `DistributedApplication.run`) +## Go output + +`--language go` (`-l go`) writes the JSON behind the Go API reference in `src/frontend/src/data/go-modules/`. It reuses the naming and type rules of the Go AppHost SDK generator (`Aspire.Hosting.CodeGeneration.Go` in [microsoft/aspire](https://github.com/microsoft/aspire)), so signatures show the Go that an AppHost author writes. `typescript` stays the default and its output is unchanged. + +A Go AppHost compiles every package it uses into one flat `package aspire` (import path `apphost/modules/aspire`). A docs module is the contributing NuGet package, so each module has its own `package.name` and the same `package.importPath`. + +### Go usage + +Generate `Aspire.Hosting` first, then pass it, and any supporting packages, as `--base` for the packages that build on it: + +```bash +dotnet run --project AtsJsonGenerator.csproj -- \ + --language go \ + --input Aspire.Hosting.dump.json \ + --output ../../frontend/src/data/go-modules/Aspire.Hosting.json \ + --package-name "Aspire.Hosting" \ + --source-repo "https://github.com/microsoft/aspire" + +dotnet run --project AtsJsonGenerator.csproj -- \ + --language go \ + --input Aspire.Hosting.Redis.dump.json \ + --output ../../frontend/src/data/go-modules/Aspire.Hosting.Redis.json \ + --package-name "Aspire.Hosting.Redis" \ + --base ../../frontend/src/data/go-modules/Aspire.Hosting.json +``` + +`--base` accepts Go JSON only. It removes the functions, handles, DTOs, enums and exported values that a base already documents, and it seeds name resolution so the retained signatures use the base's exact type names. When two bases document the same type, the first `--base` wins. Without a base, a module also lists the core handle types that its dump references. `batch` accepts `--language` too, but it has no `--base`. + +To refresh the committed data for every package, run `pnpm update:go-api` from `src/frontend`. It drives `generate-ts-api-json.ps1 -Language go`, which generates `Aspire.Hosting` first so that every other module resolves its names against it. + +### Go output format + +```json +{ + "package": { + "name": "Aspire.Hosting.Redis", + "version": "13.6.0", + "language": "go", + "importPath": "apphost/modules/aspire", + "sourceRepository": "https://github.com/microsoft/aspire" + }, + "functions": [ + { + "name": "AddRedis", + "capabilityId": "Aspire.Hosting.Redis/addRedis", + "qualifiedName": "addRedis", + "description": "Adds a Redis container to the application model.", + "returns": "The resource builder.", + "kind": "Method", + "signature": "AddRedis(name string, options ...*AddRedisOptions) RedisResource", + "receiver": "DistributedApplicationBuilder", + "parameters": [{ "name": "name", "type": "string", "description": "..." }], + "options": { + "typeName": "AddRedisOptions", + "fields": [{ "name": "Port", "jsonName": "port", "type": "*float64", "description": "..." }] + }, + "returnType": "RedisResource", + "errorModel": "deferred", + "returnsBuilder": true, + "targetTypeId": "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder", + "expandedTargetTypes": ["Aspire.Hosting.IDistributedApplicationBuilder"], + "appliesTo": ["DistributedApplicationBuilder"] + } + ], + "handleTypes": [ + { + "name": "RedisResource", + "fullName": "Aspire.Hosting.ApplicationModel.RedisResource", + "kind": "handle", + "implementedInterfaces": ["IComputeResource", "ResourceWithConnectionString"], + "capabilities": [...], + "synthesizedMembers": [] + } + ], + "dtoTypes": [...], + "enumTypes": [...], + "exportedValues": [...] +} +``` + +Reading the model (boolean properties that are `false` are not written): + +- **Names.** `name` is the Go name. `qualifiedName` stays the ATS name that the TypeScript module uses (for example `RedisResource.connectionStringExpression`); a name without a `.` is a package-level extension export and a dotted name belongs to a handle type. +- **Signature and options.** `signature` omits the `func` keyword. Required parameters are positional; optional parameters become the fields of a trailing `options ...*Options` argument that `options.fields` documents. A field has a `jsonName` unless it is a callback (`isCallback`, with a `callbackSignature`). When `options.isDirect` is true the options type is an existing DTO and `fields` is empty. +- **Error model.** `errorModel` is `returned` (a trailing `error` result), `deferred` (a fluent handle return; failures surface when `Err()` is checked on a later result) or `none` (for example a mutable list or dictionary accessor). +- **Fluent returns.** `returnsBuilder` marks a method that returns a resource builder. `returnsReceiver` marks a method that returns the type it was called on, so each type in `appliesTo` substitutes its own name for `returnType`. +- **`appliesTo`.** The Go names of the concrete handle types that expose the function, with interface targets expanded. A handle's `capabilities` lists only functions that target it directly, so a page must combine them with every function whose `appliesTo` names the type, across all modules. +- **Handles.** `isMarker` handles are interface metadata that declare no methods of their own in Go; their methods live on each concrete implementing type. `implementedInterfaces` holds Go names. `synthesizedMembers` lists the hand-written members the Go SDK adds on top of the generated ones, for example `Get`, `Required`, `Value` and `RequiredValue` on `InteractionInputCollection`. +- **DTOs, enums and exported values.** DTO fields use Go types (`[]T`, `map[K]V`, `*T` when optional, `any` for unions). Enum members are `` constants. Exported values are grouped by their first path segment, and each entry's `value` is the Go literal text. +- **Prose.** `description`, `remarks` and `returns` come from XML documentation and can contain markdown. `remarks` can contain an unclosed code fence, so consumers must tolerate that. + +### Go limitations + +- **Azure Provisioning proxies.** `generate-ts-api-json.ps1 -Language go` skips the generated `Aspire.Hosting.Azure.Provisioning.` packages. Each one projects an entire `Azure.Provisioning` library, which comes to about 72 MB of JSON and tens of thousands of member pages, against about 6 MB for every other package combined. The base `Aspire.Hosting.Azure.Provisioning` package is kept, and a full run removes any stale output for the skipped packages. +- **Per-package names.** Names are resolved one dump at a time, seeded by the `--base` modules. A collision gets the sanitized assembly name as a prefix, then a numeric suffix, and a foreign interface that no base documents is assumed to be an exported handle. A real AppHost resolves names across all of its packages, so two integrations that define the same simple name can be named differently here. Don't assume a name is unique across modules, and generate packages in a stable order. +- **Skipped capabilities.** A capability with no concrete Go type to receive it is left out and reported as `Skipped N capabilities without a concrete Go type`. Runtime-provided capabilities (on `ReferenceExpression` or on a mutable list or dictionary) are omitted silently. +- **Callback properties on DTOs.** The dump doesn't carry the signature of a callback property, so these render as `func(...any) any` where the SDK has a typed callback (for example `CommandOptions.UpdateState`). +- **Enums.** Enum values come from the dump, supplemented by `aspire sdk export` when the package has generated exports. An enum that a signature references but the dump doesn't declare (for example `HealthStatus`) has no page. +- **SDK helper types.** Types that the Go SDK hand-writes in `base.go` are not generated, so they have no page. + ## Building ```bash diff --git a/src/tools/AtsJsonGenerator/generate-ts-api-json.ps1 b/src/tools/AtsJsonGenerator/generate-ts-api-json.ps1 index 45c9ec4170..e96a5acd59 100644 --- a/src/tools/AtsJsonGenerator/generate-ts-api-json.ps1 +++ b/src/tools/AtsJsonGenerator/generate-ts-api-json.ps1 @@ -1,7 +1,7 @@ #!/usr/bin/env pwsh <# .SYNOPSIS - Generates TypeScript API reference JSON files by running `aspire sdk dump --format json` + Generates TypeScript or Go API reference JSON files by running `aspire sdk dump --format json` for each Aspire or Community Toolkit hosting integration that has ATS capabilities. .DESCRIPTION @@ -12,7 +12,7 @@ For each eligible package, this script: 1. Runs `aspire sdk dump --format json` to generate raw ATS capabilities JSON 2. Runs the AtsJsonGenerator tool to transform it into docs-site JSON - 3. Outputs to src/frontend/src/data/ts-modules/ + 3. Outputs to src/frontend/src/data/ts-modules/ (src/frontend/src/data/go-modules/ with -Language go) .PARAMETER AspireRepoPath Path to a local microsoft/aspire repository clone. Discovers projects with @@ -25,7 +25,8 @@ .PARAMETER OutputDir The directory to write the generated JSON files to. - Defaults to /src/frontend/src/data/ts-modules. + Defaults to /src/frontend/src/data/ts-modules, or + /src/frontend/src/data/go-modules with -Language go. .PARAMETER PackageFilter Optional wildcard filter to process only specific packages (e.g. "*Redis*"). @@ -35,6 +36,10 @@ `aspire` CLI. Useful for testing local CLI changes. When set, the script invokes `dotnet run --no-launch-profile --project --` instead of `aspire`. +.PARAMETER Language + The API reference language to generate: `typescript` (the default) or `go`. + Each run generates one language; run the script once per language. + .ENVIRONMENT_VARIABLE ASPIRE_CLI_PATH Path to the installed Aspire CLI executable. Used when -AspireCliProject is not set; defaults to resolving `aspire` from PATH. @@ -49,6 +54,9 @@ # Filter to specific packages ./generate-ts-api-json.ps1 -AspireRepoPath D:\GitHub\aspire -PackageFilter "*Redis*" + + # Generate the Go API reference instead of the TypeScript one + ./generate-ts-api-json.ps1 -Language go #> [CmdletBinding()] @@ -61,7 +69,10 @@ param( [string]$PackageFilter, - [string]$AspireCliProject + [string]$AspireCliProject, + + [ValidateSet("typescript", "go")] + [string]$Language = "typescript" ) Set-StrictMode -Version Latest @@ -107,11 +118,14 @@ $MaxToolAttempts = 3 $CliTimeoutSeconds = 600 $ToolTimeoutSeconds = 300 +$LanguageDisplayName = if ($Language -eq "go") { "Go" } else { "TypeScript" } + $FinalOutputDir = if ($OutputDir) { [System.IO.Path]::GetFullPath($OutputDir) } else { - Join-Path $RepoRoot "src\frontend\src\data\ts-modules" + $defaultModulesDirectory = if ($Language -eq "go") { "go-modules" } else { "ts-modules" } + Join-Path $RepoRoot "src\frontend\src\data\$defaultModulesDirectory" } $OutputDir = Join-Path ([System.IO.Path]::GetDirectoryName($FinalOutputDir)) ( ".$([System.IO.Path]::GetFileName($FinalOutputDir))-staging-$([Guid]::NewGuid().ToString('N'))") @@ -171,7 +185,7 @@ function Remove-EmptyTsModuleFile { ) if (-not (Test-Path $OutputFile)) { - throw "Cannot inspect missing TypeScript module file at $OutputFile" + throw "Cannot inspect missing $LanguageDisplayName module file at $OutputFile" } $json = Get-Content $OutputFile -Raw | ConvertFrom-Json @@ -180,7 +194,7 @@ function Remove-EmptyTsModuleFile { } Remove-Item $OutputFile -Force - Write-Host " Omitted empty TypeScript module for $PackageName" -ForegroundColor DarkYellow + Write-Host " Omitted empty $LanguageDisplayName module for $PackageName" -ForegroundColor DarkYellow return $true } @@ -518,7 +532,7 @@ if (-not $AspireRepoPath -and -not $hasExplicitNuGetPackageVersion) { $hostingPackages = @($generatedPackageMetadata) if ($hostingPackages.Count -eq 0) { - Write-Error "No TypeScript SDK package JSON files found in src/frontend/src/data/pkgs" + Write-Error "No $LanguageDisplayName SDK package JSON files found in src/frontend/src/data/pkgs" return } @@ -527,18 +541,18 @@ if (-not $AspireRepoPath -and -not $hasExplicitNuGetPackageVersion) { $details = $duplicatePackages | ForEach-Object { "$($_.Name): $((@($_.Group) | ForEach-Object { "$($_.Version) [$($_.Path)]" }) -join ', ')" } - throw "Multiple generated C# package versions prevent deterministic TypeScript API generation:`n $($details -join "`n ")" + throw "Multiple generated C# package versions prevent deterministic $LanguageDisplayName API generation:`n $($details -join "`n ")" } # Build Name@Version entries directly from the generated C# package data. $NuGetPackageVersion = @($hostingPackages | ForEach-Object { "$($_.Name)@$($_.Version)" }) if ($NuGetPackageVersion.Count -eq 0) { - Write-Error "No versioned TypeScript SDK package JSON files found in $packageJsonDir" + Write-Error "No versioned $LanguageDisplayName SDK package JSON files found in $packageJsonDir" return } - Write-Host " Found $($NuGetPackageVersion.Count) TypeScript SDK packages to process" -ForegroundColor DarkGray + Write-Host " Found $($NuGetPackageVersion.Count) $LanguageDisplayName SDK packages to process" -ForegroundColor DarkGray } # ── Helpers: generate one package ────────────────────────────────────────────── @@ -705,7 +719,8 @@ function Invoke-TsModulePackage { Start-Sleep -Seconds (10 * $attempt) } - # Step 2: Resolve canonical enum definitions for generated exports + # Step 2: Resolve canonical enum definitions for generated exports. Enum values are + # language-neutral, so the Go pass reuses the TypeScript export. if ($Package.ContainsKey("HasGeneratedExports") -and $Package.HasGeneratedExports) { $exportFile = Join-Path $workDirectory "$name.canonical.json" $exportArgs = @("sdk", "export", "--language", "typescript", "--package", "$name@$version", "--non-interactive", "--nologo") @@ -738,7 +753,8 @@ function Invoke-TsModulePackage { $Settings.TransformerPath, "--input", $dumpFile, "--output", $outputFile, - "--package-name", $name + "--package-name", $name, + "--language", $Settings.Language ) if ($Package.SourceRepository) { $transformArgs += @("--source-repo", $Package.SourceRepository) @@ -770,6 +786,9 @@ function Invoke-TsModulePackage { elseif ($line -match "^(Generated|Unchanged):") { Write-PackageLog " $line" Success } + elseif ($line.StartsWith("Skipped ", [System.StringComparison]::Ordinal)) { + Write-PackageLog " $line" Detail + } } if ($dumpReportedDiagnostics -and $tolerated.Count -eq 0) { throw "aspire sdk dump failed (exit $($dump.ExitCode)) without reporting a known scanner defect:`n $(Get-ProcessOutput $dump)" @@ -859,7 +878,7 @@ if ($AspireRepoPath) { } } - # Only hosting packages expose ATS capabilities for the TypeScript SDK. + # Only hosting packages expose ATS capabilities for the polyglot SDKs. # Client/component packages (e.g. Aspire.Azure.Data.Tables) are not applicable. $hostingDirs = Get-ChildItem -Path $SrcDir -Directory -Filter "Aspire.Hosting.*" | Where-Object { $_.Name -notmatch "(Analyzers|CodeGeneration|RemoteHost|Tests)" @@ -893,7 +912,7 @@ if ($AspireRepoPath) { } # ── Route 2: Name@Version NuGet package references ──────────────────────────── -# Only Aspire.Hosting.* packages expose ATS capabilities for the TypeScript SDK. +# Only Aspire.Hosting.* packages expose ATS capabilities for the polyglot SDKs. # Client/component packages (e.g. Aspire.Azure.Data.Tables) are not applicable. if ($NuGetPackageVersion -and $NuGetPackageVersion.Count -gt 0) { foreach ($spec in $NuGetPackageVersion) { @@ -944,6 +963,20 @@ foreach ($pkg in $Packages | Where-Object { $_.Name -eq "Aspire.Hosting.Radius" } } +# The generated Azure.Provisioning proxy packages (Aspire.Hosting.Azure.Provisioning.) +# project every Azure.Provisioning type into Go: ~72 MB and tens of thousands of member pages, +# against ~6 MB for every other package combined. The Go reference omits them; the base +# Aspire.Hosting.Azure.Provisioning package is kept. +if ($Language -eq "go") { + $omittedPackageNames = @($Packages | Where-Object { + $_.Name.StartsWith("Aspire.Hosting.Azure.Provisioning.", [System.StringComparison]::OrdinalIgnoreCase) + } | ForEach-Object { $_.Name }) + if ($omittedPackageNames.Count -gt 0) { + Write-Host "Omitting $($omittedPackageNames.Count) Azure Provisioning proxy packages from the Go reference." -ForegroundColor DarkGray + $Packages = @($Packages | Where-Object { $omittedPackageNames -notcontains $_.Name }) + } +} + if ($PackageFilter) { $Packages = @($Packages | Where-Object { $_.Name -like $PackageFilter }) } @@ -963,7 +996,7 @@ if (-not $AspireRepoPath) { $aspireCliWorkingDirectory = New-TemporaryNuGetConfigDirectory -RestoreSources $restoreSources if ($officialFeed.IsRelease) { - Write-Host "Release branch detected ($($officialFeed.BranchName)). TypeScript module generation will resolve official Aspire packages from $($officialFeed.DisplayName)." -ForegroundColor Cyan + Write-Host "Release branch detected ($($officialFeed.BranchName)). $LanguageDisplayName module generation will resolve official Aspire packages from $($officialFeed.DisplayName)." -ForegroundColor Cyan } } @@ -1019,6 +1052,7 @@ $settings = @{ CliTimeoutSeconds = $CliTimeoutSeconds ToolTimeoutSeconds = $ToolTimeoutSeconds Parallelism = $Parallelism + Language = $Language } # Core Aspire.Hosting runs first so integrations can exclude its APIs. Packages diff --git a/tests/AtsJsonGenerator.Tests/AtsJsonGeneratorTests.cs b/tests/AtsJsonGenerator.Tests/AtsJsonGeneratorTests.cs index 1955cc4468..0cc000a3e9 100644 --- a/tests/AtsJsonGenerator.Tests/AtsJsonGeneratorTests.cs +++ b/tests/AtsJsonGenerator.Tests/AtsJsonGeneratorTests.cs @@ -3,6 +3,7 @@ namespace AtsJsonGenerator.Tests; +[Collection(ConsoleCapture.CollectionName)] public sealed class AtsJsonGeneratorTests { [Fact] diff --git a/tests/AtsJsonGenerator.Tests/ConsoleCapture.cs b/tests/AtsJsonGenerator.Tests/ConsoleCapture.cs new file mode 100644 index 0000000000..0ed6a1675e --- /dev/null +++ b/tests/AtsJsonGenerator.Tests/ConsoleCapture.cs @@ -0,0 +1,10 @@ +namespace AtsJsonGenerator.Tests; + +/// +/// Test classes that replace or share one collection +/// so they never run concurrently. Otherwise one class can restore a writer that another class already disposed. +/// +internal static class ConsoleCapture +{ + public const string CollectionName = "Console capture"; +} diff --git a/tests/AtsJsonGenerator.Tests/GoGenerateCommandTests.cs b/tests/AtsJsonGenerator.Tests/GoGenerateCommandTests.cs new file mode 100644 index 0000000000..ba33e7f6d8 --- /dev/null +++ b/tests/AtsJsonGenerator.Tests/GoGenerateCommandTests.cs @@ -0,0 +1,381 @@ +using System.CommandLine; +using System.Text.Json; +using AtsJsonGenerator.Helpers; +using static AtsJsonGenerator.Tests.GoTestDumps; + +namespace AtsJsonGenerator.Tests; + +[Collection(ConsoleCapture.CollectionName)] +public sealed class GoGenerateCommandTests +{ + [Fact] + public void TransformFile_WritesTheGoDocsModel() + { + using var tempDirectory = new TempDirectory(); + + var result = Generate(tempDirectory, PackageName, CreateWidgetDump()); + + Assert.Equal(0, result.ExitCode); + Assert.Equal(string.Empty, result.Error); + + var model = ReadGoPackage(result.OutputPath); + Assert.Equal(PackageName, model.Package.Name); + Assert.Equal("2.4.0", model.Package.Version); + Assert.Equal("https://github.com/microsoft/aspire", model.Package.SourceRepository); + Assert.Equal("abc123", model.Package.SourceCommit); + Assert.Equal("AddWidget(name string) WidgetResource", Assert.Single(model.Functions).Signature); + Assert.Equal( + $"Generated: {result.OutputPath} ({model.Functions.Count} functions, {model.HandleTypes.Count} handles, {model.DtoTypes.Count} DTOs, {model.EnumTypes.Count} enums)", + result.Output.Trim()); + } + + [Fact] + public void TransformFile_WritesTheJsonContractTheDocsSiteReads() + { + using var tempDirectory = new TempDirectory(); + + var result = Generate(tempDirectory, PackageName, CreateWidgetDump()); + + using var document = JsonDocument.Parse(File.ReadAllText(result.OutputPath)); + var root = document.RootElement; + Assert.Equal( + ["package", "functions", "handleTypes", "dtoTypes", "enumTypes", "exportedValues"], + root.EnumerateObject().Select(property => property.Name)); + + var package = root.GetProperty("package"); + Assert.Equal("go", package.GetProperty("language").GetString()); + Assert.Equal("apphost/modules/aspire", package.GetProperty("importPath").GetString()); + } + + [Fact] + public void TransformFile_DoesNotRewriteAnUnchangedModel() + { + using var tempDirectory = new TempDirectory(); + var first = Generate(tempDirectory, PackageName, CreateWidgetDump()); + var writeTime = new DateTime(2001, 1, 2, 0, 0, 0, DateTimeKind.Utc); + File.SetLastWriteTimeUtc(first.OutputPath, writeTime); + + var second = Generate(tempDirectory, PackageName, CreateWidgetDump()); + + Assert.Equal(0, second.ExitCode); + Assert.StartsWith("Unchanged:", second.Output); + Assert.Equal(writeTime, File.GetLastWriteTimeUtc(first.OutputPath)); + } + + [Fact] + public void TransformFile_RejectsAnUnsupportedLanguage() + { + using var tempDirectory = new TempDirectory(); + + var result = Generate(tempDirectory, PackageName, CreateWidgetDump(), language: "rust"); + + Assert.Equal(1, result.ExitCode); + Assert.Equal("Unsupported language 'rust'. Expected 'typescript' or 'go'.", result.Error.Trim()); + Assert.False(File.Exists(result.OutputPath)); + } + + [Fact] + public void TransformFile_ReportsAMissingBaseFile() + { + using var tempDirectory = new TempDirectory(); + var basePath = Path.Combine(tempDirectory.Path, "missing.base.json"); + + var result = Generate(tempDirectory, PackageName, CreateWidgetDump(), basePaths: [basePath]); + + Assert.Equal(1, result.ExitCode); + Assert.Equal($"Base file not found: {basePath}", result.Error.Trim()); + Assert.False(File.Exists(result.OutputPath)); + } + + [Fact] + public void TransformFile_FailsOnErrorDiagnosticsWithoutWritingTheModel() + { + using var tempDirectory = new TempDirectory(); + var dump = CreateWidgetDump(); + dump.Diagnostics.Add(new AtsDumpDiagnostic { Severity = "Error", Message = "scanner exploded" }); + + var exception = Assert.Throws(() => Generate(tempDirectory, PackageName, dump)); + + Assert.Contains("scanner exploded", exception.Message); + Assert.False(File.Exists(Path.Combine(tempDirectory.Path, $"{PackageName}.json"))); + } + + [Fact] + public void TransformFile_ReportsToleratedKnownScannerDiagnostics() + { + using var tempDirectory = new TempDirectory(); + var dump = new AtsDumpRoot + { + HandleTypes = AtsTransformerHelperTests.KnownProxyHandleTypes, + Diagnostics = + [ + new() { Severity = "Error", Message = AtsTransformerHelperTests.KustoInheritedDuplicate }, + new() { Severity = "Error", Message = AtsTransformerHelperTests.NetworkInheritedDuplicate }, + ], + }; + + Assert.Throws(() => Generate(tempDirectory, "Contoso.Tools", dump)); + + var result = Generate(tempDirectory, "Contoso.Tools", dump, tolerateKnownScannerDiagnostics: true); + + Assert.Equal(0, result.ExitCode); + Assert.True(File.Exists(result.OutputPath)); + var lines = result.Output.Split(Environment.NewLine); + Assert.Contains($"{KnownScannerDiagnostics.ToleratedOutputPrefix} {AtsTransformerHelperTests.KustoInheritedDuplicate}", lines); + Assert.Contains($"{KnownScannerDiagnostics.ToleratedOutputPrefix} {AtsTransformerHelperTests.NetworkInheritedDuplicate}", lines); + } + + [Fact] + public void TransformFile_ListsTheCapabilitiesTheGoSdkDoesNotExpose() + { + using var tempDirectory = new TempDirectory(); + var resource = HandleRef(ResourceTypeId, isInterface: true); + var dump = CreateWidgetDump(); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = ResourceTypeId, IsInterface = true }); + dump.Capabilities.Add(Method("Contoso.Widgets/zeta", "zeta", resource, Primitive("string"), expandedTargets: [])); + dump.Capabilities.Add(Method("Contoso.Widgets/alpha", "alpha", resource, Primitive("string"), expandedTargets: [])); + + var result = Generate(tempDirectory, PackageName, dump); + + Assert.Equal(0, result.ExitCode); + Assert.Contains( + "Skipped 2 capabilities without a concrete Go type: Contoso.Widgets/alpha, Contoso.Widgets/zeta", + result.Output.Split(Environment.NewLine)); + Assert.Equal( + ["Contoso.Widgets/addWidget"], + ReadGoPackage(result.OutputPath).Functions.Select(function => function.CapabilityId)); + } + + [Fact] + public void TransformFile_LeavesOutTheTypesOfABasePackageAndKeepsTheirNames() + { + using var tempDirectory = new TempDirectory(); + var core = Generate(tempDirectory, "Aspire.Hosting", CreateCoreDump()); + Assert.Equal(0, core.ExitCode); + + var tools = Generate(tempDirectory, "Contoso.Tools", CreateToolsDump(), basePaths: [core.OutputPath]); + + Assert.Equal(0, tools.ExitCode); + var model = ReadGoPackage(tools.OutputPath); + + var function = Assert.Single(model.Functions); + Assert.Equal("Contoso.Tools/addTool", function.CapabilityId); + Assert.Equal("AddTool(name string, mode CoreMode, options ...*CoreOptions) ToolResource", function.Signature); + Assert.Equal(["ToolResource"], model.HandleTypes.Select(handle => handle.Name)); + Assert.Equal(["ToolOptions"], model.DtoTypes.Select(dto => dto.Name)); + Assert.Equal(["ToolKind"], model.EnumTypes.Select(enumType => enumType.Name)); + Assert.Equal(["Defaults", "ToolDefaults"], model.ExportedValues.Select(group => group.Name)); + + var defaults = Assert.Single(model.ExportedValues, group => group.Name == "Defaults"); + Assert.Equal(["Timeout"], defaults.Values.Select(value => value.Path)); + } + + [Fact] + public void TransformFile_RemovesBaseCapabilitiesFromTheHandlesThatCarryThem() + { + using var tempDirectory = new TempDirectory(); + var basePath = Path.Combine(tempDirectory.Path, "base.json"); + File.WriteAllText(basePath, JsonSerializer.Serialize(new GoPackageModel + { + Package = new GoPackageInfo { Name = "Contoso.Base" }, + Functions = + [ + new GoFunctionModel + { + Name = "LegacyOp", + CapabilityId = "Contoso.Widgets/legacyOp", + QualifiedName = "legacyOp", + Kind = "InstanceMethod", + Signature = "LegacyOp() error", + ReturnType = "error", + ErrorModel = GoErrorModels.Returned, + }, + ], + })); + + var dump = CreateDump(); + dump.Capabilities.AddRange( + [ + Method("Contoso.Widgets/legacyOp", "legacyOp", GadgetRef(), Primitive("void"), capabilityKind: "InstanceMethod"), + Method("Contoso.Widgets/addNote", "addNote", GadgetRef(), Primitive("void"), capabilityKind: "InstanceMethod"), + ]); + + var result = Generate(tempDirectory, PackageName, dump, basePaths: [basePath]); + + Assert.Equal(0, result.ExitCode); + var model = ReadGoPackage(result.OutputPath); + Assert.Equal(["Contoso.Widgets/addNote"], model.Functions.Select(function => function.CapabilityId)); + + var gadget = Assert.Single(model.HandleTypes, handle => handle.Name == "GadgetResource"); + Assert.Equal(["Contoso.Widgets/addNote"], gadget.Capabilities.Select(capability => capability.CapabilityId)); + } + + [Fact] + public async Task Command_GeneratesGoDocsJsonForTheGoLanguage() + { + using var tempDirectory = new TempDirectory(); + var inputPath = WriteDump(Path.Combine(tempDirectory.Path, "input.json"), CreateWidgetDump()); + var outputPath = Path.Combine(tempDirectory.Path, "output", "widgets.json"); + + var result = await CaptureAsync(() => GenerateCommand.GetCommand() + .Parse(["--input", inputPath, "--output", outputPath, "--package-name", PackageName, "--language", "go"]) + .InvokeAsync()); + + Assert.Equal(0, result.ExitCode); + var model = ReadGoPackage(outputPath); + Assert.Equal(PackageName, model.Package.Name); + Assert.Equal("AddWidget(name string) WidgetResource", Assert.Single(model.Functions).Signature); + } + + [Fact] + public async Task Command_GeneratesTypeScriptDocsJsonByDefault() + { + using var tempDirectory = new TempDirectory(); + var inputPath = WriteDump(Path.Combine(tempDirectory.Path, "input.json"), CreateWidgetDump()); + var outputPath = Path.Combine(tempDirectory.Path, "output", "widgets.json"); + + var result = await CaptureAsync(() => GenerateCommand.GetCommand() + .Parse(["--input", inputPath, "--output", outputPath, "--package-name", PackageName]) + .InvokeAsync()); + + Assert.Equal(0, result.ExitCode); + using var document = JsonDocument.Parse(File.ReadAllText(outputPath)); + Assert.Equal("typescript", document.RootElement.GetProperty("package").GetProperty("language").GetString()); + } + + [Fact] + public void Command_RejectsALanguageItDoesNotSupport() + { + var parseResult = GenerateCommand.GetCommand() + .Parse(["--input", "input.json", "--output", "output.json", "--language", "rust"]); + + Assert.Contains(parseResult.Errors, error => error.Message.Contains("rust", StringComparison.Ordinal)); + } + + [Fact] + public async Task BatchCommand_GeneratesGoDocsJsonForEachInput() + { + using var tempDirectory = new TempDirectory(); + var inputPath = WriteDump(Path.Combine(tempDirectory.Path, "input", $"{PackageName}.json"), CreateWidgetDump()); + var outputDirectory = Path.Combine(tempDirectory.Path, "output"); + var rootCommand = GenerateCommand.GetCommand(); + rootCommand.Add(BatchGenerateCommand.GetCommand()); + + var result = await CaptureAsync(() => rootCommand + .Parse(["batch", "--input", inputPath, "--output-dir", outputDirectory, "--language", "go"]) + .InvokeAsync()); + + Assert.Equal(0, result.ExitCode); + Assert.Equal(string.Empty, result.Error); + var model = ReadGoPackage(Path.Combine(outputDirectory, $"{PackageName}.json")); + Assert.Equal("AddWidget(name string) WidgetResource", Assert.Single(model.Functions).Signature); + } + + private static AtsDumpRoot CreateWidgetDump() + { + var dump = CreateDump(); + dump.Capabilities.Add(Method( + "Contoso.Widgets/addWidget", + "addWidget", + BuilderRef(), + WidgetRef(), + [Param("name", Primitive("string"))], + returnsBuilder: true)); + + return dump; + } + + private static string WriteDump(string path, AtsDumpRoot dump) + { + Directory.CreateDirectory(Path.GetDirectoryName(path)!); + File.WriteAllText(path, JsonSerializer.Serialize(dump)); + + return path; + } + + /// + /// Runs against a dump written next to the output, + /// which is {packageName}.json in the same directory. + /// + private static GenerateResult Generate( + TempDirectory tempDirectory, + string packageName, + AtsDumpRoot dump, + string[]? basePaths = null, + bool tolerateKnownScannerDiagnostics = false, + string language = GenerateCommand.GoLanguage) + { + var inputPath = WriteDump(Path.Combine(tempDirectory.Path, $"{packageName}.dump.json"), dump); + var outputPath = Path.Combine(tempDirectory.Path, $"{packageName}.json"); + + var (exitCode, output, error) = Capture(() => GenerateCommand.TransformFile( + inputPath, + outputPath, + packageName, + version: null, + sourceRepo: "https://github.com/microsoft/aspire", + sourceCommit: "abc123", + basePaths, + tolerateKnownScannerDiagnostics, + language)); + + return new GenerateResult(outputPath, exitCode, output, error); + } + + private static GoPackageModel ReadGoPackage(string path) + { + var model = JsonSerializer.Deserialize(File.ReadAllText(path)); + Assert.NotNull(model); + + return model; + } + + private static (int ExitCode, string Output, string Error) Capture(Func action) => + CaptureAsync(() => Task.FromResult(action())).GetAwaiter().GetResult(); + + // Console is process-wide, so every class that redirects it shares ConsoleCapture.CollectionName. + private static async Task<(int ExitCode, string Output, string Error)> CaptureAsync(Func> action) + { + var originalOut = Console.Out; + var originalError = Console.Error; + using var capturedOut = new StringWriter(); + using var capturedError = new StringWriter(); + int exitCode; + try + { + Console.SetOut(capturedOut); + Console.SetError(capturedError); + exitCode = await action(); + } + finally + { + Console.SetOut(originalOut); + Console.SetError(originalError); + } + + return (exitCode, capturedOut.ToString(), capturedError.ToString()); + } + + private sealed record GenerateResult(string OutputPath, int ExitCode, string Output, string Error); + + private sealed class TempDirectory : IDisposable + { + public TempDirectory() + { + Path = Directory.CreateTempSubdirectory("ats-json-generator-tests-").FullName; + } + + public string Path { get; } + + public void Dispose() + { + try + { + Directory.Delete(Path, recursive: true); + } + catch + { + } + } + } +} diff --git a/tests/AtsJsonGenerator.Tests/GoTestDumps.cs b/tests/AtsJsonGenerator.Tests/GoTestDumps.cs new file mode 100644 index 0000000000..d26f44d20a --- /dev/null +++ b/tests/AtsJsonGenerator.Tests/GoTestDumps.cs @@ -0,0 +1,274 @@ +using System.Text.Json; +using AtsJsonGenerator.Helpers; + +namespace AtsJsonGenerator.Tests; + +/// +/// Builds ATS dumps shaped like the output of aspire sdk dump --format json +/// for the Go docs-site tests. +/// +internal static class GoTestDumps +{ + public const string PackageName = "Contoso.Widgets"; + public const string BuilderTypeId = "Aspire.Hosting/Aspire.Hosting.IDistributedApplicationBuilder"; + public const string ApplicationTypeId = "Aspire.Hosting/Aspire.Hosting.DistributedApplication"; + public const string ReferenceExpressionTypeId = "Aspire.Hosting/Aspire.Hosting.ApplicationModel.ReferenceExpression"; + public const string CreateBuilderOptionsTypeId = "Aspire.Hosting/Aspire.Hosting.CreateBuilderOptions"; + public const string InteractionInputCollectionTypeId = "Aspire.Hosting/Aspire.Hosting.InteractionInputCollection"; + public const string WidgetTypeId = "Contoso.Widgets/Contoso.Widgets.WidgetResource"; + public const string GadgetTypeId = "Contoso.Widgets/Contoso.Widgets.GadgetResource"; + public const string ThingTypeId = "Contoso.Widgets/Contoso.Widgets.ThingResource"; + public const string ResourceTypeId = "Contoso.Widgets/Contoso.Widgets.IResource"; + public const string ModeFullName = "Contoso.Widgets.WidgetMode"; + + // Types owned by the core package that integration dumps also contain. + public const string CoreResourceTypeId = "Aspire.Hosting/Aspire.Hosting.CoreResource"; + public const string CoreOptionsTypeId = "Aspire.Hosting/Aspire.Hosting.CoreOptions"; + public const string CoreModeFullName = "Aspire.Hosting.CoreMode"; + public const string ToolTypeId = "Contoso.Tools/Contoso.Tools.ToolResource"; + public const string ToolOptionsTypeId = "Contoso.Tools/Contoso.Tools.ToolOptions"; + public const string ToolKindFullName = "Contoso.Tools.ToolKind"; + + public static AtsDumpTypeRef Primitive(string typeId, bool isNullable = false) => new() + { + TypeId = typeId, + Category = AtsTypeCategories.Primitive, + IsNullable = isNullable, + }; + + public static AtsDumpTypeRef HandleRef(string typeId, bool isInterface = false) => new() + { + TypeId = typeId, + Category = AtsTypeCategories.Handle, + IsInterface = isInterface, + }; + + public static AtsDumpTypeRef BuilderRef() => HandleRef(BuilderTypeId, isInterface: true); + + public static AtsDumpTypeRef ApplicationRef() => HandleRef(ApplicationTypeId); + + public static AtsDumpTypeRef WidgetRef() => HandleRef(WidgetTypeId); + + public static AtsDumpTypeRef GadgetRef() => HandleRef(GadgetTypeId); + + public static AtsDumpTypeRef ThingRef() => HandleRef(ThingTypeId); + + public static AtsDumpTypeRef DtoRef(string typeId) => new() + { + TypeId = typeId, + Category = AtsTypeCategories.Dto, + }; + + public static AtsDumpTypeRef EnumRef(string fullName) => new() + { + TypeId = $"enum:{fullName}", + Category = AtsTypeCategories.Enum, + }; + + public static AtsDumpTypeRef CallbackRef() => new() + { + TypeId = "callback", + Category = AtsTypeCategories.Callback, + }; + + public static AtsDumpTypeRef ListOf(AtsDumpTypeRef element, bool isReadOnly = false) => new() + { + TypeId = $"Aspire.Hosting/List<{element.TypeId}>", + Category = AtsTypeCategories.List, + ElementType = element, + IsReadOnly = isReadOnly, + }; + + public static AtsDumpTypeRef DictOf(AtsDumpTypeRef key, AtsDumpTypeRef value, bool isReadOnly = false) => new() + { + TypeId = $"Aspire.Hosting/Dict<{key.TypeId},{value.TypeId}>", + Category = AtsTypeCategories.Dict, + KeyType = key, + ValueType = value, + IsReadOnly = isReadOnly, + }; + + public static AtsDumpTypeRef UnionOf(params AtsDumpTypeRef[] members) => new() + { + TypeId = string.Join('|', members.Select(member => member.TypeId)), + Category = AtsTypeCategories.Union, + UnionTypes = [.. members], + }; + + public static AtsDumpParameter Param(string name, AtsDumpTypeRef type, bool isOptional = false) => new() + { + Name = name, + Type = type, + IsOptional = isOptional, + }; + + public static AtsDumpParameter CallbackParam( + string name, + AtsDumpTypeRef? returnType, + params (string Name, AtsDumpTypeRef Type)[] parameters) => new() + { + Name = name, + Type = CallbackRef(), + IsCallback = true, + CallbackParameters = [.. parameters.Select(parameter => new AtsDumpCallbackParam { Name = parameter.Name, Type = parameter.Type })], + CallbackReturnType = returnType, + }; + + /// + /// Creates a capability whose first parameter is the target, as the dump does for every capability. + /// Pass an empty for a capability with no concrete targets. + /// + public static AtsDumpCapability Method( + string capabilityId, + string methodName, + AtsDumpTypeRef target, + AtsDumpTypeRef? returnType, + IEnumerable? parameters = null, + IEnumerable? expandedTargets = null, + bool returnsBuilder = false, + string capabilityKind = "Method", + string targetParameterName = "builder", + string? qualifiedMethodName = null, + AtsDumpDocumentation? documentation = null, + string? description = null) + { + IEnumerable callerParameters = parameters ?? []; + IEnumerable targets = expandedTargets ?? [target]; + + return new AtsDumpCapability + { + CapabilityId = capabilityId, + MethodName = methodName, + QualifiedMethodName = qualifiedMethodName ?? methodName, + CapabilityKind = capabilityKind, + TargetTypeId = target.TypeId, + TargetParameterName = targetParameterName, + TargetType = target, + ReturnsBuilder = returnsBuilder, + ReturnType = returnType, + Documentation = documentation, + Description = description, + Parameters = [Param(targetParameterName, target), .. callerParameters], + ExpandedTargetTypes = [.. targets], + }; + } + + public static AtsDumpCapability CreateBuilderCapability() => new() + { + CapabilityId = "Aspire.Hosting/createBuilder", + MethodName = "createBuilder", + QualifiedMethodName = "createBuilder", + CapabilityKind = "Method", + TargetTypeId = "any", + TargetParameterName = "argsOrOptions", + TargetType = Primitive("any"), + ReturnType = BuilderRef(), + ExpandedTargetTypes = [], + }; + + public static AtsDumpCapability BuildCapability() => Method( + "Aspire.Hosting/build", + "build", + BuilderRef(), + ApplicationRef(), + capabilityKind: "InstanceMethod"); + + public static AtsDumpExportedValue ExportedValue(string[] pathSegments, AtsDumpTypeRef type, object? value) => new() + { + PathSegments = [.. pathSegments], + Type = type, + Value = value is null ? null : JsonSerializer.SerializeToElement(value), + }; + + public static AtsDumpEnumType ModeEnum() => new() + { + TypeId = $"enum:{ModeFullName}", + Name = "WidgetMode", + Values = ["Fast", "Slow"], + }; + + /// + /// A dump with the builder, application and a few resource handles but no capabilities. + /// + public static AtsDumpRoot CreateDump() => new() + { + Packages = [new AtsDumpPackageRef { Name = PackageName, Version = "2.4.0" }], + HandleTypes = + [ + new AtsDumpHandleType { AtsTypeId = BuilderTypeId, IsInterface = true }, + new AtsDumpHandleType { AtsTypeId = ApplicationTypeId }, + new AtsDumpHandleType { AtsTypeId = WidgetTypeId }, + new AtsDumpHandleType { AtsTypeId = GadgetTypeId }, + ], + }; + + /// + /// A dump for the core package, which owns the builder, an options type, an enum and exported values. + /// + public static AtsDumpRoot CreateCoreDump() => new() + { + Packages = [new AtsDumpPackageRef { Name = "Aspire.Hosting", Version = "13.0.0" }], + HandleTypes = + [ + new AtsDumpHandleType { AtsTypeId = BuilderTypeId, IsInterface = true }, + new AtsDumpHandleType { AtsTypeId = ApplicationTypeId }, + new AtsDumpHandleType { AtsTypeId = CoreResourceTypeId }, + ], + DtoTypes = + [ + new AtsDumpDtoType + { + TypeId = CoreOptionsTypeId, + Name = "CoreOptions", + Properties = [new AtsDumpDtoProperty { Name = "size", Type = Primitive("number", isNullable: true), IsOptional = true }], + }, + ], + EnumTypes = + [ + new AtsDumpEnumType { TypeId = $"enum:{CoreModeFullName}", Name = "CoreMode", Values = ["Fast", "Slow"] }, + ], + Capabilities = + [ + Method( + "Aspire.Hosting/addCore", + "addCore", + BuilderRef(), + HandleRef(CoreResourceTypeId), + [Param("name", Primitive("string"))], + returnsBuilder: true), + ], + ExportedValues = + [ + ExportedValue(["Defaults", "Retries"], Primitive("number"), 3), + ExportedValue(["Version", "Current"], Primitive("string"), "1.0"), + ], + }; + + /// + /// A dump for an integration. Dumps list every type their capabilities reference, so it repeats the + /// core package's types and adds its own. + /// + public static AtsDumpRoot CreateToolsDump() + { + var dump = CreateCoreDump(); + dump.Packages.Add(new AtsDumpPackageRef { Name = "Contoso.Tools", Version = "2.4.0" }); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = ToolTypeId }); + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = ToolOptionsTypeId, Name = "ToolOptions" }); + dump.EnumTypes.Add(new AtsDumpEnumType { TypeId = $"enum:{ToolKindFullName}", Name = "ToolKind", Values = ["Cli"] }); + dump.Capabilities.Add(Method( + "Contoso.Tools/addTool", + "addTool", + BuilderRef(), + HandleRef(ToolTypeId), + [ + Param("name", Primitive("string")), + Param("mode", EnumRef(CoreModeFullName)), + Param("options", DtoRef(CoreOptionsTypeId), isOptional: true), + ], + returnsBuilder: true)); + dump.ExportedValues.Add(ExportedValue(["Defaults", "Timeout"], Primitive("number"), 30)); + dump.ExportedValues.Add(ExportedValue(["ToolDefaults", "Size"], Primitive("number"), 5)); + + return dump; + } +} diff --git a/tests/AtsJsonGenerator.Tests/GoTransformerTests.cs b/tests/AtsJsonGenerator.Tests/GoTransformerTests.cs new file mode 100644 index 0000000000..59b9f5df5b --- /dev/null +++ b/tests/AtsJsonGenerator.Tests/GoTransformerTests.cs @@ -0,0 +1,966 @@ +using System.Text.Json; +using AtsJsonGenerator.Helpers; +using static AtsJsonGenerator.Tests.GoTestDumps; + +namespace AtsJsonGenerator.Tests; + +public sealed class GoTransformerTests +{ + private const string GadgetOptionsTypeId = "Contoso.Widgets/Contoso.Widgets.GadgetOptions"; + private const string WidgetOptionsTypeId = "Contoso.Widgets/Contoso.Widgets.WidgetOptions"; + private const string InnerOptionsTypeId = "Contoso.Widgets/Contoso.Widgets.InnerOptions"; + private const string FactoryContextTypeId = "Contoso.Widgets/Contoso.Widgets.FactoryContext"; + private const string ParameterResourceTypeId = "Contoso.Widgets/Contoso.Widgets.ParameterResource"; + private const string LifetimeFullName = "Aspire.Hosting.ApplicationModel.ContainerLifetime"; + private const string CommandOptionsFullName = "Aspire.Hosting.ApplicationModel.CommandOptions"; + private const string CommandOptionsTypeId = "Aspire.Hosting/" + CommandOptionsFullName; + + [Fact] + public void Transform_ReadsPackageMetadataFromTheDump() + { + var model = GoTransformer.Transform(CreateDump(), PackageName); + + Assert.Equal(PackageName, model.Package.Name); + Assert.Equal("2.4.0", model.Package.Version); + Assert.Equal("go", model.Package.Language); + Assert.Equal("apphost/modules/aspire", model.Package.ImportPath); + } + + [Fact] + public void Transform_PrefersAnExplicitVersionAndRecordsTheSource() + { + var model = GoTransformer.Transform( + CreateDump(), + PackageName, + version: "3.0.0", + sourceRepository: "https://github.com/microsoft/aspire", + sourceCommit: "abc123"); + + Assert.Equal("3.0.0", model.Package.Version); + Assert.Equal("https://github.com/microsoft/aspire", model.Package.SourceRepository); + Assert.Equal("abc123", model.Package.SourceCommit); + } + + [Fact] + public void Transform_ThrowsOnErrorDiagnostics() + { + var dump = CreateDump(); + dump.Diagnostics.Add(new AtsDumpDiagnostic { Severity = "Error", Message = "scanner exploded" }); + + var exception = Assert.Throws(() => GoTransformer.Transform(dump, PackageName)); + + Assert.Contains("scanner exploded", exception.Message); + } + + [Fact] + public void Transform_ToleratesKnownScannerDiagnosticsOnlyWhenRequested() + { + var dump = new AtsDumpRoot + { + Packages = [new AtsDumpPackageRef { Name = PackageName, Version = "2.4.0" }], + HandleTypes = AtsTransformerHelperTests.KnownProxyHandleTypes, + Diagnostics = [new AtsDumpDiagnostic { Severity = "Error", Message = AtsTransformerHelperTests.KustoInheritedDuplicate }], + }; + + Assert.Throws(() => GoTransformer.Transform(dump, PackageName)); + + var model = GoTransformer.Transform(dump, PackageName, tolerateKnownScannerDiagnostics: true); + + Assert.Equal(PackageName, model.Package.Name); + } + + [Fact] + public void Transform_RendersCreateBuilderWithTheOptionsDto() + { + var model = GoTransformer.Transform(CreateEntryPointDump(includeCreateBuilderOptions: true), PackageName); + + var function = GetFunction(model, "Aspire.Hosting/createBuilder"); + Assert.Equal("CreateBuilder(options ...*CreateBuilderOptions) (DistributedApplicationBuilder, error)", function.Signature); + Assert.Equal("returned", function.ErrorModel); + Assert.Null(function.Receiver); + Assert.Empty(function.AppliesTo); + Assert.Equal("CreateBuilder establishes a connection to the AppHost and returns a new builder.", function.Description); + + var options = GetOptions(function); + Assert.Equal("CreateBuilderOptions", options.TypeName); + Assert.True(options.IsDirect); + Assert.Empty(options.Fields); + } + + [Fact] + public void Transform_RendersCreateBuilderWithoutOptionsWhenTheDumpHasNoOptionsDto() + { + var model = GoTransformer.Transform(CreateEntryPointDump(includeCreateBuilderOptions: false), PackageName); + + var function = GetFunction(model, "Aspire.Hosting/createBuilder"); + Assert.Equal("CreateBuilder() (DistributedApplicationBuilder, error)", function.Signature); + Assert.Null(function.Options); + } + + [Fact] + public void Transform_RendersBuildOnTheBuilder() + { + var model = GoTransformer.Transform(CreateEntryPointDump(includeCreateBuilderOptions: false), PackageName); + + var function = GetFunction(model, "Aspire.Hosting/build"); + Assert.Equal("Build() (DistributedApplication, error)", function.Signature); + Assert.Equal("returned", function.ErrorModel); + Assert.Equal("DistributedApplicationBuilder", function.Receiver); + Assert.Equal(["DistributedApplicationBuilder"], function.AppliesTo); + + var builder = GetHandle(model, "DistributedApplicationBuilder"); + Assert.True(builder.IsInterface); + Assert.False(builder.IsMarker); + Assert.Equal(["Aspire.Hosting/build"], builder.Capabilities.Select(capability => capability.CapabilityId)); + } + + [Theory] + [InlineData("Contoso.Widgets/addWidget", "AddWidget(name string) WidgetResource", "deferred")] + [InlineData("Contoso.Widgets/withLabel", "WithLabel(label string, options ...*WithLabelOptions) WidgetResource", "deferred")] + [InlineData("Contoso.Widgets/getCount", "GetCount() (float64, error)", "returned")] + [InlineData("Contoso.Widgets/reset", "Reset() error", "returned")] + [InlineData("Contoso.Widgets/touch", "Touch() error", "returned")] + [InlineData("Contoso.Widgets/withKind", "WithKind(type_ string, range_ string) WidgetResource", "deferred")] + [InlineData("Contoso.Widgets/addGadget", "AddGadget(name string, options ...*GadgetOptions) GadgetResource", "deferred")] + [InlineData("Contoso.Widgets/withFactory", "WithFactory(path string, factory func(arg FactoryContext) string) WidgetResource", "deferred")] + [InlineData("Contoso.Widgets/withEndpoint", "WithEndpoint(endpoint any) WidgetResource", "deferred")] + [InlineData("Contoso.Widgets/WidgetResource.tags", "Tags() *List[string]", "none")] + [InlineData("Contoso.Widgets/WidgetResource.labels", "Labels() ([]string, error)", "returned")] + [InlineData("Contoso.Widgets/WidgetResource.env", "Env() *Dict[string, string]", "none")] + [InlineData("Contoso.Widgets/run", "Run(options ...*RunOptions) error", "returned")] + [InlineData("Contoso.Widgets/withMode", "WithMode(mode WidgetMode, options ...*WithModeOptions) WidgetResource", "deferred")] + public void Transform_RendersGoSignatures(string capabilityId, string signature, string errorModel) + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var function = GetFunction(model, capabilityId); + Assert.Equal(signature, function.Signature); + Assert.Equal(errorModel, function.ErrorModel); + } + + [Fact] + public void Transform_RecordsTheReceiverAndTheTypesAFunctionAppliesTo() + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var addWidget = GetFunction(model, "Contoso.Widgets/addWidget"); + Assert.Equal("DistributedApplicationBuilder", addWidget.Receiver); + Assert.Equal(["DistributedApplicationBuilder"], addWidget.AppliesTo); + Assert.True(addWidget.ReturnsBuilder); + Assert.False(addWidget.ReturnsReceiver); + + var withLabel = GetFunction(model, "Contoso.Widgets/withLabel"); + Assert.Equal("WidgetResource", withLabel.Receiver); + Assert.Equal(["WidgetResource"], withLabel.AppliesTo); + Assert.True(withLabel.ReturnsReceiver); + } + + [Fact] + public void Transform_GroupsCapabilitiesUnderTheirTargetHandle() + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + Assert.Equal( + ["Contoso.Widgets/addGadget", "Contoso.Widgets/addWidget"], + GetHandle(model, "DistributedApplicationBuilder").Capabilities.Select(capability => capability.CapabilityId).Order(StringComparer.Ordinal)); + Assert.Equal( + ["Contoso.Widgets/run"], + GetHandle(model, "DistributedApplication").Capabilities.Select(capability => capability.CapabilityId)); + } + + [Fact] + public void Transform_CarriesDocumentationOntoFunctionsAndParameters() + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var documented = GetFunction(model, "Contoso.Widgets/withLabel"); + Assert.Equal("Adds a label to the widget.", documented.Description); + Assert.Equal("Labels are case sensitive.", documented.Remarks); + Assert.Equal("The widget builder.", documented.Returns); + Assert.Equal("The label text.", Assert.Single(documented.Parameters).Description); + + var legacy = GetFunction(model, "Contoso.Widgets/getCount"); + Assert.Equal("Gets the number of widgets.", legacy.Description); + Assert.Null(legacy.Remarks); + } + + [Theory] + [InlineData("Contoso.Widgets/withLabel", "WithLabelOptions", "Tag", "tag", "*string")] + [InlineData("Contoso.Widgets/withMode", "WithModeOptions", "Fallback", "fallback", "*WidgetMode")] + [InlineData("Contoso.Widgets/run", "RunOptions", "CancellationToken", null, "*CancellationToken")] + public void Transform_CollectsOptionalParametersIntoAnOptionsStruct( + string capabilityId, + string typeName, + string fieldName, + string? jsonName, + string fieldType) + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var options = GetOptions(GetFunction(model, capabilityId)); + Assert.Equal(typeName, options.TypeName); + Assert.False(options.IsDirect); + + var field = Assert.Single(options.Fields); + Assert.Equal(fieldName, field.Name); + Assert.Equal(jsonName, field.JsonName); + Assert.Equal(fieldType, field.Type); + } + + [Fact] + public void Transform_PassesAnOptionsDtoDirectlyAndOmitsOptionsWhenThereAreNoOptionalParameters() + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var direct = GetOptions(GetFunction(model, "Contoso.Widgets/addGadget")); + Assert.Equal("GadgetOptions", direct.TypeName); + Assert.True(direct.IsDirect); + Assert.Empty(direct.Fields); + + Assert.Null(GetFunction(model, "Contoso.Widgets/getCount").Options); + } + + [Fact] + public void Transform_ListsOnlyRequiredParametersAndEscapesGoKeywords() + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var withLabel = GetFunction(model, "Contoso.Widgets/withLabel"); + Assert.Equal(["label"], withLabel.Parameters.Select(parameter => parameter.Name)); + + var withKind = GetFunction(model, "Contoso.Widgets/withKind"); + Assert.Equal(["type_", "range_"], withKind.Parameters.Select(parameter => parameter.Name)); + } + + [Fact] + public void Transform_DescribesCallbackAndUnionParameters() + { + var model = GoTransformer.Transform(CreateShapesDump(), PackageName); + + var factory = Assert.Single(GetFunction(model, "Contoso.Widgets/withFactory").Parameters, parameter => parameter.Name == "factory"); + Assert.True(factory.IsCallback); + Assert.Equal("func(arg FactoryContext) string", factory.Type); + Assert.Equal("func(arg FactoryContext) string", factory.CallbackSignature); + Assert.Null(factory.AllowedTypes); + + var endpoint = Assert.Single(GetFunction(model, "Contoso.Widgets/withEndpoint").Parameters); + Assert.False(endpoint.IsCallback); + Assert.Equal("any", endpoint.Type); + Assert.Equal(["string", "ParameterResource"], endpoint.AllowedTypes); + } + + [Fact] + public void Transform_ExpandsInterfaceTargetsOntoTheConcreteTypesThatImplementThem() + { + var resource = HandleRef(ResourceTypeId, isInterface: true); + var dump = CreateDump(); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = ResourceTypeId, IsInterface = true }); + dump.Capabilities.Add(Method( + "Contoso.Widgets/withDescription", + "withDescription", + resource, + resource, + [Param("description", Primitive("string"))], + expandedTargets: [WidgetRef(), GadgetRef()], + returnsBuilder: true)); + + var model = GoTransformer.Transform(dump, PackageName); + + var function = GetFunction(model, "Contoso.Widgets/withDescription"); + Assert.Equal("WithDescription(description string) Resource", function.Signature); + Assert.Equal("Resource", function.Receiver); + Assert.Equal("Resource", function.ReturnType); + Assert.True(function.ReturnsReceiver); + Assert.Equal(["GadgetResource", "WidgetResource"], function.AppliesTo); + Assert.Equal( + ["Contoso.Widgets/withDescription"], + GetHandle(model, "Resource").Capabilities.Select(capability => capability.CapabilityId)); + } + + [Fact] + public void Transform_QualifiesHandleNamesThatCollideAcrossAssemblies() + { + var dump = new AtsDumpRoot + { + Packages = [new AtsDumpPackageRef { Name = PackageName, Version = "2.4.0" }], + HandleTypes = + [ + new AtsDumpHandleType { AtsTypeId = "Contoso.A/Contoso.Widget" }, + new AtsDumpHandleType { AtsTypeId = "Contoso.B/Contoso.Widget" }, + ], + }; + + var model = GoTransformer.Transform(dump, PackageName); + + Assert.Equal(["Contoso_BWidget", "Widget"], model.HandleTypes.Select(handle => handle.Name).Order(StringComparer.Ordinal)); + Assert.All(model.HandleTypes, handle => Assert.Equal("Contoso.Widget", handle.FullName)); + } + + [Fact] + public void Transform_NumbersHandleNamesThatStillCollideAfterQualification() + { + var dump = new AtsDumpRoot + { + Packages = [new AtsDumpPackageRef { Name = PackageName, Version = "2.4.0" }], + HandleTypes = + [ + new AtsDumpHandleType { AtsTypeId = "Contoso.A/Contoso.Widget" }, + new AtsDumpHandleType { AtsTypeId = "Contoso.B/Contoso.X.Widget" }, + new AtsDumpHandleType { AtsTypeId = "Contoso.B/Contoso.Y.Widget" }, + ], + }; + + var model = GoTransformer.Transform(dump, PackageName); + + Assert.Equal( + ["Contoso_BWidget", "Widget", "Widget2"], + model.HandleTypes.Select(handle => handle.Name).Order(StringComparer.Ordinal)); + } + + [Fact] + public void Transform_StripsTheInterfacePrefixOnlyFromInterfacesTheDumpDoesNotOwn() + { + var dump = CreateDump(); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = ResourceTypeId, IsInterface = true }); + dump.Capabilities.Add(Method( + "Contoso.Widgets/useLogger", + "useLogger", + WidgetRef(), + WidgetRef(), + [ + Param("logger", HandleRef("Microsoft.Extensions.Logging/Microsoft.Extensions.Logging.ILogger", isInterface: true)), + Param("compute", HandleRef("Contoso.Widgets/Contoso.Widgets.IComputeResource", isInterface: true)), + ], + returnsBuilder: true)); + + var model = GoTransformer.Transform(dump, PackageName); + + Assert.Equal( + "UseLogger(logger Logger, compute IComputeResource) WidgetResource", + GetFunction(model, "Contoso.Widgets/useLogger").Signature); + + var logger = GetHandle(model, "Logger"); + Assert.True(logger.IsInterface); + Assert.True(logger.IsMarker); + + var compute = GetHandle(model, "IComputeResource"); + Assert.False(compute.IsInterface); + Assert.False(compute.IsMarker); + + var resource = GetHandle(model, "Resource"); + Assert.True(resource.IsInterface); + Assert.True(resource.IsMarker); + } + + [Fact] + public void Transform_DescribesHandlesAndListsOnlyTheInterfacesTheGoSdkExposes() + { + var dump = new AtsDumpRoot + { + Packages = [new AtsDumpPackageRef { Name = PackageName, Version = "2.4.0" }], + HandleTypes = + [ + new AtsDumpHandleType { AtsTypeId = ResourceTypeId, IsInterface = true }, + new AtsDumpHandleType + { + AtsTypeId = WidgetTypeId, + Documentation = new AtsDumpDocumentation { Summary = "A widget.", Remarks = "Widgets spin." }, + ImplementedInterfaces = + [ + HandleRef(ResourceTypeId, isInterface: true), + HandleRef("System.Private.CoreLib/System.IDisposable", isInterface: true), + ], + BaseTypeHierarchy = [HandleRef("Contoso.Widgets/Contoso.Widgets.WidgetBase")], + }, + ], + }; + + var model = GoTransformer.Transform(dump, PackageName); + + var widget = GetHandle(model, "WidgetResource"); + Assert.Equal("Contoso.Widgets.WidgetResource", widget.FullName); + Assert.Equal("A widget.", widget.Description); + Assert.Equal("Widgets spin.", widget.Remarks); + Assert.Equal(["Resource"], widget.ImplementedInterfaces); + Assert.False(JsonSerializer.SerializeToElement(widget).TryGetProperty("baseTypeHierarchy", out _)); + } + + [Fact] + public void Transform_AddsTheSynthesizedMembersToInteractionInputCollection() + { + var dump = CreateDump(); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = InteractionInputCollectionTypeId }); + + var model = GoTransformer.Transform(dump, PackageName); + + var members = GetHandle(model, "InteractionInputCollection").SynthesizedMembers; + Assert.Equal(["Get", "Required", "Value", "RequiredValue"], members.Select(member => member.Name)); + Assert.Equal( + [ + "Get(name string) (*InteractionInput, error)", + "Required(name string) (*InteractionInput, error)", + "Value(name string) (string, error)", + "RequiredValue(name string) (string, error)", + ], + members.Select(member => member.Signature)); + Assert.All(members, member => Assert.False(string.IsNullOrWhiteSpace(member.Description))); + } + + [Fact] + public void Transform_SharesAnOptionsStructOnlyWhenTheOptionalFieldsMatch() + { + var dump = CreateDump(); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = ThingTypeId }); + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = "Contoso.Widgets/Contoso.Widgets.WithThingOptions", Name = "WithThingOptions" }); + dump.Capabilities.AddRange( + [ + Method( + "Contoso.Widgets/widgetWithTag", + "withTag", + WidgetRef(), + WidgetRef(), + [Param("tag", Primitive("string"), isOptional: true)], + returnsBuilder: true), + Method( + "Contoso.Widgets/gadgetWithTag", + "withTag", + GadgetRef(), + GadgetRef(), + [Param("tag", Primitive("string"), isOptional: true)], + returnsBuilder: true), + Method( + "Contoso.Widgets/thingWithTag", + "withTag", + ThingRef(), + ThingRef(), + [Param("count", Primitive("number"), isOptional: true)], + returnsBuilder: true), + Method( + "Contoso.Widgets/widgetWithThing", + "withThing", + WidgetRef(), + WidgetRef(), + [Param("name", Primitive("string"), isOptional: true)], + returnsBuilder: true), + ]); + + var model = GoTransformer.Transform(dump, PackageName); + + Assert.Equal("WithTagOptions", GetOptions(GetFunction(model, "Contoso.Widgets/widgetWithTag")).TypeName); + Assert.Equal("WithTagOptions", GetOptions(GetFunction(model, "Contoso.Widgets/gadgetWithTag")).TypeName); + Assert.Equal("ThingResourceWithTagOptions", GetOptions(GetFunction(model, "Contoso.Widgets/thingWithTag")).TypeName); + Assert.Equal("WidgetResourceWithThingOptions", GetOptions(GetFunction(model, "Contoso.Widgets/widgetWithThing")).TypeName); + } + + [Theory] + [InlineData("name", "Name", "string", false, false)] + [InlineData("retries", "Retries", "*float64", true, false)] + [InlineData("labels", "Labels", "[]string", false, false)] + [InlineData("env", "Env", "map[string]string", false, false)] + [InlineData("mode", "Mode", "*WidgetMode", true, false)] + [InlineData("target", "Target", "any", false, false)] + [InlineData("onReady", "OnReady", "func(...any) any", false, true)] + [InlineData("inner", "Inner", "*InnerOptions", false, false)] + [InlineData("expression", "Expression", "*ReferenceExpression", false, false)] + public void Transform_MapsDtoFields(string jsonName, string name, string type, bool isOptional, bool isCallback) + { + var model = GoTransformer.Transform(CreateDtoDump(), PackageName); + + var dto = Assert.Single(model.DtoTypes, candidate => candidate.Name == "WidgetOptions"); + var field = Assert.Single(dto.Fields, candidate => candidate.JsonName == jsonName); + Assert.Equal(name, field.Name); + Assert.Equal(type, field.Type); + Assert.Equal(isOptional, field.IsOptional); + Assert.Equal(isCallback, field.IsCallback); + } + + [Fact] + public void Transform_DescribesDtosAndOmitsTheReferenceExpressionDto() + { + var model = GoTransformer.Transform(CreateDtoDump(), PackageName); + + Assert.Equal(["InnerOptions", "WidgetOptions"], model.DtoTypes.Select(dto => dto.Name).Order(StringComparer.Ordinal)); + + var widgetOptions = Assert.Single(model.DtoTypes, dto => dto.Name == "WidgetOptions"); + Assert.Equal("Contoso.Widgets.WidgetOptions", widgetOptions.FullName); + Assert.Equal("Options for a widget.", widgetOptions.Description); + } + + [Fact] + public void Transform_PrefixesEnumMembersWithTheEnumName() + { + var dump = CreateDump(); + dump.EnumTypes.Add(new AtsDumpEnumType + { + TypeId = $"enum:{ModeFullName}", + Name = "WidgetMode", + Documentation = new AtsDumpDocumentation { Summary = "How fast the widget spins." }, + Values = ["Fast", "Slow"], + ValueInfos = + [ + new AtsDumpEnumValueInfo + { + Name = "Fast", + Documentation = new AtsDumpDocumentation { Summary = "Spins quickly." }, + }, + ], + }); + + var model = GoTransformer.Transform(dump, PackageName); + + var enumType = Assert.Single(model.EnumTypes); + Assert.Equal("WidgetMode", enumType.Name); + Assert.Equal(ModeFullName, enumType.FullName); + Assert.Equal("How fast the widget spins.", enumType.Description); + Assert.Equal(["WidgetModeFast", "WidgetModeSlow"], enumType.Members.Select(member => member.Name)); + Assert.Equal(["Fast", "Slow"], enumType.Members.Select(member => member.Value)); + Assert.Equal("Spins quickly.", Assert.Single(enumType.Members, member => member.Name == "WidgetModeFast").Description); + Assert.Null(Assert.Single(enumType.Members, member => member.Name == "WidgetModeSlow").Description); + } + + [Fact] + public void Transform_RendersExportedValuesAsGoLiterals() + { + var model = GoTransformer.Transform(CreateExportedValuesDump(), PackageName); + + Assert.Equal(["Defaults", "Version"], model.ExportedValues.Select(group => group.Name)); + + var defaults = Assert.Single(model.ExportedValues, group => group.Name == "Defaults"); + Assert.Equal("Defaults", defaults.FullName); + Assert.Equal( + [ + ("Absent", "string", "nil"), + ("Enabled", "bool", "true"), + ("Missing", "string", "nil"), + ("Mode", "WidgetMode", "WidgetMode(\"fast\")"), + ("Name", "string", "\"widget\""), + ("Retries", "float64", "3"), + ], + defaults.Values.Select(value => (value.Path, value.Type, value.Value))); + + var version = Assert.Single(model.ExportedValues, group => group.Name == "Version"); + var current = Assert.Single(version.Values); + Assert.Equal(string.Empty, current.Path); + Assert.Equal("\"1.0+build<5>\"", current.Value); + } + + [Theory] + [InlineData("\r\n")] + [InlineData("\n")] + public void Transform_RendersCompositeExportedValuesAsSingleLineJson(string newLine) + { + var dump = CreateDump(); + AddWidgetOptionsDtos(dump); + + // The dump is indented, so the raw text of a composite value spans several lines. + var indented = string.Join(newLine, "{", " \"Name\": \"fast+<1>\",", " \"Tags\": [", " 1,", " 2", " ]", "}"); + using var document = JsonDocument.Parse(indented); + dump.ExportedValues.Add(new AtsDumpExportedValue + { + PathSegments = ["Presets", "Fast"], + Type = DtoRef(WidgetOptionsTypeId), + Value = document.RootElement.Clone(), + }); + + var model = GoTransformer.Transform(dump, PackageName); + + var presets = Assert.Single(model.ExportedValues); + var fast = Assert.Single(presets.Values); + Assert.Equal("{\"Name\":\"fast+<1>\",\"Tags\":[1,2]}", fast.Value); + } + + [Fact] + public void Transform_ReportsCapabilitiesWithoutAConcreteTypeAsSkipped() + { + var resource = HandleRef(ResourceTypeId, isInterface: true); + var dump = CreateDump(); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = ResourceTypeId, IsInterface = true }); + dump.Capabilities.Add(Method("Contoso.Widgets/zeta", "zeta", resource, Primitive("string"), expandedTargets: [])); + dump.Capabilities.Add(Method("Contoso.Widgets/alpha", "alpha", resource, Primitive("string"), expandedTargets: [])); + + var model = GoTransformer.Transform(dump, PackageName); + + Assert.Empty(model.Functions); + Assert.Equal(["Contoso.Widgets/alpha", "Contoso.Widgets/zeta"], model.SkippedCapabilityIds); + } + + [Fact] + public void Transform_IgnoresRuntimeProvidedCapabilitiesWithoutReportingThemAsSkipped() + { + var dump = CreateDump(); + dump.Capabilities.AddRange( + [ + Method("Aspire.Hosting/List.add", "add", ListOf(Primitive("string")), null, expandedTargets: []), + Method("Aspire.Hosting/Dict.set", "set", DictOf(Primitive("string"), Primitive("string")), null, expandedTargets: []), + Method("Aspire.Hosting/ReferenceExpression.format", "format", HandleRef(ReferenceExpressionTypeId), Primitive("string"), expandedTargets: []), + ]); + + var model = GoTransformer.Transform(dump, PackageName); + + Assert.Empty(model.Functions); + Assert.Empty(model.SkippedCapabilityIds); + } + + [Fact] + public void Transform_IsIndependentOfTheOrderOfTheDump() + { + var dump = CreateRichDump(); + var reversed = new AtsDumpRoot + { + Packages = dump.Packages, + Capabilities = [.. dump.Capabilities.AsEnumerable().Reverse()], + HandleTypes = [.. dump.HandleTypes.AsEnumerable().Reverse()], + DtoTypes = [.. dump.DtoTypes.AsEnumerable().Reverse()], + EnumTypes = [.. dump.EnumTypes.AsEnumerable().Reverse()], + ExportedValues = [.. dump.ExportedValues.AsEnumerable().Reverse()], + }; + + var expected = JsonSerializer.Serialize(GoTransformer.Transform(dump, PackageName)); + var actual = JsonSerializer.Serialize(GoTransformer.Transform(reversed, PackageName)); + + Assert.Equal(expected, actual); + } + + [Fact] + public void GoKnownTypes_NoneKnowsNothing() + { + var known = GoKnownTypes.None; + + Assert.Empty(known.Handles); + Assert.Empty(known.DtoNames); + Assert.Empty(known.EnumNames); + Assert.False(known.TryGetHandle("Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", out _)); + Assert.Null(known.GetDtoName(CommandOptionsTypeId)); + Assert.Null(known.GetEnumName(LifetimeFullName)); + } + + [Fact] + public void GoKnownTypes_KeepsTheFirstDeclarationOfAType() + { + var other = new GoPackageModel + { + Package = new GoPackageInfo { Name = "Contoso.Other" }, + DtoTypes = [new GoDtoTypeModel { Name = "Renamed", FullName = CommandOptionsFullName }], + }; + + var known = new GoKnownTypes([CreateCoreModel(), other]); + + Assert.Equal("CommandOptions", known.GetDtoName(CommandOptionsTypeId)); + } + + [Theory] + [InlineData("Aspire.Hosting.ApplicationModel.ContainerLifetime")] + [InlineData("enum:Aspire.Hosting.ApplicationModel.ContainerLifetime")] + public void GoKnownTypes_FindsAnEnumByItsFullNameOrItsEnumTypeId(string typeId) + { + var known = new GoKnownTypes([CreateCoreModel()]); + + Assert.Equal("ContainerLifetime", known.GetEnumName(typeId)); + } + + [Fact] + public void GoKnownTypes_FindsHandlesAndDtosByAssemblyQualifiedTypeId() + { + var known = new GoKnownTypes([CreateCoreModel()]); + + Assert.True(known.TryGetHandle("Aspire.Hosting/Aspire.Hosting.ApplicationModel.IResource", out var marker)); + Assert.Equal(new GoKnownHandle("Resource", IsInterface: true, HasImplementation: false), marker); + + Assert.True(known.TryGetHandle("Aspire.Hosting/Aspire.Hosting.ApplicationModel.ContainerResource", out var concrete)); + Assert.Equal(new GoKnownHandle("ContainerResource", IsInterface: false, HasImplementation: true), concrete); + + Assert.Equal("CommandOptions", known.GetDtoName(CommandOptionsTypeId)); + } + + [Fact] + public void Transform_UsesTheBaseNameForAReferencedEnumTheDumpDoesNotDeclare() + { + var dump = CreateDump(); + dump.Capabilities.Add(Method( + "Contoso.Widgets/withLifetime", + "withLifetime", + WidgetRef(), + WidgetRef(), + [Param("lifetime", EnumRef(LifetimeFullName))], + returnsBuilder: true)); + + var model = GoTransformer.Transform(dump, PackageName, knownTypes: new GoKnownTypes([CreateCoreModel()])); + + Assert.Equal( + "WithLifetime(lifetime ContainerLifetime) WidgetResource", + GetFunction(model, "Contoso.Widgets/withLifetime").Signature); + Assert.Empty(model.EnumTypes); + } + + [Fact] + public void Transform_KeepsTheBaseNamesOfTypesTheDumpRedeclares() + { + var dump = CreateDump(); + dump.EnumTypes.Add(new AtsDumpEnumType + { + TypeId = $"enum:{LifetimeFullName}", + Name = "ContainerLifetime", + Values = ["Session", "Persistent"], + }); + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = CommandOptionsTypeId, Name = "CommandOptions" }); + dump.Capabilities.Add(Method( + "Contoso.Widgets/withLifetime", + "withLifetime", + WidgetRef(), + WidgetRef(), + [ + Param("lifetime", EnumRef(LifetimeFullName)), + Param("options", DtoRef(CommandOptionsTypeId), isOptional: true), + ], + returnsBuilder: true)); + + var model = GoTransformer.Transform(dump, PackageName, knownTypes: new GoKnownTypes([CreateCoreModel()])); + + var enumType = Assert.Single(model.EnumTypes); + Assert.Equal("ContainerLifetime", enumType.Name); + Assert.Equal(["ContainerLifetimeSession", "ContainerLifetimePersistent"], enumType.Members.Select(member => member.Name)); + Assert.Equal("CommandOptions", Assert.Single(model.DtoTypes).Name); + Assert.Equal( + "WithLifetime(lifetime ContainerLifetime, options ...*CommandOptions) WidgetResource", + GetFunction(model, "Contoso.Widgets/withLifetime").Signature); + } + + [Fact] + public void Transform_RenamesDumpTypesThatCollideWithBaseTypes() + { + var dump = CreateDump(); + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = "Contoso.Widgets/Contoso.Widgets.CommandOptions", Name = "CommandOptions" }); + dump.HandleTypes.Add(new AtsDumpHandleType { AtsTypeId = "Contoso.Widgets/Contoso.Widgets.ContainerResource" }); + + var model = GoTransformer.Transform(dump, PackageName, knownTypes: new GoKnownTypes([CreateCoreModel()])); + + var dto = Assert.Single(model.DtoTypes); + Assert.Equal("CommandOptions2", dto.Name); + Assert.Equal("Contoso.Widgets.CommandOptions", dto.FullName); + Assert.Contains(model.HandleTypes, handle => handle.Name == "Contoso_WidgetsContainerResource"); + } + + private static GoFunctionModel GetFunction(GoPackageModel model, string capabilityId) => + Assert.Single(model.Functions, function => function.CapabilityId == capabilityId); + + private static GoOptionsModel GetOptions(GoFunctionModel function) + { + Assert.NotNull(function.Options); + return function.Options; + } + + private static GoHandleTypeModel GetHandle(GoPackageModel model, string name) => + Assert.Single(model.HandleTypes, handle => handle.Name == name); + + private static AtsDumpRoot CreateEntryPointDump(bool includeCreateBuilderOptions) + { + var dump = CreateDump(); + dump.Capabilities.Add(CreateBuilderCapability()); + dump.Capabilities.Add(BuildCapability()); + + if (includeCreateBuilderOptions) + { + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = CreateBuilderOptionsTypeId, Name = "CreateBuilderOptions" }); + } + + return dump; + } + + private static AtsDumpRoot CreateShapesDump() + { + var dump = CreateDump(); + dump.EnumTypes.Add(ModeEnum()); + dump.DtoTypes.Add(new AtsDumpDtoType + { + TypeId = GadgetOptionsTypeId, + Name = "GadgetOptions", + Properties = [new AtsDumpDtoProperty { Name = "size", Type = Primitive("number", isNullable: true), IsOptional = true }], + }); + + var text = Primitive("string"); + + dump.Capabilities.AddRange( + [ + Method("Contoso.Widgets/addWidget", "addWidget", BuilderRef(), WidgetRef(), [Param("name", text)], returnsBuilder: true), + Method( + "Contoso.Widgets/withLabel", + "withLabel", + WidgetRef(), + WidgetRef(), + [Param("label", text), Param("tag", Primitive("string", isNullable: true), isOptional: true)], + returnsBuilder: true, + documentation: new AtsDumpDocumentation + { + Summary = "Adds a label to the widget.", + Remarks = "Labels are case sensitive.", + Returns = "The widget builder.", + Parameters = [new AtsDumpParameterDoc { Name = "label", Description = "The label text." }], + }), + Method("Contoso.Widgets/getCount", "getCount", WidgetRef(), Primitive("number"), description: "Gets the number of widgets."), + Method("Contoso.Widgets/reset", "reset", WidgetRef(), Primitive("void")), + Method("Contoso.Widgets/touch", "touch", WidgetRef(), null), + Method("Contoso.Widgets/withKind", "withKind", WidgetRef(), WidgetRef(), [Param("type", text), Param("range", text)], returnsBuilder: true), + Method( + "Contoso.Widgets/addGadget", + "addGadget", + BuilderRef(), + GadgetRef(), + [Param("name", text), Param("options", DtoRef(GadgetOptionsTypeId), isOptional: true)], + returnsBuilder: true), + Method( + "Contoso.Widgets/withFactory", + "withFactory", + WidgetRef(), + WidgetRef(), + [Param("path", text), CallbackParam("factory", text, ("arg", HandleRef(FactoryContextTypeId)))], + returnsBuilder: true), + Method( + "Contoso.Widgets/withEndpoint", + "withEndpoint", + WidgetRef(), + WidgetRef(), + [Param("endpoint", UnionOf(text, HandleRef(ParameterResourceTypeId)))], + returnsBuilder: true), + Method( + "Contoso.Widgets/WidgetResource.tags", + "tags", + WidgetRef(), + ListOf(text), + capabilityKind: "PropertyGetter", + targetParameterName: "context", + qualifiedMethodName: "WidgetResource.tags"), + Method( + "Contoso.Widgets/WidgetResource.labels", + "labels", + WidgetRef(), + ListOf(text, isReadOnly: true), + capabilityKind: "PropertyGetter", + targetParameterName: "context", + qualifiedMethodName: "WidgetResource.labels"), + Method( + "Contoso.Widgets/WidgetResource.env", + "env", + WidgetRef(), + DictOf(text, text), + capabilityKind: "PropertyGetter", + targetParameterName: "context", + qualifiedMethodName: "WidgetResource.env"), + Method( + "Contoso.Widgets/run", + "run", + ApplicationRef(), + Primitive("void"), + [Param("cancellationToken", Primitive("cancellationToken"), isOptional: true)], + capabilityKind: "InstanceMethod"), + Method( + "Contoso.Widgets/withMode", + "withMode", + WidgetRef(), + WidgetRef(), + [Param("mode", EnumRef(ModeFullName)), Param("fallback", EnumRef(ModeFullName), isOptional: true)], + returnsBuilder: true), + ]); + + return dump; + } + + private static AtsDumpRoot CreateDtoDump() + { + var dump = CreateDump(); + dump.EnumTypes.Add(ModeEnum()); + AddWidgetOptionsDtos(dump); + + return dump; + } + + private static AtsDumpRoot CreateExportedValuesDump() + { + var dump = CreateDump(); + dump.EnumTypes.Add(ModeEnum()); + AddExportedValues(dump); + + return dump; + } + + private static AtsDumpRoot CreateRichDump() + { + var dump = CreateShapesDump(); + AddWidgetOptionsDtos(dump); + AddExportedValues(dump); + + return dump; + } + + private static void AddWidgetOptionsDtos(AtsDumpRoot dump) + { + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = InnerOptionsTypeId, Name = "InnerOptions" }); + dump.DtoTypes.Add(new AtsDumpDtoType { TypeId = ReferenceExpressionTypeId, Name = "ReferenceExpression" }); + dump.DtoTypes.Add(new AtsDumpDtoType + { + TypeId = WidgetOptionsTypeId, + Name = "WidgetOptions", + Description = "Options for a widget.", + Properties = + [ + new AtsDumpDtoProperty { Name = "name", Type = Primitive("string") }, + new AtsDumpDtoProperty { Name = "retries", Type = Primitive("number", isNullable: true), IsOptional = true }, + new AtsDumpDtoProperty { Name = "labels", Type = ListOf(Primitive("string")) }, + new AtsDumpDtoProperty { Name = "env", Type = DictOf(Primitive("string"), Primitive("string")) }, + new AtsDumpDtoProperty { Name = "mode", Type = EnumRef(ModeFullName), IsOptional = true }, + new AtsDumpDtoProperty { Name = "target", Type = UnionOf(Primitive("string"), HandleRef(ParameterResourceTypeId)) }, + new AtsDumpDtoProperty { Name = "onReady", Type = CallbackRef() }, + new AtsDumpDtoProperty { Name = "inner", Type = DtoRef(InnerOptionsTypeId) }, + new AtsDumpDtoProperty { Name = "expression", Type = DtoRef(ReferenceExpressionTypeId) }, + ], + }); + } + + private static void AddExportedValues(AtsDumpRoot dump) + { + dump.ExportedValues.AddRange( + [ + ExportedValue(["Defaults", "Retries"], Primitive("number"), 3), + ExportedValue(["Defaults", "Name"], Primitive("string"), "widget"), + ExportedValue(["Defaults", "Enabled"], Primitive("boolean"), true), + ExportedValue(["Defaults", "Mode"], EnumRef(ModeFullName), "fast"), + ExportedValue(["Defaults", "Missing"], Primitive("string"), null), + new AtsDumpExportedValue + { + PathSegments = ["Defaults", "Absent"], + Type = Primitive("string"), + Value = JsonSerializer.SerializeToElement(null), + }, + ExportedValue(["Version"], Primitive("string"), "1.0+build<5>"), + ]); + } + + private static GoPackageModel CreateCoreModel() => new() + { + Package = new GoPackageInfo { Name = "Aspire.Hosting" }, + HandleTypes = + [ + new GoHandleTypeModel { Name = "ContainerResource", FullName = "Aspire.Hosting.ApplicationModel.ContainerResource" }, + new GoHandleTypeModel + { + Name = "Resource", + FullName = "Aspire.Hosting.ApplicationModel.IResource", + IsInterface = true, + IsMarker = true, + }, + ], + DtoTypes = [new GoDtoTypeModel { Name = "CommandOptions", FullName = CommandOptionsFullName }], + EnumTypes = + [ + new GoEnumTypeModel + { + Name = "ContainerLifetime", + FullName = LifetimeFullName, + Members = + [ + new GoEnumMemberModel { Name = "ContainerLifetimeSession", Value = "Session" }, + new GoEnumMemberModel { Name = "ContainerLifetimePersistent", Value = "Persistent" }, + ], + }, + ], + }; +}