Share via


@azure/arm-postgresql-flexible package

Classes

PostgreSQLManagementFlexibleServerClient

Interfaces

AdminCredentials

Credentials of administrator users for source and target servers.

AdminCredentialsForPatch

Credentials of administrator users for source and target servers.

AdministratorMicrosoftEntra

Server administrator associated to a Microsoft Entra principal.

AdministratorMicrosoftEntraAdd

Server administrator associated to a Microsoft Entra principal.

AdministratorMicrosoftEntraList

List of server administrators associated to Microsoft Entra principals.

AdministratorsMicrosoftEntra

Interface representing a AdministratorsMicrosoftEntra.

AdministratorsMicrosoftEntraCreateOrUpdateHeaders

Defines headers for AdministratorsMicrosoftEntra_createOrUpdate operation.

AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraDeleteHeaders

Defines headers for AdministratorsMicrosoftEntra_delete operation.

AdministratorsMicrosoftEntraDeleteOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraGetOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraListByServerNextOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraListByServerOptionalParams

Optional parameters.

AdvancedThreatProtectionSettings

Interface representing a AdvancedThreatProtectionSettings.

AdvancedThreatProtectionSettingsGetOptionalParams

Optional parameters.

AdvancedThreatProtectionSettingsList

List of advanced threat protection settings for a server.

AdvancedThreatProtectionSettingsListByServerNextOptionalParams

Optional parameters.

AdvancedThreatProtectionSettingsListByServerOptionalParams

Optional parameters.

AdvancedThreatProtectionSettingsModel

Advanced threat protection settings of the server.

AuthConfig

Authentication configuration properties of a server.

AuthConfigForPatch

Authentication configuration properties of a server.

Backup

Backup properties of a server.

BackupAutomaticAndOnDemand

Properties of a backup.

BackupAutomaticAndOnDemandList

List of backups.

BackupForPatch

Backup properties of a server.

BackupRequestBase

BackupRequestBase is the base for all backup request.

BackupSettings

The settings for the long term backup.

BackupStoreDetails

Details about the target where the backup content will be stored.

BackupsAutomaticAndOnDemand

Interface representing a BackupsAutomaticAndOnDemand.

BackupsAutomaticAndOnDemandCreateHeaders

Defines headers for BackupsAutomaticAndOnDemand_create operation.

BackupsAutomaticAndOnDemandCreateOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandDeleteHeaders

Defines headers for BackupsAutomaticAndOnDemand_delete operation.

BackupsAutomaticAndOnDemandDeleteOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandGetOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandListByServerNextOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandListByServerOptionalParams

Optional parameters.

BackupsLongTermRetention

Interface representing a BackupsLongTermRetention.

BackupsLongTermRetentionCheckPrerequisitesExceptionHeaders

Defines headers for BackupsLongTermRetention_checkPrerequisites operation.

BackupsLongTermRetentionCheckPrerequisitesHeaders

Defines headers for BackupsLongTermRetention_checkPrerequisites operation.

BackupsLongTermRetentionCheckPrerequisitesOptionalParams

Optional parameters.

BackupsLongTermRetentionGetOptionalParams

Optional parameters.

BackupsLongTermRetentionListByServerNextOptionalParams

Optional parameters.

BackupsLongTermRetentionListByServerOptionalParams

Optional parameters.

BackupsLongTermRetentionOperation

Response for the LTR backup Operation API call

BackupsLongTermRetentionRequest

The request that is made for a long term retention backup.

BackupsLongTermRetentionResponse

Response for the LTR backup API call

BackupsLongTermRetentionStartExceptionHeaders

Defines headers for BackupsLongTermRetention_start operation.

BackupsLongTermRetentionStartHeaders

Defines headers for BackupsLongTermRetention_start operation.

BackupsLongTermRetentionStartOptionalParams

Optional parameters.

CapabilitiesByLocation

Interface representing a CapabilitiesByLocation.

CapabilitiesByLocationListNextOptionalParams

Optional parameters.

CapabilitiesByLocationListOptionalParams

Optional parameters.

CapabilitiesByServer

Interface representing a CapabilitiesByServer.

CapabilitiesByServerListNextOptionalParams

Optional parameters.

CapabilitiesByServerListOptionalParams

Optional parameters.

Capability

Capability for the Azure Database for PostgreSQL flexible server.

CapabilityBase

Base object for representing capability

CapabilityList

List of capabilities for the Azure Database for PostgreSQL flexible server.

CapturedLog

Log file.

CapturedLogList

List of log files.

CapturedLogs

Interface representing a CapturedLogs.

CapturedLogsListByServerNextOptionalParams

Optional parameters.

CapturedLogsListByServerOptionalParams

