az cosmosdb

Manage Azure Cosmos DB database accounts.

Commands

az cosmosdb check-name-exists Checks if an Azure Cosmos DB account name exists.
az cosmosdb collection Manage Azure Cosmos DB collections.
az cosmosdb collection create Creates an Azure Cosmos DB collection.
az cosmosdb collection delete Deletes an Azure Cosmos DB collection.
az cosmosdb collection exists Returns a boolean indicating whether the collection exists.
az cosmosdb collection list Lists all Azure Cosmos DB collections.
az cosmosdb collection show Shows an Azure Cosmos DB collection and its offer.
az cosmosdb collection update Updates an Azure Cosmos DB collection.
az cosmosdb create Creates a new Azure Cosmos DB database account.
az cosmosdb database Manage Azure Cosmos DB databases.
az cosmosdb database create Creates an Azure Cosmos DB database.
az cosmosdb database delete Deletes an Azure Cosmos DB database.
az cosmosdb database exists Returns a boolean indicating whether the database exists.
az cosmosdb database list Lists all Azure Cosmos DB databases.
az cosmosdb database show Shows an Azure Cosmos DB database.
az cosmosdb delete Deletes an Azure Cosmos DB database account.
az cosmosdb failover-priority-change Changes the failover priority for the Azure Cosmos DB database account.
az cosmosdb list List Azure Cosmos DB database accounts.
az cosmosdb list-connection-strings List the connection strings for a Azure Cosmos DB database account.
az cosmosdb list-keys List the access keys for a Azure Cosmos DB database account.
az cosmosdb list-read-only-keys List the read-only access keys for a Azure Cosmos DB database account.
az cosmosdb network-rule Manage Azure Comsos DB network rules.
az cosmosdb network-rule add Adds a virtual network rule to an existing Cosmos DB database account.
az cosmosdb network-rule list Lists the virtual network accounts associated with a Cosmos DB account.
az cosmosdb network-rule remove Adds a virtual network rule to an existing Cosmos DB database account.
az cosmosdb regenerate-key Regenerate an access key for a Azure Cosmos DB database account.
az cosmosdb show Get the details of an Azure Cosmos DB database account.
az cosmosdb update Update an Azure Cosmos DB database account.

az cosmosdb check-name-exists

Edit

Checks if an Azure Cosmos DB account name exists.

az cosmosdb check-name-exists [--ids]
                              [--name]
                              [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--subscription

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

az cosmosdb create

Edit

Creates a new Azure Cosmos DB database account.

az cosmosdb create --name
                   --resource-group
                   [--capabilities]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--ip-range-filter]
                   [--kind {GlobalDocumentDB, MongoDB, Parse}]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--subscription]
                   [--tags]
                   [--virtual-network-rules]

Required Parameters

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

Optional Parameters

--capabilities

Set custom capabilities on the Cosmos DB database account.

--default-consistency-level

Default consistency level of the Cosmos DB database account.

accepted values: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong
--enable-automatic-failover

Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

accepted values: false, true
--enable-multiple-write-locations

Enable Multiple Write Locations.

accepted values: false, true
--enable-virtual-network

Enables virtual network on the Cosmos DB database account.

accepted values: false, true
--ip-range-filter

Firewall support. Specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma-separated and must not contain any spaces.

--kind

The type of Cosmos DB database account to create.

accepted values: GlobalDocumentDB, MongoDB, Parse
default value: GlobalDocumentDB
--locations

Space-separated locations in 'regionName=failoverPriority' format. E.g eastus=0 westus=1. Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions. Default: single region account in the location of the specified resource group.

--max-interval

When used with Bounded Staleness consistency, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 1 - 100.

default value: 5
--max-staleness-prefix

When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. Accepted range for this value is 1 - 2,147,483,647.

default value: 100
--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--virtual-network-rules

ACL's for virtual network.

az cosmosdb delete

Edit

Deletes an Azure Cosmos DB database account.

az cosmosdb delete [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb failover-priority-change

Edit

Changes the failover priority for the Azure Cosmos DB database account.

az cosmosdb failover-priority-change --failover-policies
                                     [--ids]
                                     [--name]
                                     [--resource-group]
                                     [--subscription]

Required Parameters

--failover-policies

Space-separated failover policies in 'regionName=failoverPriority' format. E.g eastus=0 westus=1.

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb list

Edit

List Azure Cosmos DB database accounts.

az cosmosdb list [--resource-group]
                 [--subscription]

Optional Parameters

--resource-group -g

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

--subscription

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

az cosmosdb list-connection-strings

Edit

List the connection strings for a Azure Cosmos DB database account.

az cosmosdb list-connection-strings [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb list-keys

Edit

List the access keys for a Azure Cosmos DB database account.

az cosmosdb list-keys [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb list-read-only-keys

Edit

List the read-only access keys for a Azure Cosmos DB database account.

az cosmosdb list-read-only-keys [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb regenerate-key

Edit

Regenerate an access key for a Azure Cosmos DB database account.

az cosmosdb regenerate-key --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Required Parameters

--key-kind

The access key to regenerate.

accepted values: primary, primaryReadonly, secondary, secondaryReadonly

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb show

Edit

Get the details of an Azure Cosmos DB database account.

az cosmosdb show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

Optional Parameters

--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

az cosmosdb update

Edit

Update an Azure Cosmos DB database account.

az cosmosdb update [--capabilities]
                   [--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
                   [--enable-automatic-failover {false, true}]
                   [--enable-multiple-write-locations {false, true}]
                   [--enable-virtual-network {false, true}]
                   [--ids]
                   [--ip-range-filter]
                   [--locations]
                   [--max-interval]
                   [--max-staleness-prefix]
                   [--name]
                   [--resource-group]
                   [--subscription]
                   [--tags]
                   [--virtual-network-rules]

Optional Parameters

--capabilities

Set custom capabilities on the Cosmos DB database account.

--default-consistency-level

Default consistency level of the Cosmos DB database account.

accepted values: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong
--enable-automatic-failover

Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.

accepted values: false, true
--enable-multiple-write-locations

Enable Multiple Write Locations.

accepted values: false, true
--enable-virtual-network

Enables virtual network on the Cosmos DB database account.

accepted values: false, true
--ids

One or more resource IDs (space-delimited). If provided, no other 'Resource Id' arguments should be specified.

--ip-range-filter

Firewall support. Specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma-separated and must not contain any spaces.

--locations

Space-separated locations in 'regionName=failoverPriority' format. E.g eastus=0 westus=1. Failover priority values are 0 for write regions and greater than 0 for read regions. A failover priority value must be unique and less than the total number of regions. Default: single region account in the location of the specified resource group.

--max-interval

When used with Bounded Staleness consistency, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 1 - 100.

--max-staleness-prefix

When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. Accepted range for this value is 1 - 2,147,483,647.

--name -n

Name of the Cosmos DB database account.

--resource-group -g

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

--subscription

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

--tags

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

--virtual-network-rules

ACL's for virtual network.