Update-AzCosmosDBMongoDBCollection

リファレンス

モジュール:: Az.CosmosDB

CosmosDB MongoDB コレクションを更新します。既存のコレクションを読み取って、クライアント側のパッチ操作を実行します。

構文

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

説明

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 データベースアカウントの名前。

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

-AnalyticalStorageTtl

分析ストレージの TTL。

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

-AutoscaleMaxThroughput

自動スケーリングが有効になっている場合の最大スループット値。

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

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-DatabaseName

データベース名。

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

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

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

-Index

PSMongoIndex オブジェクトの配列。

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

-InputObject

Sql Container オブジェクト。

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

-Name

コレクション名。

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

-ParentObject

Mongo Database オブジェクト。

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

-ResourceGroupName

リソースグループの名前。

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

-Shard

シャーディングキーパス。

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

-Throughput

SQL コンテナーのスループット (RU/秒)。既定値は 400 です。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

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

入力

PSMongoDBDatabaseGetResults

PSMongoDBCollectionGetResults

出力