Optional parameters.

CheckNameAvailabilityRequest

The check availability request body.

CheckNameAvailabilityResponse

The check availability result.

Cluster

Cluster properties of a server.

Configuration

Configuration (also known as server parameter).

ConfigurationForUpdate

Configuration (also known as server parameter).

ConfigurationList

List of configurations (also known as server parameters).

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.

DatabaseList

List of all databases in a server.

DatabaseMigrationState

Migration state of a database.

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.

DbLevelValidationStatus

Validation status summary for a database.

DbServerMetadata

Database server metadata.

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

Capability of a fast provisioning compute tier.

FirewallRule

Firewall rule.

FirewallRuleList

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.

HighAvailability

High availability properties of a server.

HighAvailabilityForPatch

High availability properties of a server.

ImpactRecord

Impact on some metric if this recommended action is applied.

LtrPreBackupRequest

A request that is made for pre-backup.

LtrPreBackupResponse

Response for the LTR pre-backup API call

LtrServerBackupOperationList

A list of long term retention backup operations for server.

MaintenanceWindow

Maintenance window properties of a server.

MaintenanceWindowForPatch

Maintenance window properties of a server.

Migration

Properties of a migration.

MigrationList

List of migrations.

MigrationNameAvailability

Availability of a migration name.

MigrationResourceForPatch

Migration.

MigrationSecretParameters

Migration secret parameters.

MigrationSecretParametersForPatch

Migration secret parameters.

MigrationStatus

State of migration.

MigrationSubstateDetails

Details of migration substate.

Migrations

Interface representing a Migrations.

MigrationsCancelOptionalParams

Optional parameters.

MigrationsCheckNameAvailabilityOptionalParams

Optional parameters.

MigrationsCreateOptionalParams

Optional parameters.

MigrationsGetOptionalParams

Optional parameters.

MigrationsListByTargetServerNextOptionalParams

Optional parameters.

MigrationsListByTargetServerOptionalParams

Optional parameters.

MigrationsUpdateOptionalParams

Optional parameters.

NameAvailability

Interface representing a NameAvailability.

NameAvailabilityCheckGloballyOptionalParams

Optional parameters.

NameAvailabilityCheckWithLocationOptionalParams

Optional parameters.

NameAvailabilityModel

Availability of a name.

NameProperty

Name property for quota usage

Network

Network properties of a server.

ObjectRecommendation

Object recommendation properties.

ObjectRecommendationDetails

Recommendation details for the recommended action.

ObjectRecommendationList

List of available object recommendations.

ObjectRecommendationPropertiesAnalyzedWorkload

Workload information for the recommended action.

ObjectRecommendationPropertiesImplementationDetails

Implementation details for the recommended action.

Operation

REST API operation definition.

OperationDisplay

Display metadata associated with the operation.

OperationList

List of resource provider operations.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PostgreSQLManagementFlexibleServerClientOptionalParams

Optional parameters.

PrivateDnsZoneSuffix

Interface representing a PrivateDnsZoneSuffix.

PrivateDnsZoneSuffixGetOptionalParams

Optional parameters.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The private endpoint connection resource.

PrivateEndpointConnectionList

List of private endpoint connections.

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByServerNextOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByServerOptionalParams

Optional parameters.

PrivateEndpointConnectionsUpdateHeaders

Defines headers for PrivateEndpointConnections_update operation.

PrivateEndpointConnectionsUpdateOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource.

PrivateLinkResourceList

A list of private link resources

PrivateLinkResources

Interface representing a PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByServerNextOptionalParams

Optional parameters.

PrivateLinkResourcesListByServerOptionalParams

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

QuotaUsage

Quota usage for servers

QuotaUsageList

Capability for the PostgreSQL server

QuotaUsages

Interface representing a QuotaUsages.

QuotaUsagesListNextOptionalParams

Optional parameters.

QuotaUsagesListOptionalParams

Optional parameters.

Replica

Replica properties of a server.

Replicas

Interface representing a Replicas.

ReplicasListByServerOptionalParams

Optional parameters.

Resource

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

RestartParameter

PostgreSQL database engine restart parameters.

Server

Properties of a server.

ServerEditionCapability

Capabilities in terms of compute tier.

ServerForPatch

Represents a server to be updated.

ServerList

A list of servers.

ServerSku

Compute information of a server.

ServerSkuCapability

Capabilities in terms of compute.

ServerThreatProtectionSettings

Interface representing a ServerThreatProtectionSettings.

ServerThreatProtectionSettingsCreateOrUpdateHeaders

Defines headers for ServerThreatProtectionSettings_createOrUpdate operation.

ServerThreatProtectionSettingsCreateOrUpdateOptionalParams

