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

gcloud: Wed May 15 09:19:06 UTC 2024

This commit is contained in:
Automated 2024-05-15 09:19:06 +00:00
parent e8259d86b1
commit 3b84182be4
193 changed files with 10091 additions and 581 deletions

View file

@ -0,0 +1,135 @@
NAME
gcloud logging views add-iam-policy-binding - add IAM policy binding to a
log view
SYNOPSIS
gcloud logging views add-iam-policy-binding VIEW_ID --bucket=BUCKET
--location=LOCATION --member=PRINCIPAL --role=ROLE
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[--condition=[KEY=VALUE,...]
| --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Add IAM policy binding to a log view.
EXAMPLES
To add an IAM policy binding for the role 'roles/my-role' for the user
'my-user@gmail.com' on my-view, run:
$ gcloud logging views add-iam-policy-binding my-view \
--member='user:my-user@gmail.com' --role='roles/my-role' \
--bucket=my-bucket --location=global
To add a binding with a condition, run:
$ gcloud logging views add-iam-policy-binding my-view \
--member='user:my-user@gmail.com' --role='roles/my-role' \
--bucket=my-bucket --location=global \
--condition=expression=[expression],title=[title],\
description=[description]
See https://cloud.google.com/iam/docs/managing-policies for details about
IAM policies and member types.
POSITIONAL ARGUMENTS
VIEW_ID
ID of the view that contains the IAM policy.
REQUIRED FLAGS
--bucket=BUCKET
ID of the bucket that contains the view.
--location=LOCATION
Location of the bucket that contains the view.
--member=PRINCIPAL
The principal to add the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete
path of a predefined role, such as roles/logging.viewer, or the role ID
for a custom role, such as
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
OPTIONAL FLAGS
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Billing account of the view that contains the IAM policy.
--folder=FOLDER_ID
Folder of the view that contains the IAM policy.
--organization=ORGANIZATION_ID
Organization of the view that contains the IAM policy.
--project=PROJECT_ID
Project of the view that contains the IAM policy.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
At most one of these can be specified:
--condition=[KEY=VALUE,...]
A condition to include in the binding. When the condition is
explicitly specified as None (--condition=None), a binding without a
condition is added. When the condition is specified and is not None,
--role cannot be a basic role. Basic roles are roles/editor,
roles/owner, and roles/viewer. For more on conditions, refer to the
conditions overview guide:
https://cloud.google.com/iam/docs/conditions-overview
When using the --condition flag, include the following key-value
pairs:
expression
(Required) Condition expression that evaluates to True or False.
This uses a subset of Common Expression Language syntax.
If the condition expression includes a comma, use a different
delimiter to separate the key-value pairs. Specify the delimiter
before listing the key-value pairs. For example, to specify a
colon (:) as the delimiter, do the following:
--condition=^:^title=TITLE:expression=EXPRESSION. For more
information, see
https://cloud.google.com/sdk/gcloud/reference/topic/escaping.
title
(Required) A short string describing the purpose of the
expression.
description
(Optional) Additional description for the expression.
--condition-from-file=CONDITION_FROM_FILE
Path to a local JSON or YAML file that defines the condition. To see
available fields, see the help for --condition.
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.

View file

@ -8,7 +8,7 @@ SYNOPSIS
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Displays information about a view.
Displays information about a log view.
EXAMPLES
To describe a view in a project, run:

View file

@ -0,0 +1,63 @@
NAME
gcloud logging views get-iam-policy - display the IAM policy for a view
SYNOPSIS
gcloud logging views get-iam-policy VIEW_ID --bucket=BUCKET
--location=LOCATION
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get the IAM policy for a view.
EXAMPLES
To describe a view in a project, run:
$ gcloud logging views get-iam-policy my-view --bucket=my-bucket \
--location=global
POSITIONAL ARGUMENTS
VIEW_ID
ID of the view to fetch IAM policy
REQUIRED FLAGS
--bucket=BUCKET
ID of the bucket that holds the view.
--location=LOCATION
Location of the bucket that contains the view
OPTIONAL FLAGS
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Billing account of the view to fetch IAM policy.
--folder=FOLDER_ID
Folder of the view to fetch IAM policy.
--organization=ORGANIZATION_ID
Organization of the view to fetch IAM policy.
--project=PROJECT_ID
Project of the view to fetch IAM policy.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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.

View file

@ -16,6 +16,9 @@ GCLOUD WIDE FLAGS
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
Add IAM policy binding to a log view.
create
Create a log view on a log bucket.
@ -25,9 +28,18 @@ COMMANDS
describe
Display information about a view.
get-iam-policy
Display the IAM policy for a view.
list
List the defined views.
remove-iam-policy-binding
Remove IAM policy binding to a log view.
set-iam-policy
Set IAM policy for a view.
update
Update a view.

View file

@ -0,0 +1,141 @@
NAME
gcloud logging views remove-iam-policy-binding - remove IAM policy binding
to a log view
SYNOPSIS
gcloud logging views remove-iam-policy-binding VIEW_ID --bucket=BUCKET
--location=LOCATION --member=PRINCIPAL --role=ROLE
[--all | --condition=[KEY=VALUE,...]
| --condition-from-file=CONDITION_FROM_FILE]
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Remove IAM policy binding to a log view.
EXAMPLES
To remove an IAM policy binding for the role 'roles/my-role' for the user
'my-user@gmail.com' on my-view, run:
$ gcloud logging views remove-iam-policy-binding my-view \
--member='user:my-user@gmail.com' --role='roles/my-role' \
--bucket=my-bucket --location=global
To remove a binding with a condition, run:
$ gcloud logging views remove-iam-policy-binding my-view \
--member='user:my-user@gmail.com' --role='roles/my-role' \
--bucket=my-bucket --location=global \
--condition=expression=[expression],title=[title],\
description=[description]
See https://cloud.google.com/iam/docs/managing-policies for details about
IAM policies and member types.
POSITIONAL ARGUMENTS
VIEW_ID
ID of the view that contains the IAM policy.
REQUIRED FLAGS
--bucket=BUCKET
ID of the bucket that contains the view.
--location=LOCATION
Location of the bucket that contains the view.
--member=PRINCIPAL
The principal to remove the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Deleted principals have an additional deleted: prefix and a ?uid=UID
suffix, where UID is a unique identifier for the principal. Example:
deleted:user:test-user@gmail.com?uid=123456789012345678901.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
The role to remove the principal from.
OPTIONAL FLAGS
At most one of these can be specified:
--all
Remove all bindings with this role and principal, irrespective of any
conditions.
--condition=[KEY=VALUE,...]
The condition of the binding that you want to remove. When the
condition is explicitly specified as None (--condition=None), a
binding without a condition is removed. Otherwise, only a binding
with a condition that exactly matches the specified condition
(including the optional description) is removed. For more on
conditions, refer to the conditions overview guide:
https://cloud.google.com/iam/docs/conditions-overview
When using the --condition flag, include the following key-value
pairs:
expression
(Required) Condition expression that evaluates to True or False.
This uses a subset of Common Expression Language syntax.
If the condition expression includes a comma, use a different
delimiter to separate the key-value pairs. Specify the delimiter
before listing the key-value pairs. For example, to specify a
colon (:) as the delimiter, do the following:
--condition=^:^title=TITLE:expression=EXPRESSION. For more
information, see
https://cloud.google.com/sdk/gcloud/reference/topic/escaping.
title
(Required) A short string describing the purpose of the
expression.
description
(Optional) Additional description for the expression.
--condition-from-file=CONDITION_FROM_FILE
Path to a local JSON or YAML file that defines the condition. To see
available fields, see the help for --condition.
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Billing account of the view that contains the IAM policy.
--folder=FOLDER_ID
Folder of the view that contains the IAM policy.
--organization=ORGANIZATION_ID
Organization of the view that contains the IAM policy.
--project=PROJECT_ID
Project of the view that contains the IAM policy.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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.

View file

@ -0,0 +1,71 @@
NAME
gcloud logging views set-iam-policy - set IAM policy for a view
SYNOPSIS
gcloud logging views set-iam-policy VIEW_ID POLICY_FILE --bucket=BUCKET
--location=LOCATION
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Set an IAM policy for a view.
EXAMPLES
To set the IAM policy using a json file 'my_policy.json' for the view
my-view in my-bucket in the global location, run:
$ gcloud logging views set-iam-policy my-view \
/path/to/my_policy.json --bucket=my-bucket --location=global
POSITIONAL ARGUMENTS
VIEW_ID
ID of the view to set IAM policy.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any
JSON or YAML file conforming to the structure of a Policy
(https://cloud.google.com/iam/reference/rest/v1/Policy).
REQUIRED FLAGS
--bucket=BUCKET
ID of the bucket that contains the view.
--location=LOCATION
Location of the bucket that contains the view.
OPTIONAL FLAGS
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Billing account of the view to set IAM policy.
--folder=FOLDER_ID
Folder of the view to set IAM policy.
--organization=ORGANIZATION_ID
Organization of the view to set IAM policy.
--project=PROJECT_ID
Project of the view to set IAM policy.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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.