Az.CosmosDB

1.4.0

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

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 1.4.0

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

Author(s)

Microsoft Corporation

Copyright

Microsoft Corporation. All rights reserved.

Owners

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 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-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

PSEditions

Core Desktop

Dependencies

Release Notes

* Introduced Get-AzCosmosDBMongoDBBackupInformation to retrieve latest backup information for MongoDB.
* Updated New-AzCosmosDBAccount, Update-AzCosmosDBAccount to accept BackupStorageRedundancy
* Introduced Get-AzCosmosDBLocation to list Azure CosmosDB Account and its locations properties.

Version History

Version Downloads Last updated
2.0.1-preview 582 2/23/2021
2.0.0-preview 103 1/29/2021
1.4.0 (current version) 592,140 11/2/2021
1.3.1 1,213,418 8/27/2021
1.3.0 1,059,160 7/6/2021
1.2.0 767,599 5/25/2021
1.1.0 2,336,677 3/2/2021
1.0.0 2,409,103 1/19/2021
0.2.0 35,628 9/22/2020
0.1.6 63,049 6/23/2020
0.1.5 6,656 5/19/2020
0.1.4 13,595 4/21/2020
0.1.3 1,431 3/31/2020
0.1.2 3,851 3/19/2020