Optional parameters.

ServerVersionCapability

Capabilities in terms of major versions of PostgreSQL database engine.

Servers

Interface representing a Servers.

ServersCreateOrUpdateHeaders

Defines headers for Servers_createOrUpdate operation.

ServersCreateOrUpdateOptionalParams

Optional parameters.

ServersDeleteHeaders

Defines headers for Servers_delete operation.

ServersDeleteOptionalParams

Optional parameters.

ServersGetOptionalParams

Optional parameters.

ServersListByResourceGroupNextOptionalParams

Optional parameters.

ServersListByResourceGroupOptionalParams

Optional parameters.

ServersListBySubscriptionNextOptionalParams

Optional parameters.

ServersListBySubscriptionOptionalParams

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

Compute information of a server.

SkuForPatch

Compute information of a server.

Storage

Storage properties of a server.

StorageEditionCapability

Capabilities in terms of storage tier.

StorageMbCapability

Storage size (in MB) capability.

StorageTierCapability

Capability of a storage tier.

SupportedFeature

Features supported.

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'

TuningOptions

Impact on some metric if this recommended action is applied.

TuningOptionsGetOptionalParams

Optional parameters.

TuningOptionsList

List of server tuning options.

TuningOptionsListByServerNextOptionalParams

Optional parameters.

TuningOptionsListByServerOptionalParams

Optional parameters.

TuningOptionsListRecommendationsNextOptionalParams

Optional parameters.

TuningOptionsListRecommendationsOptionalParams

Optional parameters.

TuningOptionsOperations

Interface representing a TuningOptionsOperations.

UserAssignedIdentity

Identities associated with a server.

UserIdentity

User assigned managed identity associated with a server.

ValidationDetails

Details for the validation for migration.

ValidationMessage

Validation message object.

ValidationSummaryItem

Validation summary object.

VirtualEndpoint

Pair of virtual endpoints for a server.

VirtualEndpointResourceForPatch

Pair of virtual endpoints for a server.

VirtualEndpoints

Interface representing a VirtualEndpoints.

VirtualEndpointsCreateHeaders

Defines headers for VirtualEndpoints_create operation.

VirtualEndpointsCreateOptionalParams

Optional parameters.

VirtualEndpointsDeleteHeaders

Defines headers for VirtualEndpoints_delete operation.

VirtualEndpointsDeleteOptionalParams

Optional parameters.

VirtualEndpointsGetOptionalParams

Optional parameters.

VirtualEndpointsList

List of virtual endpoints.

VirtualEndpointsListByServerNextOptionalParams

Optional parameters.

VirtualEndpointsListByServerOptionalParams

Optional parameters.

VirtualEndpointsUpdateHeaders

Defines headers for VirtualEndpoints_update operation.

VirtualEndpointsUpdateOptionalParams

Optional parameters.

VirtualNetworkSubnetUsage

Interface representing a VirtualNetworkSubnetUsage.

VirtualNetworkSubnetUsageListOptionalParams

Optional parameters.

VirtualNetworkSubnetUsageModel

Virtual network subnet usage data.

VirtualNetworkSubnetUsageParameter

Virtual network subnet usage parameter

Type Aliases

AdministratorsMicrosoftEntraCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AdministratorsMicrosoftEntraDeleteResponse

Contains response data for the delete operation.

AdministratorsMicrosoftEntraGetResponse

Contains response data for the get operation.

AdministratorsMicrosoftEntraListByServerNextResponse

Contains response data for the listByServerNext operation.

AdministratorsMicrosoftEntraListByServerResponse

Contains response data for the listByServer operation.

AdvancedThreatProtectionSettingsGetResponse

Contains response data for the get operation.

AdvancedThreatProtectionSettingsListByServerNextResponse

Contains response data for the listByServerNext operation.

AdvancedThreatProtectionSettingsListByServerResponse

Contains response data for the listByServer operation.

AzureManagedDiskPerformanceTier

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

Known values supported by the service

P1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads.
P2: Slightly higher IOPS for small-scale applications needing consistent low latency.
P3: Balanced performance for basic production workloads with moderate throughput.
P4: Enhanced IOPS for growing apps with predictable performance needs.
P6: Mid-tier SSD for steady workloads requiring reliable throughput and latency.
P10: Popular choice for general-purpose production workloads with scalable performance.
P15: High IOPS tier for demanding apps with frequent read/write operations.
P20: Entry point for high-performance Solid State Disks (SSDs), suitable for small-scale I/O-intensive workloads.
P30: Balanced tier for moderate throughput and latency-sensitive applications.
P40: Enhanced performance for growing production workloads with consistent IOPS demands.
P50: Optimized for enterprise-grade applications needing sustained high throughput.
P60: High-capacity tier for large databases and analytics workloads with elevated IOPS.
P70: Designed for mission-critical systems requiring ultra-low latency and high concurrency.
P80: Top-tier SSD for maximum IOPS and throughput, ideal for the most demanding workloads.

BackupType

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

Known values supported by the service

Full: A full backup taken automatically by the service. These backups are retained for a period of time as defined by the backup retention policy, and they cannot be deleted by the customer.
Customer On-Demand: A full backup triggered by the customer. These backups are retained for a period of time as defined by the backup retention policy, and they can also be deleted by the customer.

BackupsAutomaticAndOnDemandCreateResponse

Contains response data for the create operation.

BackupsAutomaticAndOnDemandDeleteResponse

Contains response data for the delete operation.

BackupsAutomaticAndOnDemandGetResponse

Contains response data for the get operation.

BackupsAutomaticAndOnDemandListByServerNextResponse

Contains response data for the listByServerNext operation.

BackupsAutomaticAndOnDemandListByServerResponse

Contains response data for the listByServer operation.

BackupsLongTermRetentionCheckPrerequisitesResponse

Contains response data for the checkPrerequisites operation.

BackupsLongTermRetentionGetResponse

Contains response data for the get operation.

BackupsLongTermRetentionListByServerNextResponse

Contains response data for the listByServerNext operation.

BackupsLongTermRetentionListByServerResponse

Contains response data for the listByServer operation.

BackupsLongTermRetentionStartResponse

Contains response data for the start operation.

Cancel

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

Known values supported by the service

True: Cancel must be triggered for the entire migration.
False: Cancel must not be triggered for the entire migration.

CapabilitiesByLocationListNextResponse

Contains response data for the listNext operation.

CapabilitiesByLocationListResponse

Contains response data for the list operation.

CapabilitiesByServerListNextResponse

Contains response data for the listNext operation.

CapabilitiesByServerListResponse

Contains response data for the list operation.

CapabilityStatus

Defines values for CapabilityStatus.

CapturedLogsListByServerNextResponse

Contains response data for the listByServerNext operation.

CapturedLogsListByServerResponse

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

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: A boolean value.
Numeric: A numeric value.
Integer: An integer value.
Enumeration: An enumeration value.
String: A string value.
Set: A set of values.

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: If the operation is triggered on a non-existing server, it's equivalent to 'Create'. If the operation is triggered on an existing server, it's equivalent to 'Update'.
Create: Operation creates a new server.
Update: Operation updates an existing server.
PointInTimeRestore: Operation restores an existing backup of an existing server. This operation creates a new server, and then restores on it the backup of an existing server at a specific point in time.
GeoRestore: Operation restores an existing backup of an existing server, on the paired region of the existing server. This operation creates a new server on the paired region of the existing server, and then restores on it the backup of an existing server at a specific point in time, in a different region. This operation is only supported on existing servers that were created with geographically redundant backups enabled.
Replica: Operation creates a replica of an existing server. This operation creates a new server, restores a base backup of the existing server (referred to as primary), and configures physical replication to asynchronously stream all changes which are recorded in the transaction log of the primary.
ReviveDropped: Operation creates a new server, initialized with the backup of a server that was recently deleted.

CreateModeForPatch

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

Known values supported by the service

Default: It's equivalent to 'Update'.
Update: Operation updates an existing server.

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

DataEncryptionType

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

Known values supported by the service

SystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance.
AzureKeyVault: Encryption using customer managed keys stored in Azure Key Vault for enhanced control and security.

DatabasesCreateResponse

Contains response data for the create operation.

DatabasesDeleteResponse

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

EncryptionKeyStatus

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

Known values supported by the service

Valid: Key is valid and can be used for encryption.
Invalid: Key is invalid and cannot be used for encryption. Possible causes include key deletion, permission changes, key being disabled, key type not supported, or current date being outside of validity period associated to the key.

ExecutionStatus

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

Known values supported by the service

Running: The operation is currently running.
Cancelled: The operation was cancelled.
Failed: The operation failed.
Succeeded: The operation succeeded.

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: Triggers a failover from primary to standby without killing the primary database process first. This is a graceful failover that attempts to preserve data consistency.
ForcedFailover: Kills the primary database process first, then triggers the failover. This is more aggressive and used when the primary is unresponsive or in an unhealthy state.
PlannedSwitchover: Similar to 'PlannedFailover' but prefers a switch over operation where roles are swapped between primary and standby.
ForcedSwitchover: Kills the primary database process and then triggers a switch over with role swapping.

FastProvisioningSupport

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

Known values supported by the service

