Compartir a través de


Update-AzCosmosDBAccount

Actualice los atributos de una cuenta de Cosmos DB.

Sintaxis

ByNameParameterSet (valor predeterminado)

Update-AzCosmosDBAccount
    -ResourceGroupName <String>
    -Name <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>]
    [-EnablePartitionMerge <Boolean>]
    [-EnableBurstCapacity <Boolean>]
    [-EnablePriorityBasedExecution <Boolean>]
    [-DefaultPriorityLevel <String>]
    [-AsJob]
    [-NetworkAclBypass <String>]
    [-NetworkAclBypassResourceId <String[]>]
    [-ServerVersion <String>]
    [-BackupIntervalInMinutes <Int32>]
    [-BackupRetentionIntervalInHours <Int32>]
    [-BackupStorageRedundancy <String>]
    [-BackupPolicyType <String>]
    [-ContinuousTier <String>]
    [-AnalyticalStorageSchemaType <String>]
    [-MinimalTlsVersion <String>]
    [-EnablePerRegionPerPartitionAutoscale <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByResourceIdParameterSet

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>]
    [-EnablePartitionMerge <Boolean>]
    [-EnableBurstCapacity <Boolean>]
    [-EnablePriorityBasedExecution <Boolean>]
    [-DefaultPriorityLevel <String>]
    [-AsJob]
    [-NetworkAclBypass <String>]
    [-NetworkAclBypassResourceId <String[]>]
    [-ServerVersion <String>]
    [-BackupIntervalInMinutes <Int32>]
    [-BackupRetentionIntervalInHours <Int32>]
    [-BackupStorageRedundancy <String>]
    [-BackupPolicyType <String>]
    [-ContinuousTier <String>]
    [-AnalyticalStorageSchemaType <String>]
    [-MinimalTlsVersion <String>]
    [-EnablePerRegionPerPartitionAutoscale <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectParameterSet

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>]
    [-EnablePartitionMerge <Boolean>]
    [-EnableBurstCapacity <Boolean>]
    [-EnablePriorityBasedExecution <Boolean>]
    [-DefaultPriorityLevel <String>]
    [-AsJob]
    [-NetworkAclBypass <String>]
    [-NetworkAclBypassResourceId <String[]>]
    [-ServerVersion <String>]
    [-BackupIntervalInMinutes <Int32>]
    [-BackupRetentionIntervalInHours <Int32>]
    [-BackupStorageRedundancy <String>]
    [-BackupPolicyType <String>]
    [-ContinuousTier <String>]
    [-AnalyticalStorageSchemaType <String>]
    [-MinimalTlsVersion <String>]
    [-EnablePerRegionPerPartitionAutoscale <Boolean>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Actualice las propiedades de una cuenta de Cosmos DB. No se pueden actualizar las regiones de cuenta simultáneamente con otras propiedades.

Ejemplos

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

Se ha actualizado DefaultConsistencyLevel a "Strong", Enabled AutomaticFailover, Enabled MultipleWriteLocations y Enabled VirtualNetwork for Cosmos DB Account with name accountName.

Parámetros

-AnalyticalStorageSchemaType

Tipo de esquema para el almacenamiento analítico. Los valores válidos incluyen: "WellDefined" y "FullFidelity".

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-AsJob

Ejecución del cmdlet en segundo plano

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-BackupIntervalInMinutes

Intervalo (en minutos) con el que se realiza la copia de seguridad (solo para cuentas con copias de seguridad en modo periódico)

Propiedades de parámetro

Tipo:

Nullable<T>[Int32]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-BackupPolicyType

Tipo de copias de seguridad en la cuenta de Cosmos DB. Valores aceptados: Periodic, Continuous

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-BackupRetentionIntervalInHours

El tiempo (en horas) para el que se conserva cada copia de seguridad (solo para las cuentas con copias de seguridad en modo periódico)

Propiedades de parámetro

Tipo:

Nullable<T>[Int32]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-BackupStorageRedundancy

El tipo de redundancia de la cuenta de almacenamiento de copia de seguridad

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ContinuousTier

El nivel del modo de copias de seguridad continuas en la cuenta de Cosmos DB. Valores aceptados: Continuous7Days, Continuous30Days

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultConsistencyLevel

Nivel de coherencia predeterminado de la cuenta de base de datos de Cosmos DB. Valores aceptados: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultPriorityLevel

Nivel de prioridad predeterminado de solicitudes para la cuenta de base de datos de Cosmos DB. Valores aceptados: Alto, Bajo

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultProfile

Credenciales, cuenta, inquilino y suscripción usados para la comunicación con Azure.

Propiedades de parámetro

Tipo:IAzureContextContainer
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DisableKeyBasedMetadataWriteAccess

Deshabilitar las operaciones de escritura en recursos de metadatos (bases de datos, contenedores, rendimiento) mediante claves de cuenta

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnableAnalyticalStorage

Bool para indicar si AnalyticalStorage está habilitado en la cuenta.

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnableAutomaticFailover

Habilita la conmutación automática por error de la región de escritura en el caso poco frecuente de que la región no esté disponible debido a una interrupción. La conmutación automática por error dará lugar a una nueva región de escritura para la cuenta y se elige en función de las prioridades de conmutación por error configuradas para la cuenta. Valores aceptados: false, true

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnableBurstCapacity

Bool para indicar si la capacidad de ráfaga está habilitada en la cuenta.

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnableMultipleWriteLocations

Habilite varias ubicaciones de escritura. Valores aceptados: false, true

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnablePartitionMerge

Habilitar la combinación de particiones en los valores aceptados de la cuenta: false, true

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnablePerRegionPerPartitionAutoscale

Bool para indicar si el escalado dinámico (por región por escalabilidad automática de partición) está habilitado en la cuenta.

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnablePriorityBasedExecution

Bool para indicar si la ejecución basada en prioridad está habilitada en la cuenta.

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-EnableVirtualNetwork

Habilita la red virtual en la cuenta de base de datos de Cosmos DB. Valores aceptados: false, true

Propiedades de parámetro

Tipo:

Nullable<T>[Boolean]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InputObject

Cosmos DB Account (objeto)

Propiedades de parámetro

Tipo:PSDatabaseAccountGetResults
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByObjectParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-IpRule

Compatibilidad con el firewall. Especifica el conjunto de direcciones IP o intervalos de direcciones IP en el formulario CIDR que se incluirá como la lista de direcciones IP de cliente permitidas para una cuenta de base de datos determinada.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-KeyVaultKeyUri

URI de KeyVault

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-MaxStalenessIntervalInSeconds

Cuando se usa con la coherencia de obsolescencia limitada, este valor representa la cantidad de tiempo de obsolescencia (en el intervalo de tiempo) tolerado. El intervalo aceptado para este valor es de 5 a 86400.

Propiedades de parámetro

Tipo:

Nullable<T>[Int32]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-MaxStalenessPrefix

Cuando se usa con la coherencia de obsolescencia limitada, este valor representa el número de solicitudes obsoletas toleradas. El intervalo aceptado para este valor es de 1 a 2.147.483.647.

Propiedades de parámetro

Tipo:

Nullable<T>[Int32]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-MinimalTlsVersion

Indica la versión mínima permitida de Tls. El valor predeterminado es Tls 1.2. Las API de Cassandra y Mongo solo funcionan con Tls 1.2. Entre los valores posibles se incluyen: "Tls", "Tls11", "Tls12".

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

Nombre de la cuenta de base de datos de Cosmos DB.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByNameParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-NetworkAclBypass

Indica si la omisión de Acl de red está habilitada para esta cuenta para Synapse Link. Los valores posibles son: "None", "AzureServices".

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-NetworkAclBypassResourceId

Lista de identificadores de recursos para permitir la omisión de Acl de red para Synapse Link.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PublicNetworkAccess

Si se permite o no el acceso al punto de conexión público para este servidor. Los valores posibles son: "Enabled", "Disabled"

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ResourceGroupName

Nombre del grupo de recursos.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByNameParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ResourceId

ResourceId del recurso.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByResourceIdParameterSet
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ServerVersion

ServerVersion, válido solo en caso de cuentas de MongoDB.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Tag

Tabla hash de etiquetas como pares clave-valor. Use una cadena vacía para borrar la etiqueta existente.

Propiedades de parámetro

Tipo:Hashtable
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-VirtualNetworkRule

Matriz de valores de cadena de la ACL para la red virtual.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-VirtualNetworkRuleObject

Matriz de PSVirtualNetworkRuleObjects para la red virtual.

Propiedades de parámetro

Tipo:

PSVirtualNetworkRule[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

PSDatabaseAccountGetResults

Salidas

PSDatabaseAccountGetResults