This page explains how to delete a Game Servers deployment.
Before you begin
Before you start, we recommend you familiarize yourself with key concepts in the Game Servers Overview. Make sure you have also performed the following tasks:
- Ensure that you have enabled the Game Services API. Enable Game Services API
- Either choose a shell with gcloud CLI installed, or use an API client:
Go to Google Cloud console.
From the upper-right corner of the console, click the Activate Cloud Shell button:
- Create a service account.
- Download a private key as a JSON file.
-
Set the environment variable
GOOGLE_APPLICATION_CREDENTIALS
to the path of the JSON file that contains your service account key. This variable only applies to your current shell session, so if you open a new session, set the variable again.
Cloud Shell
To launch Cloud Shell, perform the following steps:
A Cloud Shell session opens inside a frame lower on the console.
You use this shell to run gcloud
commands.
Local shell
Install the gcloud CLI.
Verify that you have set desired default project for Google Cloud CLI (otherwise you need to specify flag --project
explicitly for each command later):
gcloud config list project
If not you can run the following command to set a default project, replacing PROJECT_ID
with your desired project ID :
gcloud config set project PROJECT_ID
Run the following command to verify your version of the Google Cloud CLI.
Game Servers requires version 306.0.0
or higher of the gcloud CLI.
gcloud version
To update your installation, run the following command:
gcloud components update
curl / PowerShell
To use the REST API with curl
or Windows PowerShell, do the
following:
Client Library
Google Cloud Game Servers can be controlled programmatically using a client library. See Client Libraries Overview for instructions on using the library and authenticating.
Deleting a deployment
Before you delete a Game Servers deployment, make sure you delete all configs under the deployment.
Console
In the Google Cloud console, go to the Game Server Deployments page.
You can use the filter box to filter the deployments list by different properties.
In the last table column, click the ellipses more_vert and select Remove deployment.
gcloud
You can delete a deployment using the Google Cloud CLI.
To delete a deployment, run the following command and replace deploymentID with the identifier for a deployment you have previously created:
gcloud game servers deployments delete deploymentID
REST & CMD LINE
Before using any of the request data, make the following replacements:
- PROJECT_ID: your Google Cloud project ID listed in the IAM Settings
- DEPLOYMENT_ID: the user-defined identifier for the deployment
To send your request, expand one of these options:
You should receive a JSON response similar to the following:
{ "name": "projects/PROJECT_ID/locations/global/operations/OPERATION_ID", "metadata": { "@type": "type.googleapis.com/google.cloud.gaming.v1.OperationMetadata", "createTime": CREATE_TIME, "target": "projects/PROJECT_ID/locations/global/gameServerDeployments/DEPLOYMENT_ID", "verb": "delete", "requestedCancellation": false, "apiVersion": "v1" }, "done": false }
C#
To learn how to install and use the client library for Game Servers, see Game Servers client libraries.
Go
To learn how to install and use the client library for Game Servers, see Game Servers client libraries.
Java
To learn how to install and use the client library for Game Servers, see Game Servers client libraries.
Node.js
To learn how to install and use the client library for Game Servers, see Game Servers client libraries.
Python
To learn how to install and use the client library for Game Servers, see Game Servers client libraries.
Verifying that your deployment has been deleted
To verify that you successfully deleted the deployment, list your deployments using the Google Cloud CLI.
To list all deployments, run the following command:
gcloud game servers deployments list
Your deleted deployment no longer appears in the output of the command.
What's next
Learn how to Game Servers audit logging information.