@azure/arm-postgresql-flexible package

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.

AdministratorMicrosoftEntraProperties

Properties of a server administrator associated to a Microsoft Entra principal.

AdministratorMicrosoftEntraPropertiesForAdd

Properties of a server administrator associated to a Microsoft Entra principal.

AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraDeleteOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraGetOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraListByServerOptionalParams

Optional parameters.

AdministratorsMicrosoftEntraOperations

Interface representing a AdministratorsMicrosoftEntra operations.

AdvancedThreatProtectionSettingsGetOptionalParams

Optional parameters.

AdvancedThreatProtectionSettingsListByServerOptionalParams

Optional parameters.

AdvancedThreatProtectionSettingsModel

Advanced threat protection settings of the server.

AdvancedThreatProtectionSettingsOperations

Interface representing a AdvancedThreatProtectionSettings operations.

AdvancedThreatProtectionSettingsProperties

Properties of advanced threat protection state for a 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.

BackupAutomaticAndOnDemandProperties

Properties of a backup.

BackupForPatch

Backup properties of a server.

BackupRequestBase

BackupRequestBase is the base for all backup request.

BackupSettings

Settings for the long term backup.

BackupStoreDetails

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

BackupsAutomaticAndOnDemandCreateOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandDeleteOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandGetOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandListByServerOptionalParams

Optional parameters.

BackupsAutomaticAndOnDemandOperations

Interface representing a BackupsAutomaticAndOnDemand operations.

BackupsLongTermRetentionCheckPrerequisitesOptionalParams

Optional parameters.

BackupsLongTermRetentionGetOptionalParams

Optional parameters.

BackupsLongTermRetentionListByServerOptionalParams

Optional parameters.

BackupsLongTermRetentionOperation

Response for the LTR backup Operation API call

BackupsLongTermRetentionOperations

Interface representing a BackupsLongTermRetention operations.

BackupsLongTermRetentionRequest

Request made for a long term retention backup.

BackupsLongTermRetentionResponse

Response for the LTR backup API call

BackupsLongTermRetentionResponseProperties

Response for the pre-backup request.

BackupsLongTermRetentionStartOptionalParams

Optional parameters.

CapabilitiesByLocationListOptionalParams

Optional parameters.

CapabilitiesByLocationOperations

Interface representing a CapabilitiesByLocation operations.

CapabilitiesByServerListOptionalParams

Optional parameters.

CapabilitiesByServerOperations

Interface representing a CapabilitiesByServer operations.

Capability

Capability for the Azure Database for PostgreSQL flexible server.

CapabilityBase

Base object for representing capability

CapturedLog

Log file.

CapturedLogProperties

Properties of a log file.

CapturedLogsListByServerOptionalParams

Optional parameters.

CapturedLogsOperations

Interface representing a CapturedLogs operations.

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

ConfigurationProperties

Properties of a configuration (also known as server parameter).

ConfigurationsGetOptionalParams

Optional parameters.

ConfigurationsListByServerOptionalParams

Optional parameters.

ConfigurationsOperations

Interface representing a Configurations operations.

ConfigurationsPutOptionalParams

Optional parameters.

ConfigurationsUpdateOptionalParams

Optional parameters.

DataEncryption

Data encryption properties of a server.

Database

Represents a database.

DatabaseMigrationState

Migration state of a database.

DatabaseProperties

Properties of a database.

DatabasesCreateOptionalParams

Optional parameters.

DatabasesDeleteOptionalParams

Optional parameters.

DatabasesGetOptionalParams

Optional parameters.

DatabasesListByServerOptionalParams

Optional parameters.

DatabasesOperations

Interface representing a Databases operations.

DbAgent

The database agent configuration for a PostgreSQL flexible server.

DbAgentForUpdate

A request to enable or disable the database agent.

DbAgentForUpdateProperties

Writable properties of the database agent configuration.

DbAgentProperties

Properties of the database agent configuration.

DbAgentsCreateOrUpdateOptionalParams

Optional parameters.

DbAgentsGetOptionalParams

Optional parameters.

DbAgentsListOptionalParams

Optional parameters.

DbAgentsOperations

Interface representing a DbAgents operations.

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.

FastProvisioningEditionCapability

Capability of a fast provisioning compute tier.

FirewallRule

Firewall rule.

