Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration

Module:

Az.CosmosDB

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

Syntax

Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration
      [-Name <String>]
      -ResourceGroupName <String>
      -AccountName <String>
      -ThroughputType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration
      [-Name <String>]
      -ParentObject <PSDatabaseAccountGetResults>
      -ThroughputType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration
      [-Name <String>]
      -InputObject <PSMongoDBDatabaseGetResults>
      -ThroughputType <String>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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

Examples

Example 1

$NewMongodbDatabase = New-AzCosmosDBMongoDBDatabase -AccountName myAccountName -ResourceGroupName myRgName -Name myDbName -Throughput 700
$AutoscaleThroughput = Invoke-AzCosmosDBMongoDBDatabaseThroughputMigration -InputObject $NewMongodbDatabase -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

-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 Database object.

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

-Name

Database name.

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

-ParentObject

CosmosDB Account object

Type:	PSDatabaseAccountGetResults
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
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

Outputs

PSThroughputSettingsGetResults