Enabled: Fast provisioning is supported.
Disabled: Fast provisioning is not supported.

FeatureStatus

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

Known values supported by the service

Enabled: Feature is enabled.
Disabled: Feature is disabled.

FirewallRulesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

FirewallRulesDeleteResponse

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

GeographicallyRedundantBackup

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

Known values supported by the service

Enabled: Server is configured to create geographically redundant backups.
Disabled: Server is not configured to create geographically redundant backups.

GeographicallyRedundantBackupSupport

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

Known values supported by the service

Enabled: Geographically redundant backups are supported.
Disabled: Geographically redundant backups are not supported.

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

ZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary.
SameZone: High availability is enabled for the server, with standby server in the same availability zone as the primary.

HighAvailabilityState

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

Known values supported by the service

NotEnabled: High availability is not enabled for the server.
CreatingStandby: Standby server is being created.
ReplicatingData: Data is being replicated to the standby server.
FailingOver: Failover operation to the standby server is in progress.
Healthy: Standby server is healthy and ready to take over in case of a failover.
RemovingStandby: Standby server is being removed.

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: No managed identity is assigned to the server.
UserAssigned: One or more managed identities provided by the user are assigned to the server.
SystemAssigned: Azure automatically creates and manages the identity associated to the lifecycle of the server.
SystemAssigned,UserAssigned: Both system-assigned and user-assigned identities are assigned to the server.

LocationRestricted

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

Known values supported by the service

Enabled: Location is restricted.
Disabled: Location is not restricted.

LogicalReplicationOnSourceServer

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

Known values supported by the service

True: Logical replication will be set up on the source server.
False: Logical replication will not be set up on the source server.

MicrosoftEntraAuth

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

Known values supported by the service

Enabled: Server supports Microsoft Entra authentication.
Disabled: Server doesn't support Microsoft Entra authentication.

MigrateRolesAndPermissions

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

Known values supported by the service

True: Roles and permissions will be migrated.
False: Roles and permissions will not be migrated.

MigrationDatabaseState

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

Known values supported by the service

InProgress: Migration is in progress for the database.
WaitingForCutoverTrigger: Migration is waiting for cutover trigger for the database.
Failed: Migration has failed for the database.
Canceled: Migration has been canceled for the database.
Succeeded: Migration has succeeded for the database.
Canceling: Migration is canceling for the database.

MigrationDetailsLevel

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

Known values supported by the service

Default: Default level of details.
Summary: Summary level of details.
Full: Full level of details.

MigrationListFilter

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

Known values supported by the service

Active: Only active (in-progress) migrations.
All: All migrations.

MigrationMode

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

Known values supported by the service

Offline: Offline migration mode.
Online: Online migration mode.

MigrationNameAvailabilityReason

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

Known values supported by the service

Invalid: Migration name is invalid.
AlreadyExists: Migration name already exists.

MigrationOption

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

Known values supported by the service

Validate: Validate the migration without performing it.
Migrate: Perform the migration.
ValidateAndMigrate: Validate and perform the migration.

MigrationState

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

Known values supported by the service

InProgress: Migration is in progress.
WaitingForUserAction: Migration is waiting for user action.
Canceled: Migration has been canceled.
Failed: Migration has failed.
Succeeded: Migration has succeeded.
ValidationFailed: Validation for migration has failed.
CleaningUp: Migration is cleaning up resources.

MigrationSubstate

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

Known values supported by the service

PerformingPreRequisiteSteps: Performing pre-requisite steps for migration.
WaitingForLogicalReplicationSetupRequestOnSourceDB: Waiting for logical replication setup request on source database.
WaitingForDBsToMigrateSpecification: Waiting for databases to migrate specification.
WaitingForTargetDBOverwriteConfirmation: Waiting for target database overwrite confirmation.
WaitingForDataMigrationScheduling: Waiting for data migration scheduling.
WaitingForDataMigrationWindow: Waiting for data migration window.
MigratingData: Migrating data.
WaitingForCutoverTrigger: Waiting for cutover trigger.
CompletingMigration: Completing migration.
Completed: Migration completed.
CancelingRequestedDBMigrations: Canceling requested database migrations.
ValidationInProgress: Validation in progress.

MigrationsCancelResponse

Contains response data for the cancel operation.

MigrationsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

MigrationsCreateResponse

Contains response data for the create operation.

MigrationsGetResponse

Contains response data for the get operation.

MigrationsListByTargetServerNextResponse

Contains response data for the listByTargetServerNext operation.

MigrationsListByTargetServerResponse

Contains response data for the listByTargetServer operation.

MigrationsUpdateResponse

Contains response data for the update operation.

NameAvailabilityCheckGloballyResponse

Contains response data for the checkGlobally operation.

