你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/arm-mongocluster package

类

MongoClusterManagementClient

接口

CheckNameAvailabilityRequest	检查可用性请求正文。
CheckNameAvailabilityResponse	检查可用性结果。
ConnectionString	Mongo 群集的连接字符串
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。
FirewallRule	表示 Mongo 群集防火墙规则。
FirewallRuleProperties	Mongo 群集防火墙规则的属性。
FirewallRulesCreateOrUpdateOptionalParams	可选参数。
FirewallRulesDeleteOptionalParams	可选参数。
FirewallRulesGetOptionalParams	可选参数。
FirewallRulesListByMongoClusterOptionalParams	可选参数。
FirewallRulesOperations	表示 FirewallRules 操作的接口。
ListConnectionStringsResult	给定 mongo 群集的连接字符串。
MongoCluster	表示 mongo 群集资源。
MongoClusterManagementClientOptionalParams	客户端的可选参数。
MongoClusterProperties	mongo 群集的属性。
MongoClusterRestoreParameters	用于还原操作的参数
MongoClusterUpdate	用于 MongoCluster 更新操作的类型。
MongoClusterUpdateProperties	MongoCluster 的可更新属性。
MongoClustersCheckNameAvailabilityOptionalParams	可选参数。
MongoClustersCreateOrUpdateOptionalParams	可选参数。
MongoClustersDeleteOptionalParams	可选参数。
MongoClustersGetOptionalParams	可选参数。
MongoClustersListByResourceGroupOptionalParams	可选参数。
MongoClustersListConnectionStringsOptionalParams	可选参数。
MongoClustersListOptionalParams	可选参数。
MongoClustersOperations	表示 MongoClusters 操作的接口。
MongoClustersUpdateOptionalParams	可选参数。
NodeGroupSpec	节点组的规范。
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 操作的接口。
ProxyResource	Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
RestorePollerOptions
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

类型别名

ActionType	可扩展枚举。 指示操作类型。 “内部”是指仅适用于内部 API 的操作。 KnownActionType 可与 ActionType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 内部
CheckNameAvailabilityReason	名称不可用的可能原因。 KnownCheckNameAvailabilityReason 可与 CheckNameAvailabilityReason 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 无效的 AlreadyExists
ContinuablePage	描述结果页的接口。
CreateMode	使用 Mongo 群集创建的模式。 KnownCreateMode 可与 CreateMode 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 默认 PointInTimeRestore
CreatedByType	创建资源的实体类型。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户 应用程序 ManagedIdentity 密钥
MongoClusterStatus	Mongo 群集资源的状态。 KnownMongoClusterStatus 可与 MongoClusterStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 就绪 预配 更新 开始 停止 已停止 删除
NodeKind	群集上的节点类型。 KnownNodeKind 可与 NodeKind 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 分片
Origin	操作的预期执行程序;与基于资源的访问控制 （RBAC） 和审核日志 UX 中一样。 默认值为“user，system” KnownOrigin 可与 Origin 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 用户 系统 用户，系统
PrivateEndpointConnectionProvisioningState	当前预配状态。 KnownPrivateEndpointConnectionProvisioningState 可与 PrivateEndpointConnectionProvisioningState 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已成功 创建 删除 失败
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。 KnownPrivateEndpointServiceConnectionStatus 可与 PrivateEndpointServiceConnectionStatus 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 挂起的 已批准 拒绝
ProvisioningState	ProvisioningState 的别名
PublicNetworkAccess	此 Mongo 群集是否允许公共终结点访问。 值为可选值，默认值为“已启用” KnownPublicNetworkAccess 可与 PublicNetworkAccess 互换使用，此枚举包含服务支持的已知值。 服务支持的已知值 已启用 禁用
ResourceProvisioningState	资源类型的预配状态。 KnownResourceProvisioningState 可与 ResourceProvisioningState 互换，此枚举包含服务支持的已知值。 服务支持的已知值 已成功 失败 已取消
Versions	可用的 API 版本。

枚举

KnownActionType	服务的 ActionType 已知值。
KnownCheckNameAvailabilityReason	CheckNameAvailabilityReason 服务的已知值。
KnownCreateMode	服务的 CreateMode 已知值。
KnownCreatedByType	服务的 CreatedByType 的已知值。
KnownMongoClusterStatus	服务接受的 MongoClusterStatus 的已知值。
KnownNodeKind	服务的 NodeKind 已知值。
KnownOrigin	服务的 Origin 的已知值。
KnownPrivateEndpointConnectionProvisioningState	PrivateEndpointConnectionProvisioningState 服务的已知值。
KnownPrivateEndpointServiceConnectionStatus	PrivateEndpointServiceConnectionStatus 服务的已知值。
KnownPublicNetworkAccess	PublicNetworkAccess 服务的已知值。
KnownResourceProvisioningState	服务的 ResourceProvisioningState 的已知值。

函数

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>