az oracle-database autonomous-database

Note

This reference is part of the oracle-database extension for the Azure CLI (version 2.75.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 action

Perform Lifecycle Management Action on Autonomous Database.

Extension GA
az oracle-database autonomous-database backup

Autonomous Databases Backup.

Extension GA
az oracle-database autonomous-database backup create

Create an Autonomous Database backup.

Extension GA
az oracle-database autonomous-database backup delete

Delete an Autonomous Database backup.

Extension GA
az oracle-database autonomous-database backup list

List Autonomous Database backup resources by Autonomous Database.

Extension GA
az oracle-database autonomous-database backup show

Get an Autonomous Database backup.

Extension GA
az oracle-database autonomous-database backup update

Update an Autonomous Database backup.

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 change-disaster-recovery-configuration

Change the disaster recovery configuration of a cross-region disaster recovery peer Autonomous Database.

Extension GA
az oracle-database autonomous-database character-set

Autonomous Databases Character Set.

Extension GA
az oracle-database autonomous-database character-set list

List Autonomous Database character set resources by location.

Extension GA
az oracle-database autonomous-database character-set show

Get an Autonomous Database character set.

Extension GA
az oracle-database autonomous-database create

Create an Autonomous Database.

Extension GA
az oracle-database autonomous-database delete

Delete an Autonomous Database.

Extension GA
az oracle-database autonomous-database failover

Perform failover action on Autonomous Database.

Extension GA
az oracle-database autonomous-database generate-wallet

Generate wallet action on Autonomous Database.

Extension GA
az oracle-database autonomous-database list

List Autonomous Database 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 Autonomous Database national character set resources by location.

Extension GA
az oracle-database autonomous-database national-character-set show

Get an Autonomous Database national character set.

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 an Autonomous Database.

Extension GA
az oracle-database autonomous-database shrink

This operation shrinks the current allocated storage down to the current actual used data storage.

Extension GA
az oracle-database autonomous-database switchover

Perform switchover action on Autonomous Database.

Extension GA
az oracle-database autonomous-database update

Update an Autonomous Database.

Extension GA
az oracle-database autonomous-database version

Autonomous Databases Version.

Extension GA
az oracle-database autonomous-database version list

List Autonomous Database version resources by location.

Extension GA
az oracle-database autonomous-database version show

Get an Autonomous Database version.

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 action

Perform Lifecycle Management Action on Autonomous Database.

az oracle-database autonomous-database action --action {Restart, Start, Stop}
                                              [--acquire-policy-token]
                                              [--autonomousdatabasename]
                                              [--change-reference]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]

Examples

AutonomousDatabases_Action

az oracle-database autonomous-database action --resource-group rgopenapi --autonomousdatabasename databasedb1 --action Start

Required Parameters

--action

Autonomous Database lifecycle action.

Property Value
Parameter group: Body Arguments
Accepted values: Restart, Start, Stop

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
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 change-disaster-recovery-configuration

Change the disaster recovery configuration of a cross-region disaster recovery peer Autonomous Database.

az oracle-database autonomous-database change-disaster-recovery-configuration [--acquire-policy-token]
                                                                              [--autonomousdatabasename]
                                                                              [--change-reference]
                                                                              [--disaster-recovery-type {Adg, BackupBased}]
                                                                              [--ids]
                                                                              [--is-replicate-automatic-backups {0, 1, f, false, n, no, t, true, y, yes}]
                                                                              [--is-snapshot-standby {0, 1, f, false, n, no, t, true, y, yes}]
                                                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                              [--resource-group]
                                                                              [--subscription]
                                                                              [--time-snapshot-standby-enabled-till]

Examples

Change the disaster recovery configuration of a cross-region disaster recovery peer

az oracle-database autonomous-database change-disaster-recovery-configuration --resource-group MyResourceGroup --autonomousdatabasename MyCrossRegionPeerDB --disaster-recovery-type Adg --is-replicate-automatic-backups false

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The peer Autonomous Database name for the existing cross-region disaster recovery association.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--disaster-recovery-type

Indicates the disaster recovery (DR) type of the Autonomous Database Serverless instance. Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover. Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover.

