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

@azure/arm-cosmosdbforpostgresql package

CosmosDBForPostgreSQL

接口

Cluster

表示群集。

ClusterConfigurationListResult

群集配置列表。

ClusterForUpdate

表示要更新的群集。

ClusterListResult

群集列表。

ClusterServer

表示群集中的服务器。

ClusterServerListResult

群集中的服务器列表。

ClusterServerProperties

群集中服务器的属性。

Clusters

表示群集的接口。

ClustersCheckNameAvailabilityOptionalParams

可选参数。

ClustersCreateHeaders

定义Clusters_create作的标头。

ClustersCreateOptionalParams

可选参数。

ClustersDeleteHeaders

定义Clusters_delete作的标头。

ClustersDeleteOptionalParams

可选参数。

ClustersGetOptionalParams

可选参数。

ClustersListByResourceGroupNextOptionalParams

可选参数。

ClustersListByResourceGroupOptionalParams

可选参数。

ClustersListNextOptionalParams

可选参数。

ClustersListOptionalParams

可选参数。

ClustersPromoteReadReplicaHeaders

定义Clusters_promoteReadReplica作的标头。

ClustersPromoteReadReplicaOptionalParams

可选参数。

ClustersRestartHeaders

定义Clusters_restart作的标头。

ClustersRestartOptionalParams

可选参数。

ClustersStartHeaders

定义Clusters_start作的标头。

ClustersStartOptionalParams

可选参数。

ClustersStopHeaders

定义Clusters_stop作的标头。

ClustersStopOptionalParams

可选参数。

ClustersUpdateHeaders

定义Clusters_update作的标头。

ClustersUpdateOptionalParams

可选参数。

Configuration

表示协调器和节点的配置详细信息。

Configurations

表示配置的接口。

ConfigurationsGetCoordinatorOptionalParams

可选参数。

ConfigurationsGetNodeOptionalParams

可选参数。

ConfigurationsGetOptionalParams

可选参数。

ConfigurationsListByClusterNextOptionalParams

可选参数。

ConfigurationsListByClusterOptionalParams

可选参数。

ConfigurationsListByServerNextOptionalParams

可选参数。

ConfigurationsListByServerOptionalParams

可选参数。

ConfigurationsUpdateOnCoordinatorHeaders

定义Configurations_updateOnCoordinator作的标头。

ConfigurationsUpdateOnCoordinatorOptionalParams

可选参数。

ConfigurationsUpdateOnNodeHeaders

定义Configurations_updateOnNode作的标头。

ConfigurationsUpdateOnNodeOptionalParams

可选参数。

CosmosDBForPostgreSQLOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的常见错误响应,以返回失败作的错误详细信息。 (这也遵循 OData 错误响应格式)。

FirewallRule

表示群集防火墙规则。

FirewallRuleListResult

防火墙规则列表。

FirewallRules

表示 FirewallRules 的接口。

FirewallRulesCreateOrUpdateHeaders

定义FirewallRules_createOrUpdate作的标头。

FirewallRulesCreateOrUpdateOptionalParams

可选参数。

FirewallRulesDeleteHeaders

定义FirewallRules_delete作的标头。

FirewallRulesDeleteOptionalParams

可选参数。

FirewallRulesGetOptionalParams

可选参数。

FirewallRulesListByClusterOptionalParams

可选参数。

MaintenanceWindow

计划常规群集更新的设置。

NameAvailability

表示群集名称可用性。

NameAvailabilityRequest

从客户端请求检查群集名称可用性。

Operation

REST API作定义。

OperationDisplay

显示与作关联的元数据。

OperationListResult

资源提供程序作的列表。

Operations

表示作的接口。

OperationsListOptionalParams

可选参数。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionListResult

与指定资源关联的专用终结点连接列表。

PrivateEndpointConnections

表示 PrivateEndpointConnections 的接口。

PrivateEndpointConnectionsCreateOrUpdateHeaders

定义PrivateEndpointConnections_createOrUpdate作的标头。

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

可选参数。

PrivateEndpointConnectionsDeleteHeaders

定义PrivateEndpointConnections_delete作的标头。

PrivateEndpointConnectionsDeleteOptionalParams

可选参数。

PrivateEndpointConnectionsGetOptionalParams

可选参数。

PrivateEndpointConnectionsListByClusterOptionalParams

可选参数。

PrivateEndpointProperty

表示专用终结点的资源 ID 的属性。

PrivateLinkResource

专用链接资源。

PrivateLinkResourceListResult

专用链接资源的列表。

PrivateLinkResources

表示 PrivateLinkResources 的接口。

PrivateLinkResourcesGetOptionalParams

可选参数。

PrivateLinkResourcesListByClusterOptionalParams

可选参数。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

Role

表示群集角色。

RoleListResult

角色列表。

Roles

表示角色的接口。

RolesCreateHeaders

定义Roles_create作的标头。

RolesCreateOptionalParams

可选参数。

RolesDeleteHeaders

定义Roles_delete作的标头。

RolesDeleteOptionalParams

可选参数。

RolesGetOptionalParams

可选参数。

RolesListByClusterOptionalParams

可选参数。

ServerConfiguration

表示配置。

ServerConfigurationListResult

服务器配置列表。

ServerNameItem

服务器的名称对象。

ServerProperties

服务器的属性。

