Skip to content

Commit f6e20e9

Browse files
Merge pull request #2712 from msmbaldwin/akv-overhaul
Key Vault docset audit: fix broken links, update SDKs, clean up orphans
2 parents 6d52ad6 + 85eb52e commit f6e20e9

16 files changed

Lines changed: 32 additions & 36 deletions

articles/key-vault/certificates/how-to-integrate-certificate-authority.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ DigiCertCA is now in the certificate authority list.
8787
3. Select the **Certificate Authorities** tab:
8888
:::image type="content" source="../media/certificates/how-to-integrate-certificate-authority/select-certificate-authorities.png" alt-text="Screenshot that shows selecting the Certificate Authorities tab.":::
8989
4. Select **Add**:
90-
:::image type="content" source="../media/certificates/how-to-integrate-certificate-authority/add-global-sign-certificate-authority.jpg" alt-text="Screenshot that shows the Add button on the Global Sign Certificate Authorities tab.":::
90+
:::image type="content" source="../media/certificates/how-to-integrate-certificate-authority/add-globalsign-ca.jpg" alt-text="Screenshot that shows the Add button on the Global Sign Certificate Authorities tab.":::
9191
5. Under **Create a certificate authority**, enter these values:
9292
- **Name**: An identifiable issuer name. For example, **GlobalSignCA**.
9393
- **Provider**: **GlobalSign**.

articles/key-vault/general/assign-access-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ms.author: mbaldwin
1717

1818
[!INCLUDE [contributor-role-warning.md](~/reusable-content/ce-skilling/azure/includes/key-vault/key-vault-contributor-role-warning.md)]
1919

20-
A Key Vault access policy determines whether a given security principal, namely a user, application or user group, can perform different operations on Key Vault [secrets](../secrets/index.yml), [keys](../keys/index.yml), and [certificates](../certificates/index.yml). You can assign access policies using the [Azure portal](assign-access-policy-portal.md), the Azure CLI, or [Azure PowerShell](assign-access-policy-powershell.md).
20+
A Key Vault access policy determines whether a given security principal, namely a user, application or user group, can perform different operations on Key Vault [secrets](../secrets/index.yml), [keys](../keys/index.yml), and [certificates](../certificates/index.yml). You can assign access policies using the Azure portal, the Azure CLI, or Azure PowerShell.
2121

2222
Key vault supports up to 1024 access policy entries, with each entry granting a distinct set of permissions to a particular security principal. Because of this limitation, we recommend assigning access policies to groups of users, where possible, rather than individual users. Using groups makes it much easier to manage permissions for multiple people in your organization. For more information, see [Manage app and resource access using Microsoft Entra groups](/entra/fundamentals/how-to-manage-groups).
2323

