DatabaseAccountGetResults interface

Paket:

@azure/arm-cosmosdb

Ein Azure Cosmos DB-Datenbankkonto.

Extends

ARMResourceProperties

Eigenschaften

analyticalStorageConfiguration	Analytische Speicherspezifische Eigenschaften.
apiProperties	API-spezifische Eigenschaften.
backupPolicy	Das Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt.
capabilities	Liste der Cosmos DB-Funktionen für das Konto
capacity	Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.
connectorOffer	Der Cassandra Connector-Angebotstyp für das Cosmos DB-Datenbank-C*-Konto.
consistencyPolicy	Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.
cors	Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.
createMode	Aufzählung, um den Modus der Kontoerstellung anzugeben.
customerManagedKeyStatus	Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung.
databaseAccountOfferType	Der Angebotstyp für das Cosmos DB-Datenbankkonto. Standardwert: Standard. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
defaultIdentity	Die Standardidentität für den Zugriff auf den Schlüsseltresor, der in Features wie vom Kunden verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein.
disableKeyBasedMetadataWriteAccess	Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel
disableLocalAuth	Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.
documentEndpoint	Der Verbindungsendpunkt für das Cosmos DB-Datenbankkonto. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
enableAnalyticalStorage	Kennzeichnen, um anzugeben, ob Speicheranalysen aktiviert werden sollen.
enableAutomaticFailover	Aktiviert das automatische Failover des Schreibbereichs im seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einem neuen Schreibbereich für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt.
enableBurstCapacity	Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto
enableCassandraConnector	Aktiviert den Cassandra Connector auf dem Cosmos DB C*-Konto
enableFreeTier	Kennzeichnung, um anzugeben, ob die kostenlose Leiste aktiviert ist.
enableMultipleWriteLocations	Ermöglicht das Schreiben des Kontos an mehreren Speicherorten.
enablePartitionMerge	Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto
enablePerRegionPerPartitionAutoscale	Flag zum Aktivieren/Deaktivieren des PerRegionPerPartitionAutoscale-Features für das Konto
failoverPolicies	Ein Array, das die Regionen enthält, die nach ihren Failoverprioritäten sortiert sind. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
identity	Identität für die Ressource.
instanceId	Ein eindeutiger Bezeichner, der dem Datenbankkontohinweis zugewiesen ist: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
ipRules	Liste der IpRules.
isVirtualNetworkFilterEnabled	Kennzeichnen, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen.
keysMetadata	Das Objekt, das die Metadaten für die Kontoschlüssel des Cosmos DB-Kontos darstellt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
keyVaultKeyUri	Der URI des Schlüsseltresors
kind	Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Datenbankkontoerstellung festgelegt werden.
locations	Ein Array, das alle für das Cosmos DB-Konto aktivierten Speicherorte enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
minimalTlsVersion	Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.
networkAclBypass	Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.
networkAclBypassResourceIds	Ein Array, das die Ressourcen-IDs für die Netzwerk-Acl-Umgehung für das Cosmos DB-Konto enthält.
privateEndpointConnections	Liste der privaten Endpunktverbindungen, die für das Cosmos DB-Konto konfiguriert sind. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
provisioningState	Der Status des Cosmos DB-Kontos zum Zeitpunkt des Aufrufs des Vorgangs. Der Status kann eine der folgenden Sein: "Creating" – das Cosmos DB-Konto wird erstellt. Wenn sich ein Konto im Zustand "Erstellen" befindet, werden nur Eigenschaften zurückgegeben, die als Eingabe für den Create Cosmos DB-Kontovorgang angegeben werden. "Succeeded" – das Cosmos DB-Konto ist für die Verwendung aktiv. "Aktualisieren" – das Cosmos DB-Konto wird aktualisiert. "Löschen" – das Cosmos DB-Konto wird gelöscht. "Failed" – Das Cosmos DB-Konto konnte nicht erstellt werden. "DeleteFailed" – Fehler beim Löschen des Cosmos DB-Kontos. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
publicNetworkAccess	Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.
readLocations	Ein Array mit den für das Cosmos DB-Konto aktivierten Lesespeicherorten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
restoreParameters	Parameter, die die Informationen zur Wiederherstellung angeben sollen.
systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
virtualNetworkRules	Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind.
writeLocations	Ein Array, das den Schreibspeicherort für das Cosmos DB-Konto enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Geerbte Eigenschaften

