Dela via

Update-AzCosmosDBAccount

Modul:
Az.CosmosDB Module

Uppdatera ett Cosmos DB-kontoattribut.

Syntax

ByNameParameterSet (Standard) 

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>]
    [-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>]
    [-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>]
    [-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

Uppdatera egenskaperna för ett Cosmos DB-konto. Det går inte att uppdatera kontoregioner samtidigt med andra egenskaper.

Exempel

Exempel 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 har uppdaterats till "Strong", Enabled AutomaticFailover, Enabled MultipleWriteLocations och Enabled VirtualNetwork for Cosmos DB Account with name accountName.

Parametrar

-AnalyticalStorageSchemaType

Schematypen för analyslagring. Giltiga värden är: "WellDefined" och "FullFidelity".

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-AsJob

Kör cmdlet i bakgrunden

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-BackupIntervalInMinutes

Intervallet (i minuter) med vilket säkerhetskopiering görs (endast för konton med periodiska lägessäkerhetskopior)

Parameteregenskaper

Typ:

Nullable<T>[Int32]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-BackupPolicyType

Typ av säkerhetskopior på Cosmos DB-kontot. Godkända värden: Periodiska, kontinuerliga

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-BackupRetentionIntervalInHours

Den tid (i timmar) för vilken varje säkerhetskopia behålls (endast för konton med periodiska säkerhetskopior)

Parameteregenskaper

Typ:

Nullable<T>[Int32]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-BackupStorageRedundancy

Redundanstypen för lagringskontot för säkerhetskopiering

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:jfr

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ContinuousTier

Nivån för läget för kontinuerliga säkerhetskopieringar på Cosmos DB-kontot. Godkända värden: Continuous7Days, Continuous30Days

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultConsistencyLevel

Standardkonsekvensnivå för Cosmos DB-databaskontot. Godkända värden: BoundedStaleness, ConsistentPrefix, Eventual, Session, Strong

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Parameteregenskaper

Typ:IAzureContextContainer
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-DisableKeyBasedMetadataWriteAccess

Inaktivera skrivåtgärder för metadataresurser (databaser, containrar, dataflöde) via kontonycklar

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnableAnalyticalStorage

Bool för att ange om AnalyticalStorage är aktiverat för kontot.

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnableAutomaticFailover

Aktiverar automatisk redundans för skrivregionen i den sällsynta händelsen att regionen inte är tillgänglig på grund av ett avbrott. Automatisk redundans resulterar i en ny skrivregion för kontot och väljs baserat på de redundansprioriteringar som konfigurerats för kontot. Godkända värden: false, true

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnableBurstCapacity

Bool för att ange om Burst-kapacitet är aktiverad för kontot.

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnableMultipleWriteLocations

Aktivera flera skrivplatser. Godkända värden: false, true

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnablePartitionMerge

Aktivera partitionssammanslagning på kontogodkända värden: false, true

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnablePerRegionPerPartitionAutoscale

Bool för att ange om dynamisk skalning (per region per partition autoskalning) är aktiverat för kontot.

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-EnableVirtualNetwork

Aktiverar virtuellt nätverk på Cosmos DB-databaskontot. Godkända värden: false, true

Parameteregenskaper

Typ:

Nullable<T>[Boolean]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-InputObject

Cosmos DB-kontoobjekt

Parameteregenskaper

Typ:PSDatabaseAccountGetResults
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByObjectParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-IpRule

Brandväggsstöd. Anger den uppsättning IP-adresser eller IP-adressintervall i CIDR-formulär som ska inkluderas som den tillåtna listan över klient-IP-adresser för ett visst databaskonto.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-KeyVaultKeyUri

URI för KeyVault

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-MaxStalenessIntervalInSeconds

När det används med begränsad föråldringskonsekvens representerar det här värdet den tidsmängd för inaktuellhet (i tidsintervall) som tolereras. Godkänt intervall för det här värdet är 5–86400.

Parameteregenskaper

Typ:

Nullable<T>[Int32]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-MaxStalenessPrefix

När det används med konsekvens för begränsad inaktuellhet representerar det här värdet antalet inaktuella begäranden som tolereras. Godkänt intervall för det här värdet är 1– 2 147 483 647.

Parameteregenskaper

Typ:

Nullable<T>[Int32]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-MinimalTlsVersion

Anger den lägsta tillåtna Tls-versionen. Standardvärdet är Tls 1.2. Api:er för Cassandra och Mongo fungerar bara med Tls 1.2. Möjliga värden är: "Tls", "Tls11", "Tls12".

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Name

Namnet på Cosmos DB-databaskontot.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-NetworkAclBypass

Om förbikoppling av nätverksacl är aktiverat för det här kontot för Synapse Link eller inte. Möjliga värden är: "None", "AzureServices".

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-NetworkAclBypassResourceId

Lista över resurs-ID:n som tillåter förbikoppling av nätverksacl för Synapse Link.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-PublicNetworkAccess

Om offentlig slutpunktsåtkomst tillåts för den här servern eller inte. Möjliga värden är: "Aktiverad", "Inaktiverad"

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceGroupName

Namnet på resursgruppen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByNameParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ResourceId

ResourceId för resursen.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

ByResourceIdParameterSet
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ServerVersion

ServerVersion, gäller endast för MongoDB-konton.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Tag

Hashtable med taggar som nyckel/värde-par. Använd en tom sträng för att rensa den befintliga taggen.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-VirtualNetworkRule

Matris med strängvärden för ACL:er för virtuella nätverk.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-VirtualNetworkRuleObject

Matris med PSVirtualNetworkRuleObjects för virtuella nätverk.

Parameteregenskaper

Typ:

PSVirtualNetworkRule[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Wi

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

PSDatabaseAccountGetResults

Utdata

PSDatabaseAccountGetResults