mcpField
A
azure-key-vault

azure-key-vault

github.com/microsoftdocsSecurity797319 installsUpdated 4d ago
Repository

About azure-key-vault

azure-key-vault is a guidance skill for agents working with Azure Key Vault and Managed HSM. It combines local references with remote documentation access across security, configuration, migration, troubleshooting, and coding patterns.

Key features

  1. 01Key Vault and Managed HSM troubleshooting
  2. 02Security and access-control guidance
  3. 03Configuration and quota references
  4. 04Integration patterns and code samples
  5. 05Deployment and migration guidance

Use cases

  1. 01Diagnosing access-policy or network errors
  2. 02Planning cryptographic workload migrations
  3. 03Configuring key rotation and monitoring

MCP support

The skill can fetch documentation through mcp_microsoftdocs:microsoft_docs_fetch, with fetch_webpage as a fallback.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/microsoftdocs/agent-skills --skill azure-key-vault

After installing, type/azure-key-vaultin Claude Code to confirm it loaded.

Details

From the project README

Azure Key Vault Skill

This skill provides expert guidance for Azure Key Vault. Covers troubleshooting, best practices, decision making, limits & quotas, security, configuration, integrations & coding patterns, and deployment. It combines local quick-reference content with remote documentation fetching capabilities.

How to Use This Skill

IMPORTANT for Agent: Use the Category Index below to locate relevant sections. For categories with line ranges (e.g., L35-L120), use read_file with the specified lines. For categories with file links (e.g., [security.md](security.md)), use read_file on the linked reference file

IMPORTANT for Agent: If metadata.generated_at is more than 3 months old, suggest the user pull the latest version from the repository. If mcp_microsoftdocs tools are not available, suggest the user install it: Installation Guide

This skill requires network access to fetch documentation content:

  • Preferred: Use mcp_microsoftdocs:microsoft_docs_fetch with query string from=learn-agent-skill. Returns Markdown.
  • Fallback: Use fetch_webpage with query string from=learn-agent-skill&accept=text/markdown. Returns Markdown.

Category Index

