mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-18 06:47:12 +00:00
gcloud: Wed Mar 1 10:23:17 UTC 2023
This commit is contained in:
parent
7664984b79
commit
bdaa0b3cfc
230 changed files with 8963 additions and 242 deletions
|
|
@ -2,9 +2,9 @@ NAME
|
|||
gcloud beta logging buckets create - create a bucket
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta logging buckets create BUCKET_ID --location=LOCATION
|
||||
gcloud beta logging buckets create BUCKET_ID --location=LOCATION [--async]
|
||||
[--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION]
|
||||
[--index=[KEY=VALUE, ...,...]]
|
||||
[--enable-analytics] [--index=[KEY=VALUE, ...,...]]
|
||||
[--restricted-fields=[RESTRICTED_FIELD,...]]
|
||||
[--retention-days=RETENTION_DAYS] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
|
|
@ -37,6 +37,11 @@ EXAMPLES
|
|||
$ gcloud beta logging buckets create my-bucket \
|
||||
--location=us-central1 --cmek-kms-key-name=CMEK_KMS_KEY_NAME
|
||||
|
||||
To asynchronously create a bucket enrolled into Log Analytics, run:
|
||||
|
||||
$ gcloud beta logging buckets create my-bucket --location=global \
|
||||
--async --enable-analytics
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
BUCKET_ID
|
||||
ID of the bucket to create.
|
||||
|
|
@ -47,12 +52,20 @@ REQUIRED FLAGS
|
|||
location cannot be changed.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
--cmek-kms-key-name=CMEK_KMS_KEY_NAME
|
||||
A valid kms_key_name will enable CMEK for the bucket.
|
||||
|
||||
--description=DESCRIPTION
|
||||
A textual description for the bucket.
|
||||
|
||||
--enable-analytics
|
||||
Whether to opt the bucket into Log Analytics. Once opted in, the bucket
|
||||
cannot be opted out of Log Analytics.
|
||||
|
||||
--index=[KEY=VALUE, ...,...]
|
||||
Specify an index to be added to the log bucket. This flag can be
|
||||
repeated. The fieldPath and type attributes are required. For example:
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@ NAME
|
|||
|
||||
SYNOPSIS
|
||||
gcloud beta logging buckets update BUCKET_ID --location=LOCATION
|
||||
[--add-index=[KEY=VALUE, ...,...]] [--clear-indexes]
|
||||
[--add-index=[KEY=VALUE, ...,...]] [--async] [--clear-indexes]
|
||||
[--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION]
|
||||
[--locked] [--remove-indexes=[FIELD PATH,...]]
|
||||
[--enable-analytics] [--locked] [--remove-indexes=[FIELD PATH,...]]
|
||||
[--restricted-fields=[RESTRICTED_FIELD,...]]
|
||||
[--retention-days=RETENTION_DAYS] [--update-index=[KEY=VALUE, ...,...]]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
|
@ -44,6 +44,11 @@ EXAMPLES
|
|||
$ gcloud beta logging buckets update my-bucket --location=global \
|
||||
--cmek-kms-key-name=CMEK_KEY_NAME
|
||||
|
||||
To asynchronously enroll a bucket in your project into Log Analytics, run:
|
||||
|
||||
$ gcloud beta logging buckets update my-bucket --location=global \
|
||||
--async --enable-analytics
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
BUCKET_ID
|
||||
The id of the bucket to update.
|
||||
|
|
@ -69,6 +74,10 @@ OPTIONAL FLAGS
|
|||
The type of data in this index. For example: INDEX_TYPE_STRING
|
||||
Supported types are strings and integers.
|
||||
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
--clear-indexes
|
||||
Remove all logging indexes from the bucket.
|
||||
|
||||
|
|
@ -78,6 +87,10 @@ OPTIONAL FLAGS
|
|||
--description=DESCRIPTION
|
||||
A new description for the bucket.
|
||||
|
||||
--enable-analytics
|
||||
Whether to opt the bucket into Log Analytics. Once opted in, the bucket
|
||||
cannot be opted out of Log Analytics.
|
||||
|
||||
--locked
|
||||
Lock the bucket and prevent it from being modified or deleted (unless
|
||||
it is empty).
|
||||
|
|
|
|||
|
|
@ -18,6 +18,9 @@ GROUPS
|
|||
buckets
|
||||
(BETA) Manage Cloud Logging buckets.
|
||||
|
||||
links
|
||||
(BETA) Manage log links.
|
||||
|
||||
locations
|
||||
(BETA) Query Cloud Logging locations.
|
||||
|
||||
|
|
|
|||
79
gcloud/beta/logging/links/create
Normal file
79
gcloud/beta/logging/links/create
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
NAME
|
||||
gcloud beta logging links create - create a link on an analytics log bucket
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta logging links create LINK_ID --bucket=BUCKET
|
||||
--location=LOCATION [--async] [--description=DESCRIPTION]
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Create a link for a log bucket.
|
||||
|
||||
EXAMPLES
|
||||
To create a link in a project, run:
|
||||
|
||||
$ gcloud beta logging links create my-link --bucket=my-bucket \
|
||||
--location=global
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
LINK_ID
|
||||
ID of the link to create.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--bucket=BUCKET
|
||||
ID of the bucket that will hold the link
|
||||
|
||||
--location=LOCATION
|
||||
Location of the bucket that will hold the link.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
--description=DESCRIPTION
|
||||
A textual description for the link.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Billing account of the link to create.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Folder of the link to create.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Organization of the link to create.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Project of the link to create.
|
||||
|
||||
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.
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud logging links create
|
||||
|
||||
$ gcloud alpha logging links create
|
||||
|
||||
76
gcloud/beta/logging/links/delete
Normal file
76
gcloud/beta/logging/links/delete
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
NAME
|
||||
gcloud beta logging links delete - delete a link
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta logging links delete LINK_ID --bucket=BUCKET
|
||||
--location=LOCATION [--async]
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Deletes a bucket's link.
|
||||
|
||||
EXAMPLES
|
||||
To delete a bucket's link, run:
|
||||
|
||||
$ gcloud beta logging links delete my-link --bucket=my-bucket \
|
||||
--location=global
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
LINK_ID
|
||||
ID of the link to delete.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--bucket=BUCKET
|
||||
ID of bucket
|
||||
|
||||
--location=LOCATION
|
||||
Location of the bucket.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
--async
|
||||
Return immediately, without waiting for the operation in progress to
|
||||
complete.
|
||||
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Billing account of the link to delete.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Folder of the link to delete.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Organization of the link to delete.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Project of the link to delete.
|
||||
|
||||
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.
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud logging links delete
|
||||
|
||||
$ gcloud alpha logging links delete
|
||||
|
||||
72
gcloud/beta/logging/links/describe
Normal file
72
gcloud/beta/logging/links/describe
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
NAME
|
||||
gcloud beta logging links describe - display information about a link
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta logging links describe LINK_ID --bucket=BUCKET
|
||||
--location=LOCATION
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Displays information about a link.
|
||||
|
||||
EXAMPLES
|
||||
To describe a link in a project, run:
|
||||
|
||||
$ gcloud beta logging links describe my-link --bucket=my-bucket \
|
||||
--location=global
|
||||
|
||||
POSITIONAL ARGUMENTS
|
||||
LINK_ID
|
||||
Id of the link to describe.
|
||||
|
||||
REQUIRED FLAGS
|
||||
--bucket=BUCKET
|
||||
ID of bucket
|
||||
|
||||
--location=LOCATION
|
||||
Location of the bucket.
|
||||
|
||||
OPTIONAL FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Billing account of the link to describe.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Folder of the link to describe.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Organization of the link to describe.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Project of the link to describe.
|
||||
|
||||
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.
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud logging links describe
|
||||
|
||||
$ gcloud alpha logging links describe
|
||||
|
||||
38
gcloud/beta/logging/links/help
Normal file
38
gcloud/beta/logging/links/help
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
NAME
|
||||
gcloud beta logging links - manage log links
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta logging links COMMAND [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Commands for managing links. A log link represents a linked BigQuery
|
||||
dataset that contains log data for the link's parent log bucket.
|
||||
|
||||
GCLOUD WIDE FLAGS
|
||||
These flags are available to all commands: --help.
|
||||
|
||||
Run $ gcloud help for details.
|
||||
|
||||
COMMANDS
|
||||
COMMAND is one of the following:
|
||||
|
||||
create
|
||||
(BETA) Create a link on an analytics log bucket.
|
||||
|
||||
delete
|
||||
(BETA) Delete a link.
|
||||
|
||||
describe
|
||||
(BETA) Display information about a link.
|
||||
|
||||
list
|
||||
(BETA) List created links on the specified bucket.
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud logging links
|
||||
|
||||
$ gcloud alpha logging links
|
||||
|
||||
99
gcloud/beta/logging/links/list
Normal file
99
gcloud/beta/logging/links/list
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
NAME
|
||||
gcloud beta logging links list - list created links on the specified bucket
|
||||
|
||||
SYNOPSIS
|
||||
gcloud beta logging links list --bucket=BUCKET --location=LOCATION
|
||||
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
|
||||
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
|
||||
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
|
||||
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
|
||||
|
||||
DESCRIPTION
|
||||
(BETA) Lists the links created for a bucket.
|
||||
|
||||
EXAMPLES
|
||||
To list the links created for a bucket, run:
|
||||
|
||||
$ gcloud beta logging links list
|
||||
|
||||
REQUIRED FLAGS
|
||||
--bucket=BUCKET
|
||||
ID of bucket
|
||||
|
||||
--location=LOCATION
|
||||
Location of the specified bucket
|
||||
|
||||
FLAGS
|
||||
At most one of these can be specified:
|
||||
|
||||
--billing-account=BILLING_ACCOUNT_ID
|
||||
Billing account of the links to list.
|
||||
|
||||
--folder=FOLDER_ID
|
||||
Folder of the links to list.
|
||||
|
||||
--organization=ORGANIZATION_ID
|
||||
Organization of the links to list.
|
||||
|
||||
--project=PROJECT_ID
|
||||
Project of the links to list.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
NOTES
|
||||
This command is currently in beta and might change without notice. These
|
||||
variants are also available:
|
||||
|
||||
$ gcloud logging links list
|
||||
|
||||
$ gcloud alpha logging links list
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue