Last round of triple slash, I believe. (dotnet#661)

* Last round of triple slash, I believe.

* Revert Aspire.sln change

* Update src/Aspire.Hosting.Azure.Provisioning/UserSecretsPathHelper.cs

* Update src/Aspire.Hosting.Azure.Provisioning/UserSecretsPathHelper.cs

---------

Co-authored-by: David Fowler <[email protected]>

Author: IEvangelist

.editorconfig

@@ -4,7 +4,7 @@
 ;
 ; Here are some resources for what's supported for .NET/C#
 ; https://kent-boogaart.com/blog/editorconfig-reference-for-c-developers
-; https://learn.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
+; https://learn.microsoft.com/visualstudio/ide/editorconfig-code-style-settings-reference
 ;
 ; Be **careful** editing this because some of the rules don't support adding a severity level
 ; For instance if you change to `dotnet_sort_system_directives_first = true:warning` (adding `:warning`)

eng/common/templates/job/job.yml

@@ -76,7 +76,7 @@ jobs:
     - name: EnableRichCodeNavigation
       value: 'true'
   # Retry signature validation up to three times, waiting 2 seconds between attempts.
-  # See https://learn.microsoft.com/en-us/nuget/reference/errors-and-warnings/nu3028#retry-untrusted-root-failures
+  # See https://learn.microsoft.com/nuget/reference/errors-and-warnings/nu3028#retry-untrusted-root-failures
   - name: NUGET_EXPERIMENTAL_CHAIN_BUILD_RETRY_POLICY
     value: 3,2000
   - ${{ each variable in parameters.variables }}:

samples/eShopLite/BasketService/Protos/basket.proto

@@ -47,7 +47,7 @@ message DeleteCustomerBasketRequest {
 message DeleteCustomerBasketResponse {
 }
 
-// See: https://learn.microsoft.com/en-us/dotnet/architecture/grpc-for-wcf-developers/protobuf-data-types#decimals
+// See: https://learn.microsoft.com/dotnet/architecture/grpc-for-wcf-developers/protobuf-data-types#decimals
 // Example: 12345.6789 -> { units = 12345, nanos = 678900000 }
 message DecimalValue {
 

src/Aspire.Dashboard/Components/Controls/LogViewer.razor.cs

@@ -77,7 +77,7 @@ public async ValueTask DisposeAsync()
         }
         catch (JSDisconnectedException)
         {
-            // Per https://learn.microsoft.com/en-us/aspnet/core/blazor/javascript-interoperability/?view=aspnetcore-7.0#javascript-interop-calls-without-a-circuit
+            // Per https://learn.microsoft.com/aspnet/core/blazor/javascript-interoperability/?view=aspnetcore-7.0#javascript-interop-calls-without-a-circuit
             // this is one of the calls that will fail if the circuit is disconnected, and we just need to catch the exception so it doesn't pollute the logs
         }
     }

src/Aspire.Dashboard/Components/Dialogs/SettingsDialog.razor.cs

@@ -83,7 +83,7 @@ public async ValueTask DisposeAsync()
         }
         catch (JSDisconnectedException)
         {
-            // Per https://learn.microsoft.com/en-us/aspnet/core/blazor/javascript-interoperability/?view=aspnetcore-7.0#javascript-interop-calls-without-a-circuit
+            // Per https://learn.microsoft.com/aspnet/core/blazor/javascript-interoperability/?view=aspnetcore-7.0#javascript-interop-calls-without-a-circuit
             // this is one of the calls that will fail if the circuit is disconnected, and we just need to catch the exception so it doesn't pollute the logs
         }
     }

src/Aspire.Hosting.Azure.Provisioning/AzureProvisionerExtensions.cs

@@ -16,6 +16,9 @@
 
 namespace Aspire.Hosting;
 