CategoryLinesDescription
TroubleshootingL36-L45Diagnosing and fixing Key Vault errors: REST/API codes, Private Link misconfig, access policy/Policy enforcement issues, and Managed HSM external key management failures.
Best PracticesL46-L52Best practices for securing Key Vault keys, handling Managed HSM disaster recovery, and generating/importing BYOK HSM keys for compliant, resilient key management.
Decision MakingL53-L63Guidance on choosing access control models, safely updating Key Vault APIs, and planning/migrating key workloads, including external keys and Managed HSM capacity, scaling, and SLAs.
Limits & QuotasL64-L75Limits, quotas, and behaviors for Key Vault and Managed HSM (certificates, secrets, throttling, logging latency, IP firewall/network rules, soft-delete/recovery, and capacity constraints).
SecurityL76-L106Securing Azure Key Vault and Managed HSM: auth (Entra ID, RBAC/ABAC, access policies), networking/firewalls/private endpoints, Zero Trust, BYOK/HSM key transfer, backup/restore, and best practices.
ConfigurationL107-L130Configuring Key Vault and Managed HSM for monitoring, logging, alerts, policies, key/secret types and rotation, secure key release, BYOK imports, and soft-delete/purge protection.
Integrations & Coding PatternsL131-L159Patterns and code samples for integrating Key Vault with apps and services (Event Grid, Logic Apps, Databricks, Private Link) and using keys/secrets from .NET, Node.js, Python, and JavaScript.
DeploymentL160-L163How to deploy and provision Azure Key Vault and Managed HSM (vaults, keys, secrets) using ARM templates, Bicep, Terraform, Azure CLI, and PowerShell
Troubleshooting
TopicURL
Resolve common Azure Key Vault error codeshttps://learn.microsoft.com/en-us/azure/key-vault/general/common-error-codes
Diagnose and fix Azure Key Vault Private Link configuration issueshttps://learn.microsoft.com/en-us/azure/key-vault/general/private-link-diagnostics
Interpret Azure Key Vault REST API error codeshttps://learn.microsoft.com/en-us/azure/key-vault/general/rest-error-codes
Troubleshoot Azure Policy enforcement on Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/troubleshoot-azure-policy-for-key-vault
Troubleshoot Azure Key Vault access policy failureshttps://learn.microsoft.com/en-us/azure/key-vault/general/troubleshooting-access-issues
Troubleshoot Managed HSM external key management failureshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/external-key-management-troubleshooting
Best Practices
TopicURL
Apply security best practices for Azure Key Vault keyshttps://learn.microsoft.com/en-us/azure/key-vault/keys/secure-keys
Execute disaster recovery for Azure Managed HSM disruptionshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/disaster-recovery-guide
Generate and import BYOK HSM keys into Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/hsm-protected-keys-byok
Decision Making
TopicURL
Choose default access control model for Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/access-control-default
Update Azure Key Vault API versions safelyhttps://learn.microsoft.com/en-us/azure/key-vault/general/migrate-api-version
Plan and execute migration of cryptographic key workloadshttps://learn.microsoft.com/en-us/azure/key-vault/general/migrate-key-workloads
Migrate Azure Key Vault from access policies to RBAChttps://learn.microsoft.com/en-us/azure/key-vault/general/rbac-migration
Plan migration from external keys to Managed HSM keyshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/external-key-management-migration
Evaluate SLA and responsibilities for Managed HSM external keyshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/external-key-management-shared-responsibility
Plan capacity and scaling for Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/scaling-guidance
Limits & Quotas
TopicURL
Understand Azure Key Vault certificate limits and behaviorshttps://learn.microsoft.com/en-us/azure/key-vault/certificates/faq
Configure and interpret Azure Key Vault logging latencyhttps://learn.microsoft.com/en-us/azure/key-vault/general/logging
Understand and manage Azure Key Vault throttling limitshttps://learn.microsoft.com/en-us/azure/key-vault/general/overview-throttling
Review Azure Key Vault and Managed HSM service limitshttps://learn.microsoft.com/en-us/azure/key-vault/general/service-limits
Configure Managed HSM IP firewall and network securityhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/configure-network-security
Review Azure Managed HSM service limits and quotashttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/service-limits
Use soft-delete and recovery for Managed HSM resourceshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/soft-delete-overview
Understand Azure Key Vault secret size limitshttps://learn.microsoft.com/en-us/azure/key-vault/secrets/about-secrets
Security
TopicURL
Apply security best practices to Key Vault certificateshttps://learn.microsoft.com/en-us/azure/key-vault/certificates/secure-certificates
Allow Azure Key Vault access from clients behind firewallshttps://learn.microsoft.com/en-us/azure/key-vault/general/access-behind-firewall
Configure Azure Key Vault access policies with CLIhttps://learn.microsoft.com/en-us/azure/key-vault/general/assign-access-policy
Configure authentication to Azure Key Vault with Entra IDhttps://learn.microsoft.com/en-us/azure/key-vault/general/authentication
Add Azure ABAC conditions for Key Vault via CLIhttps://learn.microsoft.com/en-us/azure/key-vault/general/howto-abac-conditions-cli
Add Azure ABAC conditions for Key Vault via PowerShellhttps://learn.microsoft.com/en-us/azure/key-vault/general/howto-abac-conditions-powershell
Configure network security options for Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/network-security
Secure Azure Key Vault with virtual network service endpointshttps://learn.microsoft.com/en-us/azure/key-vault/general/overview-vnet-service-endpoints
Configure Azure Key Vault ABAC actions and attributeshttps://learn.microsoft.com/en-us/azure/key-vault/general/rbac-abac
Choose Azure RBAC vs access policies for Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/rbac-access-policy
Configure Azure RBAC access for Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/rbac-guide
Apply Zero Trust security practices to Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/secure-key-vault
Configure and use Azure Key Vault soft-delete safelyhttps://learn.microsoft.com/en-us/azure/key-vault/general/soft-delete-overview
Generate and transfer HSM-protected keys to Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/keys/hsm-protected-keys
Implement BYOK HSM key transfer for Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/keys/hsm-protected-keys-byok
Manage access control and authorization for Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/access-control
Configure ARM access for Managed HSM key managementhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/authorize-azure-resource-manager
Enforce Managed HSM governance with Azure Policyhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/azure-policy
Perform full and selective backup/restore for Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/backup-restore
Use Managed HSM built-in local RBAC roleshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/built-in-roles
Configure networking and mTLS for Managed HSM external keyshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/external-key-management-networking
Implement secure access control for Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/how-to-secure-access
Configure network security and firewall for Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/network-security
Configure Managed HSM private endpoints with Private Linkhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/private-link
Manage data plane RBAC roles for Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/role-management
Apply security best practices to Managed HSM deploymentshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/secure-managed-hsm
Apply security best practices for Key Vault secretshttps://learn.microsoft.com/en-us/azure/key-vault/secrets/secure-secrets
Configuration
TopicURL
Configure health and throttling alerts for Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/alert
Formulate authenticated JSON requests to Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/authentication-requests-and-responses
Apply Azure Policy to govern Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/azure-policy
Enable and configure Azure Key Vault diagnostic logginghttps://learn.microsoft.com/en-us/azure/key-vault/general/howto-logging
Configure monitoring for Azure Key Vault with Azure Monitorhttps://learn.microsoft.com/en-us/azure/key-vault/general/monitor-key-vault
Reference monitoring metrics and logs for Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/monitor-key-vault-reference
Use Azure Key Vault key types and algorithmshttps://learn.microsoft.com/en-us/azure/key-vault/keys/about-keys-details
Follow BYOK specification for importing HSM keys to Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/keys/byok-specification
Configure automatic cryptographic key rotation in Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/keys/how-to-configure-key-rotation
Author secure key release policies in Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/keys/policy-grammar
Configure key types and algorithms in Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/about-keys-details
Configure health and performance alerts for Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/configure-alerts
Configure logging and monitoring for Managed HSM external keyshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/external-key-management-logging-monitoring
Configure automated key rotation in Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/key-rotation
Configure logging and audit events for Azure Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/logging
Author secure key release policies for Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/policy-grammar
Configure soft-delete and purge protection for Managed HSMhttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/recovery
Configure Azure Key Vault to store multiline secretshttps://learn.microsoft.com/en-us/azure/key-vault/secrets/multiline-secrets
Automate single-credential secret rotation in Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/tutorial-rotation
Configure dual-credential secret rotation in Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/tutorial-rotation-dual
Integrations & Coding Patterns
TopicURL
Integrate Azure Key Vault with DigiCert CAhttps://learn.microsoft.com/en-us/azure/key-vault/certificates/how-to-integrate-certificate-authority
Trigger Logic Apps from Key Vault events via Event Gridhttps://learn.microsoft.com/en-us/azure/key-vault/general/event-grid-logicapps
Integrate Azure Key Vault events with Azure Event Gridhttps://learn.microsoft.com/en-us/azure/key-vault/general/event-grid-overview
Handle Azure Key Vault notifications with Event Grid and Automationhttps://learn.microsoft.com/en-us/azure/key-vault/general/event-grid-tutorial
Access Blob Storage via Databricks using Key Vault secretshttps://learn.microsoft.com/en-us/azure/key-vault/general/integrate-databricks-blob-storage
Integrate Azure Key Vault with Azure Private Linkhttps://learn.microsoft.com/en-us/azure/key-vault/general/private-link-service
Use Node.js on VMs to read secrets from Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/tutorial-javascript-virtual-machine
Connect ASP.NET Core web apps to Azure Key Vaulthttps://learn.microsoft.com/en-us/azure/key-vault/general/tutorial-net-create-vault-azure-web-app
Integrate .NET VM apps with Azure Key Vault secretshttps://learn.microsoft.com/en-us/azure/key-vault/general/tutorial-net-virtual-machine
Access Azure Key Vault from Python on virtual machineshttps://learn.microsoft.com/en-us/azure/key-vault/general/tutorial-python-virtual-machine
Back up, delete, and restore keys in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-backup-delete-restore-key
Create and rotate Key Vault keys in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-create-update-rotate-key
Enable or disable Key Vault keys in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-enable-disable-key
Encrypt and decrypt with Key Vault keys in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-encrypt-decrypt-key
Retrieve Azure Key Vault keys in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-get-key
Import keys into Azure Key Vault with JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-import-key
List Azure Key Vault keys using JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-list-key-version
Sign and verify with Key Vault keys in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/keys/javascript-developer-guide-sign-verify-key
Implement EKM Proxy API for Managed HSM external keyshttps://learn.microsoft.com/en-us/azure/key-vault/managed-hsm/external-key-management-proxy-api-reference
Back up and restore Key Vault secrets in JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/javascript-developer-guide-backup-secrets
Delete and purge Key Vault secrets with JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/javascript-developer-guide-delete-secret
Enable or disable Key Vault secrets using JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/javascript-developer-guide-enable-disable-secret
Retrieve Azure Key Vault secrets with JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/javascript-developer-guide-get-secret
Use Azure Key Vault secrets from JavaScript applicationshttps://learn.microsoft.com/en-us/azure/key-vault/secrets/javascript-developer-guide-get-started
Create, update, and rotate Key Vault secrets with JavaScripthttps://learn.microsoft.com/en-us/azure/key-vault/secrets/javascript-developer-guide-set-update-rotate-secret
Deployment
TopicURL
Provision Key Vault and key using Terraformhttps://learn.microsoft.com/en-us/azure/key-vault/keys/quick-create-terraform

Comments

Markdown supported