1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00

gcloud: Wed Mar 29 10:40:15 UTC 2023

This commit is contained in:
Automated 2023-03-29 10:40:15 +00:00
parent 4ccfc7a5e3
commit 5fabf24be7
269 changed files with 6797 additions and 464 deletions

View file

@ -0,0 +1,72 @@
NAME
gcloud recaptcha firewall-policies create - create a Firewall Policy
SYNOPSIS
gcloud recaptcha firewall-policies create [--actions=ACTIONS]
[--condition=CONDITION] [--description=DESCRIPTION] [--path=PATH]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a reCAPTCHA Firewall Policy.
EXAMPLES
To create a new reCAPTCHA firewall policy covering the path "/login/" for
all requests with a reCAPTCHA Lite score of >= 0.5 to allow the requests
and set the header 'foo' to the value 'bar':
$ gcloud recaptcha firewall-policies create --path='/login/*' \
--condition='recaptcha.assessment_type == AssessmentType.LITE
&& recaptcha.score >= 0.5' --actions=allow,set_header=foo=bar
FLAGS
--actions=ACTIONS
The actions that the caller should take regarding the user. There
should be at most 1 terminal action. A terminal action is any action
that forces a response, such as Allow, Block or Substitute. If it makes
sense for it to happen multple times, such as SetHeader, the action is
non-terminal.
Examples:
◆ Block and set the header with key foo to value bar
▸ --actions=block,set_header=foo=bar
◆ Substitute with path google.com and set two headers, one with key
key1 to value value1 and one with key key2 to value value2
▸ --actions=substitute=google.com,set_header=key1=value1,set_header=key2=value2
--condition=CONDITION
A CEL (Common Expression Language) conditional expression that
specifies if this policy applies to an incoming user request. If this
condition evaluates to true and the requested path matched the path
pattern, the associated actions should be executed by the caller. The
condition string is checked for CEL syntax correctness on creation. For
more information, see the CEL spec: https://github.com/google/cel-spec
and its language definition:
https://github.com/google/cel-spec/blob/master/doc/langdef.md
--description=DESCRIPTION
A description of what this policy aims to achieve, for convenience
purposes. The description can at most include 256 UTF-8 characters.
--path=PATH
The path for which this policy applies, specified as a glob pattern.
For more information on glob, see the manual page:
https://man7.org/linux/man-pages/man7/glob.7.html.
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 recaptchaenterprise/v1 API. The full documentation
for this API can be found at:
https://cloud.google.com/recaptcha-enterprise/
NOTES
This variant is also available:
$ gcloud alpha recaptcha firewall-policies create

View file

@ -0,0 +1,51 @@
NAME
gcloud recaptcha firewall-policies delete - delete one or more reCAPTCHA
Firewall Policies
SYNOPSIS
gcloud recaptcha firewall-policies delete FIREWALL_POLICY
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete one or more reCAPTCHA Firewall Policies from a given cloud project.
EXAMPLES
To delete a reCAPTCHA firewall policies, run:
$ gcloud recaptcha firewall-policies delete policy-id
POSITIONAL ARGUMENTS
Firewall policy resource - The reCAPTCHA firewall policy to delete. 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 firewall_policy on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
FIREWALL_POLICY
ID of the firewall_policy or fully qualified identifier for the
firewall_policy. To set the firewall_policy attribute:
▸ provide the argument firewall_policy 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 recaptchaenterprise/v1 API. The full documentation
for this API can be found at:
https://cloud.google.com/recaptcha-enterprise/
NOTES
This variant is also available:
$ gcloud alpha recaptcha firewall-policies delete

View file

@ -0,0 +1,51 @@
NAME
gcloud recaptcha firewall-policies describe - describe reCAPTCHA Firewall
Policy
SYNOPSIS
gcloud recaptcha firewall-policies describe FIREWALL_POLICY
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get the details of a reCAPTCHA Firewall Policy.
EXAMPLES
To get details on a reCAPTCHA firewall policy, run:
$ gcloud recaptcha firewall-policies describe policy-id
POSITIONAL ARGUMENTS
Firewall policy resource - The reCAPTCHA firewall policy to describe. 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 firewall_policy on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
FIREWALL_POLICY
ID of the firewall_policy or fully qualified identifier for the
firewall_policy. To set the firewall_policy attribute:
▸ provide the argument firewall_policy 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 recaptchaenterprise/v1 API. The full documentation
for this API can be found at:
https://cloud.google.com/recaptcha-enterprise/
NOTES
This variant is also available:
$ gcloud alpha recaptcha firewall-policies describe

View file

