Share via


az oracle-database cloud-vm-cluster

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 cloud-vm-cluster command. Learn more about extensions.

Cloud VM Clusters.

Commands

Name Description Type Status
az oracle-database cloud-vm-cluster add-vm

Add VMs to the VM Cluster.

Extension GA
az oracle-database cloud-vm-cluster create

Create a CloudVmCluster.

Extension GA
az oracle-database cloud-vm-cluster database-node

Database Nodes.

Extension GA
az oracle-database cloud-vm-cluster database-node action

VM actions on DbNode of VM Cluster by the provided filter.

Extension GA
az oracle-database cloud-vm-cluster database-node list

List DbNode resources by CloudVmCluster.

Extension GA
az oracle-database cloud-vm-cluster delete

Delete a CloudVmCluster.

Extension GA
az oracle-database cloud-vm-cluster list

List CloudVmCluster resources by subscription ID.

Extension GA
az oracle-database cloud-vm-cluster remove-vm

Remove VMs from the VM Cluster.

Extension GA
az oracle-database cloud-vm-cluster show

Get a CloudVmCluster.

Extension GA
az oracle-database cloud-vm-cluster update

Update a CloudVmCluster.

Extension GA
az oracle-database cloud-vm-cluster wait

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

Extension GA

az oracle-database cloud-vm-cluster add-vm

Add VMs to the VM Cluster.

az oracle-database cloud-vm-cluster add-vm --db-servers
                                           [--cloudvmclustername]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]

Examples

Add VMs to Cluster

az oracle-database cloud-vm-cluster add-vm --cloudvmclustername <vmclustername> --resource-group <Resource group> --db-servers ['ocid1','ocid2']

Required Parameters

--db-servers

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

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.

--cloudvmclustername

CloudVmCluster 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
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 cloud-vm-cluster create

Create a CloudVmCluster.

az oracle-database cloud-vm-cluster create --cloudvmclustername --name
                                           --resource-group
                                           [--backup-subnet-cidr]
                                           [--cloud-exadata-infrastructure-id --exa-infra-id]
                                           [--cluster-name]
                                           [--collection-options --data-collection-options]
                                           [--cpu-core-count]
                                           [--data-storage-percentage --storage-percent]
                                           [--data-storage-size-in-tbs --storage-tbs]
                                           [--db-node-storage-size-in-gbs --node-storage-gbs]
                                           [--db-servers]
                                           [--display-name]
                                           [--domain]
                                           [--gi-version]
                                           [--hostname]
                                           [--is-local-backup-enabled --local-backup-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--is-sparse-diskgroup-enabled --sparse-diskgroup {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--license-model {BringYourOwnLicense, LicenseIncluded}]
                                           [--location]
                                           [--memory-size-in-gbs]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--nsg-cidrs]
                                           [--ocpu-count]
                                           [--scan-listener-port-tcp]
                                           [--scan-listener-port-tcp-ssl --scan-tcps-port]
                                           [--ssh-public-keys]
                                           [--subnet-id]
                                           [--system-version]
                                           [--tags]
                                           [--time-zone]
                                           [--vnet-id]
                                           [--zone-id]

Examples

Create VM Cluster

az oracle-database cloud-vm-cluster create --name <name> --resource-group <resource group> --location <location> --cloud-exadata-infrastructure-id <Exa Infra Id> --cpu-core-count <cpu count> --data-storage-percentage <storage percent> --data-storage-size-in-tbs <storage in TBs> --db-node-storage-size-in-gbs <storage size> --db-servers ['ocid1','ocid2'] --display-name <display name> --gi-version 19.0.0.0 --hostname <host name> --is-local-backup-enabled False --is-sparse-diskgroup-enabled False --license-model <LicenseIncluded/BringYourOwnLicense> --memory-size-in-gbs <memory size> --ssh-public-keys <ssh key> --subnet-id <subnet id> --time-zone <timezeone eg. UTC> --vnet-id <virtual network id>

Required Parameters

--cloudvmclustername --name -n

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

--backup-subnet-cidr

Client OCI backup subnet CIDR, default is 192.168.252.0/22.

Property Value
Parameter group: Properties Arguments
--cloud-exadata-infrastructure-id --exa-infra-id

Cloud Exadata Infrastructure ID.

Property Value
Parameter group: Properties Arguments
--cluster-name

The cluster name for cloud VM cluster. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

Property Value
Parameter group: Properties Arguments
--collection-options --data-collection-options

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--cpu-core-count

The number of CPU cores enabled on the cloud VM cluster.

Property Value
Parameter group: Properties Arguments
--data-storage-percentage --storage-percent

The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

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

The data disk group size to be allocated in TBs.

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

The local node storage to be allocated in GBs.

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

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