id	Der eindeutige Ressourcenbezeichner der ARM-Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
location	Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.
name	Der Name der ARM-Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
tags	Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Beispielsweise wird die Standardoberfläche für einen Vorlagentyp mit "defaultExperience": "Cassandra" festgelegt. Aktuelle "defaultExperience"-Werte enthalten auch "Table", "Graph", "DocumentDB" und "MongoDB".
type	Der Typ der Azure-Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

analyticalStorageConfiguration

Analytische Speicherspezifische Eigenschaften.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Eigenschaftswert

AnalyticalStorageConfiguration

apiProperties

API-spezifische Eigenschaften.

apiProperties?: ApiProperties

Eigenschaftswert

ApiProperties

backupPolicy

Das Objekt, das die Richtlinie zum Erstellen von Sicherungen für ein Konto darstellt.

backupPolicy?: BackupPolicyUnion

Eigenschaftswert

BackupPolicyUnion

capabilities

Liste der Cosmos DB-Funktionen für das Konto

capabilities?: Capability[]

Eigenschaftswert

Capability[]

capacity

Das Objekt, das alle Eigenschaften im Zusammenhang mit der Kapazitätserzwingung für ein Konto darstellt.

capacity?: Capacity

Eigenschaftswert

Capacity

connectorOffer

Der Cassandra Connector-Angebotstyp für das Cosmos DB-Datenbank-C*-Konto.

connectorOffer?: string

Eigenschaftswert

string

consistencyPolicy

Die Konsistenzrichtlinie für das Cosmos DB-Datenbankkonto.

consistencyPolicy?: ConsistencyPolicy

Eigenschaftswert

ConsistencyPolicy

cors

Die CORS-Richtlinie für das Cosmos DB-Datenbankkonto.

cors?: CorsPolicy[]

Eigenschaftswert

CorsPolicy[]

createMode

Aufzählung, um den Modus der Kontoerstellung anzugeben.

createMode?: string

Eigenschaftswert

string

customerManagedKeyStatus

Gibt den Status des Features "Vom Kunden verwalteter Schlüssel" für das Konto an. Falls Fehler auftreten, bietet die Eigenschaft Anleitungen zur Problembehandlung.

customerManagedKeyStatus?: string

Eigenschaftswert

string

databaseAccountOfferType

Der Angebotstyp für das Cosmos DB-Datenbankkonto. Standardwert: Standard. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

databaseAccountOfferType?: "Standard"

Eigenschaftswert

"Standard"

defaultIdentity

Die Standardidentität für den Zugriff auf den Schlüsseltresor, der in Features wie vom Kunden verwalteten Schlüsseln verwendet wird. Die Standardidentität muss explizit von den Benutzern festgelegt werden. Dies kann "FirstPartyIdentity", "SystemAssignedIdentity" und mehr sein.

defaultIdentity?: string

Eigenschaftswert

string

disableKeyBasedMetadataWriteAccess

Deaktivieren von Schreibvorgängen für Metadatenressourcen (Datenbanken, Container, Durchsatz) über Kontoschlüssel

disableKeyBasedMetadataWriteAccess?: boolean

Eigenschaftswert

boolean

disableLocalAuth

Deaktivieren Sie die lokale Authentifizierung, und stellen Sie sicher, dass nur MSI und AAD ausschließlich für die Authentifizierung verwendet werden können.

disableLocalAuth?: boolean

Eigenschaftswert

boolean

documentEndpoint

