DatabaseAccountGetResults interface

Pakket:

@azure/arm-cosmosdb

Een Azure Cosmos DB-databaseaccount.

Extends

ARMResourceProperties

Eigenschappen

analyticalStorageConfiguration	Specifieke eigenschappen van analytische opslag.
apiProperties	API-specifieke eigenschappen.
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 met betrekking tot het afdwingen van capaciteit voor een account.
connectorOffer	Het aanbiedingstype van de Cassandra-connector voor het C*-account van de Cosmos DB-database.
consistencyPolicy	Het consistentiebeleid voor het Cosmos DB-databaseaccount.
cors	Het CORS-beleid voor het Cosmos DB-databaseaccount.
createMode	Opsomming om de modus voor het maken van een account aan te geven.
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.
databaseAccountOfferType	Het aanbiedingstype voor het Cosmos DB-databaseaccount. Standaardwaarde: Standaard. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
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 voor verificatie kunnen worden gebruikt.
documentEndpoint	Het verbindingseindpunt voor het Cosmos DB-databaseaccount. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
enableAnalyticalStorage	Vlag om aan te geven of opslaganalyse moet worden ingeschakeld.
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.
enableBurstCapacity	Vlag om aan te geven dat de preview-functie voor burstcapaciteit in het account is ingeschakeld of uitgeschakeld
enableCassandraConnector	Hiermee schakelt u 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
failoverPolicies	Een matrix die de regio's bevat die zijn geordend op hun failoverprioriteiten. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
identity	Identiteit voor de resource.
instanceId	Een unieke id die is toegewezen aan het databaseaccount OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
ipRules	Lijst met IpRules.
isVirtualNetworkFilterEnabled	Vlag om aan te geven of Virtual Network ACL-regels moeten worden ingeschakeld of uitgeschakeld.
keysMetadata	Het object dat de metagegevens vertegenwoordigt 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
kind	Geeft het type databaseaccount aan. Dit kan alleen worden ingesteld bij het maken van een databaseaccount.
locations	Een matrix die alle locaties bevat die zijn ingeschakeld voor het Cosmos DB-account. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
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	Hiermee wordt aangegeven welke services firewallcontroles mogen omzeilen.
networkAclBypassResourceIds	Een matrix met de resource-id's voor netwerk-Acl Bypass voor het Cosmos DB-account.
privateEndpointConnections	Lijst met privé-eindpunten Connections geconfigureerd voor het Cosmos DB-account. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
provisioningState	De status van het Cosmos DB-account op het moment dat de bewerking werd aangeroepen. De status kan een van de volgende zijn. 'Maken': het Cosmos DB-account wordt gemaakt. Wanneer een account de status Maken heeft, worden alleen eigenschappen geretourneerd die zijn opgegeven als invoer voor de bewerking Cosmos DB-account maken. Geslaagd: het Cosmos DB-account is actief voor gebruik. 'Bijwerken': het Cosmos DB-account wordt bijgewerkt. 'Verwijderen': het Cosmos DB-account wordt verwijderd. Mislukt: het Maken van het Cosmos DB-account is mislukt. 'DeletionFailed': het verwijderen van het Cosmos DB-account is mislukt. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
publicNetworkAccess	Of aanvragen van het openbare netwerk zijn toegestaan
readLocations	Een matrix met de leeslocaties die zijn ingeschakeld voor het Cosmos DB-account. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
restoreParameters	Parameters om de informatie over de herstelbewerking aan te geven.
systemData	De systeemmetagegevens met betrekking tot deze resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
virtualNetworkRules	Lijst met Virtual Network ACL-regels die zijn geconfigureerd voor het Cosmos DB-account.
writeLocations	Een matrix die de schrijflocatie voor het Cosmos DB-account bevat. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

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

AnalyticalStorageConfiguration

apiProperties

API-specifieke eigenschappen.

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 met betrekking tot het afdwingen van capaciteit voor een account.

capacity?: Capacity

Waarde van eigenschap

Capacity

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-databaseaccount.

consistencyPolicy?: ConsistencyPolicy

Waarde van eigenschap

ConsistencyPolicy

cors

Het CORS-beleid voor het Cosmos DB-databaseaccount.

cors?: CorsPolicy[]

Waarde van eigenschap

CorsPolicy[]

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 het Cosmos DB-databaseaccount. Standaardwaarde: Standaard. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

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

documentEndpoint

Het verbindingseindpunt voor het Cosmos DB-databaseaccount. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

documentEndpoint?: string

Waarde van eigenschap

string

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

failoverPolicies

Een matrix die de regio's bevat die zijn geordend op hun failoverprioriteiten. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

failoverPolicies?: FailoverPolicy[]

Waarde van eigenschap

FailoverPolicy[]

identity

Identiteit voor de resource.

identity?: ManagedServiceIdentity

Waarde van eigenschap

ManagedServiceIdentity

instanceId

Een unieke id die is toegewezen aan het databaseaccount OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

instanceId?: string

Waarde van eigenschap

string

ipRules

Lijst met IpRules.

ipRules?: IpAddressOrRange[]

Waarde van eigenschap

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

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

isVirtualNetworkFilterEnabled?: boolean

Waarde van eigenschap

boolean

keysMetadata

Het object dat de metagegevens vertegenwoordigt 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

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 alle locaties bevat die zijn ingeschakeld voor het Cosmos DB-account. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

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

NetworkAclBypass

networkAclBypassResourceIds

Een matrix met de resource-id's voor netwerk-Acl Bypass voor het Cosmos DB-account.

networkAclBypassResourceIds?: string[]

Waarde van eigenschap

string[]

privateEndpointConnections

Lijst met privé-eindpunten Connections geconfigureerd voor het Cosmos DB-account. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

privateEndpointConnections?: PrivateEndpointConnection[]

Waarde van eigenschap

PrivateEndpointConnection[]

provisioningState

De status van het Cosmos DB-account op het moment dat de bewerking werd aangeroepen. De status kan een van de volgende zijn. 'Maken': het Cosmos DB-account wordt gemaakt. Wanneer een account de status Maken heeft, worden alleen eigenschappen geretourneerd die zijn opgegeven als invoer voor de bewerking Cosmos DB-account maken. Geslaagd: het Cosmos DB-account is actief voor gebruik. 'Bijwerken': het Cosmos DB-account wordt bijgewerkt. 'Verwijderen': het Cosmos DB-account wordt verwijderd. Mislukt: het Maken van het Cosmos DB-account is mislukt. 'DeletionFailed': het verwijderen van het Cosmos DB-account is mislukt. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

provisioningState?: string

Waarde van eigenschap

string

publicNetworkAccess

Of aanvragen van het openbare netwerk zijn toegestaan

publicNetworkAccess?: string

Waarde van eigenschap

string

readLocations

Een matrix met de leeslocaties die zijn ingeschakeld voor het Cosmos DB-account. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

readLocations?: Location_2[]

Waarde van eigenschap

Location[]

restoreParameters

Parameters om de informatie over de herstelbewerking aan te geven.

restoreParameters?: RestoreParameters

Waarde van eigenschap

RestoreParameters

systemData

De systeemmetagegevens met betrekking tot deze resource. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

systemData?: SystemData

Waarde van eigenschap

SystemData

virtualNetworkRules

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

virtualNetworkRules?: VirtualNetworkRule[]

Waarde van eigenschap

VirtualNetworkRule[]

writeLocations

Een matrix die de schrijflocatie voor het Cosmos DB-account bevat. OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

writeLocations?: Location_2[]

Waarde van eigenschap

Location[]

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