@azure/arm-mongocluster package

类

MongoClusterManagementClient

接口

AdministratorProperties	本地管理员登录属性。
AuthConfigProperties	Mongo 集群的身份验证配置。
BackupProperties	群集的备份属性。 这包括最早的还原时间和保留设置。
CheckNameAvailabilityRequest	检查可用性请求正文。
CheckNameAvailabilityResponse	检查可用性结果。
ComputeProperties	群集的计算属性。 这包括应用于群集中的服务器的虚拟核心/内存和缩放选项。
ConnectionString	Mongo 群集的连接字符串
CustomerManagedKeyEncryptionProperties	客户管理的密钥加密设置。
DataApiProperties	数据 API 属性。
DatabaseRole	分配给用户的数据库角色定义。
EncryptionProperties	mongo 集群的加密配置。
EntraIdentityProvider	定义 Microsoft Entra ID Mongo 用户。
EntraIdentityProviderProperties	Microsoft Entra ID 提供程序属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。
FirewallRule	表示 Mongo 群集防火墙规则。
FirewallRuleProperties	Mongo 群集防火墙规则的属性。
FirewallRulesCreateOrUpdateOptionalParams	可选参数。
FirewallRulesDeleteOptionalParams	可选参数。
FirewallRulesGetOptionalParams	可选参数。
FirewallRulesListByMongoClusterOptionalParams	可选参数。
FirewallRulesOperations	表示 FirewallRules作的接口。
HighAvailabilityProperties	群集的高可用性属性。
IdentityProvider	定义用户的标识提供者定义。
KeyEncryptionKeyIdentity	用于密钥加密密钥的标识。
ListConnectionStringsResult	给定 mongo 群集的连接字符串。
ManagedServiceIdentity	托管服务标识（系统分配和/或用户分配的标识）
MongoCluster	表示 mongo 群集资源。
MongoClusterManagementClientOptionalParams	客户端的可选参数。
MongoClusterProperties	mongo 群集的属性。
MongoClusterReplicaParameters	用于副本作的参数。
MongoClusterRestoreParameters	用于还原作的参数
MongoClusterUpdate	用于 MongoCluster 更新作的类型。
MongoClusterUpdateProperties	MongoCluster 的可更新属性。
MongoClustersCheckNameAvailabilityOptionalParams	可选参数。
MongoClustersCreateOrUpdateOptionalParams	可选参数。
MongoClustersDeleteOptionalParams	可选参数。
MongoClustersGetOptionalParams	可选参数。
MongoClustersListByResourceGroupOptionalParams	可选参数。
MongoClustersListConnectionStringsOptionalParams	可选参数。
MongoClustersListOptionalParams	可选参数。
MongoClustersOperations	表示 MongoClusters作的接口。
MongoClustersPromoteOptionalParams	可选参数。
MongoClustersUpdateOptionalParams	可选参数。
Operation	从资源提供程序作 API 返回的 REST API作的详细信息
OperationDisplay	本地化的显示信息和作。
OperationsListOptionalParams	可选参数。
OperationsOperations	表示作作的接口。
PageSettings	byPage 方法的选项
PagedAsyncIterableIterator	允许异步迭代到完成和逐页迭代的接口。
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	专用终结点连接资源
PrivateEndpointConnectionProperties	专用终结点连接的属性。
PrivateEndpointConnectionResource	具体代理资源类型可以通过使用特定属性类型将此类型别名创建。
PrivateEndpointConnectionsCreateOptionalParams	可选参数。
PrivateEndpointConnectionsDeleteOptionalParams	可选参数。
PrivateEndpointConnectionsGetOptionalParams	可选参数。
PrivateEndpointConnectionsListByMongoClusterOptionalParams	可选参数。
PrivateEndpointConnectionsOperations	表示 PrivateEndpointConnections作的接口。
PrivateLinkResource	具体代理资源类型可以通过使用特定属性类型将此类型别名创建。
PrivateLinkResourceProperties	专用链接资源的属性。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
PrivateLinksListByMongoClusterOptionalParams	可选参数。
PrivateLinksOperations	表示 PrivateLinks作的接口。
PromoteReplicaRequest	提升副本请求属性。
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置
Replica	表示 Mongo 群集副本。
ReplicasListByParentOptionalParams	可选参数。
ReplicasOperations	表示副本作的接口。
ReplicationProperties	mongo 群集的副本属性。
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
RestorePollerOptions
ShardingProperties	群集的分片属性。 这包括群集的分片计数和缩放选项。
StorageProperties	群集的存储属性。 这包括应用于群集中的服务器的数据存储大小和缩放。
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
User	表示 Mongo 集群用户。
UserAssignedIdentity	用户分配的标识属性
UserProperties	集群上 Mongo 用户资源的定义。
UsersCreateOrUpdateOptionalParams	可选参数。
UsersDeleteOptionalParams	可选参数。
UsersGetOptionalParams	可选参数。
UsersListByMongoClusterOptionalParams	可选参数。
UsersOperations	表示用户作的接口。

