DatabaseAccountGetResults interface

Paket:

@azure/arm-cosmosdb

Akun database Azure Cosmos DB.

Memperluas

ARMResourceProperties

Properti

analyticalStorageConfiguration	Properti khusus penyimpanan analitis.
apiProperties	Properti khusus API.
backupPolicy	Objek yang mewakili kebijakan untuk mengambil cadangan pada akun.
capabilities	Daftar kemampuan Cosmos DB untuk akun
capacity	Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.
connectorOffer	Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB.
consistencyPolicy	Kebijakan konsistensi untuk akun database Cosmos DB.
cors	Kebijakan CORS untuk akun database Cosmos DB.
createMode	Enum untuk menunjukkan mode pembuatan akun.
customerManagedKeyStatus	Menunjukkan status fitur Kunci yang Dikelola Pelanggan di akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah.
databaseAccountOfferType	Jenis penawaran untuk akun database Cosmos DB. Nilai default: Standar. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
defaultIdentity	Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi.
defaultPriorityLevel	Enum untuk menunjukkan Tingkat Prioritas default permintaan untuk Eksekusi Berbasis Prioritas.
disableKeyBasedMetadataWriteAccess	Nonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun
disableLocalAuth	Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi.
documentEndpoint	Titik akhir koneksi untuk akun database Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
enableAnalyticalStorage	Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan.
enableAutomaticFailover	Mengaktifkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun.
enableBurstCapacity	Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Kapasitas Burst pada akun
enableCassandraConnector	Mengaktifkan konektor cassandra pada akun Cosmos DB C*
enableFreeTier	Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan.
enableMultipleWriteLocations	Memungkinkan akun menulis di beberapa lokasi
enablePartitionMerge	Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Gabungan Partisi pada akun
enablePerRegionPerPartitionAutoscale	Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur PerRegionPerPartitionAutoscale pada akun
enablePriorityBasedExecution	Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Eksekusi Berbasis Prioritas pada akun
failoverPolicies	Array yang berisi wilayah yang diurutkan berdasarkan prioritas failover mereka. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
identity	Identitas untuk sumber daya.
instanceId	Pengidentifikasi unik yang ditetapkan ke akun database NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
ipRules	Daftar IpRules.
isVirtualNetworkFilterEnabled	Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan Virtual Network ACL.
keysMetadata	Objek yang mewakili metadata untuk Kunci Akun akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
keyVaultKeyUri	URI brankas kunci
keyVaultKeyUriVersion	Versi Kunci Terkelola Pelanggan yang saat ini digunakan oleh akun CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
kind	Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.
locations	Array yang berisi semua lokasi yang diaktifkan untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
minimalTlsVersion	Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.
networkAclBypass	Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.
networkAclBypassResourceIds	Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB.
privateEndpointConnections	Daftar Koneksi Titik Akhir Privat yang dikonfigurasi untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
provisioningState	Status akun Cosmos DB pada saat operasi dipanggil. Statusnya bisa menjadi salah satu dari berikut ini. 'Membuat' – akun Cosmos DB sedang dibuat. Saat akun dalam status Membuat, hanya properti yang ditentukan sebagai input untuk operasi Buat akun Cosmos DB yang dikembalikan. 'Berhasil' – akun Cosmos DB aktif untuk digunakan. 'Memperbarui' – akun Cosmos DB sedang diperbarui. 'Menghapus' – akun Cosmos DB sedang dihapus. 'Gagal' – pembuatan akun Cosmos DB gagal. 'DeletionFailed' – penghapusan akun Cosmos DB gagal. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
publicNetworkAccess	Apakah permintaan dari Jaringan Publik diizinkan
readLocations	Array yang berisi lokasi baca yang diaktifkan untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
restoreParameters	Parameter untuk menunjukkan informasi tentang pemulihan.
systemData	Data meta sistem yang berkaitan dengan sumber daya ini. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
virtualNetworkRules	Daftar aturan Virtual Network ACL yang dikonfigurasi untuk akun Cosmos DB.
writeLocations	Array yang berisi lokasi tulis untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Properti yang Diwariskan

id	Pengidentifikasi sumber daya unik sumber daya ARM. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
location	Lokasi grup sumber daya tempat sumber daya berada.
name	Nama sumber daya ARM. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
tags	Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".
type	Jenis sumber daya Azure. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

Detail Properti

analyticalStorageConfiguration

Properti khusus penyimpanan analitis.

analyticalStorageConfiguration?: AnalyticalStorageConfiguration

Nilai Properti

AnalyticalStorageConfiguration

apiProperties

Properti khusus API.

apiProperties?: ApiProperties

Nilai Properti

ApiProperties

backupPolicy

Objek yang mewakili kebijakan untuk mengambil cadangan pada akun.

