共用方式為

Update-AzCosmosDBAccount

  • 參考
模組:
Az.CosmosDB

更新 Cosmos DB 帳戶屬性。

Syntax

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

Description

更新 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 帳戶，且名稱為 accountName。

參數

-AnalyticalStorageSchemaType

分析記憶體的架構類型。 有效值包括：『WellDefined』 和 『FullFidelity』。

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

-AsJob

在背景執行 Cmdlet

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

執行 Cmdlet 之前先提示您確認。

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

布爾值，指出是否在帳戶上啟用分析 儲存體。

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 Account 物件

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

-IpRule

防火牆支援。 指定要包含在 CIDR 表單中的 IP 位址或 IP 位址範圍集合，作為指定資料庫帳戶的用戶端 IP 允許清單。

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 略過的資源識別碼清單。

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

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

PSDatabaseAccountGetResults

輸出

PSDatabaseAccountGetResults