このページでは、一般的なセキュア ゲートウェイ管理タスクを行う方法について説明します。
シェル環境の設定
作業シェルで次の環境変数を定義して、設定プロセスを合理化し、セキュア ゲートウェイ API と通信できるようにします。
一般的なパラメータ
API="beyondcorp.googleapis.com" API_VERSION=v1 PROJECT_ID=MY_PROJECT_ID APPLICATION_ID=MY_APPLICATION_ID APPLICATION_DISPLAY_NAME="MY_APPLICATION_DISPLAY_NAME" HOST_NAME=MY_HOST_NAME
次のように置き換えます。
- MY_PROJECT_ID: セキュア ゲートウェイが作成されるプロジェクトの ID。
- MY_APPLICATION_ID: アプリケーションの ID。例:
github
名前は最大 63 文字で、小文字、数字、ハイフンを使用できます。最初の文字は英字にし、最後の文字は英字または数字にしてください。 - MY_APPLICATION_DISPLAY_NAME: 表示する人が読める形式の名前。
MY_HOST_NAME: アプリケーションのホスト名。例:
github.com
ホスト名は最大 253 文字で、次のいずれかの形式に準拠する必要があります。- 有効な IPv4 アドレス
- 有効な IPv6 アドレス
- 有効な DNS 名
- アスタリスク(*)
- アスタリスク(*)の後に有効な DNS 名
セキュア ゲートウェイのパラメータ
SECURITY_GATEWAY_ID=MY_SECURITY_GATEWAY_ID SECURITY_GATEWAY_DISPLAY_NAME="MY_SECURITY_GATEWAY_DISPLAY_NAME"
次のように置き換えます。
- MY_SECURITY_GATEWAY_ID: セキュア ゲートウェイの ID。ID は最大 63 文字で、小文字、数字、ハイフンを使用できます。最初の文字は英字に、最後の文字は英字または数字にしてください。
- MY_SECURITY_GATEWAY_DISPLAY_NAME: セキュア ゲートウェイの人が読める形式の名前。名前は最大 63 文字で、印刷可能な文字を含めることができます。
セキュア ゲートウェイを更新する
次の例は、既存のセキュア ゲートウェイのハブを更新する方法を示しています。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -X PATCH \ -d "{ \"hubs\": {\"us-central1\": {}, \"us-east1\": {}} }" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}?update_mask=hubs"
セキュア ゲートウェイの詳細を取得する
セキュア ゲートウェイの詳細を取得するには、次のコマンドを実行します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}"
セキュア ゲートウェイを一覧表示する
プロジェクト内のすべてのセキュア ゲートウェイを一覧表示するには、次のコマンドを実行します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways"
セキュア ゲートウェイを削除する
セキュア ゲートウェイを削除するには、次のコマンドを実行します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -X DELETE \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}"
アプリケーション リソースを更新する
既存のアプリケーションを更新するには、Update
API を呼び出します。編集可能なフィールドは次のとおりです。
display_name
endpoint_matchers
更新するフィールドを制御するには、update_mask
を使用します。次の例では、endpoint_matchers
を更新します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -X PATCH \ -d "{ \"endpoint_matchers\": [{hostname: \"${HOST_NAME}\"}] }" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications/${APPLICATION_ID}?update_mask=endpoint_matchers"
アプリケーション リソースの詳細を取得する
アプリケーションの作成または更新が完了した後に、アプリケーション リソースの詳細情報を取得するには、Get
API を呼び出します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications/${APPLICATION_ID}"
アプリケーション リソースを一覧表示する
セキュア ゲートウェイでアクセスを制御するすべてのアプリケーション リソースを一覧表示するには、List
API を呼び出します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications"
アプリケーション リソースを削除する
アプリケーション リソースを削除するには、Delete
API を呼び出します。
curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -X DELETE \ "https://${API}/${API_VERSION}/projects/${PROJECT_ID}/locations/global/securityGateways/${SECURITY_GATEWAY_ID}/applications/${APPLICATION_ID}"