DatabaseAccountGetResults interface

Balíček:

@azure/arm-cosmosdb

Účet databáze Azure Cosmos DB.

Extends

ARMResourceProperties

Vlastnosti

analyticalStorageConfiguration	Vlastnosti specifické pro analytické úložiště
apiProperties	Vlastnosti specifické pro rozhraní API
backupPolicy	Objekt představující zásadu pro zálohování účtu.
capabilities	Seznam možností služby Cosmos DB pro účet
capacity	Objekt, který představuje všechny vlastnosti související s vynucení kapacity u účtu.
connectorOffer	Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB.
consistencyPolicy	Zásady konzistence pro účet databáze Cosmos DB.
cors	Zásady CORS pro účet databáze Cosmos DB.
createMode	Výčet označující režim vytváření účtu.
customerManagedKeyStatus	Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží.
databaseAccountOfferType	Typ nabídky pro účet databáze Cosmos DB. Výchozí hodnota: Standard. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
defaultIdentity	Výchozí identita pro přístup k trezoru klíčů používaným ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další.
defaultPriorityLevel	Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority.
disableKeyBasedMetadataWriteAccess	Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu
disableLocalAuth	Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD.
documentEndpoint	Koncový bod připojení pro účet databáze Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
enableAnalyticalStorage	Příznak označující, jestli se má povolit analýza úložiště.
enableAutomaticFailover	Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet.
enableBurstCapacity	Příznak označující povolení nebo zakázání funkce burstové kapacity v účtu
enableCassandraConnector	Povolí konektor Cassandra v účtu C* služby Cosmos DB.
enableFreeTier	Příznak označující, jestli je povolená úroveň Free.
enableMultipleWriteLocations	Umožňuje účtu zapisovat do více umístění.
enablePartitionMerge	Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu
enablePerRegionPerPartitionAutoscale	Příznak označující povolení nebo zakázání funkce PerRegionPerPartitionAutoscale v účtu
enablePriorityBasedExecution	Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu
failoverPolicies	Pole, které obsahuje oblasti seřazené podle priorit převzetí služeb při selhání. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
identity	Identita prostředku
instanceId	Jedinečný identifikátor přiřazený k databázovému účtu POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
ipRules	Seznam iprules
isVirtualNetworkFilterEnabled	Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě.
keysMetadata	Objekt, který představuje metadata pro klíče účtu služby Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
keyVaultKeyUri	Identifikátor URI trezoru klíčů
keyVaultKeyUriVersion	Verze Customer Managed Key, kterou účet aktuálně používá. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
kind	Určuje typ databázového účtu. To lze nastavit pouze při vytváření účtu databáze.
locations	Pole, které obsahuje všechna umístění povolená pro účet Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
minimalTlsVersion	Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem Tls 1.2.
networkAclBypass	Označuje, které služby mají povoleno obejít kontroly brány firewall.
networkAclBypassResourceIds	Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB.
privateEndpointConnections	Seznam připojení privátních koncových bodů nakonfigurovaných pro účet Cosmos DB POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
provisioningState	Stav účtu služby Cosmos DB v době, kdy byla operace volána. Stav může být jeden z následujících. Vytváření – vytváří se účet Cosmos DB. Pokud je účet ve stavu Vytváření, vrátí se pouze vlastnosti, které jsou zadány jako vstup pro operaci vytvoření účtu Cosmos DB. Úspěch – účet cosmos DB je aktivní pro použití. Aktualizace – aktualizuje se účet služby Cosmos DB. Odstranění – účet Cosmos DB se odstraňuje. Chyba – účet služby Cosmos DB selhal při vytváření. Odstranění se nezdařilo – odstranění účtu služby Cosmos DB se nezdařilo. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
publicNetworkAccess	Jestli jsou povolené požadavky z veřejné sítě
readLocations	Pole obsahující umístění pro čtení povolená pro účet Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
restoreParameters	Parametry označující informace o obnovení
systemData	Systémová meta data týkající se tohoto prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
virtualNetworkRules	Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB
writeLocations	Pole, které obsahuje umístění zápisu pro účet Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

Zděděné vlastnosti

id	Jedinečný identifikátor prostředku ARM. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
location	Umístění skupiny prostředků, do které prostředek patří.
name	Název prostředku ARM. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.
tags	Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB".
type	Typ prostředku Azure. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

Podrobnosti vlastnosti

analyticalStorageConfiguration

Vlastnosti specifické pro analytické úložiště

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Hodnota vlastnosti

AnalyticalStorageConfiguration

apiProperties

Vlastnosti specifické pro rozhraní API

apiProperties?: ApiProperties

Hodnota vlastnosti

ApiProperties

backupPolicy

Objekt představující zásadu pro zálohování účtu.

backupPolicy?: BackupPolicyUnion

Hodnota vlastnosti

BackupPolicyUnion

capabilities

Seznam možností služby Cosmos DB pro účet

capabilities?: Capability[]

Hodnota vlastnosti

Capability[]

capacity