ServerRoleGroupConfiguration

表示服务器角色组配置值。

Servers

表示服务器的接口。

ServersGetOptionalParams

可选参数。

ServersListByClusterOptionalParams

可选参数。

SimplePrivateEndpointConnection

专用终结点连接。

SystemData

与创建和上次修改资源相关的元数据。

TrackedResource

Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源

类型别名

ClustersCheckNameAvailabilityResponse

包含 checkNameAvailability作的响应数据。

ClustersCreateResponse

包含创建作的响应数据。

ClustersGetResponse

包含获取作的响应数据。

ClustersListByResourceGroupNextResponse

包含 listByResourceGroupNext作的响应数据。

ClustersListByResourceGroupResponse

包含 listByResourceGroup作的响应数据。

ClustersListNextResponse

包含 listNext作的响应数据。

ClustersListResponse

包含列表作的响应数据。

ClustersPromoteReadReplicaResponse

包含 promoteReadReplica作的响应数据。

ClustersRestartResponse

包含重启作的响应数据。

ClustersUpdateResponse

包含更新作的响应数据。

ConfigurationDataType

定义 ConfigurationDataType 的值。
KnownConfigurationDataType 可与 ConfigurationDataType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

布尔
数字
整数
枚举

ConfigurationsGetCoordinatorResponse

包含 getCoordinator作的响应数据。

ConfigurationsGetNodeResponse

包含 getNode作的响应数据。

ConfigurationsGetResponse

包含获取作的响应数据。

ConfigurationsListByClusterNextResponse

包含 listByClusterNext作的响应数据。

ConfigurationsListByClusterResponse

包含 listByCluster作的响应数据。

ConfigurationsListByServerNextResponse

包含 listByServerNext作的响应数据。

ConfigurationsListByServerResponse

包含 listByServer作的响应数据。

ConfigurationsUpdateOnCoordinatorResponse

包含 updateOnCoordinator作的响应数据。

ConfigurationsUpdateOnNodeResponse

包含 updateOnNode作的响应数据。

CreatedByType

定义 CreatedByType 的值。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户
应用程序
ManagedIdentity
密钥

FirewallRulesCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

FirewallRulesDeleteResponse

包含删除作的响应数据。

FirewallRulesGetResponse

包含获取作的响应数据。

FirewallRulesListByClusterResponse

包含 listByCluster作的响应数据。

OperationOrigin

定义 OperationOrigin 的值。
KnownOperationOrigin 可与 OperationOrigin 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

NotSpecified
用户
系统

OperationsListResponse

包含列表作的响应数据。

PrivateEndpointConnectionProvisioningState

定义 PrivateEndpointConnectionProvisioningState 的值。
KnownPrivateEndpointConnectionProvisioningState 可与 PrivateEndpointConnectionProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

已成功
创建
删除
失败

PrivateEndpointConnectionsCreateOrUpdateResponse

包含 createOrUpdate作的响应数据。

PrivateEndpointConnectionsDeleteResponse

包含删除作的响应数据。

PrivateEndpointConnectionsGetResponse

包含获取作的响应数据。

PrivateEndpointConnectionsListByClusterResponse

包含 listByCluster作的响应数据。

PrivateEndpointServiceConnectionStatus

定义 PrivateEndpointServiceConnectionStatus 的值。
KnownPrivateEndpointServiceConnectionStatus 可与 PrivateEndpointServiceConnectionStatus 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

挂起的
已批准
拒绝

PrivateLinkResourcesGetResponse

包含获取作的响应数据。

PrivateLinkResourcesListByClusterResponse

包含 listByCluster作的响应数据。

ProvisioningState

定义 ProvisioningState 的值。
KnownProvisioningState 可与 ProvisioningState 互换,此枚举包含服务支持的已知值。

服务支持的已知值

已成功
已取消
InProgress
失败

RolesCreateResponse

包含创建作的响应数据。

RolesDeleteResponse

包含删除作的响应数据。

RolesGetResponse

包含获取作的响应数据。

RolesListByClusterResponse

包含 listByCluster作的响应数据。

ServerRole

定义 ServerRole 的值。
KnownServerRole 可与 ServerRole 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

协调器
辅助角色

ServersGetResponse

包含获取作的响应数据。

ServersListByClusterResponse

包含 listByCluster作的响应数据。

枚举

KnownConfigurationDataType

ConfigurationDataType 服务的已知值。

KnownCreatedByType

服务的 CreatedByType 的已知值

KnownOperationOrigin

服务的 OperationOrigin 已知值。

KnownPrivateEndpointConnectionProvisioningState

PrivateEndpointConnectionProvisioningState 服务的已知值。

KnownPrivateEndpointServiceConnectionStatus

PrivateEndpointServiceConnectionStatus 服务的已知值。

KnownProvisioningState

服务的 ProvisioningState 的已知值。

KnownServerRole

服务的 ServerRole 已知值。

函数

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

函数详细信息

getContinuationToken(unknown)

给定由 byPage 迭代器生成的最后一个 .value,返回一个延续标记,该标记可用于稍后开始分页。

function getContinuationToken(page: unknown): string | undefined

参数

page

unknown

byPage 迭代器访问 IteratorResult 上的 value 的对象。

返回

string | undefined

可在将来调用期间传递到 byPage() 的延续标记。