Der Verbindungsendpunkt für das Cosmos DB-Datenbankkonto. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

documentEndpoint?: string

Eigenschaftswert

string

enableAnalyticalStorage

Kennzeichnen, um anzugeben, ob Speicheranalysen aktiviert werden sollen.

enableAnalyticalStorage?: boolean

Eigenschaftswert

boolean

enableAutomaticFailover

Aktiviert das automatische Failover des Schreibbereichs im seltenen Fall, dass die Region aufgrund eines Ausfalls nicht verfügbar ist. Das automatische Failover führt zu einem neuen Schreibbereich für das Konto und wird basierend auf den für das Konto konfigurierten Failoverprioritäten ausgewählt.

enableAutomaticFailover?: boolean

Eigenschaftswert

boolean

enableBurstCapacity

Flag zum Aktivieren/Deaktivieren der Funktion "Burst Capacity" auf dem Konto

enableBurstCapacity?: boolean

Eigenschaftswert

boolean

enableCassandraConnector

Aktiviert den Cassandra Connector auf dem Cosmos DB C*-Konto

enableCassandraConnector?: boolean

Eigenschaftswert

boolean

enableFreeTier

Kennzeichnung, um anzugeben, ob die kostenlose Leiste aktiviert ist.

enableFreeTier?: boolean

Eigenschaftswert

boolean

enableMultipleWriteLocations

Ermöglicht das Schreiben des Kontos an mehreren Speicherorten.

enableMultipleWriteLocations?: boolean

Eigenschaftswert

boolean

enablePartitionMerge

Flag zum Aktivieren/Deaktivieren der Partitionszusammenführungsfunktion für das Konto

enablePartitionMerge?: boolean

Eigenschaftswert

boolean

enablePerRegionPerPartitionAutoscale

Flag zum Aktivieren/Deaktivieren des PerRegionPerPartitionAutoscale-Features für das Konto

enablePerRegionPerPartitionAutoscale?: boolean

Eigenschaftswert

boolean

failoverPolicies

Ein Array, das die Regionen enthält, die nach ihren Failoverprioritäten sortiert sind. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

failoverPolicies?: FailoverPolicy[]

Eigenschaftswert

FailoverPolicy[]

identity

Identität für die Ressource.

identity?: ManagedServiceIdentity

Eigenschaftswert

ManagedServiceIdentity

instanceId

Ein eindeutiger Bezeichner, der dem Datenbankkontohinweis zugewiesen ist: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

instanceId?: string

Eigenschaftswert

string

ipRules

Liste der IpRules.

ipRules?: IpAddressOrRange[]

Eigenschaftswert

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Kennzeichnen, um anzugeben, ob ACL-Regeln für virtuelle Netzwerke aktiviert/deaktiviert werden sollen.

isVirtualNetworkFilterEnabled?: boolean

Eigenschaftswert

boolean

keysMetadata

Das Objekt, das die Metadaten für die Kontoschlüssel des Cosmos DB-Kontos darstellt. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

keysMetadata?: DatabaseAccountKeysMetadata

Eigenschaftswert

DatabaseAccountKeysMetadata

keyVaultKeyUri

Der URI des Schlüsseltresors

keyVaultKeyUri?: string

Eigenschaftswert

string

kind

Gibt den Typ des Datenbankkontos an. Dies kann nur bei der Datenbankkontoerstellung festgelegt werden.

kind?: string

Eigenschaftswert

string

locations

Ein Array, das alle für das Cosmos DB-Konto aktivierten Speicherorte enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

locations?: Location_2[]

Eigenschaftswert

Location[]

minimalTlsVersion

Gibt die mindestens zulässige Tls-Version an. Der Standardwert ist Tls 1.2. Cassandra- und Mongo-APIs funktionieren nur mit Tls 1.2.

minimalTlsVersion?: string

Eigenschaftswert

string

networkAclBypass

Gibt an, welche Dienste Firewallprüfungen umgehen dürfen.

