@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. Known values supported by the serviceP1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| BackupType |
Type of backup. Known values supported by the serviceFull: 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. |
| Cancel |
Indicates if cancel must be triggered for the entire migration. Known values supported by the serviceTrue: Cancel must be triggered for the entire migration. |
| CapabilityStatus |
Status of the capability. |
| CheckNameAvailabilityReason |
Possible reasons for a name not being available. Known values supported by the serviceInvalid: Name is invalid. |
| ConfigurationDataType |
Data type of the configuration (also known as server parameter). Known values supported by the serviceBoolean: A boolean value. |
| ContinuablePage |
An interface that describes a page of results. |
| CreateMode |
Creation mode of a new server. Known values supported by the serviceDefault: 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'. |
| CreateModeForPatch |
Update mode of an existing server. Known values supported by the serviceDefault: It's equivalent to 'Update'. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DataEncryptionType |
Data encryption type used by a server. Known values supported by the serviceSystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. |
| DbAgentForUpdateState |
The database agent states accepted in a write request. |
| DbAgentProvisioningState |
The provisioning state of the database agent resource. Known values supported by the serviceSucceeded: Resource has been created. |
| DbAgentState |
The state of the database agent. Known values supported by the serviceEnabling: The database agent is being enabled. |
| 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. Known values supported by the serviceValid: Key is valid and can be used for encryption. |
| ExecutionStatus |
Service-set extensible enumeration indicating the status of operation. Known values supported by the serviceRunning: Operation is currently running. |
| FailoverMode |
Failover mode. Known values supported by the servicePlannedFailover: 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. |
| 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'. Known values supported by the serviceEnabled: Fast provisioning is supported. |
| FeatureStatus |
Status of the feature. Indicates if the feature is enabled or not. Known values supported by the serviceEnabled: Feature is enabled. |
| FipsMode |
Indicates if FIPS (Federal Information Processing Standards) mode is enabled on the server. Known values supported by the serviceEnabled: FIPS mode is enabled on the server. |
| GeographicallyRedundantBackup |
Indicates if the server is configured to create geographically redundant backups. Known values supported by the serviceEnabled: Server is 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'. Known values supported by the serviceEnabled: Geographically redundant backups are supported in this location. |
| HighAvailabilityMode |
Mode of high availability supported for this compute. Known values supported by the serviceZoneRedundant: High availability is supported for this compute, with standby server in a different availability zone than that of the primary. |
| HighAvailabilityState |
Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. Known values supported by the serviceNotEnabled: High availability is not enabled for the server. |
| IdentityType |
Types of identities associated with a server. Known values supported by the serviceNone: No managed identity is assigned to the server. |
| ImmutableBackup |
Indicates if the server is configured to create immutable backups. Known values supported by the serviceEnabled: Server is configured to create immutable backups. |
| LocationRestricted |
Indicates if this location is restricted. Will be deprecated in the future. Look to Supported Features for 'Restricted'. Known values supported by the serviceEnabled: Location is restricted. |
| LogicalReplicationOnSourceServer |
Indicates whether to setup logical replication on source server, if needed. Known values supported by the serviceTrue: Logical replication will be set up on the source server. |
| MaintenanceEventStatus |
The status of a maintenance event. Known values supported by the servicePlanned: The maintenance event is scheduled and has not yet started. |
| MaintenanceEventStatusFilter |
Filter for maintenance event status. Known values supported by the serviceUpcoming: Return events that have a scheduled or in progress status. |
| MaintenanceType |
Type of a maintenance event resource. Known values supported by the servicePlannedMaintenance: Planned maintenance event. |
| MajorVersionUpgradePrecheckStatus |
The status of the major version upgrade precheck. Known values supported by the serviceValidating: Executing prechecks against the source server |
| MicrosoftEntraAuth |
Indicates if the server supports Microsoft Entra authentication. Known values supported by the serviceEnabled: Server supports Microsoft Entra authentication. |
| MigrateRolesAndPermissions |
Indicates if roles and permissions must be migrated. Known values supported by the serviceTrue: Roles and permissions will be migrated. |
| MigrationDatabaseState |
Migration state of a database. Known values supported by the serviceInProgress: Migration is in progress for the database. |
| MigrationListFilter |
Indicates the filter to apply when listing migrations. Known values supported by the serviceActive: Only active (in-progress) migrations. |
| MigrationMode |
Mode used to perform the migration. Known values supported by the serviceOffline: Offline migration mode. |
| MigrationNameAvailabilityReason |
Migration name availability reason. Known values supported by the serviceInvalid: Migration name is invalid. |
| MigrationOption |
Supported option for a migration. Known values supported by the serviceValidate: Validate the migration without performing it. |
| MigrationState |
State of migration. Known values supported by the serviceInProgress: Migration is in progress. |
| MigrationSubstate |
Substate of migration. Known values supported by the servicePerformingPreRequisiteSteps: Performing pre-requisite steps for migration. |
| NetworkMigrationState |
State of the network migration operation. Known values supported by the servicePending: Network migration is pending. |
| 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'. Known values supported by the serviceEnabled: Resizing the storage without interrupting the operation of the database engine is supported. |
| OperationOrigin |
Intended executor of the operation. Known values supported by the serviceNotSpecified |
| OverwriteDatabasesOnTargetServer |
Indicates if databases on the target server can be overwritten when already present. Known values supported by the serviceTrue: Databases on the target server can be overwritten when already present. |
| PasswordBasedAuth |
Indicates if the server supports password based authentication. Known values supported by the serviceEnabled: Server supports password based authentication. |
| PostgreSqlFlexibleServerHighAvailabilityMode |
Mode of high availability supported for this compute. Known values supported by the serviceDisabled: High availability is disabled for the server. |
| PostgresMajorVersion |
Major version of PostgreSQL database engine. Known values supported by the service19: PostgreSQL 19. |
| PrincipalType |
Type of Microsoft Entra principal to which the server administrator is associated. Known values supported by the serviceUnknown: Principal type is not known or not specified. |
| PrivateDnsZoneSuffixGetResponse | |
| PrivateEndpointConnectionProvisioningState |
The current provisioning state. Known values supported by the serviceSucceeded: Connection has been provisioned |
| PrivateEndpointServiceConnectionStatus |
The private endpoint connection status. Known values supported by the servicePending: Connection waiting for approval or rejection |
| ReadReplicaPromoteMode |
Type of operation to apply on the read replica. This property is write only. Known values supported by the serviceStandalone: Read replica will become an independent server, and a completely independent entity from the replication set. |
| ReadReplicaPromoteOption |
Data synchronization option to use when processing the operation specified in the promoteMode property. This property is write only. Known values supported by the servicePlanned: Wait for data in the read replica to be fully synchronized with its source server before it initiates the operation. |
| RecommendationTypeEnum |
Type for this recommendation. Known values supported by the serviceCreateIndex: Recommendation to create an index to improve query performance. |
| RecommendationTypeParameterEnum |
Recommendations list filter. Retrieves recommendations based on type. Known values supported by the serviceCreateIndex: Recommendation to create an index to improve query performance. |
| ReplicationRole |
Role of the server in a replication set. Known values supported by the serviceNone: No replication role assigned; the server operates independently. |
| ReplicationState |
Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Known values supported by the serviceActive: Read replica server is fully synchronized and actively replicating data from the primary server. |
| ServerPublicNetworkAccessState |
Indicates if public network access is enabled or not. Known values supported by the serviceEnabled: 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. |
| ServerState |
State of a server. Known values supported by the serviceReady: 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. |
| SkuTier |
Tier of the compute assigned to a server. Known values supported by the serviceBurstable: Cost-effective tier for infrequent CPU usage, ideal for development and testing workloads with low performance requirements. |
| SourceType |
Source server type used for the migration. Known values supported by the serviceOnPremises: On-premises PostgreSQL server. |
| SslMode |
SSL mode used by a migration. Default SSL mode for 'PostgreSQLSingleServer' is 'VerifyFull'. Default SSL mode for other source types is 'Prefer'. Known values supported by the servicePrefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. |
| StartDataMigration |
Indicates if data migration must start right away. Known values supported by the serviceTrue: Data migration must 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. Known values supported by the serviceEnabled: Server should automatically grow storage size when available space is nearing zero and conditions allow for automatically growing storage size. |
| StorageAutoGrowthSupport |
Indicates if storage autogrow is supported in this location. Will be deprecated in the future. Look to Supported Features for 'StorageAutoGrowth'. Known values supported by the serviceEnabled: Storage autogrow is supported. |
| StorageType |
Type of storage assigned to a server. If not specified, it defaults to Premium_LRS. Known values supported by the servicePremium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. |
| 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. Known values supported by the serviceTrue: Cutover must be triggered for the entire migration. |
| TuningOptionParameterEnum |
Name of the tuning option. Known values supported by the serviceindex: Index related recommendations. |
| ValidationState |
Validation state for migration. Known values supported by the serviceFailed: Validation has failed. |
| VirtualEndpointType |
Type of endpoint for the virtual endpoints. Known values supported by the serviceReadWrite: 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'. Known values supported by the serviceEnabled: High availability with zone redundancy is 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'. Known values supported by the serviceEnabled: High availability with zone redundancy is 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
| is |
Typeguard for RestError |
| restore |
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
| Rest |
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>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor