Azure Key Vault pattern-based discovery
Summarize
Summary of Azure Key Vault pattern-based discovery
The Azure Key Vault pattern-based discovery enables ServiceNow customers to automatically detect and map Azure Key Vault resources within their cloud environment. This capability is part of the Discovery and Service Mapping Patterns application, which helps populate both CMDB and non-CMDB tables with detailed information about Azure services. Proper configuration and enabling of the relevant patterns are required to ensure accurate discovery.
Show less
Key Features
- Pattern Activation: The Azure Key Vault discovery pattern is disabled by default and must be enabled. Starting with Visibility Content version 6.28.0, enabling or disabling patterns does not count as customization and patterns receive updates automatically.
- Prerequisites: Verification of Microsoft Azure discovery prerequisites is necessary. Guidance is provided for setting up Azure service accounts, especially for GovCloud environments requiring datacenter URLs.
- Data Population: The discovery process populates data in both CMDB and non-CMDB tables:
- Non-CMDB Table (cmdbazurekeyvaultkeyvault): Stores detailed Azure Key Vault attributes such as kind, location, object ID, provisioning state, public network access, resource group, subscription ID, tenant ID, and links to the Cloud Resource table.
- CMDB Table (cmdbcicmpresource): Captures general cloud resource information including install status, location, name, object ID, operational status, resource type (set to microsoft.keyvault/vaults), and description.
- CI Relationships: The pattern establishes relationships to reflect resource group containment, hosting on Azure datacenters, and references between Azure Key Vault and cloud resource CIs to provide a comprehensive service map.
- Tag Collection: Azure tags are collected and stored in the Key Value [cmdbkeyvalue] table, capturing tag names and values to support asset management and filtering.
Practical Benefits for ServiceNow Customers
By leveraging the Azure Key Vault pattern-based discovery, customers can:
- Automatically detect and inventory Azure Key Vault resources within their cloud infrastructure.
- Ensure accurate and updated CMDB records that support IT service management, compliance, and operational visibility.
- Benefit from ongoing updates to discovery patterns without losing custom activation settings.
- Understand resource relationships and configurations through comprehensive mapping, enabling better impact analysis and change management.
- Manage resource tags effectively for improved categorization and reporting.
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. |