@azure/arm-postgresql package

Classes

PostgreSQLManagementClient

Interfaces

CheckNameAvailability	Interface representing a CheckNameAvailability.
CheckNameAvailabilityExecuteOptionalParams	Optional parameters.
CloudError	An error response from the Batch service.
Configuration	Represents a Configuration.
ConfigurationListResult	A list of server configurations.
Configurations	Interface representing a Configurations.
ConfigurationsCreateOrUpdateOptionalParams	Optional parameters.
ConfigurationsGetOptionalParams	Optional parameters.
ConfigurationsListByServerOptionalParams	Optional parameters.
Database	Represents a Database.
DatabaseListResult	A List of databases.
Databases	Interface representing a Databases.
DatabasesCreateOrUpdateOptionalParams	Optional parameters.
DatabasesDeleteOptionalParams	Optional parameters.
DatabasesGetOptionalParams	Optional parameters.
DatabasesListByServerOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
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 server firewall rule.
FirewallRuleListResult	A list of firewall rules.
FirewallRules	Interface representing a FirewallRules.
FirewallRulesCreateOrUpdateOptionalParams	Optional parameters.
FirewallRulesDeleteOptionalParams	Optional parameters.
FirewallRulesGetOptionalParams	Optional parameters.
FirewallRulesListByServerOptionalParams	Optional parameters.
LocationBasedPerformanceTier	Interface representing a LocationBasedPerformanceTier.
LocationBasedPerformanceTierListOptionalParams	Optional parameters.
LogFile	Represents a log file.
LogFileListResult	A list of log files.
LogFiles	Interface representing a LogFiles.
LogFilesListByServerOptionalParams	Optional parameters.
NameAvailability	Represents a resource name availability.
NameAvailabilityRequest	Request from client to check resource 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.
PerformanceTierListResult	A list of performance tiers.
PerformanceTierProperties	Performance tier properties
PerformanceTierServiceLevelObjectives	Service level objectives for performance tier.
PostgreSQLManagementClientOptionalParams	Optional parameters.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionListResult	A list of private endpoint connections.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServerNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServerOptionalParams	Optional parameters.
PrivateEndpointConnectionsUpdateTagsOptionalParams	Optional parameters.
PrivateEndpointProperty
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByServerNextOptionalParams	Optional parameters.
PrivateLinkResourcesListByServerOptionalParams	Optional parameters.
PrivateLinkServiceConnectionStateProperty
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RecoverableServerResource	A recoverable server resource.
RecoverableServers	Interface representing a RecoverableServers.
RecoverableServersGetOptionalParams	Optional parameters.
Replicas	Interface representing a Replicas.
ReplicasListByServerOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceIdentity	Azure Active Directory identity configuration for a resource.
Server	Represents a server.
ServerAdministratorResource	Represents a and external administrator to be created.
ServerAdministratorResourceListResult	The response to a list Active Directory Administrators request.
ServerAdministrators	Interface representing a ServerAdministrators.
ServerAdministratorsCreateOrUpdateOptionalParams	Optional parameters.
ServerAdministratorsDeleteOptionalParams	Optional parameters.
ServerAdministratorsGetOptionalParams	Optional parameters.
ServerAdministratorsListOptionalParams	Optional parameters.
ServerBasedPerformanceTier	Interface representing a ServerBasedPerformanceTier.
ServerBasedPerformanceTierListOptionalParams	Optional parameters.
ServerForCreate	Represents a server to be created.
ServerKey	A PostgreSQL Server key.
ServerKeyListResult	A list of PostgreSQL Server keys.
ServerKeys	Interface representing a ServerKeys.
ServerKeysCreateOrUpdateOptionalParams	Optional parameters.
ServerKeysDeleteOptionalParams	Optional parameters.
ServerKeysGetOptionalParams	Optional parameters.
ServerKeysListNextOptionalParams	Optional parameters.
ServerKeysListOptionalParams	Optional parameters.
ServerListResult	A list of servers.
ServerParameters	Interface representing a ServerParameters.
ServerParametersListUpdateConfigurationsOptionalParams	Optional parameters.
ServerPrivateEndpointConnection	A private endpoint connection under a server
ServerPrivateEndpointConnectionProperties	Properties of a private endpoint connection.
ServerPrivateLinkServiceConnectionStateProperty
ServerPropertiesForCreate	The properties used to create a new server.
ServerPropertiesForDefaultCreate	The properties used to create a new server.
ServerPropertiesForGeoRestore	The properties used to create a new server by restoring to a different region from a geo replicated backup.
ServerPropertiesForReplica	The properties to create a new replica.
ServerPropertiesForRestore	The properties used to create a new server by restoring from a backup.
ServerSecurityAlertPolicies	Interface representing a ServerSecurityAlertPolicies.
ServerSecurityAlertPoliciesCreateOrUpdateOptionalParams	Optional parameters.
ServerSecurityAlertPoliciesGetOptionalParams	Optional parameters.
ServerSecurityAlertPoliciesListByServerNextOptionalParams	Optional parameters.
ServerSecurityAlertPoliciesListByServerOptionalParams	Optional parameters.
ServerSecurityAlertPolicy	A server security alert policy.
ServerSecurityAlertPolicyListResult	A list of the server's security alert policies.
ServerUpdateParameters	Parameters allowed to update for a server.
Servers	Interface representing a Servers.
ServersCreateOptionalParams	Optional parameters.
ServersDeleteOptionalParams	Optional parameters.
ServersGetOptionalParams	Optional parameters.
ServersListByResourceGroupOptionalParams	Optional parameters.
ServersListOptionalParams	Optional parameters.
ServersRestartOptionalParams	Optional parameters.
ServersUpdateOptionalParams	Optional parameters.
Sku	Billing information related properties of a server.
StorageProfile	Storage Profile properties of a server
TagsObject	Tags object for patch operations.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
VirtualNetworkRule	A virtual network rule.
VirtualNetworkRuleListResult	A list of virtual network rules.
VirtualNetworkRules	Interface representing a VirtualNetworkRules.
VirtualNetworkRulesCreateOrUpdateOptionalParams	Optional parameters.
VirtualNetworkRulesDeleteOptionalParams	Optional parameters.
VirtualNetworkRulesGetOptionalParams	Optional parameters.
VirtualNetworkRulesListByServerNextOptionalParams	Optional parameters.
VirtualNetworkRulesListByServerOptionalParams	Optional parameters.

