imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00
Code Activity

gcloud: Thu Mar 26 12:11:21 UTC 2026

Browse source
This commit is contained in:
Automated 2026-03-26 12:11:21 +00:00
parent c0febd2be1
commit 89a3bc9276
1093 changed files with 69108 additions and 2686 deletions
Download patch file Download diff file Expand all files Collapse all files

523
gcloud/apihub/deployments/create Normal file
View file

@ -0,0 +1,523 @@
NAME
gcloud apihub deployments create - create a Deployment
SYNOPSIS
gcloud apihub deployments create (DEPLOYMENT : --location=LOCATION)
--display-name=DISPLAY_NAME --endpoints=[ENDPOINTS,...]
--resource-uri=RESOURCE_URI
(--deployment-type-enum-values=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
| --deployment-type-json-values=[DEPLOYMENT_TYPE_JSON_VALUES,...]
| --deployment-type-string-values=[DEPLOYMENT_TYPE_STRING_VALUES,...]
| --deployment-type-uri-values=[DEPLOYMENT_TYPE_URI_VALUES,...])
[--attributes=[ATTRIBUTES,...]] [--description=DESCRIPTION]
[--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI]
[--source-environment=SOURCE_ENVIRONMENT]
[--source-project=SOURCE_PROJECT]
[--environment-enum-values=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
| --environment-json-values=[ENVIRONMENT_JSON_VALUES,...]
| --environment-string-values=[ENVIRONMENT_STRING_VALUES,...]
| --environment-uri-values=[ENVIRONMENT_URI_VALUES,...]]
[--management-url-enum-values=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
| --management-url-json-values=[MANAGEMENT_URL_JSON_VALUES,...]
| --management-url-string-values=[MANAGEMENT_URL_STRING_VALUES,...]
| --management-url-uri-values=[MANAGEMENT_URL_URI_VALUES,...]]
[--slo-enum-values=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
| --slo-json-values=[SLO_JSON_VALUES,...]
| --slo-string-values=[SLO_STRING_VALUES,...]
| --slo-uri-values=[SLO_URI_VALUES,...]]
[--source-uri-enum-values=[description=DESCRIPTION],
[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
| --source-uri-json-values=[SOURCE_URI_JSON_VALUES,...]
| --source-uri-string-values=[SOURCE_URI_STRING_VALUES,...]
| --source-uri-values=[SOURCE_URI_VALUES,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a deployment
EXAMPLES
To create a deployment with the ID my-deployment, run:
$ gcloud apihub deployments create --deployment=my-deployment \
--display-name="My Deployment" --deployment-type=apigee \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Deployment resource - Identifier. The name of the deployment.
Format: projects/{project}/locations/{location}/deployments/{deployment}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument deployment on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
DEPLOYMENT
ID of the deployment or fully qualified identifier for the
deployment.
To set the deployment attribute:
▸ provide the argument deployment on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the deployment resource.
To set the location attribute:
▸ provide the argument deployment on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--display-name=DISPLAY_NAME
The display name of the deployment.
--endpoints=[ENDPOINTS,...]
The endpoints at which this deployment resource is listening for API
requests. This could be a list of complete URIs, hostnames or an IP
addresses.
--resource-uri=RESOURCE_URI
The resource URI identifies the deployment within its gateway. For
Apigee gateways, its recommended to use the format:
organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy
with name orders is deployed in staging environment of cymbal
organization, the resource URI would be:
organizations/cymbal/environments/staging/apis/orders.
The attribute values associated with resource.
This must be specified.
Arguments for the Value.
At most one of these can be specified:
The attribute values of data type enum.
--deployment-type-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
Required, The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
◇ If provided, the same will be used. The service will throw
an error if the specified id is already used by another
allowed value in the same attribute resource.
◇ If not provided, a system generated id derived from the
display name will be used. In this case, the service will
handle conflict resolution by adding a system generated
suffix in case of duplicates.
This value should be 4-63 characters, and valid characters are
/[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated or
deleted by the user. It can only be true for System defined
attributes.
Shorthand Example:
--deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean --deployment-type-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:
--deployment-type-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:
--deployment-type-enum-values=path_to_file.(yaml|json)
The attribute values of data type string or JSON.
--deployment-type-json-values=[DEPLOYMENT_TYPE_JSON_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--deployment-type-string-values=[DEPLOYMENT_TYPE_STRING_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--deployment-type-uri-values=[DEPLOYMENT_TYPE_URI_VALUES,...]
The attribute values in case attribute data type is string or JSON.
OPTIONAL FLAGS
--attributes=[ATTRIBUTES,...]
The list of user defined attributes associated with the deployment
resource. The key is the attribute name. It will be of the format:
projects/{project}/locations/{location}/attributes/{attribute}. The
value is the attribute values associated with the resource.
KEY
Sets KEY value.
VALUE
Sets VALUE value.
enumValues
The attribute values associated with a resource in case
attribute data type is enum.
values
The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▹ If provided, the same will be used. The service
will throw an error if the specified id is already
used by another allowed value in the same attribute
resource.
▹ If not provided, a system generated id derived from
the display name will be used. In this case, the
service will handle conflict resolution by adding a
system generated suffix in case of duplicates.
This value should be 4-63 characters, and valid
characters are /[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated
or deleted by the user. It can only be true for System
defined attributes.
jsonValues
The attribute values associated with a resource in case
attribute data type is JSON.
values
The attribute values in case attribute data type is string
or JSON.
stringValues
The attribute values associated with a resource in case
attribute data type is string.
values
The attribute values in case attribute data type is string
or JSON.
uriValues
The attribute values associated with a resource in case
attribute data type is URL, URI or IP, like
gs://bucket-name/object-name.
values
The attribute values in case attribute data type is string
or JSON.
Shorthand Example:
--attributes=string={enumValues={values=[{description=string,displayName=string,id=string,immutable=boolean}]},jsonValues={values=[string]},stringValues={values=[string]},uriValues={values=[string]}}
JSON Example:
--attributes='{"string": {"enumValues": {"values": [{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]}, "jsonValues": {"values": ["string"]}, "stringValues": {"values": ["string"]}, "uriValues": {"values": ["string"]}}}'
File Example:
--attributes=path_to_file.(yaml|json)
--description=DESCRIPTION
The description of the deployment.
Documentation details.
--documentation-external-uri=DOCUMENTATION_EXTERNAL_URI
The uri of the externally hosted documentation.
--source-environment=SOURCE_ENVIRONMENT
The environment at source for the deployment. For example: prod, dev,
staging, etc.
--source-project=SOURCE_PROJECT
The project to which the deployment belongs. For Google Cloud gateways,
this will refer to the project identifier. For others like Edge/OPDK,
this will refer to the org identifier.
The attribute values associated with resource.
Arguments for the Value.
At most one of these can be specified:
The attribute values of data type enum.
--environment-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
Required, The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▫ If provided, the same will be used. The service will throw an
error if the specified id is already used by another allowed
value in the same attribute resource.
▫ If not provided, a system generated id derived from the
display name will be used. In this case, the service will
handle conflict resolution by adding a system generated suffix
in case of duplicates.
This value should be 4-63 characters, and valid characters are
/[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated or deleted
by the user. It can only be true for System defined attributes.
Shorthand Example:
--environment-enum-values=description=string,displayName=string,id=string,immutable=boolean --environment-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:
--environment-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:
--environment-enum-values=path_to_file.(yaml|json)
The attribute values of data type string or JSON.
--environment-json-values=[ENVIRONMENT_JSON_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--environment-string-values=[ENVIRONMENT_STRING_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--environment-uri-values=[ENVIRONMENT_URI_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values associated with resource.
Arguments for the Value.
At most one of these can be specified:
The attribute values of data type enum.
--management-url-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
Required, The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▫ If provided, the same will be used. The service will throw an
error if the specified id is already used by another allowed
value in the same attribute resource.
▫ If not provided, a system generated id derived from the
display name will be used. In this case, the service will
handle conflict resolution by adding a system generated suffix
in case of duplicates.
This value should be 4-63 characters, and valid characters are
/[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated or deleted
by the user. It can only be true for System defined attributes.
Shorthand Example:
--management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean --management-url-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:
--management-url-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:
--management-url-enum-values=path_to_file.(yaml|json)
The attribute values of data type string or JSON.
--management-url-json-values=[MANAGEMENT_URL_JSON_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--management-url-string-values=[MANAGEMENT_URL_STRING_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--management-url-uri-values=[MANAGEMENT_URL_URI_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values associated with resource.
Arguments for the Value.
At most one of these can be specified:
The attribute values of data type enum.
--slo-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
Required, The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▫ If provided, the same will be used. The service will throw an
error if the specified id is already used by another allowed
value in the same attribute resource.
▫ If not provided, a system generated id derived from the
display name will be used. In this case, the service will
handle conflict resolution by adding a system generated suffix
in case of duplicates.
This value should be 4-63 characters, and valid characters are
/[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated or deleted
by the user. It can only be true for System defined attributes.
Shorthand Example:
--slo-enum-values=description=string,displayName=string,id=string,immutable=boolean --slo-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:
--slo-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:
--slo-enum-values=path_to_file.(yaml|json)
The attribute values of data type string or JSON.
--slo-json-values=[SLO_JSON_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--slo-string-values=[SLO_STRING_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--slo-uri-values=[SLO_URI_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values associated with resource.
Arguments for the Value.
At most one of these can be specified:
The attribute values of data type enum.
--source-uri-enum-values=[description=DESCRIPTION],[displayName=DISPLAYNAME],[id=ID],[immutable=IMMUTABLE]
Required, The attribute values in case attribute data type is enum.
description
The detailed description of the allowed value.
displayName
The display name of the allowed value.
id
The ID of the allowed value.
▫ If provided, the same will be used. The service will throw an
error if the specified id is already used by another allowed
value in the same attribute resource.
▫ If not provided, a system generated id derived from the
display name will be used. In this case, the service will
handle conflict resolution by adding a system generated suffix
in case of duplicates.
This value should be 4-63 characters, and valid characters are
/[a-z][0-9]-/.
immutable
When set to true, the allowed value cannot be updated or deleted
by the user. It can only be true for System defined attributes.
Shorthand Example:
--source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean --source-uri-enum-values=description=string,displayName=string,id=string,immutable=boolean
JSON Example:
--source-uri-enum-values='[{"description": "string", "displayName": "string", "id": "string", "immutable": boolean}]'
File Example:
--source-uri-enum-values=path_to_file.(yaml|json)
The attribute values of data type string or JSON.
--source-uri-json-values=[SOURCE_URI_JSON_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--source-uri-string-values=[SOURCE_URI_STRING_VALUES,...]
The attribute values in case attribute data type is string or JSON.
The attribute values of data type string or JSON.
--source-uri-values=[SOURCE_URI_VALUES,...]
The attribute values in case attribute data type is string or 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 help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub deployments create

67
gcloud/apihub/deployments/delete Normal file
View file

@ -0,0 +1,67 @@
NAME
gcloud apihub deployments delete - delete a Deployment
SYNOPSIS
gcloud apihub deployments delete (DEPLOYMENT : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a deployment
EXAMPLES
To delete a deployment with the ID my-deployment, run:
$ gcloud apihub deployments delete my-deployment \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Deployment resource - The name of the deployment resource to delete.
Format: projects/{project}/locations/{location}/deployments/{deployment}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument deployment on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
DEPLOYMENT
ID of the deployment or fully qualified identifier for the
deployment.
To set the deployment attribute:
▸ provide the argument deployment on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the deployment resource.
To set the location attribute:
▸ provide the argument deployment on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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 help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub deployments delete

67
gcloud/apihub/deployments/describe Normal file
View file

@ -0,0 +1,67 @@
NAME
gcloud apihub deployments describe - describe a Deployment
SYNOPSIS
gcloud apihub deployments describe (DEPLOYMENT : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Describe a deployment
EXAMPLES
To describe a deployment with the ID my-deployment, run:
$ gcloud apihub deployments describe my-deployment \
--project=my-project --location=us-central1
POSITIONAL ARGUMENTS
Deployment resource - The name of the deployment resource to retrieve.
Format: projects/{project}/locations/{location}/deployments/{deployment}
The arguments in this group can be used to specify the attributes of this
resource. (NOTE) Some attributes are not given arguments in this group but
can be set in other ways.
To set the project attribute:
◆ provide the argument deployment on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
DEPLOYMENT
ID of the deployment or fully qualified identifier for the
deployment.
To set the deployment attribute:
▸ provide the argument deployment on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
The location id of the deployment resource.
To set the location attribute:
▸ provide the argument deployment on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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 help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub deployments describe

37
gcloud/apihub/deployments/help Normal file
View file

@ -0,0 +1,37 @@
NAME
gcloud apihub deployments - manage Deployment resources
SYNOPSIS
gcloud apihub deployments COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Manage Deployment resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a Deployment.
delete
Delete a Deployment.
describe
Describe a Deployment.
list
List Deployments.
update
Update deployments.
NOTES
This variant is also available:
$ gcloud alpha apihub deployments

88
gcloud/apihub/deployments/list Normal file
View file

@ -0,0 +1,88 @@
NAME
gcloud apihub deployments list - list Deployments
SYNOPSIS
gcloud apihub deployments list --location=LOCATION [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List deployments
EXAMPLES
To list all deployments in project my-project and location us-central1,
run:
$ gcloud apihub deployments list --project=my-project \
--location=us-central1
REQUIRED FLAGS
Location resource - The parent, which owns this collection of deployment
resources. Format: projects/{project}/locations/{location} 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 project attribute:
◆ provide the argument --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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 help for details.
API REFERENCE
This command uses the apihub/v1 API. The full documentation for this API
can be found at:
https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub
NOTES
This variant is also available:
$ gcloud alpha apihub deployments list

1148
gcloud/apihub/deployments/update Normal file
View file

File diff suppressed because it is too large Load diff