FirewallRuleProperties

Properties of a firewall rule.

FirewallRulesCreateOrUpdateOptionalParams

Optional parameters.

FirewallRulesDeleteOptionalParams

Optional parameters.

FirewallRulesGetOptionalParams

Optional parameters.

FirewallRulesListByServerOptionalParams

Optional parameters.

FirewallRulesOperations

Interface representing a FirewallRules operations.

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.

LogSpecification

Log specification for an operation.

LtrBackupOperationResponseProperties

Response for the backup request.

LtrPreBackupRequest

A request that is made for pre-backup.

LtrPreBackupResponse

Response for the LTR pre-backup API call.

MaintenanceEventActionResponse

Response model for maintenance event reschedule and apply-now actions.

MaintenanceEventRescheduleRequest

Parameters to reschedule a maintenance event.

MaintenanceEventResource

Maintenance event resource for a PostgreSQL flexible server.

MaintenanceEventResourceProperties

Properties of a maintenance event resource.

MaintenanceEventsApplyNowOptionalParams

Optional parameters.

MaintenanceEventsGetOptionalParams

Optional parameters.

MaintenanceEventsListOptionalParams

Optional parameters.

MaintenanceEventsOperations

Interface representing a MaintenanceEvents operations.

MaintenanceEventsRescheduleOptionalParams

Optional parameters.

MaintenanceWindow

Maintenance window properties of a server.

MaintenanceWindowForPatch

Maintenance window properties of a server.

MajorVersionUpgradePrecheckGetOptionalParams

Optional parameters.

MajorVersionUpgradePrecheckListOptionalParams

Optional parameters.

MajorVersionUpgradePrecheckOperations

Interface representing a MajorVersionUpgradePrecheck operations.

MajorVersionUpgradePrecheckResource

Major version upgrade precheck resource for a PostgreSQL flexible server.

MajorVersionUpgradePrecheckResourceProperties

Major version upgrade precheck resource with validation results.

MetricSpecification

Metric specification for an operation.

MigrateNetworkStatus

Status of a network migration operation.

Migration

Properties of a migration.

MigrationNameAvailability

Availability of a migration name.

MigrationProperties

Migration.

MigrationPropertiesForPatch

Migration properties.

MigrationResourceForPatch

Migration.

MigrationSecretParameters

Migration secret parameters.

MigrationSecretParametersForPatch

Migration secret parameters.

MigrationStatus

State of migration.

MigrationSubstateDetails

Details of migration substate.

MigrationsCancelOptionalParams

Optional parameters.

MigrationsCheckNameAvailabilityOptionalParams

Optional parameters.

MigrationsCreateOptionalParams

Optional parameters.

MigrationsGetOptionalParams

Optional parameters.

MigrationsListByTargetServerOptionalParams

Optional parameters.

MigrationsOperations

Interface representing a Migrations operations.

MigrationsUpdateOptionalParams

Optional parameters.

NameAvailabilityCheckGloballyOptionalParams

Optional parameters.

NameAvailabilityCheckWithLocationOptionalParams

Optional parameters.

NameAvailabilityModel

Availability of a name.

NameAvailabilityOperations

Interface representing a NameAvailability operations.

NameProperty

Name property for quota usage

Network

Network properties of a server.

ObjectRecommendation

Object recommendation properties.

ObjectRecommendationDetails

Recommendation details for the recommended action.

ObjectRecommendationProperties

Object recommendation properties.

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.

OperationProperties

Additional properties for operation metadata.

OperationsListOptionalParams

Optional parameters.

OperationsOperations

Interface representing a Operations operations.

PageSettings

Options for the byPage method

PagedAsyncIterableIterator

An interface that allows async iterable iteration both to completion and by page.

PolicyDetail

Policy validation details.

PostgreSQLManagementFlexibleServerClientOptionalParams

Optional parameters for the client.

PrecheckErrorInfo

Error information from precheck validation.

PrecheckResult

Precheck result details.

PrivateDnsZoneSuffixGetOptionalParams

Optional parameters.

PrivateDnsZoneSuffixOperations

Interface representing a PrivateDnsZoneSuffix operations.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The private endpoint connection resource.

PrivateEndpointConnectionProperties

Properties of the private endpoint connection.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListByServerOptionalParams

Optional parameters.

