imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 23:08:48 +00:00
Code Activity

gcloud: Wed Oct 1 11:06:24 UTC 2025

Browse source
This commit is contained in:
Automated 2025-10-01 11:06:24 +00:00
parent 1dea1ef852
commit a0434a4d7a
247 changed files with 8086 additions and 424 deletions
Download patch file Download diff file Expand all files Collapse all files

97
gcloud/beta/pam/settings/describe Normal file
View file

@ -0,0 +1,97 @@
NAME
gcloud beta pam settings describe - show details of Privileged Access
Manager settings on a resource
SYNOPSIS
gcloud beta pam settings describe
(--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Show details of Privileged Access Manager (PAM) settings on a
resource.
EXAMPLES
The following command describes settings on a project named sample-project,
and in location global:
$ gcloud beta pam settings describe --project=sample-project \
--location=global
The following command describes settings on a folder with ID FOLDER_ID, and
in location global:
$ gcloud beta pam settings describe --folder=FOLDER_ID \
--location=global
The following command describes settings on an organization with ID
ORGANIZATION_ID, and in location global:
$ gcloud beta pam settings describe --organization=ORGANIZATION_ID \
--location=global
REQUIRED FLAGS
Location resource - The project/organization/folder location for which the
settings are to be described. 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 --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [privilegedaccessmanager.projects.locations,
privilegedaccessmanager.folders.locations,
privilegedaccessmanager.organizations.locations].
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.
This flag argument must be specified if any of the other arguments in
this group are specified.
--folder=FOLDER
The name of the folder
To set the folder attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type
[privilegedaccessmanager.folders.locations].
--organization=ORGANIZATION
The name of the organization
To set the organization attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type
[privilegedaccessmanager.organizations.locations].
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 privilegedaccessmanager/v1beta API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam-overview
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha pam settings describe

101
gcloud/beta/pam/settings/describe-effective Normal file
View file

@ -0,0 +1,101 @@
NAME
gcloud beta pam settings describe-effective - show effective Privileged
Access Manager settings on a resource
SYNOPSIS
gcloud beta pam settings describe-effective
(--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Show effective Privileged Access Manager (PAM) settings on a
resource. The "effective value" of a setting on a given resource refers to
the final or active value of a setting configuration that is applied to a
resource. For each configuration type field in settings resource, a
hierarchy evaluation will happen to calculate effective value on the
resource node.
EXAMPLES
The following command describes effective settings on a project named
sample-project, and in location global:
$ gcloud beta pam settings describe-effective \
--project=sample-project --location=global
The following command describes effective settings on a folder with ID
FOLDER_ID, and in location global:
$ gcloud beta pam settings describe-effective --folder=FOLDER_ID \
--location=global
The following command describes effective settings on an organization with
ID ORGANIZATION_ID, and in location global:
$ gcloud beta pam settings describe-effective \
--organization=ORGANIZATION_ID --location=global
REQUIRED FLAGS
Location resource - The project/organization/folder location for which the
effective settings are to be described. 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 --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [privilegedaccessmanager.projects.locations,
privilegedaccessmanager.folders.locations,
privilegedaccessmanager.organizations.locations].
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.
This flag argument must be specified if any of the other arguments in
this group are specified.
--folder=FOLDER
The name of the folder
To set the folder attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type
[privilegedaccessmanager.folders.locations].
--organization=ORGANIZATION
The name of the organization
To set the organization attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type
[privilegedaccessmanager.organizations.locations].
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 privilegedaccessmanager/v1beta API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam-overview
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha pam settings describe-effective

107
gcloud/beta/pam/settings/export Normal file
View file

@ -0,0 +1,107 @@
NAME
gcloud beta pam settings export - export Privileged Access Manager settings
configured on a project, folder, or organization to a local YAML file
SYNOPSIS
gcloud beta pam settings export
(--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION)
[--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Export the Privileged Access Manager (PAM) settings configured for a
specified project, folder, or organization to a local YAML file.
EXAMPLES
The following command exports PAM settings for the project named
sample-project in location global to a local YAML file named
pam-settings.yaml:
$ gcloud beta pam settings export --project=sample-project \
--location=global --destination=pam-settings.yaml
The following command exports PAM settings for the folder with ID FOLDER_ID
in location global to a local YAML file named pam-settings.yaml:
$ gcloud beta pam settings export --folder=FOLDER_ID \
--location=global --destination=pam-settings.yaml
The following command exports PAM settings for the organization with ID
ORGANIZATION_ID in location global to a local YAML file named
pam-settings.yaml:
$ gcloud beta pam settings export --organization=ORGANIZATION_ID \
--location=global --destination=pam-settings.yaml
REQUIRED FLAGS
Location resource - The project/organization/folder location for which the
settings needs to be exported. 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 --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [privilegedaccessmanager.projects.locations,
privilegedaccessmanager.folders.locations,
privilegedaccessmanager.organizations.locations].
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.
This flag argument must be specified if any of the other arguments in
this group are specified.
--folder=FOLDER
The name of the folder
To set the folder attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type
[privilegedaccessmanager.folders.locations].
--organization=ORGANIZATION
The name of the organization
To set the organization attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type
[privilegedaccessmanager.organizations.locations].
OPTIONAL FLAGS
--destination=DESTINATION
Path to a YAML file where the configuration will be exported. The
exported data will not contain any output-only fields. Alternatively,
you may omit this flag to write to standard output. For a schema
describing the export/import format, see
$CLOUDSDKROOT/lib/googlecloudsdk/schemas/...
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 privilegedaccessmanager/v1beta API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam-overview
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha pam settings export

117
gcloud/beta/pam/settings/help Normal file
View file

@ -0,0 +1,117 @@
NAME
gcloud beta pam settings - manage Privileged Access Manager Settings
SYNOPSIS
gcloud beta pam settings COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) The gcloud pam settings command group lets you manage Privileged
Access Manager (PAM) settings.
EXAMPLES
To describe the PAM Settings on a project named sample-project and in
location global, run:
$ gcloud beta pam settings describe --project=sample-project \
--location=global
To describe the PAM Settings on a folder with ID FOLDER_ID and in location
global, run:
$ gcloud beta pam settings describe --folder=FOLDER_ID \
--location=global
To describe the PAM Settings on an organization with ID ORGANIZATION_ID and
in location global, run:
$ gcloud beta pam settings describe --organization=ORGANIZATION_ID \
--location=global
To describe the effective PAM Settings on a project named sample-project
and in location global, run:
$ gcloud beta pam settings describe-effective \
--project=sample-project --location=global
To describe the effective PAM Settings on a folder with ID FOLDER_ID and in
location global, run:
$ gcloud beta pam settings describe-effective --folder=FOLDER_ID \
--location=global
To describe the effective PAM Settings on an organization with ID
ORGANIZATION_ID and in location global, run:
$ gcloud beta pam settings describe-effective \
--organization=ORGANIZATION_ID --location=global
To export the PAM Settings configured on a project named sample-project,
and in location global to a local YAML file named pam-settings.yaml, run:
$ gcloud beta pam settings export --project=sample-project \
--location=global --destination=pam-settings.yaml
To export the PAM Settings configured on a folder with ID FOLDER_ID, and in
location global to a local YAML file named pam-settings.yaml, run:
$ gcloud beta pam settings export --folder=FOLDER_ID \
--location=global --destination=pam-settings.yaml
To export the PAM settings configured for an organization with ID
ORGANIZATION_ID in location global to a local YAML file named
pam-settings.yaml, run:
$ gcloud beta pam settings export --organization=ORGANIZATION_ID \
--location=global --destination=pam-settings.yaml
To update the PAM Settings on a project named sample-project and in
location global, and the new updated settings configuration stored in a
file named pam-settings.yaml, run:
$ gcloud beta pam settings update --project=sample-project \
--location=global --settings-file=pam-settings.yaml
To update the PAM Settings on a folder with ID FOLDER_ID and in location
global, and the new updated settings configuration stored in a file named
pam-settings.yaml, run:
$ gcloud beta pam settings update --folder=FOLDER_ID \
--location=global --settings-file=pam-settings.yaml
To update the PAM Settings on an organization with ID ORGANIZATION_ID and
in location global, and the new updated settings configuration stored in a
file named pam-settings.yaml, run:
$ gcloud beta pam settings update --organization=ORGANIZATION_ID \
--location=global --settings-file=pam-settings.yaml
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(BETA) Show details of Privileged Access Manager (PAM) settings on a
resource.
describe-effective
(BETA) Show effective Privileged Access Manager (PAM) settings on a
resource.
export
(BETA) Export Privileged Access Manager (PAM) settings configured on a
project, folder, or organization to a local YAML file.
update
(BETA) Update Privileged Access Manager (PAM) settings configured on a
project, folder, or organization.
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha pam settings

111
gcloud/beta/pam/settings/update Normal file
View file

@ -0,0 +1,111 @@
NAME
gcloud beta pam settings update - update Privileged Access Manager settings
configured on a project, folder, or organization
SYNOPSIS
gcloud beta pam settings update --settings-file=PATH_TO_FILE
(--location=LOCATION : --folder=FOLDER --organization=ORGANIZATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update the Privileged Access Manager (PAM) settings configured for a
specified project, folder, or organization. This command allows you to
modify the settings using a YAML file.
EXAMPLES
The following command updates PAM settings for the project named
sample-project in location global, using the settings defined in a file
named pam_settings.yaml:
$ gcloud beta pam settings update --project=sample-project \
--location=global --settings-file=pam_settings.yaml
The following command updates PAM settings for the folder with ID FOLDER_ID
in location global, using the settings defined in a file named
pam_settings.yaml:
$ gcloud beta pam settings update --folder=FOLDER_ID \
--location=global --settings-file=pam_settings.yaml
The following command updates PAM settings for the organization with ID
ORGANIZATION_ID in location global, using the settings defined in a file
named pam_settings.yaml:
$ gcloud beta pam settings update --organization=ORGANIZATION_ID \
--location=global --settings-file=pam_settings.yaml
REQUIRED FLAGS
--settings-file=PATH_TO_FILE
YAML file containing the new configuration of the PAM settings. Use a
full or relative path to a local file containing the value of
settings_file.
Location resource - The project/organization/folder location for which the
settings are to be updated. 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 --location on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. This resource can be one of the
following types: [privilegedaccessmanager.projects.locations,
privilegedaccessmanager.folders.locations,
privilegedaccessmanager.organizations.locations].
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.
This flag argument must be specified if any of the other arguments in
this group are specified.
--folder=FOLDER
The name of the folder
To set the folder attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --folder on the command line. Must be
specified for resource of type
[privilegedaccessmanager.folders.locations].
--organization=ORGANIZATION
The name of the organization
To set the organization attribute:
▸ provide the argument --location on the command line with a fully
specified name;
▸ provide the argument --organization on the command line. Must be
specified for resource of type
[privilegedaccessmanager.organizations.locations].
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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 privilegedaccessmanager/v1beta API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam-overview
NOTES
This command is currently in beta and might change without notice. This
variant is also available:
$ gcloud alpha pam settings update