Azure Key Vault pattern-based discovery
Summarize
Summary of Azure Key Vault pattern-based discovery
Azure Key Vault pattern-based discovery, available in the Discovery and Service Mapping Patterns application, enables ServiceNow customers to identify and map Azure Key Vault resources within their cloud environments. This functionality supports both CMDB and non-CMDB data population, helping maintain accurate, up-to-date records of Azure Key Vault instances and their configurations.
Show less
Key Features
- Pattern Activation: The Azure Key Vault discovery pattern is disabled by default. Activating or deactivating patterns with Visibility Content version 6.28.0 or later does not count as customization and patterns reset to the latest predefined version after upgrades while retaining active states.
- Azure GovCloud Support: Discovery supports Azure GovCloud (US) accounts by configuring the discovery schedule with appropriate datacenter URLs and service accounts.
- Data Population: The pattern populates data in:
- Non-CMDB tables: Specifically, azurekeyvaultkeyvault table with detailed resource attributes such as kind, location, provisioning status, network access, resource group, and tenant information.
- CMDB tables: Cloud Resource table (cmdbcicmpresource) stores essential resource metadata including install status, operational status, name, object ID, resource type (set to microsoft.keyvault/vaults), and description.
- CI Relationships: The pattern creates important relationships linking Azure Key Vaults to resource groups, datacenters, and cloud resources to support comprehensive discovery and mapping.
- Azure Tag Discovery: Tags are collected and stored in the Key Value table (cmdbkeyvalue) with key-value pairs representing tag names and values, enhancing resource categorization.
Practical Application for ServiceNow Customers
By enabling this pattern, ServiceNow customers can automate the discovery and mapping of Azure Key Vault services, ensuring their CMDB accurately reflects the current state of these critical security resources. This supports better governance, compliance, and operational management of Azure environments.
Before activation, customers should verify Azure discovery prerequisites and configure discovery schedules correctly, especially when working with Azure GovCloud accounts. Leveraging this pattern improves visibility into Azure Key Vault instances and their associated metadata, relationships, and tags, facilitating more effective cloud resource management within ServiceNow.
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. |