.TH "GCLOUD_PARAMETERMANAGER_PARAMETERS_UPDATE" 1



.SH "NAME"
.HP
gcloud parametermanager parameters update \- updates the metadata of an Parameter Manager parameter resource



.SH "SYNOPSIS"
.HP
\f5gcloud parametermanager parameters update\fR \fIPARAMETER\fR [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-parameter\-format\fR=\fIPARAMETER_FORMAT\fR] [\fB\-\-request\-id\fR=\fIREQUEST_ID\fR] [\fB\-\-key\-ring\fR=\fIKEY_RING\fR\ \fB\-\-clear\-kms\-key\fR\ |\ \fB\-\-kms\-key\fR=\fIKMS_KEY\fR] [\fB\-\-labels\fR=[\fILABELS\fR,...]\ |\ \fB\-\-update\-labels\fR=[\fIUPDATE_LABELS\fR,...]\ \fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=\fIREMOVE_LABELS\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update the metadata of a parameter (e.g. labels). This command will return an
error if you specify a parameter that does not exist.



.SH "EXAMPLES"

To update a parameter \f5my\-parameter\fR in location \f5global\fR run:

.RS 2m
$ gcloud parametermanager parameters update my\-parameter \e
    \-\-location=global
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Parameter resource \- Identifier. [Output only] The resource name of the
Parameter in the format \f5projects/*/locations/*/parameters/*\fR. This
represents a Cloud resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5parameter\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

To set the \f5location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5parameter\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIPARAMETER\fR

ID of the parameter or fully qualified identifier for the parameter.

To set the \f5parameter\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5parameter\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

For resources [parameter, kms\-key], provides fallback value for resource
location attribute. When the resource's full URI path is not provided, location
will fallback to this flag value.

.TP 2m
\fB\-\-parameter\-format\fR=\fIPARAMETER_FORMAT\fR

Specifies the format of a Parameter. \fIPARAMETER_FORMAT\fR must be one of:

.RS 2m
.TP 2m
\fBjson\fR
JSON format.
.TP 2m
\fBunformatted\fR
Unformatted.
.TP 2m
\fByaml\fR
YAML format.
.RE
.sp


.TP 2m
\fB\-\-request\-id\fR=\fIREQUEST_ID\fR

An optional request ID to identify requests. Specify a unique request ID so that
if you must retry your request, the server will know to ignore the request if it
has already been completed. The server will guarantee that for at least 60
minutes since the first request.

For example, consider a situation where you make an initial request and the
request times out. If you make the request again with the same request ID, the
server can check if original operation with the same request ID was received,
and if so, will ignore the second request. This prevents clients from
accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not
supported (00000000\-0000\-0000\-0000\-000000000000).

.TP 2m

Arguments for the kms key.


.RS 2m
.TP 2m

All arguments needed to update kms_key.


.RS 2m
.TP 2m
\fB\-\-key\-ring\fR=\fIKEY_RING\fR

The keyRing id of the cryptoKey resource.

To set the \f5key\-ring\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-current\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-key\-ring\fR on the command line.
.RE
.sp

.TP 2m

Update kms_key.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-kms\-key\fR

Clear kms_key value and set to null.

.TP 2m

CryptoKey resource \- Set kms_key to new value.

Customer managed encryption key (CMEK) to use for encrypting the Parameter
Versions. If not set, the default Google\-managed encryption key will be used.
Cloud KMS CryptoKeys must reside in the same location as the Parameter. The
expected format is \f5projects/*/locations/*/keyRings/*/cryptoKeys/*\fR. This
represents a Cloud resource. (NOTE) Some attributes are not given arguments in
this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp

To set the \f5key\-ring\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-kms\-key\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-key\-ring\fR on the command line.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-kms\-key\fR=\fIKMS_KEY\fR

ID of the cryptoKey or fully qualified identifier for the cryptoKey.

To set the \f5crypto\-key\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-kms\-key\fR on the command line.
.RE
.sp

.RE
.RE
.RE
.RE
.sp
.TP 2m

Update labels.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-labels\fR=[\fILABELS\fR,...]

Set labels to new value. Labels as key value pairs.

.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.

.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-labels=string=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-labels='{"string": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-labels=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-update\-labels\fR=[\fIUPDATE_LABELS\fR,...]

Update labels value or add key value pair. Labels as key value pairs.

.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.

.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.

.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-update\-labels=string=string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-update\-labels='{"string": "string"}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-update\-labels=path_to_file.(yaml|json)
.RE


.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Clear labels value and set to empty map.

.TP 2m
\fB\-\-remove\-labels\fR=\fIREMOVE_LABELS\fR

Remove existing value from map labels. Sets \f5remove_labels\fR value.

\fBShorthand Example:\fR


.RS 2m
\-\-remove\-labels=string,string
.RE


\fBJSON Example:\fR


.RS 2m
\-\-remove\-labels=["string"]
.RE


\fBFile Example:\fR


.RS 2m
\-\-remove\-labels=path_to_file.(yaml|json)
.RE



.RE
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBparametermanager/v1\fR API. The full documentation for
this API can be found at:
https://cloud.google.com/secret\-manager/parameter\-manager/docs/overview