类型别名

ActionType	可扩展枚举。 指示作类型。 “内部”是指仅适用于内部 API 的作。 KnownActionType 可与 ActionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 内部：作适用于仅限内部的 API。
AuthenticationMode	Mongo 集群支持的身份验证模式。 KnownAuthenticationMode 可与 AuthenticationMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 NativeAuth：使用用户名和密码的本机 mongo 身份验证模式，身份验证机制为“SCRAM-SHA-256”。 MicrosoftEntraID：使用分配给群集和身份验证机制“MONGODB-OIDC”的 Entra 用户的 Microsoft Entra ID 身份验证模式。
AzureSupportedClouds	云设置为字符串文字类型的支持值
CheckNameAvailabilityReason	名称不可用的可能原因。 KnownCheckNameAvailabilityReason 可与 CheckNameAvailabilityReason 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无效：名称无效。 AlreadyExists：名称已存在。
ContinuablePage	描述结果页的接口。
CreateMode	使用 Mongo 群集创建的模式。 KnownCreateMode 可与 CreateMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 默认值：创建一个新的 mongo 集群。 PointInTimeRestore：从还原时间点创建 mongo 集群。 GeoReplica：在与源群集不同的地理区域中创建副本群集。 副本：在与源集群相同的地理区域中创建副本集群。
CreatedByType	创建资源的实体类型。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：实体是由用户创建的。 应用程序：实体是由应用程序创建的。 ManagedIdentity：实体是由托管标识创建的。 密钥：实体是由密钥创建的。
DataApiMode	应用于 Mongo Data API 的模式。 KnownDataApiMode 可以与 DataApiMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已启用：为集群启用了 Mongo Data API。 已禁用：集群禁用了 Mongo Data API。
EntraPrincipalType	适用于 Mongo 用户的 Microsoft Entra ID 主体类型。 KnownEntraPrincipalType 可以与 EntraPrincipalType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 user：Entra 用户类型。 servicePrincipal：Entra 服务主体类型。
HighAvailabilityMode	群集的高可用性模式。 KnownHighAvailabilityMode 可与 HighAvailabilityMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 禁用：禁用高可用性模式。 此模式可以在故障或维护期间看到可用性影响，不建议用于生产。 SameZone：启用高可用性模式，其中分片中的每台服务器都放置在同一可用性区域中。 ZoneRedundantPreferred：如果可用区容量在区域中可用，则启用高可用性模式并首选项为“区域冗余”，否则回退为使用 SameZone 进行预配。
IdentityProviderType	用户身份可以属于的身份提供程序类型。 KnownIdentityProviderType 可与 IdentityProviderType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 MicrosoftEntraID：Microsoft Entra ID 提供程序。
IdentityProviderUnion	IdentityProviderUnion 的别名
KeyEncryptionKeyIdentityType	密钥加密密钥的标识类型。 KnownKeyEncryptionKeyIdentityType 可以与 KeyEncryptionKeyIdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 UserAssignedIdentity：用户分配的标识。
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。 KnownManagedServiceIdentityType 可与 ManagedServiceIdentityType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无：无托管标识。 SystemAssigned：系统分配的托管标识。 UserAssigned：用户分配的托管标识。 SystemAssigned、UserAssigned：系统和用户分配的托管标识。
MongoClusterStatus	Mongo 群集资源的状态。 KnownMongoClusterStatus 可与 MongoClusterStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 就绪：mongo 集群资源已准备就绪，可供使用。 预配：正在预配 mongo 集群资源。 正在更新：正在更新 mongo 集群资源。 正在启动：mongo 集群资源正在启动。 正在停止：mongo 集群资源正在停止。 已停止：mongo 集群资源已停止。 Dropping：正在删除 mongo 集群资源。
Origin	作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system” KnownOrigin 可与 Origin 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户：指示作是由用户启动的。 系统：指示作是由系统启动的。 用户，系统：指示作是由用户或系统启动的。
PreviewFeature	可以在 Mongo 群集上启用的预览功能。 KnownPreviewFeature 可与 PreviewFeature 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 GeoReplicas：启用异地副本预览功能。 必须在新群集的创建时设置该功能，以便将异地副本群集链接到该群集。
PrivateEndpointConnectionProvisioningState	当前预配状态。 KnownPrivateEndpointConnectionProvisioningState 可与 PrivateEndpointConnectionProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已预配连接 创建：正在创建连接 删除：正在删除连接 失败：连接预配失败
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。 KnownPrivateEndpointServiceConnectionStatus 可与 PrivateEndpointServiceConnectionStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 待处理：连接正在等待批准或拒绝 已批准 ：已批准连接 拒绝：连接被拒绝
PromoteMode	应用于提升作的模式。 KnownPromoteMode 可与 PromoteMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 切换：升级会将当前副本集群切换到主角色，原始主集群将切换到副本角色，从而保持复制链路。
PromoteOption	应用于提升作的选项。 KnownPromoteOption 可与 PromoteOption 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 强制：提升选项强制升级，而无需等待副本赶上主副本。 这可能会导致数据丢失，因此只能在灾难恢复方案中使用。
ProvisioningState	上次接受操作的预配状态。 KnownProvisioningState 可与 ProvisioningState 互换，此枚举包含服务支持的已知值。 服务支持的已知值 已成功：已创建资源。 失败：资源创建失败。 已取消：资源创建已取消。 InProgress：资源上的作正在进行中。 正在更新：资源正在进行更新作。 正在删除：资源上的删除作正在进行中。
PublicNetworkAccess	此 Mongo 群集是否允许公共终结点访问。 值为可选值，默认值为“已启用” KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 启用：如果设置，则可以通过私有和公共方法访问 mongo 集群。 禁用：如果设置，则专用终结点是独占访问方法。
ReplicationRole	mongo 群集的复制角色。 KnownReplicationRole 可与 ReplicationRole 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 主要：群集是主要副本。 AsyncReplica：集群是本地异步副本。 GeoAsyncReplica：群集是异地异步副本。
ReplicationState	副本和源群集之间的复制链接的状态。 KnownReplicationState 可与 ReplicationState 互换，此枚举包含服务支持的已知值。 服务支持的已知值 活动：复制链接处于活动状态。 追赶：副本正在赶上主副本。 这可能发生在创建副本或触发升级之后。 预配：正在创建到主服务器的副本和复制链接。 正在更新：由于副本上的更改或升级，正在更新复制链接。 已损坏：复制链接已断开，可能需要重新创建副本。 正在重新配置：由于升级事件，复制链接正在重新配置。
StorageType	可以配置 mongo 集群的存储类型。 KnownStorageType 可与 StorageType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 PremiumSSD：用于高性能工作负载的高级 SSD。 PremiumSSDv2：用于 IO 密集型工作负载的高级 SSD v2。 这是一个预览选项，有其他限制。
UserRole	可以分配给用户的内置数据库角色。 KnownUserRole 可以与 UserRole 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 root：目标作用域的根角色权限。