+/// <summary>
+/// Provides extension methods for adding support for generating Azure resources dynamically during application startup.
+/// </summary>
 public static class AzureProvisionerExtensions
 {
     /// <summary>
@@ -27,11 +30,11 @@ public static IDistributedApplicationBuilder AddAzureProvisioning(this IDistribu
         builder.Services.AddLifecycleHook<AzureProvisioner>();
 
         // Attempt to read azure configuration from configuration
-        builder.Services.AddOptions<AzureProvisinerOptions>()
+        builder.Services.AddOptions<AzureProvisionerOptions>()
             .BindConfiguration("Azure");
 
         // We're adding 2 because there's no easy way to enumerate all keys and all service types
-        builder.AddAzureProvisioner<AzureKeyVaultResource, KeyVaultProvisoner>();
+        builder.AddAzureProvisioner<AzureKeyVaultResource, KeyVaultProvisioner>();
         builder.AddResourceEnumerator(resourceGroup => resourceGroup.GetKeyVaults(), resource => resource.Data.Tags);
 
         builder.AddAzureProvisioner<AzureStorageResource, StorageProvisioner>();
@@ -43,7 +46,7 @@ public static IDistributedApplicationBuilder AddAzureProvisioning(this IDistribu
         builder.AddAzureProvisioner<AzureRedisResource, AzureRedisProvisioner>();
         builder.AddResourceEnumerator(resourceGroup => resourceGroup.GetAllRedis(), resource => resource.Data.Tags);
 
-        builder.AddAzureProvisioner<AzureAppConfigurationResource, AppConfigurationProvisoner>();
+        builder.AddAzureProvisioner<AzureAppConfigurationResource, AppConfigurationProvisioner>();
         builder.AddResourceEnumerator(resourceGroup => resourceGroup.GetAppConfigurationStores(), resource => resource.Data.Tags);
         return builder;
     }

src/Aspire.Hosting.Azure.Provisioning/AzureProvisinerOptions.cs renamed to src/Aspire.Hosting.Azure.Provisioning/AzureProvisionerOptions.cs

@@ -3,7 +3,7 @@
 
 namespace Aspire.Hosting.Azure.Provisioning;
 
-internal sealed class AzureProvisinerOptions
+internal sealed class AzureProvisionerOptions
 {
     public string? SubscriptionId { get; set; }
 

src/Aspire.Hosting.Azure.Provisioning/JsonExtensions.cs

@@ -1,5 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
+
 using System.Text.Json.Nodes;
 
 namespace Aspire.Hosting.Azure;

src/Aspire.Hosting.Azure.Provisioning/Provisioners/AppConfigurationProvisoner.cs

@@ -15,7 +15,7 @@
 
 namespace Aspire.Hosting.Azure.Provisioning;
 
-internal sealed class AppConfigurationProvisoner(ILogger<AppConfigurationProvisoner> logger) : AzureResourceProvisioner<AzureAppConfigurationResource>
+internal sealed class AppConfigurationProvisioner(ILogger<AppConfigurationProvisioner> logger) : AzureResourceProvisioner<AzureAppConfigurationResource>
 {
     public override bool ConfigureResource(IConfiguration configuration, AzureAppConfigurationResource resource)
     {
@@ -72,7 +72,7 @@ public override async Task GetOrCreateResourceAsync(
         connectionStrings[resource.Name] = resource.Endpoint;
 
         // App Configuration Data Owner
-        // https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#app-configuration-data-owner
+        // https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#app-configuration-data-owner
         var roleDefinitionId = CreateRoleDefinitionId(subscription, "5ae67dd6-50cb-40e7-96ff-dc2bfa4b606b");
 
         await DoRoleAssignmentAsync(armClient, appConfigurationResource.Id, principalId, roleDefinitionId, cancellationToken).ConfigureAwait(false);

src/Aspire.Hosting.Azure.Provisioning/Provisioners/AzureProvisioner.cs

@@ -24,7 +24,7 @@ namespace Aspire.Hosting.Azure;
 
 // Provisions azure resources for development purposes
 internal sealed class AzureProvisioner(
-    IOptions<AzureProvisinerOptions> options,
+    IOptions<AzureProvisionerOptions> options,
     IOptions<PublishingOptions> publishingOptions,
     IConfiguration configuration,
     IHostEnvironment environment,
@@ -34,7 +34,7 @@ internal sealed class AzureProvisioner(
 {
     internal const string AspireResourceNameTag = "aspire-resource-name";
 
-    private readonly AzureProvisinerOptions _options = options.Value;
+    private readonly AzureProvisionerOptions _options = options.Value;
 
     public async Task BeforeStartAsync(DistributedApplicationModel appModel, CancellationToken cancellationToken = default)
     {
@@ -186,21 +186,21 @@ await PopulateExistingAspireResources(
         {
             usedResources.Add(resource.Name);
 
-            var provisoner = serviceProvider.GetKeyedService<IAzureResourceProvisioner>(resource.GetType());
+            var provisioner = serviceProvider.GetKeyedService<IAzureResourceProvisioner>(resource.GetType());
 
-            if (provisoner is null)
+            if (provisioner is null)
             {
                 logger.LogWarning("No provisioner found for {resourceType} skipping.", resource.GetType().Name);
                 continue;
             }
 
-            if (!provisoner.ShouldProvision(configuration, resource))
+            if (!provisioner.ShouldProvision(configuration, resource))
             {
                 logger.LogInformation("Skipping {resourceName} because it is not configured to be provisioned.", resource.Name);
                 continue;
             }
 
-            if (provisoner.ConfigureResource(configuration, resource))
+            if (provisioner.ConfigureResource(configuration, resource))
             {
                 logger.LogInformation("Using connection information stored in user secrets for {resourceName}.", resource.Name);
 
@@ -217,7 +217,7 @@ await PopulateExistingAspireResources(
             resourceMap ??= await resourceMapLazy.Value.ConfigureAwait(false);
             principalId ??= await principalIdLazy.Value.ConfigureAwait(false);
 
-            var task = provisoner.GetOrCreateResourceAsync(armClient,
+            var task = provisioner.GetOrCreateResourceAsync(armClient,
                     subscription,
                     resourceGroup,
                     resourceMap,

src/Aspire.Hosting.Azure.Provisioning/Provisioners/KeyVaultProvisoner.cs

@@ -14,7 +14,7 @@
 
 namespace Aspire.Hosting.Azure.Provisioning;
 
-internal sealed class KeyVaultProvisoner(ILogger<KeyVaultProvisoner> logger) : AzureResourceProvisioner<AzureKeyVaultResource>
+internal sealed class KeyVaultProvisioner(ILogger<KeyVaultProvisioner> logger) : AzureResourceProvisioner<AzureKeyVaultResource>
 {
     public override bool ConfigureResource(IConfiguration configuration, AzureKeyVaultResource resource)
     {
@@ -76,7 +76,7 @@ public override async Task GetOrCreateResourceAsync(
         connectionStrings[keyVault.Name] = keyVault.VaultUri.ToString();
 
         // Key Vault Administrator
-        // https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#key-vault-administrator
+        // https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#key-vault-administrator
         var roleDefinitionId = CreateRoleDefinitionId(subscription, "00482a5a-887f-4fb3-b363-3b7fe8e74483");
 
         await DoRoleAssignmentAsync(armClient, keyVaultResource.Id, principalId, roleDefinitionId, cancellationToken).ConfigureAwait(false);

src/Aspire.Hosting.Azure.Provisioning/Provisioners/ServiceBusProvisioner.cs

@@ -150,7 +150,7 @@ public override async Task GetOrCreateResourceAsync(
         }
 
         // Azure Service Bus Data Owner
-        // https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#azure-service-bus-data-owner
+        // https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#azure-service-bus-data-owner
         var roleDefinitionId = CreateRoleDefinitionId(subscription, "090c5cfd-751d-490a-894a-3ce6f1109419");
 
         await DoRoleAssignmentAsync(armClient, serviceBusNamespace.Id, principalId, roleDefinitionId, cancellationToken).ConfigureAwait(false);

src/Aspire.Hosting.Azure.Provisioning/Provisioners/StorageProvisioner.cs

@@ -91,15 +91,15 @@ public override async Task GetOrCreateResourceAsync(
         resourceEntry["QueueUri"] = resource.QueueUri.ToString();
 
         // Storage Queue Data Contributor
-        // https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-queue-data-contributor
+        // https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#storage-queue-data-contributor
         var storageQueueDataContributorId = CreateRoleDefinitionId(subscription, "974c5e8b-45b9-4653-ba55-5f855dd0fb88");
 
         // Storage Table Data Contributor
-        // https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-table-data-contributor
+        // https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#storage-table-data-contributor
         var storageDataContributorId = CreateRoleDefinitionId(subscription, "0a9a7e1f-b9d0-4cc4-a60d-0319b160aaa3");
 
         // Storage Blob Data Contributor
-        // https://learn.microsoft.com/en-us/azure/role-based-access-control/built-in-roles#storage-blob-data-contributor
+        // https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#storage-blob-data-contributor
         var storageBlobDataContributorId = CreateRoleDefinitionId(subscription, "81a9662b-bebf-436f-a333-f67b29880f12");
 
         var t0 = DoRoleAssignmentAsync(armClient, storageAccount.Id, principalId, storageQueueDataContributorId, cancellationToken);

src/Aspire.Hosting.Azure.Provisioning/UserSecretsPathHelper.cs

@@ -5,7 +5,10 @@ namespace Aspire.Hosting.Azure;
 
 // Copied from https://github.com/dotnet/runtime/blob/213833ea99b79a4b494b2935e1ccb10b93cd4cbc/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PathHelper.cs
 
-public class UserSecretsPathHelper
+/// <summary>
+/// Provides helper methods for working with user secrets in a location outside of source control.
+/// </summary>
+internal sealed class UserSecretsPathHelper
 {
     internal const string SecretsFileName = "secrets.json";
 

src/Aspire.Hosting.Azure/AzureAppConfigurationResource.cs

@@ -3,9 +3,20 @@
 
 namespace Aspire.Hosting.ApplicationModel;
 
+/// <summary>
+/// Represents an Azure App Configuration resource.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
 public class AzureAppConfigurationResource(string name) : Resource(name), IAzureResource, IResourceWithConnectionString
 {
+    /// <summary>
+    /// Gets or sets the endpoint for the Azure App Configuration resource.
+    /// </summary>
     public string? Endpoint { get; set; }
 
+    /// <summary>
+    /// Gets the connection string for the Azure App Configuration resource.
+    /// </summary>
+    /// <returns>The connection string for the Azure App Configuration resource.</returns>
     public string? GetConnectionString() => Endpoint;
 }

src/Aspire.Hosting.Azure/AzureBlobStorageResource.cs

@@ -0,0 +1,26 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// Represents a resource that is stored in Azure Blob Storage.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
+/// <param name="storage">The <see cref="AzureStorageResource"/> that the resource is stored in.</param>
+public class AzureBlobStorageResource(string name, AzureStorageResource storage) : Resource(name),
+    IAzureResource,
+    IResourceWithConnectionString,
+    IResourceWithParent<AzureStorageResource>
+{
+    /// <summary>
+    /// Gets the parent AzureStorageResource of this AzureBlobStorageResource.
+    /// </summary>
+    public AzureStorageResource Parent => storage;
+
+    /// <summary>
+    /// Gets the connection string for the Azure Blob Storage resource.
+    /// </summary>
+    /// <returns>The connection string for the Azure Blob Storage resource.</returns>
+    public string? GetConnectionString() => Parent.GetBlobConnectionString();
+}

src/Aspire.Hosting.Azure/AzureKeyVaultResource.cs

@@ -3,9 +3,20 @@
 
 namespace Aspire.Hosting.ApplicationModel;
 
+/// <summary>
+/// Represents an Azure Key Vault resource that can be deployed to an Azure resource group.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
 public class AzureKeyVaultResource(string name) : Resource(name), IAzureResource, IResourceWithConnectionString
 {
+    /// <summary>
+    /// Gets or sets the URI of the Azure Key Vault.
+    /// </summary>
     public Uri? VaultUri { get; set; }
 
+    /// <summary>
+    /// Gets the connection string for the Azure Key Vault resource.
+    /// </summary>
+    /// <returns>The connection string for the Azure Key Vault resource.</returns>
     public string? GetConnectionString() => VaultUri?.ToString();
 }

src/Aspire.Hosting.Azure/AzureQueueStorageResource.cs

@@ -0,0 +1,26 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+namespace Aspire.Hosting.ApplicationModel;
+
+/// <summary>
+/// Represents an Azure Queue Storage resource.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
+/// <param name="storage">The <see cref="AzureStorageResource"/> that the resource is stored in.</param>
+public class AzureQueueStorageResource(string name, AzureStorageResource storage) : Resource(name),
+    IAzureResource,
+    IResourceWithConnectionString,
+    IResourceWithParent<AzureStorageResource>
+{
+    /// <summary>
+    /// Gets the parent AzureStorageResource of this AzureQueueStorageResource.
+    /// </summary>
+    public AzureStorageResource Parent => storage;
+
+    /// <summary>
+    /// Gets the connection string for the Azure Queue Storage resource.
+    /// </summary>
+    /// <returns>The connection string for the Azure Queue Storage resource.</returns>
+    public string? GetConnectionString() => Parent.GetQueueConnectionString();
+}

src/Aspire.Hosting.Azure/AzureRedisResource.cs

@@ -3,9 +3,20 @@
 
 namespace Aspire.Hosting.ApplicationModel;
 
+/// <summary>
+/// Represents an Azure Redis resource.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
 public class AzureRedisResource(string name) : Resource(name), IAzureResource, IResourceWithConnectionString
 {
+    /// <summary>
+    /// Gets or sets the connection string for the Azure Redis resource.
+    /// </summary>
     public string? ConnectionString { get; set; }
 
+    /// <summary>
+    /// Gets the connection string for the Azure Redis resource.
+    /// </summary>
+    /// <returns>The connection string for the Azure Redis resource.</returns>
     public string? GetConnectionString() => ConnectionString;
 }

src/Aspire.Hosting.Azure/AzureResourceExtensions.cs

@@ -7,6 +7,9 @@
 
 namespace Aspire.Hosting;
 
+/// <summary>
+/// Provides extension methods for adding Azure resources to the application model.
+/// </summary>
 public static class AzureResourceExtensions
 {
     /// <summary>

src/Aspire.Hosting.Azure/AzureServiceBusResource.cs

@@ -3,13 +3,31 @@
 
 namespace Aspire.Hosting.ApplicationModel;
 
+/// <summary>
+/// Represents an Azure Service Bus resource.
+/// </summary>
+/// <param name="name">The name of the resource.</param>
 public class AzureServiceBusResource(string name) : Resource(name), IAzureResource, IResourceWithConnectionString
 {
-    // This is the full uri to the service bus namespace e.g namespace.servicebus.windows.net
+    /// <summary>
+    /// Gets or sets the Service Bus endpoint. This is the full uri to the service bus 
+    /// namespace, for example <c>"namespace.servicebus.windows.net"</c>.
+    /// </summary>
     public string? ServiceBusEndpoint { get; set; }
 
+    /// <summary>
+    /// Gets or sets the names of the queues associated with the Azure Service Bus resource.
+    /// </summary>
     public string[] QueueNames { get; set; } = [];
+    
+    /// <summary>
+    /// Gets or sets the names of the topics associated with the Azure Service Bus resource.
+    /// </summary>
     public string[] TopicNames { get; set; } = [];
 
+    /// <summary>
+    /// Gets the connection string for the Azure Service Bus endpoint.
+    /// </summary>
+    /// <returns>The connection string for the Azure Service Bus endpoint.</returns>
     public string? GetConnectionString() => ServiceBusEndpoint;
 }