DatabaseAccountCreateUpdateParameters interface

Pakiet:

@azure/arm-cosmosdb

Parametry do tworzenia i aktualizowania kont bazy danych usługi Cosmos DB.

Rozszerzenie

ARMResourceProperties

Właściwości

analyticalStorageConfiguration	Właściwości specyficzne dla magazynu analitycznego.
apiProperties	Właściwości specyficzne dla interfejsu API. Obecnie obsługiwane tylko dla interfejsu API bazy danych MongoDB.
backupPolicy	Obiekt reprezentujący zasady tworzenia kopii zapasowych na koncie.
capabilities	Lista możliwości usługi Cosmos DB dla konta
capacity	Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie.
capacityMode	Wskazuje wartość capacityMode konta usługi Cosmos DB.
connectorOffer	Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*.
consistencyPolicy	Zasady spójności dla konta usługi Cosmos DB.
cors	Zasady CORS dla konta bazy danych usługi Cosmos DB.
createMode	Wyliczenie wskazujące tryb tworzenia konta.
customerManagedKeyStatus	Wskazuje stan funkcji Klucz zarządzany przez klienta na koncie. W przypadku wystąpienia błędów właściwość zawiera wskazówki dotyczące rozwiązywania problemów.
databaseAccountOfferType	Typ oferty bazy danych
defaultIdentity	Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanych w funkcjach, takich jak klucze zarządzane przez klienta. Tożsamość domyślna musi być jawnie ustawiona przez użytkowników. Może to być "FirstPartyIdentity", "SystemAssignedIdentity" i nie tylko.
defaultPriorityLevel	Wyliczenie wskazujące domyślny poziom priorytetu żądania dla wykonania na podstawie priorytetu.
diagnosticLogSettings	Obiekt reprezentujący różne ustawienia dziennika diagnostycznego dla konta usługi Cosmos DB.
disableKeyBasedMetadataWriteAccess	Wyłączanie operacji zapisu na zasobach metadanych (bazach danych, kontenerach, przepływności) za pomocą kluczy konta
disableLocalAuth	Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD.
enableAllVersionsAndDeletesChangeFeed	Flaga wskazująca, czy na koncie jest włączona funkcja Wszystkie wersje i Usuń zestawienie zmian
enableAnalyticalStorage	Flaga wskazująca, czy włączyć analizę magazynu.
enableAutomaticFailover	Włącza automatyczne przełączanie w tryb failover regionu zapisu w rzadkim przypadku, że region jest niedostępny z powodu awarii. Automatyczne przełączanie w tryb failover spowoduje utworzenie nowego regionu zapisu dla konta i zostanie wybrane na podstawie priorytetów trybu failover skonfigurowanych dla konta.
enableBurstCapacity	Flaga wskazująca włączanie/wyłączanie funkcji Burst Capacity Preview na koncie
enableCassandraConnector	Włącza łącznik cassandra na koncie usługi Cosmos DB C*
enableFreeTier	Flaga wskazująca, czy warstwa Bezpłatna jest włączona.
enableMaterializedViews	Flaga wskazująca, czy włączyć materializedViews na koncie usługi Cosmos DB
enableMultipleWriteLocations	Umożliwia zapisanie konta w wielu lokalizacjach
enablePartitionMerge	Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie
enablePerRegionPerPartitionAutoscale	Flaga wskazująca włączanie/wyłączanie funkcji automatycznego skalowania na partycję Per-Region na koncie
enablePriorityBasedExecution	Flaga wskazująca włączanie/wyłączanie funkcji podglądu wykonywania na podstawie priorytetu na koncie
ipRules	Lista adresów IPRules.
isVirtualNetworkFilterEnabled	Flaga wskazująca, czy należy włączyć/wyłączyć reguły listy ACL sieci wirtualnej.
keysMetadata	Ta właściwość jest ignorowana podczas operacji aktualizacji/tworzenia, ponieważ metadane są tylko do odczytu. Obiekt reprezentuje metadane kluczy konta konta usługi Cosmos DB. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
keyVaultKeyUri	Identyfikator URI magazynu kluczy
kind	Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych.
locations	Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB.
minimalTlsVersion	Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.0, z wyjątkiem interfejsów API Cassandra i Mongo, które działają tylko z protokołem Tls 1.2.
networkAclBypass	Wskazuje, jakie usługi mogą pomijać kontrole zapory.
networkAclBypassResourceIds	Tablica zawierająca identyfikatory zasobów dla obejścia listy Acl sieci dla konta usługi Cosmos DB.
publicNetworkAccess	Czy żądania z sieci publicznej są dozwolone
restoreParameters	Parametry wskazujące informacje o przywracaniu.
virtualNetworkRules	Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB.

