connection-properties

Generate connection properties for Aspire resources implementing IResourceWithConnectionString.

6.2k|952|Updated Sep 25, 2023
One-click install
npx skills add https://github.com/dotnet/aspire --skill connection-properties
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: connection-properties
Source: https://github.com/dotnet/aspire/tree/main/.github/skills/connection-properties
Command: npx skills add https://github.com/dotnet/aspire --skill connection-properties

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Aspire resources often need a standardized set of connection properties for cross-resource integration. This skill defines how to implement IResourceWithConnectionString.GetConnectionProperties and document those properties to ensure consistent consumption.

Core Features & Use Cases

  • Inherit and override connection properties from a parent resource using CombineProperties, enabling Uri and JdbcConnectionString customization per resource.
  • Provide a complete set of common connection properties including Host, Port, Username, Password, Uri, JdbcConnectionString, DatabaseName, and Azure indicator when applicable.
  • Keep README documentation up-to-date with a formal Connection Properties table describing each property and its format.

Quick Start

Use this skill to implement or verify GetConnectionProperties on a resource, documenting the resulting properties in the resource README and updating any parent-child overrides as needed.

Frequently Asked Questions about connection-properties

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

FAQPage Schema
How do I define connection properties for Aspire resources implementing IResourceWithConnectionString?▼

Define connection properties for Aspire resources by implementing the GetConnectionProperties method to expose standardized Host, Port, Username, Password, Uri, JdbcConnectionString, and DatabaseName values for cross-resource integration.

What is parent-based inheritance for Aspire resource connection properties?▼

Parent-based inheritance uses the CombineProperties mechanism to let child Aspire resources inherit standard connection properties from a parent resource while overriding specific values like Uri and JdbcConnectionString for real-world scenarios.

How do I document connection properties in an Aspire resource README?▼

Document connection properties in an Aspire resource README by generating a formal Connection Properties table that describes each property, such as Host, Port, and Azure indicator, and its specific format for consistent consumption.

Can I override Uri and JdbcConnectionString for child Aspire resources?▼

Yes, you can override Uri and JdbcConnectionString for child Aspire resources by using CombineProperties to inherit the base connection properties from the parent resource and then applying per-resource customizations.

What standard connection properties should an Aspire resource expose?▼

An Aspire resource should expose a standard set of connection properties including Host, Port, Username, Password, Uri, JdbcConnectionString, DatabaseName, and an Azure indicator when applicable to ensure consistent cross-resource integration.

Does this approach to connection properties work with all Aspire resources?▼

This connection properties approach applies specifically to Aspire resources implementing the IResourceWithConnectionString interface, enforcing a standardized property set to ensure robust and consistent cross-resource consumption.