通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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”。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-AsJob

在后台运行 cmdlet

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-BackupIntervalInMinutes

备份的间隔（以分钟为单位）（仅适用于定期模式备份的帐户）

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-BackupPolicyType

Cosmos DB 帐户上的备份类型。 接受的值：定期、连续

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-BackupRetentionIntervalInHours

保留每个备份的时间（以小时为单位）（仅适用于定期模式备份的帐户）

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-BackupStorageRedundancy

备份存储帐户的冗余类型

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ContinuousTier

Cosmos DB 帐户上的连续备份模式层。 接受的值：Continuous7Days、Continuous30Days

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultConsistencyLevel

Cosmos DB 数据库帐户的默认一致性级别。 接受的值：BoundedStaleness、ConsistentPrefix、Eventual、Session、Strong

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DisableKeyBasedMetadataWriteAccess

通过帐户密钥对元数据资源（数据库、容器、吞吐量）禁用写入操作

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnableAnalyticalStorage

用于指示是否在帐户上启用了分析Storage 的布尔值。

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnableAutomaticFailover

在极少数情况下启用写入区域的自动故障转移，因为服务中断导致该区域不可用。 自动故障转移将导致帐户的新写入区域，并根据为帐户配置的故障转移优先级进行选择。 接受的值：false、true

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnableBurstCapacity

用于指示是否在帐户上启用了突发容量的布尔值。

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnableMultipleWriteLocations

启用多个写入位置。 接受的值：false、true

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnablePartitionMerge

对帐户接受的值启用分区合并：false、true

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EnableVirtualNetwork

在 Cosmos DB 数据库帐户上启用虚拟网络。 接受的值：false、true

类型:Nullable<T>[Boolean]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

Cosmos DB Account 对象

类型:PSDatabaseAccountGetResults
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-IpRule

防火墙支持。 以 CIDR 形式指定要作为给定数据库帐户的客户端 IP 允许列表包含的 IP 地址或 IP 地址范围集。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-KeyVaultKeyUri

KeyVault 的 URI

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-MaxStalenessIntervalInSeconds

与有限过期一致性一起使用时，此值表示容忍的过期时间量（以时间跨度为单位）。 此值的接受范围为 5-86400。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-MaxStalenessPrefix

与有限过期一致性一起使用时，此值表示允许的过时请求数。 此值的接受范围为 1 - 2,147,483,647。

类型:Nullable<T>[Int32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Name

Cosmos DB 数据库帐户的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-NetworkAclBypass

是否为此帐户启用了 Synapse Link 的网络 Acl 旁路。 可能的值包括：“None”、“AzureServices”。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-NetworkAclBypassResourceId

允许 Synapse Link 的网络 Acl 绕过的资源 ID 列表。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PublicNetworkAccess

是否允许对此服务器使用公共终结点访问。 可能的值包括：“Enabled”、“Disabled”

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

资源组的名称。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-ResourceId

资源的 ResourceId。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-ServerVersion

ServerVersion 仅在 MongoDB 帐户的情况下有效。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Tag

标记的哈希表作为键值对。 使用空字符串清除现有标记。

类型:Hashtable
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-VirtualNetworkRule

ACL 用于虚拟网络的字符串值的数组。

类型:String[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-VirtualNetworkRuleObject

虚拟网络的 PSVirtualNetworkRuleObjects 数组。

类型:PSVirtualNetworkRule[]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

PSDatabaseAccountGetResults

输出

PSDatabaseAccountGetResults