PrivateEndpointConnectionsOperations

Interface representing a PrivateEndpointConnections operations.

PrivateEndpointConnectionsUpdateOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource.

PrivateLinkResourceProperties

Properties of a private link resource.

PrivateLinkResourcesGetOptionalParams

Optional parameters.

PrivateLinkResourcesListByServerOptionalParams

Optional parameters.

PrivateLinkResourcesOperations

Interface representing a PrivateLinkResources operations.

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

QuotaUsagesListOptionalParams

Optional parameters.

QuotaUsagesOperations

Interface representing a QuotaUsages operations.

Replica

Replica properties of a server.

ReplicasListByServerOptionalParams

Optional parameters.

ReplicasOperations

Interface representing a Replicas operations.

Resource

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

RestartParameter

PostgreSQL database engine restart parameters.

RestorePollerOptions
Server

Properties of a server.

ServerEditionCapability

Capabilities in terms of compute tier.

ServerForPatch

Represents a server to be updated.

ServerProperties

Properties of a server.

ServerPropertiesForPatch

Properties of a server.

ServerSku

Compute information of a server.

ServerSkuCapability

Capabilities in terms of compute.

ServerThreatProtectionSettingsCreateOrUpdateOptionalParams

Optional parameters.

ServerThreatProtectionSettingsOperations

Interface representing a ServerThreatProtectionSettings operations.

ServerVersionCapability

Capabilities in terms of major versions of PostgreSQL database engine.

ServersCreateOrUpdateOptionalParams

Optional parameters.

ServersDeleteOptionalParams

Optional parameters.

ServersGetOptionalParams

Optional parameters.

ServersListByResourceGroupOptionalParams

Optional parameters.

ServersListBySubscriptionOptionalParams

Optional parameters.

ServersMigrateNetworkModeOptionalParams

Optional parameters.

ServersOperations

Interface representing a Servers operations.

ServersRestartOptionalParams

Optional parameters.

ServersStartMajorVersionUpgradePrecheckOptionalParams

Optional parameters.

ServersStartOptionalParams

Optional parameters.

ServersStopOptionalParams

Optional parameters.

ServersUpdateOptionalParams

Optional parameters.

ServiceSpecification

Service specification for an operation.

SimplePollerLike

A simple poller that can be used to poll a long running operation.

Sku

Compute information of a server.

SkuForPatch

Compute information of a server.

StartMajorVersionUpgradePrecheckRequest

Request model for starting a major version upgrade precheck.

StartMajorVersionUpgradePrecheckResponse

Response model for starting a major version upgrade precheck.

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.

TuningOptionsOperationsGetOptionalParams

Optional parameters.

TuningOptionsOperationsListByServerOptionalParams

Optional parameters.

TuningOptionsOperationsListRecommendationsOptionalParams

Optional parameters.

TuningOptionsOperationsOperations

Interface representing a TuningOptionsOperations operations.

TuningOptionsProperties

Properties of a tuning option.

UpgradeSequence

Upgrade sequence information.

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.

VirtualEndpointResourceProperties

Properties of a pair of virtual endpoints.

VirtualEndpointsCreateOptionalParams

Optional parameters.

VirtualEndpointsDeleteOptionalParams

Optional parameters.

VirtualEndpointsGetOptionalParams

Optional parameters.

VirtualEndpointsListByServerOptionalParams

Optional parameters.

VirtualEndpointsOperations

Interface representing a VirtualEndpoints operations.

VirtualEndpointsUpdateOptionalParams

Optional parameters.

VirtualNetworkSubnetUsageListOptionalParams

Optional parameters.

VirtualNetworkSubnetUsageModel

Virtual network subnet usage data.

VirtualNetworkSubnetUsageOperations

Interface representing a VirtualNetworkSubnetUsage operations.

VirtualNetworkSubnetUsageParameter

Virtual network subnet usage parameter

Type Aliases

AzureManagedDiskPerformanceTier

Storage tier of a server.
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.

AzureSupportedClouds

The supported values for cloud setting as a string literal type

BackupType

Type of backup.
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.

Cancel

Indicates if cancel must be triggered for the entire migration.
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.

CapabilityStatus

Status of the capability.

CheckNameAvailabilityReason

Possible reasons for a name not being available.
KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports.

Known values supported by the service

