@azure/arm-mongocluster package

Kelas

MongoClusterManagementClient

Antarmuka

AdministratorProperties	Properti masuk administrator lokal.
AuthConfigProperties	Konfigurasi autentikasi untuk kluster Mongo.
BackupProperties	Properti cadangan kluster. Ini termasuk waktu pemulihan paling awal dan pengaturan retensi.
CheckNameAvailabilityRequest	Isi permintaan ketersediaan pemeriksaan.
CheckNameAvailabilityResponse	Hasil ketersediaan pemeriksaan.
ComputeProperties	Properti komputasi kluster. Ini termasuk opsi virtual-cores/memori dan penskalan yang diterapkan ke server di kluster.
ConnectionString	String koneksi untuk kluster mongo
CustomerManagedKeyEncryptionProperties	Pengaturan enkripsi kunci yang dikelola pelanggan.
DataApiProperties	Properti API Data.
DatabaseRole	Definisi peran database yang ditetapkan ke pengguna.
EncryptionProperties	Konfigurasi enkripsi untuk kluster mongo.
EntraIdentityProvider	Menentukan pengguna Microsoft Entra ID Mongo.
EntraIdentityProviderProperties	Properti penyedia ID Microsoft Entra.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal.
FirewallRule	Mewakili aturan firewall kluster mongo.
FirewallRuleProperties	Properti aturan firewall kluster mongo.
FirewallRulesCreateOrUpdateOptionalParams	Parameter opsional.
FirewallRulesDeleteOptionalParams	Parameter opsional.
FirewallRulesGetOptionalParams	Parameter opsional.
FirewallRulesListByMongoClusterOptionalParams	Parameter opsional.
FirewallRulesOperations	Antarmuka yang mewakili operasi FirewallRules.
HighAvailabilityProperties	Properti ketersediaan tinggi dari kluster.
IdentityProvider	Menentukan definisi penyedia identitas pengguna.
KeyEncryptionKeyIdentity	Identitas yang digunakan untuk kunci enkripsi kunci.
ListConnectionStringsResult	String koneksi untuk kluster mongo yang diberikan.
ManagedServiceIdentity	Identitas layanan terkelola (identitas yang ditetapkan sistem dan/atau pengguna)
MongoCluster	Mewakili sumber daya kluster mongo.
MongoClusterManagementClientOptionalParams	Parameter opsional untuk klien.
MongoClusterProperties	Properti kluster mongo.
MongoClusterReplicaParameters	Parameter yang digunakan untuk operasi replika.
MongoClusterRestoreParameters	Parameter yang digunakan untuk operasi pemulihan
MongoClusterUpdate	Jenis yang digunakan untuk operasi pembaruan MongoCluster.
MongoClusterUpdateProperties	Properti yang dapat diperbarui dari MongoCluster.
MongoClustersCheckNameAvailabilityOptionalParams	Parameter opsional.
MongoClustersCreateOrUpdateOptionalParams	Parameter opsional.
MongoClustersDeleteOptionalParams	Parameter opsional.
MongoClustersGetOptionalParams	Parameter opsional.
MongoClustersListByResourceGroupOptionalParams	Parameter opsional.
MongoClustersListConnectionStringsOptionalParams	Parameter opsional.
MongoClustersListOptionalParams	Parameter opsional.
MongoClustersOperations	Antarmuka yang mewakili operasi MongoClusters.
MongoClustersPromoteOptionalParams	Parameter opsional.
MongoClustersUpdateOptionalParams	Parameter opsional.
Operation	Detail operasi REST API, dikembalikan dari API Operasi Penyedia Sumber Daya
OperationDisplay	Informasi tampilan yang dilokalkan untuk operasi dan .
OperationsListOptionalParams	Parameter opsional.
OperationsOperations	Antarmuka yang mewakili operasi Operasi.
PageSettings	Opsi untuk metode byPage
PagedAsyncIterableIterator	Antarmuka yang memungkinkan iterasi yang dapat diulang asinkron baik ke penyelesaian maupun berdasarkan halaman.
PrivateEndpoint	Sumber daya titik akhir privat.
PrivateEndpointConnection	Sumber daya koneksi titik akhir privat
PrivateEndpointConnectionProperties	Properti koneksi titik akhir privat.
PrivateEndpointConnectionResource	Jenis sumber daya proksi konkret dapat dibuat dengan alias jenis ini menggunakan jenis properti tertentu.
PrivateEndpointConnectionsCreateOptionalParams	Parameter opsional.
PrivateEndpointConnectionsDeleteOptionalParams	Parameter opsional.
PrivateEndpointConnectionsGetOptionalParams	Parameter opsional.
PrivateEndpointConnectionsListByMongoClusterOptionalParams	Parameter opsional.
PrivateEndpointConnectionsOperations	Antarmuka yang mewakili operasi PrivateEndpointConnections.
PrivateLinkResource	Jenis sumber daya proksi konkret dapat dibuat dengan alias jenis ini menggunakan jenis properti tertentu.
PrivateLinkResourceProperties	Properti sumber daya tautan privat.
PrivateLinkServiceConnectionState	Kumpulan informasi tentang status koneksi antara konsumen layanan dan penyedia.
PrivateLinksListByMongoClusterOptionalParams	Parameter opsional.
PrivateLinksOperations	Antarmuka yang mewakili operasi PrivateLinks.
PromoteReplicaRequest	Mempromosikan properti permintaan replika.
ProxyResource	Definisi model sumber daya untuk sumber daya proksi Azure Resource Manager. Ini tidak akan memiliki tag dan lokasi
Replica	Mewakili replika kluster mongo.
ReplicasListByParentOptionalParams	Parameter opsional.
ReplicasOperations	Antarmuka yang mewakili operasi Replika.
ReplicationProperties	Properti replika kluster mongo.
Resource	Bidang umum yang dikembalikan dalam respons untuk semua sumber daya Azure Resource Manager
RestorePollerOptions
ShardingProperties	Properti sharding kluster. Ini termasuk jumlah shard dan opsi penskalaan untuk kluster.
StorageProperties	Properti penyimpanan kluster. Ini termasuk ukuran penyimpanan data dan penskalakan yang diterapkan ke server di kluster.
SystemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TrackedResource	Definisi model sumber daya untuk Sumber Daya Azure Resource Manager melacak sumber daya tingkat atas yang memiliki 'tag' dan 'lokasi'
User	Mewakili pengguna kluster Mongo.
UserAssignedIdentity	Properti identitas yang ditetapkan pengguna
UserProperties	Definisi sumber daya pengguna Mongo pada kluster.
UsersCreateOrUpdateOptionalParams	Parameter opsional.
UsersDeleteOptionalParams	Parameter opsional.
UsersGetOptionalParams	Parameter opsional.
UsersListByMongoClusterOptionalParams	Parameter opsional.
UsersOperations	Antarmuka yang mewakili operasi Pengguna.