NameAvailabilityCheckWithLocationResponse

Contains response data for the checkWithLocation operation.

OnlineStorageResizeSupport

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

Known values supported by the service

Enabled: Resizing the storage without interrupting the operation of the database engine is supported.
Disabled: Resizing the storage without interrupting the operation of the database engine is not supported.

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: The origin is not specified.
user: The operation is initiated by a user.
system: The operation is initiated by the system.

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

OverwriteDatabasesOnTargetServer

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

Known values supported by the service

True: Databases on the target server can be overwritten when already present.
False: Databases on the target server cannot be overwritten when already present.

PasswordBasedAuth

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

Known values supported by the service

Enabled: Server supports password based authentication.
Disabled: Server doesn't support password based authentication.

PostgresMajorVersion

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

Known values supported by the service

18: PostgreSQL 18.
17: PostgreSQL 17.
16: PostgreSQL 16.
15: PostgreSQL 15.
14: PostgreSQL 14.
13: PostgreSQL 13.
12: PostgreSQL 12.
11: PostgreSQL 11.

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: The principal type is not known or not specified.
User: A Microsoft Entra user.
Group: A Microsoft Entra group.
ServicePrincipal: A Microsoft Entra service principal, typically representing an application or service identity

PrivateDnsZoneSuffixGetResponse

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

PrivateEndpointConnectionsDeleteResponse

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

PrivateEndpointConnectionsUpdateResponse

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

PrivateLinkResourcesListByServerNextResponse

Contains response data for the listByServerNext operation.

PrivateLinkResourcesListByServerResponse

Contains response data for the listByServer operation.

QuotaUsagesListNextResponse

Contains response data for the listNext operation.

QuotaUsagesListResponse

Contains response data for the list operation.

ReadReplicaPromoteMode

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

Known values supported by the service

Standalone: Read replica will become an independent server.
Switchover: Read replica will swap roles with primary server.

ReadReplicaPromoteOption

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

Known values supported by the service

Planned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation.
Forced: The operation will not wait for data in the read replica to be synchronized with its source server, before it initiates the operation.

RecommendationTypeEnum

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

Known values supported by the service

CreateIndex
DropIndex
ReIndex
AnalyzeTable

RecommendationTypeParameterEnum

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

Known values supported by the service

CreateIndex
DropIndex
ReIndex
AnalyzeTable

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: No replication role assigned; the server operates independently.
Primary: Acts as the source server for replication to one or more replicas.
AsyncReplica: Receives data asynchronously from a primary server within the same region.
GeoAsyncReplica: Receives data asynchronously from a primary server in a different region for geographical redundancy.

ReplicationState

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

Known values supported by the service

Active: Read replica is fully synchronized and actively replicating data from the primary server.
Catchup: Read replica is behind the primary server and is currently catching up with pending changes.
Provisioning: Read replica is being created and is in process of getting initialized.
Updating: Read replica is undergoing some changes it can be changing compute size of promoting it to primary server.
Broken: Replication has failed or been interrupted.
Reconfiguring: Read replica is being reconfigured, possibly due to changes in source or settings.

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: Public network access is enabled. This allows the server to be accessed from the public internet, provided the necessary firewall rule that allows incoming traffic originating from the connecting client is in place. This is compatible with the use of private endpoints to connect to this server.
Disabled: Public network access is disabled. This means the server cannot be accessed from the public internet, but only via private endpoints.

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: Server is healthy and not undergoing any operations at the management or control plane level. This doesn't mean that the server is fully operational at the data plane level.
Dropping: Server is being deleted.
Disabled: Server is disabled. Typical reasons include: the subscription on which the server is deployed is explicitly disabled or canceled by the administrator, the spending limit has been reached, or the bill is past due. May also happen when the server is being moved to another resource group or subscription.
Starting: PostgreSQL database engine is being restarted.
Stopping: Compute resources associated with the server are being stopped and deallocated. If the server has high availability enabled, the compute resources of the standby server are also stopped and deallocated.
Stopped: Compute resources associated with the server are being stopped and deallocated.
Updating: Server is undergoing some changes which may or may not impact the availability of the PostgreSQL database engine. For example, the compute resources of the server are being scaled up or down, which may cause temporary unavailability of the database engine. Or, for example, a firewall rule is being added or removed, which doesn't cause any unavailability of the database engine.
Restarting: PostgreSQL database engine is being restarted.
Inaccessible: Server isn't accessible, because the key provided to encrypt and decrypt the data is in invalid state.
Provisioning: Server is in the process of being created.

ServerThreatProtectionSettingsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ServersCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ServersDeleteResponse

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

ServersListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ServersListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ServersRestartResponse