Objekt, který představuje všechny vlastnosti související s vynucení kapacity u účtu.

capacity?: Capacity

Hodnota vlastnosti

Capacity

connectorOffer

Typ nabídky konektoru Cassandra pro účet C* databáze Cosmos DB.

connectorOffer?: string

Hodnota vlastnosti

string

consistencyPolicy

Zásady konzistence pro účet databáze Cosmos DB.

consistencyPolicy?: ConsistencyPolicy

Hodnota vlastnosti

ConsistencyPolicy

cors

Zásady CORS pro účet databáze Cosmos DB.

cors?: CorsPolicy[]

Hodnota vlastnosti

CorsPolicy[]

createMode

Výčet označující režim vytváření účtu.

createMode?: string

Hodnota vlastnosti

string

customerManagedKeyStatus

Označuje stav funkce klíče spravovaného zákazníkem v účtu. V případě chyb tato vlastnost poskytuje pokyny k řešení potíží.

customerManagedKeyStatus?: string

Hodnota vlastnosti

string

databaseAccountOfferType

Typ nabídky pro účet databáze Cosmos DB. Výchozí hodnota: Standard. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

databaseAccountOfferType?: "Standard"

Hodnota vlastnosti

"Standard"

defaultIdentity

Výchozí identita pro přístup k trezoru klíčů používaným ve funkcích, jako jsou klíče spravované zákazníkem. Výchozí identitu musí uživatelé explicitně nastavit. Může to být FirstPartyIdentity, SystemAssignedIdentity a další.

defaultIdentity?: string

Hodnota vlastnosti

string

defaultPriorityLevel

Výčet označující výchozí úroveň priority požadavku pro spouštění na základě priority.

defaultPriorityLevel?: string

Hodnota vlastnosti

string

disableKeyBasedMetadataWriteAccess

Zakázání operací zápisu u prostředků metadat (databáze, kontejnery, propustnost) prostřednictvím klíčů účtu

disableKeyBasedMetadataWriteAccess?: boolean

Hodnota vlastnosti

boolean

disableLocalAuth

Odhlaste se od místního ověřování a ujistěte se, že se k ověřování dají používat jenom MSI a AAD.

disableLocalAuth?: boolean

Hodnota vlastnosti

boolean

documentEndpoint

Koncový bod připojení pro účet databáze Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

documentEndpoint?: string

Hodnota vlastnosti

string

enableAnalyticalStorage

Příznak označující, jestli se má povolit analýza úložiště.

enableAnalyticalStorage?: boolean

Hodnota vlastnosti

boolean

enableAutomaticFailover

Umožňuje automatické převzetí služeb při selhání oblasti zápisu ve výjimečných událostech, že oblast není dostupná kvůli výpadku. Automatické převzetí služeb při selhání bude mít za následek novou oblast zápisu pro účet a zvolí se na základě priorit převzetí služeb při selhání nakonfigurovaných pro účet.

enableAutomaticFailover?: boolean

Hodnota vlastnosti

boolean

enableBurstCapacity

Příznak označující povolení nebo zakázání funkce burstové kapacity v účtu

enableBurstCapacity?: boolean

Hodnota vlastnosti

boolean

enableCassandraConnector

Povolí konektor Cassandra v účtu C* služby Cosmos DB.

enableCassandraConnector?: boolean

Hodnota vlastnosti

boolean

enableFreeTier

Příznak označující, jestli je povolená úroveň Free.

enableFreeTier?: boolean

Hodnota vlastnosti

boolean

enableMultipleWriteLocations

Umožňuje účtu zapisovat do více umístění.

enableMultipleWriteLocations?: boolean

Hodnota vlastnosti

boolean

enablePartitionMerge

Příznak označující povolení nebo zakázání funkce sloučení oddílů v účtu

enablePartitionMerge?: boolean

Hodnota vlastnosti

boolean

enablePerRegionPerPartitionAutoscale

Příznak označující povolení nebo zakázání funkce PerRegionPerPartitionAutoscale v účtu

enablePerRegionPerPartitionAutoscale?: boolean

Hodnota vlastnosti

boolean

enablePriorityBasedExecution

Příznak označující povolení nebo zakázání funkce Náhledu na základě priority v účtu

enablePriorityBasedExecution?: boolean

Hodnota vlastnosti

boolean

failoverPolicies

Pole, které obsahuje oblasti seřazené podle priorit převzetí služeb při selhání. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

failoverPolicies?: FailoverPolicy[]

Hodnota vlastnosti

FailoverPolicy[]

identity

Identita prostředku

identity?: ManagedServiceIdentity

Hodnota vlastnosti

ManagedServiceIdentity

instanceId

Jedinečný identifikátor přiřazený k databázovému účtu POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

instanceId?: string

Hodnota vlastnosti

string

ipRules

Seznam iprules

ipRules?: IpAddressOrRange[]

Hodnota vlastnosti

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Příznak označující, jestli se mají povolit nebo zakázat pravidla seznamu ACL virtuální sítě.

