Skip to content

Commit 55f2df7

Browse files
authored
Merge pull request #279779 from TimShererWithAquent/us248136h
Convert 20 services to new template: Azure Key Vault
2 parents e5f142a + 59bc74b commit 55f2df7

File tree

3 files changed

+171
-172
lines changed

3 files changed

+171
-172
lines changed
Lines changed: 49 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,74 @@
11
---
2-
title: Monitoring Azure Key Vault data reference
3-
description: Important reference material needed when you monitor Key Vault
4-
author: msmbaldwin
2+
title: Monitoring data reference for Azure Key Vault
3+
description: This article contains important reference material you need when you monitor Azure Key Vault by using Azure Monitor.
4+
ms.date: 07/09/2024
5+
ms.custom: horz-monitor, subject-monitoring
56
ms.topic: reference
7+
author: msmbaldwin
68
ms.author: mbaldwin
79
ms.service: key-vault
8-
ms.subservice: general
9-
ms.custom: subject-monitoring
10-
ms.date: 02/20/2024
1110
---
11+
# Azure Key Vault monitoring data reference
1212

13-
# Monitoring Key Vault data reference
13+
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
1414

15-
See [Monitoring Key Vault](monitor-key-vault.md) for details on collecting and analyzing monitoring data for Key Vault.
15+
See [Monitor Azure Key Vault](monitor-key-vault.md) for details on the data you can collect for Key Vault and how to use it.
1616

17-
## Metrics
17+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
1818

19+
### Supported metrics for microsoft.keyvault/managedhsms
1920

20-
This section lists all the automatically collected platform metrics collected for Key Vault.
21+
The following table lists the metrics available for the microsoft.keyvault/managedhsms resource type.
2122

