Invoke-AzCosmosDBMongoDBCollectionThroughputMigration

Use this to migrate autoscale throughput to manual throughput and vice versa.

Syntax

Invoke-AzCosmosDBMongoDBCollectionThroughputMigration
      -DatabaseName <String>
      [-Name <String>]
      -ResourceGroupName <String>
      -AccountName <String>
      -ThroughputType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzCosmosDBMongoDBCollectionThroughputMigration
      [-Name <String>]
      -ParentObject <PSMongoDBDatabaseGetResults>
      -ThroughputType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Invoke-AzCosmosDBMongoDBCollectionThroughputMigration
      [-Name <String>]
      -InputObject <PSMongoDBCollectionGetResults>
      -ThroughputType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

ThroughpyteType paramter defines the throughput to which you want to migrate to.

Examples

Example 1

$NewCollection = New-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -Name myCollectionName -Throughput 700 -DatabaseName myDbName
$AutoscaleThroughput = Invoke-AzCosmosDBMongoDBCollectionThroughputMigration -InputObject $NewCollection -ThroughputType Autoscale

Parameters

-AccountName

Name of the Cosmos DB database account.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DatabaseName

Database name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Mongo Collection object.

Type:PSMongoDBCollectionGetResults
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Collection name.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ParentObject

Mongo Database object.

Type:PSMongoDBDatabaseGetResults
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

Name of resource group.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ThroughputType

Throughput type to migrate to. Possible values are: Autoscale, Manual.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PSMongoDBDatabaseGetResults

PSMongoDBCollectionGetResults

Outputs

PSThroughputSettingsGetResults