Azure Key Vault pattern-based discovery
Summarize
Summary of Azure Key Vault pattern-based discovery
The Azure Key Vault pattern-based discovery within ServiceNow’s Discovery and Service Mapping Patterns identifies Azure Key Vault services in your cloud environment. This discovery method populates both CMDB and non-CMDB tables with detailed data about Azure Key Vault resources, enabling comprehensive asset tracking and management.
Show less
Key Features
- Pattern Activation: The Azure Key Vault pattern is disabled by default and requires activation. Starting with Visibility Content version 6.28.0, enabling or disabling patterns is no longer treated as a customization, ensuring patterns remain updated after upgrades.
- Prerequisites: Ensure Microsoft Azure discovery prerequisites are met, including appropriate setup of Azure service accounts—especially when discovering Azure GovCloud environments, which require specific datacenter URLs.
- Data Population:
- Non-CMDB Data: Populated by the Azure - Key Vault - Extended Inventory (LP) pattern, stored in tables accessible via ServiceNow navigation (e.g., cmdbazurekeyvaultkeyvault), capturing attributes like resource ID, location, provisioning state, network access, and subscription details.
- CMDB Data: Also populated by the Extended Inventory pattern into the Cloud Resource table (cmdbcicmpresource), including resource install status, operational status, name, type (set as microsoft.keyvault/vaults), and description.
- Tag Collection: Azure tags associated with Key Vaults are discovered and stored in the Key Value table (cmdbkeyvalue) for enhanced metadata management.
- CI Relationships: The pattern establishes relationships linking Azure Key Vaults with resource groups, cloud resources, and Azure datacenters to provide a structured view of dependencies and hosting context.
Practical Benefits for ServiceNow Customers
- Enables automated discovery and detailed inventory of Azure Key Vaults across subscriptions and tenants, including GovCloud environments.
- Maintains up-to-date resource status and configuration details in the CMDB, supporting accurate service mapping and impact analysis.
- Supports governance and compliance by capturing provisioning state, network accessibility, and tagging information.
- Improves operational visibility by linking Key Vaults to their resource groups and hosting datacenters, facilitating troubleshooting and lifecycle management.
Discovery and Service Mapping Patterns finds Azure services on your cloud environment. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Pattern-based discovery and mapping requirements
- Verify the Microsoft Azure discovery prerequisites
- For more information, see the prerequisites section in Microsoft Azure Cloud components discovery using patterns.
- Enable the relevant pattern
- The pattern for this service is disabled by default. Starting with Visibility Content version 6.28.0, activating or deactivating a pattern won't be considered a customization, and it will continue to receive updates. Patterns that were previously activated or deactivated will reset to the latest predefined version after upgrading while retaining the last active field value. For more information on enabling patterns, see Activate a disabled pattern.
- Configure the Discovery schedule to support GovCloud
- Discovering Azure GovCloud (US) accounts requires using a datacenter URL when setting up an Azure service account. For more information, see Set up Azure service accounts.
Discovery and Service Mapping Patterns application populates data in both CMDB and non-CMDB tables.
Data stored in non-CMDB tables
Discovery and Service Mapping Patterns application populates data in the non-CMDB table when running the Azure - Key Vault - Extended Inventory(LP) pattern.
You can review the non-CMDB Azure tables by navigating to . You can also search the navigation filter for the specific pattern name.
| Field | Description |
|---|---|
| Kind [kind] | The specific form or variant of the resource type. |
| Location [location] | The geographical location where the resource is hosted. |
| Object Id [object_id] | The unique identifier of the resource. |
| Provisioning State [provisioning_state] | The current provisioning status of the resource. |
| Public Network Access [public_network_access] | Indicates whether the resource is accessible over a public network. |
| Resource Group [resource_group] | Name of the resource group. |
| Subscription ID [subscription_id] | The subscription ID. |
| Tenant ID [tenant_id] | The unique identifier of the Azure Active Directory tenant to which the resource belongs. |
| Configuration Item [configuration_item] | References the Cloud Resource [cmdb_ci_cmp_resource] table. |
Data stored in CMDB tables
Discovery and Service Mapping Patterns application populates data in the CMDB when running the Azure - Key Vault - Extended Inventory(LP) pattern.
| Field | Description |
|---|---|
| Install Status [install_status] | Install status of the resource. Default value is Installed. |
| Location [location] | The geographical location where the resource is hosted. |
| Name [name] | The name assigned to the resource. |
| Object ID [object_id] | The unique identifier of the resource. |
| Operational status [operational_status] | Operational status of the resource. Default value is Operational. |
| Resource type [resource_type] | Type of resource. The value is set to microsoft.keyvault/vaults. |
| Description [short_description] | Description of the resource or service. |
CI relationships
The pattern creates these relationships to support discovery.
| CI | Relationship | CI |
|---|---|---|
| Resource Group [cmdb_ci_resource_group] | Contains::Contained by | Cloud Resource [cmdb_ci_cmp_resource] |
| Cloud Resource [cmdb_ci_cmp_resource] | Hosted on::Hosts | Azure Datacenter [cmdb_ci_azure_datacenter] |
| Azure Key Vault [cmdb_azure_key_vault_key_vault] | References | Cloud Resource [cmdb_ci_cmp_resource] |
Azure tag discovery
| Field | Description |
|---|---|
| Key [key] | Tag name. |
| Value [value] | Tag value. |