mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-10 19:31:55 +00:00
228 lines
8 KiB
Text
228 lines
8 KiB
Text
NAME
|
|
gcloud oracle-database autonomous-databases update - update an
|
|
AutonomousDatabase
|
|
|
|
SYNOPSIS
|
|
gcloud oracle-database autonomous-databases update AUTONOMOUS_DATABASE
|
|
[--async] [--location=LOCATION] [--request-id=REQUEST_ID]
|
|
[--clear-properties --encryption-key-provider=ENCRYPTION_KEY_PROVIDER
|
|
--key-ring=KEY_RING --clear-encryption-key-kms
|
|
| --encryption-key-kms=ENCRYPTION_KEY_KMS]
|
|
[--labels=[LABELS,...]
|
|
| --update-labels=[UPDATE_LABELS,...] --clear-labels
|
|
| --remove-labels=REMOVE_LABELS] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
Update an AutonomousDatabase.
|
|
|
|
EXAMPLES
|
|
To Update the encryption for a given AutonomousDatabase with id
|
|
my-autonomous-database with custom KMS encryption key
|
|
projects/project-id/locations/us-east4/keyRings/keyring/cryptoKeys/key,
|
|
run:
|
|
|
|
$ gcloud oracle-database autonomous-databases update \
|
|
my-autonomous-database --location=us-east4 \
|
|
--properties-encryption-key-provider=GOOGLE_MANAGED \
|
|
--properties-encryption-key-kms-key=projects/project-id/\
|
|
locations/us-east4/keyRings/keyring/cryptoKeys/key
|
|
|
|
POSITIONAL ARGUMENTS
|
|
AutonomousDatabase resource - Identifier. The name of the Autonomous
|
|
Database resource in the following format:
|
|
projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
|
|
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 project attribute:
|
|
◆ provide the argument autonomous_database on the command line with a
|
|
fully specified name;
|
|
◆ provide the argument --project on the command line;
|
|
◆ set the property core/project.
|
|
|
|
To set the location attribute:
|
|
◆ provide the argument autonomous_database on the command line with a
|
|
fully specified name;
|
|
◆ provide the argument --location on the command line.
|
|
|
|
This must be specified.
|
|
|
|
AUTONOMOUS_DATABASE
|
|
ID of the autonomousDatabase or fully qualified identifier for the
|
|
autonomousDatabase.
|
|
|
|
To set the autonomous_database attribute:
|
|
▸ provide the argument autonomous_database on the command line.
|
|
|
|
FLAGS
|
|
--async
|
|
Return immediately, without waiting for the operation in progress to
|
|
complete.
|
|
|
|
--location=LOCATION
|
|
For resources [autonomous_database, encryption-key-kms], provides
|
|
fallback value for resource location attribute. When the resource's
|
|
full URI path is not provided, location will fallback to this flag
|
|
value.
|
|
|
|
--request-id=REQUEST_ID
|
|
An optional ID to identify the request. This value is used to identify
|
|
duplicate requests. If you make a request with the same request ID and
|
|
the original request is still in progress or completed, the server
|
|
ignores 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).
|
|
|
|
The properties of an Autonomous Database.
|
|
|
|
--clear-properties
|
|
Set autonomousDatabase.properties back to default value.
|
|
|
|
The encryption key used to encrypt the Autonomous Database.
|
|
|
|
--encryption-key-provider=ENCRYPTION_KEY_PROVIDER
|
|
The provider of the encryption key. ENCRYPTION_KEY_PROVIDER must be one
|
|
of:
|
|
|
|
google-managed
|
|
Google Managed KMS key, if selected, please provide the KMS key
|
|
name.
|
|
oracle-managed
|
|
Oracle Managed.
|
|
|
|
All arguments needed to update encryption_key_kms.
|
|
|
|
--key-ring=KEY_RING
|
|
The keyRing id of the cryptoKey resource.
|
|
|
|
To set the key-ring attribute:
|
|
◆ provide the argument --current on the command line with a fully
|
|
specified name;
|
|
◆ provide the argument --key-ring on the command line.
|
|
|
|
Update encryption_key_kms.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-encryption-key-kms
|
|
Clear encryption_key_kms value and set to null.
|
|
|
|
CryptoKey resource - Set encryption_key_kms to new value.
|
|
|
|
The KMS key used to encrypt the Autonomous Database. This field is
|
|
required if the provider is GOOGLE_MANAGED. The name of the KMS key
|
|
resource in the following format:
|
|
projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
|
|
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 project attribute:
|
|
▸ provide the argument --encryption-key-kms on the command line with
|
|
a fully specified name;
|
|
▸ provide the argument --project on the command line;
|
|
▸ set the property core/project.
|
|
|
|
To set the location attribute:
|
|
▸ provide the argument --encryption-key-kms on the command line with
|
|
a fully specified name;
|
|
▸ provide the argument --location on the command line.
|
|
|
|
To set the key-ring attribute:
|
|
▸ provide the argument --encryption-key-kms on the command line with
|
|
a fully specified name;
|
|
▸ provide the argument --key-ring on the command line.
|
|
|
|
--encryption-key-kms=ENCRYPTION_KEY_KMS
|
|
ID of the cryptoKey or fully qualified identifier for the cryptoKey.
|
|
|
|
To set the crypto-key attribute:
|
|
▸ provide the argument --encryption-key-kms on the command line.
|
|
|
|
Update labels.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--labels=[LABELS,...]
|
|
Set labels to new value. The labels or tags associated with the
|
|
Autonomous Database.
|
|
|
|
KEY
|
|
Keys must start with a lowercase character and contain only
|
|
hyphens (-), underscores (_), lowercase characters, and numbers.
|
|
|
|
VALUE
|
|
Values must contain only hyphens (-), underscores (_), lowercase
|
|
characters, and numbers.
|
|
|
|
Shorthand Example:
|
|
|
|
--labels=string=string
|
|
|
|
JSON Example:
|
|
|
|
--labels='{"string": "string"}'
|
|
|
|
File Example:
|
|
|
|
--labels=path_to_file.(yaml|json)
|
|
|
|
Or at least one of these can be specified:
|
|
|
|
--update-labels=[UPDATE_LABELS,...]
|
|
Update labels value or add key value pair. The labels or tags
|
|
associated with the Autonomous Database.
|
|
|
|
KEY
|
|
Keys must start with a lowercase character and contain only
|
|
hyphens (-), underscores (_), lowercase characters, and
|
|
numbers.
|
|
|
|
VALUE
|
|
Values must contain only hyphens (-), underscores (_),
|
|
lowercase characters, and numbers.
|
|
|
|
Shorthand Example:
|
|
|
|
--update-labels=string=string
|
|
|
|
JSON Example:
|
|
|
|
--update-labels='{"string": "string"}'
|
|
|
|
File Example:
|
|
|
|
--update-labels=path_to_file.(yaml|json)
|
|
|
|
At most one of these can be specified:
|
|
|
|
--clear-labels
|
|
Clear labels value and set to empty map.
|
|
|
|
--remove-labels=REMOVE_LABELS
|
|
Remove existing value from map labels. Sets remove_labels value.
|
|
|
|
Shorthand Example:
|
|
|
|
--remove-labels=string,string
|
|
|
|
JSON Example:
|
|
|
|
--remove-labels=["string"]
|
|
|
|
File Example:
|
|
|
|
--remove-labels=path_to_file.(yaml|json)
|
|
|
|
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 oracledatabase/v1 API. The full documentation for
|
|
this API can be found at: https://cloud.google.com/oracle/database/docs
|