1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00
gcloud-help/gcloud/pam/entitlements/export
2024-07-31 09:35:16 +00:00

123 lines
4.7 KiB
Text

NAME
gcloud pam entitlements export - export a Privileged Access Manager
entitlement into a local YAML file
SYNOPSIS
gcloud pam entitlements export
(ENTITLEMENT
: --folder=FOLDER --location=LOCATION --organization=ORGANIZATION)
[--destination=DESTINATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Export a Privileged Access Manager (PAM) entitlement into a local YAML
file.
EXAMPLES
The following command exports an entitlement with a name of
sample-entitlement, in a project named sample-project, and in location
global to a local YAML file named sample-entitlement.yaml:
$ gcloud pam entitlements export sample-entitlement \
--project=sample-project --location=global \
--destination=sample-entitlement.yaml
The following command exports an entitlement with a name of
sample-entitlement, in a folder with ID FOLDER_ID, and in location global
to a local YAML file named sample-entitlement.yaml:
$ gcloud pam entitlements export sample-entitlement \
--folder=FOLDER_ID --location=global \
--destination=sample-entitlement.yaml
The following command exports an entitlement with a name of
sample-entitlement, in an organization with ID ORGANIZATION_ID, and in
location global to a local YAML file named sample-entitlement.yaml:
$ gcloud pam entitlements export sample-entitlement \
--organization=ORGANIZATION_ID --location=global \
--destination=sample-entitlement.yaml
POSITIONAL ARGUMENTS
Entitlement resource - Name of the entitlement to export. 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 entitlement 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.entitlements,
privilegedaccessmanager.folders.locations.entitlements,
privilegedaccessmanager.organizations.locations.entitlements].
This must be specified.
ENTITLEMENT
ID of the entitlement or fully qualified identifier for the
entitlement.
To set the entitlement attribute:
▸ provide the argument entitlement on the command line.
This positional 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 entitlement 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.entitlements].
--location=LOCATION
The resource location
To set the location attribute:
▸ provide the argument entitlement on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
--organization=ORGANIZATION
The name of the organization
To set the organization attribute:
▸ provide the argument entitlement 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.entitlements].
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/v1 API. The full
documentation for this API can be found at:
https://cloud.google.com/iam/docs/pam-overview
NOTES
These variants are also available:
$ gcloud alpha pam entitlements export
$ gcloud beta pam entitlements export