Invalid: Name is invalid.
AlreadyExists: Name already exists.

ConfigurationDataType

Data type of the configuration (also known as server parameter).
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.

ContinuablePage

An interface that describes a page of results.

CreateMode

Creation mode of a new server.
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

Update mode of an existing server.
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

The kind of entity that created the resource.
KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports.

Known values supported by the service

User: The entity was created by a user.
Application: The entity was created by an application.
ManagedIdentity: The entity was created by a managed identity.
Key: The entity was created by a key.

DataEncryptionType

Data encryption type used by a server.
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.

DbAgentForUpdateState

The database agent states accepted in a write request.

DbAgentProvisioningState

The provisioning state of the database agent resource.
KnownDbAgentProvisioningState can be used interchangeably with DbAgentProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
InProgress: The database agent lifecycle operation is in progress.

DbAgentState

The state of the database agent.
KnownDbAgentState can be used interchangeably with DbAgentState, this enum contains the known values that the service supports.

Known values supported by the service

Enabling: The database agent is being enabled.
Enabled: The database agent is enabled.
Disabling: The database agent is being disabled.
Disabled: The database agent is disabled.
Failed: The database agent lifecycle operation failed.

EncryptionKeyStatus

Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.
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

Service-set extensible enumeration indicating the status of operation.
KnownExecutionStatus can be used interchangeably with ExecutionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Running: Operation is currently running.
Cancelled: Operation has been cancelled.
Failed: Operation has failed.
Succeeded: Operation has succeeded.

FailoverMode

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

Known values supported by the service

PlannedFailover: Trigger 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: Terminate 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: Terminate the primary database process first, and then triggers a switch over with role swapping.

FastProvisioningSupport

Indicates if fast provisioning is supported. 'Enabled' means fast provisioning is supported. 'Disabled' stands for fast provisioning is not supported. Will be deprecated in the future. Look to Supported Features for 'FastProvisioning'.
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

Status of the feature. Indicates if the feature is enabled or not.
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.

FipsMode

Indicates if FIPS (Federal Information Processing Standards) mode is enabled on the server.
KnownFipsMode can be used interchangeably with FipsMode, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: FIPS mode is enabled on the server.
Disabled: FIPS mode is disabled on the server.

GeographicallyRedundantBackup

Indicates if the server is configured to create geographically redundant backups.
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

Indicates if geographically redundant backups are supported in this location. Will be deprecated in the future. Look to Supported Features for 'GeoBackup'.
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 in this location.
Disabled: Geographically redundant backups are not supported in this location.

HighAvailabilityMode

Mode of high availability supported for this compute.
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 supported for this compute, with standby server in a different availability zone than that of the primary.
SameZone: High availability is supported for this compute, with standby server in the same availability zone as the primary.

HighAvailabilityState

Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.
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.
RecreatingStandby: Standby server is being recreated.
ComputeUpdatingByFailover: Compute is being updated due to a failover.

IdentityType

Types of identities associated with a server.
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.

ImmutableBackup

Indicates if the server is configured to create immutable backups.
KnownImmutableBackup can be used interchangeably with ImmutableBackup, this enum contains the known values that the service supports.

Known values supported by the service

Enabled: Server is configured to create immutable backups.
Disabled: Server is not configured to create immutable backups.

LocationRestricted

Indicates if this location is restricted. Will be deprecated in the future. Look to Supported Features for 'Restricted'.
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

Indicates whether to setup logical replication on source server, if needed.
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.

MaintenanceEventStatus

The status of a maintenance event.
KnownMaintenanceEventStatus can be used interchangeably with MaintenanceEventStatus, this enum contains the known values that the service supports.

Known values supported by the service

Planned: The maintenance event is scheduled and has not yet started.
InProgress: The maintenance event is currently in progress.
Complete: The maintenance event has completed successfully.
Rescheduled: The maintenance event has been rescheduled (postponed) by the customer.
Canceled: The maintenance event was canceled, failed, or timed out.

MaintenanceEventStatusFilter

Filter for maintenance event status.
KnownMaintenanceEventStatusFilter can be used interchangeably with MaintenanceEventStatusFilter, this enum contains the known values that the service supports.

Known values supported by the service

Upcoming: Return events that have a scheduled or in progress status.
Past: Return events that have a completed status.

MaintenanceType

