Dela via

DatabaseAccountGetResults interface

Paket:
@azure/arm-cosmosdb

Ett Azure Cosmos DB-databaskonto.

Extends
ARMResourceProperties

Egenskaper

analyticalStorageConfiguration

Specifika egenskaper för analyslagring.
apiProperties

API-specifika egenskaper.
backupPolicy

Objektet som representerar principen för att ta säkerhetskopior på ett konto.
capabilities

Lista över Cosmos DB-funktioner för kontot
capacity

Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.
connectorOffer

Erbjudandetypen cassandra connector för Cosmos DB-databasens C*-konto.
consistencyPolicy

Konsekvensprincipen för Cosmos DB-databaskontot.
cors

CORS-principen för Cosmos DB-databaskontot.
createMode

Uppräkning för att ange läget för kontoskapande.
customerManagedKeyStatus

Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning.
databaseAccountOfferType

Erbjudandetypen för Cosmos DB-databaskontot. Standardvärde: Standard. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
defaultIdentity

Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera.
defaultPriorityLevel

Uppräkning för att ange standardprioritetsnivå för begäran för prioritetsbaserad körning.
disableKeyBasedMetadataWriteAccess

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

Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering.
documentEndpoint

Anslutningsslutpunkten för Cosmos DB-databaskontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
enableAnalyticalStorage

Flagga för att ange om lagringsanalys ska aktiveras.
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.
enableBurstCapacity

Flagga för att ange aktivering/inaktivering av burst-kapacitetsfunktionen på kontot
enableCassandraConnector

Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot
enableFreeTier

Flagga för att ange om den kostnadsfria nivån är aktiverad.
enableMultipleWriteLocations

Gör att kontot kan skriva på flera platser
enablePartitionMerge

Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot
enablePerRegionPerPartitionAutoscale

Flagga för att ange aktivering/inaktivering av funktionen PerRegionPerPartitionAutoscale på kontot
enablePriorityBasedExecution

Flagga för att ange aktivering/inaktivering av funktionen Förhandsgranskning av prioritetsbaserad körning på kontot
failoverPolicies

En matris som innehåller de regioner som sorteras efter deras redundansprioriteringar. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
identity

Identitet för resursen.
instanceId

En unik identifierare som tilldelats databaskontot OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
ipRules

Lista över IpRules.
isVirtualNetworkFilterEnabled

Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk.
keysMetadata

Objektet som representerar metadata för kontonycklarna för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
keyVaultKeyUri

URI för nyckelvalvet
keyVaultKeyUriVersion

Den version av Customer Managed Key som för närvarande används av kontot OBS: Denna egenskap kommer inte att serialiseras. Den kan bara fyllas i av servern.
kind

Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas.
locations

En matris som innehåller alla platser som är aktiverade för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
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.
networkAclBypass

Anger vilka tjänster som tillåts kringgå brandväggskontroller.
networkAclBypassResourceIds

En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot.
privateEndpointConnections

Lista över privata slutpunktsanslutningar som konfigurerats för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
provisioningState

Status för Cosmos DB-kontot när åtgärden anropades. Statusen kan vara något av följande. "Skapar" – Cosmos DB-kontot skapas. När ett konto är i läget Skapa returneras endast egenskaper som anges som indata för åtgärden Skapa Cosmos DB-konto. "Lyckades" – Cosmos DB-kontot är aktivt för användning. "Uppdaterar" – Cosmos DB-kontot uppdateras. "Tar bort" – Cosmos DB-kontot tas bort. "Misslyckades" – Cosmos DB-kontot kunde inte skapas. "DeletionFailed" – borttagningen av Cosmos DB-kontot misslyckades. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
publicNetworkAccess

Om begäranden från offentliga nätverk tillåts
readLocations

En matris som innehåller de läsplatser som är aktiverade för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
restoreParameters

Parametrar som anger information om återställningen.
systemData

Systemmetadata som är relaterade till den här resursen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
virtualNetworkRules

Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot.
writeLocations

En matris som innehåller skrivplatsen för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

Ärvda egenskaper

id

Den unika resursidentifieraren för ARM-resursen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
location

Platsen för den resursgrupp som resursen tillhör.
name

Namnet på ARM-resursen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
tags

Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".
type

Typen av Azure-resurs. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

Egenskapsinformation

analyticalStorageConfiguration

Specifika egenskaper för analyslagring.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Egenskapsvärde

AnalyticalStorageConfiguration

apiProperties

API-specifika egenskaper.

apiProperties?: ApiProperties

Egenskapsvärde

ApiProperties

backupPolicy

Objektet som representerar principen för att ta säkerhetskopior på ett konto.

