Update-AzCosmosDBAccount

  • Referência
Módulo:
Az.CosmosDB

Atualize os atributos de uma conta do 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

Atualize as propriedades de uma conta do Cosmos DB. Não é possível atualizar regiões de conta simultaneamente 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   : {}

DefaultConsistencyLevel atualizado para "Strong", Enabled AutomaticFailover, Enabled MultipleWriteLocations e 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'.

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

-AsJob

Executar cmdlet em segundo plano

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

-BackupIntervalInMinutes

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

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

-BackupPolicyType

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

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

-BackupRetentionIntervalInHours

O tempo (em horas) pelo qual cada backup é retido (somente para contas com backups de modo periódico)

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

-BackupStorageRedundancy

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

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

-Confirm

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

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

-ContinuousTier

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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

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

-EnableAnalyticalStorage

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

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

-EnableAutomaticFailover

Habilita o failover automático da região de gravação no caso raro de a região não estar disponí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

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

-EnableBurstCapacity

Bool para indicar se a Capacidade de Burst está habilitada na conta.

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

-EnableMultipleWriteLocations

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

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

-EnablePartitionMerge

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

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

-EnableVirtualNetwork

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

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

-InputObject

Objeto Conta do Cosmos DB

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

-IpRule

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

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

-KeyVaultKeyUri

URI do KeyVault

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

-MaxStalenessIntervalInSeconds

Quando usado com consistência de Bounded Staleness, esse valor representa a quantidade de tempo de staleness (em intervalo de tempo) tolerada. O intervalo aceito para esse valor é 5-86400.

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

-MaxStalenessPrefix

Quando usado com consistência de Limite Obsoleto, esse valor representa o número de solicitações obsoletas toleradas. O intervalo aceito para este valor é de 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

Nome da conta de banco de dados do Cosmos DB.

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

-NetworkAclBypass

Se o Network Acl Bypass está habilitado ou não para esta conta do Synapse Link. Os valores possíveis incluem: 'Nenhum', 'AzureServices'.

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

-NetworkAclBypassResourceId

Lista de IDs de recursos para permitir o desvio de Acl de rede para o link sinapse.

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

-PublicNetworkAccess

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

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

-ResourceGroupName

Nome do grupo de recursos.

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

-ResourceId

ResourceId do recurso.

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

-ServerVersion

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

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

-Tag

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

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

-VirtualNetworkRule

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

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

-VirtualNetworkRuleObject

Matriz de PSVirtualNetworkRuleObjects para rede virtual.

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

-WhatIf

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

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

Entradas

PSDatabaseAccountGetResults

Saídas

PSDatabaseAccountGetResults