你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Update-AzCosmosDBMongoDBCollection

模块:: Az.CosmosDB Module

更新 CosmosDB MongoDB 集合。通过读取现有集合来执行客户端修补作。

语法

ByNameParameterSet (默认值)

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

ByParentObjectParameterSet

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

ByObjectParameterSet

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

说明

更新 CosmosDB MongoDB 集合。通过读取现有集合来执行客户端修补作。

示例

示例 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

参数

-AccountName

Cosmos DB 数据库帐户的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByNameParameterSet

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-AnalyticalStorageTtl

分析存储的 TTL。

参数属性

类型:	Nullable<T>[Int32]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-AutoscaleMaxThroughput

启用自动缩放时的最大吞吐量值。

参数属性

类型:	Nullable<T>[Int32]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DatabaseName

数据库名称

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByNameParameterSet

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:	IAzureContextContainer
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzContext, AzureRmContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Index

PSMongoIndex 对象的数组。

参数属性

类型:	PSMongoIndex[]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-InputObject

Sql 容器对象。

参数属性

类型:	PSMongoDBCollectionGetResults
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByObjectParameterSet

Position:	Named
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Name

集合名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ParentObject

Mongo Database 对象。

参数属性

类型:	PSMongoDBDatabaseGetResults
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByParentObjectParameterSet

Position:	Named
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceGroupName

资源组的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

ByNameParameterSet

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Shard

分片键路径。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Throughput

SQL 容器（RU/s）的吞吐量。默认值为 400。

参数属性

类型:	Nullable<T>[Int32]
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

通过

Update-AzCosmosDBMongoDBCollection

语法

ByNameParameterSet (默认值)

ByParentObjectParameterSet

ByObjectParameterSet

说明

示例

示例 1

参数

-AccountName

参数属性

参数集

-AnalyticalStorageTtl

参数属性

参数集

-AutoscaleMaxThroughput

参数属性

参数集

-Confirm

参数属性

参数集

-DatabaseName

参数属性

参数集

-DefaultProfile

参数属性

参数集

-Index

参数属性

参数集

-InputObject

参数属性

参数集

-Name

参数属性

参数集

-ParentObject

参数属性

参数集

-ResourceGroupName

参数属性

参数集

-Shard

参数属性

参数集

-Throughput

参数属性

参数集

-WhatIf

参数属性

参数集

CommonParameters

输入

PSMongoDBDatabaseGetResults

PSMongoDBCollectionGetResults

输出

PSMongoDBCollectionGetResults

ResourceNotFoundException

反馈