-
Notifications
You must be signed in to change notification settings - Fork 6.7k
Expand file tree
/
Copy pathdelete_key_version.py
More file actions
57 lines (44 loc) · 1.89 KB
/
delete_key_version.py
File metadata and controls
57 lines (44 loc) · 1.89 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# [START kms_delete_key_version]
from google.cloud import kms
def delete_key_version(
project_id: str, location_id: str, key_ring_id: str, key_id: str, version_id: str
) -> None:
"""
Delete the given key version. This action is permanent and cannot be undone.
Once the key version is deleted, it will no longer exist.
Args:
project_id (str): Google Cloud project ID (e.g. 'my-project').
location_id (str): Cloud KMS location (e.g. 'us-east1').
key_ring_id (str): ID of the Cloud KMS key ring (e.g. 'my-key-ring').
key_id (str): ID of the key to use (e.g. 'my-key').
version_id (str): ID of the key version to delete (e.g. '1').
Returns:
None
"""
# Create the client.
client = kms.KeyManagementServiceClient()
# Build the key version name.
key_version_name = client.crypto_key_version_path(
project_id, location_id, key_ring_id, key_id, version_id
)
# Call the API.
# Note: delete_crypto_key_version returns a long-running operation.
# Warning: This operation is permanent and cannot be undone.
operation = client.delete_crypto_key_version(request={"name": key_version_name})
# Wait for the operation to complete.
operation.result()
print(f"Deleted key version: {key_version_name}")
# [END kms_delete_key_version]