@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.
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	The 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	The request that is 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.
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
MaintenanceWindow	Maintenance window properties of a server.
MaintenanceWindowForPatch	Maintenance window properties of a server.
MetricSpecification	Metric specification for an operation.
MigrateNetworkStatus	The 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.
PostgreSQLManagementFlexibleServerClientOptionalParams	Optional parameters for the client.
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.
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.
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.
TuningOptionsListByServerOptionalParams	Optional parameters.
TuningOptionsListRecommendationsOptionalParams	Optional parameters.
TuningOptionsOperations	Interface representing a TuningOptions operations.
TuningOptionsProperties	Properties of a tuning option.
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 P2 P3 P4 P6 P10 P15 P20 P30 P40 P50 P60 P70 P80
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 Customer On-Demand
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 False
CapabilityStatus	The 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 Numeric Integer Enumeration String Set
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 Create Update PointInTimeRestore GeoRestore Replica ReviveDropped
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 Update
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 AzureKeyVault
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 Invalid
ExecutionStatus	Service-set extensible enum 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 Cancelled Failed 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 ForcedFailover PlannedSwitchover ForcedSwitchover
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 Disabled
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 Disabled
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 Disabled
GeographicallyRedundantBackupSupport	Indicates if geographically redundant backups are supported in this location. 'Enabled' means geographically redundant backups are supported. 'Disabled' stands for geographically redundant backup is not supported. 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 Disabled
HighAvailabilityMode	Modes 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 SameZone
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 CreatingStandby ReplicatingData FailingOver Healthy RemovingStandby
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 UserAssigned SystemAssigned SystemAssigned,UserAssigned
LocationRestricted	Indicates if this location is restricted. 'Enabled' means location is restricted. 'Disabled' stands for location is not 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 Disabled
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 False
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 Disabled
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 False
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 WaitingForCutoverTrigger Failed Canceled Succeeded Canceling
MigrationListFilter	Type of MigrationListFilter
MigrationMode	Mode used to perform the migration: Online or Offline. KnownMigrationMode can be used interchangeably with MigrationMode, this enum contains the known values that the service supports. Known values supported by the service Offline Online
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 AlreadyExists
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 Migrate ValidateAndMigrate
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 WaitingForUserAction Canceled Failed Succeeded ValidationFailed CleaningUp
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 WaitingForLogicalReplicationSetupRequestOnSourceDB WaitingForDBsToMigrateSpecification WaitingForTargetDBOverwriteConfirmation WaitingForDataMigrationScheduling WaitingForDataMigrationWindow MigratingData WaitingForCutoverTrigger CompletingMigration Completed CancelingRequestedDBMigrations ValidationInProgress
NetworkMigrationState	The 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: The network migration is pending. InProgress: The network migration is in progress. Succeeded: The network migration succeeded. Failed: The network migration failed. CancelInProgress: The network migration cancellation is in progress. Cancelled: The 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. 'Enabled' means resizing the storage without interrupting the operation of the database engine is supported. 'Disabled' means resizing the storage without interrupting the operation of the database engine is not supported. 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 Disabled
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. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation. KnownOverwriteDatabasesOnTargetServer can be used interchangeably with OverwriteDatabasesOnTargetServer, this enum contains the known values that the service supports. Known values supported by the service True False
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 Disabled
PostgreSqlFlexibleServerHighAvailabilityMode	Modes 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 ZoneRedundant SameZone
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 18 17 16 15 14 13 12 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: 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
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. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server. 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	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: 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	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 DropIndex ReIndex AnalyzeTable VacuumTable
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 DropIndex ReIndex AnalyzeTable VacuumTable
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 Primary AsyncReplica GeoAsyncReplica
ReplicationState	Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating KnownReplicationState can be used interchangeably with ReplicationState, this enum contains the known values that the service supports. Known values supported by the service Active: The read replica server is fully synchronized and actively replicating data from the primary server. Catchup: The read replica server is behind the primary server and is currently catching up with pending changes. Provisioning: The read replica server is being created and is in process of getting initialized. Updating: The 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: The 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 Disabled
ServerState	Possible states 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 Dropping Disabled Starting Stopping Stopped Updating Restarting Inaccessible Provisioning
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 GeneralPurpose MemoryOptimized
SourceType	Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL KnownSourceType can be used interchangeably with SourceType, this enum contains the known values that the service supports. Known values supported by the service OnPremises AWS GCP AzureVM PostgreSQLSingleServer AWS_RDS AWS_AURORA AWS_EC2 GCP_CloudSQL GCP_AlloyDB GCP_Compute EDB EDB_Oracle_Server EDB_PostgreSQL PostgreSQLFlexibleServer PostgreSQLCosmosDB Huawei_RDS Huawei_Compute Heroku_PostgreSQL Crunchy_PostgreSQL ApsaraDB_RDS Digital_Ocean_Droplets Digital_Ocean_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 Require VerifyCA VerifyFull
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 False
StorageAutoGrow	Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically 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 Disabled
StorageAutoGrowthSupport	Indicates if storage autogrow is supported in this location. 'Enabled' means storage autogrow is supported. 'Disabled' stands for storage autogrow is not supported. 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 Disabled
StorageType	Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. 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 PremiumV2_LRS UltraSSD_LRS
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 False
TuningOptionParameterEnum	The 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 table
ValidationState	Validation status 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 Succeeded Warning
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
ZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport	Indicates if high availability with zone redundancy is supported in conjunction with geographically redundant backups in this location. 'Enabled' means high availability with zone redundancy is supported in conjunction with geographically redundant backups is supported. 'Disabled' stands for high availability with zone redundancy is supported in conjunction with geographically redundant backups is not supported. 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 Disabled
ZoneRedundantHighAvailabilitySupport	Indicates if high availability with zone redundancy is supported in this location. 'Enabled' means high availability with zone redundancy is supported. 'Disabled' stands for high availability with zone redundancy is not supported. 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 Disabled

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).
KnownCreateMode	Creation mode of a new server.
KnownCreateModeForPatch	Update mode of an existing server.
KnownCreatedByType	The kind of entity that created the resource.
KnownDataEncryptionType	Data encryption type used by a server.
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 enum 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.
KnownGeographicallyRedundantBackup	Indicates if the server is configured to create geographically redundant backups.
KnownGeographicallyRedundantBackupSupport	Indicates if geographically redundant backups are supported in this location. 'Enabled' means geographically redundant backups are supported. 'Disabled' stands for geographically redundant backup is not supported. Will be deprecated in the future. Look to Supported Features for 'GeoBackup'.
KnownHighAvailabilityMode	Modes 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.
KnownLocationRestricted	Indicates if this location is restricted. 'Enabled' means location is restricted. 'Disabled' stands for location is not 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.
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	Known values of MigrationListFilter that the service accepts.
KnownMigrationMode	Mode used to perform the migration: Online or Offline.
KnownMigrationNameAvailabilityReason	Migration name availability reason.
KnownMigrationOption	Supported option for a migration
KnownMigrationState	State of migration.
KnownMigrationSubstate	Substate of migration.
KnownNetworkMigrationState	The 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. 'Enabled' means resizing the storage without interrupting the operation of the database engine is supported. 'Disabled' means resizing the storage without interrupting the operation of the database engine is not supported. 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. If set to 'False', when the migration workflow detects that the database already exists on the target server, it will wait for a confirmation.
KnownPasswordBasedAuth	Indicates if the server supports password based authentication.
KnownPostgreSqlFlexibleServerHighAvailabilityMode	Modes of high availability supported for this compute.
KnownPostgresMajorVersion	Major version of PostgreSQL database engine.
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. Standalone means that the read replica will be promoted to a standalone server, and will become a completely independent entity from the replication set. Switchover means that the read replica will roles with the primary server.
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. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating
KnownServerPublicNetworkAccessState	Indicates if public network access is enabled or not.
KnownServerState	Possible states of a server.
KnownSkuTier	Tier of the compute assigned to a server.
KnownSourceType	Source server type used for the migration: ApsaraDB_RDS, AWS, AWS_AURORA, AWS_EC2, AWS_RDS, AzureVM, Crunchy_PostgreSQL, Digital_Ocean_Droplets, Digital_Ocean_PostgreSQL, EDB, EDB_Oracle_Server, EDB_PostgreSQL, GCP, GCP_AlloyDB, GCP_CloudSQL, GCP_Compute, Heroku_PostgreSQL, Huawei_Compute, Huawei_RDS, OnPremises, PostgreSQLCosmosDB, PostgreSQLFlexibleServer, PostgreSQLSingleServer, or Supabase_PostgreSQL
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	Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size.
KnownStorageAutoGrowthSupport	Indicates if storage autogrow is supported in this location. 'Enabled' means storage autogrow is supported. 'Disabled' stands for storage autogrow is not supported. Will be deprecated in the future. Look to Supported Features for 'StorageAutoGrowth'.
KnownStorageType	Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. 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	The name of the tuning option.
KnownValidationState	Validation status 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. 'Enabled' means high availability with zone redundancy is supported in conjunction with geographically redundant backups is supported. 'Disabled' stands for high availability with zone redundancy is supported in conjunction with geographically redundant backups is not supported. 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. 'Enabled' means high availability with zone redundancy is supported. 'Disabled' stands for high availability with zone redundancy is not supported. Will be deprecated in the future. Look to Supported Features for 'ZoneRedundantHa'.

Functions

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 Details

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

client

PostgreSQLManagementFlexibleServerClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>