az cosmosdb
Manage Azure Cosmos DB database accounts.
Commands
az cosmosdb cassandra |
Manage Cassandra resources of Azure Cosmos DB account. |
az cosmosdb cassandra keyspace |
Manage Azure Cosmos DB Cassandra keyspaces. |
az cosmosdb cassandra keyspace create |
Create an Cassandra keyspace under an Azure Cosmos DB account. |
az cosmosdb cassandra keyspace delete |
Delete the Cassandra keyspace under an Azure Cosmos DB account. |
az cosmosdb cassandra keyspace exists |
Checks if an Azure Cosmos DB Cassandra keyspace exists. |
az cosmosdb cassandra keyspace list |
List the Cassandra keyspaces under an Azure Cosmos DB account. |
az cosmosdb cassandra keyspace show |
Show the details of a Cassandra keyspace under an Azure Cosmos DB account. |
az cosmosdb cassandra keyspace throughput |
Manage throughput of Cassandra keyspace under an Azure Cosmos DB account. |
az cosmosdb cassandra keyspace throughput migrate |
Migrate the throughput of the Cassandra keyspace between autoscale and manually provisioned. |
az cosmosdb cassandra keyspace throughput show |
Get the throughput of the Cassandra keyspace under an Azure Cosmos DB account. |
az cosmosdb cassandra keyspace throughput update |
Update the throughput of the Cassandra keyspace under an Azure Cosmos DB account. |
az cosmosdb cassandra table |
Manage Azure Cosmos DB Cassandra tables. |
az cosmosdb cassandra table create |
Create an Cassandra table under an Azure Cosmos DB Cassandra keyspace. |
az cosmosdb cassandra table delete |
Delete the Cassandra table under an Azure Cosmos DB Cassandra keyspace. |
az cosmosdb cassandra table exists |
Checks if an Azure Cosmos DB Cassandra table exists. |
az cosmosdb cassandra table list |
List the Cassandra tables under an Azure Cosmos DB Cassandra keyspace. |
az cosmosdb cassandra table show |
Show the details of a Cassandra table under an Azure Cosmos DB Cassandra keyspace. |
az cosmosdb cassandra table throughput |
Manage throughput of Cassandra table under an Azure Cosmos DB account. |
az cosmosdb cassandra table throughput migrate |
Migrate the throughput of the Cassandra table between autoscale and manually provisioned. |
az cosmosdb cassandra table throughput show |
Get the throughput of the Cassandra table under an Azure Cosmos DB Cassandra keyspace. |
az cosmosdb cassandra table throughput update |
Update the throughput of the Cassandra table under an Azure Cosmos DB Cassandra keyspace. |
az cosmosdb cassandra table update |
Update an Cassandra table under an Azure Cosmos DB Cassandra keyspace. |
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 dts |
Manage data transfer job with cosmosdb. |
az cosmosdb dts cancel |
Cancels a Data Transfer Job. |
az cosmosdb dts copy |
Creates a Data Transfer Copy Job. |
az cosmosdb dts list |
Get a list of Data Transfer Jobs. |
az cosmosdb dts pause |
Pause a Data Transfer Job. |
az cosmosdb dts resume |
Resumes a Data Transfer Job. |
az cosmosdb dts show |
Get a Data Transfer Job. |
az cosmosdb failover-priority-change |
Changes the failover priority for the Azure Cosmos DB database account. |
az cosmosdb gremlin |
Manage Gremlin resources of Azure Cosmos DB account. |
az cosmosdb gremlin database |
Manage Azure Cosmos DB Gremlin databases. |
az cosmosdb gremlin database create |
Create an Gremlin database under an Azure Cosmos DB account. |
az cosmosdb gremlin database delete |
Delete the Gremlin database under an Azure Cosmos DB account. |
az cosmosdb gremlin database exists |
Checks if an Azure Cosmos DB Gremlin database exists. |
az cosmosdb gremlin database list |
List the Gremlin databases under an Azure Cosmos DB account. |
az cosmosdb gremlin database restore |
Restore a deleted gremlin database within the same account. |
az cosmosdb gremlin database show |
Show the details of a Gremlin database under an Azure Cosmos DB account. |
az cosmosdb gremlin database throughput |
Manage throughput of Gremlin database under an Azure Cosmos DB account. |
az cosmosdb gremlin database throughput migrate |
Migrate the throughput of the Gremlin database between autoscale and manually provisioned. |
az cosmosdb gremlin database throughput show |
Get the throughput of the Gremlin database under an Azure Cosmos DB account. |
az cosmosdb gremlin database throughput update |
Update the throughput of the Gremlin database under an Azure Cosmos DB account. |
az cosmosdb gremlin graph |
Manage Azure Cosmos DB Gremlin graphs. |
az cosmosdb gremlin graph create |
Create an Gremlin graph under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin graph delete |
Delete the Gremlin graph under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin graph exists |
Checks if an Azure Cosmos DB Gremlin graph exists. |
az cosmosdb gremlin graph list |
List the Gremlin graphs under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin graph restore |
Restore a deleted gremlin graph within the same account. |
az cosmosdb gremlin graph show |
Show the details of a Gremlin graph under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin graph throughput |
Manage throughput of Gremlin graph under an Azure Cosmos DB account. |
az cosmosdb gremlin graph throughput migrate |
Migrate the throughput of the Gremlin Graph between autoscale and manually provisioned. |
az cosmosdb gremlin graph throughput show |
Get the throughput of the Gremlin graph under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin graph throughput update |
Update the throughput of the Gremlin graph under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin graph update |
Update an Gremlin graph under an Azure Cosmos DB Gremlin database. |
az cosmosdb gremlin restorable-database |
Manage different versions of gremlin databases that are restorable in a Azure Cosmos DB account. |
az cosmosdb gremlin restorable-database list |
List all the versions of all the gremlin databases that were created / modified / deleted in the given restorable account. |
az cosmosdb gremlin restorable-graph |
Manage different versions of gremlin graphs that are restorable in a database of a Azure Cosmos DB account. |
az cosmosdb gremlin restorable-graph list |
List all the versions of all the gremlin graphs that were created / modified / deleted in the given database and restorable account. |
az cosmosdb gremlin restorable-resource |
Manage the databases and its graphs that can be restored in the given account at the given timestamp and region. |
az cosmosdb gremlin restorable-resource list |
List all the databases and its graphs that can be restored in the given account at the given timestamp and region. |
az cosmosdb gremlin retrieve-latest-backup-time |
Retrieves latest restorable timestamp for the given gremlin graph in given region. |
az cosmosdb identity |
Manage Azure Cosmos DB managed service identities. |
az cosmosdb identity assign |
Assign SystemAssigned identity for a Azure Cosmos DB database account. |
az cosmosdb identity remove |
Remove SystemAssigned identity for a Azure Cosmos DB database account. |
az cosmosdb identity show |
Show the identities for a Azure Cosmos DB database account. |
az cosmosdb keys |
Manage Azure Cosmos DB keys. |
az cosmosdb keys list |
List the access keys or connection strings for a Azure Cosmos DB database account. |
az cosmosdb keys regenerate |
Regenerate an access key for a 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 locations |
Manage Azure Cosmos DB location properties. |
az cosmosdb locations list |
Retrieves the list of cosmosdb locations and their properties. |
az cosmosdb locations show |
Show the Azure Cosmos DB location properties in the given location. |
az cosmosdb mongocluster |
Mongo cluster. |
az cosmosdb mongocluster create |
Create a Mongo cluster. |
az cosmosdb mongocluster delete |
Delete a Mongo Cluster Resource. |
az cosmosdb mongocluster firewall |
Mongo cluster firewall. |
az cosmosdb mongocluster firewall rule |
Mongo cluster firewall rule. |
az cosmosdb mongocluster firewall rule create |
Create a Mongo cluster firewall rule. |
az cosmosdb mongocluster firewall rule delete |
Delete a Mongo cluster firewall rule. |
az cosmosdb mongocluster firewall rule list |
Lists firewall rule on a Mongo cluster. |
az cosmosdb mongocluster firewall rule show |
Get a Mongo cluster firewall rule. |
az cosmosdb mongocluster firewall rule update |
Create a Mongo cluster firewall rule. |
az cosmosdb mongocluster list |
List a Mongo Cluster Resource. |
az cosmosdb mongocluster show |
Get a Mongo Cluster Resource. |
az cosmosdb mongocluster update |
Update a Mongo cluster. |
az cosmosdb mongodb |
Manage MongoDB resources of Azure Cosmos DB account. |
az cosmosdb mongodb collection |
Manage Azure Cosmos DB MongoDB collections. |
az cosmosdb mongodb collection create |
Create an MongoDB collection under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb collection delete |
Delete the MongoDB collection under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb collection exists |
Checks if an Azure Cosmos DB MongoDB collection exists. |
az cosmosdb mongodb collection list |
List the MongoDB collections under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb collection merge |
Merges the partitions of a mongodb collection. |
az cosmosdb mongodb collection redistribute-partition-throughput |
Redistributes the partition throughput of a mongodb collection. |
az cosmosdb mongodb collection restore |
Restore a deleted mongodb collection within the same account. |
az cosmosdb mongodb collection retrieve-partition-throughput |
Retrieve the partition throughput of a mongodb collection. |
az cosmosdb mongodb collection show |
Show the details of a MongoDB collection under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb collection throughput |
Manage throughput of MongoDB collection under an Azure Cosmos DB account. |
az cosmosdb mongodb collection throughput migrate |
Migrate the throughput of the MongoDB collection between autoscale and manually provisioned. |
az cosmosdb mongodb collection throughput show |
Get the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb collection throughput update |
Update the throughput of the MongoDB collection under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb collection update |
Update an MongoDB collection under an Azure Cosmos DB MongoDB database. |
az cosmosdb mongodb database |
Manage Azure Cosmos DB MongoDB databases. |
az cosmosdb mongodb database create |
Create an MongoDB database under an Azure Cosmos DB account. |
az cosmosdb mongodb database delete |
Delete the MongoDB database under an Azure Cosmos DB account. |
az cosmosdb mongodb database exists |
Checks if an Azure Cosmos DB MongoDB database exists. |
az cosmosdb mongodb database list |
List the MongoDB databases under an Azure Cosmos DB account. |
az cosmosdb mongodb database restore |
Restore a deleted mongodb database within the same account. |
az cosmosdb mongodb database show |
Show the details of a MongoDB database under an Azure Cosmos DB account. |
az cosmosdb mongodb database throughput |
Manage throughput of MongoDB database under an Azure Cosmos DB account. |
az cosmosdb mongodb database throughput migrate |
Migrate the throughput of the MongoDB database between autoscale and manually provisioned. |
az cosmosdb mongodb database throughput show |
Get the throughput of the MongoDB database under an Azure Cosmos DB account. |
az cosmosdb mongodb database throughput update |
Update the throughput of the MongoDB database under an Azure Cosmos DB account. |
az cosmosdb mongodb restorable-collection |
Manage different versions of mongodb collections that are restorable in a database of a Azure Cosmos DB account. |
az cosmosdb mongodb restorable-collection list |
List all the versions of all the mongodb collections that were created / modified / deleted in the given database and restorable account. |
az cosmosdb mongodb restorable-database |
Manage different versions of mongodb databases that are restorable in a Azure Cosmos DB account. |
az cosmosdb mongodb restorable-database list |
List all the versions of all the mongodb databases that were created / modified / deleted in the given restorable account. |
az cosmosdb mongodb restorable-resource |
Manage the databases and its collections that can be restored in the given account at the given timesamp and region. |
az cosmosdb mongodb restorable-resource list |
List all the databases and its collections that can be restored in the given account at the given timesamp and region. |
az cosmosdb mongodb retrieve-latest-backup-time |
Retrieves latest restorable timestamp for the given mongodb collection in given region. |
az cosmosdb mongodb role |
Manage Azure Cosmos DB Mongo role resources. |
az cosmosdb mongodb role definition |
Manage Azure Cosmos DB Mongo role definitions. |
az cosmosdb mongodb role definition create |
Create a Mongo DB role definition under an Azure Cosmos DB account. |
az cosmosdb mongodb role definition delete |
Delete a CosmosDb MongoDb role definition under an Azure Cosmos DB account. |
az cosmosdb mongodb role definition exists |
Check if an Azure Cosmos DB MongoDb role definition exists. |
az cosmosdb mongodb role definition list |
List all MongoDb role definitions under an Azure Cosmos DB account. |
az cosmosdb mongodb role definition show |
Show the properties of a MongoDb role definition under an Azure Cosmos DB account. |
az cosmosdb mongodb role definition update |
Update a MongoDb role definition under an Azure Cosmos DB account. |
az cosmosdb mongodb user |
Manage Azure Cosmos DB Mongo user resources. |
az cosmosdb mongodb user definition |
Manage Azure Cosmos DB Mongo user definitions. |
az cosmosdb mongodb user definition create |
Create a Mongo DB user definition under an Azure Cosmos DB account. |
az cosmosdb mongodb user definition delete |
Delete a CosmosDb MongoDb user definition under an Azure Cosmos DB account. |
az cosmosdb mongodb user definition exists |
Check if an Azure Cosmos DB MongoDb user definition exists. |
az cosmosdb mongodb user definition list |
List all MongoDb user definitions under an Azure Cosmos DB account. |
az cosmosdb mongodb user definition show |
Show the properties of a MongoDb user definition under an Azure Cosmos DB account. |
az cosmosdb mongodb user definition update |
Update a MongoDb user definition under an Azure Cosmos DB account. |
az cosmosdb network-rule |
Manage Azure Cosmos 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 |
Remove a virtual network rule from an existing Cosmos DB database account. |
az cosmosdb private-endpoint-connection |
Manage Azure Cosmos DB private endpoint connections. |
az cosmosdb private-endpoint-connection approve |
Approve the specified private endpoint connection associated with Azure Cosmos DB. |
az cosmosdb private-endpoint-connection delete |
Delete the specified private endpoint connection associated with Azure Cosmos DB. |
az cosmosdb private-endpoint-connection reject |
Reject the specified private endpoint connection associated with Azure Cosmos DB. |
az cosmosdb private-endpoint-connection show |
Show details of a private endpoint connection associated with Azure Cosmos DB. |
az cosmosdb private-link-resource |
Manage Azure Cosmos DB private link resources. |
az cosmosdb private-link-resource list |
List the private link resources supported for Azure Cosmos DB. |
az cosmosdb regenerate-key |
Regenerate an access key for a Azure Cosmos DB database account. |
az cosmosdb restorable-database-account |
Manage restorable Azure Cosmos DB accounts. |
az cosmosdb restorable-database-account list |
List all the database accounts that can be restored. |
az cosmosdb restorable-database-account show |
Show the details of a database account that can be restored. |
az cosmosdb restore |
Create a new Azure Cosmos DB database account by restoring from an existing database account. |
az cosmosdb service |
Commands to perform operations on Service. |
az cosmosdb service create |
Create a cosmosdb service resource. |
az cosmosdb service delete |
Delete the given cosmosdb service resource. |
az cosmosdb service list |
List all cosmosdb service resource under an account. |
az cosmosdb service show |
Get cosmosdb service resource under an account. |
az cosmosdb service update |
Update a cosmosdb service resource. |
az cosmosdb show |
Get the details of an Azure Cosmos DB database account. |
az cosmosdb sql |
Manage SQL resources of Azure Cosmos DB account. |
az cosmosdb sql container |
Manage Azure Cosmos DB SQL containers. |
az cosmosdb sql container create |
Create an SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container delete |
Delete the SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container exists |
Checks if an Azure Cosmos DB SQL container exists. |
az cosmosdb sql container list |
List the SQL containers under an Azure Cosmos DB SQL database. |
az cosmosdb sql container merge |
Merges the partitions of a sql container. |
az cosmosdb sql container redistribute-partition-throughput |
Redistributes the partition throughput of a sql container. |
az cosmosdb sql container restore |
Restore a deleted sql container within the same account. |
az cosmosdb sql container retrieve-partition-throughput |
Retrieve the partition throughput of a sql container. |
az cosmosdb sql container show |
Show the details of a SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container throughput |
Manage throughput of SQL container under an Azure Cosmos DB account. |
az cosmosdb sql container throughput migrate |
Migrate the throughput of the SQL container between autoscale and manually provisioned. |
az cosmosdb sql container throughput show |
Get the throughput of the SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container throughput update |
Update the throughput of the SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql container update |
Update an SQL container under an Azure Cosmos DB SQL database. |
az cosmosdb sql database |
Manage Azure Cosmos DB SQL databases. |
az cosmosdb sql database create |
Create an SQL database under an Azure Cosmos DB account. |
az cosmosdb sql database delete |
Delete the SQL database under an Azure Cosmos DB account. |
az cosmosdb sql database exists |
Checks if an Azure Cosmos DB SQL database exists. |
az cosmosdb sql database list |
List the SQL databases under an Azure Cosmos DB account. |
az cosmosdb sql database restore |
Restore a deleted sql database within the same account. |
az cosmosdb sql database show |
Show the details of a SQL database under an Azure Cosmos DB account. |
az cosmosdb sql database throughput |
Manage throughput of SQL database under an Azure Cosmos DB account. |
az cosmosdb sql database throughput migrate |
Migrate the throughput of the SQL database between autoscale and manually provisioned. |
az cosmosdb sql database throughput show |
Get the throughput of the SQL database under an Azure Cosmos DB account. |
az cosmosdb sql database throughput update |
Update the throughput of the SQL database under an Azure Cosmos DB account. |
az cosmosdb sql restorable-container |
Manage different versions of sql containers that are restorable in a database of a Azure Cosmos DB account. |
az cosmosdb sql restorable-container list |
List all the versions of all the sql containers that were created / modified / deleted in the given database and restorable account. |
az cosmosdb sql restorable-database |
Manage different versions of sql databases that are restorable in a Azure Cosmos DB account. |
az cosmosdb sql restorable-database list |
List all the versions of all the sql databases that were created / modified / deleted in the given restorable account. |
az cosmosdb sql restorable-resource |
Manage the databases and its containers that can be restored in the given account at the given timesamp and region. |
az cosmosdb sql restorable-resource list |
List all the databases and its containers that can be restored in the given account at the given timesamp and region. |
az cosmosdb sql retrieve-latest-backup-time |
Retrieves latest restorable timestamp for the given sql container in given region. |
az cosmosdb sql role |
Manage Azure Cosmos DB SQL role resources. |
az cosmosdb sql role assignment |
Manage Azure Cosmos DB SQL role assignments. |
az cosmosdb sql role assignment create |
Create a SQL role assignment under an Azure Cosmos DB account. |
az cosmosdb sql role assignment delete |
Delete a SQL role assignment under an Azure Cosmos DB account. |
az cosmosdb sql role assignment exists |
Check if an Azure Cosmos DB role assignment exists. |
az cosmosdb sql role assignment list |
List all SQL role assignments under an Azure Cosmos DB account. |
az cosmosdb sql role assignment show |
Show the properties of a SQL role assignment under an Azure Cosmos DB account. |
az cosmosdb sql role assignment update |
Update a SQL role assignment under an Azure Cosmos DB account. |
az cosmosdb sql role assignment wait |
Poll on a SQL role assignment until a specific condition is met. |
az cosmosdb sql role definition |
Manage Azure Cosmos DB SQL role definitions. |
az cosmosdb sql role definition create |
Create a SQL role definition under an Azure Cosmos DB account. |
az cosmosdb sql role definition delete |
Delete a SQL role definition under an Azure Cosmos DB account. |
az cosmosdb sql role definition exists |
Check if an Azure Cosmos DB role definition exists. |
az cosmosdb sql role definition list |
List all SQL role definitions under an Azure Cosmos DB account. |
az cosmosdb sql role definition show |
Show the properties of a SQL role definition under an Azure Cosmos DB account. |
az cosmosdb sql role definition update |
Update a SQL role definition under an Azure Cosmos DB account. |
az cosmosdb sql role definition wait |
Poll on a SQL role definition until a specific condition is met. |
az cosmosdb sql stored-procedure |
Manage Azure Cosmos DB SQL stored procedures. |
az cosmosdb sql stored-procedure create |
Create an SQL stored procedure under an Azure Cosmos DB SQL container. |
az cosmosdb sql stored-procedure delete |
Delete the SQL stored procedure under an Azure Cosmos DB SQL container. |
az cosmosdb sql stored-procedure list |
List the SQL stored procedures under an Azure Cosmos DB SQL container. |
az cosmosdb sql stored-procedure show |
Show the details of a SQL stored procedure under an Azure Cosmos DB SQL container. |
az cosmosdb sql stored-procedure update |
Creates or Updates an Azure Cosmos DB SQL stored procedure. |
az cosmosdb sql trigger |
Manage Azure Cosmos DB SQL triggers. |
az cosmosdb sql trigger create |
Create an SQL trigger under an Azure Cosmos DB SQL container. |
az cosmosdb sql trigger delete |
Delete the SQL trigger under an Azure Cosmos DB SQL container. |
az cosmosdb sql trigger list |
List the SQL triggers under an Azure Cosmos DB SQL container. |
az cosmosdb sql trigger show |
Show the details of a SQL trigger under an Azure Cosmos DB SQL container. |
az cosmosdb sql trigger update |
Updates an Azure Cosmos DB SQL trigger. |
az cosmosdb sql user-defined-function |
Manage Azure Cosmos DB SQL user defined functions. |
az cosmosdb sql user-defined-function create |
Create an SQL user defined function under an Azure Cosmos DB SQL container. |
az cosmosdb sql user-defined-function delete |
Delete the SQL user defined function under an Azure Cosmos DB SQL container. |
az cosmosdb sql user-defined-function list |
List the SQL user defined functions under an Azure Cosmos DB SQL container. |
az cosmosdb sql user-defined-function show |
Show the details of a SQL user defined function under an Azure Cosmos DB SQL container. |
az cosmosdb sql user-defined-function update |
Creates or Updates an Azure Cosmos DB SQL user defined function. |
az cosmosdb table |
Manage Table resources of Azure Cosmos DB account. |
az cosmosdb table create |
Create an Table under an Azure Cosmos DB account. |
az cosmosdb table delete |
Delete the Table under an Azure Cosmos DB account. |
az cosmosdb table exists |
Checks if an Azure Cosmos DB table exists. |
az cosmosdb table list |
List the Tables under an Azure Cosmos DB account. |
az cosmosdb table restorable-resource |
Manage the tables that can be restored in the given account at the given timestamp and region. |
az cosmosdb table restorable-resource list |
List all the tables that can be restored in the given account at the given timestamp and region. |
az cosmosdb table restorable-table |
Manage different versions of tables that are restorable in Azure Cosmos DB account. |
az cosmosdb table restorable-table list |
List all the versions of all the tables that were created / modified / deleted in the given restorable account. |
az cosmosdb table restore |
Restore a deleted table within the same account. |
az cosmosdb table retrieve-latest-backup-time |
Retrieves latest restorable timestamp for the given table in given region. |
az cosmosdb table show |
Show the details of a Table under an Azure Cosmos DB account. |
az cosmosdb table throughput |
Manage throughput of Table under an Azure Cosmos DB account. |
az cosmosdb table throughput migrate |
Migrate the throughput of the Table between autoscale and manually provisioned. |
az cosmosdb table throughput show |
Get the throughput of the Table under an Azure Cosmos DB account. |
az cosmosdb table throughput update |
Update the throughput of the Table under an Azure Cosmos DB account. |
az cosmosdb update |
Update an Azure Cosmos DB database account. |
az cosmosdb check-name-exists
Checks if an Azure Cosmos DB account name exists.
az cosmosdb check-name-exists [--ids]
[--name]
[--subscription]
Examples
Checks if an Azure Cosmos DB account name exists. (autogenerated)
az cosmosdb check-name-exists --name MyCosmosDBDatabaseAccount
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb create
Creates a new Azure Cosmos DB database account.
az cosmosdb create --name
--resource-group
[--analytical-storage-schema-type {FullFidelity, WellDefined}]
[--assign-identity]
[--backup-interval]
[--backup-policy-type {Continuous, Periodic}]
[--backup-redundancy {Geo, Local, Zone}]
[--backup-retention]
[--capabilities]
[--continuous-tier {Continuous30Days, Continuous7Days}]
[--databases-to-restore]
[--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
[--default-identity]
[--disable-key-based-metadata-write-access {false, true}]
[--enable-analytical-storage {false, true}]
[--enable-automatic-failover {false, true}]
[--enable-free-tier {false, true}]
[--enable-multiple-write-locations {false, true}]
[--enable-partition-merge {false, true}]
[--enable-virtual-network {false, true}]
[--gremlin-databases-to-restore]
[--ip-range-filter]
[--is-restore-request {false, true}]
[--key-uri]
[--kind {GlobalDocumentDB, MongoDB, Parse}]
[--locations]
[--max-interval]
[--max-staleness-prefix]
[--network-acl-bypass {AzureServices, None}]
[--network-acl-bypass-resource-ids]
[--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
[--restore-source]
[--restore-timestamp]
[--server-version {3.2, 3.6, 4.0, 4.2}]
[--tables-to-restore]
[--tags]
[--virtual-network-rules]
Examples
Creates a new Azure Cosmos DB database account. (autogenerated)
az cosmosdb create --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription
Creates a new Azure Cosmos DB database account with two regions. UK South is zone redundant.
az cosmosdb create -n myaccount -g mygroup --locations regionName=eastus failoverPriority=0 isZoneRedundant=False --locations regionName=uksouth failoverPriority=1 isZoneRedundant=True --enable-multiple-write-locations --network-acl-bypass AzureServices --network-acl-bypass-resource-ids /subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Synapse/workspaces/wsName
Create a new Azure Cosmos DB database account by restoring from an existing account in the given location
az cosmosdb create -n restoredaccount -g mygroup --is-restore-request true --restore-source /subscriptions/2296c272-5d55-40d9-bc05-4d56dc2d7588/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/d056a4f8-044a-436f-80c8-cd3edbc94c68 --restore-timestamp 2020-07-13T16:03:41+0000 --locations regionName=westus failoverPriority=0 isZoneRedundant=False
Required Parameters
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Schema type for analytical storage.
Assign system or user assigned identities separated by spaces. Use '[system]' to refer system assigned identity.
The frequency(in minutes) with which backups are taken (only for accounts with periodic mode backups).
The type of backup policy of the account to create.
The redundancy type of the backup Storage account.
The time(in hours) for which each backup is retained (only for accounts with periodic mode backups).
Set custom capabilities on the Cosmos DB database account.
The tier of Continuous backup.
Add a database and its collection names to restore.
Default consistency level of the Cosmos DB database account.
The primary identity to access key vault in CMK related features. e.g. 'FirstPartyIdentity', 'SystemAssignedIdentity' and more. User-assigned identities are specified in format 'UserAssignedIdentity='.
Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Flag to enable log storage on the account.
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.
If enabled the account is free-tier.
Enable Multiple Write Locations.
Flag to enable partition merge on the account.
Enables virtual network on the Cosmos DB database account.
Add a gremlin database and its graph names to restore.
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.
Restore from an existing/deleted account.
The URI of the key vault.
The type of Cosmos DB database account to create.
Add a location to the Cosmos DB database account.
When used with Bounded Staleness consistency, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400.
When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. Accepted range for this value is 10 - 2,147,483,647.
Flag to enable or disable Network Acl Bypass.
List of Resource Ids to allow Network Acl Bypass.
Sets public network access in server to either Enabled, Disabled, or SecuredByPerimeter.
The restorable-database-account Id of the source account from which the account has to be restored. Required if --is-restore-request is set to true.
The timestamp to which the account has to be restored to. Required if --is-restore-request is set to true.
Valid only for MongoDB accounts.
Add table names to restore.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
ACL's for virtual network.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb delete
Deletes an Azure Cosmos DB database account.
az cosmosdb delete [--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Examples
Deletes an Azure Cosmos DB database account. (autogenerated)
az cosmosdb delete --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb failover-priority-change
Changes the failover priority for the Azure Cosmos DB database account.
az cosmosdb failover-priority-change --failover-policies
[--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Changes the failover priority for the Azure Cosmos DB database account.
az cosmosdb failover-priority-change --failover-policies southafricanorth=0 westus=8 northeurope=3 --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Required Parameters
Space-separated failover policies in 'regionName=failoverPriority' format. Number of policies must match the number of regions the account is currently replicated. All regionName values must match those of the regions the account is currently replicated. All failoverPriority values must be unique. There must be one failoverPriority value zero (0) specified. All remaining failoverPriority values can be any positive integer and they don't have to be contiguos, neither written in any specific order. E.g eastus=0 westus=1.
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb list
List Azure Cosmos DB database accounts.
az cosmosdb list [--resource-group]
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb list-connection-strings
List the connection strings for a Azure Cosmos DB database account.
az cosmosdb list-connection-strings [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
List the connection strings for a Azure Cosmos DB database account. (autogenerated)
az cosmosdb list-connection-strings --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb list-keys
List the access keys for a Azure Cosmos DB database account.
az cosmosdb list-keys [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
List the access keys for a Azure Cosmos DB database account. (autogenerated)
az cosmosdb list-keys --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb list-read-only-keys
List the read-only access keys for a Azure Cosmos DB database account.
az cosmosdb list-read-only-keys [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
List the read-only access keys for a Azure Cosmos DB database account. (autogenerated)
az cosmosdb list-read-only-keys --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb regenerate-key
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]
Examples
Regenerate an access key for a Azure Cosmos DB database account. (autogenerated)
az cosmosdb regenerate-key --key-kind primary --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Required Parameters
The access key to regenerate.
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb restore
Create a new Azure Cosmos DB database account by restoring from an existing database account.
az cosmosdb restore --account-name
--location
--resource-group
--restore-timestamp
--target-database-account-name
[--databases-to-restore]
[--gremlin-databases-to-restore]
[--tables-to-restore]
Examples
Create a new Azure Cosmos DB database account by restoring from an existing database account.
az cosmosdb restore --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 -g MyResourceGroup --location westus
Create a new Azure Cosmos DB Sql or MongoDB database account by restoring only the selected databases and collections from an existing database account.
az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --databases-to-restore name=MyDB1 collections=collection1 collection2 --databases-to-restore name=MyDB2 collections=collection3 collection4
Create a new Azure Cosmos DB Gremlin database account by restoring only the selected databases or graphs from an existing database account.
az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --gremlin-databases-to-restore name=graphdb1 graphs=graph1 graph2
Create a new Azure Cosmos DB Table database account by restoring only the selected tables from an existing database account.
az cosmosdb restore -g MyResourceGroup --target-database-account-name MyRestoredCosmosDBDatabaseAccount --account-name MySourceAccount --restore-timestamp 2020-07-13T16:03:41+0000 --location westus --tables-to-restore table1,table2
Required Parameters
Name of the source Cosmos DB database account for the restore.
The location of the source account from which restore is triggered. This will also be the write region of the restored account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The timestamp to which the account has to be restored to.
Name of the new target Cosmos DB database account after the restore.
Optional Parameters
Add a database and its collection names to restore.
Add a gremlin database and its graph names to restore.
Add table names to restore.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb show
Get the details of an Azure Cosmos DB database account.
az cosmosdb show [--ids]
[--name]
[--resource-group]
[--subscription]
Examples
Get the details of an Azure Cosmos DB database account. (autogenerated)
az cosmosdb show --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of the Cosmos DB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb update
Update an Azure Cosmos DB database account.
az cosmosdb update [--analytical-storage-schema-type {FullFidelity, WellDefined}]
[--backup-interval]
[--backup-policy-type {Continuous, Periodic}]
[--backup-redundancy {Geo, Local, Zone}]
[--backup-retention]
[--capabilities]
[--continuous-tier {Continuous30Days, Continuous7Days}]
[--default-consistency-level {BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong}]
[--default-identity]
[--disable-key-based-metadata-write-access {false, true}]
[--enable-analytical-storage {false, true}]
[--enable-automatic-failover {false, true}]
[--enable-multiple-write-locations {false, true}]
[--enable-partition-merge {false, true}]
[--enable-virtual-network {false, true}]
[--ids]
[--ip-range-filter]
[--key-uri]
[--locations]
[--max-interval]
[--max-staleness-prefix]
[--name]
[--network-acl-bypass {AzureServices, None}]
[--network-acl-bypass-resource-ids]
[--public-network-access {DISABLED, ENABLED, SECUREDBYPERIMETER}]
[--resource-group]
[--server-version {3.2, 3.6, 4.0, 4.2}]
[--subscription]
[--tags]
[--virtual-network-rules]
Examples
Update an Azure Cosmos DB database account. (autogenerated)
az cosmosdb update --capabilities EnableGremlin --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup
Creates a new Azure Cosmos DB database account with two regions. UK South is zone redundant.
az cosmosdb update -n myaccount -g mygroup --locations regionName=eastus failoverPriority=0 isZoneRedundant=False --locations regionName=uksouth failoverPriority=1 isZoneRedundant=True --enable-multiple-write-locations --network-acl-bypass AzureServices --network-acl-bypass-resource-ids /subscriptions/subId/resourceGroups/rgName/providers/Microsoft.Synapse/workspaces/wsName
Optional Parameters
Schema type for analytical storage.
The frequency(in minutes) with which backups are taken (only for accounts with periodic mode backups).
The type of backup policy of the account to create.
The redundancy type of the backup Storage account.
The time(in hours) for which each backup is retained (only for accounts with periodic mode backups).
Set custom capabilities on the Cosmos DB database account.
The tier of Continuous backup.
Default consistency level of the Cosmos DB database account.
The primary identity to access key vault in CMK related features. e.g. 'FirstPartyIdentity', 'SystemAssignedIdentity' and more. User-assigned identities are specified in format 'UserAssignedIdentity='.
Disable write operations on metadata resources (databases, containers, throughput) via account keys.
Flag to enable log storage on the account.
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.
Enable Multiple Write Locations.
Flag to enable partition merge on the account.
Enables virtual network on the Cosmos DB database account.
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.
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.
The URI of the key vault.
Add a location to the Cosmos DB database account.
When used with Bounded Staleness consistency, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400.
When used with Bounded Staleness consistency, this value represents the number of stale requests tolerated. Accepted range for this value is 10 - 2,147,483,647.
Name of the Cosmos DB database account.
Flag to enable or disable Network Acl Bypass.
List of Resource Ids to allow Network Acl Bypass.
Sets public network access in server to either Enabled, Disabled, or SecuredByPerimeter.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Valid only for MongoDB accounts.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
ACL's for virtual network.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Submit and view feedback for