次の方法で共有


Update-AzCosmosDBMongoDBCollection

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-AnalyticalStorageTtl

分析ストレージの TTL。

型:Nullable<T>[Int32]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-AutoscaleMaxThroughput

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

型:Nullable<T>[Int32]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DatabaseName

データベース名。

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Index

PSMongoIndex オブジェクトの配列。

型:PSMongoIndex[]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-InputObject

Sql Container オブジェクト。

型:PSMongoDBCollectionGetResults
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-Name

コレクション名。

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-ParentObject

Mongo Database オブジェクト。

型:PSMongoDBDatabaseGetResults
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ResourceGroupName

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Shard

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

型:String
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Throughput

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

型:Nullable<T>[Int32]
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PSMongoDBDatabaseGetResults

PSMongoDBCollectionGetResults

出力

PSMongoDBCollectionGetResults

ResourceNotFoundException