Update-AzCosmosDBAccount
Werk kenmerken van een Cosmos DB-account bij.
Syntax
ByNameParameterSet (Standaard)
Update-AzCosmosDBAccount
-ResourceGroupName <String>
-Name <String>
[-EnableAutomaticFailover <Boolean>]
[-EnableMultipleWriteLocations <Boolean>]
[-EnableVirtualNetwork <Boolean>]
[-DisableKeyBasedMetadataWriteAccess <Boolean>]
[-Capabilities <String[]>]
[-DefaultConsistencyLevel <String>]
[-IpRule <String[]>]
[-MaxStalenessIntervalInSeconds <Int32>]
[-MaxStalenessPrefix <Int32>]
[-Tag <Hashtable>]
[-VirtualNetworkRule <String[]>]
[-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
[-PublicNetworkAccess <String>]
[-KeyVaultKeyUri <String>]
[-DisableLocalAuth <Boolean>]
[-EnableAnalyticalStorage <Boolean>]
[-EnablePartitionMerge <Boolean>]
[-EnableBurstCapacity <Boolean>]
[-AsJob]
[-NetworkAclBypass <String>]
[-NetworkAclBypassResourceId <String[]>]
[-ServerVersion <String>]
[-BackupIntervalInMinutes <Int32>]
[-BackupRetentionIntervalInHours <Int32>]
[-BackupStorageRedundancy <String>]
[-BackupPolicyType <String>]
[-ContinuousTier <String>]
[-AnalyticalStorageSchemaType <String>]
[-MinimalTlsVersion <String>]
[-EnablePerRegionPerPartitionAutoscale <Boolean>]
[-EnablePriorityBasedExecution <Boolean>]
[-DefaultPriorityLevel <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceIdParameterSet
Update-AzCosmosDBAccount
-ResourceId <String>
[-EnableAutomaticFailover <Boolean>]
[-EnableMultipleWriteLocations <Boolean>]
[-EnableVirtualNetwork <Boolean>]
[-DisableKeyBasedMetadataWriteAccess <Boolean>]
[-Capabilities <String[]>]
[-DefaultConsistencyLevel <String>]
[-IpRule <String[]>]
[-MaxStalenessIntervalInSeconds <Int32>]
[-MaxStalenessPrefix <Int32>]
[-Tag <Hashtable>]
[-VirtualNetworkRule <String[]>]
[-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
[-PublicNetworkAccess <String>]
[-KeyVaultKeyUri <String>]
[-DisableLocalAuth <Boolean>]
[-EnableAnalyticalStorage <Boolean>]
[-EnablePartitionMerge <Boolean>]
[-EnableBurstCapacity <Boolean>]
[-AsJob]
[-NetworkAclBypass <String>]
[-NetworkAclBypassResourceId <String[]>]
[-ServerVersion <String>]
[-BackupIntervalInMinutes <Int32>]
[-BackupRetentionIntervalInHours <Int32>]
[-BackupStorageRedundancy <String>]
[-BackupPolicyType <String>]
[-ContinuousTier <String>]
[-AnalyticalStorageSchemaType <String>]
[-MinimalTlsVersion <String>]
[-EnablePerRegionPerPartitionAutoscale <Boolean>]
[-EnablePriorityBasedExecution <Boolean>]
[-DefaultPriorityLevel <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObjectParameterSet
Update-AzCosmosDBAccount
-InputObject <PSDatabaseAccountGetResults>
[-EnableAutomaticFailover <Boolean>]
[-EnableMultipleWriteLocations <Boolean>]
[-EnableVirtualNetwork <Boolean>]
[-DisableKeyBasedMetadataWriteAccess <Boolean>]
[-Capabilities <String[]>]
[-DefaultConsistencyLevel <String>]
[-IpRule <String[]>]
[-MaxStalenessIntervalInSeconds <Int32>]
[-MaxStalenessPrefix <Int32>]
[-Tag <Hashtable>]
[-VirtualNetworkRule <String[]>]
[-VirtualNetworkRuleObject <PSVirtualNetworkRule[]>]
[-PublicNetworkAccess <String>]
[-KeyVaultKeyUri <String>]
[-DisableLocalAuth <Boolean>]
[-EnableAnalyticalStorage <Boolean>]
[-EnablePartitionMerge <Boolean>]
[-EnableBurstCapacity <Boolean>]
[-AsJob]
[-NetworkAclBypass <String>]
[-NetworkAclBypassResourceId <String[]>]
[-ServerVersion <String>]
[-BackupIntervalInMinutes <Int32>]
[-BackupRetentionIntervalInHours <Int32>]
[-BackupStorageRedundancy <String>]
[-BackupPolicyType <String>]
[-ContinuousTier <String>]
[-AnalyticalStorageSchemaType <String>]
[-MinimalTlsVersion <String>]
[-EnablePerRegionPerPartitionAutoscale <Boolean>]
[-EnablePriorityBasedExecution <Boolean>]
[-DefaultPriorityLevel <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Werk de eigenschappen van een Cosmos DB-account bij. Kan accountregio's niet tegelijk bijwerken met andere eigenschappen.
Voorbeelden
Voorbeeld 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 bijgewerkt naar Strong, Enabled AutomaticFailover, Enabled MultipleWriteLocations and Enabled VirtualNetwork for Cosmos DB Account with name accountName.
Parameters
-AnalyticalStorageSchemaType
Het schematype voor analytische opslag. Geldige waarden zijn: 'WellDefined' en 'FullFidelity'.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-AsJob
Cmdlet op de achtergrond uitvoeren
Parametereigenschappen
Type: SwitchParameter
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-BackupIntervalInMinutes
Het interval (in minuten) waarmee een back-up wordt gemaakt (alleen voor accounts met periodieke back-ups in de modus)
Parametereigenschappen
Type: Nullable<T> [ Int32 ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-BackupPolicyType
Het type back-ups in het Cosmos DB-account. Geaccepteerde waarden: periodiek, doorlopend
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-BackupRetentionIntervalInHours
De tijd (in uren) waarvoor elke back-up wordt bewaard (alleen voor accounts met periodieke back-ups in de modus)
Parametereigenschappen
Type: Nullable<T> [ Int32 ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-BackupStorageRedundancy
Het redundantietype van het back-upopslagaccount
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-Capabilities
Lijst met Cosmos DB-mogelijkheden voor het account. bijvoorbeeld EnableMongo, EnablePerPartitionFailoverPreview, DisableRateLimitingResponses.
Parametereigenschappen
Type: String [ ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-Confirm
Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.
Parametereigenschappen
Type: SwitchParameter
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Aliassen: Cf
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-ContinuousTier
De laag van de modus continue back-ups in het Cosmos DB-account. Geaccepteerde waarden: Continuous7Days, Continuous30Days
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-DefaultConsistencyLevel
Standaardconsistentieniveau van het Cosmos DB-databaseaccount.
Geaccepteerde waarden: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-DefaultPriorityLevel
Standaardprioriteitsniveau van aanvragen voor Cosmos DB-databaseaccount.
Geaccepteerde waarden: Hoog, Laag
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-DefaultProfile
De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.
Parametereigenschappen
Type: IAzureContextContainer
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Aliassen: AzContext, AzureRmContext, AzureCredential
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-DisableLocalAuth
Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD uitsluitend voor verificatie kunnen worden gebruikt.
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnableAnalyticalStorage
Bool om aan te geven of AnalyticalStorage is ingeschakeld voor het account.
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnableAutomaticFailover
Maakt automatische failover van de schrijfregio mogelijk in de zeldzame gebeurtenis dat de regio niet beschikbaar is vanwege een storing.
Automatische failover resulteert in een nieuwe schrijfregio voor het account en wordt gekozen op basis van de failoverprioriteiten die voor het account zijn geconfigureerd.
Geaccepteerde waarden: onwaar, waar
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnableBurstCapacity
Bool om aan te geven of Burst-capaciteit is ingeschakeld voor het account.
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnableMultipleWriteLocations
Schakel meerdere schrijflocaties in.
Geaccepteerde waarden: onwaar, waar
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnablePartitionMerge
Partitie samenvoegen inschakelen voor geaccepteerde accountwaarden: false, true
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnablePerRegionPerPartitionAutoscale
Bool om aan te geven of dynamisch schalen (per regio per partitie automatisch schalen) is ingeschakeld voor het account.
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnablePriorityBasedExecution
Bool om aan te geven of uitvoering op basis van prioriteit is ingeschakeld voor het account.
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-EnableVirtualNetwork
Hiermee schakelt u het virtuele netwerk in het Cosmos DB-databaseaccount in.
Geaccepteerde waarden: onwaar, waar
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
Cosmos DB-accountobject
ByObjectParameterSet
Position: Named
Verplicht: True
Waarde uit pijplijn: True
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-IpRule
Firewallondersteuning. Hiermee geeft u de set IP-adressen of IP-adresbereiken in CIDR-formulier moet worden opgenomen als de lijst met toegestane client-IP-adressen voor een bepaald databaseaccount.
Parametereigenschappen
Type: String [ ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-KeyVaultKeyUri
URI van keyvault
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-MaxStalenessIntervalInSeconds
Wanneer deze waarde wordt gebruikt met gebonden verouderingsconsistentie, vertegenwoordigt deze waarde de tijdsduur van veroudering (in tijdspanne) die wordt getolereerd.
Geaccepteerd bereik voor deze waarde is 5-86400.
Parametereigenschappen
Type: Nullable<T> [ Int32 ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-MaxStalenessPrefix
Wanneer deze waarde wordt gebruikt met de consistentie Gebonden veroudering, vertegenwoordigt deze waarde het aantal verlopen aanvragen dat wordt getolereerd.
Geaccepteerd bereik voor deze waarde is 1 - 2.147.483.647.
Parametereigenschappen
Type: Nullable<T> [ Int32 ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-MinimalTlsVersion
Geeft de minimaal toegestane Tls-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met Tls 1.2. Mogelijke waarden zijn: 'Tls', 'Tls11', 'Tls12'.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-Name
Naam van het Cosmos DB-databaseaccount.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
ByNameParameterSet
Position: Named
Verplicht: True
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-NetworkAclBypass
Of netwerk-Acl bypass al dan niet is ingeschakeld voor dit account voor Synapse Link. Mogelijke waarden zijn: 'None', 'AzureServices'.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-NetworkAclBypassResourceId
Lijst met resource-id's om netwerk-Acl-bypass toe te staan voor Synapse Link.
Parametereigenschappen
Type: String [ ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-PublicNetworkAccess
Of openbare eindpunttoegang wel of niet is toegestaan voor deze server. Mogelijke waarden zijn: 'Ingeschakeld', 'Uitgeschakeld'
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-ResourceGroupName
Naam van resourcegroep.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
ByNameParameterSet
Position: Named
Verplicht: True
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-ResourceId
ResourceId van de resource.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
ByResourceIdParameterSet
Position: Named
Verplicht: True
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-ServerVersion
ServerVersion, alleen geldig in het geval van MongoDB-accounts.
Parametereigenschappen
Type: String
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-Tag
Hashtabel van tags als sleutel-waardeparen.
Gebruik een lege tekenreeks om een bestaande tag te wissen.
Parametereigenschappen
Type: Hashtable
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-VirtualNetworkRule
Matrix van tekenreekswaarden van ACL's voor virtueel netwerk.
Parametereigenschappen
Type: String [ ]
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-VirtualNetworkRuleObject
Matrix van PSVirtualNetworkRuleObjects voor virtueel netwerk.
Parametereigenschappen
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
-WhatIf
Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd.
De cmdlet wordt niet uitgevoerd.
Parametereigenschappen
Type: SwitchParameter
Default value: None
Ondersteunt jokertekens: False
DontShow: False
Aliassen: Wi
Parametersets
(All)
Position: Named
Verplicht: False
Waarde uit pijplijn: False
Waarde uit pijplijn op eigenschapsnaam: False
Waarde van resterende argumenten: False
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParameters voor meer informatie.
Uitvoerwaarden