Type of a maintenance event resource.
KnownMaintenanceType can be used interchangeably with MaintenanceType, this enum contains the known values that the service supports.

Known values supported by the service

PlannedMaintenance: Planned maintenance event.

MajorVersionUpgradePrecheckStatus

The status of the major version upgrade precheck.
KnownMajorVersionUpgradePrecheckStatus can be used interchangeably with MajorVersionUpgradePrecheckStatus, this enum contains the known values that the service supports.

Known values supported by the service

Validating: Executing prechecks against the source server
Succeeded: Validation succeeded
Failed: Validation failed
Canceled: Validation canceled

MicrosoftEntraAuth

Indicates if the server supports Microsoft Entra authentication.
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 does not support Microsoft Entra authentication.

MigrateRolesAndPermissions

Indicates if roles and permissions must be migrated.
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

Migration state of a database.
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 being canceled for the database.

MigrationListFilter

Indicates the filter to apply when listing migrations.
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

Mode used to perform the migration.
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

Migration name availability reason.
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

Supported option for a migration.
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

State of migration.
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

Substate of migration.
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.

NetworkMigrationState

State of the network migration operation.
KnownNetworkMigrationState can be used interchangeably with NetworkMigrationState, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Network migration is pending.
InProgress: Network migration is in progress.
Succeeded: Network migration succeeded.
Failed: Network migration failed.
CancelInProgress: Network migration cancellation is in progress.
Cancelled: Network migration was cancelled.

OnlineStorageResizeSupport

Indicates if resizing the storage, without interrupting the operation of the database engine, is supported in this location for the given subscription. Will be deprecated in the future. Look to Supported Features for 'OnlineResize'.
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

Intended executor of the operation.
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

OverwriteDatabasesOnTargetServer

Indicates if databases on the target server can be overwritten when already present.
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. When the migration workflow detects that the database already exists on the target server, it will wait for a confirmation.

PasswordBasedAuth

Indicates if the server supports password based authentication.
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 does not support password based authentication.

PostgreSqlFlexibleServerHighAvailabilityMode

Mode of high availability supported for this compute.
KnownPostgreSqlFlexibleServerHighAvailabilityMode can be used interchangeably with PostgreSqlFlexibleServerHighAvailabilityMode, this enum contains the known values that the service supports.

Known values supported by the service

Disabled: High availability is disabled for the server.
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.

PostgresMajorVersion

Major version of PostgreSQL database engine.
KnownPostgresMajorVersion can be used interchangeably with PostgresMajorVersion, this enum contains the known values that the service supports.

Known values supported by the service

19: PostgreSQL 19.
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

Type of Microsoft Entra principal to which the server administrator is associated.
KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports.

Known values supported by the service

Unknown: 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
PrivateEndpointConnectionProvisioningState

The current provisioning state.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded: Connection has been provisioned
Creating: Connection is being created
Deleting: Connection is being deleted
Failed: Connection provisioning has failed

PrivateEndpointServiceConnectionStatus

The private endpoint connection status.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending: Connection waiting for approval or rejection
Approved: Connection approved
Rejected: Connection Rejected

ReadReplicaPromoteMode

Type of operation to apply on the read replica. This property is write only.
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, and a completely independent entity from the replication set.
Switchover: Read replica will swap roles with primary server.

ReadReplicaPromoteOption

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.
KnownReadReplicaPromoteOption can be used interchangeably with ReadReplicaPromoteOption, this enum contains the known values that the service supports.

Known values supported by the service

Planned: Wait for data in the read replica to be fully synchronized with its source server before it initiates the operation.
Forced: Initiate the operation immediately, without waiting for data in the read replica to be synchronized with its source server.

RecommendationTypeEnum

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

Known values supported by the service

CreateIndex: Recommendation to create an index to improve query performance.
DropIndex: Recommendation to drop an existing index because it's duplicate or unused.
ReIndex: Recommendation to reindex an existing invalid index.
AnalyzeTable: Recommendation to analyze a table to update statistics for the query optimizer.
VacuumTable: Recommendation to vacuum a table to reclaim storage and optimize performance.

RecommendationTypeParameterEnum

Recommendations list filter. Retrieves recommendations based on type.
KnownRecommendationTypeParameterEnum can be used interchangeably with RecommendationTypeParameterEnum, this enum contains the known values that the service supports.