Property Value
Parameter group: Properties Arguments
--display-name

Display Name.

Property Value
Parameter group: Properties Arguments
--domain

The domain name for the cloud VM cluster.

Property Value
Parameter group: Properties Arguments
--gi-version

Oracle Grid Infrastructure (GI) software version.

Property Value
Parameter group: Properties Arguments
--hostname

The hostname for the cloud VM cluster.

Property Value
Parameter group: Properties Arguments
--is-local-backup-enabled --local-backup-enabled

If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster.

Property Value
Parameter group: Properties Arguments
Default value: False
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--is-sparse-diskgroup-enabled --sparse-diskgroup

If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.

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

The Oracle license model that applies to the cloud VM cluster. 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
--memory-size-in-gbs

The memory to be allocated in GBs.

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
--nsg-cidrs

CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

Property Value
Parameter group: Properties Arguments
--scan-listener-port-tcp

The TCP Single Client Access Name (SCAN) port. The default port is 1521.

Property Value
Parameter group: Properties Arguments
--scan-listener-port-tcp-ssl --scan-tcps-port

The TCPS Single Client Access Name (SCAN) port. The default port is 2484.

Property Value
Parameter group: Properties Arguments
--ssh-public-keys

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. 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
--system-version

Operating system version of the image.

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
--time-zone

The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.

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

VNET for network connectivity.

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

The OCID of the zone the cloud VM cluster is associated with.

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 cloud-vm-cluster delete

Delete a CloudVmCluster.

az oracle-database cloud-vm-cluster delete [--cloudvmclustername --name]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete VM Cluster

az oracle-database cloud-vm-cluster delete --name <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.

--cloudvmclustername --name -n

CloudVmCluster 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 cloud-vm-cluster list

List CloudVmCluster resources by subscription ID.

az oracle-database cloud-vm-cluster list [--max-items]
                                         [--next-token]
                                         [--resource-group]

Examples

List Vm Clusters

az oracle-database cloud-vm-cluster 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 cloud-vm-cluster remove-vm

Remove VMs from the VM Cluster.

az oracle-database cloud-vm-cluster remove-vm --db-servers
                                              [--cloudvmclustername]
                                              [--ids]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]

Examples

Remove VM from Cluster

az oracle-database cloud-vm-cluster remove-vm --cloudvmclustername <vmclustername> --resource-group <Resource group> --db-servers ['ocid1','ocid2']

Required Parameters

--db-servers

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

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.

--cloudvmclustername

CloudVmCluster 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
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 cloud-vm-cluster show

Get a CloudVmCluster.

az oracle-database cloud-vm-cluster show [--cloudvmclustername --name]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Examples

Get a VM Cluster

az oracle-database cloud-vm-cluster show --cloudvmclustername <vmclustername> --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.

--cloudvmclustername --name -n

CloudVmCluster 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 cloud-vm-cluster update

Update a CloudVmCluster.

az oracle-database cloud-vm-cluster update [--add]
                                           [--cloudvmclustername --name]
                                           [--collection-options --data-collection-options]
                                           [--compute-nodes]
                                           [--cpu-core-count]
                                           [--data-storage-size-in-tbs --storage-tbs]
                                           [--db-node-storage-size-in-gbs --node-storage-gbs]
                                           [--display-name]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--license-model {BringYourOwnLicense, LicenseIncluded}]
                                           [--memory-size-in-gbs]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ocpu-count]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--ssh-public-keys]
                                           [--storage-size-in-gbs]
                                           [--subscription]
                                           [--tags]

Examples

Update VM Cluster

az oracle-database cloud-vm-cluster update --cloudvmclustername <vmclustername> --resource-group <Resource group> --tags {tagv1:tagk1}

Optional Parameters

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

--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
--cloudvmclustername --name -n

CloudVmCluster name.

Property Value
Parameter group: Resource Id Arguments
--collection-options --data-collection-options

Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

The list of compute servers to be added to the cloud VM cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--cpu-core-count

The number of CPU cores enabled on the cloud VM cluster.

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

The data disk group size to be allocated in TBs.

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

The local node storage to be allocated in GBs.

Property Value
Parameter group: Properties Arguments
--display-name

Display Name.

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
--license-model

The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.

Property Value
Parameter group: Properties Arguments
Accepted values: BringYourOwnLicense, LicenseIncluded
--memory-size-in-gbs

The memory to be allocated in GBs.

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
--ocpu-count

The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.

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
--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
--ssh-public-keys

The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

The data disk group size to be allocated in GBs per VM.

Property Value
Parameter group: Properties 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
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 cloud-vm-cluster wait

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

az oracle-database cloud-vm-cluster wait [--cloudvmclustername --name]
                                         [--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.

--cloudvmclustername --name -n

CloudVmCluster 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