skills.rest
microsoft
microsoftOFFICIAL
Explore all skills by this author →
Website𝕏@OpenAtMicrosoftGitHub

connection-properties

Verify Aspire resource connection properties and update README.md tables.

6.2k|952|Updated Sep 25, 2023
Search Tags:#documentation#OpenTelemetry#aspire#connection properties#C# resource interfaces#JdbcConnectionString#resource inheritance
One-click install
npx skills add https://github.com/microsoft/aspire --skill connection-properties-microsoft
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: connection-properties
Source: https://github.com/microsoft/aspire/tree/main/.agents/skills/connection-properties
Command: npx skills add https://github.com/microsoft/aspire --skill connection-properties-microsoft

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Aspire resources may expose connection details needed by consuming projects, but these details can be missing, inconsistent, or undocumented, forcing manual guesswork and integration delays.

Core Features & Use Cases

  • Implements Connection Property Discovery: Ensures an Aspire resource correctly implements IResourceWithConnectionString.GetConnectionProperties and returns the required connection fields (for example Host, Port, Uri, and JdbcConnectionString when applicable).
  • Enforces Parent Inheritance Rules: Validates that child resources correctly inherit and override connection properties using ConnectionPropertiesExtensions.CombineProperties so Uri and JdbcConnectionString remain consistent across resource hierarchies.
  • Generates Matching Documentation: Updates the resource-specific README.md with a standardized, table-based Connection Properties section that accurately reflects what GetConnectionProperties defines.

Quick Start

Ask the agent to verify the Aspire resource implementation and update its sibling README.md with a correctly formatted Connection Properties table that matches GetConnectionProperties output.

Frequently Asked Questions about connection-properties

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document Aspire connection properties for resources using WithReference?▼

To document Aspire connection properties, the resource must implement IResourceWithConnectionString.GetConnectionProperties and output a standardized table in its sibling README.md. This ensures consuming projects receive the correct environment variables for distributed app wiring.

What connection properties are required for an Aspire resource to support distributed app wiring?▼

Required Aspire connection properties include the Uri and, when documented online, JdbcConnectionString. These fields must be returned by GetConnectionProperties to ensure consuming projects can connect reliably via WithReference.

How do child Aspire resources inherit connection properties from parent resources?▼

Child Aspire resources inherit and override connection properties using ConnectionPropertiesExtensions.CombineProperties. This ensures fields like Uri and JdbcConnectionString remain consistent across the parent and child resource hierarchy.

How do I verify that an Azure service resource correctly implements GetConnectionProperties?▼

You verify an Azure service resource by checking that its GetConnectionProperties implementation returns the required common properties and that the sibling README.md contains an identically formatted connection-properties table reflecting those exact outputs.

Does Aspire require JdbcConnectionString for all resources implementing connection properties?▼

Aspire requires JdbcConnectionString only when documented online for applicable resources. All resources must provide the Uri property, while JdbcConnectionString ensures proper database connectivity for distributed app wiring when needed.

Related Skills

Explore More Software Engineering Skills→
kourou25kourou25
4

虚谷数据库 C 语言驱动开发

Develop C drivers for XuguDB using NCI, OCI, and XGCI interfaces.

Community
Intermediate
PlazaCCPlazaCC
2

dotenvx

Encrypt .env files and inject decrypted variables into process.env at runtime.

Official
Intermediate
sast-playgroundsast-playground

connection-properties

Generate and verify connection properties documentation for Aspire resources.

Official
Intermediate
microsoftmicrosoft
242

appinsights-instrumentation

Instrument ASP.NET Core and Node.js apps to send telemetry to Azure Application Insights.

Official
Intermediate