Update-AzCosmosDBMongoDBCollection

Reference

Module:: Az.CosmosDB

Updates the CosmosDB MongoDB Collection. Performs a client side patch operation by reading the existing Collection.

Syntax

Update-AzCosmosDBMongoDBCollection
      -ResourceGroupName <String>
      -AccountName <String>
      -DatabaseName <String>
      [-Name <String>]
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-Shard <String>]
      [-AnalyticalStorageTtl <Int32>]
      [-Index <PSMongoIndex[]>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCosmosDBMongoDBCollection
      [-Name <String>]
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-Shard <String>]
      [-AnalyticalStorageTtl <Int32>]
      [-Index <PSMongoIndex[]>]
      -ParentObject <PSMongoDBDatabaseGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzCosmosDBMongoDBCollection
      [-Name <String>]
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-Shard <String>]
      [-AnalyticalStorageTtl <Int32>]
      [-Index <PSMongoIndex[]>]
      -InputObject <PSMongoDBCollectionGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates the CosmosDB MongoDB Collection. Performs a client side patch operation by reading the existing Collection.

Examples

Example 1

Update-AzCosmosDBMongoDBCollection -AccountName myAccountName -ResourceGroupName myRgName -DatabaseName myDatabaseName -Name myCollectionName -Index $index1,$index2

Name     : collection1
Id       : /subscriptions/mySubId/resourceGroups/myRgName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/mongodbDatabases/myDatabaseName/collect
           ions/myCollectionName
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSMongoDBCollectionGetPropertiesResource

Parameters

-AccountName

Name of the Cosmos DB database account.

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

-AnalyticalStorageTtl

TTL for Analytical Storage.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-AutoscaleMaxThroughput

Maximum Throughput value if autoscale is enabled.

Type:	Nullable<T>[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

-Index

Array of PSMongoIndex objects.

Type:	PSMongoIndex[]
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

-Shard

Sharding key path.

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:	Nullable<T>[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

PSMongoDBDatabaseGetResults

PSMongoDBCollectionGetResults

Outputs