isVirtualNetworkFilterEnabled?: boolean

Hodnota vlastnosti

boolean

keysMetadata

Objekt, který představuje metadata pro klíče účtu služby Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

keysMetadata?: DatabaseAccountKeysMetadata

Hodnota vlastnosti

DatabaseAccountKeysMetadata

keyVaultKeyUri

Identifikátor URI trezoru klíčů

keyVaultKeyUri?: string

Hodnota vlastnosti

string

keyVaultKeyUriVersion

Verze Customer Managed Key, kterou účet aktuálně používá. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

keyVaultKeyUriVersion?: string

Hodnota vlastnosti

string

kind

Určuje typ databázového účtu. To lze nastavit pouze při vytváření účtu databáze.

kind?: string

Hodnota vlastnosti

string

locations

Pole, které obsahuje všechna umístění povolená pro účet Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

locations?: Location[]

Hodnota vlastnosti

Location[]

minimalTlsVersion

Označuje minimální povolenou verzi protokolu TLS. Výchozí hodnota je Tls 1.2. Rozhraní API Cassandra a Mongo fungují jenom s protokolem Tls 1.2.

minimalTlsVersion?: string

Hodnota vlastnosti

string

networkAclBypass

Označuje, které služby mají povoleno obejít kontroly brány firewall.

networkAclBypass?: NetworkAclBypass

Hodnota vlastnosti

NetworkAclBypass

networkAclBypassResourceIds

Pole obsahující ID prostředků pro vynechání seznamu Acl sítě pro účet Cosmos DB.

networkAclBypassResourceIds?: string[]

Hodnota vlastnosti

string[]

privateEndpointConnections

Seznam připojení privátních koncových bodů nakonfigurovaných pro účet Cosmos DB POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

privateEndpointConnections?: PrivateEndpointConnection[]

Hodnota vlastnosti

PrivateEndpointConnection[]

provisioningState

Stav účtu služby Cosmos DB v době, kdy byla operace volána. Stav může být jeden z následujících. Vytváření – vytváří se účet Cosmos DB. Pokud je účet ve stavu Vytváření, vrátí se pouze vlastnosti, které jsou zadány jako vstup pro operaci vytvoření účtu Cosmos DB. Úspěch – účet cosmos DB je aktivní pro použití. Aktualizace – aktualizuje se účet služby Cosmos DB. Odstranění – účet Cosmos DB se odstraňuje. Chyba – účet služby Cosmos DB selhal při vytváření. Odstranění se nezdařilo – odstranění účtu služby Cosmos DB se nezdařilo. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

provisioningState?: string

Hodnota vlastnosti

string

publicNetworkAccess

Jestli jsou povolené požadavky z veřejné sítě

publicNetworkAccess?: string

Hodnota vlastnosti

string

readLocations

Pole obsahující umístění pro čtení povolená pro účet Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

readLocations?: Location[]

Hodnota vlastnosti

Location[]

restoreParameters

Parametry označující informace o obnovení

restoreParameters?: RestoreParameters

Hodnota vlastnosti

RestoreParameters

systemData

Systémová meta data týkající se tohoto prostředku. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

systemData?: SystemData

Hodnota vlastnosti

SystemData

virtualNetworkRules

Seznam pravidel seznamu ACL virtuálních sítí nakonfigurovaných pro účet služby Cosmos DB

virtualNetworkRules?: VirtualNetworkRule[]

Hodnota vlastnosti

VirtualNetworkRule[]

writeLocations

Pole, které obsahuje umístění zápisu pro účet Cosmos DB. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

writeLocations?: Location[]

Hodnota vlastnosti

Location[]

Podrobnosti zděděných vlastností

id

Jedinečný identifikátor prostředku ARM. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

id?: string

Hodnota vlastnosti

string

zděděno zARMResourceProperties.id

location

Umístění skupiny prostředků, do které prostředek patří.

location?: string

Hodnota vlastnosti

string

zděděno zARMResourceProperties.location

name

Název prostředku ARM. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

name?: string

Hodnota vlastnosti

string

zděděno zeARMResourceProperties.name

tags

Značky jsou seznam párů klíč-hodnota, které popisují prostředek. Tyto značky je možné použít k zobrazení a seskupování tohoto prostředku (napříč skupinami prostředků). Pro prostředek je možné zadat maximálně 15 značek. Každá značka musí mít klíč maximálně 128 znaků a nesmí mít hodnotu větší než 256 znaků. Například výchozí prostředí pro typ šablony je nastaveno na defaultExperience: "Cassandra". Aktuální hodnoty defaultExperience zahrnují také "Table", "Graph", "DocumentDB" a "MongoDB".

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

Hodnota vlastnosti

{[propertyName: string]: string}

zděděno zARMResourceProperties.tags

type

Typ prostředku Azure. POZNÁMKA: Tato vlastnost nebude serializována. Server ho může naplnit pouze.

type?: string

Hodnota vlastnosti

string

zděděno zARMResourceProperties.type