Skip to content

feat(secretmanager): Added samples for tags field #2140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion secretmanager/composer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"require": {
"google/cloud-secret-manager": "^2.0.0"
"google/cloud-secret-manager": "^2.1.0",
"google/cloud-resource-manager": "^1.0"
}
}
92 changes: 92 additions & 0 deletions secretmanager/src/bind_tags_to_regional_secret.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?php
/*
* 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
* limitations under the License.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_bind_tags_to_regional_secret]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\ResourceManager\V3\Client\TagBindingsClient;
use Google\Cloud\ResourceManager\V3\CreateTagBindingRequest;
use Google\Cloud\ResourceManager\V3\TagBinding;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $locationId Your Google Cloud Location ID (e.g. 'us-central1')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param string $tagValue Your tag value (e.g. 'tagValues/281476592621530')
*/
function bind_tags_to_regional_secret(string $projectId, string $locationId, string $secretId, string $tagValue): void
{
// Specify regional endpoint.
$options = ['apiEndpoint' => "secretmanager.$locationId.rep.googleapis.com"];

// Create the Secret Manager client.
$client = new SecretManagerServiceClient($options);

// Build the resource name of the parent project.
$parent = $client->locationName($projectId, $locationId);

$secret = new Secret();

// Build the request.
$request = CreateSecretRequest::build($parent, $secretId, $secret);

// Create the secret.
$newSecret = $client->createSecret($request);

// Print the new secret name.
printf('Created secret %s' . PHP_EOL, $newSecret->getName());

// Specify regional endpoint.
$tagBindOptions = ['apiEndpoint' => "$locationId-cloudresourcemanager.googleapis.com"];
$tagBindingsClient = new TagBindingsClient($tagBindOptions);
$tagBinding = (new TagBinding())
->setParent('//secretmanager.googleapis.com/' . $newSecret->getName())
->setTagValue($tagValue);

// Build the request.
$request = (new CreateTagBindingRequest())
->setTagBinding($tagBinding);

// Create the tag binding.
$operationResponse = $tagBindingsClient->createTagBinding($request);
$operationResponse->pollUntilComplete();

// Check if the operation succeeded.
if ($operationResponse->operationSucceeded()) {
printf('Tag binding created for secret %s with tag value %s' . PHP_EOL, $newSecret->getName(), $tagValue);
} else {
$error = $operationResponse->getError();
printf('Error in creating tag binding: %s' . PHP_EOL, $error->getMessage());
}
}
// [END secretmanager_bind_tags_to_regional_secret]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
92 changes: 92 additions & 0 deletions secretmanager/src/bind_tags_to_secret.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?php
/*
* 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
* limitations under the License.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_bind_tags_to_secret]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Replication;
use Google\Cloud\SecretManager\V1\Replication\Automatic;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;
use Google\Cloud\ResourceManager\V3\Client\TagBindingsClient;
use Google\Cloud\ResourceManager\V3\CreateTagBindingRequest;
use Google\Cloud\ResourceManager\V3\TagBinding;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param string $tagValue Your tag value (e.g. 'tagValues/281476592621530')
*/
function bind_tags_to_secret(string $projectId, string $secretId, string $tagValue): void
{
// Create the Secret Manager client.
$client = new SecretManagerServiceClient();

// Build the resource name of the parent project.
$parent = $client->projectName($projectId);

$secret = new Secret([
'replication' => new Replication([
'automatic' => new Automatic(),
]),
]);

// Build the request.
$request = CreateSecretRequest::build($parent, $secretId, $secret);

// Create the secret.
$newSecret = $client->createSecret($request);

// Print the new secret name.
printf('Created secret %s' . PHP_EOL, $newSecret->getName());

$tagBindingsClient = new TagBindingsClient();
$tagBinding = (new TagBinding())
->setParent('//secretmanager.googleapis.com/' . $newSecret->getName())
->setTagValue($tagValue);

// Build the binding request.
$request = (new CreateTagBindingRequest())
->setTagBinding($tagBinding);

// Create the tag binding.
$operationResponse = $tagBindingsClient->createTagBinding($request);
$operationResponse->pollUntilComplete();

// Check if the operation succeeded.
if ($operationResponse->operationSucceeded()) {
printf('Tag binding created for secret %s with tag value %s' . PHP_EOL, $newSecret->getName(), $tagValue);
} else {
$error = $operationResponse->getError();
printf('Error in creating tag binding: %s' . PHP_EOL, $error->getMessage());
}
}
// [END secretmanager_bind_tags_to_secret]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
71 changes: 71 additions & 0 deletions secretmanager/src/create_regional_secret_with_tags.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
<?php
/*
* 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
* limitations under the License.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_regional_create_secret_with_tags]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $locationId Your Google Cloud Location ID (e.g. 'us-central1')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param string $tagKey Your tag key (e.g. 'tagKeys/281475012216835')
* @param string $tagValue Your tag value (e.g. 'tagValues/281476592621530')
*/
function create_regional_secret_with_tags(string $projectId, string $locationId, string $secretId, string $tagKey, string $tagValue): void
{
// Specify regional endpoint.
$options = ['apiEndpoint' => "secretmanager.$locationId.rep.googleapis.com"];

// Create the Secret Manager client.
$client = new SecretManagerServiceClient($options);

// Build the resource name of the parent project.
$parent = $client->locationName($projectId, $locationId);

$secret = new Secret();

// set the tags.
$tags = [$tagKey => $tagValue];
$secret ->setTags($tags);

// Build the request.
$request = CreateSecretRequest::build($parent, $secretId, $secret);

// Create the secret.
$newSecret = $client->createSecret($request);

// Print the new secret name.
printf('Created secret %s with tag', $newSecret->getName());
}
// [END secretmanager_regional_create_secret_with_tags]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
73 changes: 73 additions & 0 deletions secretmanager/src/create_secret_with_tags.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php
/*
* 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
* limitations under the License.
*/