backupPolicy?: BackupPolicyUnion

Nilai Properti

BackupPolicyUnion

capabilities

Daftar kemampuan Cosmos DB untuk akun

capabilities?: Capability[]

Nilai Properti

Capability[]

capacity

Objek yang mewakili semua properti yang terkait dengan penegakan kapasitas pada akun.

capacity?: Capacity

Nilai Properti

Capacity

connectorOffer

Jenis penawaran konektor cassandra untuk akun C* database Cosmos DB.

connectorOffer?: string

Nilai Properti

string

consistencyPolicy

Kebijakan konsistensi untuk akun database Cosmos DB.

consistencyPolicy?: ConsistencyPolicy

Nilai Properti

ConsistencyPolicy

cors

Kebijakan CORS untuk akun database Cosmos DB.

cors?: CorsPolicy[]

Nilai Properti

CorsPolicy[]

createMode

Enum untuk menunjukkan mode pembuatan akun.

createMode?: string

Nilai Properti

string

customerManagedKeyStatus

Menunjukkan status fitur Kunci yang Dikelola Pelanggan di akun. Jika ada kesalahan, properti menyediakan panduan pemecahan masalah.

customerManagedKeyStatus?: string

Nilai Properti

string

databaseAccountOfferType

Jenis penawaran untuk akun database Cosmos DB. Nilai default: Standar. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

databaseAccountOfferType?: "Standard"

Nilai Properti

"Standard"

defaultIdentity

Identitas default untuk mengakses brankas kunci yang digunakan dalam fitur seperti kunci yang dikelola pelanggan. Identitas default harus diatur secara eksplisit oleh pengguna. Ini bisa menjadi "FirstPartyIdentity", "SystemAssignedIdentity" dan banyak lagi.

defaultIdentity?: string

Nilai Properti

string

defaultPriorityLevel

Enum untuk menunjukkan Tingkat Prioritas default permintaan untuk Eksekusi Berbasis Prioritas.

defaultPriorityLevel?: string

Nilai Properti

string

disableKeyBasedMetadataWriteAccess

Nonaktifkan operasi tulis pada sumber daya metadata (database, kontainer, throughput) melalui kunci akun

disableKeyBasedMetadataWriteAccess?: boolean

Nilai Properti

boolean

disableLocalAuth

Menolak autentikasi lokal dan memastikan hanya MSI dan AAD yang dapat digunakan secara eksklusif untuk autentikasi.

disableLocalAuth?: boolean

Nilai Properti

boolean

documentEndpoint

Titik akhir koneksi untuk akun database Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

documentEndpoint?: string

Nilai Properti

string

enableAnalyticalStorage

Bendera untuk menunjukkan apakah akan mengaktifkan analitik penyimpanan.

enableAnalyticalStorage?: boolean

Nilai Properti

boolean

enableAutomaticFailover

Mengaktifkan failover otomatis wilayah tulis dalam peristiwa langka bahwa wilayah tidak tersedia karena pemadaman. Failover otomatis akan menghasilkan wilayah tulis baru untuk akun dan dipilih berdasarkan prioritas failover yang dikonfigurasi untuk akun.

enableAutomaticFailover?: boolean

Nilai Properti

boolean

enableBurstCapacity

Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Kapasitas Burst pada akun

enableBurstCapacity?: boolean

Nilai Properti

boolean

enableCassandraConnector

Mengaktifkan konektor cassandra pada akun Cosmos DB C*

enableCassandraConnector?: boolean

Nilai Properti

boolean

enableFreeTier

Bendera untuk menunjukkan apakah Tingkat Gratis diaktifkan.

enableFreeTier?: boolean

Nilai Properti

boolean

enableMultipleWriteLocations

Memungkinkan akun menulis di beberapa lokasi

enableMultipleWriteLocations?: boolean

Nilai Properti

boolean

enablePartitionMerge

Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Gabungan Partisi pada akun

enablePartitionMerge?: boolean

Nilai Properti

boolean

enablePerRegionPerPartitionAutoscale

Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur PerRegionPerPartitionAutoscale pada akun

enablePerRegionPerPartitionAutoscale?: boolean

Nilai Properti

boolean

enablePriorityBasedExecution

Bendera untuk menunjukkan mengaktifkan/menonaktifkan fitur Pratinjau Eksekusi Berbasis Prioritas pada akun

enablePriorityBasedExecution?: boolean

Nilai Properti

boolean

failoverPolicies

Array yang berisi wilayah yang diurutkan berdasarkan prioritas failover mereka. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

failoverPolicies?: FailoverPolicy[]

Nilai Properti

FailoverPolicy[]

identity

Identitas untuk sumber daya.

identity?: ManagedServiceIdentity

