Az.CosmosDB
2.0.0-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://docs.microsoft.com/azure/cosmos-db/
Minimum PowerShell version
5.1
See the version list below for details.
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 New-AzCosmosDBSqlDatabase Update-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 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 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 New-AzCosmosDBDatabaseToRestore Restore-AzCosmosDBAccount Get-AzCosmosDBRestorableDatabaseAccount Get-AzCosmosDBSqlRestorableDatabase Get-AzCosmosDBSqlRestorableContainer Get-AzCosmosDBSqlRestorableResource Get-AzCosmosDBMongoDBRestorableDatabase Get-AzCosmosDBMongoDBRestorableCollection Get-AzCosmosDBMongoDBRestorableResource New-AzCosmosDBSqlRoleDefinition New-AzCosmosDBSqlRoleAssignment Get-AzCosmosDBSqlRoleDefinition Get-AzCosmosDBSqlRoleAssignment Remove-AzCosmosDBSqlRoleDefinition Remove-AzCosmosDBSqlRoleAssignment Update-AzCosmosDBSqlRoleDefinition Update-AzCosmosDBSqlRoleAssignment New-AzCosmosDBPermission
PSEditions
Dependencies
-
- Az.Accounts (>= 2.2.4)
Release Notes
* This release introduces the cmdlets for the preview features of Continuous Backup(Point in time restore):
- Introduced support for creating accounts with continuous mode backup policy.
- Introduced support for Point in time restore for accounts with continuous mode backup policy.
- Introduced support to update the backup interval and backup retention for accounts with periodic mode backup policy.
- Introduced support to list the restorable resources in a live database account.
- New-AzCosmosBAccount cmdlet is updated with new parameters: IsRestoreReqeust, RestoreSource, RestoreTimestampInUtc, DatabasesToRestore, BackupPolicy.
- Update-AzCosmosDBAccount cmdlet is updated with new parameters: BackupPolicy.
- The following cmdlets are added:
- New-AzCosmosDBRestore, New-AzCosmosDBDatabaseToRestore, Get-AzCosmosDBRestorableDatabaseAccount,
- Get-AzCosmosDBSqlRestorableDatabase, Get-AzCosmosDBSqlRestorableContainer, Get-AzCosmosDBSqlRestorableResource,
- Get-AzCosmosDBMongoDBRestorableDatabase, Get-AzCosmosDBMongoDBRestorableCollection, Get-AzCosmosDBMongoDBRestorableResource.
- Removed the support for throughput Migration. (Please use the stable version of Az.CosmosDB Powershell module if you intend to use this feature).
- Removed AnalyticalStorageTTL from SqlContainer datamodel (Please use the stable version of Az.CosmosDB Powershell module if you intend to use this feature).
* Introduced support for Sql data plane RBAC, allowing the creation, updating, removal, and retrieval of Role Definitions and Role Assignments
- The following cmdlets are added:
- Get-AzCosmosDBSqlRoleDefinition, Get-AzCosmosDBSqlRoleAssignment,
- New-AzCosmosDBSqlRoleDefinition, New-AzCosmosDBSqlRoleAssignment,
- Remove-AzCosmosDBSqlRoleDefinition, Remove-AzCosmosDBSqlRoleAssignment,
- Update-AzCosmosDBSqlRoleDefinition, Update-AzCosmosDBSqlRoleAssignment,
- New-AzCosmosDBSqlPermission
* Please note this is a preview version. The cmdlets introduced here may be changed or removed in a future release.
FileList
- Az.CosmosDB.nuspec
- Az.CosmosDB.format.ps1xml
- Az.CosmosDB.psd1
- Az.CosmosDB.psm1
- CosmosDB.generated.format.ps1xml
- Microsoft.Azure.Management.CosmosDB.dll
- Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.deps.json
- Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll
- Microsoft.Azure.PowerShell.Cmdlets.CosmosDB.dll-Help.xml
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 2.0.8-preview | 717 | 8/26/2025 |
| 2.0.7-preview | 652 | 7/16/2025 |
| 2.0.6-preview | 7,242 | 3/15/2024 |
| 2.0.5-preview | 3,272 | 5/10/2023 |
| 2.0.4-preview | 85 | 4/13/2023 |
| 2.0.3-preview | 807 | 10/13/2022 |
| 2.0.2-preview | 2,992 | 5/24/2022 |
| 2.0.1-preview | 1,119 | 2/23/2021 |
| 2.0.0-preview (current version) | 499 | 1/29/2021 |
| 1.18.2 | 16,685,501 | 8/5/2025 |
| 1.18.1 | 6,303,385 | 7/1/2025 |
| 1.18.0 | 14,708,788 | 3/13/2025 |
| 1.17.0 | 3,288,938 | 3/4/2025 |
| 1.16.0 | 7,053,454 | 1/14/2025 |
| 1.15.0 | 13,383,294 | 10/8/2024 |
| 1.14.5 | 2,976,724 | 9/3/2024 |
| 1.14.4 | 4,684,993 | 7/9/2024 |
| 1.14.3 | 4,799,897 | 5/21/2024 |
| 1.14.2 | 3,714,968 | 4/2/2024 |
| 1.14.1 | 1,900,555 | 3/5/2024 |
| 1.14.0 | 3,578,520 | 1/9/2024 |
| 1.13.0 | 2,900,163 | 11/14/2023 |
| 1.12.0 | 7,387,488 | 9/5/2023 |
| 1.11.2 | 1,459,955 | 8/1/2023 |
| 1.11.1 | 1,210,808 | 7/4/2023 |
| 1.11.0 | 1,616,664 | 5/23/2023 |
| 1.10.1 | 2,650,282 | 4/25/2023 |
| 1.10.0 | 915,357 | 4/4/2023 |
| 1.9.1 | 1,197,777 | 3/9/2023 |
| 1.9.0 | 4,965,429 | 12/6/2022 |
| 1.8.2 | 7,004,330 | 7/5/2022 |
| 1.8.1 | 6,465 | 6/17/2022 |
| 1.8.0 | 4,173,391 | 5/24/2022 |
| 1.7.0 | 4,911,540 | 4/5/2022 |
| 1.6.0-preview | 393 | 3/3/2022 |
| 1.5.1 | 2,057,024 | 1/4/2022 |
| 1.5.0 | 536,629 | 12/7/2021 |
| 1.4.0 | 2,413,657 | 11/2/2021 |
| 1.3.1 | 1,341,399 | 8/27/2021 |
| 1.3.0 | 1,311,521 | 7/6/2021 |
| 1.2.0 | 843,827 | 5/25/2021 |
| 1.1.0 | 5,221,371 | 3/2/2021 |
| 1.0.0 | 2,586,004 | 1/19/2021 |
| 0.2.0 | 56,805 | 9/22/2020 |
| 0.1.6 | 113,435 | 6/23/2020 |
| 0.1.5 | 7,547 | 5/19/2020 |
| 0.1.4 | 14,271 | 4/21/2020 |
| 0.1.3 | 1,837 | 3/31/2020 |
| 0.1.2 | 12,688 | 3/19/2020 |