@azure/arm-postgresql-flexible package

Classes

PostgreSQLManagementFlexibleServerClient

Interfaces

ActiveDirectoryAdministrator

Represents an Active Directory administrator.

ActiveDirectoryAdministratorAdd

Represents an Active Directory administrator.

AdministratorListResult

A list of active directory administrators.

Administrators

Interface representing a Administrators.

AdministratorsCreateHeaders

Defines headers for Administrators_create operation.

AdministratorsCreateOptionalParams

Optional parameters.

AdministratorsDeleteHeaders

Defines headers for Administrators_delete operation.

AdministratorsDeleteOptionalParams

Optional parameters.

AdministratorsGetOptionalParams

Optional parameters.

AdministratorsListByServerNextOptionalParams

Optional parameters.

AdministratorsListByServerOptionalParams

Optional parameters.

AuthConfig

Authentication configuration properties of a server

Backup

Backup properties of a server

Backups

Interface representing a Backups.

BackupsGetOptionalParams

Optional parameters.

BackupsListByServerNextOptionalParams

Optional parameters.

BackupsListByServerOptionalParams

Optional parameters.

CapabilitiesListResult

location capability

CapabilityProperties

Location capabilities.

CheckNameAvailability

Interface representing a CheckNameAvailability.

CheckNameAvailabilityExecuteOptionalParams

Optional parameters.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

CheckNameAvailabilityWithLocation

Interface representing a CheckNameAvailabilityWithLocation.

CheckNameAvailabilityWithLocationExecuteOptionalParams

Optional parameters.

Configuration

Represents a Configuration.

ConfigurationForUpdate

Represents a Configuration.

ConfigurationListResult

A list of server configurations.

Configurations

Interface representing a Configurations.

ConfigurationsGetOptionalParams

Optional parameters.

ConfigurationsListByServerNextOptionalParams

Optional parameters.

ConfigurationsListByServerOptionalParams

Optional parameters.

ConfigurationsPutHeaders

Defines headers for Configurations_put operation.

ConfigurationsPutOptionalParams

Optional parameters.

ConfigurationsUpdateHeaders

Defines headers for Configurations_update operation.

ConfigurationsUpdateOptionalParams

Optional parameters.

DataEncryption

Data encryption properties of a server

Database

Represents a Database.

DatabaseListResult

A List of databases.

Databases

Interface representing a Databases.

DatabasesCreateHeaders

Defines headers for Databases_create operation.

DatabasesCreateOptionalParams

Optional parameters.

DatabasesDeleteHeaders

Defines headers for Databases_delete operation.

DatabasesDeleteOptionalParams

Optional parameters.

DatabasesGetOptionalParams

Optional parameters.

DatabasesListByServerNextOptionalParams

Optional parameters.

DatabasesListByServerOptionalParams

Optional parameters.

DelegatedSubnetUsage

Delegated subnet usage data.

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.).

FastProvisioningEditionCapability
FirewallRule

Represents a server 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.

FirewallRulesListByServerNextOptionalParams

Optional parameters.

FirewallRulesListByServerOptionalParams

Optional parameters.

FlexibleServerEditionCapability

Flexible server edition capabilities.

GetPrivateDnsZoneSuffix

Interface representing a GetPrivateDnsZoneSuffix.

GetPrivateDnsZoneSuffixExecuteOptionalParams

Optional parameters.

HighAvailability

High availability properties of a server

HyperscaleNodeEditionCapability

Hyperscale node edition capabilities.

LocationBasedCapabilities

Interface representing a LocationBasedCapabilities.

LocationBasedCapabilitiesExecuteNextOptionalParams

Optional parameters.

LocationBasedCapabilitiesExecuteOptionalParams

Optional parameters.

MaintenanceWindow

Maintenance window properties of a server.

NameAvailability

Represents a resource name availability.

Network

Network properties of a server

NodeTypeCapability

node type capability

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.

PostgreSQLManagementFlexibleServerClientOptionalParams

Optional parameters.

ProxyResource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location

Replicas

Interface representing a Replicas.

ReplicasListByServerOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

RestartParameter

Represents server restart parameters.