Property Value
Parameter group: Body Arguments
Accepted values: Adg, BackupBased
--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
--is-replicate-automatic-backups

If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database.

Property Value
Parameter group: Body Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-snapshot-standby

Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database.

Property Value
Parameter group: Body Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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
--time-snapshot-standby-enabled-till

Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database.

Property Value
Parameter group: Body 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 create

Create an Autonomous Database.

Use one create mode option per request. The database type is inferred from --regular, --clone, --clone-from-backup-timestamp, or --cross-region-disaster-recovery. Do not pass dataBaseType directly. Clone and disaster recovery fields must be nested inside the matching create mode option.

az oracle-database autonomous-database create --autonomousdatabasename --name
                                              --resource-group
                                              [--acquire-policy-token]
                                              [--admin-password]
                                              [--autonomous-database-id]
                                              [--autonomous-maintenance-schedule-type --schedule-type {Early, Regular}]
                                              [--backup-retention-period-in-days --retention-days]
                                              [--change-reference]
                                              [--character-set]
                                              [--clone]
                                              [--clone-from-backup-timestamp]
                                              [--compute-count]
                                              [--compute-model {ECPU, OCPU}]
                                              [--cpu-auto-scaling --is-auto-scaling-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--cpu-core-count]
                                              [--cross-region-disaster-recovery]
                                              [--customer-contacts]
                                              [--data-storage-size-in-gbs --storage-gbs]
                                              [--data-storage-size-in-tbs --storage-tbs]
                                              [--database-edition {EnterpriseEdition, StandardEdition}]
                                              [--db-version]
                                              [--db-workload {AJD, APEX, DW, OLTP}]
                                              [--display-name]
                                              [--is-auto-scaling-for-storage-enabled --store-auto-scaling {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--is-local-data-guard-enabled --local-data-guard {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--is-mtls-connection-required --mtls-reqd {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--is-preview-version-with-service-terms-accepted --preview-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-list]
                                              [--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 <vnet_id> --regular

Clone from an existing Autonomous Database

az oracle-database autonomous-database create --resource-group MyResourceGroup --location eastus --autonomousdatabasename MyCloneDB --display-name MyCloneDB --db-version 19c --admin-password <password> --compute-model ECPU --compute-count 2 --data-storage-size-in-gbs 1024 --license-model LicenseIncluded --db-workload OLTP --character-set AL32UTF8 --ncharacter-set AL16UTF16 --vnet-id <vnet_id> --subnet-id <subnet_id> --clone clone-type=Full source=Database source-id=<source_autonomous_database_id>

Clone from a backup timestamp

az oracle-database autonomous-database create --resource-group MyResourceGroup --location eastus --autonomousdatabasename MyBackupCloneDB --display-name MyBackupCloneDB --db-version 19c --admin-password <password> --compute-model ECPU --compute-count 2 --data-storage-size-in-gbs 32 --license-model BringYourOwnLicense --db-workload OLTP --character-set AL32UTF8 --ncharacter-set AL16UTF16 --vnet-id <vnet_id> --subnet-id <subnet_id> --clone-from-backup-timestamp clone-type=Full source=BackupFromTimestamp source-id=<source_autonomous_database_id> timestamp=2026-06-03T15:45:11.000Z use-latest-available-backup-time-stamp=false

Create a cross-region disaster recovery peer

az oracle-database autonomous-database create --resource-group MyResourceGroup --location germanywestcentral --autonomousdatabasename MyCrossRegionPeerDB --display-name MyCrossRegionPeerDB --db-version 19c --compute-model ECPU --compute-count 2 --data-storage-size-in-gbs 1024 --license-model LicenseIncluded --character-set AL32UTF8 --ncharacter-set AL16UTF16 --vnet-id <destination_vnet_id> --subnet-id <destination_subnet_id> --cross-region-disaster-recovery remote-disaster-recovery-type=Adg source=CrossRegionDisasterRecovery source-id=<source_autonomous_database_id> source-location=eastus is-replicate-automatic-backups=true

Required Parameters

--autonomousdatabasename --name -n

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--admin-password

Admin password. If value is blank it's asked from the tty.

Property Value
Parameter group: Properties Arguments
--autonomous-database-id

Autonomous Database ID.

Property Value
Parameter group: Properties Arguments
--autonomous-maintenance-schedule-type --schedule-type

The maintenance schedule type of the Autonomous Database Serverless.

Property Value
Parameter group: Properties Arguments
Accepted values: Early, Regular
--backup-retention-period-in-days --retention-days

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

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--character-set

The character set for the autonomous database.

Property Value
Parameter group: Properties Arguments
--clone

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--clone-from-backup-timestamp

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--compute-count

The compute amount (CPUs) available to the database.

Property Value
Parameter group: Properties Arguments
--compute-model

The compute model of the Autonomous Database.

Property Value
Parameter group: Properties Arguments
Accepted values: ECPU, OCPU
--cpu-auto-scaling --is-auto-scaling-enabled

Indicates if auto scaling is enabled for the Autonomous Database CPU core count.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--cpu-core-count

The number of CPU cores to be made available to the database.

Property Value
Parameter group: Properties Arguments
--cross-region-disaster-recovery

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--customer-contacts

Customer Contacts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--data-storage-size-in-gbs --storage-gbs

The size, in gigabytes, of the data volume that will be created and attached to the database.

Property Value
Parameter group: Properties Arguments
--data-storage-size-in-tbs --storage-tbs

The quantity of data in the database, in terabytes.

Property Value
Parameter group: Properties Arguments
--database-edition

The Oracle Database edition that applies to the Autonomous Database. Use this only with --license-model BringYourOwnLicense.

Property Value
Parameter group: Properties Arguments
Accepted values: EnterpriseEdition, StandardEdition
--db-version

A valid Oracle Database version for Autonomous Database.

Property Value
Parameter group: Properties Arguments
--db-workload

The Autonomous Database workload type.

Property Value
Parameter group: Properties Arguments
Accepted values: AJD, APEX, DW, OLTP
--display-name

The user-friendly name for the Autonomous Database.

Property Value
Parameter group: Properties Arguments
--is-auto-scaling-for-storage-enabled --store-auto-scaling

Indicates if auto scaling is enabled for the Autonomous Database storage. For clones from an existing database, this value must match the source database storage auto-scaling setting.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-local-data-guard-enabled --local-data-guard

Indicates whether the Autonomous Database has local or called in-region Data Guard enabled.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-mtls-connection-required --mtls-reqd

Specifies if the Autonomous Database requires mTLS connections.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-preview-version-with-service-terms-accepted --preview-accepted

Specifies if the Autonomous Database preview version is being provisioned.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--license-model

The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.

Property Value
Parameter group: Properties Arguments
Accepted values: BringYourOwnLicense, LicenseIncluded
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Resource Arguments
--ncharacter-set

The character set for the Autonomous Database.

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
--private-endpoint-ip

The private endpoint Ip address for the resource.

Property Value
Parameter group: Properties Arguments
--private-endpoint-label

The resource's private endpoint label.

Property Value
Parameter group: Properties Arguments
--regular

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--scheduled-operations-list

The list of scheduled operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--subnet-id

Client subnet.

Property Value
Parameter group: Properties Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--vnet-id

VNET for network connectivity.

Property Value
Parameter group: Properties Arguments
--whitelisted-ips

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.

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 delete

Delete an Autonomous Database.

az oracle-database autonomous-database delete [--acquire-policy-token]
                                              [--autonomousdatabasename --name]
                                              [--change-reference]
                                              [--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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename --name -n

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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 failover

Perform failover action on Autonomous Database.

az oracle-database autonomous-database failover [--acquire-policy-token]
                                                [--autonomousdatabasename]
                                                [--change-reference]
                                                [--ids]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--peer-db-id]
                                                [--peer-db-location]
                                                [--peer-db-ocid]
                                                [--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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--peer-db-id

The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.

Property Value
Parameter group: Body Arguments
--peer-db-location

The location of the Disaster Recovery peer database.

Property Value
Parameter group: Body Arguments
--peer-db-ocid

Ocid of the Disaster Recovery peer database, which is located in a different region from the current peer database.

Property Value
Parameter group: Body 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 generate-wallet

Generate wallet action on Autonomous Database.

az oracle-database autonomous-database generate-wallet --password
                                                       [--acquire-policy-token]
                                                       [--autonomousdatabasename]
                                                       [--change-reference]
                                                       [--file]
                                                       [--generate-type {All, Single}]
                                                       [--ids]
                                                       [--is-regional {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--subscription]

Examples

Generate Wallet

az oracle-database autonomous-database generate-wallet --autonomousdatabasename MyAutoDB --resource-group MyResourceGroup --password <password> --is-regional True --file wallet-MyAutoDB.zip

Required Parameters

--password

The password to encrypt the keys inside the wallet If value is blank it's asked from the tty.

Property Value
Parameter group: Body Arguments

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--file -f

Local file path to save the generated wallet zip. Defaults to wallet-{autonomousdatabasename}.zip.

--generate-type

The type of wallet to generate.

Property Value
Parameter group: Body Arguments
Accepted values: All, Single
--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
--is-regional

True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only.

Property Value
Parameter group: Body Arguments
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
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 list

List Autonomous Database 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

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
--resource-group -g

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

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 restore

Restores an Autonomous Database based on the provided request parameters.

az oracle-database autonomous-database restore --timestamp
                                               [--acquire-policy-token]
                                               [--autonomousdatabasename]
                                               [--change-reference]
                                               [--ids]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

Examples

Restore an Autonomous Database

az oracle-database autonomous-database restore --autonomousdatabasename <ADBS name> --resource-group <resource_group> --timestamp 2026-06-03T15:45:11.000Z

Required Parameters

--timestamp

The point in time to restore the database to. Use RFC3339 UTC format, for example 2026-06-03T15:45:11.000Z.

Property Value
Parameter group: Body Arguments

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
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 show

Get an Autonomous Database.

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

Examples

Get an Autonomous Database

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

Optional Parameters

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

--autonomousdatabasename --name -n

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 shrink

This operation shrinks the current allocated storage down to the current actual used data storage.

az oracle-database autonomous-database shrink [--acquire-policy-token]
                                              [--autonomousdatabasename]
                                              [--change-reference]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]

Examples

Shrink

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

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
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 switchover

Perform switchover action on Autonomous Database.

az oracle-database autonomous-database switchover [--acquire-policy-token]
                                                  [--autonomousdatabasename]
                                                  [--change-reference]
                                                  [--ids]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--peer-db-id]
                                                  [--peer-db-location]
                                                  [--peer-db-ocid]
                                                  [--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 following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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
--peer-db-id

The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.

Property Value
Parameter group: Body Arguments
--peer-db-location

The location of the Disaster Recovery peer database.

Property Value
Parameter group: Body Arguments
--peer-db-ocid

Ocid of the Disaster Recovery peer database, which is located in a different region from the current peer database.

Property Value
Parameter group: Body 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 update

Update an Autonomous Database.

az oracle-database autonomous-database update [--acquire-policy-token]
                                              [--add]
                                              [--admin-password]
                                              [--autonomous-maintenance-schedule-type --schedule-type {Early, Regular}]
                                              [--autonomousdatabasename --name]
                                              [--backup-retention-period-in-days --retention-days]
                                              [--backup-schedule --long-term-backup-schedule]
                                              [--change-reference]
                                              [--clone]
                                              [--clone-from-backup-timestamp]
                                              [--compute-count]
                                              [--cpu-auto-scaling --is-auto-scaling-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--cpu-core-count]
                                              [--cross-region-disaster-recovery]
                                              [--customer-contacts]
                                              [--data-storage-size-in-gbs --storage-gbs]
                                              [--data-storage-size-in-tbs --storage-tbs]
                                              [--database-edition {EnterpriseEdition, StandardEdition}]
                                              [--display-name]
                                              [--failover-limit --local-adg-auto-failover-max-data-loss-limit]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--ids]
                                              [--is-auto-scaling-for-storage-enabled --store-auto-scaling {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--is-local-data-guard-enabled --local-data-guard {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--is-mtls-connection-required --mtls-reqd {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-list]
                                              [--set]
                                              [--subscription]
                                              [--tags]
                                              [--whitelisted-ips]

Examples

Update an Autonomous Database

az oracle-database autonomous-database update --autonomousdatabasename <ADBS name> --resource-group <resource_group> --tags {Tagkey:TagValue}

Enable local Autonomous Data Guard

az oracle-database autonomous-database update --resource-group MyResourceGroup --autonomousdatabasename MyAutoDB --local-data-guard true --local-adg-auto-failover-max-data-loss-limit 0

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy 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
--admin-password

Admin password. If value is blank it's asked from the tty.

Property Value
Parameter group: Properties Arguments
--autonomous-maintenance-schedule-type --schedule-type

The maintenance schedule type of the Autonomous Database Serverless.

Property Value
Parameter group: Properties Arguments
Accepted values: Early, Regular
--autonomousdatabasename --name -n

The database name.

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

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

Property Value
Parameter group: Properties Arguments
--backup-schedule --long-term-backup-schedule

Details for the long-term backup schedule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--clone

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--clone-from-backup-timestamp

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--compute-count

The compute amount (CPUs) available to the database.

Property Value
Parameter group: Properties Arguments
--cpu-auto-scaling --is-auto-scaling-enabled

Indicates if auto scaling is enabled for the Autonomous Database CPU core count.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--cpu-core-count

The number of CPU cores to be made available to the database.

Property Value
Parameter group: Properties Arguments
--cross-region-disaster-recovery

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--customer-contacts

Customer Contacts. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--data-storage-size-in-gbs --storage-gbs

The size, in gigabytes, of the data volume that will be created and attached to the database.

Property Value
Parameter group: Properties Arguments
--data-storage-size-in-tbs --storage-tbs

The quantity of data in the database, in terabytes.

Property Value
Parameter group: Properties Arguments
--database-edition

The Oracle Database edition that applies to the Autonomous Database.

Property Value
Parameter group: Properties Arguments
Accepted values: EnterpriseEdition, StandardEdition
--display-name

The user-friendly name for the Autonomous Database.

Property Value
Parameter group: Properties Arguments
--failover-limit --local-adg-auto-failover-max-data-loss-limit

Maximum data loss limit, in seconds, for local Autonomous Data Guard automatic failover when supported.

Property Value
Parameter group: Properties 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
--is-auto-scaling-for-storage-enabled --store-auto-scaling

Indicates if auto scaling is enabled for the Autonomous Database storage.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-local-data-guard-enabled --local-data-guard

Indicates whether local, in-region Autonomous Data Guard is enabled for the Autonomous Database.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-mtls-connection-required --mtls-reqd

Specifies if the Autonomous Database requires mTLS connections.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--license-model

The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED.

Property Value
Parameter group: Properties Arguments
Accepted values: BringYourOwnLicense, LicenseIncluded
--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
--open-mode

Indicates the Autonomous Database mode.

Property Value
Parameter group: Properties Arguments
Accepted values: ReadOnly, ReadWrite
--peer-db-id

The database OCID of the Disaster Recovery peer database, which is located in a different region from the current peer database.

Property Value
Parameter group: Properties Arguments
--permission-level

The Autonomous Database permission level.

Property Value
Parameter group: Properties Arguments
Accepted values: Restricted, Unrestricted
--regular

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--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
--role

The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled.

Property Value
Parameter group: Properties Arguments
Accepted values: BackupCopy, DisabledStandby, Primary, SnapshotStandby, Standby
--scheduled-operations-list

The list of scheduled operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Resource Arguments
--whitelisted-ips

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.

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.

--verbose

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

Property Value
Default value: False

az oracle-database autonomous-database wait

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

az oracle-database autonomous-database wait [--acquire-policy-token]
                                            [--autonomousdatabasename --name]
                                            [--change-reference]
                                            [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--autonomousdatabasename --name -n

The database name.

Property Value
Parameter group: Resource Id Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy 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