networkAclBypass?: NetworkAclBypass

Eigenschaftswert

NetworkAclBypass

networkAclBypassResourceIds

Ein Array, das die Ressourcen-IDs für die Netzwerk-Acl-Umgehung für das Cosmos DB-Konto enthält.

networkAclBypassResourceIds?: string[]

Eigenschaftswert

string[]

privateEndpointConnections

Liste der privaten Endpunktverbindungen, die für das Cosmos DB-Konto konfiguriert sind. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

privateEndpointConnections?: PrivateEndpointConnection[]

Eigenschaftswert

PrivateEndpointConnection[]

provisioningState

Der Status des Cosmos DB-Kontos zum Zeitpunkt des Aufrufs des Vorgangs. Der Status kann eine der folgenden Sein: "Creating" – das Cosmos DB-Konto wird erstellt. Wenn sich ein Konto im Zustand "Erstellen" befindet, werden nur Eigenschaften zurückgegeben, die als Eingabe für den Create Cosmos DB-Kontovorgang angegeben werden. "Succeeded" – das Cosmos DB-Konto ist für die Verwendung aktiv. "Aktualisieren" – das Cosmos DB-Konto wird aktualisiert. "Löschen" – das Cosmos DB-Konto wird gelöscht. "Failed" – Das Cosmos DB-Konto konnte nicht erstellt werden. "DeleteFailed" – Fehler beim Löschen des Cosmos DB-Kontos. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

provisioningState?: string

Eigenschaftswert

string

publicNetworkAccess

Gibt an, ob Anforderungen aus dem öffentlichen Netzwerk zulässig sind.

publicNetworkAccess?: string

Eigenschaftswert

string

readLocations

Ein Array mit den für das Cosmos DB-Konto aktivierten Lesespeicherorten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

readLocations?: Location_2[]

Eigenschaftswert

Location[]

restoreParameters

Parameter, die die Informationen zur Wiederherstellung angeben sollen.

restoreParameters?: RestoreParameters

Eigenschaftswert

RestoreParameters

systemData

Die Systemmetadaten, die sich auf diese Ressource beziehen. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

systemData?: SystemData

Eigenschaftswert

SystemData

virtualNetworkRules

Liste der Virtual Network ACL-Regeln, die für das Cosmos DB-Konto konfiguriert sind.

virtualNetworkRules?: VirtualNetworkRule[]

Eigenschaftswert

VirtualNetworkRule[]

writeLocations

Ein Array, das den Schreibspeicherort für das Cosmos DB-Konto enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

writeLocations?: Location_2[]

Eigenschaftswert

Location[]

Geerbte Eigenschaftsdetails

id

Der eindeutige Ressourcenbezeichner der ARM-Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

geerbt vonARMResourceProperties.id

location

Der Speicherort der Ressourcengruppe, zu der die Ressource gehört.

location?: string

Eigenschaftswert

string

geerbt vonARMResourceProperties.location

name

Der Name der ARM-Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

geerbt vonARMResourceProperties.name

tags

Tags sind eine Liste von Schlüssel-Wert-Paaren, die die Ressource beschreiben. Diese Tags können zum Anzeigen und Gruppieren dieser Ressource (über Ressourcengruppen hinweg) verwendet werden. Für eine Ressource können maximal 15 Tags bereitgestellt werden. Jedes Tag muss einen Schlüssel haben, der nicht größer als 128 Zeichen ist, und der Wert darf maximal 256 Zeichen lang sein. Beispielsweise wird die Standardoberfläche für einen Vorlagentyp mit "defaultExperience": "Cassandra" festgelegt. Aktuelle "defaultExperience"-Werte enthalten auch "Table", "Graph", "DocumentDB" und "MongoDB".

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

Eigenschaftswert

{[propertyName: string]: string}

vonARMResourceProperties.tags geerbt

type

Der Typ der Azure-Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

geerbt vonARMResourceProperties.type