Alias Jenis

ActionType	Enum yang dapat diperluas. Menunjukkan jenis tindakan. "Internal" mengacu pada tindakan yang hanya untuk API internal saja. KnownActionType dapat digunakan secara bergantian dengan ActionType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Internal : Tindakan adalah untuk API internal saja.
AuthenticationMode	Mode autentikasi yang mendukung pada kluster Mongo. KnownAuthenticationMode dapat digunakan secara bergantian dengan AuthenticationMode, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan NativeAuth: Mode otentikasi mongo asli menggunakan nama pengguna dan kata sandi dengan mekanisme autentikasi 'SCRAM-SHA-256'. MicrosoftEntraID: Mode otentikasi ID Microsoft Entra menggunakan pengguna Entra yang ditugaskan ke klaster dan mekanisme autentikasi 'MONGODB-OIDC'.
AzureSupportedClouds	Nilai yang didukung untuk pengaturan cloud sebagai jenis literal string
CheckNameAvailabilityReason	Kemungkinan alasan nama tidak tersedia. KnownCheckNameAvailabilityReason dapat digunakan secara bergantian dengan CheckNameAvailabilityReason, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan tidak valid: Nama tidak valid. AlreadyExists: Nama sudah ada.
ContinuablePage	Antarmuka yang menjelaskan halaman hasil.
CreateMode	Mode tempat Kluster Mongo dibuat. KnownCreateMode dapat digunakan secara bergantian dengan CreateMode, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Default: Buat kluster mongo baru. PointInTimeRestore: Membuat kluster mongo dari titik waktu pemulihan. GeoReplica: Buat kluster replika di wilayah geografis yang berbeda dari kluster sumber. Replika: Buat kluster replika di wilayah geografis yang sama dengan kluster sumber.
CreatedByType	Jenis entitas yang membuat sumber daya. KnownCreatedByType dapat digunakan secara bergantian dengan CreatedByType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Pengguna : Entitas dibuat oleh pengguna. Aplikasi : Entitas dibuat oleh aplikasi. ManagedIdentity: Entitas dibuat oleh identitas terkelola. Key: Entitas dibuat oleh kunci.
DataApiMode	Mode yang akan diterapkan ke Mongo Data API. KnownDataApiMode dapat digunakan secara bergantian dengan DataApiMode, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Diaktifkan: Mongo Data API diaktifkan untuk kluster. Dinonaktifkan: Mongo Data API dinonaktifkan untuk kluster.
EntraPrincipalType	Jenis perwakilan ID Microsoft Entra tersedia untuk pengguna Mongo. KnownEntraPrincipalType dapat digunakan secara bergantian dengan EntraPrincipalType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan user: Entra jenis pengguna. servicePrincipal: Jenis perwakilan layanan entra.
HighAvailabilityMode	Mode ketersediaan tinggi untuk kluster. KnownHighAvailabilityMode dapat digunakan secara bergantian dengan HighAvailabilityMode, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Dinonaktifkan: Mode ketersediaan tinggi dinonaktifkan. Mode ini dapat melihat dampak ketersediaan selama kesalahan atau pemeliharaan dan tidak direkomendasikan untuk produksi. SameZone: Mode ketersediaan tinggi diaktifkan, di mana setiap server dalam serpihan ditempatkan di zona ketersediaan yang sama. ZoneRedundantPreferred: Mode ketersediaan tinggi diaktifkan dan lebih memilih ZoneRedundant jika kapasitas zona ketersediaan tersedia di wilayah tersebut, jika tidak, kembali ke penyediaan dengan SameZone.
IdentityProviderType	Jenis penyedia identitas yang dapat dimiliki oleh identitas pengguna. KnownIdentityProviderType dapat digunakan secara bergantian dengan IdentityProviderType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan MicrosoftEntraID: Penyedia ID Microsoft Entra.
IdentityProviderUnion	Alias untuk IdentityProviderUnion
KeyEncryptionKeyIdentityType	Jenis identitas untuk kunci enkripsi kunci. KnownKeyEncryptionKeyIdentityType dapat digunakan secara bergantian dengan KeyEncryptionKeyIdentityType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan UserAssignedIdentity: Identitas yang ditetapkan pengguna.
ManagedServiceIdentityType	Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan). KnownManagedServiceIdentityType dapat digunakan secara bergantian dengan ManagedServiceIdentityType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Tidak Ada: Tidak ada identitas terkelola. SystemAssigned: Identitas terkelola yang ditetapkan sistem. UserAssigned: Identitas terkelola yang ditetapkan pengguna. SystemAssigned,UserAssigned: Sistem dan identitas terkelola yang ditetapkan pengguna.
MongoClusterStatus	Status sumber daya kluster Mongo. KnownMongoClusterStatus dapat digunakan secara bergantian dengan MongoClusterStatus, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Siap: Sumber daya kluster mongo siap digunakan. Penyediaan: Sumber daya kluster mongo sedang disediakan. Memperbarui: Sumber daya kluster mongo sedang diperbarui. Memulai: Sumber daya kluster mongo sedang dimulai. Berhenti: Sumber daya kluster mongo sedang dihentikan. Dihentikan: Sumber daya kluster mongo dihentikan. Menjatuhkan: Sumber daya kluster mongo sedang dijatuhkan.
Origin	Pelaksana operasi yang dimaksudkan; seperti dalam Resource Based Access Control (RBAC) dan log audit UX. Nilai defaultnya adalah "user,system" KnownOrigin dapat digunakan secara bergantian dengan Origin, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan pengguna : Menunjukkan operasi dimulai oleh pengguna. sistem : Menunjukkan operasi dimulai oleh sistem. pengguna,sistem : Menunjukkan operasi dimulai oleh pengguna atau sistem.
PreviewFeature	Fitur pratinjau yang dapat diaktifkan pada kluster mongo. KnownPreviewFeature dapat digunakan secara bergantian dengan PreviewFeature, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan GeoReplicas: Mengaktifkan fitur pratinjau replika geografis. Fitur harus diatur pada waktu pembuatan pada kluster baru untuk memungkinkan penautan kluster replika geografis ke kluster tersebut.
PrivateEndpointConnectionProvisioningState	Status provisi saat ini. KnownPrivateEndpointConnectionProvisioningState dapat digunakan secara bergantian dengan PrivateEndpointConnectionProvisioningState, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Berhasil: Koneksi telah disediakan Membuat: Koneksi sedang dibuat Menghapus: Koneksi sedang dihapus Gagal: Provisi koneksi gagal
PrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat. KnownPrivateEndpointServiceConnectionStatus dapat digunakan secara bergantian dengan PrivateEndpointServiceConnectionStatus, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Tertunda: Koneksi menunggu persetujuan atau penolakan disetujui: Koneksi disetujui Ditolak : Koneksi Ditolak
PromoteMode	Mode untuk diterapkan ke operasi promosi. KnownPromoteMode dapat digunakan secara bergantian dengan PromoteMode, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Peralihan: Promosi akan mengalihkan kluster replika saat ini ke peran utama dan primer asli akan dialihkan ke peran replika, mempertahankan tautan replikasi.
PromoteOption	Opsi untuk diterapkan ke operasi promosi. KnownPromoteOption dapat digunakan secara bergantian dengan PromoteOption, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Dipaksakan: Opsi promosi memaksa promosi tanpa menunggu replika terjebak ke primer. Hal ini dapat mengakibatkan kehilangan data sehingga hanya boleh digunakan selama skenario pemulihan bencana.
ProvisioningState	Status provisi operasi terakhir yang diterima. KnownProvisioningState dapat digunakan secara bergantian dengan ProvisioningState, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Berhasil: Sumber daya telah dibuat. Gagal: Pembuatan sumber daya gagal. Dibatalkan: Pembuatan sumber daya dibatalkan. InProgress: Operasi sedang berlangsung pada sumber daya. Memperbarui: Operasi pembaruan sedang berlangsung pada sumber daya. Dropping: Operasi drop sedang berlangsung pada sumber daya.
PublicNetworkAccess	Apakah akses titik akhir publik diizinkan atau tidak untuk kluster Mongo ini. Nilai bersifat opsional dan nilai defaultnya adalah 'Diaktifkan' KnownPublicNetworkAccess dapat digunakan secara bergantian dengan PublicNetworkAccess, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Diaktifkan: Jika diatur, kluster mongo dapat diakses melalui metode pribadi dan publik. Dinonaktifkan: Jika diatur, titik akhir privat adalah metode akses eksklusif.
ReplicationRole	Peran replikasi kluster mongo. KnownReplicationRole dapat digunakan secara bergantian dengan ReplicationRole, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Utama: Kluster adalah replika utama. AsyncReplica: Kluster adalah replika asinkron lokal. GeoAsyncReplica: Kluster adalah replika geo-asinkron.
ReplicationState	Status tautan replikasi antara replika dan kluster sumber. KnownReplicationState dapat digunakan secara bergantian dengan ReplicationState, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan Aktif: Tautan replikasi aktif. Mengejar ketinggalan: Replika mengejar ketinggalan dengan primer. Hal ini dapat terjadi setelah replika dibuat atau setelah promosi dipicu. Provisi: Tautan replika dan replikasi ke utama sedang dibuat. Memperbarui: Tautan replikasi sedang diperbarui karena perubahan pada replika atau peningkatan. Rusak: Tautan replikasi rusak dan replika mungkin perlu dibuat ulang. Mengonfigurasi ulang: Tautan replikasi dikonfigurasi ulang karena peristiwa promosi.
StorageType	Jenis penyimpanan yang dapat disediakan dengan kluster mongo. KnownStorageType dapat digunakan secara bergantian dengan StorageType, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan PremiumSSD: SSD premium untuk beban kerja berkinerja tinggi. PremiumSSDv2: SSD premium v2 untuk beban kerja yang sangat intensif IO. Ini adalah opsi pratinjau dan memiliki batasan tambahan.
UserRole	Peran database bawaan yang dapat ditetapkan ke pengguna. KnownUserRole dapat digunakan secara bergantian dengan UserRole, enum ini berisi nilai yang diketahui yang didukung layanan. Nilai yang diketahui didukung oleh layanan root: Izin peran root pada cakupan target.

