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

This is a prerelease version of Az.CosmosDB.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name Az.CosmosDB -RequiredVersion 2.0.0-preview -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name Az.CosmosDB -Version 2.0.0-preview -Prerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

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

Core Desktop

Dependencies

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

Version History

Version Downloads Last updated
2.0.6-preview 31 3/15/2024
2.0.5-preview 1,948 5/10/2023
2.0.4-preview 78 4/13/2023
2.0.3-preview 793 10/13/2022
2.0.2-preview 2,981 5/24/2022
2.0.1-preview 1,109 2/23/2021
2.0.0-preview (current version) 492 1/29/2021
1.14.1 1,402,531 3/5/2024
1.14.0 3,108,909 1/9/2024
1.13.0 2,795,113 11/14/2023
1.12.0 3,672,260 9/5/2023
1.11.2 1,428,798 8/1/2023
1.11.1 1,200,027 7/4/2023
1.11.0 1,590,022 5/23/2023
1.10.1 1,855,536 4/25/2023
1.10.0 884,438 4/4/2023
1.9.1 1,143,232 3/9/2023
1.9.0 3,724,915 12/6/2022
1.8.2 5,963,144 7/5/2022
1.8.1 6,454 6/17/2022
1.8.0 3,867,130 5/24/2022
1.7.0 3,472,183 4/5/2022
1.6.0-preview 389 3/3/2022
1.5.1 1,996,278 1/4/2022
1.5.0 525,834 12/7/2021
1.4.0 1,930,851 11/2/2021
1.3.1 1,325,619 8/27/2021
1.3.0 1,260,965 7/6/2021
1.2.0 821,747 5/25/2021
1.1.0 4,387,227 3/2/2021
1.0.0 2,562,770 1/19/2021
0.2.0 54,374 9/22/2020
0.1.6 106,637 6/23/2020
0.1.5 7,480 5/19/2020
0.1.4 14,262 4/21/2020
0.1.3 1,831 3/31/2020
0.1.2 12,058 3/19/2020
Show less