Server

Represents a server.

ServerBackup

Server backup properties

ServerBackupListResult

A list of server backups.

ServerForUpdate

Represents a server to be updated.

ServerListResult

A list of servers.

ServerVersionCapability

Server version capabilities.

Servers

Interface representing a Servers.

ServersCreateHeaders

Defines headers for Servers_create operation.

ServersCreateOptionalParams

Optional parameters.

ServersDeleteHeaders

Defines headers for Servers_delete operation.

ServersDeleteOptionalParams

Optional parameters.

ServersGetOptionalParams

Optional parameters.

ServersListByResourceGroupNextOptionalParams

Optional parameters.

ServersListByResourceGroupOptionalParams

Optional parameters.

ServersListNextOptionalParams

Optional parameters.

ServersListOptionalParams

Optional parameters.

ServersRestartHeaders

Defines headers for Servers_restart operation.

ServersRestartOptionalParams

Optional parameters.

ServersStartHeaders

Defines headers for Servers_start operation.

ServersStartOptionalParams

Optional parameters.

ServersStopHeaders

Defines headers for Servers_stop operation.

ServersStopOptionalParams

Optional parameters.

ServersUpdateHeaders

Defines headers for Servers_update operation.

ServersUpdateOptionalParams

Optional parameters.

Sku

Sku information related properties of a server.

Storage

Storage properties of a server

StorageEditionCapability

storage edition capability

StorageMBCapability

storage size in MB capability

StorageTierCapability
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'

UserAssignedIdentity

Information describing the identities associated with this application.

UserIdentity

Describes a single user-assigned identity associated with the application.

VcoreCapability

Vcores capability

VirtualNetworkSubnetUsage

Interface representing a VirtualNetworkSubnetUsage.

VirtualNetworkSubnetUsageExecuteOptionalParams

Optional parameters.

VirtualNetworkSubnetUsageParameter

Virtual network subnet usage parameter

VirtualNetworkSubnetUsageResult

Virtual network subnet usage data.

Type Aliases

ActiveDirectoryAuthEnum

Defines values for ActiveDirectoryAuthEnum.
KnownActiveDirectoryAuthEnum can be used interchangeably with ActiveDirectoryAuthEnum, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

AdministratorsCreateResponse

Contains response data for the create operation.

AdministratorsGetResponse

Contains response data for the get operation.

AdministratorsListByServerNextResponse

Contains response data for the listByServerNext operation.

AdministratorsListByServerResponse

Contains response data for the listByServer operation.

ArmServerKeyType

Defines values for ArmServerKeyType.
KnownArmServerKeyType can be used interchangeably with ArmServerKeyType, this enum contains the known values that the service supports.

Known values supported by the service

SystemManaged
AzureKeyVault

BackupsGetResponse

Contains response data for the get operation.

BackupsListByServerNextResponse

Contains response data for the listByServerNext operation.

BackupsListByServerResponse

Contains response data for the listByServer operation.

CheckNameAvailabilityExecuteResponse

Contains response data for the execute operation.

CheckNameAvailabilityReason

Defines values for CheckNameAvailabilityReason.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid
AlreadyExists

CheckNameAvailabilityWithLocationExecuteResponse

Contains response data for the execute 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

ConfigurationsGetResponse

Contains response data for the get operation.

ConfigurationsListByServerNextResponse

Contains response data for the listByServerNext operation.

ConfigurationsListByServerResponse

Contains response data for the listByServer operation.

ConfigurationsPutResponse

Contains response data for the put operation.

ConfigurationsUpdateResponse

Contains response data for the update 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
Create
Update
PointInTimeRestore
GeoRestore
Replica

CreateModeForUpdate

Defines values for CreateModeForUpdate.
KnownCreateModeForUpdate can be used interchangeably with CreateModeForUpdate, this enum contains the known values that the service supports.

Known values supported by the service

Default
Update

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

DatabasesCreateResponse

Contains response data for the create operation.

DatabasesGetResponse

Contains response data for the get operation.

DatabasesListByServerNextResponse

Contains response data for the listByServerNext operation.

DatabasesListByServerResponse