articles/key-vault/general/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ More information about best practices and developer examples, see [Authenticate
102102
## Next Steps
103103

104104
- [Key Vault developer's guide](developers-guide.md)
105-
- [Assign a Key Vault access policy using the Azure portal](assign-access-policy-portal.md)
105+
- [Assign a Key Vault access policy](assign-access-policy.md)
106106
- [Assign Azure RBAC role to Key Vault](rbac-guide.md)
107107
- [Key Vault access policy troubleshooting](troubleshooting-access-issues.md)
108108
- [Key Vault REST API error codes](rest-error-codes.md)

articles/key-vault/general/move-subscription.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,7 @@ az keyvault update -n myvault --set Properties.tenantId=$tenantId # Upd
101101
Now that your vault is associated with the correct tenant ID and old access policy entries or role assignments are removed, set new access policy entries or role assignments.
102102

103103
For assigning policies, see:
104-
- [Assign an access policy using Portal](assign-access-policy-portal.md)
105-
- [Assign an access policy using Azure CLI](assign-access-policy-cli.md)
106-
- [Assign an access policy using PowerShell](assign-access-policy-powershell.md)
104+
- [Assign a Key Vault access policy](assign-access-policy.md)
107105

108106
For adding role assignments, see:
109107
- [Assign Azure roles using the Azure portal](/azure/role-based-access-control/role-assignments-portal)

articles/key-vault/general/rbac-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The **control plane** is where you manage Key Vault itself. Operations in this p
3232

3333
The **data plane** is where you work with the data stored in a key vault. You can add, delete, and modify keys, secrets, and certificates.
3434

35-
Both planes use [Microsoft Entra ID](/entra/fundamentals/whatis) for authentication. For authorization, the control plane uses [Azure role-based access control (Azure RBAC)](/azure/role-based-access-control/overview) and the data plane uses a [Key Vault access policy](./assign-access-policy-portal.md) (legacy) or [Azure RBAC for Key Vault data plane operations](./rbac-guide.md).
35+
Both planes use [Microsoft Entra ID](/entra/fundamentals/whatis) for authentication. For authorization, the control plane uses [Azure role-based access control (Azure RBAC)](/azure/role-based-access-control/overview) and the data plane uses a [Key Vault access policy](./assign-access-policy.md) (legacy) or [Azure RBAC for Key Vault data plane operations](./rbac-guide.md).
3636

3737
To access a key vault in either plane, all callers (users or applications) must have proper authentication and authorization. Authentication establishes the identity of the caller. Authorization determines which operations the caller can execute.
3838

articles/key-vault/general/troubleshooting-access-issues.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.topic: how-to
1515

1616
### I'm not able to list or get secrets/keys/certificate. I'm seeing a "something went wrong" error
1717

18-
If you're having problem with listing/getting/creating or accessing secret, make sure that you have the appropriate Azure RBAC role assigned. See [Azure RBAC for Key Vault](./rbac-guide.md). If you're using the legacy access policy model, see [Key Vault Access Policies](./assign-access-policy-cli.md).
18+
If you're having problem with listing/getting/creating or accessing secret, make sure that you have the appropriate Azure RBAC role assigned. See [Azure RBAC for Key Vault](./rbac-guide.md). If you're using the legacy access policy model, see [Assign a Key Vault access policy](./assign-access-policy.md).
1919

2020
### How can I identify how and when key vaults are accessed?
2121

@@ -52,7 +52,7 @@ If you're creating an on-premises application, doing local development, or other
5252
Give the AD group permissions to your key vault using Azure RBAC with the Azure CLI `az role assignment create` command, or the Azure PowerShell `New-AzRoleAssignment` cmdlet. See [Azure RBAC for Key Vault data plane operations](rbac-guide.md).
5353

5454
> [!NOTE]
55-
> If you are using legacy access policies, you can use the Azure CLI `az keyvault set-policy` command or the Azure PowerShell `Set-AzKeyVaultAccessPolicy` cmdlet. However, Azure RBAC is the recommended authorization model. See [Assign an access policy - CLI](assign-access-policy-cli.md) and [Assign an access policy - PowerShell](assign-access-policy-powershell.md).
55+
> If you are using legacy access policies, you can use the Azure CLI `az keyvault set-policy` command or the Azure PowerShell `Set-AzKeyVaultAccessPolicy` cmdlet. However, Azure RBAC is the recommended authorization model. See [Assign a Key Vault access policy](assign-access-policy.md).
5656
5757
The application also needs at least one Identity and Access Management (IAM) role assigned to the key vault. Otherwise it will not be able to log in and will fail with insufficient rights to access the subscription. Microsoft Entra groups with Managed Identities may require many hours to refresh tokens and become effective. See [Limitation of using managed identities for authorization](/entra/identity/managed-identities-azure-resources/managed-identity-best-practice-recommendations#limitation-of-using-managed-identities-for-authorization)
5858

@@ -67,7 +67,7 @@ Another option that can help for this scenario is using Azure RBAC and roles as
6767
* HTTP 401: Unauthenticated Request - [Troubleshooting steps](rest-error-codes.md#http-401-unauthenticated-request)
6868
* HTTP 403: Insufficient Permissions - [Troubleshooting steps](rest-error-codes.md#http-403-insufficient-permissions)
6969
* HTTP 429: Too Many Requests - [Troubleshooting steps](rest-error-codes.md#http-429-too-many-requests)
70-
* Check if you've delete access permission to key vault: See [Azure RBAC for Key Vault](./rbac-guide.md). If using legacy access policies, see [Assign an access policy - CLI](assign-access-policy-cli.md), [Assign an access policy - PowerShell](assign-access-policy-powershell.md), or [Assign an access policy - Portal](assign-access-policy-portal.md).
70+
* Check if you've delete access permission to key vault: See [Azure RBAC for Key Vault](./rbac-guide.md). If using legacy access policies, see [Assign a Key Vault access policy](assign-access-policy.md).
7171
* If you have problem with authenticate to key vault in code, use [Authentication SDK](https://azure.github.io/azure-sdk/posts/2020-02-25/defaultazurecredentials.html)
7272

7373
### What are the best practices I should implement when key vault is getting throttled?

articles/key-vault/key-vault-insights-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ There's a limit of 200 key vaults that can be selected and viewed. Regardless of
148148

149149
We only show subscriptions that contain key vaults, chosen from the selected subscription filter, which are selected in the "Directory + Subscription" in the Azure portal header.
150150

151-
![Screenshot of subscription filter](./media/key-vaults-insights-overview/Subscriptions.png)
151+
![Screenshot of subscription filter](./media/key-vaults-insights-overview/subscription-filter.png)
152152

153153
### I want to make changes or add more visualizations to Key Vault Insights, how do I do so
154154

articles/key-vault/media/certificates/how-to-integrate-certificate-authority/add-global-sign-certificate-authority.JPG renamed to articles/key-vault/media/certificates/how-to-integrate-certificate-authority/add-globalsign-ca.jpg

File renamed without changes.

articles/key-vault/media/key-vaults-insights-overview/subscriptions.png renamed to articles/key-vault/media/key-vaults-insights-overview/subscription-filter.png

File renamed without changes.

articles/key-vault/secrets/about-secrets.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,8 @@ Use the following permissions, on a per-principal basis, in the secrets access c
6767
For more information on working with secrets, see [Secret operations in the Key Vault REST API reference](/rest/api/keyvault). For information on establishing permissions, see [Vaults - Create or Update](/rest/api/keyvault/keyvault/vaults/create-or-update) and [Vaults - Update Access Policy](/rest/api/keyvault/keyvault/vaults/update-access-policy).
6868

6969
How-to guides to control access in Key Vault:
70-
- [Assign a Key Vault access policy using CLI](../general/assign-access-policy-cli.md)
71-
- [Assign a Key Vault access policy using PowerShell](../general/assign-access-policy-powershell.md)
72-
- [Assign a Key Vault access policy using the Azure portal](../general/assign-access-policy-portal.md)
73-
- [Provide access to Key Vault keys, certificates, and secrets with an Azure role-based access control](../general/rbac-guide.md)
70+
- [Provide access to Key Vault keys, certificates, and secrets with Azure role-based access control](../general/rbac-guide.md) (recommended)
71+
- [Assign a Key Vault access policy](../general/assign-access-policy.md) (legacy)
7472

7573
## Secret tags
7674
You can specify more application-specific metadata in the form of tags. Key Vault supports up to 15 tags, each of which can have a 512-character name and a 512-character value.

0 commit comments

Comments
 (0)