Share via

az oracle-database autonomous-database backup

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 backup command. Learn more about extensions.

Autonomous Databases Backup.

Commands

Name Description Type Status
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 backup create

Create a AutonomousDatabaseBackup.

az oracle-database autonomous-database backup create --adbbackupid --name
                                                     --autonomousdatabasename
                                                     --resource-group
                                                     [--display-name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--retention-days --retention-period-in-days]

Examples

ADBS Backup Create

az oracle-database autonomous-database backup create --autonomousdatabasename <ADBS name> --resource-group <resource_group> --adbbackupid <id> --display-name <display name> --retention-period-in-days <days>

Required Parameters

--adbbackupid --name -n

AutonomousDatabaseBackup id.

--autonomousdatabasename

The database name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--display-name

The user-friendly name for the backup. The name does not have to be unique.

Property Value
Parameter group: Properties Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--retention-days --retention-period-in-days

Retention period, in days, for long-term backups.

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az oracle-database autonomous-database backup delete

Delete a AutonomousDatabaseBackup.

az oracle-database autonomous-database backup delete [--adbbackupid --name]
                                                     [--autonomousdatabasename]
                                                     [--ids]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--yes]

Examples

ADBS Backup Delete

az oracle-database autonomous-database backup delete --autonomousdatabasename <ADBS name> --resource-group <resource_group> --adbbackupid <id>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--adbbackupid --name -n

AutonomousDatabaseBackup id.

Property Value
Parameter group: Resource Id Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az oracle-database autonomous-database backup list

List AutonomousDatabaseBackup resources by AutonomousDatabase.

az oracle-database autonomous-database backup list --autonomousdatabasename
                                                   --resource-group
                                                   [--max-items]
                                                   [--next-token]

Examples

List ADBS Backups

az az oracle-database autonomous-database backup list --autonomousdatabasename <ADBS name> --resource-group <resource_group>

Required Parameters

--autonomousdatabasename

The database name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az oracle-database autonomous-database backup show

Get a AutonomousDatabaseBackup.

az oracle-database autonomous-database backup show [--adbbackupid --name]
                                                   [--autonomousdatabasename]
                                                   [--ids]
                                                   [--resource-group]
                                                   [--subscription]

Examples

Get ADBS Backup

az oracle-database autonomous-database backup show --autonomousdatabasename <ADBS name> --resource-group <resource_group> --adbbackupid <id>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--adbbackupid --name -n

AutonomousDatabaseBackup id.

Property Value
Parameter group: Resource Id Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az oracle-database autonomous-database backup update

Update a AutonomousDatabaseBackup.

az oracle-database autonomous-database backup update [--adbbackupid --name]
                                                     [--add]
                                                     [--autonomousdatabasename]
                                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--ids]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--remove]
                                                     [--resource-group]
                                                     [--retention-days --retention-period-in-days]
                                                     [--set]
                                                     [--subscription]

Examples

ADBS Backup Update

az oracle-database autonomous-database backup create --autonomousdatabasename <ADBS name> --resource-group <resource_group> --adbbackupid <id> --retention-period-in-days <days>

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--adbbackupid --name -n

AutonomousDatabaseBackup id.

Property Value
Parameter group: Resource Id Arguments
--add

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>.

Property Value
Parameter group: Generic Update Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--retention-days --retention-period-in-days

Retention period, in days, for long-term backups.

Property Value
Parameter group: Properties Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az oracle-database autonomous-database backup wait

Place the CLI in a waiting state until a condition is met.

az oracle-database autonomous-database backup wait [--adbbackupid --name]
                                                   [--autonomousdatabasename]
                                                   [--created]
                                                   [--custom]
                                                   [--deleted]
                                                   [--exists]
                                                   [--ids]
                                                   [--interval]
                                                   [--resource-group]
                                                   [--subscription]
                                                   [--timeout]
                                                   [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--adbbackupid --name -n

AutonomousDatabaseBackup id.

Property Value
Parameter group: Resource Id Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False