Rewrite Azure Key Vault content #2555
Conversation
dotnetrepoman
bot
added
database
There was a problem hiding this comment.
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (4)
docs/security/azure-security-key-vault-integration.md:3
- The word 'Lean' should be 'Learn'.
description: Lean about the .NET Aspire Azure Key Vault integration.
docs/security/azure-security-key-vault-integration.md:33
- The word 'THe' should be 'The'.
THe following sections describe various example usages.
docs/security/azure-security-key-vault-integration.md:188
- [nitpick] The term ':::no-loc text="Program.cs":::' should be consistent with the rest of the document.
In the :::no-loc text="Program.cs"::: file of your client-consuming project, call the <xref:Microsoft.Extensions.Hosting.AspireKeyVaultExtensions.AddAzureKeyVaultSecrets*> extension method on the <xref:Microsoft.Extensions.Configuration.IConfiguration> to add the secrets as part of your app's configuration.
docs/security/azure-security-key-vault-integration.md:194
- [nitpick] The note about
AddAzureKeyVaultSecretsAPI name causing confusion should be clearer.
> [!NOTE]
> The `AddAzureKeyVaultSecrets` API name has caused a bit of confusion. The method is used to configure the `SecretClient` based on the given connection name, and _it's not used_ to add secrets to the configuration.
Co-authored-by: Copilot <[email protected]>
IEvangelist
force-pushed
the
azure-key-vault
branch
from
4b0451f to
a0fe879
Compare
| <!-- markdownlint-disable MD033 --> | ||
| <br/> | ||
| <details> | ||
| <summary id="azure-postgresql"><strong>Toggle Azure PostgreSQL Bicep.</strong></summary> |
There was a problem hiding this comment.
This "toggle" and the "following Bicep" and "preceding Bicep" references to content only seen when the section is expanded seems likely to confuse many readers, as it did me. I read the reference to the "following Bicep" and the "preceding Bicep" and didn't see any, and it took a while for me comparing source in the PR to the review site before I realized this was an expanding/collapsing section. I think the reader experience would be better without the toggle. The blocks of code hidden by the toggle aren't so big as to be more of a nuisance when they're shown compared to needing to click on the toggle to see what blocks of code the text is referring to when they're hidden.
| <!-- markdownlint-disable MD033 --> | ||
| <br/> | ||
| <details> | ||
| <summary id="azure-key-vault"><strong>Toggle Azure Key Vault Bicep.</strong></summary> |
There was a problem hiding this comment.
See my comment on the "toggle" in the other location where it appears.
| To get started with the .NET Aspire Azure Key Vault integration, install the [📦 Aspire.Azure.Security.KeyVault](https://www.nuget.org/packages/Aspire.Azure.Security.KeyVault) NuGet package in the client-consuming project, i.e., the project for the application that uses the Azure Key Vault client. | ||
| ## Hosting integration | ||
|
|
||
| The Azure Key Vault hosting integration models a Key Vault resource as the <xref:Aspire.Hosting.Azure.AzureKeyVaultResource> type. To access this type and APIs for expressing them within your [app host](xref:dotnet/aspire/app-host) project, install the [📦 Aspire.Hosting.Azure.KeyVault](https://www.nuget.org/packages/Aspire.Hosting.Azure.KeyVault) NuGet package: |
There was a problem hiding this comment.
As noted elsewhere, it's not clear to me what "them" refers to.
Co-authored-by: Tom Dykstra <[email protected]>
Summary
Rewrite Azure Key Vault content.
Fixes #2311
Internal previews