Update-AzCosmosDBMongoDBCollectionThroughput

Module:: Az.CosmosDB

Updates the throughput value of a CosmosDB MongoDB Collection.

Syntax

Update-AzCosmosDBMongoDBCollectionThroughput
      -DatabaseName <String>
      [-Name <String>]
      -ResourceGroupName <String>
      -AccountName <String>
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCosmosDBMongoDBCollectionThroughput
      [-Name <String>]
      -ParentObject <PSMongoDBDatabaseGetResults>
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCosmosDBMongoDBCollectionThroughput
      [-Name <String>]
      -InputObject <PSMongoDBCollectionGetResults>
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates the throughput value of a CosmosDB MongoDB Collection.

Examples

Example 1

PS C:\> Update-AzCosmosDBMongoDBCollectionThroughput -AccountName {myAccountName} -ResourceGroupName {myResourceGroupName} -DatabaseName {mydatabaseName} -Name {myCollectionName} -Throughput {updatedThroughputValue}
Name                : mxGp
Id                  : /subscriptions/{mySubscriptionId}/resourceGroups/{myResourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{myAccountName}/mongodbDatabase/{mydatabaseName}/collections/{myCollectionName}/throughputSettings/default
Throughput          : {updatedThroughputValue}
MinimumThroughput   : 400
OfferReplacePending :

Parameters

-AccountName

Name of the Cosmos DB database account.

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

-AutoscaleMaxThroughput

Maximum Throughput value if autoscale is enabled.

Type:	Int32
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-DatabaseName

Database name.

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Mongo Database object.

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

-Name

Collection name.

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

-ParentObject

Mongo Database object.

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

-ResourceGroupName

Name of resource group.

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

-Throughput

The throughput of SQL container (RU/s). Default value is 400.

Type:	Int32
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBDatabaseGetResults

Outputs

Microsoft.Azure.Commands.CosmosDB.Models.PSThroughputSettingsGetResults