22-
|Metric Type | Resource Provider / Type Namespace<br/> and link to individual metrics |
23-
|-------|-----|
24-
| Key Vault | [Microsoft.KeyVault/vaults](../../azure-monitor/essentials/metrics-supported.md#microsoftkeyvaultvaults) |
25-
| Managed HSM | [Microsoft.KeyVault/managedhsms](../../azure-monitor/essentials/resource-logs-categories.md#microsoftkeyvaultmanagedhsms)
23+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
24+
[!INCLUDE [microsoft.keyvault/managedhsms](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-keyvault-managedhsms-metrics-include.md)]
2625

27-
### Key Vault metrics
26+
### Supported metrics for Microsoft.KeyVault/vaults
2827

29-
Resource Provider and Type: [Microsoft.KeyVault/vaults](../../azure-monitor/essentials/metrics-supported.md#microsoftkeyvaultvaults)
28+
The following table lists the metrics available for the Microsoft.KeyVault/vaults resource type.
3029

31-
| Name | Metric | Unit | Type | Description |
32-
|:-------|:-----|:------------|:------------------|
33-
| Overall Vault Availability | Availability | Percent | Average | Vault requests availability |
34-
| Overall Vault Saturation | SaturationShoebox | Percent | Average| Vault capacity used |
35-
| Total Service Api Hits | ServiceApiHit | Count | Count | Number of total service API hits |
36-
| Overall Service Api Latency | ServiceApiLatency | MilliSeconds | Average | Overall latency of service API requests |
37-
| Total Service Api Results | ServiceApiResult | Count | Count | Number of total service API results |
30+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
31+
[!INCLUDE [Microsoft.KeyVault/vaults](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-keyvault-vaults-metrics-include.md)]
3832

39-
For more information, see a list of [all platform metrics supported in Azure Monitor](../../azure-monitor/essentials/metrics-supported.md).
33+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
4034

41-
## Metric dimensions
42-
43-
For more information on what metric dimensions are, see [Multi-dimensional metrics](../../azure-monitor/essentials/data-platform-metrics.md#multi-dimensional-metrics).
44-
45-
Key Vault has the following dimensions associated with its metrics:
35+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
4636

4737
- ActivityType
4838
- ActivityName
4939
- TransactionType
5040
- StatusCode
5141
- StatusCodeClass
5242

53-
## Resource logs
43+
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
44+
45+
### Supported resource logs for microsoft.keyvault/managedhsms
46+
47+
[!INCLUDE [microsoft.keyvault/managedhsms](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-keyvault-managedhsms-logs-include.md)]
48+
49+
### Supported resource logs for Microsoft.KeyVault/vaults
50+
51+
[!INCLUDE [Microsoft.KeyVault/vaults](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-keyvault-vaults-logs-include.md)]
5452

55-
This section lists the types of resource logs you can collect for Key Vault.
53+
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
5654

57-
For reference, see a list of [Microsoft.KeyVault/vaults](../../azure-monitor/essentials/resource-logs-categories.md#microsoftkeyvaultvaults). For full details, see [Azure Key Vault logging](logging.md).
55+
### Key Vault microsoft.keyvault/managedhsms
5856

59-
|Resource Log Type | Resource Provider / Type Namespace<br/> and link to individual metrics |
60-
|-------|-----|
61-
| Key Vault | [Microsoft.KeyVault/vaults](../../azure-monitor/essentials/resource-logs-categories.md#microsoftkeyvaultmanagedhsms) |
62-
| Managed HSM | [Microsoft.KeyVault/managedhsms](../../azure-monitor/essentials/resource-logs-categories.md#microsoftkeyvaultvaults)
57+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
58+
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
59+
- [AZKVAuditLogs](/azure/azure-monitor/reference/tables/azkvauditlogs#columns)
6360

64-
## Azure Monitor Logs tables
61+
### Key Vault Microsoft.KeyVault/vaults
6562

66-
This section refers to all of the Azure Monitor Logs Kusto tables relevant to Key Vault and available for query by Log Analytics.
63+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
64+
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
65+
- [AZKVAuditLogs](/azure/azure-monitor/reference/tables/azkvauditlogs#columns)
66+
- [AZKVPolicyEvaluationDetailsLogs](/azure/azure-monitor/reference/tables/azkvpolicyevaluationdetailslogs#columns)
67+
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics#columns)
6768

68-
|Resource Type | Notes |
69-
|-------|-----|
70-
| [Key Vault](/azure/azure-monitor/reference/tables/tables-resourcetype#key-vaults) | |
69+
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
7170

72-
For a reference of all Azure Monitor Logs / Log Analytics tables, see the [Azure Monitor Log Table Reference](/azure/azure-monitor/reference/tables/tables-resourcetype).
71+
- [Security resource provider operations](/azure/role-based-access-control/resource-provider-operations#security)
7372

7473
### Diagnostics tables
7574

@@ -79,21 +78,21 @@ Key Vault uses the [Azure Diagnostics](/azure/azure-monitor/reference/tables/azu
7978

8079
| Property | Description |
8180
|:--- |:---|
82-
| _ResourceId | A unique identifier for the resource that the record is associated with |
83-
| CallerIPAddress | IP address of the user who has performed the operation UPN claim or SPN claim based on availability. |
81+
| _ResourceId | A unique identifier for the resource that the record is associated with. |
82+
| CallerIPAddress | IP address of the user who performed the operation UPN claim or SPN claim based on availability. |
8483
| DurationMs | The duration of the operation in milliseconds. |
85-
| httpStatusCode_d | HTTP status code returned by the request (for example, *200*) |
84+
| httpStatusCode_d | HTTP status code returned by the request, for example, *200*. |
8685
| Level | Level of the event. One of the following values: Critical, Error, Warning, Informational and Verbose. |
87-
| OperationName | Name of the operation, for example, Alert |
86+
| OperationName | Name of the operation, for example, Alert. |
8887
| properties_s | |
8988
| Region_s | |
9089
| requestUri_s | The URI of the client request. |
9190
| Resource | |
9291
| ResourceProvider | Resource provider of the Azure resource reporting the metric. |
9392
| ResultSignature | |
94-
| TimeGenerated | Date and time the record was created |
93+
| TimeGenerated | Date and time the record was created. |
9594

96-
## See also
95+
## Related content
9796

98-
- See [Monitoring Azure Key Vault](monitor-key-vault.md) for a description of monitoring Azure Key Vault.
99-
- See [Monitoring Azure resources with Azure Monitor](../../azure-monitor/essentials/monitor-azure-resource.md) for details on monitoring Azure resources.
97+
- See [Monitor Azure Key Vault](monitor-key-vault.md) for a description of monitoring Key Vault.
98+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

0 commit comments

Comments
 (0)