default

Description

Create a Database Tools database API gateway config auto API spec resource

Usage

oci dbtools-runtime database-api-gateway-config-pool-auto-api-spec create default [OPTIONS]

Required Parameters

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

The OCID of a Database Tools database API gateway config.

--database-object-name [text]

The name of the database object.

--database-object-type [text]

The type of the database object.

Accepted values are:

DUALITYVIEW, FUNCTION, MVIEW, PACKAGE, PROCEDURE, TABLE, VIEW

--display-name [text]

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

--pool-key [text]

The key of the pool config.

Optional Parameters

--alias [text]

Used as the URI path element for this object. When not specified the objectName lowercase is the default value.

--description [text]

Description of the autoApiSpec.

--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/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--operations [text]

The operations to limit access to this resource. If not specified then the default is [“READ”,”WRITE”].

Accepted values are:

READ, WRITE

--roles [complex type]

The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes. 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.

--scope [text]

The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.

--security-schemes [text]

The security schemes that can access this resource. If not specified then the resource is public.

Accepted values are:

BASIC, BEARER

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-pool-auto-api-spec/create/default.html#cmdoption-database-api-gateway-config-id
    export database_object_name=<substitute-value-of-database_object_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-pool-auto-api-spec/create/default.html#cmdoption-database-object-name
    export database_object_type=<substitute-value-of-database_object_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-pool-auto-api-spec/create/default.html#cmdoption-database-object-type
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-pool-auto-api-spec/create/default.html#cmdoption-display-name
    export pool_key=<substitute-value-of-pool_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/dbtools-runtime/database-api-gateway-config-pool-auto-api-spec/create/default.html#cmdoption-pool-key

    oci dbtools-runtime database-api-gateway-config-pool-auto-api-spec create default --database-api-gateway-config-id $database_api_gateway_config_id --database-object-name $database_object_name --database-object-type $database_object_type --display-name $display_name --pool-key $pool_key