Contains response data for the listByServer operation.

FailoverMode

Defines values for FailoverMode.
KnownFailoverMode can be used interchangeably with FailoverMode, this enum contains the known values that the service supports.

Known values supported by the service

PlannedFailover
ForcedFailover
PlannedSwitchover
ForcedSwitchover

FirewallRulesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

FirewallRulesGetResponse

Contains response data for the get operation.

FirewallRulesListByServerNextResponse

Contains response data for the listByServerNext operation.

FirewallRulesListByServerResponse

Contains response data for the listByServer operation.

GeoRedundantBackupEnum

Defines values for GeoRedundantBackupEnum.
KnownGeoRedundantBackupEnum can be used interchangeably with GeoRedundantBackupEnum, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

GetPrivateDnsZoneSuffixExecuteResponse

Contains response data for the execute operation.

HighAvailabilityMode

Defines values for HighAvailabilityMode.
KnownHighAvailabilityMode can be used interchangeably with HighAvailabilityMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled
ZoneRedundant
SameZone

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

None
SystemAssigned
UserAssigned

LocationBasedCapabilitiesExecuteNextResponse

Contains response data for the executeNext operation.

LocationBasedCapabilitiesExecuteResponse

Contains response data for the execute 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.

Origin

Defines values for Origin.
KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports.

Known values supported by the service

Full

PasswordAuthEnum

Defines values for PasswordAuthEnum.
KnownPasswordAuthEnum can be used interchangeably with PasswordAuthEnum, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

PrincipalType

Defines values for PrincipalType.
KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown
User
Group
ServicePrincipal

ReplicasListByServerResponse

Contains response data for the listByServer operation.

ReplicationRole

Defines values for ReplicationRole.
KnownReplicationRole can be used interchangeably with ReplicationRole, this enum contains the known values that the service supports.

Known values supported by the service

None
Primary
AsyncReplica
GeoAsyncReplica

ServerHAState

Defines values for ServerHAState.
KnownServerHAState can be used interchangeably with ServerHAState, this enum contains the known values that the service supports.

Known values supported by the service

NotEnabled
CreatingStandby
ReplicatingData
FailingOver
Healthy
RemovingStandby

ServerPublicNetworkAccessState

Defines values for ServerPublicNetworkAccessState.
KnownServerPublicNetworkAccessState can be used interchangeably with ServerPublicNetworkAccessState, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

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
Starting
Stopping
Stopped
Updating

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

14
13
12
11

ServersCreateResponse

Contains response data for the create operation.

ServersGetResponse

Contains response data for the get operation.

ServersListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ServersListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ServersListNextResponse

Contains response data for the listNext 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

Burstable
GeneralPurpose
MemoryOptimized

VirtualNetworkSubnetUsageExecuteResponse

Contains response data for the execute operation.

Enums

KnownActiveDirectoryAuthEnum

Known values of ActiveDirectoryAuthEnum that the service accepts.

KnownArmServerKeyType

Known values of ArmServerKeyType that the service accepts.

KnownCheckNameAvailabilityReason

Known values of CheckNameAvailabilityReason that the service accepts.

KnownConfigurationDataType

Known values of ConfigurationDataType that the service accepts.

KnownCreateMode

Known values of CreateMode that the service accepts.

KnownCreateModeForUpdate

Known values of CreateModeForUpdate that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownFailoverMode

Known values of FailoverMode that the service accepts.

KnownGeoRedundantBackupEnum

Known values of GeoRedundantBackupEnum that the service accepts.

KnownHighAvailabilityMode

Known values of HighAvailabilityMode that the service accepts.

KnownIdentityType

Known values of IdentityType that the service accepts.

KnownOperationOrigin

Known values of OperationOrigin that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownPasswordAuthEnum

Known values of PasswordAuthEnum that the service accepts.

KnownPrincipalType

Known values of PrincipalType that the service accepts.

KnownReplicationRole

Known values of ReplicationRole that the service accepts.

KnownServerHAState

Known values of ServerHAState that the service accepts.

KnownServerPublicNetworkAccessState

Known values of ServerPublicNetworkAccessState 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.

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.