close #2636: added json schemas for Aspire.Hosting.AppHost and Aspire.Hosting.Azure (#4912)

Description
fixed an issues with intellisense inside appsettings.json when using Aspire.Hosting.AppHost or Aspire.Hosting.Azure

Changes:

added AspireAppHostConfiguration.json file and included it into Aspire.Host.AppHosting nuget package
added src/Aspire.Hosting.Azure/AspireAzureConfigurationSchema.json and included it into Aspire.Host.Azure package

* fix: added appsettings intellisence to show Parameters json property

* feat: added Aspire Hosting Azure json schema

* fixed PR comments

* PR feedback

Add some more descriptions and tweak wording.

Fix #2636
---------

Co-authored-by: Eric Erhardt <[email protected]>

Author: vladimir-shirmanov

src/Aspire.Hosting.AppHost/Aspire.Hosting.AppHost.csproj

@@ -16,7 +16,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="**/*.props;**/*.targets" Pack="true" PackagePath="%(RecursiveDir)%(Filename)%(Extension)" />
+    <None Include="**/*.props;**/*.targets;AspireAppHostConfiguration.json" Pack="true" PackagePath="%(RecursiveDir)%(Filename)%(Extension)" />
   </ItemGroup>
 
   <ItemGroup>

src/Aspire.Hosting.AppHost/AspireAppHostConfiguration.json

@@ -0,0 +1,9 @@
+{
+  "type": "object",
+  "properties": {
+    "Parameters": {
+      "description": ".NET Aspire parameter configuration. A parameter's value will be retrieved from the property with the same name.",
+      "type": "object"
+    }
+  }
+}

src/Aspire.Hosting.AppHost/build/Aspire.Hosting.AppHost.targets

@@ -12,6 +12,11 @@
     <ProjectCapability Include="Aspire" Condition=" '$(IsAspireHost)' == 'true' " />
   </ItemGroup>
 
+  <ItemGroup>
+    <JsonSchemaSegment Include="$(MSBuildThisFileDirectory)..\AspireAppHostConfiguration.json"
+                       FilePathPattern="appsettings\..*json" />
+  </ItemGroup>
+
   <Target Name="_CreateAspireProjectResources">
 
     <ItemGroup>

src/Aspire.Hosting.Azure/Aspire.Hosting.Azure.csproj

@@ -24,6 +24,10 @@
     <EmbeddedResource Include="Bicep\*.bicep" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="**/*.targets;AspireAzureConfigurationSchema.json" Pack="true" PackagePath="%(RecursiveDir)%(Filename)%(Extension)"  />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Aspire.Hosting\Aspire.Hosting.csproj" />
     <PackageReference Include="System.IO.Hashing" />

src/Aspire.Hosting.Azure/AspireAzureConfigurationSchema.json

@@ -0,0 +1,44 @@
+{
+  "type": "object",
+  "properties": {
+    "Azure": {
+      "description": "Azure provisioning information. This section is used to create Azure resources for the app.",
+      "type": "object",
+      "properties": {
+        "SubscriptionId": {
+          "description": "Azure Subscription Id that will be used to host the resources.",
+          "type": "string"
+        },
+        "ResourceGroup": {
+          "description": "Azure Resource Group name where to create resources.",
+          "type": "string"
+        },
+        "ResourceGroupPrefix": {
+          "description": "Azure Resource Group prefix used in resource groups names created.",
+          "type": "string"
+        },
+        "AllowResourceGroupCreation": {
+          "description": "Flag that shows if it is allowed to create a resource group if not exists. Defaults to false if ResourceGroup is provided.",
+          "type": "boolean"
+        },
+        "Location": {
+          "description": "Azure Location that will be used to create resources.",
+          "type": "string"
+        },
+        "CredentialSource": {
+          "description": "Configures which Azure credential to use for provisioning.",
+          "enum": [
+            "AzureCli",
+            "AzurePowerShell",
+            "VisualStudio",
+            "VisualStudioCode",
+            "AzureDeveloperCli",
+            "InteractiveBrowser",
+            "Default"
+          ],
+          "default": "Default"
+        }
+      }
+    }
+  }
+}

src/Aspire.Hosting.Azure/buildTransitive/Aspire.Hosting.Azure.targets

@@ -0,0 +1,6 @@
+<Project>
+  <ItemGroup>
+    <JsonSchemaSegment Include="$(MSBuildThisFileDirectory)..\AspireAzureConfigurationSchema.json"
+                       FilePathPattern="appsettings\..*json" />
+  </ItemGroup>
+</Project>