DatabaseAccountUpdateParameters interface

Pakket:

@azure/arm-cosmosdb

Parameters voor het patchen van eigenschappen van Azure Cosmos DB-databaseaccounts.

Eigenschappen

analyticalStorageConfiguration	Specifieke eigenschappen van analytische opslag.
apiProperties	API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API.
backupPolicy	Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account.
capabilities	Lijst met Cosmos DB-mogelijkheden voor het account
capacity	Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.
connectorOffer	Het aanbiedingstype cassandra-connector voor het C*-account van de Cosmos DB-database.
consistencyPolicy	Het consistentiebeleid voor het Cosmos DB-account.
cors	Het CORS-beleid voor het Cosmos DB-databaseaccount.
customerManagedKeyStatus	Geeft de status aan van de functie Door de klant beheerde sleutel voor het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing.
defaultIdentity	De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Dit kan 'FirstPartyIdentity', 'SystemAssignedIdentity' en meer zijn.
disableKeyBasedMetadataWriteAccess	Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels
disableLocalAuth	Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD exclusief kunnen worden gebruikt voor verificatie.
enableAnalyticalStorage	Vlag om aan te geven of opslaganalyse moet worden ingeschakeld.
enableAutomaticFailover	Hiermee schakelt u automatische failover van de schrijfregio 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.
enableBurstCapacity	Vlag om aan te geven dat de preview-functie voor burstcapaciteit op het account is in- of uitgeschakeld
enableCassandraConnector	Schakelt de cassandra-connector in op het Cosmos DB C*-account
enableFreeTier	Vlag om aan te geven of gratis laag is ingeschakeld.
enableMultipleWriteLocations	Hiermee kan het account op meerdere locaties schrijven
enablePartitionMerge	Vlag om aan te geven dat de functie Voor het samenvoegen van partities in het account is ingeschakeld of uitgeschakeld
identity	Identiteit voor de resource.
ipRules	Lijst met IpRules.
isVirtualNetworkFilterEnabled	Vlag om aan te geven of Virtual Network ACL-regels moeten worden in- of uitgeschakeld.
keysMetadata	Deze eigenschap wordt genegeerd tijdens de updatebewerking, omdat de metagegevens alleen-lezen zijn. Het object vertegenwoordigt de metagegevens voor de accountsleutels van het Cosmos DB-account. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
keyVaultKeyUri	De URI van de sleutelkluis
location	De locatie van de resourcegroep waartoe de resource behoort.
locations	Een matrix die de geo-replicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account.
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.
networkAclBypass	Geeft aan welke services firewallcontroles mogen omzeilen.
networkAclBypassResourceIds	Een matrix die de resource-id's voor network Acl Bypass voor het Cosmos DB-account bevat.
publicNetworkAccess	Of aanvragen van het openbare netwerk zijn toegestaan
tags	Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
virtualNetworkRules	Lijst met Virtual Network ACL-regels die zijn geconfigureerd voor het Cosmos DB-account.

Eigenschapdetails

analyticalStorageConfiguration

Specifieke eigenschappen van analytische opslag.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Waarde van eigenschap

AnalyticalStorageConfiguration

apiProperties

API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API.

apiProperties?: ApiProperties

Waarde van eigenschap

ApiProperties

backupPolicy

Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account.

backupPolicy?: BackupPolicyUnion

Waarde van eigenschap

BackupPolicyUnion

capabilities

Lijst met Cosmos DB-mogelijkheden voor het account

capabilities?: Capability[]

Waarde van eigenschap

Capability[]

capacity

Het object dat alle eigenschappen vertegenwoordigt die betrekking hebben op het afdwingen van capaciteit voor een account.

capacity?: Capacity

Waarde van eigenschap

Capacity

connectorOffer

Het aanbiedingstype cassandra-connector voor het C*-account van de Cosmos DB-database.

connectorOffer?: string

Waarde van eigenschap

string

consistencyPolicy

Het consistentiebeleid voor het Cosmos DB-account.

consistencyPolicy?: ConsistencyPolicy

Waarde van eigenschap

ConsistencyPolicy

cors

Het CORS-beleid voor het Cosmos DB-databaseaccount.

cors?: CorsPolicy[]

Waarde van eigenschap

CorsPolicy[]

customerManagedKeyStatus

Geeft de status aan van de functie Door de klant beheerde sleutel voor het account. Als er fouten zijn, biedt de eigenschap richtlijnen voor probleemoplossing.

customerManagedKeyStatus?: string

Waarde van eigenschap

string

defaultIdentity