Właściwości dziedziczone

id	Unikatowy identyfikator zasobu usługi ARM. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
identity	Tożsamość zasobu.
location	Lokalizacja grupy zasobów, do której należy zasób.
name	Nazwa zasobu usługi ARM. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
tags	Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB".
type	Typ zasobu platformy Azure. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

analyticalStorageConfiguration

Właściwości specyficzne dla magazynu analitycznego.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Wartość właściwości

AnalyticalStorageConfiguration

apiProperties

Właściwości specyficzne dla interfejsu API. Obecnie obsługiwane tylko dla interfejsu API bazy danych MongoDB.

apiProperties?: ApiProperties

Wartość właściwości

ApiProperties

backupPolicy

Obiekt reprezentujący zasady tworzenia kopii zapasowych na koncie.

backupPolicy?: BackupPolicyUnion

Wartość właściwości

BackupPolicyUnion

capabilities

Lista możliwości usługi Cosmos DB dla konta

capabilities?: Capability[]

Wartość właściwości

Capability[]

capacity

Obiekt reprezentujący wszystkie właściwości związane z wymuszaniem pojemności na koncie.

capacity?: Capacity

Wartość właściwości

Capacity

capacityMode

Wskazuje wartość capacityMode konta usługi Cosmos DB.

capacityMode?: string

Wartość właściwości

string

connectorOffer

Typ oferty łącznika cassandra dla konta bazy danych Cosmos DB C*.

connectorOffer?: string

Wartość właściwości

string

consistencyPolicy

Zasady spójności dla konta usługi Cosmos DB.

consistencyPolicy?: ConsistencyPolicy

Wartość właściwości

ConsistencyPolicy

cors

Zasady CORS dla konta bazy danych usługi Cosmos DB.

cors?: CorsPolicy[]

Wartość właściwości

CorsPolicy[]

createMode

Wyliczenie wskazujące tryb tworzenia konta.

createMode?: string

Wartość właściwości

string

customerManagedKeyStatus

Wskazuje stan funkcji Klucz zarządzany przez klienta na koncie. W przypadku wystąpienia błędów właściwość zawiera wskazówki dotyczące rozwiązywania problemów.

customerManagedKeyStatus?: string

Wartość właściwości

string

databaseAccountOfferType

Typ oferty bazy danych

databaseAccountOfferType: "Standard"

Wartość właściwości

"Standard"

defaultIdentity

Domyślna tożsamość na potrzeby uzyskiwania dostępu do magazynu kluczy używanych w funkcjach, takich jak klucze zarządzane przez klienta. Tożsamość domyślna musi być jawnie ustawiona przez użytkowników. Może to być "FirstPartyIdentity", "SystemAssignedIdentity" i nie tylko.

defaultIdentity?: string

Wartość właściwości

string

defaultPriorityLevel

Wyliczenie wskazujące domyślny poziom priorytetu żądania dla wykonania na podstawie priorytetu.

defaultPriorityLevel?: string

Wartość właściwości

string

diagnosticLogSettings

Obiekt reprezentujący różne ustawienia dziennika diagnostycznego dla konta usługi Cosmos DB.

diagnosticLogSettings?: DiagnosticLogSettings

Wartość właściwości

DiagnosticLogSettings

disableKeyBasedMetadataWriteAccess

Wyłączanie operacji zapisu na zasobach metadanych (bazach danych, kontenerach, przepływności) za pomocą kluczy konta

disableKeyBasedMetadataWriteAccess?: boolean

Wartość właściwości

boolean

disableLocalAuth

Rezygnacja z uwierzytelniania lokalnego i upewnienie się, że do uwierzytelniania można używać tylko tożsamości usługi zarządzanej i usługi AAD.

disableLocalAuth?: boolean

Wartość właściwości

boolean

enableAllVersionsAndDeletesChangeFeed

Flaga wskazująca, czy na koncie jest włączona funkcja Wszystkie wersje i Usuń zestawienie zmian

enableAllVersionsAndDeletesChangeFeed?: boolean

Wartość właściwości

boolean

enableAnalyticalStorage

Flaga wskazująca, czy włączyć analizę magazynu.

enableAnalyticalStorage?: boolean

Wartość właściwości

boolean

enableAutomaticFailover

Włącza automatyczne przełączanie w tryb failover regionu zapisu w rzadkim przypadku, że region jest niedostępny z powodu awarii. Automatyczne przełączanie w tryb failover spowoduje utworzenie nowego regionu zapisu dla konta i zostanie wybrane na podstawie priorytetów trybu failover skonfigurowanych dla konta.

enableAutomaticFailover?: boolean

Wartość właściwości

boolean

enableBurstCapacity

