0
# Operations and Resource Discovery
1
2
Service discovery and available operations listing for the Azure Key Vault Management API. Provides metadata about supported operations, capabilities, and service specifications for programmatic discovery and monitoring.
3
4
## Capabilities
5
6
### Operations Listing
7
8
Retrieve all available operations supported by the Azure Key Vault Management API, including metadata about each operation's purpose and parameters.
9
10
```python { .api }
11
def list() -> ItemPaged[Operation]:
12
"""
13
Lists all available operations for the Azure Key Vault Management API.
14
15
Returns:
16
ItemPaged[Operation]: Paginated list of available operations
17
"""
18
```
19
20
21
## Usage Examples
22
23
### Discovering Available Operations
24
25
```python
26
from azure.mgmt.keyvault import KeyVaultManagementClient
27
from azure.identity import DefaultAzureCredential
28
29
credential = DefaultAzureCredential()
30
client = KeyVaultManagementClient(credential, "subscription-id")
31
32
# List all available operations
33
print("Available Azure Key Vault Management Operations:")
34
print("=" * 50)
35
36
for operation in client.operations.list():
37
print(f"Operation: {operation.name}")
38
print(f" Display Name: {operation.display.operation}")
39
print(f" Provider: {operation.display.provider}")
40
print(f" Resource: {operation.display.resource}")
41
print(f" Description: {operation.display.description}")
42
print()
43
```
44
45
46
## Types
47
48
### Operation Information
49
50
```python { .api }
51
class Operation:
52
name: Optional[str]
53
is_data_action: Optional[bool]
54
display: Optional[OperationDisplay]
55
origin: Optional[str]
56
properties: Optional[Any]
57
58
class OperationDisplay:
59
provider: Optional[str]
60
resource: Optional[str]
61
operation: Optional[str]
62
description: Optional[str]
63
```
64
65
### Operation Results
66
67
```python { .api }
68
class OperationListResult:
69
value: Optional[List[Operation]]
70
next_link: Optional[str]
71
```
72
73
### Geo-Replication Regions
74
75
```python { .api }
76
class MHSMGeoReplicatedRegion:
77
name: Optional[str]
78
provisioning_state: Optional[GeoReplicationRegionProvisioningState]
79
is_primary: Optional[bool]
80
81
class MHSMRegionsListResult:
82
value: Optional[List[MHSMGeoReplicatedRegion]]
83
next_link: Optional[str]
84
```
85
86
### Service Specifications
87
88
```python { .api }
89
class ServiceSpecification:
90
log_specifications: Optional[List[LogSpecification]]
91
metric_specifications: Optional[List[MetricSpecification]]
92
93
class LogSpecification:
94
name: Optional[str]
95
display_name: Optional[str]
96
blob_duration: Optional[str]
97
98
class MetricSpecification:
99
name: Optional[str]
100
display_name: Optional[str]
101
display_description: Optional[str]
102
unit: Optional[str]
103
aggregation_type: Optional[str]
104
supported_aggregation_types: Optional[List[str]]
105
supported_time_grain_types: Optional[List[str]]
106
fill_gap_with_zero: Optional[bool]
107
category: Optional[str]
108
resource_id_dimension_name_override: Optional[str]
109
is_internal: Optional[bool]
110
dimensions: Optional[List[DimensionProperties]]
111
112
class DimensionProperties:
113
name: Optional[str]
114
display_name: Optional[str]
115
internal_name: Optional[str]
116
internal_metric_name: Optional[str]
117
source_mdm_namespace: Optional[str]
118
to_be_exported_for_shoebox: Optional[bool]
119
```
120
121
### Enumerations
122
123
```python { .api }
124
class GeoReplicationRegionProvisioningState(str, Enum):
125
PROVISIONING = "Provisioning"
126
SUCCEEDED = "Succeeded"
127
DELETING = "Deleting"
128
FAILED = "Failed"
129
CLEANUP = "Cleanup"
130
```
131
132
## Common Operations Categories
133
134
### Resource Management Operations
135
136
Operations for managing Key Vault and Managed HSM resources:
137
138
- `Microsoft.KeyVault/vaults/read` - Get vault properties
139
- `Microsoft.KeyVault/vaults/write` - Create or update vault
140
- `Microsoft.KeyVault/vaults/delete` - Delete vault
141
- `Microsoft.KeyVault/managedHSMs/read` - Get managed HSM properties
142
- `Microsoft.KeyVault/managedHSMs/write` - Create or update managed HSM
143
- `Microsoft.KeyVault/managedHSMs/delete` - Delete managed HSM
144
145
### Key and Secret Operations
146
147
ARM-level operations for keys and secrets:
148
149
- `Microsoft.KeyVault/vaults/keys/read` - Get key metadata
150
- `Microsoft.KeyVault/vaults/keys/write` - Create or update key
151
- `Microsoft.KeyVault/vaults/secrets/read` - Get secret metadata
152
- `Microsoft.KeyVault/vaults/secrets/write` - Create or update secret
153
154
### Network Security Operations
155
156
Operations for private endpoints and network rules:
157
158
- `Microsoft.KeyVault/vaults/privateEndpointConnections/read` - Get private endpoint connection
159
- `Microsoft.KeyVault/vaults/privateEndpointConnections/write` - Update private endpoint connection
160
- `Microsoft.KeyVault/vaults/privateEndpointConnections/delete` - Delete private endpoint connection
161
162
### Administrative Operations
163
164
Service-level administrative operations:
165
166
- `Microsoft.KeyVault/operations/read` - List available operations
167
- `Microsoft.KeyVault/checkNameAvailability/read` - Check name availability
168
- `Microsoft.KeyVault/deletedVaults/read` - List deleted vaults
169
- `Microsoft.KeyVault/locations/deletedVaults/purge/action` - Purge deleted vault
170
171
## Monitoring and Compliance
172
173
### Operation Tracking
174
175
Use operations listing for:
176
177
- Compliance auditing and reporting
178
- Monitoring API usage patterns
179
- Implementing custom RBAC policies
180
- Building automation tools with operation discovery
181
182
### Regional Capabilities
183
184
Geo-replication region information supports:
185
186
- Disaster recovery planning
187
- Data residency compliance
188
- Performance optimization through regional selection
189
- High availability architecture design