/*
* For instructions on how to run the full sample:
*
* @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/main/secretmanager/README.md
*/

declare(strict_types=1);

namespace Google\Cloud\Samples\SecretManager;

// [START secretmanager_create_secret_with_tags]
// Import the Secret Manager client library.
use Google\Cloud\SecretManager\V1\CreateSecretRequest;
use Google\Cloud\SecretManager\V1\Replication;
use Google\Cloud\SecretManager\V1\Replication\Automatic;
use Google\Cloud\SecretManager\V1\Secret;
use Google\Cloud\SecretManager\V1\Client\SecretManagerServiceClient;

/**
* @param string $projectId Your Google Cloud Project ID (e.g. 'my-project')
* @param string $secretId Your secret ID (e.g. 'my-secret')
* @param string $tagKey Your tag key (e.g. 'tagKeys/281475012216835')
* @param string $tagValue Your tag value (e.g. 'tagValues/281476592621530')
*/
function create_secret_with_tags(string $projectId, string $secretId, string $tagKey, string $tagValue): void
{
// Create the Secret Manager client.
$client = new SecretManagerServiceClient();

// Build the resource name of the parent project.
$parent = $client->projectName($projectId);

$secret = new Secret([
'replication' => new Replication([
'automatic' => new Automatic(),
]),
]);

// set the tags.
$tags = [$tagKey => $tagValue];
$secret->setTags($tags);

// Build the request.
$request = CreateSecretRequest::build($parent, $secretId, $secret);

// Create the secret.
$newSecret = $client->createSecret($request);

// Print the new secret name.
printf('Created secret %s with tag', $newSecret->getName());
}
// [END secretmanager_create_secret_with_tags]

// The following 2 lines are only needed to execute the samples on the CLI
require_once __DIR__ . '/../../testing/sample_helpers.php';
\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);
Loading