Contains response data for the restart operation.

ServersStartResponse

Contains response data for the start operation.

ServersStopResponse

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

SourceType

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

Known values supported by the service

OnPremises: On-premises PostgreSQL server.
AWS: Amazon Web Services PostgreSQL server.
GCP: Google Cloud Platform PostgreSQL server.
AzureVM: Azure Virtual Machine PostgreSQL server.
PostgreSQLSingleServer: Azure Database for PostgreSQL single server.
AWS_RDS: Amazon RDS for PostgreSQL.
AWS_AURORA: Amazon Aurora for PostgreSQL.
AWS_EC2: Amazon EC2 for PostgreSQL.
GCP_CloudSQL: Google Cloud SQL for PostgreSQL.
GCP_AlloyDB: Google Cloud AlloyDB for PostgreSQL.
GCP_Compute: Google Compute Engine for PostgreSQL.
EDB: EnterpriseDB PostgreSQL server.
EDB_Oracle_Server: EnterpriseDB Oracle Server.
EDB_PostgreSQL: EnterpriseDB PostgreSQL server.
PostgreSQLFlexibleServer: Azure Database for PostgreSQL flexible server.
PostgreSQLCosmosDB: .NET Cosmos DB for PostgreSQL
Huawei_RDS: Huawei RDS for PostgreSQL
Huawei_Compute: Huawei Compute for PostgreSQL
Heroku_PostgreSQL: Heroku PostgreSQL
Crunchy_PostgreSQL: Crunchy PostgreSQL
ApsaraDB_RDS: ApsaraDB RDS for PostgreSQL
Digital_Ocean_Droplets: Digital Ocean Droplets for PostgreSQL
Digital_Ocean_PostgreSQL: Digital Ocean PostgreSQL
Supabase_PostgreSQL: Supabase PostgreSQL

SslMode

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

Known values supported by the service

Prefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL.
Require: Require SSL connection. If the server does not support SSL, the connection will fail.
VerifyCA: Require SSL connection and verify the server certificate against the CA certificate.
VerifyFull: Require SSL connection, verify the server certificate against the CA certificate, and verify that the server hostname matches the certificate.

StartDataMigration

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

Known values supported by the service

True: Data migration must start right away.
False: Data migration must not start right away.

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: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size.
Disabled: Server should not automatically grow storage size when available space is nearing zero.

StorageAutoGrowthSupport

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

Known values supported by the service

Enabled: Storage autogrow is supported.
Disabled: Storage autogrow is not supported.

StorageType

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

Known values supported by the service

Premium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads.
PremiumV2_LRS: Next generation Solid State Disk (SSD) storage with improved scalability and performance for demanding enterprise workloads.
UltraSSD_LRS: High-end Solid State Disk (SSD) storage designed for extreme IOPS and latency-sensitive applications.

ThreatProtectionName

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

Known values supported by the service

Default: Default advanced threat protection settings.

ThreatProtectionState

Defines values for ThreatProtectionState.

TriggerCutover

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

Known values supported by the service

True: Cutover must be triggered for the entire migration.
False: Cutover must not be triggered for the entire migration.

TuningOptionParameterEnum

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

Known values supported by the service

index
table

TuningOptionsGetResponse

Contains response data for the get operation.

TuningOptionsListByServerNextResponse

Contains response data for the listByServerNext operation.

TuningOptionsListByServerResponse

Contains response data for the listByServer operation.

TuningOptionsListRecommendationsNextResponse

Contains response data for the listRecommendationsNext operation.

TuningOptionsListRecommendationsResponse

Contains response data for the listRecommendations operation.

ValidationState

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

Known values supported by the service

Failed: Validation has failed.
Succeeded: Validation has succeeded.
Warning: Validation has succeeded with warnings.

VirtualEndpointType

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

Known values supported by the service

ReadWrite: Read-write endpoint.

VirtualEndpointsCreateResponse

Contains response data for the create operation.

VirtualEndpointsDeleteResponse

Contains response data for the delete operation.

VirtualEndpointsGetResponse

Contains response data for the get operation.

VirtualEndpointsListByServerNextResponse

Contains response data for the listByServerNext operation.

VirtualEndpointsListByServerResponse

Contains response data for the listByServer operation.

VirtualEndpointsUpdateResponse

Contains response data for the update operation.

VirtualNetworkSubnetUsageListResponse

Contains response data for the list operation.

ZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport

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

Known values supported by the service

Enabled: High availability with zone redundancy is supported in conjunction with geographically redundant backups.
Disabled: High availability with zone redundancy is not supported in conjunction with geographically redundant backups.

ZoneRedundantHighAvailabilitySupport

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

Known values supported by the service

