az oracle-database autonomous-database
Note
This reference is part of the oracle-database extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az oracle-database autonomous-database command. Learn more about extensions.
Oracle Autonomous Databases.
Commands
Name | Description | Type | Status |
---|---|---|---|
az oracle-database autonomous-database backup |
Autonomous Databases Backup. |
Extension | GA |
az oracle-database autonomous-database backup create |
Create a AutonomousDatabaseBackup. |
Extension | GA |
az oracle-database autonomous-database backup delete |
Delete a AutonomousDatabaseBackup. |
Extension | GA |
az oracle-database autonomous-database backup list |
List AutonomousDatabaseBackup resources by AutonomousDatabase. |
Extension | GA |
az oracle-database autonomous-database backup show |
Get a AutonomousDatabaseBackup. |
Extension | GA |
az oracle-database autonomous-database backup update |
Update a AutonomousDatabaseBackup. |
Extension | GA |
az oracle-database autonomous-database backup wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az oracle-database autonomous-database character-set |
Autonomous Databases Character Set. |
Extension | GA |
az oracle-database autonomous-database character-set list |
List AutonomousDatabaseCharacterSet resources by Location. |
Extension | GA |
az oracle-database autonomous-database create |
Create a AutonomousDatabase. |
Extension | GA |
az oracle-database autonomous-database delete |
Delete a AutonomousDatabase. |
Extension | GA |
az oracle-database autonomous-database failover |
Perform failover action on Autonomous Database. |
Extension | GA |
az oracle-database autonomous-database list |
List AutonomousDatabase resources by subscription ID. |
Extension | GA |
az oracle-database autonomous-database national-character-set |
Autonomous Databases National Character Set. |
Extension | GA |
az oracle-database autonomous-database national-character-set list |
List AutonomousDatabaseNationalCharacterSet resources by Location. |
Extension | GA |
az oracle-database autonomous-database restore |
Restores an Autonomous Database based on the provided request parameters. |
Extension | GA |
az oracle-database autonomous-database show |
Get a AutonomousDatabase. |
Extension | GA |
az oracle-database autonomous-database switchover |
Perform switchover action on Autonomous Database. |
Extension | GA |
az oracle-database autonomous-database update |
Update a AutonomousDatabase. |
Extension | GA |
az oracle-database autonomous-database version |
Autonomous Databases Version. |
Extension | GA |
az oracle-database autonomous-database version list |
List AutonomousDbVersion resources by Location. |
Extension | GA |
az oracle-database autonomous-database wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az oracle-database autonomous-database create
Create a AutonomousDatabase.
az oracle-database autonomous-database create --autonomousdatabasename
--resource-group
[--admin-password]
[--autonomous-database-id]
[--autonomous-maintenance-schedule-type {Early, Regular}]
[--backup-retention-period-in-days]
[--character-set]
[--clone]
[--compute-count]
[--compute-model {ECPU, OCPU}]
[--cpu-auto-scaling {0, 1, f, false, n, no, t, true, y, yes}]
[--cpu-core-count]
[--customer-contacts]
[--data-storage-size-in-gbs]
[--data-storage-size-in-tbs]
[--database-edition {EnterpriseEdition, StandardEdition}]
[--db-version]
[--db-workload {AJD, APEX, DW, OLTP}]
[--display-name]
[--is-auto-scaling-for-storage-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--is-local-data-guard-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--is-mtls-connection-required {0, 1, f, false, n, no, t, true, y, yes}]
[--is-preview-version-with-service-terms-accepted {0, 1, f, false, n, no, t, true, y, yes}]
[--license-model {BringYourOwnLicense, LicenseIncluded}]
[--location]
[--ncharacter-set]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--private-endpoint-ip]
[--private-endpoint-label]
[--regular]
[--scheduled-operations]
[--subnet-id]
[--tags]
[--vnet-id]
[--whitelisted-ips]
Examples
Create an Autonomous database
az oracle-database autonomous-database create --location <location> --autonomousdatabasename <name> --resource-group <resource_group> --subnet-id /<subnet_id> --display-name <display_name> --compute-model ECPU --compute-count <compute_count> --data-storage-size-in-gbs <storage_size> --license-model <BringYourOwnLicense/LicenseIncluded> --db-workload <OLTP> --admin-password <password> --db-version 19c --character-set AL32UTF8 --ncharacter-set AL16UTF16 --vnet-id <virtual network id> --regular
Required Parameters
The database name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Admin password. If value is blank it's asked from the tty.
Autonomous Database ID.
The maintenance schedule type of the Autonomous Database Serverless.
Retention period, in days, for long-term backups.
The character set for the autonomous database.
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The compute amount (CPUs) available to the database.
The compute model of the Autonomous Database.
Indicates if auto scaling is enabled for the Autonomous Database CPU core count.
The number of CPU cores to be made available to the database.
Customer Contacts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The size, in gigabytes, of the data volume that will be created and attached to the database.
The quantity of data in the database, in terabytes.
The Oracle Database Edition that applies to the Autonomous databases.
A valid Oracle Database version for Autonomous Database.
The Autonomous Database workload type.
The user-friendly name for the Autonomous Database.
Indicates if auto scaling is enabled for the Autonomous Database storage.
Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.
Specifies if the Autonomous Database requires mTLS connections.
Specifies if the Autonomous Database preview version is being provisioned.
The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
The character set for the Autonomous Database.
Do not wait for the long-running operation to finish.
The private endpoint Ip address for the resource.
The resource's private endpoint label.
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The list of scheduled operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Client subnet.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
VNET for network connectivity.
The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25'] Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database delete
Delete a AutonomousDatabase.
az oracle-database autonomous-database delete [--autonomousdatabasename]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete an Autonomous database
az oracle-database autonomous-database delete --name <ADBS name> --resource-group <resource_group>
Optional Parameters
The database name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database failover
Perform failover action on Autonomous Database.
az oracle-database autonomous-database failover [--autonomousdatabasename]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peer-db-id]
[--resource-group]
[--subscription]
Examples
Failover
az oracle-database autonomous-database failover --autonomousdatabasename <ADBS name> --resource-group <resource_group> --peer-db-id <id>
Optional Parameters
The database name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database list
List AutonomousDatabase resources by subscription ID.
az oracle-database autonomous-database list [--max-items]
[--next-token]
[--resource-group]
Examples
List Autonomous databases
az oracle-database autonomous-database list --resource-group <resource_group>
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database restore
Restores an Autonomous Database based on the provided request parameters.
az oracle-database autonomous-database restore --timestamp
[--autonomousdatabasename]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Restore Autonomous database
az oracle-database autonomous-database restore --autonomousdatabasename <ADBS name> --resource-group <resource_group> --timestamp <timestamp>
Required Parameters
The time to restore the database to.
Optional Parameters
The database name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database show
Get a AutonomousDatabase.
az oracle-database autonomous-database show [--autonomousdatabasename]
[--ids]
[--resource-group]
[--subscription]
Examples
Get Autonomous database
az oracle-database autonomous-database show --autonomousdatabasename <ADBS name> --resource-group <resource_group>
Optional Parameters
The database name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database switchover
Perform switchover action on Autonomous Database.
az oracle-database autonomous-database switchover [--autonomousdatabasename]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--peer-db-id]
[--resource-group]
[--subscription]
Examples
Switchover
az oracle-database autonomous-database switchover --autonomousdatabasename <ADBS name> --resource-group <resource_group> --peer-db-id <id>
Optional Parameters
The database name.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database update
Update a AutonomousDatabase.
az oracle-database autonomous-database update [--add]
[--admin-password]
[--autonomous-maintenance-schedule-type {Early, Regular}]
[--autonomousdatabasename]
[--backup-retention-period-in-days]
[--backup-schedule]
[--clone]
[--compute-count]
[--cpu-auto-scaling {0, 1, f, false, n, no, t, true, y, yes}]
[--cpu-core-count]
[--customer-contacts]
[--data-storage-size-in-gbs]
[--data-storage-size-in-tbs]
[--database-edition {EnterpriseEdition, StandardEdition}]
[--display-name]
[--failover-limit]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--is-auto-scaling-for-storage-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--is-local-data-guard-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--is-mtls-connection-required {0, 1, f, false, n, no, t, true, y, yes}]
[--license-model {BringYourOwnLicense, LicenseIncluded}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--open-mode {ReadOnly, ReadWrite}]
[--peer-db-id]
[--permission-level {Restricted, Unrestricted}]
[--regular]
[--remove]
[--resource-group]
[--role {BackupCopy, DisabledStandby, Primary, SnapshotStandby, Standby}]
[--scheduled-operations]
[--set]
[--subscription]
[--tags]
[--whitelisted-ips]
Examples
Update Autonomous database
az oracle-database autonomous-database update --autonomousdatabasename <ADBS name> --resource-group <resource_group> --tags {Tagkey:TagValue}
Optional Parameters
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
Admin password. If value is blank it's asked from the tty.
The maintenance schedule type of the Autonomous Database Serverless.
The database name.
Retention period, in days, for long-term backups.
Details for the long-term backup schedule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The compute amount (CPUs) available to the database.
Indicates if auto scaling is enabled for the Autonomous Database CPU core count.
The number of CPU cores to be made available to the database.
Customer Contacts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The size, in gigabytes, of the data volume that will be created and attached to the database.
The quantity of data in the database, in terabytes.
The Oracle Database Edition that applies to the Autonomous databases.
The user-friendly name for the Autonomous Database.
Parameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Indicates if auto scaling is enabled for the Autonomous Database storage.
Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.
Specifies if the Autonomous Database requires mTLS connections.
The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.
Do not wait for the long-running operation to finish.
Indicates the Autonomous Database mode.
The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.
The Autonomous Database permission level.
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.
The list of scheduled operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25'] Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az oracle-database autonomous-database wait
Place the CLI in a waiting state until a condition is met.
az oracle-database autonomous-database wait [--autonomousdatabasename]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The database name.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.