backupPolicy?: BackupPolicyUnion

Egenskapsvärde

BackupPolicyUnion

capabilities

Lista över Cosmos DB-funktioner för kontot

capabilities?: Capability[]

Egenskapsvärde

Capability[]

capacity

Objektet som representerar alla egenskaper som är relaterade till kapacitetsframtvingande för ett konto.

capacity?: Capacity

Egenskapsvärde

Capacity

connectorOffer

Erbjudandetypen cassandra connector för Cosmos DB-databasens C*-konto.

connectorOffer?: string

Egenskapsvärde

string

consistencyPolicy

Konsekvensprincipen för Cosmos DB-databaskontot.

consistencyPolicy?: ConsistencyPolicy

Egenskapsvärde

ConsistencyPolicy

cors

CORS-principen för Cosmos DB-databaskontot.

cors?: CorsPolicy[]

Egenskapsvärde

CorsPolicy[]

createMode

Uppräkning för att ange läget för kontoskapande.

createMode?: string

Egenskapsvärde

string

customerManagedKeyStatus

Anger status för funktionen Kundhanterad nyckel för kontot. Om det finns fel ger egenskapen felsökningsvägledning.

customerManagedKeyStatus?: string

Egenskapsvärde

string

databaseAccountOfferType

Erbjudandetypen för Cosmos DB-databaskontot. Standardvärde: Standard. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

databaseAccountOfferType?: "Standard"

Egenskapsvärde

"Standard"

defaultIdentity

Standardidentiteten för åtkomst till nyckelvalv som används i funktioner som kundhanterade nycklar. Standardidentiteten måste uttryckligen anges av användarna. Det kan vara "FirstPartyIdentity", "SystemAssignedIdentity" med mera.

defaultIdentity?: string

Egenskapsvärde

string

defaultPriorityLevel

Uppräkning för att ange standardprioritetsnivå för begäran för prioritetsbaserad körning.

defaultPriorityLevel?: string

Egenskapsvärde

string

disableKeyBasedMetadataWriteAccess

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

disableKeyBasedMetadataWriteAccess?: boolean

Egenskapsvärde

boolean

disableLocalAuth

Välj bort lokal autentisering och se till att endast MSI och AAD kan användas uteslutande för autentisering.

disableLocalAuth?: boolean

Egenskapsvärde

boolean

documentEndpoint

Anslutningsslutpunkten för Cosmos DB-databaskontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

documentEndpoint?: string

Egenskapsvärde

string

enableAnalyticalStorage

Flagga för att ange om lagringsanalys ska aktiveras.

enableAnalyticalStorage?: boolean

Egenskapsvärde

boolean

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.

enableAutomaticFailover?: boolean

Egenskapsvärde

boolean

enableBurstCapacity

Flagga för att ange aktivering/inaktivering av burst-kapacitetsfunktionen på kontot

enableBurstCapacity?: boolean

Egenskapsvärde

boolean

enableCassandraConnector

Aktiverar cassandra-anslutningsappen på Cosmos DB C*-kontot

enableCassandraConnector?: boolean

Egenskapsvärde

boolean

enableFreeTier

Flagga för att ange om den kostnadsfria nivån är aktiverad.

enableFreeTier?: boolean

Egenskapsvärde

boolean

enableMultipleWriteLocations

Gör att kontot kan skriva på flera platser

enableMultipleWriteLocations?: boolean

Egenskapsvärde

boolean

enablePartitionMerge

Flagga för att ange aktivering/inaktivering av funktionen För sammanfogning av partition på kontot

enablePartitionMerge?: boolean

Egenskapsvärde

boolean

enablePerRegionPerPartitionAutoscale

Flagga för att ange aktivering/inaktivering av funktionen PerRegionPerPartitionAutoscale på kontot

enablePerRegionPerPartitionAutoscale?: boolean

Egenskapsvärde

boolean

enablePriorityBasedExecution

Flagga för att ange aktivering/inaktivering av funktionen Förhandsgranskning av prioritetsbaserad körning på kontot

enablePriorityBasedExecution?: boolean

Egenskapsvärde

boolean

failoverPolicies

En matris som innehåller de regioner som sorteras efter deras redundansprioriteringar. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

failoverPolicies?: FailoverPolicy[]

Egenskapsvärde

FailoverPolicy[]

identity

Identitet för resursen.

identity?: ManagedServiceIdentity

Egenskapsvärde

ManagedServiceIdentity

instanceId

En unik identifierare som tilldelats databaskontot OBS: Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

instanceId?: string

Egenskapsvärde

string

ipRules

Lista över IpRules.

ipRules?: IpAddressOrRange[]