Enum

AzureClouds	Enum untuk mendeskripsikan lingkungan Azure Cloud.
KnownActionType	Enum yang dapat diperluas. Menunjukkan jenis tindakan. "Internal" mengacu pada tindakan yang hanya untuk API internal saja.
KnownAuthenticationMode	Mode autentikasi yang mendukung pada kluster Mongo.
KnownCheckNameAvailabilityReason	Kemungkinan alasan nama tidak tersedia.
KnownCreateMode	Mode tempat Kluster Mongo dibuat.
KnownCreatedByType	Jenis entitas yang membuat sumber daya.
KnownDataApiMode	Mode yang akan diterapkan ke Mongo Data API.
KnownEntraPrincipalType	Jenis perwakilan ID Microsoft Entra tersedia untuk pengguna Mongo.
KnownHighAvailabilityMode	Mode ketersediaan tinggi untuk kluster.
KnownIdentityProviderType	Jenis penyedia identitas yang dapat dimiliki oleh identitas pengguna.
KnownKeyEncryptionKeyIdentityType	Jenis identitas untuk kunci enkripsi kunci.
KnownManagedServiceIdentityType	Jenis identitas layanan terkelola (di mana jenis SystemAssigned dan UserAssigned diizinkan).
KnownMongoClusterStatus	Status sumber daya kluster Mongo.
KnownOrigin	Pelaksana operasi yang dimaksudkan; seperti dalam Resource Based Access Control (RBAC) dan log audit UX. Nilai defaultnya adalah "user,system"
KnownPreviewFeature	Fitur pratinjau yang dapat diaktifkan pada kluster mongo.
KnownPrivateEndpointConnectionProvisioningState	Status provisi saat ini.
KnownPrivateEndpointServiceConnectionStatus	Status koneksi titik akhir privat.
KnownPromoteMode	Mode untuk diterapkan ke operasi promosi.
KnownPromoteOption	Opsi untuk diterapkan ke operasi promosi.
KnownProvisioningState	Status provisi operasi terakhir yang diterima.
KnownPublicNetworkAccess	Apakah akses titik akhir publik diizinkan atau tidak untuk kluster Mongo ini. Nilai bersifat opsional dan nilai default adalah 'Diaktifkan'
KnownReplicationRole	Peran replikasi kluster mongo.
KnownReplicationState	Status tautan replikasi antara replika dan kluster sumber.
KnownStorageType	Jenis penyimpanan yang dapat disediakan dengan kluster mongo.
KnownUserRole	Peran database bawaan yang dapat ditetapkan ke pengguna.
KnownVersions	Versi API yang tersedia.

Fungsi

restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Membuat poller dari status serial poller lain. Ini dapat berguna ketika Anda ingin membuat poller pada host yang berbeda atau poller perlu dibangun setelah yang asli tidak berada dalam cakupan.

Detail Fungsi

restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Membuat poller dari status serial poller lain. Ini dapat berguna ketika Anda ingin membuat poller pada host yang berbeda atau poller perlu dibangun setelah yang asli tidak berada dalam cakupan.

function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameter

client

MongoClusterManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Mengembalikan

PollerLike<OperationState<TResult>, TResult>