Known values supported by the service

CreateIndex: Recommendation to create an index to improve query performance.
DropIndex: Recommendation to drop an existing index because it's duplicate or unused.
ReIndex: Recommendation to reindex an existing invalid index.
AnalyzeTable: Recommendation to analyze a table to update statistics for the query optimizer.
VacuumTable: Recommendation to vacuum a table to reclaim storage and optimize performance.

ReplicationRole

Role of the server in a replication set.
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

Indicates the replication state of a read replica. This property is returned only when the target server is a read replica.
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 server is fully synchronized and actively replicating data from the primary server.
Catchup: Read replica server is behind the primary server and is currently catching up with pending changes.
Provisioning: Read replica server is being created and is in process of getting initialized.
Updating: Read replica server 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 server is being reconfigured, possibly due to changes in source or settings.

ServerPublicNetworkAccessState

Indicates if public network access is enabled or not.
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

State of a server.
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.

SkuTier

Tier of the compute assigned to a server.
KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports.

Known values supported by the service

Burstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements.
GeneralPurpose: Balanced compute and memory for most workloads, offering scalable performance and I/O throughput.
MemoryOptimized: High memory-to-core ratio for demanding workloads needing fast in-memory processing and high concurrency.

SourceType

Source server type used for the migration.
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

SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.
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

Indicates if data migration must start right away.
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

Indicates if the server is configured to automatically grow storage size when available space is nearing zero and conditions allow for automatic growing storage size.
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

Indicates if storage autogrow is supported in this location. Will be deprecated in the future. Look to Supported Features for 'StorageAutoGrowth'.
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

Type of storage assigned to a server. If not specified, it defaults to Premium_LRS.
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

Type of ThreatProtectionName

ThreatProtectionState

Specifies the state of the advanced threat protection, whether it is enabled, disabled, or a state has not been applied yet on the server.

TriggerCutover

Indicates if cutover must be triggered for the entire migration.
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

Name of the tuning option.
KnownTuningOptionParameterEnum can be used interchangeably with TuningOptionParameterEnum, this enum contains the known values that the service supports.

Known values supported by the service

index: Index related recommendations.
table: Table related recommendations.

ValidationState

Validation state for migration.
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

Type of endpoint for the virtual endpoints.
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.

ZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport

Indicates if high availability with zone redundancy is supported in conjunction with geographically redundant backups in this location. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHaAndGeoBackup'.
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

Indicates if high availability with zone redundancy is supported in this location. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHa'.
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

AzureClouds

An enum to describe Azure Cloud environments.

KnownAzureManagedDiskPerformanceTier

Storage tier of a server.

KnownBackupType

Type of backup.

KnownCancel

Indicates if cancel must be triggered for the entire migration.

KnownCheckNameAvailabilityReason

Possible reasons for a name not being available.

KnownConfigurationDataType

Data type of the configuration (also known as server parameter).

KnownCreatedByType

The kind of entity that created the resource.

KnownCreateMode

Creation mode of a new server.

KnownCreateModeForPatch

Update mode of an existing server.

KnownDataEncryptionType

Data encryption type used by a server.

KnownDbAgentProvisioningState

The provisioning state of the database agent resource.

KnownDbAgentState

The state of the database agent.

KnownEncryptionKeyStatus

Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server.

KnownExecutionStatus

Service-set extensible enumeration indicating the status of operation.

KnownFailoverMode

Failover mode.

KnownFastProvisioningSupport

Indicates if fast provisioning is supported. 'Enabled' means fast provisioning is supported. 'Disabled' stands for fast provisioning is not supported. Will be deprecated in the future. Look to Supported Features for 'FastProvisioning'.

KnownFeatureStatus

Status of the feature. Indicates if the feature is enabled or not.

KnownFipsMode

Indicates if FIPS (Federal Information Processing Standards) mode is enabled on the server.

KnownGeographicallyRedundantBackup

Indicates if the server is configured to create geographically redundant backups.

KnownGeographicallyRedundantBackupSupport

Indicates if geographically redundant backups are supported in this location. Will be deprecated in the future. Look to Supported Features for 'GeoBackup'.

KnownHighAvailabilityMode

Mode of high availability supported for this compute.

KnownHighAvailabilityState

Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant.

