DatabaseAccountCreateUpdateParameters interface
Parameters voor het maken en bijwerken van Cosmos DB-databaseaccounts.
- Extends
Eigenschappen
analytical |
Specifieke eigenschappen van analytische opslag. |
api |
API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API. |
backup |
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 met betrekking tot het afdwingen van capaciteit voor een account. |
connector |
Het aanbiedingstype van de Cassandra-connector voor het C*-account van de Cosmos DB-database. |
consistency |
Het consistentiebeleid voor het Cosmos DB-account. |
cors | Het CORS-beleid voor het Cosmos DB-databaseaccount. |
create |
Opsomming om de modus voor het maken van een account aan te geven. |
customer |
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. |
database |
Het aanbiedingstype voor de database |
default |
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. |
disable |
Schrijfbewerkingen uitschakelen voor metagegevensresources (databases, containers, doorvoer) via accountsleutels |
disable |
Meld u af voor lokale verificatie en zorg ervoor dat alleen MSI en AAD exclusief voor verificatie kunnen worden gebruikt. |
enable |
Vlag om aan te geven of opslaganalyse moet worden ingeschakeld. |
enable |
Hiermee wordt automatische failover van de schrijfregio ingeschakeld 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. |
enable |
Vlag om aan te geven dat de preview-functie voor burstcapaciteit in het account is ingeschakeld of uitgeschakeld |
enable |
Hiermee schakelt u de cassandra-connector in op het Cosmos DB C*-account |
enable |
Vlag om aan te geven of gratis laag is ingeschakeld. |
enable |
Hiermee kan het account op meerdere locaties schrijven |
enable |
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. |
ip |
Lijst met IpRules. |
is |
Vlag om aan te geven of Virtual Network ACL-regels moeten worden ingeschakeld of uitgeschakeld. |
keys |
Deze eigenschap wordt genegeerd tijdens de update-/maakbewerking, omdat de metagegevens het kenmerk Alleen-lezen hebben. 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. |
key |
De URI van de sleutelkluis |
kind | Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount. |
locations | Een matrix die de georeplicatielocaties bevat die zijn ingeschakeld voor het Cosmos DB-account. |
minimal |
Geeft de minimaal toegestane TLS-versie aan. De standaardwaarde is Tls 1.2. Cassandra- en Mongo-API's werken alleen met TLS 1.2. |
network |
Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen. |
network |
Een matrix met de resource-id's voor netwerk-Acl Bypass voor het Cosmos DB-account. |
public |
Of aanvragen van het openbare netwerk zijn toegestaan |
restore |
Parameters om de informatie over de herstelbewerking aan te geven. |
virtual |
Lijst met Virtual Network ACL-regels die zijn geconfigureerd voor het Cosmos DB-account. |
Overgenomen eigenschappen
id | De unieke resource-id van de ARM-resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server. |
location | De locatie van de resourcegroep waartoe de resource behoort. |
name | De naam van de ARM-resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server. |
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 (tussen 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 de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'. |
type | Het type Azure-resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server. |
Eigenschapdetails
analyticalStorageConfiguration
Specifieke eigenschappen van analytische opslag.
analyticalStorageConfiguration?: AnalyticalStorageConfiguration
Waarde van eigenschap
apiProperties
API-specifieke eigenschappen. Momenteel alleen ondersteund voor MongoDB-API.
apiProperties?: ApiProperties
Waarde van eigenschap
backupPolicy
Het object dat het beleid vertegenwoordigt voor het maken van back-ups voor een account.
backupPolicy?: BackupPolicyUnion
Waarde van eigenschap
capabilities
Lijst met Cosmos DB-mogelijkheden voor het account
capabilities?: Capability[]
Waarde van eigenschap
capacity
Het object dat alle eigenschappen vertegenwoordigt met betrekking tot het afdwingen van capaciteit voor een account.
capacity?: Capacity
Waarde van eigenschap
connectorOffer
Het aanbiedingstype van de 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
cors
Het CORS-beleid voor het Cosmos DB-databaseaccount.
cors?: CorsPolicy[]
Waarde van eigenschap
createMode
Opsomming om de modus voor het maken van een account aan te geven.
createMode?: string
Waarde van eigenschap
string
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
databaseAccountOfferType
Het aanbiedingstype voor de database
databaseAccountOfferType: "Standard"
Waarde van eigenschap
"Standard"
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 voor verificatie kunnen worden gebruikt.
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 wordt automatische failover van de schrijfregio ingeschakeld 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 in het account is ingeschakeld of uitgeschakeld
enableBurstCapacity?: boolean
Waarde van eigenschap
boolean
enableCassandraConnector
Hiermee schakelt u 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
ipRules
isVirtualNetworkFilterEnabled
Vlag om aan te geven of Virtual Network ACL-regels moeten worden ingeschakeld of uitgeschakeld.
isVirtualNetworkFilterEnabled?: boolean
Waarde van eigenschap
boolean
keysMetadata
Deze eigenschap wordt genegeerd tijdens de update-/maakbewerking, omdat de metagegevens het kenmerk Alleen-lezen hebben. 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
keyVaultKeyUri
De URI van de sleutelkluis
keyVaultKeyUri?: string
Waarde van eigenschap
string
kind
Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount.
kind?: string
Waarde van eigenschap
string
locations
Een matrix die de georeplicatielocaties 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
Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.
networkAclBypass?: NetworkAclBypass
Waarde van eigenschap
networkAclBypassResourceIds
Een matrix met de resource-id's voor netwerk-Acl Bypass voor het Cosmos DB-account.
networkAclBypassResourceIds?: string[]
Waarde van eigenschap
string[]
publicNetworkAccess
Of aanvragen van het openbare netwerk zijn toegestaan
publicNetworkAccess?: string
Waarde van eigenschap
string
restoreParameters
Parameters om de informatie over de herstelbewerking aan te geven.
restoreParameters?: RestoreParameters
Waarde van eigenschap
virtualNetworkRules
Lijst met Virtual Network ACL-regels die zijn geconfigureerd voor het Cosmos DB-account.
virtualNetworkRules?: VirtualNetworkRule[]
Waarde van eigenschap
Details van overgenomen eigenschap
id
De unieke resource-id van de ARM-resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
id?: string
Waarde van eigenschap
string
Overgenomen vanARMResourceProperties.id
location
De locatie van de resourcegroep waartoe de resource behoort.
location?: string
Waarde van eigenschap
string
Overgenomen vanARMResourceProperties.location
name
De naam van de ARM-resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name?: string
Waarde van eigenschap
string
Overgenomen vanARMResourceProperties.name
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 (tussen 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 de waarde niet groter is dan 256 tekens. De standaardervaring voor een sjabloontype is bijvoorbeeld ingesteld met 'defaultExperience': 'Cassandra'. Huidige 'defaultExperience'-waarden omvatten ook 'Table', 'Graph', 'DocumentDB' en 'MongoDB'.
tags?: {[propertyName: string]: string}
Waarde van eigenschap
{[propertyName: string]: string}
Overgenomen vanARMResourceProperties.tags
type
Het type Azure-resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
type?: string
Waarde van eigenschap
string
Overgenomen vanARMResourceProperties.type