Type Aliases

CheckNameAvailabilityExecuteResponse	Contains response data for the execute operation.
ConfigurationsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ConfigurationsGetResponse	Contains response data for the get operation.
ConfigurationsListByServerResponse	Contains response data for the listByServer operation.
CreateMode	Defines values for CreateMode. KnownCreateMode can be used interchangeably with CreateMode, this enum contains the known values that the service supports. Known values supported by the service Default PointInTimeRestore GeoRestore Replica
DatabasesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DatabasesGetResponse	Contains response data for the get operation.
DatabasesListByServerResponse	Contains response data for the listByServer operation.
FirewallRulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
FirewallRulesGetResponse	Contains response data for the get operation.
FirewallRulesListByServerResponse	Contains response data for the listByServer operation.
GeoRedundantBackup	Defines values for GeoRedundantBackup. KnownGeoRedundantBackup can be used interchangeably with GeoRedundantBackup, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
IdentityType	Defines values for IdentityType. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service SystemAssigned
InfrastructureEncryption	Defines values for InfrastructureEncryption. KnownInfrastructureEncryption can be used interchangeably with InfrastructureEncryption, this enum contains the known values that the service supports. Known values supported by the service Enabled: Default value for single layer of encryption for data at rest. Disabled: Additional (2nd) layer of encryption for data at rest
LocationBasedPerformanceTierListResponse	Contains response data for the list operation.
LogFilesListByServerResponse	Contains response data for the listByServer operation.
MinimalTlsVersionEnum	Defines values for MinimalTlsVersionEnum. KnownMinimalTlsVersionEnum can be used interchangeably with MinimalTlsVersionEnum, this enum contains the known values that the service supports. Known values supported by the service TLS1_0 TLS1_1 TLS1_2 TLSEnforcementDisabled
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.
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByServerNextResponse	Contains response data for the listByServerNext operation.
PrivateEndpointConnectionsListByServerResponse	Contains response data for the listByServer operation.
PrivateEndpointConnectionsUpdateTagsResponse	Contains response data for the updateTags operation.
PrivateEndpointProvisioningState	Defines values for PrivateEndpointProvisioningState. KnownPrivateEndpointProvisioningState can be used interchangeably with PrivateEndpointProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Approving Ready Dropping Failed Rejecting
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByServerNextResponse	Contains response data for the listByServerNext operation.
PrivateLinkResourcesListByServerResponse	Contains response data for the listByServer operation.
PrivateLinkServiceConnectionStateActionsRequire	Defines values for PrivateLinkServiceConnectionStateActionsRequire. KnownPrivateLinkServiceConnectionStateActionsRequire can be used interchangeably with PrivateLinkServiceConnectionStateActionsRequire, this enum contains the known values that the service supports. Known values supported by the service None
PrivateLinkServiceConnectionStateStatus	Defines values for PrivateLinkServiceConnectionStateStatus. KnownPrivateLinkServiceConnectionStateStatus can be used interchangeably with PrivateLinkServiceConnectionStateStatus, this enum contains the known values that the service supports. Known values supported by the service Approved Pending Rejected Disconnected
PublicNetworkAccessEnum	Defines values for PublicNetworkAccessEnum. KnownPublicNetworkAccessEnum can be used interchangeably with PublicNetworkAccessEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
RecoverableServersGetResponse	Contains response data for the get operation.
ReplicasListByServerResponse	Contains response data for the listByServer operation.
SecurityAlertPolicyName	Defines values for SecurityAlertPolicyName. KnownSecurityAlertPolicyName can be used interchangeably with SecurityAlertPolicyName, this enum contains the known values that the service supports. Known values supported by the service Default
ServerAdministratorsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ServerAdministratorsGetResponse	Contains response data for the get operation.
ServerAdministratorsListResponse	Contains response data for the list operation.
ServerBasedPerformanceTierListResponse	Contains response data for the list operation.
ServerKeyType	Defines values for ServerKeyType. KnownServerKeyType can be used interchangeably with ServerKeyType, this enum contains the known values that the service supports. Known values supported by the service AzureKeyVault
ServerKeysCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ServerKeysGetResponse	Contains response data for the get operation.
ServerKeysListNextResponse	Contains response data for the listNext operation.
ServerKeysListResponse	Contains response data for the list operation.
ServerParametersListUpdateConfigurationsResponse	Contains response data for the listUpdateConfigurations operation.
ServerPropertiesForCreateUnion
ServerSecurityAlertPoliciesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ServerSecurityAlertPoliciesGetResponse	Contains response data for the get operation.
ServerSecurityAlertPoliciesListByServerNextResponse	Contains response data for the listByServerNext operation.
ServerSecurityAlertPoliciesListByServerResponse	Contains response data for the listByServer operation.
ServerSecurityAlertPolicyState	Defines values for ServerSecurityAlertPolicyState.
ServerState	Defines values for ServerState. KnownServerState can be used interchangeably with ServerState, this enum contains the known values that the service supports. Known values supported by the service Ready Dropping Disabled Inaccessible
ServerVersion	Defines values for ServerVersion. KnownServerVersion can be used interchangeably with ServerVersion, this enum contains the known values that the service supports. Known values supported by the service 9.5 9.6 10 10.0 10.2 11
ServersCreateResponse	Contains response data for the create operation.
ServersGetResponse	Contains response data for the get operation.
ServersListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ServersListResponse	Contains response data for the list operation.
ServersUpdateResponse	Contains response data for the update operation.
SkuTier	Defines values for SkuTier. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Basic GeneralPurpose MemoryOptimized
SslEnforcementEnum	Defines values for SslEnforcementEnum.
StorageAutogrow	Defines values for StorageAutogrow. KnownStorageAutogrow can be used interchangeably with StorageAutogrow, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
VirtualNetworkRuleState	Defines values for VirtualNetworkRuleState. KnownVirtualNetworkRuleState can be used interchangeably with VirtualNetworkRuleState, this enum contains the known values that the service supports. Known values supported by the service Initializing InProgress Ready Deleting Unknown
VirtualNetworkRulesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
VirtualNetworkRulesGetResponse	Contains response data for the get operation.
VirtualNetworkRulesListByServerNextResponse	Contains response data for the listByServerNext operation.
VirtualNetworkRulesListByServerResponse	Contains response data for the listByServer operation.

