シークレット バージョンにエイリアスを割り当てることで、アクセスを容易にできます。エイリアスが割り当てられると、バージョン番号からシークレット バージョンにアクセスするのと同じように、エイリアスを使用してシークレット バージョンにアクセスできます。
必要なロール
シークレット バージョンにアリアスを割り当てる権限を取得するには、シークレット、プロジェクト、フォルダ、または組織に対する Secret Manager 管理者 (roles/secretmanager.admin
)の IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
シークレット バージョンにエイリアスを割り当てる
シークレット バージョンにエイリアスを割り当てるには、次のいずれかの方法を使用します。
Console
-
Google Cloud コンソールの [Secret Manager] ページに移動します。
-
[Secret Manager] ページで、[リージョン シークレット] タブをクリックします。
-
シークレットを編集するには、次のいずれかの方法を使用します。
-
編集するシークレットの [
アクション] をクリックし、[編集] をクリックします。 -
シークレット名をクリックして、シークレットの詳細ページに移動します。シークレットの詳細ページで、[
シークレットを編集する] をクリックします。
-
-
[シークレットを編集] ページで [バージョン エイリアス] に移動し、[エイリアスを追加] をクリックします。
-
手順は次のとおりです。
-
[エイリアス名] を指定します。
-
このエイリアスを割り当てるシークレット バージョンを選択します。
-
-
[シークレットを更新する] をクリックします。
gcloud
後述のコマンドデータを使用する前に、次のように置き換えます。
- SECRET_ID: Secret の ID または Secret の完全修飾識別子。
- LOCATION: シークレットの Google Cloud ロケーション
- KEY: バージョン エイリアス
- VALUE: シークレットのバージョン番号
次のコマンドを実行します。
Linux、macOS、Cloud Shell
gcloud secrets update SECRET_ID --location=LOCATION \ --update-version-aliases=KEY=VALUE
Windows(PowerShell)
gcloud secrets update SECRET_ID --location=LOCATION ` --update-version-aliases=KEY=VALUE
Windows(cmd.exe)
gcloud secrets update SECRET_ID --location=LOCATION ^ --update-version-aliases=KEY=VALUE
レスポンスには、更新されたシークレットが含まれます。
REST
リクエストのデータを使用する前に、次のように置き換えます。
- LOCATION: シークレットの Google Cloud ロケーション
- PROJECT_ID: Google Cloud プロジェクト ID
- SECRET_ID: Secret の ID または Secret の完全修飾識別子
- KEY: バージョン エイリアス
- VALUE: シークレットのバージョン番号
HTTP メソッドと URL:
PATCH https://secretmanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/secrets/SECRET_ID?updateMask=version_aliases
リクエストの本文(JSON):
{'version-aliases': {'KEY': 'VALUE'}}
リクエストを送信するには、次のいずれかのオプションを選択します。
curl
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://secretmanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/secrets/SECRET_ID?updateMask=version_aliases"
PowerShell
リクエスト本文を request.json
という名前のファイルに保存して、次のコマンドを実行します。
$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }
Invoke-WebRequest `
-Method PATCH `
-Headers $headers `
-ContentType: "application/json; charset=utf-8" `
-InFile request.json `
-Uri "https://secretmanager.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/secrets/SECRET_ID?updateMask=version_aliases" | Select-Object -Expand Content
次のような JSON レスポンスが返されます。
{ "name": "projects/PROJECT_ID/locations/LOCATION/secrets/SECRET_ID", "createTime": "2024-09-04T06:34:32.995517Z", "etag": "\"16214584d1479c\"", "versionAliases": { "nonprod": "1" } }
Go
このコードを実行するには、まず Go 開発環境を設定し、Secret Manager Go SDK をインストールします。 Compute Engine または GKE では、cloud-platform スコープを使用して認証する必要があります。
Java
このコードを実行するには、まず Java 開発環境を設定し、Secret Manager Java SDK をインストールします。 Compute Engine または GKE では、cloud-platform スコープを使用して認証する必要があります。
Node.js
このコードを実行するには、まず Node.js 開発環境を設定し、Secret Manager Node.js SDK をインストールします。 Compute Engine または GKE では、cloud-platform スコープを使用して認証する必要があります。
次のステップ
- リージョン シークレットのバージョンを一覧表示し、バージョンの詳細を表示する方法を学習する。
- シークレット バージョンの追加とアクセス時にデータの整合性を確保する方法を学習する。