De standaardidentiteit voor toegang tot de sleutelkluis die wordt gebruikt in functies zoals door de klant beheerde sleutels. De standaardidentiteit moet expliciet worden ingesteld door de gebruikers. Dit kan 'FirstPartyIdentity', 'SystemAssignedIdentity' en meer zijn.

defaultIdentity?: string

Waarde van eigenschap

string

disableKeyBasedMetadataWriteAccess

Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels

disableKeyBasedMetadataWriteAccess?: boolean

Waarde van eigenschap

boolean

disableLocalAuth

Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD exclusief kunnen worden gebruikt voor verificatie.

disableLocalAuth?: boolean

Waarde van eigenschap

boolean

enableAnalyticalStorage

Vlag om aan te geven of opslaganalyse moet worden ingeschakeld.

enableAnalyticalStorage?: boolean

Waarde van eigenschap

boolean

enableAutomaticFailover

Hiermee schakelt u automatische failover van de schrijfregio 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.

enableAutomaticFailover?: boolean

Waarde van eigenschap

boolean

enableBurstCapacity

Vlag om aan te geven dat de preview-functie voor burstcapaciteit op het account is in- of uitgeschakeld

enableBurstCapacity?: boolean

Waarde van eigenschap

boolean

enableCassandraConnector

Schakelt de cassandra-connector in op het Cosmos DB C*-account

enableCassandraConnector?: boolean

Waarde van eigenschap

boolean

enableFreeTier

Vlag om aan te geven of gratis laag is ingeschakeld.

enableFreeTier?: boolean

Waarde van eigenschap

boolean

enableMultipleWriteLocations

Hiermee kan het account op meerdere locaties schrijven

enableMultipleWriteLocations?: boolean

Waarde van eigenschap

boolean

enablePartitionMerge

Vlag om aan te geven dat de functie Voor het samenvoegen van partities in het account is ingeschakeld of uitgeschakeld

enablePartitionMerge?: boolean

Waarde van eigenschap

boolean

identity

Identiteit voor de resource.

identity?: ManagedServiceIdentity

Waarde van eigenschap

ManagedServiceIdentity

ipRules

Lijst met IpRules.

ipRules?: IpAddressOrRange[]

Waarde van eigenschap

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Vlag om aan te geven of Virtual Network ACL-regels moeten worden in- of uitgeschakeld.

isVirtualNetworkFilterEnabled?: boolean

Waarde van eigenschap

boolean

keysMetadata

Deze eigenschap wordt genegeerd tijdens de updatebewerking, omdat de metagegevens alleen-lezen zijn. Het object vertegenwoordigt de metagegevens voor de accountsleutels van het Cosmos DB-account. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

keysMetadata?: DatabaseAccountKeysMetadata

Waarde van eigenschap

DatabaseAccountKeysMetadata

keyVaultKeyUri

De URI van de sleutelkluis

keyVaultKeyUri?: string

Waarde van eigenschap

string

location

De locatie van de resourcegroep waartoe de resource behoort.

location?: string

Waarde van eigenschap

string

locations

Een matrix die de geo-replicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account.

locations?: Location_2[]

Waarde van eigenschap

Location[]

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.

minimalTlsVersion?: string

Waarde van eigenschap

string

networkAclBypass

Geeft aan welke services firewallcontroles mogen omzeilen.

networkAclBypass?: NetworkAclBypass

Waarde van eigenschap

NetworkAclBypass

networkAclBypassResourceIds

Een matrix die de resource-id's voor network Acl Bypass voor het Cosmos DB-account bevat.

networkAclBypassResourceIds?: string[]

Waarde van eigenschap

string[]

publicNetworkAccess

Of aanvragen van het openbare netwerk zijn toegestaan

publicNetworkAccess?: string

Waarde van eigenschap

string

tags

Tags zijn een lijst met sleutel-waardeparen die de resource beschrijven. Deze tags kunnen worden gebruikt bij het weergeven en groeperen van deze resource (in resourcegroepen). Er kunnen maximaal 15 tags worden opgegeven voor een resource. Elke tag moet een sleutel hebben die niet groter is dan 128 tekens en een waarde van niet meer dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige waarden voor 'defaultExperience' omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.

tags?: {[propertyName: string]: string}

Waarde van eigenschap

{[propertyName: string]: string}

virtualNetworkRules

Lijst met Virtual Network ACL-regels die zijn geconfigureerd voor het Cosmos DB-account.

virtualNetworkRules?: VirtualNetworkRule[]

Waarde van eigenschap

VirtualNetworkRule[]