Az.CosmosDB
2.0.8-preview
Microsoft Azure PowerShell - CosmosDB service cmdlets for Azure Resource Manager in Windows PowerShell and PowerShell Core.
For more information on CosmosDB, please visit the following: https://learn.microsoft.com/azure/cosmos-db/
Minimum PowerShell version
5.1
Installation Options
Owners
Copyright
Microsoft Corporation. All rights reserved.
Package Details
Author(s)
- Microsoft Corporation
Tags
Azure ResourceManager ARM CosmosDB
Cmdlets
Get-AzCosmosDBSqlContainer Get-AzCosmosDBSqlContainerThroughput Get-AzCosmosDBSqlDatabase Get-AzCosmosDBSqlDatabaseThroughput Get-AzCosmosDBSqlStoredProcedure Get-AzCosmosDBSqlTrigger Get-AzCosmosDBSqlUserDefinedFunction New-AzCosmosDBSqlStoredProcedure New-AzCosmosDBSqlTrigger New-AzCosmosDBSqlUserDefinedFunction Update-AzCosmosDBSqlStoredProcedure Update-AzCosmosDBSqlTrigger Update-AzCosmosDBSqlUserDefinedFunction Remove-AzCosmosDBSqlStoredProcedure Remove-AzCosmosDBSqlTrigger Remove-AzCosmosDBSqlUserDefinedFunction New-AzCosmosDBSqlConflictResolutionPolicy New-AzCosmosDBSqlIndexingPolicy New-AzCosmosDBSqlUniqueKey New-AzCosmosDBSqlUniqueKeyPolicy Remove-AzCosmosDBSqlContainer Remove-AzCosmosDBSqlDatabase New-AzCosmosDBSqlContainer Restore-AzCosmosDBSqlDatabase New-AzCosmosDBSqlDatabase Update-AzCosmosDBSqlContainer Restore-AzCosmosDBSqlContainer Update-AzCosmosDBSqlDatabase New-AzCosmosDBAccount Remove-AzCosmosDBAccount Get-AzCosmosDBAccount Get-AzCosmosDBAccountKey New-AzCosmosDBAccountKey Update-AzCosmosDBAccount Update-AzCosmosDBAccountRegion Update-AzCosmosDBAccountFailoverPriority New-AzCosmosDBVirtualNetworkRule New-AzCosmosDBLocationObject New-AzCosmosDBSqlSpatialSpec New-AzCosmosDBSqlCompositePath New-AzCosmosDBSqlIncludedPath New-AzCosmosDBSqlIncludedPathIndex Get-AzCosmosDBGremlinDatabase Get-AzCosmosDBGremlinDatabaseThroughput Get-AzCosmosDBGremlinGraph Get-AzCosmosDBGremlinGraphThroughput Remove-AzCosmosDBGremlinDatabase Remove-AzCosmosDBGremlinGraph New-AzCosmosDBGremlinDatabase New-AzCosmosDBGremlinGraph Update-AzCosmosDBGremlinDatabase Update-AzCosmosDBGremlinGraph Restore-AzCosmosDBGremlinDatabase Restore-AzCosmosDBGremlinGraph New-AzCosmosDBGremlinIndexingPolicy New-AzCosmosDBGremlinUniqueKey New-AzCosmosDBGremlinUniqueKeyPolicy New-AzCosmosDBGremlinSpatialSpec New-AzCosmosDBGremlinCompositePath New-AzCosmosDBGremlinConflictResolutionPolicy New-AzCosmosDBGremlinIncludedPath New-AzCosmosDBGremlinIncludedPathIndex Get-AzCosmosDBTable Get-AzCosmosDBTableThroughput Remove-AzCosmosDBTable New-AzCosmosDBTable Update-AzCosmosDBTable Restore-AzCosmosDBTable Get-AzCosmosDBCassandraKeyspace Get-AzCosmosDBCassandraKeyspaceThroughput Get-AzCosmosDBCassandraTable Get-AzCosmosDBCassandraTableThroughput New-AzCosmosDBCassandraClusterKey New-AzCosmosDBCassandraColumn New-AzCosmosDBCassandraSchema Remove-AzCosmosDBCassandraKeyspace Remove-AzCosmosDBCassandraTable Update-AzCosmosDBCassandraKeyspace Update-AzCosmosDBCassandraTable New-AzCosmosDBCassandraKeyspace New-AzCosmosDBCassandraTable Get-AzCosmosDBMongoDBCollection Get-AzCosmosDBMongoDBCollectionThroughput Get-AzCosmosDBMongoDBDatabase Get-AzCosmosDBMongoDBDatabaseThroughput Remove-AzCosmosDBMongoDBCollection Remove-AzCosmosDBMongoDBDatabase New-AzCosmosDBMongoDBIndex Update-AzCosmosDBSqlContainerThroughput Update-AzCosmosDBSqlDatabaseThroughput Update-AzCosmosDBMongoDBCollectionThroughput Update-AzCosmosDBMongoDBDatabaseThroughput Update-AzCosmosDBGremlinGraphThroughput Update-AzCosmosDBGremlinDatabaseThroughput Update-AzCosmosDBCassandraTableThroughput Update-AzCosmosDBCassandraKeyspaceThroughput Update-AzCosmosDBTableThroughput Update-AzCosmosDBMongoDBCollection Update-AzCosmosDBMongoDBDatabase New-AzCosmosDBMongoDBCollection New-AzCosmosDBMongoDBDatabase Restore-AzCosmosDBMongoDBDatabase Restore-AzCosmosDBMongoDBCollection Invoke-AzCosmosDBSqlContainerThroughputMigration Invoke-AzCosmosDBSqlDatabaseThroughputMigration Invoke-AzCosmosDBMongoDBCollectionThroughputMigration Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration Invoke-AzCosmosDBGremlinGraphThroughputMigration Invoke-AzCosmosDBGremlinDatabaseThroughputMigration Invoke-AzCosmosDBCassandraTableThroughputMigration Invoke-AzCosmosDBCassandraKeyspaceThroughputMigration Invoke-AzCosmosDBTableThroughputMigration New-AzCosmosDBSqlRoleDefinition New-AzCosmosDBSqlRoleAssignment Get-AzCosmosDBSqlRoleDefinition Get-AzCosmosDBSqlRoleAssignment Remove-AzCosmosDBSqlRoleDefinition Remove-AzCosmosDBSqlRoleAssignment Update-AzCosmosDBSqlRoleDefinition Update-AzCosmosDBSqlRoleAssignment New-AzCosmosDBGremlinRoleDefinition New-AzCosmosDBGremlinRoleAssignment Get-AzCosmosDBGremlinRoleDefinition Get-AzCosmosDBGremlinRoleAssignment Remove-AzCosmosDBGremlinRoleDefinition Remove-AzCosmosDBGremlinRoleAssignment Update-AzCosmosDBGremlinRoleDefinition Update-AzCosmosDBGremlinRoleAssignment New-AzCosmosDBCassandraRoleDefinition New-AzCosmosDBCassandraRoleAssignment Get-AzCosmosDBCassandraRoleDefinition Get-AzCosmosDBCassandraRoleAssignment Remove-AzCosmosDBCassandraRoleDefinition Remove-AzCosmosDBCassandraRoleAssignment Update-AzCosmosDBCassandraRoleDefinition Update-AzCosmosDBCassandraRoleAssignment New-AzCosmosDBMongoMIRoleDefinition New-AzCosmosDBMongoMIRoleAssignment Get-AzCosmosDBMongoMIRoleDefinition Get-AzCosmosDBMongoMIRoleAssignment Remove-AzCosmosDBMongoMIRoleDefinition Remove-AzCosmosDBMongoMIRoleAssignment Update-AzCosmosDBMongoMIRoleDefinition Update-AzCosmosDBMongoMIRoleAssignment New-AzCosmosDBPermission New-AzCosmosDBDatabaseToRestore Restore-AzCosmosDBAccount Get-AzCosmosDBRestorableDatabaseAccount Get-AzCosmosDBSqlRestorableDatabase Get-AzCosmosDBSqlRestorableContainer Get-AzCosmosDBSqlRestorableResource Get-AzCosmosDBMongoDBRestorableDatabase Get-AzCosmosDBMongoDBRestorableCollection Get-AzCosmosDBMongoDBRestorableResource Get-AzCosmosDBSqlContainerBackupInformation Get-AzCosmosDBMongoDBCollectionBackupInformation Get-AzCosmosDBLocation New-AzManagedCassandraCluster New-AzManagedCassandraDataCenter Get-AzManagedCassandraCluster Get-AzManagedCassandraDataCenter Remove-AzManagedCassandraCluster Remove-AzManagedCassandraDataCenter Update-AzManagedCassandraCluster Update-AzManagedCassandraDataCenter Get-AzCosmosDbClientEncryptionKey New-AzCosmosDbClientEncryptionKey Update-AzCosmosDbClientEncryptionKey New-AzCosmosDBMongoDBRoleDefinition New-AzCosmosDBMongoDBPrivilegeResource New-AzCosmosDBMongoDBPrivilege New-AzCosmosDBMongoDBRole Remove-AzCosmosDBMongoDBRoleDefinition Update-AzCosmosDBMongoDBRoleDefinition Get-AzCosmosDBMongoDBRoleDefinition New-AzCosmosDBMongoDBUserDefinition Update-AzCosmosDBMongoDBUserDefinition Get-AzCosmosDBMongoDBUserDefinition Remove-AzCosmosDBMongoDBUserDefinition Get-AzCosmosDBService New-AzCosmosDBService Remove-AzCosmosDBService Get-AzCosmosDBGremlinGraphBackupInformation Get-AzCosmosDBGremlinRestorableDatabase Get-AzCosmosDBGremlinRestorableGraph Get-AzCosmosDBGremlinRestorableResource Get-AzCosmosDBTableRestorableTable Get-AzCosmosDBTableRoleAssignment Get-AzCosmosDBTableRoleDefinition Get-AzCosmosDBTableRestorableResource Get-AzCosmosDBTableBackupInformation New-AzCosmosDBGremlinDatabaseToRestore New-AzCosmosDBTableToRestore New-AzCosmosDBTableRoleAssignment New-AzCosmosDBTableRoleDefinition New-AzCosmosDBSqlVectorEmbedding New-AzCosmosDBSqlVectorEmbeddingPolicy New-AzCosmosDBSqlVectorIndex Invoke-AzCosmosDbSqlContainerMerge Invoke-AzCosmosDbMongoDbCollectionMerge Get-AzCosmosDBSqlContainerPerPartitionThroughput Update-AzCosmosDBSqlContainerPerPartitionThroughput Get-AzCosmosDBMongoDBCollectionPerPartitionThroughput Update-AzCosmosDBMongoDBCollectionPerPartitionThroughput Get-AzCosmosDBSqlDatabasePerPartitionThroughput Update-AzCosmosDBSqlDatabasePerPartitionThroughput Get-AzCosmosDBMongoDBDatabasePerPartitionThroughput Update-AzCosmosDBMongoDBDatabasePerPartitionThroughput New-AzCosmosDBPhysicalPartitionThroughputObject Invoke-AzCosmosDbMongoDbDatabaseMerge Invoke-AzCosmosDbSqlDatabaseMerge Remove-AzCosmosDBTableRoleAssignment Remove-AzCosmosDBTableRoleDefinition Update-AzCosmosDBTableRoleAssignment Update-AzCosmosDBTableRoleDefinition New-AzCosmosDBThroughputBucketObject
PSEditions
Dependencies
-
- Az.Accounts (>= 5.2.0)
Release Notes
* Fixed issue where the restore command failed to detect the source account, even when it existed.
* Added support for preserving existing throughput buckets during SQL container throughput updates.
FileList
- Az.CosmosDB.nuspec
- Az.CosmosDB.psd1
- Az.CosmosDB.psm1
- Azure.Security.KeyVault.Keys.dll
- CosmosDB.generated.format.ps1xml
- Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll
- Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml
- Microsoft.Azure.PowerShell.CosmosDB.Management.Sdk.dll
- .signature.p7s
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 2.0.8-preview (current version) | 1,346 | 8/26/2025 |
| 2.0.7-preview | 656 | 7/16/2025 |
| 2.0.6-preview | 7,837 | 3/15/2024 |
| 2.0.5-preview | 3,358 | 5/10/2023 |
| 2.0.4-preview | 86 | 4/13/2023 |
| 2.0.3-preview | 808 | 10/13/2022 |
| 2.0.2-preview | 2,993 | 5/24/2022 |
| 2.0.1-preview | 1,120 | 2/23/2021 |
| 2.0.0-preview | 501 | 1/29/2021 |
| 1.19.1 | 1,481,023 | 1/13/2026 |
| 1.19.0 | 7,715,363 | 12/2/2025 |
| 1.18.3 | 2,791,958 | 11/18/2025 |
| 1.18.2 | 20,463,926 | 8/5/2025 |
| 1.18.1 | 6,319,351 | 7/1/2025 |
| 1.18.0 | 15,089,740 | 3/13/2025 |
| 1.17.0 | 3,396,208 | 3/4/2025 |
| 1.16.0 | 7,090,092 | 1/14/2025 |
| 1.15.0 | 14,200,280 | 10/8/2024 |
| 1.14.5 | 2,983,415 | 9/3/2024 |
| 1.14.4 | 4,926,457 | 7/9/2024 |
| 1.14.3 | 4,821,096 | 5/21/2024 |
| 1.14.2 | 3,785,823 | 4/2/2024 |
| 1.14.1 | 1,949,310 | 3/5/2024 |
| 1.14.0 | 3,598,884 | 1/9/2024 |
| 1.13.0 | 2,927,245 | 11/14/2023 |
| 1.12.0 | 7,881,903 | 9/5/2023 |
| 1.11.2 | 1,460,559 | 8/1/2023 |
| 1.11.1 | 1,211,248 | 7/4/2023 |
| 1.11.0 | 1,618,730 | 5/23/2023 |
| 1.10.1 | 2,705,907 | 4/25/2023 |
| 1.10.0 | 919,040 | 4/4/2023 |
| 1.9.1 | 1,200,231 | 3/9/2023 |
| 1.9.0 | 4,992,410 | 12/6/2022 |
| 1.8.2 | 7,100,402 | 7/5/2022 |
| 1.8.1 | 6,466 | 6/17/2022 |
| 1.8.0 | 4,180,988 | 5/24/2022 |
| 1.7.0 | 4,940,283 | 4/5/2022 |
| 1.6.0-preview | 394 | 3/3/2022 |
| 1.5.1 | 2,063,197 | 1/4/2022 |
| 1.5.0 | 537,518 | 12/7/2021 |
| 1.4.0 | 2,459,544 | 11/2/2021 |
| 1.3.1 | 1,342,448 | 8/27/2021 |
| 1.3.0 | 1,318,359 | 7/6/2021 |
| 1.2.0 | 846,335 | 5/25/2021 |
| 1.1.0 | 5,303,459 | 3/2/2021 |
| 1.0.0 | 2,586,825 | 1/19/2021 |
| 0.2.0 | 56,891 | 9/22/2020 |
| 0.1.6 | 113,871 | 6/23/2020 |
| 0.1.5 | 7,588 | 5/19/2020 |
| 0.1.4 | 14,272 | 4/21/2020 |
| 0.1.3 | 1,838 | 3/31/2020 |
| 0.1.2 | 12,769 | 3/19/2020 |