Az.CosmosDB

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

This is a prerelease version of Az.CosmosDB.

Installation Options

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

Install-Module -Name Az.CosmosDB -AllowPrerelease

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

Install-PSResource -Name Az.CosmosDB -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 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-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-AzCosmosDBTableRestorableResource Get-AzCosmosDBTableBackupInformation New-AzCosmosDBGremlinDatabaseToRestore New-AzCosmosDBTableToRestore 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

PSEditions

Core Desktop

Dependencies

Release Notes

* Added capability to provide Min/Max Throughput RU Consumption
* Added SecuredByPerimeter value to PublicNetworkAccess enum
* Added Default Priority Level and Priority Based Execution enablement features
* Locations show response now includes status, isSubscriptionRegionAccessAllowedForRegular and isSubscriptionRegionAccessAllowedForAz properties
* Added new paramater 'MinimalTlsVersion' to 'Update-AzCosmosDBAccount' and 'New-AzCosmosDBAccount'.
* Added new property 'CustomerManagedKeyStatus' to 'Get-AzCosmosDBAccount'.
* Added new parameter 'EnablePartitionMerge' to 'Update-AzCosmosDBAccount' and 'New-AzCosmosDBAccount'.
* Added new parameter 'EnablePerRegionPerPartitionAutoscale' to 'Update-AzCosmosDBAccount' and 'New-AzCosmosDBAccount'.
* Added new parameter 'DisableTtl' to 'Restore-AzCosmosDBAccount'.

FileList

Version History

Version Downloads Last updated
2.0.6-preview (current version) 2,701 3/15/2024
2.0.5-preview 2,985 5/10/2023
2.0.4-preview 84 4/13/2023
2.0.3-preview 806 10/13/2022
2.0.2-preview 2,990 5/24/2022
2.0.1-preview 1,118 2/23/2021
2.0.0-preview 497 1/29/2021
1.15.0 8,000,345 10/8/2024
1.14.5 2,932,508 9/3/2024
1.14.4 3,740,073 7/9/2024
1.14.3 4,684,517 5/21/2024
1.14.2 3,435,406 4/2/2024
1.14.1 1,779,349 3/5/2024
1.14.0 3,383,284 1/9/2024
1.13.0 2,838,522 11/14/2023
1.12.0 5,356,836 9/5/2023
1.11.2 1,449,272 8/1/2023
1.11.1 1,208,955 7/4/2023
1.11.0 1,597,248 5/23/2023
1.10.1 2,357,487 4/25/2023
1.10.0 899,742 4/4/2023
1.9.1 1,185,444 3/9/2023
1.9.0 4,479,226 12/6/2022
1.8.2 6,436,242 7/5/2022
1.8.1 6,461 6/17/2022
1.8.0 4,048,898 5/24/2022
1.7.0 4,567,709 4/5/2022
1.6.0-preview 392 3/3/2022
1.5.1 2,027,906 1/4/2022
1.5.0 529,874 12/7/2021
1.4.0 2,219,384 11/2/2021
1.3.1 1,335,739 8/27/2021
1.3.0 1,284,038 7/6/2021
1.2.0 834,138 5/25/2021
1.1.0 4,904,810 3/2/2021
1.0.0 2,580,884 1/19/2021
0.2.0 56,494 9/22/2020
0.1.6 110,698 6/23/2020
0.1.5 7,516 5/19/2020
0.1.4 14,267 4/21/2020
0.1.3 1,834 3/31/2020
0.1.2 12,363 3/19/2020
Show more