KnownIdentityType

Types of identities associated with a server.

KnownImmutableBackup

Indicates if the server is configured to create immutable backups.

KnownLocationRestricted

Indicates if this location is restricted. Will be deprecated in the future. Look to Supported Features for 'Restricted'.

KnownLogicalReplicationOnSourceServer

Indicates whether to setup logical replication on source server, if needed.

KnownMaintenanceEventStatus

The status of a maintenance event.

KnownMaintenanceEventStatusFilter

Filter for maintenance event status.

KnownMaintenanceType

Type of a maintenance event resource.

KnownMajorVersionUpgradePrecheckStatus

The status of the major version upgrade precheck.

KnownMicrosoftEntraAuth

Indicates if the server supports Microsoft Entra authentication.

KnownMigrateRolesAndPermissions

Indicates if roles and permissions must be migrated.

KnownMigrationDatabaseState

Migration state of a database.

KnownMigrationListFilter

Indicates the filter to apply when listing migrations.

KnownMigrationMode

Mode used to perform the migration.

KnownMigrationNameAvailabilityReason

Migration name availability reason.

KnownMigrationOption

Supported option for a migration.

KnownMigrationState

State of migration.

KnownMigrationSubstate

Substate of migration.

KnownNetworkMigrationState

State of the network migration operation.

KnownOnlineStorageResizeSupport

Indicates if resizing the storage, without interrupting the operation of the database engine, is supported in this location for the given subscription. Will be deprecated in the future. Look to Supported Features for 'OnlineResize'.

KnownOperationOrigin

Intended executor of the operation.

KnownOverwriteDatabasesOnTargetServer

Indicates if databases on the target server can be overwritten when already present.

KnownPasswordBasedAuth

Indicates if the server supports password based authentication.

KnownPostgresMajorVersion

Major version of PostgreSQL database engine.

KnownPostgreSqlFlexibleServerHighAvailabilityMode

Mode of high availability supported for this compute.

KnownPrincipalType

Type of Microsoft Entra principal to which the server administrator is associated.

KnownPrivateEndpointConnectionProvisioningState

The current provisioning state.

KnownPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

KnownReadReplicaPromoteMode

Type of operation to apply on the read replica. This property is write only.

KnownReadReplicaPromoteOption

Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only.

KnownRecommendationTypeEnum

Type for this recommendation.

KnownRecommendationTypeParameterEnum

Recommendations list filter. Retrieves recommendations based on type.

KnownReplicationRole

Role of the server in a replication set.

KnownReplicationState

Indicates the replication state of a read replica. This property is returned only when the target server is a read replica.

KnownServerPublicNetworkAccessState

Indicates if public network access is enabled or not.

KnownServerState

State of a server.

KnownSkuTier

Tier of the compute assigned to a server.

KnownSourceType

Source server type used for the migration.

KnownSslMode

SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'.

KnownStartDataMigration

Indicates if data migration must start right away.

KnownStorageAutoGrow

Indicates if the server is configured to automatically grow storage size when available space is nearing zero and conditions allow for automatic growing storage size.

KnownStorageAutoGrowthSupport

Indicates if storage autogrow is supported in this location. Will be deprecated in the future. Look to Supported Features for 'StorageAutoGrowth'.

KnownStorageType

Type of storage assigned to a server. If not specified, it defaults to Premium_LRS.

KnownThreatProtectionName

Known values of ThreatProtectionName that the service accepts.

KnownTriggerCutover

Indicates if cutover must be triggered for the entire migration.

KnownTuningOptionParameterEnum

Name of the tuning option.

KnownValidationState

Validation state for migration.

KnownVersions

The available API versions.

KnownVirtualEndpointType

Type of endpoint for the virtual endpoints.

KnownZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport

Indicates if high availability with zone redundancy is supported in conjunction with geographically redundant backups in this location. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHaAndGeoBackup'.

KnownZoneRedundantHighAvailabilitySupport

Indicates if high availability with zone redundancy is supported in this location. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHa'.

Functions

isRestError(unknown)

Typeguard for RestError

restorePoller<TResponse, TResult>(PostgreSQLManagementFlexibleServerClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

restorePoller<TResponse, TResult>(PostgreSQLManagementFlexibleServerClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: PostgreSQLManagementFlexibleServerClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type