Share via


Update-AzCosmosDBMongoDBCollectionThroughput

CosmosDB MongoDB コレクションのスループット値を更新します。

構文

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

説明

CosmosDB MongoDB コレクションのスループット値を更新します。

例 1

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 :

パラメーター

-AccountName

Cosmos DB データベース アカウントの名前。

Type:String
Position:Named
Default value:None
Required:True
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

-InputObject

Mongo Database オブジェクト。

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

-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

出力

PSThroughputSettingsGetResults