@azure/arm-mongocluster package
Sınıflar
| MongoClusterManagementClient |
Arabirimler
| AdministratorProperties |
Yerel yönetici oturum açma özellikleri. |
| AuthConfigProperties |
Mongo kümesi için kimlik doğrulama yapılandırması. |
| BackupProperties |
Kümenin yedekleme özellikleri. Bu, en erken geri yükleme süresini ve bekletme ayarlarını içerir. |
| CheckNameAvailabilityRequest |
Kullanılabilirlik isteği gövdesini denetleyin. |
| CheckNameAvailabilityResponse |
Kullanılabilirlik durumunu denetleme sonucu. |
| ComputeProperties |
Kümenin işlem özellikleri. Bu, kümedeki sunuculara uygulanan sanal çekirdekleri/belleği ve ölçeklendirme seçeneklerini içerir. |
| ConnectionString |
Mongo kümesi için bağlantı dizesi |
| CustomerManagedKeyEncryptionProperties |
Müşteri tarafından yönetilen anahtar şifreleme ayarları. |
| DataApiProperties |
Veri API'si özellikleri. |
| DatabaseRole |
Bir kullanıcıya atanan veritabanı rolü tanımı. |
| EncryptionProperties |
Mongo kümesi için şifreleme yapılandırması. |
| EntraIdentityProvider |
Bir Microsoft Entra ID Mongo kullanıcısı tanımlar. |
| EntraIdentityProviderProperties |
Microsoft Entra Kimlik Sağlayıcısı özellikleri. |
| ErrorAdditionalInfo |
Kaynak yönetimi hatası ek bilgileri. |
| ErrorDetail |
Hata ayrıntısı. |
| ErrorResponse |
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. |
| FirewallRule |
Mongo kümesi güvenlik duvarı kuralını temsil eder. |
| FirewallRuleProperties |
Mongo kümesi güvenlik duvarı kuralının özellikleri. |
| FirewallRulesCreateOrUpdateOptionalParams |
İsteğe bağlı parametreler. |
| FirewallRulesDeleteOptionalParams |
İsteğe bağlı parametreler. |
| FirewallRulesGetOptionalParams |
İsteğe bağlı parametreler. |
| FirewallRulesListByMongoClusterOptionalParams |
İsteğe bağlı parametreler. |
| FirewallRulesOperations |
FirewallRules işlemlerini temsil eden arabirim. |
| HighAvailabilityProperties |
Kümenin yüksek kullanılabilirlik özellikleri. |
| IdentityProvider |
Kullanıcının kimlik sağlayıcı tanımını tanımlar. |
| KeyEncryptionKeyIdentity |
Anahtar şifreleme anahtarı için kullanılan kimlik. |
| ListConnectionStringsResult |
Verilen mongo kümesi için bağlantı dizeleri. |
| ManagedServiceIdentity |
Yönetilen hizmet kimliği (sistem tarafından atanan ve/veya kullanıcı tarafından atanan kimlikler) |
| MongoCluster |
Mongo kümesi kaynağını temsil eder. |
| MongoClusterManagementClientOptionalParams |
İstemci için isteğe bağlı parametreler. |
| MongoClusterProperties |
Mongo kümesinin özellikleri. |
| MongoClusterReplicaParameters |
Çoğaltma işlemleri için kullanılan parametreler. |
| MongoClusterRestoreParameters |
Geri yükleme işlemleri için kullanılan parametreler |
| MongoClusterUpdate |
MongoCluster güncelleştirme işlemleri için kullanılan tür. |
| MongoClusterUpdateProperties |
MongoCluster'ın güncelleştirilebilir özellikleri. |
| MongoClustersCheckNameAvailabilityOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersCreateOrUpdateOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersDeleteOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersGetOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersListByResourceGroupOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersListConnectionStringsOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersListOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersOperations |
MongoClusters işlemlerini temsil eden arabirim. |
| MongoClustersPromoteOptionalParams |
İsteğe bağlı parametreler. |
| MongoClustersUpdateOptionalParams |
İsteğe bağlı parametreler. |
| Operation |
Kaynak Sağlayıcısı İşlemleri API'sinden döndürülen REST API işleminin ayrıntıları |
| OperationDisplay |
ve işlemi için yerelleştirilmiş görüntü bilgileri. |
| OperationsListOptionalParams |
İsteğe bağlı parametreler. |
| OperationsOperations |
İşlem işlemlerini temsil eden arabirim. |
| PageSettings |
byPage yöntemi için seçenekler |
| PagedAsyncIterableIterator |
Zaman uyumsuz yinelenebilir yinelemeye hem tamamlamaya hem de sayfaya izin veren bir arabirim. |
| PrivateEndpoint |
Özel uç nokta kaynağı. |
| PrivateEndpointConnection |
Özel uç nokta bağlantı kaynağı |
| PrivateEndpointConnectionProperties |
Özel uç nokta bağlantısının özellikleri. |
| PrivateEndpointConnectionResource |
Belirli bir özellik türü kullanılarak bu tür diğer ad kullanılarak somut ara sunucu kaynak türleri oluşturulabilir. |
| PrivateEndpointConnectionsCreateOptionalParams |
İsteğe bağlı parametreler. |
| PrivateEndpointConnectionsDeleteOptionalParams |
İsteğe bağlı parametreler. |
| PrivateEndpointConnectionsGetOptionalParams |
İsteğe bağlı parametreler. |
| PrivateEndpointConnectionsListByMongoClusterOptionalParams |
İsteğe bağlı parametreler. |
| PrivateEndpointConnectionsOperations |
PrivateEndpointConnections işlemlerini temsil eden arabirim. |
| PrivateLinkResource |
Belirli bir özellik türü kullanılarak bu tür diğer ad kullanılarak somut ara sunucu kaynak türleri oluşturulabilir. |
| PrivateLinkResourceProperties |
Özel bağlantı kaynağının özellikleri. |
| PrivateLinkServiceConnectionState |
Hizmet tüketicisi ile sağlayıcı arasındaki bağlantının durumu hakkında bilgi koleksiyonu. |
| PrivateLinksListByMongoClusterOptionalParams |
İsteğe bağlı parametreler. |
| PrivateLinksOperations |
PrivateLinks işlemlerini temsil eden arabirim. |
| PromoteReplicaRequest |
Çoğaltma isteği özelliklerini yükseltin. |
| ProxyResource |
Azure Resource Manager proxy kaynağı için kaynak modeli tanımı. Etiketleri ve konumu olmayacak |
| Replica |
Mongo kümesi çoğaltmasını temsil eder. |
| ReplicasListByParentOptionalParams |
İsteğe bağlı parametreler. |
| ReplicasOperations |
Çoğaltma işlemlerini temsil eden arabirim. |
| ReplicationProperties |
Mongo kümesinin çoğaltma özellikleri. |
| Resource |
Tüm Azure Resource Manager kaynakları için yanıtta döndürülen ortak alanlar |
| RestorePollerOptions | |
| ShardingProperties |
Kümenin parçalama özellikleri. Buna küme için parça sayısı ve ölçeklendirme seçenekleri dahildir. |
| StorageProperties |
Kümenin depolama özellikleri. Bu, kümedeki sunuculara uygulanan veri depolama boyutunu ve ölçeklendirmeyi içerir. |
| SystemData |
Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler. |
| TrackedResource |
Azure Resource Manager'ın 'etiketler' ve 'konum' içeren izlenen en üst düzey kaynağın kaynak modeli tanımı |
| User |
Mongo kümesi kullanıcısını temsil eder. |
| UserAssignedIdentity |
Kullanıcı tarafından atanan kimlik özellikleri |
| UserProperties |
Bir kümede Mongo kullanıcı kaynağının tanımı. |
| UsersCreateOrUpdateOptionalParams |
İsteğe bağlı parametreler. |
| UsersDeleteOptionalParams |
İsteğe bağlı parametreler. |
| UsersGetOptionalParams |
İsteğe bağlı parametreler. |
| UsersListByMongoClusterOptionalParams |
İsteğe bağlı parametreler. |
| UsersOperations |
Kullanıcı işlemlerini temsil eden arayüz. |
Tür Diğer Adları
| ActionType |
Genişletilebilir sabit listesi. Eylem türünü gösterir. "İç", yalnızca iç API'lere yönelik eylemleri ifade eder. Hizmet tarafından desteklenen bilinen değerlerİç: Eylemler yalnızca iç API'ler içindir. |
| AuthenticationMode |
Mongo kümesinde desteklenen kimlik doğrulama modları. Hizmet tarafından desteklenen bilinen değerler
NativeAuth: 'SCRAM-SHA-256' kimlik doğrulama mekanizması ile kullanıcı adı ve şifre kullanan yerel mongo kimlik doğrulama modu. |
| AzureSupportedClouds |
Dize değişmez türü olarak bulut ayarı için desteklenen değerler |
| CheckNameAvailabilityReason |
Bir adın kullanılamamasının olası nedenleri. Hizmet tarafından desteklenen bilinen değerler
Geçersiz: Ad geçersiz. |
| ContinuablePage |
Bir sonuç sayfasını açıklayan arabirim. |
| CreateMode |
Mongo Kümesinin oluşturulduğu mod. Hizmet tarafından desteklenen bilinen değerler
Varsayılan: Yeni bir mongo kümesi oluşturun. |
| CreatedByType |
Kaynağı oluşturan varlık türü. Hizmet tarafından desteklenen bilinen değerler
Kullanıcı: Varlık bir kullanıcı tarafından oluşturuldu. |
| DataApiMode |
Mongo Veri API'sine uygulanacak mod. Hizmet tarafından desteklenen bilinen değerler
Etkin: Küme için Mongo Veri API'si etkinleştirildi. |
| EntraPrincipalType |
Mongo kullanıcısı için kullanılabilen Microsoft Entra ID asıl türleri. Hizmet tarafından desteklenen bilinen değerler
user: Entra kullanıcı türü. |
| HighAvailabilityMode |
Küme için yüksek kullanılabilirlik modları. Hizmet tarafından desteklenen bilinen değerler
Devre dışı: Yüksek kullanılabilirlik modu devre dışıdır. Bu mod, arızalar veya bakım sırasında kullanılabilirlik etkisini görebilir ve üretim için önerilmez. |
| IdentityProviderType |
Bir kullanıcı kimliğinin ait olabileceği kimlik sağlayıcı türleri. Hizmet tarafından desteklenen bilinen değerlerMicrosoftEntraID: Microsoft Entra Kimlik sağlayıcısı. |
| IdentityProviderUnion |
IdentityProviderUnion için Diğer Ad |
| KeyEncryptionKeyIdentityType |
Anahtar şifreleme anahtarı için kimlik türü. Hizmet tarafından desteklenen bilinen değerlerUserAssignedIdentity: Kullanıcı tarafından atanan kimlik. |
| ManagedServiceIdentityType |
Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir). Hizmet tarafından desteklenen bilinen değerler
Hiçbiri: Yönetilen kimlik yok. |
| MongoClusterStatus |
Mongo kümesi kaynağının durumu. Hizmet tarafından desteklenen bilinen değerler
Hazır: Mongo kümesi kaynağı kullanıma hazırdır. |
| Origin |
İşlemin hedeflenen yürütücüsü; Kaynak Tabanlı Erişim Denetimi (RBAC) ve denetim günlükleri UX'sinde olduğu gibi. Varsayılan değer "user,system" Hizmet tarafından desteklenen bilinen değerlerkullanıcı : İşlemin bir kullanıcı tarafından başlatıldığını gösterir. |
| PreviewFeature |
Mongo kümesinde etkinleştirilebilen önizleme özellikleri. Hizmet tarafından desteklenen bilinen değerlerGeoReplicas: Coğrafi replikalar önizleme özelliğini etkinleştirir. Coğrafi çoğaltma kümesini bağlamayı etkinleştirmek için özelliğin yeni kümede oluşturma zamanında ayarlanması gerekir. |
| PrivateEndpointConnectionProvisioningState |
Geçerli sağlama durumu. Hizmet tarafından desteklenen bilinen değerler
Başarılı: Bağlantı sağlandı |
| PrivateEndpointServiceConnectionStatus |
Özel uç nokta bağlantı durumu. Hizmet tarafından desteklenen bilinen değerler
Beklemede: Onay veya ret bekleyen bağlantı |
| PromoteMode |
Yükseltme işlemine uygulanacak mod. Hizmet tarafından desteklenen bilinen değerlerGeçiş: Yükseltme, geçerli çoğaltma kümesini birincil role geçirir ve özgün birincil, çoğaltma bağlantısını koruyarak bir çoğaltma rolüne geçirilir. |
| PromoteOption |
Yükseltme işlemine uygulama seçeneği. Hizmet tarafından desteklenen bilinen değerlerZorunlu: Yükseltme seçeneği, çoğaltmanın birincil sürüme yetişmesini beklemeden yükseltmeyi zorlar. Bu, veri kaybına neden olabilir, bu nedenle yalnızca olağanüstü durum kurtarma senaryoları sırasında kullanılmalıdır. |
| ProvisioningState |
Kabul edilen son işlemin sağlama durumu. Hizmet tarafından desteklenen bilinen değerler
Başarılı: Kaynak oluşturuldu. |
| PublicNetworkAccess |
Bu Mongo kümesi için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır ve varsayılan değer 'Etkin' olarak ayarlanır Hizmet tarafından desteklenen bilinen değerler
Etkin: Ayarlanırsa, mongo kümesine özel ve genel yöntemler aracılığıyla erişilebilir. |
| ReplicationRole |
Mongo kümesinin çoğaltma rolü. Hizmet tarafından desteklenen bilinen değerler
Birincil: Küme birincil çoğaltmadır. |
| ReplicationState |
Çoğaltma ile kaynak küme arasındaki çoğaltma bağlantısının durumu. Hizmet tarafından desteklenen bilinen değerler
Etkin: Çoğaltma bağlantısı etkindir. |
| StorageType |
Bir mongo kümesinin sağlanabileceği depolama türü. Hizmet tarafından desteklenen bilinen değerler
PremiumSSD: Yüksek performanslı iş yükleri için birinci sınıf SSD. |
| UserRole |
Bir kullanıcıya atanabilen yerleşik veritabanı rolü. Hizmet tarafından desteklenen bilinen değerlerroot: Hedef kapsamdaki kök rol izinleri. |
Numaralandırmalar
| AzureClouds |
Azure Bulut ortamlarını açıklamak için bir sabit listesi. |
| KnownActionType |
Genişletilebilir sabit listesi. Eylem türünü gösterir. "İç", yalnızca iç API'lere yönelik eylemleri ifade eder. |
| KnownAuthenticationMode |
Mongo kümesinde desteklenen kimlik doğrulama modları. |
| KnownCheckNameAvailabilityReason |
Bir adın kullanılamamasının olası nedenleri. |
| KnownCreateMode |
Mongo Kümesinin oluşturulduğu mod. |
| KnownCreatedByType |
Kaynağı oluşturan varlık türü. |
| KnownDataApiMode |
Mongo Veri API'sine uygulanacak mod. |
| KnownEntraPrincipalType |
Mongo kullanıcısı için kullanılabilen Microsoft Entra ID asıl türleri. |
| KnownHighAvailabilityMode |
Küme için yüksek kullanılabilirlik modları. |
| KnownIdentityProviderType |
Bir kullanıcı kimliğinin ait olabileceği kimlik sağlayıcı türleri. |
| KnownKeyEncryptionKeyIdentityType |
Anahtar şifreleme anahtarı için kimlik türü. |
| KnownManagedServiceIdentityType |
Yönetilen hizmet kimliği türü (hem SystemAssigned hem de UserAssigned türlerine izin verilir). |
| KnownMongoClusterStatus |
Mongo kümesi kaynağının durumu. |
| KnownOrigin |
İşlemin hedeflenen yürütücüsü; Kaynak Tabanlı Erişim Denetimi (RBAC) ve denetim günlükleri UX'sinde olduğu gibi. Varsayılan değer "user,system" |
| KnownPreviewFeature |
Mongo kümesinde etkinleştirilebilen önizleme özellikleri. |
| KnownPrivateEndpointConnectionProvisioningState |
Geçerli sağlama durumu. |
| KnownPrivateEndpointServiceConnectionStatus |
Özel uç nokta bağlantı durumu. |
| KnownPromoteMode |
Yükseltme işlemine uygulanacak mod. |
| KnownPromoteOption |
Yükseltme işlemine uygulama seçeneği. |
| KnownProvisioningState |
Kabul edilen son işlemin sağlama durumu. |
| KnownPublicNetworkAccess |
Bu Mongo kümesi için genel uç nokta erişimine izin verilip verilmeyeceği. Değer isteğe bağlıdır ve varsayılan değer 'Etkin'dir |
| KnownReplicationRole |
Mongo kümesinin çoğaltma rolü. |
| KnownReplicationState |
Çoğaltma ile kaynak küme arasındaki çoğaltma bağlantısının durumu. |
| KnownStorageType |
Bir mongo kümesinin sağlanabileceği depolama türü. |
| KnownUserRole |
Bir kullanıcıya atanabilen yerleşik veritabanı rolü. |
| KnownVersions |
Kullanılabilir API sürümleri. |
İşlevler
| restore |
Başka bir poller'ın serileştirilmiş durumundan bir poller oluşturur. Bu, farklı bir konakta yoklama oluşturmak istediğinizde veya özgün konak kapsam dahilinde olmadığında bir poller oluşturulması gerektiğinde yararlı olabilir. |
İşlev Ayrıntıları
restorePoller<TResponse, TResult>(MongoClusterManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Başka bir poller'ın serileştirilmiş durumundan bir poller oluşturur. Bu, farklı bir konakta yoklama oluşturmak istediğinizde veya özgün konak kapsam dahilinde olmadığında bir poller oluşturulması gerektiğinde yararlı olabilir.
function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametreler
- client
- MongoClusterManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Döndürülenler
PollerLike<OperationState<TResult>, TResult>