@azure/arm-cosmosdbforpostgresql package

Classes

CosmosDBForPostgreSQL

Interfaces

Cluster	Represents a cluster.
ClusterConfigurationListResult	A list of cluster configurations.
ClusterForUpdate	Represents a cluster for update.
ClusterListResult	A list of clusters.
ClusterServer	Represents a server in a cluster.
ClusterServerListResult	A list of servers in a cluster.
ClusterServerProperties	The properties of a server in cluster.
Clusters	Interface representing a Clusters.
ClustersCheckNameAvailabilityOptionalParams	Optional parameters.
ClustersCreateHeaders	Defines headers for Clusters_create operation.
ClustersCreateOptionalParams	Optional parameters.
ClustersDeleteHeaders	Defines headers for Clusters_delete operation.
ClustersDeleteOptionalParams	Optional parameters.
ClustersGetOptionalParams	Optional parameters.
ClustersListByResourceGroupNextOptionalParams	Optional parameters.
ClustersListByResourceGroupOptionalParams	Optional parameters.
ClustersListNextOptionalParams	Optional parameters.
ClustersListOptionalParams	Optional parameters.
ClustersPromoteReadReplicaHeaders	Defines headers for Clusters_promoteReadReplica operation.
ClustersPromoteReadReplicaOptionalParams	Optional parameters.
ClustersRestartHeaders	Defines headers for Clusters_restart operation.
ClustersRestartOptionalParams	Optional parameters.
ClustersStartHeaders	Defines headers for Clusters_start operation.
ClustersStartOptionalParams	Optional parameters.
ClustersStopHeaders	Defines headers for Clusters_stop operation.
ClustersStopOptionalParams	Optional parameters.
ClustersUpdateHeaders	Defines headers for Clusters_update operation.
ClustersUpdateOptionalParams	Optional parameters.
Configuration	Represents configuration details for coordinator and node.
Configurations	Interface representing a Configurations.
ConfigurationsGetCoordinatorOptionalParams	Optional parameters.
ConfigurationsGetNodeOptionalParams	Optional parameters.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListByClusterNextOptionalParams	Optional parameters.
ConfigurationsListByClusterOptionalParams	Optional parameters.
ConfigurationsListByServerNextOptionalParams	Optional parameters.
ConfigurationsListByServerOptionalParams	Optional parameters.
ConfigurationsUpdateOnCoordinatorHeaders	Defines headers for Configurations_updateOnCoordinator operation.
ConfigurationsUpdateOnCoordinatorOptionalParams	Optional parameters.
ConfigurationsUpdateOnNodeHeaders	Defines headers for Configurations_updateOnNode operation.
ConfigurationsUpdateOnNodeOptionalParams	Optional parameters.
CosmosDBForPostgreSQLOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
FirewallRule	Represents a cluster firewall rule.
FirewallRuleListResult	A list of firewall rules.
FirewallRules	Interface representing a FirewallRules.
FirewallRulesCreateOrUpdateHeaders	Defines headers for FirewallRules_createOrUpdate operation.
FirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
FirewallRulesDeleteHeaders	Defines headers for FirewallRules_delete operation.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListByClusterOptionalParams	Optional parameters.
MaintenanceWindow	Schedule settings for regular cluster updates.
NameAvailability	Represents cluster name availability.
NameAvailabilityRequest	Request from client to check cluster name availability.
Operation	REST API operation definition.
OperationDisplay	Display metadata associated with the operation.
OperationListResult	A list of resource provider operations.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionListResult	List of private endpoint connections associated with the specified resource.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateHeaders	Defines headers for PrivateEndpointConnections_createOrUpdate operation.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteHeaders	Defines headers for PrivateEndpointConnections_delete operation.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByClusterOptionalParams	Optional parameters.
PrivateEndpointProperty	Property to represent resource id of the private endpoint.
PrivateLinkResource	A private link resource.
PrivateLinkResourceListResult	A list of private link resources.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByClusterOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
Role	Represents a cluster role.
RoleListResult	A list of roles.
Roles	Interface representing a Roles.
RolesCreateHeaders	Defines headers for Roles_create operation.
RolesCreateOptionalParams	Optional parameters.
RolesDeleteHeaders	Defines headers for Roles_delete operation.
RolesDeleteOptionalParams	Optional parameters.
RolesGetOptionalParams	Optional parameters.
RolesListByClusterOptionalParams	Optional parameters.
ServerConfiguration	Represents a configuration.
ServerConfigurationListResult	A list of server configurations.
ServerNameItem	The name object for a server.
ServerProperties	The properties of a server.
ServerRoleGroupConfiguration	Represents server role group configuration value.
Servers	Interface representing a Servers.
ServersGetOptionalParams	Optional parameters.
ServersListByClusterOptionalParams	Optional parameters.
SimplePrivateEndpointConnection	A private endpoint connection.
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ClustersCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
ClustersCreateResponse	Contains response data for the create operation.
ClustersGetResponse	Contains response data for the get operation.
ClustersListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ClustersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ClustersListNextResponse	Contains response data for the listNext operation.
ClustersListResponse	Contains response data for the list operation.
ClustersPromoteReadReplicaResponse	Contains response data for the promoteReadReplica operation.
ClustersRestartResponse	Contains response data for the restart operation.
ClustersUpdateResponse	Contains response data for the update operation.
ConfigurationDataType	Defines values for ConfigurationDataType. KnownConfigurationDataType can be used interchangeably with ConfigurationDataType, this enum contains the known values that the service supports. Known values supported by the service Boolean Numeric Integer Enumeration
ConfigurationsGetCoordinatorResponse	Contains response data for the getCoordinator operation.
ConfigurationsGetNodeResponse	Contains response data for the getNode operation.
ConfigurationsGetResponse	Contains response data for the get operation.
ConfigurationsListByClusterNextResponse	Contains response data for the listByClusterNext operation.
ConfigurationsListByClusterResponse	Contains response data for the listByCluster operation.
ConfigurationsListByServerNextResponse	Contains response data for the listByServerNext operation.
ConfigurationsListByServerResponse	Contains response data for the listByServer operation.
ConfigurationsUpdateOnCoordinatorResponse	Contains response data for the updateOnCoordinator operation.
ConfigurationsUpdateOnNodeResponse	Contains response data for the updateOnNode operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
FirewallRulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
FirewallRulesDeleteResponse	Contains response data for the delete operation.
FirewallRulesGetResponse	Contains response data for the get operation.
FirewallRulesListByClusterResponse	Contains response data for the listByCluster operation.
OperationOrigin	Defines values for OperationOrigin. KnownOperationOrigin can be used interchangeably with OperationOrigin, this enum contains the known values that the service supports. Known values supported by the service NotSpecified user system
OperationsListResponse	Contains response data for the list operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsDeleteResponse	Contains response data for the delete operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByClusterResponse	Contains response data for the listByCluster operation.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByClusterResponse	Contains response data for the listByCluster operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Canceled InProgress Failed
RolesCreateResponse	Contains response data for the create operation.
RolesDeleteResponse	Contains response data for the delete operation.
RolesGetResponse	Contains response data for the get operation.
RolesListByClusterResponse	Contains response data for the listByCluster operation.
ServerRole	Defines values for ServerRole. KnownServerRole can be used interchangeably with ServerRole, this enum contains the known values that the service supports. Known values supported by the service Coordinator Worker
ServersGetResponse	Contains response data for the get operation.
ServersListByClusterResponse	Contains response data for the listByCluster operation.

Enums

KnownConfigurationDataType	Known values of ConfigurationDataType that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownOperationOrigin	Known values of OperationOrigin that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownServerRole	Known values of ServerRole that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.