Flaga wskazująca włączanie/wyłączanie funkcji Burst Capacity Preview na koncie

enableBurstCapacity?: boolean

Wartość właściwości

boolean

enableCassandraConnector

Włącza łącznik cassandra na koncie usługi Cosmos DB C*

enableCassandraConnector?: boolean

Wartość właściwości

boolean

enableFreeTier

Flaga wskazująca, czy warstwa Bezpłatna jest włączona.

enableFreeTier?: boolean

Wartość właściwości

boolean

enableMaterializedViews

Flaga wskazująca, czy włączyć materializedViews na koncie usługi Cosmos DB

enableMaterializedViews?: boolean

Wartość właściwości

boolean

enableMultipleWriteLocations

Umożliwia zapisanie konta w wielu lokalizacjach

enableMultipleWriteLocations?: boolean

Wartość właściwości

boolean

enablePartitionMerge

Flaga wskazująca włączanie/wyłączanie funkcji Scalanie partycji na koncie

enablePartitionMerge?: boolean

Wartość właściwości

boolean

enablePerRegionPerPartitionAutoscale

Flaga wskazująca włączanie/wyłączanie funkcji automatycznego skalowania na partycję Per-Region na koncie

enablePerRegionPerPartitionAutoscale?: boolean

Wartość właściwości

boolean

enablePriorityBasedExecution

Flaga wskazująca włączanie/wyłączanie funkcji podglądu wykonywania na podstawie priorytetu na koncie

enablePriorityBasedExecution?: boolean

Wartość właściwości

boolean

ipRules

Lista adresów IPRules.

ipRules?: IpAddressOrRange[]

Wartość właściwości

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Flaga wskazująca, czy należy włączyć/wyłączyć reguły listy ACL sieci wirtualnej.

isVirtualNetworkFilterEnabled?: boolean

Wartość właściwości

boolean

keysMetadata

Ta właściwość jest ignorowana podczas operacji aktualizacji/tworzenia, ponieważ metadane są tylko do odczytu. Obiekt reprezentuje metadane kluczy konta konta usługi Cosmos DB. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

keysMetadata?: DatabaseAccountKeysMetadata

Wartość właściwości

DatabaseAccountKeysMetadata

keyVaultKeyUri

Identyfikator URI magazynu kluczy

keyVaultKeyUri?: string

Wartość właściwości

string

kind

Wskazuje typ konta bazy danych. Można to ustawić tylko podczas tworzenia konta bazy danych.

kind?: string

Wartość właściwości

string

locations

Tablica zawierająca lokalizacje georeplikacji włączone dla konta usługi Cosmos DB.

locations: Location[]

Wartość właściwości

Location[]

minimalTlsVersion

Wskazuje minimalną dozwoloną wersję protokołu Tls. Wartość domyślna to Tls 1.0, z wyjątkiem interfejsów API Cassandra i Mongo, które działają tylko z protokołem Tls 1.2.

minimalTlsVersion?: string

Wartość właściwości

string

networkAclBypass

Wskazuje, jakie usługi mogą pomijać kontrole zapory.

networkAclBypass?: NetworkAclBypass

Wartość właściwości

NetworkAclBypass

networkAclBypassResourceIds

Tablica zawierająca identyfikatory zasobów dla obejścia listy Acl sieci dla konta usługi Cosmos DB.

networkAclBypassResourceIds?: string[]

Wartość właściwości

string[]

publicNetworkAccess

Czy żądania z sieci publicznej są dozwolone

publicNetworkAccess?: string

Wartość właściwości

string

restoreParameters

Parametry wskazujące informacje o przywracaniu.

restoreParameters?: RestoreParameters

Wartość właściwości

RestoreParameters

virtualNetworkRules

Lista reguł listy ACL sieci wirtualnej skonfigurowanych dla konta usługi Cosmos DB.

virtualNetworkRules?: VirtualNetworkRule[]

Wartość właściwości

VirtualNetworkRule[]

Szczegóły właściwości dziedziczonej

id

Unikatowy identyfikator zasobu usługi ARM. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

dziedziczone zARMResourceProperties.id

identity

Tożsamość zasobu.

identity?: ManagedServiceIdentity

Wartość właściwości

ManagedServiceIdentity

dziedziczone zARMResourceProperties.identity

location

Lokalizacja grupy zasobów, do której należy zasób.

location?: string

Wartość właściwości

string

dziedziczone zARMResourceProperties.location

name

Nazwa zasobu usługi ARM. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

dziedziczone zARMResourceProperties.name

tags

Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawione z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB".

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

Wartość właściwości

{[propertyName: string]: string}

dziedziczone zARMResourceProperties.tags

type

Typ zasobu platformy Azure. UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

dziedziczone zARMResourceProperties.type