Compartilhar via

Update-AzCosmosDBAccount

  • Referência
Módulo:
Az.CosmosDB

Atualize um atributo de conta do Cosmos DB.

Sintaxe

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

Atualize as propriedades de uma conta do Cosmos DB. Não é possível atualizar as Regiões da Conta de forma simulada com outras propriedades.

Exemplos

Exemplo 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   : {}

Updated DefaultConsistencyLevel to "Strong", Enabled AutomaticFailover, Enabled MultipleWriteLocations and Enabled VirtualNetwork for Cosmos DB Account with name accountName.

Parâmetros

-AnalyticalStorageSchemaType

O tipo de esquema para armazenamento analítico. Os valores válidos incluem: 'WellDefined' e 'FullFidelity'.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-AsJob

Executar cmdlet em segundo plano

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-BackupIntervalInMinutes

O intervalo(em minutos) com o qual o backup é feito (somente para contas com backups de modo periódico)

Tipo:Nullable<T>[Int32]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-BackupPolicyType

O tipo de backups na conta do Cosmos DB. Valores aceitos: periódico, contínuo

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-BackupRetentionIntervalInHours

O tempo(em horas) para o qual cada backup é mantido (apenas para contas com backups de modo periódico)

Tipo:Nullable<T>[Int32]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-BackupStorageRedundancy

O tipo de redundância da conta de armazenamento de backup

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

Solicita a confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ContinuousTier

A camada do modo de backup contínuo na conta do Cosmos DB. Valores aceitos: Continuous7Days, Continuous30Days

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultConsistencyLevel

Nível de consistência padrão da conta de banco de dados do Cosmos DB. Valores aceitos: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-DisableKeyBasedMetadataWriteAccess

Desabilitar operações de gravação em recursos de metadados (bancos de dados, contêineres, taxa de transferência) por meio de chaves de conta

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableAnalyticalStorage

Bool para indicar se o AnalyticalStorage está habilitado na conta.

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableAutomaticFailover

Habilita o failover automático da região de gravação no evento raro em que a região está indisponível devido a uma interrupção. O failover automático resultará em uma nova região de gravação para a conta e será escolhido com base nas prioridades de failover configuradas para a conta. Valores aceitos: false, true

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableBurstCapacity

Bool para indicar se a Capacidade de Intermitência está habilitada na conta.

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableMultipleWriteLocations

Habilitar vários locais de gravação. Valores aceitos: false, true

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnablePartitionMerge

Habilitar mesclagem de partição em valores aceitos na conta: false, true

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-EnableVirtualNetwork

Habilita a rede virtual na conta de banco de dados do Cosmos DB. Valores aceitos: false, true

Tipo:Nullable<T>[Boolean]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InputObject

Objeto conta do Cosmos DB

Tipo:PSDatabaseAccountGetResults
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-IpRule

Suporte ao firewall. Especifica o conjunto de endereços IP ou intervalos de endereços IP no formulário CIDR a ser incluído como a lista permitida de IPs do cliente para uma determinada conta de banco de dados.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-KeyVaultKeyUri

URI do KeyVault

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-MaxStalenessIntervalInSeconds

Quando usado com a consistência de Desatualização Limitada, esse valor representa o tempo de desatualização (em tempo) tolerado. O intervalo aceito para esse valor é 5-86400.

Tipo:Nullable<T>[Int32]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-MaxStalenessPrefix

Quando usado com a consistência de Desatualização Limitada, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para esse valor é de 1 a 2.147.483.647.

Tipo:Nullable<T>[Int32]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Name

Nome da conta de banco de dados do Cosmos DB.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NetworkAclBypass

Se o Bypass de Acl de Rede está habilitado ou não para essa conta para o Link do Synapse. Os valores possíveis incluem: 'None', 'AzureServices'.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-NetworkAclBypassResourceId

Lista de IDs de recurso para permitir o Bypass de Acl de Rede para o Link do Synapse.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-PublicNetworkAccess

Se o acesso ao ponto de extremidade público é permitido ou não para este servidor. Os valores possíveis incluem: 'Habilitado', 'Desabilitado'

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceGroupName

Nome do grupo de recursos.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ResourceId

ResourceId do recurso.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ServerVersion

ServerVersion, válido somente no caso de contas do MongoDB.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Tag

Hashtable de marcas como pares chave-valor. Use a cadeia de caracteres vazia para limpar a marca existente.

Tipo:Hashtable
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-VirtualNetworkRule

Matriz de valores de cadeia de caracteres de ACL para rede virtual.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-VirtualNetworkRuleObject

Matriz de PSVirtualNetworkRuleObjects para rede virtual.

Tipo:PSVirtualNetworkRule[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSDatabaseAccountGetResults

Saídas

PSDatabaseAccountGetResults