Enabled: High availability with zone redundancy is supported.
Disabled: High availability with zone redundancy is not supported.

Enums

KnownAzureManagedDiskPerformanceTier

Known values of AzureManagedDiskPerformanceTier that the service accepts.

KnownBackupType

Known values of BackupType that the service accepts.

KnownCancel

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

KnownCreateModeForPatch

Known values of CreateModeForPatch that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownDataEncryptionType

Known values of DataEncryptionType that the service accepts.

KnownEncryptionKeyStatus

Known values of EncryptionKeyStatus that the service accepts.

KnownExecutionStatus

Known values of ExecutionStatus that the service accepts.

KnownFailoverMode

Known values of FailoverMode that the service accepts.

KnownFastProvisioningSupport

Known values of FastProvisioningSupport that the service accepts.

KnownFeatureStatus

Known values of FeatureStatus that the service accepts.

KnownGeographicallyRedundantBackup

Known values of GeographicallyRedundantBackup that the service accepts.

KnownGeographicallyRedundantBackupSupport

Known values of GeographicallyRedundantBackupSupport that the service accepts.

KnownHighAvailabilityMode

Known values of HighAvailabilityMode that the service accepts.

KnownHighAvailabilityState

Known values of HighAvailabilityState that the service accepts.

KnownIdentityType

Known values of IdentityType that the service accepts.

KnownLocationRestricted

Known values of LocationRestricted that the service accepts.

KnownLogicalReplicationOnSourceServer

Known values of LogicalReplicationOnSourceServer that the service accepts.

KnownMicrosoftEntraAuth

Known values of MicrosoftEntraAuth that the service accepts.

KnownMigrateRolesAndPermissions

Known values of MigrateRolesAndPermissions that the service accepts.

KnownMigrationDatabaseState

Known values of MigrationDatabaseState that the service accepts.

KnownMigrationDetailsLevel

Known values of MigrationDetailsLevel that the service accepts.

KnownMigrationListFilter

Known values of MigrationListFilter that the service accepts.

KnownMigrationMode

Known values of MigrationMode that the service accepts.

KnownMigrationNameAvailabilityReason

Known values of MigrationNameAvailabilityReason that the service accepts.

KnownMigrationOption

Known values of MigrationOption that the service accepts.

KnownMigrationState

Known values of MigrationState that the service accepts.

KnownMigrationSubstate

Known values of MigrationSubstate that the service accepts.

KnownOnlineStorageResizeSupport

Known values of OnlineStorageResizeSupport that the service accepts.

KnownOperationOrigin

Known values of OperationOrigin that the service accepts.

KnownOverwriteDatabasesOnTargetServer

Known values of OverwriteDatabasesOnTargetServer that the service accepts.

KnownPasswordBasedAuth

Known values of PasswordBasedAuth that the service accepts.

KnownPostgresMajorVersion

Known values of PostgresMajorVersion that the service accepts.

KnownPrincipalType

Known values of PrincipalType that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownReadReplicaPromoteMode

Known values of ReadReplicaPromoteMode that the service accepts.

KnownReadReplicaPromoteOption

Known values of ReadReplicaPromoteOption that the service accepts.

KnownRecommendationTypeEnum

Known values of RecommendationTypeEnum that the service accepts.

KnownRecommendationTypeParameterEnum

Known values of RecommendationTypeParameterEnum that the service accepts.

KnownReplicationRole

Known values of ReplicationRole that the service accepts.

KnownReplicationState

Known values of ReplicationState that the service accepts.

KnownServerPublicNetworkAccessState

Known values of ServerPublicNetworkAccessState that the service accepts.

KnownServerState

Known values of ServerState that the service accepts.

KnownSkuTier

Known values of SkuTier that the service accepts.

KnownSourceType

Known values of SourceType that the service accepts.

KnownSslMode

Known values of SslMode that the service accepts.

KnownStartDataMigration

Known values of StartDataMigration that the service accepts.

KnownStorageAutoGrow

Known values of StorageAutoGrow that the service accepts.

KnownStorageAutoGrowthSupport

Known values of StorageAutoGrowthSupport that the service accepts.

KnownStorageType

Known values of StorageType that the service accepts.

KnownThreatProtectionName

Known values of ThreatProtectionName that the service accepts.

KnownTriggerCutover

Known values of TriggerCutover that the service accepts.

KnownTuningOptionParameterEnum

Known values of TuningOptionParameterEnum that the service accepts.

KnownValidationState

Known values of ValidationState that the service accepts.

KnownVirtualEndpointType

Known values of VirtualEndpointType that the service accepts.

KnownZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport

Known values of ZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport that the service accepts.

KnownZoneRedundantHighAvailabilitySupport

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