feat(parametermanager): added samples for handling cmek in parameter (#13259)

Author: suvidha-malaviya

parametermanager/snippets/create_param_with_kms_key.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python
+
+# Copyright 2025 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
+"""
+command line application and sample code for
+creating a new default format parameter with kms key.
+"""
+
+from google.cloud import parametermanager_v1
+
+
+# [START parametermanager_create_param_with_kms_key]
+def create_param_with_kms_key(
+    project_id: str, parameter_id: str, kms_key: str
+) -> parametermanager_v1.Parameter:
+    """
+    Creates a parameter with default format (Unformatted)
+    in the global location of the specified
+    project and kms key using the Google Cloud Parameter Manager SDK.
+
+    Args:
+        project_id (str): The ID of the project where
+        the parameter is to be created.
+        parameter_id (str): The ID to assign to the new parameter.
+        This ID must be unique within the project.
+        kms_key (str): The KMS key used to encrypt the parameter.
+
+    Returns:
+        parametermanager_v1.Parameter: An object representing
+        the newly created parameter.
+
+    Example:
+        create_param_with_kms_key(
+            "my-project",
+            "my-global-parameter",
+            "projects/my-project/locations/global/keyRings/test/cryptoKeys/test-key"
+        )
+    """
+    # Import the necessary library for Google Cloud Parameter Manager.
+    from google.cloud import parametermanager_v1
+
+    # Create the Parameter Manager client.
+    client = parametermanager_v1.ParameterManagerClient()
+
+    # Build the resource name of the parent project in the global location.
+    parent = client.common_location_path(project_id, "global")
+
+    # Define the parameter creation request.
+    request = parametermanager_v1.CreateParameterRequest(
+        parent=parent,
+        parameter_id=parameter_id,
+        parameter=parametermanager_v1.Parameter(kms_key=kms_key),
+    )
+
+    # Create the parameter.
+    response = client.create_parameter(request=request)
+
+    # Print the newly created parameter name.
+    print(f"Created parameter {response.name} with kms key {kms_key}")
+    # [END parametermanager_create_param_with_kms_key]
+
+    return response

parametermanager/snippets/regional_samples/create_regional_param_with_kms_key.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+
+# Copyright 2025 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
+"""
+command line application and sample code for
+creating a new default format regional parameter with kms key.
+"""
+
+from google.cloud import parametermanager_v1
+
+
+# [START parametermanager_create_regional_param_with_kms_key]
+def create_regional_param_with_kms_key(
+    project_id: str, location_id: str, parameter_id: str, kms_key: str
+) -> parametermanager_v1.Parameter:
+    """
+    Creates a regional parameter with default format (Unformatted)
+    in the specified location, project and with kms key
+    using the Google Cloud Parameter Manager SDK.
+
+    Args:
+        project_id (str): The ID of the project where
+        the regional parameter is to be created.
+        location_id (str): The region where the parameter is to be created.
+        parameter_id (str): The ID to assign to the new parameter.
+        This ID must be unique within the project.
+        kms_key (str): The KMS key used to encrypt the parameter.
+
+    Returns:
+        parametermanager_v1.Parameter: An object representing
+        the newly created regional parameter.
+
+    Example:
+        create_regional_param_with_kms_key(
+            "my-project",
+            "us-central1",
+            "my-regional-parameter",
+            "projects/my-project/locations/us-central1/keyRings/test/cryptoKeys/test-key"
+        )
+    """
+
+    # Import the Parameter Manager client library.
+    from google.cloud import parametermanager_v1
+
+    api_endpoint = f"parametermanager.{location_id}.rep.googleapis.com"
+    # Create the Parameter Manager client for the specified region.
+    client = parametermanager_v1.ParameterManagerClient(
+        client_options={"api_endpoint": api_endpoint}
+    )
+
+    # Build the resource name of the parent project for the specified region.
+    parent = client.common_location_path(project_id, location_id)
+
+    # Define the parameter creation request.
+    request = parametermanager_v1.CreateParameterRequest(
+        parent=parent,
+        parameter_id=parameter_id,
+        parameter=parametermanager_v1.Parameter(kms_key=kms_key),
+    )
+
+    # Create the parameter.
+    response = client.create_parameter(request=request)
+
+    # Print the newly created parameter name.
+    print(f"Created regional parameter {response.name} with kms key {kms_key}")
+    # [END parametermanager_create_regional_param_with_kms_key]
+
+    return response

parametermanager/snippets/regional_samples/remove_regional_param_kms_key.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python
+
+# Copyright 2025 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
+"""
+command line application and sample code for removing the kms key from the regional parameter.
+"""
+
+from google.cloud import parametermanager_v1
+
+
+# [START parametermanager_remove_regional_param_kms_key]
+def remove_regional_param_kms_key(
+    project_id: str, location_id: str, parameter_id: str
+) -> parametermanager_v1.Parameter:
+    """
+    Remove the kms key of a specified regional parameter
+    in the specified project using the Google Cloud Parameter Manager SDK.
+
+    Args:
+        project_id (str): The ID of the project where the parameter is to be created.
+        location_id (str): The region where the parameter is to be created.
+        parameter_id (str): The ID of the regional parameter for
+        which kms key is to be updated.
+
+    Returns:
+        parametermanager_v1.Parameter: An object representing the
+        updated regional parameter.
+
+    Example:
+        remove_regional_param_kms_key(
+            "my-project",
+            "us-central1",
+            "my-global-parameter"
+        )
+    """
+    # Import the necessary library for Google Cloud Parameter Manager.
+    from google.cloud import parametermanager_v1
+    from google.protobuf import field_mask_pb2
+
+    # Create the Parameter Manager client.
+    api_endpoint = f"parametermanager.{location_id}.rep.googleapis.com"
+    # Create the Parameter Manager client for the specified region.
+    client = parametermanager_v1.ParameterManagerClient(
+        client_options={"api_endpoint": api_endpoint}
+    )
+
+    # Build the resource name of the regional parameter.
+    name = client.parameter_path(project_id, location_id, parameter_id)
+
+    # Get the current regional parameter details.
+    parameter = client.get_parameter(name=name)
+
+    # Set the kms key field of the regional parameter.
+    parameter.kms_key = None
+
+    # Define the update mask for the kms_key field.
+    update_mask = field_mask_pb2.FieldMask(paths=["kms_key"])
+
+    # Define the request to update the parameter.
+    request = parametermanager_v1.UpdateParameterRequest(
+        parameter=parameter, update_mask=update_mask
+    )
+
+    # Call the API to update (kms_key) the parameter.
+    response = client.update_parameter(request=request)
+
+    # Print the parameter ID that was updated.
+    print(f"Removed kms key for regional parameter {parameter_id}")
+    # [END parametermanager_remove_regional_param_kms_key]
+
+    return response