Nilai Properti

ManagedServiceIdentity

instanceId

Pengidentifikasi unik yang ditetapkan ke akun database NOTE: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

instanceId?: string

Nilai Properti

string

ipRules

Daftar IpRules.

ipRules?: IpAddressOrRange[]

Nilai Properti

IpAddressOrRange[]

isVirtualNetworkFilterEnabled

Bendera untuk menunjukkan apakah akan mengaktifkan/menonaktifkan aturan Virtual Network ACL.

isVirtualNetworkFilterEnabled?: boolean

Nilai Properti

boolean

keysMetadata

Objek yang mewakili metadata untuk Kunci Akun akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

keysMetadata?: DatabaseAccountKeysMetadata

Nilai Properti

DatabaseAccountKeysMetadata

keyVaultKeyUri

URI brankas kunci

keyVaultKeyUri?: string

Nilai Properti

string

keyVaultKeyUriVersion

Versi Kunci Terkelola Pelanggan yang saat ini digunakan oleh akun CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

keyVaultKeyUriVersion?: string

Nilai Properti

string

kind

Menunjukkan jenis akun database. Ini hanya dapat diatur pada pembuatan akun database.

kind?: string

Nilai Properti

string

locations

Array yang berisi semua lokasi yang diaktifkan untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

locations?: Location[]

Nilai Properti

Location[]

minimalTlsVersion

Menunjukkan versi Tls minimum yang diizinkan. Nilai defaultnya adalah Tls 1.2. API Cassandra dan Mongo hanya berfungsi dengan Tls 1.2.

minimalTlsVersion?: string

Nilai Properti

string

networkAclBypass

Menunjukkan layanan apa yang diizinkan untuk melewati pemeriksaan firewall.

networkAclBypass?: NetworkAclBypass

Nilai Properti

NetworkAclBypass

networkAclBypassResourceIds

Array yang berisi Id Sumber Daya untuk Bypass Acl Jaringan untuk akun Cosmos DB.

networkAclBypassResourceIds?: string[]

Nilai Properti

string[]

privateEndpointConnections

Daftar Koneksi Titik Akhir Privat yang dikonfigurasi untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

privateEndpointConnections?: PrivateEndpointConnection[]

Nilai Properti

PrivateEndpointConnection[]

provisioningState

Status akun Cosmos DB pada saat operasi dipanggil. Statusnya bisa menjadi salah satu dari berikut ini. 'Membuat' – akun Cosmos DB sedang dibuat. Saat akun dalam status Membuat, hanya properti yang ditentukan sebagai input untuk operasi Buat akun Cosmos DB yang dikembalikan. 'Berhasil' – akun Cosmos DB aktif untuk digunakan. 'Memperbarui' – akun Cosmos DB sedang diperbarui. 'Menghapus' – akun Cosmos DB sedang dihapus. 'Gagal' – pembuatan akun Cosmos DB gagal. 'DeletionFailed' – penghapusan akun Cosmos DB gagal. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

provisioningState?: string

Nilai Properti

string

publicNetworkAccess

Apakah permintaan dari Jaringan Publik diizinkan

publicNetworkAccess?: string

Nilai Properti

string

readLocations

Array yang berisi lokasi baca yang diaktifkan untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

readLocations?: Location[]

Nilai Properti

Location[]

restoreParameters

Parameter untuk menunjukkan informasi tentang pemulihan.

restoreParameters?: RestoreParameters

Nilai Properti

RestoreParameters

systemData

Data meta sistem yang berkaitan dengan sumber daya ini. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

systemData?: SystemData

Nilai Properti

SystemData

virtualNetworkRules

Daftar aturan Virtual Network ACL yang dikonfigurasi untuk akun Cosmos DB.

virtualNetworkRules?: VirtualNetworkRule[]

Nilai Properti

VirtualNetworkRule[]

writeLocations

Array yang berisi lokasi tulis untuk akun Cosmos DB. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

writeLocations?: Location[]

Nilai Properti

Location[]

Detail Properti yang Diwariskan

id

Pengidentifikasi sumber daya unik sumber daya ARM. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

id?: string

Nilai Properti

string

Diwariskan DariARMResourceProperties.id

location

Lokasi grup sumber daya tempat sumber daya berada.

location?: string

Nilai Properti

string

Diwariskan DariARMResourceProperties.location

name

Nama sumber daya ARM. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

name?: string

Nilai Properti

string

Diwariskan DariARMResourceProperties.name

tags

Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB".

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

Nilai Properti

{[propertyName: string]: string}

Diwarisi DariARMResourceProperties.tags

type

Jenis sumber daya Azure. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.

type?: string

Nilai Properti

string

Diwarisi DariARMResourceProperties.type