Enums

KnownCreateMode	Known values of CreateMode that the service accepts.
KnownGeoRedundantBackup	Known values of GeoRedundantBackup that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownInfrastructureEncryption	Known values of InfrastructureEncryption that the service accepts.
KnownMinimalTlsVersionEnum	Known values of MinimalTlsVersionEnum that the service accepts.
KnownOperationOrigin	Known values of OperationOrigin that the service accepts.
KnownPrivateEndpointProvisioningState	Known values of PrivateEndpointProvisioningState that the service accepts.
KnownPrivateLinkServiceConnectionStateActionsRequire	Known values of PrivateLinkServiceConnectionStateActionsRequire that the service accepts.
KnownPrivateLinkServiceConnectionStateStatus	Known values of PrivateLinkServiceConnectionStateStatus that the service accepts.
KnownPublicNetworkAccessEnum	Known values of PublicNetworkAccessEnum that the service accepts.
KnownSecurityAlertPolicyName	Known values of SecurityAlertPolicyName that the service accepts.
KnownServerKeyType	Known values of ServerKeyType that the service accepts.
KnownServerState	Known values of ServerState that the service accepts.
KnownServerVersion	Known values of ServerVersion that the service accepts.
KnownSkuTier	Known values of SkuTier that the service accepts.
KnownStorageAutogrow	Known values of StorageAutogrow that the service accepts.
KnownVirtualNetworkRuleState	Known values of VirtualNetworkRuleState that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

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