- NAME
-
- gcloud pam entitlements update - update an existing Privileged Access Manager entitlement
- SYNOPSIS
-
-
gcloud pam entitlements update
(ENTITLEMENT
:--folder
=FOLDER
--location
=LOCATION
--organization
=ORGANIZATION
)--entitlement-file
=PATH_TO_FILE
[--async
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Update an existing Privileged Access Manager (PAM) entitlement.
- EXAMPLES
-
The following command updates an entitlement with a name of
sample-entitlement
, in a project namedsample-project
, in locationglobal
, and the new entitlement configuration stored in a file namedsample-entitlement.yaml
:gcloud pam entitlements update sample-entitlement --project=sample-project --location=global --entitlement-file=sample-entitlement.yaml
The following command updates an entitlement with a name of
sample-entitlement
, in a folder with ID
, in locationFOLDER_ID
global
, and the new entitlement configuration stored in a file namedsample-entitlement.yaml
:gcloud pam entitlements update sample-entitlement --folder=FOLDER_ID --location=global --entitlement-file=sample-entitlement.yaml
The following command updates an entitlement with a name of
sample-entitlement
, in an organization with ID
, in locationORGANIZATION_ID
global
, and the new entitlement configuration stored in a file namedsample-entitlement.yaml
:gcloud pam entitlements update sample-entitlement --organization=ORGANIZATION_ID --location=global --entitlement-file=sample-entitlement.yaml
- POSITIONAL ARGUMENTS
-
-
Entitlement resource - Name of the entitlement to update. 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.
-
provide the argument
--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].
-
provide the argument
--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.
-
provide the argument
--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].
-
provide the argument
-
provide the argument
-
Entitlement resource - Name of the entitlement to update. 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.
- REQUIRED FLAGS
-
--entitlement-file
=PATH_TO_FILE
- YAML file containing the new configuration of the entitlement. Use a full or relative path to a local file containing the value of entitlement_file.
- 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/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 update
gcloud beta pam entitlements update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-30 UTC.