枚举

AzureClouds	用于描述 Azure 云环境的枚举。
KnownActionType	可扩展枚举。 指示作类型。 “内部”是指仅适用于内部 API 的作。
KnownAuthenticationMode	Mongo 集群支持的身份验证模式。
KnownCheckNameAvailabilityReason	名称不可用的可能原因。
KnownCreateMode	使用 Mongo 群集创建的模式。
KnownCreatedByType	创建资源的实体类型。
KnownDataApiMode	应用于 Mongo Data API 的模式。
KnownEntraPrincipalType	适用于 Mongo 用户的 Microsoft Entra ID 主体类型。
KnownHighAvailabilityMode	群集的高可用性模式。
KnownIdentityProviderType	用户身份可以属于的身份提供程序类型。
KnownKeyEncryptionKeyIdentityType	密钥加密密钥的标识类型。
KnownManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
KnownMongoClusterStatus	Mongo 群集资源的状态。
KnownOrigin	作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system”
KnownPreviewFeature	可以在 Mongo 群集上启用的预览功能。
KnownPrivateEndpointConnectionProvisioningState	当前预配状态。
KnownPrivateEndpointServiceConnectionStatus	专用终结点连接状态。
KnownPromoteMode	应用于提升作的模式。
KnownPromoteOption	应用于提升作的选项。
KnownProvisioningState	上次接受操作的预配状态。
KnownPublicNetworkAccess	此 Mongo 群集是否允许公共终结点访问。 值是可选的，默认值为“已启用”
KnownReplicationRole	mongo 群集的复制角色。
KnownReplicationState	副本和源群集之间的复制链接的状态。
KnownStorageType	可以配置 mongo 集群的存储类型。
KnownUserRole	可以分配给用户的内置数据库角色。
KnownVersions	可用的 API 版本。

函数

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

函数详细信息

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

从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器，或者在原始轮询器不在范围内后构造轮询器，这非常有用。

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

参数

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

返回

PollerLike<OperationState<TResult>, TResult>