Update-AzCosmosDBAccount

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

Cosmos DB アカウント属性を更新します。

構文

Update-AzCosmosDBAccount
      [-EnableAutomaticFailover <Boolean>]
      [-EnableMultipleWriteLocations <Boolean>]
      [-EnableVirtualNetwork <Boolean>]
      [-DisableKeyBasedMetadataWriteAccess <Boolean>]
      -ResourceGroupName <String>
      -Name <String>
      [-DefaultConsistencyLevel <String>]
      [-IpRule <String[]>]
      [-MaxStalenessIntervalInSeconds <Int32>]
      [-MaxStalenessPrefix <Int32>]
      [-Tag <Hashtable>]
      [-VirtualNetworkRule <String[]>]
      [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
      [-PublicNetworkAccess <String>]
      [-KeyVaultKeyUri <String>]
      [-EnableAnalyticalStorage <Boolean>]
      [-AsJob]
      [-NetworkAclBypass <String>]
      [-NetworkAclBypassResourceId <String[]>]
      [-ServerVersion <String>]
      [-BackupIntervalInMinutes <Int32>]
      [-BackupRetentionIntervalInHours <Int32>]
      [-EnableBurstCapacity <Boolean>]
      [-BackupStorageRedundancy <String>]
      [-BackupPolicyType <String>]
      [-ContinuousTier <String>]
      [-AnalyticalStorageSchemaType <String>]
      [-EnablePartitionMerge <Boolean>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDBAccount
      -ResourceId <String>
      [-EnableAutomaticFailover <Boolean>]
      [-EnableMultipleWriteLocations <Boolean>]
      [-EnableVirtualNetwork <Boolean>]
      [-DisableKeyBasedMetadataWriteAccess <Boolean>]
      [-DefaultConsistencyLevel <String>]
      [-IpRule <String[]>]
      [-MaxStalenessIntervalInSeconds <Int32>]
      [-MaxStalenessPrefix <Int32>]
      [-Tag <Hashtable>]
      [-VirtualNetworkRule <String[]>]
      [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
      [-PublicNetworkAccess <String>]
      [-KeyVaultKeyUri <String>]
      [-EnableAnalyticalStorage <Boolean>]
      [-AsJob]
      [-NetworkAclBypass <String>]
      [-NetworkAclBypassResourceId <String[]>]
      [-ServerVersion <String>]
      [-BackupIntervalInMinutes <Int32>]
      [-BackupRetentionIntervalInHours <Int32>]
      [-EnableBurstCapacity <Boolean>]
      [-BackupStorageRedundancy <String>]
      [-BackupPolicyType <String>]
      [-ContinuousTier <String>]
      [-AnalyticalStorageSchemaType <String>]
      [-EnablePartitionMerge <Boolean>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzCosmosDBAccount
      -InputObject <PSDatabaseAccountGetResults>
      [-EnableAutomaticFailover <Boolean>]
      [-EnableMultipleWriteLocations <Boolean>]
      [-EnableVirtualNetwork <Boolean>]
      [-DisableKeyBasedMetadataWriteAccess <Boolean>]
      [-DefaultConsistencyLevel <String>]
      [-IpRule <String[]>]
      [-MaxStalenessIntervalInSeconds <Int32>]
      [-MaxStalenessPrefix <Int32>]
      [-Tag <Hashtable>]
      [-VirtualNetworkRule <String[]>]
      [-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
      [-PublicNetworkAccess <String>]
      [-KeyVaultKeyUri <String>]
      [-EnableAnalyticalStorage <Boolean>]
      [-AsJob]
      [-NetworkAclBypass <String>]
      [-NetworkAclBypassResourceId <String[]>]
      [-ServerVersion <String>]
      [-BackupIntervalInMinutes <Int32>]
      [-BackupRetentionIntervalInHours <Int32>]
      [-EnableBurstCapacity <Boolean>]
      [-BackupStorageRedundancy <String>]
      [-BackupPolicyType <String>]
      [-ContinuousTier <String>]
      [-AnalyticalStorageSchemaType <String>]
      [-EnablePartitionMerge <Boolean>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Cosmos DB アカウントのプロパティを更新します。 他のプロパティを使用して、アカウントリージョンをシミュレート的に更新することはできません。

例

例 1

Update-AzCosmosDBAccount -ResourceGroupName resourceGroupName -Name accountName -DefaultConsistencyLevel "Strong" -EnableAutomaticFailover 1 -EnableMultipleWriteLocations 1 -EnableVirtualNetwork 1

Kind                          : GlobalDocumentDB
ProvisioningState             : Initializing
DocumentEndpoint              :
DatabaseAccountOfferType      : Standard
IpRangeFilter                 :
IsVirtualNetworkFilterEnabled : True
EnableAutomaticFailover       : True
ConsistencyPolicy             : Microsoft.Azure.Management.CosmosDB.Fluent.Models.ConsistencyPolicy
Capabilities                  : {}
WriteLocations                : {accountName-eastus}
ReadLocations                 : {accountName-eastus}
FailoverPolicies              : {accountName-eastus}
VirtualNetworkRules           : {}
EnableMultipleWriteLocations  : True
Location                      : East US
Tags                          : {}
Id                            : /subscriptions/{subscriptionid}/resourceGroups/resourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/accountName
Name                          : accountName
Type                          : Microsoft.DocumentDB/databaseAccounts
NetworkAclBypass              : None
NetworkAclBypassResourceIds   : {}

DefaultConsistencyLevel を "Strong"、Enabled AutomaticFailover、Enabled MultipleWriteLocations、Enabled VirtualNetwork for Cosmos DB Account with name accountName に更新しました。

パラメーター

-AnalyticalStorageSchemaType

分析ストレージのスキーマの種類。 有効な値は、'WellDefined' と 'FullFidelity' です。

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

-AsJob

バックグラウンドでコマンドレットを実行する

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

-BackupIntervalInMinutes

バックアップが実行される間隔 (分単位) (定期的なモードのバックアップがあるアカウントの場合のみ)

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

-BackupPolicyType

Cosmos DB アカウントのバックアップの種類。 受け入れ可能な値: 定期的、連続

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

-BackupRetentionIntervalInHours

各バックアップが保持される時間 (時間単位) (定期モード バックアップを使用するアカウントのみ)

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

-BackupStorageRedundancy

バックアップ ストレージ アカウントの冗長性の種類

Type:String
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

-ContinuousTier

Cosmos DB アカウントの継続的バックアップ モードの層。 指定できる値: Continuous7Days、Continuous30Days

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

-DefaultConsistencyLevel

Cosmos DB データベース アカウントの既定の整合性レベル。 受け入れ可能な値: BoundedStaleness、ConsistentPrefix、Eventual、Session、Strong

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

-DisableKeyBasedMetadataWriteAccess

アカウント キーを使用してメタデータ リソース (データベース、コンテナー、スループット) に対する書き込み操作を無効にする

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

-EnableAnalyticalStorage

アカウントで AnalyticalStorage が有効になっているかどうかを示すブール値。

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

-EnableAutomaticFailover

障害が原因でリージョンが使用できないまれな場合に、書き込みリージョンの自動フェールオーバーを有効にします。 自動フェールオーバーでは、アカウントの新しい書き込みリージョンが作成され、アカウント用に構成されたフェールオーバーの優先順位に基づいて選択されます。 指定できる値: false、true

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

-EnableBurstCapacity

アカウントでバースト容量が有効になっているかどうかを示すブール値。

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

-EnableMultipleWriteLocations

複数の書き込み場所を有効にします。 指定できる値: false、true

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

-EnablePartitionMerge

アカウントでパーティションマージを有効にする 受け入れられた値: false、true

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

-EnableVirtualNetwork

Cosmos DB データベース アカウントで仮想ネットワークを有効にします。 指定できる値: false、true

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

-InputObject

Cosmos DB アカウント オブジェクト

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

-IpRule

ファイアウォールのサポート。 特定のデータベース アカウントのクライアント IP の許可リストとして追加する一連の IP アドレスまたは IP アドレス範囲を CIDR 形式で指定する必要があります。

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

-KeyVaultKeyUri

KeyVault の URI

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

-MaxStalenessIntervalInSeconds

有界整合性制約と共に使用する場合、この値は許容される制約の時間量 (期間単位) を表します。 この値に使用できる範囲は 5 ~ 86400 です。

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

-MaxStalenessPrefix

有界整合性制約の一貫性と併用すると、この値は許容される古い要求の数を示します。 この値に使用できる範囲は 1 ~ 2,147,483,647 です。

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

-Name

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

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

-NetworkAclBypass

Synapse Link のこのアカウントに対してネットワーク ACL バイパスが有効になっているかどうか。 使用可能な値は、'None'、'AzureServices' です。

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

-NetworkAclBypassResourceId

Synapse Link のネットワーク ACL バイパスを許可するリソース ID の一覧。

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

-PublicNetworkAccess

このサーバーに対してパブリック エンドポイント アクセスが許可されているかどうか。 使用可能な値は、'Enabled'、'Disabled' です。

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

-ResourceGroupName

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

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

-ResourceId

リソースの ResourceId。

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

-ServerVersion

ServerVersion。MongoDB アカウントの場合にのみ有効です。

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

-Tag

キーと値のペアとしてのタグのハッシュテーブル。 既存のタグをクリアするには、空の文字列を使用します。

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

-VirtualNetworkRule

仮想ネットワークの ACL の文字列値の配列。

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

-VirtualNetworkRuleObject

仮想ネットワークの PSVirtualNetworkRuleObjects の配列。

Type:PSVirtualNetworkRule[]
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

入力

PSDatabaseAccountGetResults

出力

PSDatabaseAccountGetResults