@ -0,0 +1,37 @@
NAME
gcloud recaptcha firewall-policies - managed reCAPTCHA Firewall Policies
SYNOPSIS
gcloud recaptcha firewall-policies COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Managed reCAPTCHA Firewall Policies.
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 Firewall Policy.
delete
Delete one or more reCAPTCHA Firewall Policies.
describe
Describe reCAPTCHA Firewall Policy.
list
List reCAPTCHA Firewall Policies.
update
Update a Firewall Policy.
NOTES
This variant is also available:
$ gcloud alpha recaptcha firewall-policies

View file

@ -0,0 +1,66 @@
NAME
gcloud recaptcha firewall-policies list - list reCAPTCHA Firewall Policies
SYNOPSIS
gcloud recaptcha firewall-policies list [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List all of the reCAPTCHA Firewall Policies that exist in a given project.
EXAMPLES
To list all the reCAPTCHA firewall policies existing for your project, run:
$ gcloud recaptcha firewall-policies list
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 recaptchaenterprise/v1 API. The full documentation
for this API can be found at:
https://cloud.google.com/recaptcha-enterprise/
NOTES
This variant is also available:
$ gcloud alpha recaptcha firewall-policies list

View file

@ -0,0 +1,86 @@
NAME
gcloud recaptcha firewall-policies update - update a Firewall Policy
SYNOPSIS
gcloud recaptcha firewall-policies update FIREWALL_POLICY
[--actions=ACTIONS] [--condition=CONDITION] [--description=DESCRIPTION]
[--path=PATH] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update a reCAPTCHA Firewall Policy.
EXAMPLES
To update the information of a reCAPTCHA firewall policy, run:
$ gcloud recaptcha firewall-policies update policy-id \
--description='updated description' --actions=block
POSITIONAL ARGUMENTS
Firewall policy resource - The reCAPTCHA firewall policy to update. 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 firewall_policy on the command line with a fully
specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
FIREWALL_POLICY
ID of the firewall_policy or fully qualified identifier for the
firewall_policy. To set the firewall_policy attribute:
▸ provide the argument firewall_policy on the command line.
FLAGS
--actions=ACTIONS
The actions that the caller should take regarding the user. There
should be at most 1 terminal action. A terminal action is any action
that forces a response, such as Allow, Block or Substitute. If it makes
sense for it to happen multple times, such as SetHeader, the action is
non-terminal.
Examples:
◆ Block and set the header with key foo to value bar
▸ --actions=block,set_header=foo=bar
◆ Substitute with path google.com and set two headers, one with key
key1 to value value1 and one with key key2 to value value2
▸ --actions=substitute=google.com,set_header=key1=value1,set_header=key2=value2
--condition=CONDITION
A CEL (Common Expression Language) conditional expression that
specifies if this policy applies to an incoming user request. If this
condition evaluates to true and the requested path matched the path
pattern, the associated actions should be executed by the caller. The
condition string is checked for CEL syntax correctness on creation. For
more information, see the CEL spec: https://github.com/google/cel-spec
and its language definition:
https://github.com/google/cel-spec/blob/master/doc/langdef.md
--description=DESCRIPTION
A description of what this policy aims to achieve, for convenience
purposes. The description can at most include 256 UTF-8 characters.
--path=PATH
The path for which this policy applies, specified as a glob pattern.
For more information on glob, see the manual page:
https://man7.org/linux/man-pages/man7/glob.7.html.
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 recaptchaenterprise/v1 API. The full documentation
for this API can be found at:
https://cloud.google.com/recaptcha-enterprise/
NOTES
This variant is also available:
$ gcloud alpha recaptcha firewall-policies update

View file

@ -15,6 +15,9 @@ GCLOUD WIDE FLAGS
GROUPS
GROUP is one of the following:
firewall-policies
Managed reCAPTCHA Firewall Policies.
keys
Managed reCAPTCHA Keys.

View file

@ -3,8 +3,9 @@ NAME
SYNOPSIS
gcloud recaptcha keys create --display-name=DISPLAY_NAME
(--android (--allow-all-package-names
([--android (--allow-all-package-names
| --package-names=[PACKAGE_NAMES,...])
: --support-non-google-app-store-distribution]
| --ios (--allow-all-bundle-ids | --bundle-ids=[BUNDLE_IDS,...])
| [--web (--allow-all-domains | --domains=[DOMAINS,...])
: --allow-amp-traffic --integration-type=INTEGRATION_TYPE
@ -38,6 +39,14 @@ REQUIRED FLAGS
This flag argument must be specified if any of the other arguments
in this group are specified.
--support-non-google-app-store-distribution
If set, this key can be used in an Android application that is
available for download in app stores other than the Google Play
Store.
This setting allows your key to accept traffic from devices without
Google Mobile Services (GMS) installed.
Exactly one of these must be specified:
--allow-all-package-names