"default"
*********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Update a Database Tools database API gateway config global resource


Usage
=====

   oci dbtools-runtime database-api-gateway-config-global update default [OPTIONS]


Required Parameters
===================

--database-api-gateway-config-id [text]

The OCID of a Database Tools database API gateway config.

--global-key [text]

The key of the global config.

Accepted values are:

   SETTINGS


Optional Parameters
===================

--advanced-properties [complex type]

Advanced global properties. This is a complex type whose value must be
valid JSON. The value can be provided as a string on the command line
or passed in as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--certificate-bundle [complex type]

This is a complex type whose value must be valid JSON. The value can
be provided as a string on the command line or passed in as a file
using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.

--database-api-status [text]

ORDS database API is a database management and monitoring REST API.
Database Actions requires this feature.

Accepted values are:

   DISABLED, ENABLED

--document-root [text]

The location of the static resources to be served under the / root
server path.

--force

Perform update without prompting for confirmation.

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--http-port [integer]

Specifies the HTTP listen port. 0 disables HTTP. Use of ports below
1024 requires elevated (root) privileges and is generally discouraged;
deployment on non-privileged ports (1024–65535) is recommended.

--https-port [integer]

Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below
1024 requires elevated (root) privileges and is generally discouraged;
deployment on non-privileged ports (1024–65535) is recommended. ORDS
will use a self-signed certificate if a certificate bundle is not
provided.

--if-match [text]

If-Match is most often used with state-changing methods (e.g., POST,
PUT, DELETE) to prevent accidental overwrites when multiple user
agentss might be acting in parallel on the same resource (i.e., to
prevent the “lost update” problem). In general, it can be used with
any method that involves the selection or modification of a
representation to abort the request if the selected representation’s
current entity tag is not a member within the If-Match field value.
When specified on an action-specific subresource, the ETag value of
the resource on which the action is requested should be provided.

--pool-route [text]

How the target pool route value is determined for a HTTP request.

Accepted values are:

   HEADER, PATH

--pool-routing-header [text]

The request header name providing the pool route value.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-auto-prompt", "--
cli-rc-file", "--config-file", "--connection-timeout", "--debug", "--
defaults-file", "--enable-dual-stack", "--enable-propagation", "--
endpoint", "--generate-full-command-json-input", "--generate-param-
json-input", "--help", "--latest-version", "--max-retries", "--no-
retry", "--opc-client-request-id", "--opc-request-id", "--output", "--
profile", "--proxy", "--query", "--raw-output", "--read-timeout", "--
realm-specific-endpoint", "--region", "--release-info", "--request-
id", "--version", "-?", "-d", "-h", "-i", "-v"


Example using required parameter
================================

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export database_api_gateway_config_id=<substitute-value-of-database_api_gateway_config_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-global/update/default.html#cmdoption-database-api-gateway-config-id
       export global_key=<substitute-value-of-global_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-global/update/default.html#cmdoption-global-key

       oci dbtools-runtime database-api-gateway-config-global update default --database-api-gateway-config-id $database_api_gateway_config_id --global-key $global_key
