- NAME
-
- gcloud beta workspace-key-access endpoints create - create a Workspace Key Access endpoint
- SYNOPSIS
-
-
gcloud beta workspace-key-access endpoints createENDPOINT--config=CONFIG--kms-key=KMS_KEY[--annotations=[ANNOTATIONS,…]] [--async] [--labels=[LABELS,…]] [--location=LOCATION] [--request-id=REQUEST_ID] [--tags=[TAGS,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)Create a Workspace Key Access endpoint in a given project and location. - EXAMPLES
-
To create endpoint
my-endpointinus-east1, attached to configmy-configand Cloud KMS keymy-key, run:gcloud beta workspace-key-access endpoints create my-endpoint --location=us-east1 --config=my-config --kms-key=projects/my-project/locations/us-east1/keyRings/my-ring/cryptoKeys/my-key - POSITIONAL ARGUMENTS
-
-
Endpoint resource - Identifier. name of resource This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
To set the
projectattribute:-
provide the argument
endpointon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
endpointon the command line with a fully specified name; -
provide the argument
--locationon the command line.
This must be specified.
ENDPOINT-
ID of the endpoint or fully qualified identifier for the endpoint.
To set the
endpointattribute:-
provide the argument
endpointon the command line.
-
provide the argument
-
provide the argument
-
Endpoint resource - Identifier. name of resource This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
- REQUIRED FLAGS
-
-
Config resource - Config attached to the endpoint. The Workspace Key Access
config attached to this endpoint. Format:
projects/{project}/locations/{location}/configs/{config} This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
To set the
projectattribute:-
provide the argument
--configon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
To set the
locationattribute:-
provide the argument
--configon the command line with a fully specified name; -
provide the argument
--locationon the command line.
This must be specified.
--config=CONFIG-
ID of the config or fully qualified identifier for the config.
To set the
configattribute:-
provide the argument
--configon the command line.
-
provide the argument
-
provide the argument
--kms-key=KMS_KEY-
The Cloud KMS CryptoKey resource name. Format:
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
-
Config resource - Config attached to the endpoint. The Workspace Key Access
config attached to this endpoint. Format:
projects/{project}/locations/{location}/configs/{config} This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.
- OPTIONAL FLAGS
-
--annotations=[ANNOTATIONS,…]-
Annotations as key value pairs.
KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
Shorthand Example:--annotations=string=string
JSON Example:--annotations='{"string": "string"}'
File Example:--annotations=path_to_file.(yaml|json)
--async- Return immediately, without waiting for the operation in progress to complete.
--labels=[LABELS,…]-
Labels as key value pairs.
KEY-
Keys must start with a lowercase character and contain only hyphens
(
-), underscores (_), lowercase characters, and numbers. VALUE-
Values must contain only hyphens (
-), underscores (_), lowercase characters, and numbers.
Shorthand Example:--labels=string=string
JSON Example:--labels='{"string": "string"}'
File Example:--labels=path_to_file.(yaml|json)
--location=LOCATION- For resources [endpoint, config], provides fallback value for resource location attribute. When the resource's full URI path is not provided, location will fallback to this flag value.
--request-id=REQUEST_ID-
An optional request ID to identify requests. Specify a unique request ID so that
if you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request.
For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
-
Tag bindings as key value pairs.
KEY-
Sets
KEYvalue. VALUE-
Sets
VALUEvalue.
Shorthand Example:--tags=string=string
JSON Example:--tags='{"string": "string"}'
File Example:--tags=path_to_file.(yaml|json)
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - API REFERENCE
-
This command uses the
workspacekeyaccess/v1betaAPI. The full documentation for this API can be found at: https://docs.cloud.google.com/kms/docs/hsm-for-workspace - NOTES
- This command is currently in beta and might change without notice.
gcloud beta workspace-key-access endpoints create
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-10-27 UTC.
[null,null,["Last updated 2026-10-27 UTC."],[],[]]