Update-AzCosmosDBSqlContainer

  • リファレンス
モジュール:
Az.CosmosDB

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

構文

Update-AzCosmosDBSqlContainer
      -ResourceGroupName <String>
      -AccountName <String>
      -DatabaseName <String>
      [-Name <String>]
      [-IndexingPolicy <PSSqlIndexingPolicy>]
      [-PartitionKeyVersion <Int32>]
      [-PartitionKeyKind <String>]
      [-PartitionKeyPath <String[]>]
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-TtlInSeconds <Int32>]
      [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
      [-ConflictResolutionPolicyMode <String>]
      [-ConflictResolutionPolicyPath <String>]
      [-ConflictResolutionPolicyProcedure <String>]
      [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
      [-AnalyticalStorageTtl <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDBSqlContainer
      [-Name <String>]
      [-IndexingPolicy <PSSqlIndexingPolicy>]
      [-PartitionKeyVersion <Int32>]
      [-PartitionKeyKind <String>]
      [-PartitionKeyPath <String[]>]
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-TtlInSeconds <Int32>]
      [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
      [-ConflictResolutionPolicyMode <String>]
      [-ConflictResolutionPolicyPath <String>]
      [-ConflictResolutionPolicyProcedure <String>]
      [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
      -ParentObject <PSSqlDatabaseGetResults>
      [-AnalyticalStorageTtl <Int32>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDBSqlContainer
      [-Name <String>]
      [-IndexingPolicy <PSSqlIndexingPolicy>]
      [-PartitionKeyVersion <Int32>]
      [-PartitionKeyKind <String>]
      [-PartitionKeyPath <String[]>]
      [-Throughput <Int32>]
      [-AutoscaleMaxThroughput <Int32>]
      [-TtlInSeconds <Int32>]
      [-UniqueKeyPolicy <PSSqlUniqueKeyPolicy>]
      [-ConflictResolutionPolicyMode <String>]
      [-ConflictResolutionPolicyPath <String>]
      [-ConflictResolutionPolicyProcedure <String>]
      [-ConflictResolutionPolicy <PSSqlConflictResolutionPolicy>]
      [-AnalyticalStorageTtl <Int32>]
      -InputObject <PSSqlContainerGetResults>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

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

例

例 1

Update-AzCosmosDBSqlContainer -AccountName myAccountName -Name myDatabaseName -ResourceGroupName myResourcegroupName -Throughput 800

Name     : myDatabaseName
Id       : /subscriptions/mySubscriptionId/resourceGroups/myResourcegroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlDatabases/myDatabaseName
Location :
Tags     :
Resource : Microsoft.Azure.Commands.CosmosDB.Models.PSSqlContainerGetPropertiesResource

パラメーター

-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

-ConflictResolutionPolicy

PSSqlConflictResolutionPolicy 型の ConflictResolutionPolicy オブジェクト。指定された場合、これはコンテナーの ConflictResolutionPolicy として設定されます。

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

-ConflictResolutionPolicyMode

LastWriterWins、Custom、Manual の値を指定できます。 ConflictResolutionPolicy パラメーターと共に指定した場合は無視されます。

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

-ConflictResolutionPolicyPath

型が LastWriterWins の場合に指定します。 ConflictResolutionPolicy パラメーターと共に指定した場合は無視されます。

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

-ConflictResolutionPolicyProcedure

型がカスタムの場合に指定します。 ConflictResolutionPolicy パラメーターと共に指定した場合は無視されます。

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

-DatabaseName

データベース名。

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

-DefaultProfile

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

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

-IndexingPolicy

Microsoft.Azure.Commands.CosmosDB.PSSqlIndexingPolicy 型のインデックス作成ポリシー オブジェクト。

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

-InputObject

Sql Container オブジェクト。

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

-Name

コンテナー名。

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

-ParentObject

Sql Database オブジェクト。

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

-PartitionKeyKind

パーティション分割に使用されるアルゴリズムの種類。 指定できる値は、'Hash'、'Range' です。

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

-PartitionKeyPath

パーティション キーのパス (例: '/address/zipcode')。

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

-PartitionKeyVersion

パーティション キー定義のバージョン

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

-ResourceGroupName

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

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

-Throughput

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

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

-TtlInSeconds

既定の Ttl (秒単位)。 値が見つからないか、-1 に設定されている場合、アイテムの有効期限は切れません。 値が n に設定されている場合、アイテムは最終変更時刻の n 秒後に期限切れになります。

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

-UniqueKeyPolicy

Microsoft.Azure.Commands.CosmosDB.PSSqlUniqueKeyPolicy 型の UniqueKeyPolicy オブジェクト。

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

-WhatIf

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

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

入力

PSSqlIndexingPolicy

PSSqlUniqueKeyPolicy

PSSqlConflictResolutionPolicy

PSSqlDatabaseGetResults

PSSqlContainerGetResults

出力

PSSqlDatabaseGetResults

ResourceNotFoundException