Egenskapsvärde

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Flagga för att ange om du vill aktivera/inaktivera ACL-regler för virtuellt nätverk.

isVirtualNetworkFilterEnabled?: boolean

Egenskapsvärde

boolean

keysMetadata

Objektet som representerar metadata för kontonycklarna för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

keysMetadata?: DatabaseAccountKeysMetadata

Egenskapsvärde

DatabaseAccountKeysMetadata

keyVaultKeyUri

URI för nyckelvalvet

keyVaultKeyUri?: string

Egenskapsvärde

string

keyVaultKeyUriVersion

Den version av Customer Managed Key som för närvarande används av kontot OBS: Denna egenskap kommer inte att serialiseras. Den kan bara fyllas i av servern.

keyVaultKeyUriVersion?: string

Egenskapsvärde

string

kind

Anger typ av databaskonto. Detta kan bara anges när databaskontot skapas.

kind?: string

Egenskapsvärde

string

locations

En matris som innehåller alla platser som är aktiverade för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

locations?: Location[]

Egenskapsvärde

Location[]

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.

minimalTlsVersion?: string

Egenskapsvärde

string

networkAclBypass

Anger vilka tjänster som tillåts kringgå brandväggskontroller.

networkAclBypass?: NetworkAclBypass

Egenskapsvärde

NetworkAclBypass

networkAclBypassResourceIds

En matris som innehåller resurs-ID:n för Network Acl Bypass för Cosmos DB-kontot.

networkAclBypassResourceIds?: string[]

Egenskapsvärde

string[]

privateEndpointConnections

Lista över privata slutpunktsanslutningar som konfigurerats för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

privateEndpointConnections?: PrivateEndpointConnection[]

Egenskapsvärde

PrivateEndpointConnection[]

provisioningState

Status för Cosmos DB-kontot när åtgärden anropades. Statusen kan vara något av följande. "Skapar" – Cosmos DB-kontot skapas. När ett konto är i läget Skapa returneras endast egenskaper som anges som indata för åtgärden Skapa Cosmos DB-konto. "Lyckades" – Cosmos DB-kontot är aktivt för användning. "Uppdaterar" – Cosmos DB-kontot uppdateras. "Tar bort" – Cosmos DB-kontot tas bort. "Misslyckades" – Cosmos DB-kontot kunde inte skapas. "DeletionFailed" – borttagningen av Cosmos DB-kontot misslyckades. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

provisioningState?: string

Egenskapsvärde

string

publicNetworkAccess

Om begäranden från offentliga nätverk tillåts

publicNetworkAccess?: string

Egenskapsvärde

string

readLocations

En matris som innehåller de läsplatser som är aktiverade för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

readLocations?: Location[]

Egenskapsvärde

Location[]

restoreParameters

Parametrar som anger information om återställningen.

restoreParameters?: RestoreParameters

Egenskapsvärde

RestoreParameters

systemData

Systemmetadata som är relaterade till den här resursen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

systemData?: SystemData

Egenskapsvärde

SystemData

virtualNetworkRules

Lista över ACL-regler för virtuellt nätverk som konfigurerats för Cosmos DB-kontot.

virtualNetworkRules?: VirtualNetworkRule[]

Egenskapsvärde

VirtualNetworkRule[]

writeLocations

En matris som innehåller skrivplatsen för Cosmos DB-kontot. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

writeLocations?: Location[]

Egenskapsvärde

Location[]

Information om ärvda egenskaper

id

Den unika resursidentifieraren för ARM-resursen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

id?: string

Egenskapsvärde

string

ärvd frånARMResourceProperties.id

location

Platsen för den resursgrupp som resursen tillhör.

location?: string

Egenskapsvärde

string

ärvd frånARMResourceProperties.location

name

Namnet på ARM-resursen. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

name?: string

Egenskapsvärde

string

ärvd frånARMResourceProperties.name

tags

Taggar är en lista över nyckel/värde-par som beskriver resursen. Dessa taggar kan användas för att visa och gruppera den här resursen (mellan resursgrupper). Högst 15 taggar kan anges för en resurs. Varje tagg måste ha en nyckel som inte är större än 128 tecken och värdet får inte vara större än 256 tecken. Standardupplevelsen för en malltyp anges till exempel med "defaultExperience": "Cassandra". Aktuella "defaultExperience"-värden inkluderar även "Table", "Graph", "DocumentDB" och "MongoDB".

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

Egenskapsvärde

{[propertyName: string]: string}

ärvd frånARMResourceProperties.tags

type

Typen av Azure-resurs. Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.

type?: string

Egenskapsvärde

string

ärvs frånARMResourceProperties.type