@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. |
| AdministratorMicrosoftEntraList |
List of server administrators associated to Microsoft Entra principals. |
| AdministratorsMicrosoftEntra |
Interface representing a AdministratorsMicrosoftEntra. |
| AdministratorsMicrosoftEntraCreateOrUpdateHeaders |
Defines headers for AdministratorsMicrosoftEntra_createOrUpdate operation. |
| AdministratorsMicrosoftEntraCreateOrUpdateOptionalParams |
Optional parameters. |
| AdministratorsMicrosoftEntraDeleteHeaders |
Defines headers for AdministratorsMicrosoftEntra_delete operation. |
| AdministratorsMicrosoftEntraDeleteOptionalParams |
Optional parameters. |
| AdministratorsMicrosoftEntraGetOptionalParams |
Optional parameters. |
| AdministratorsMicrosoftEntraListByServerNextOptionalParams |
Optional parameters. |
| AdministratorsMicrosoftEntraListByServerOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettings |
Interface representing a AdvancedThreatProtectionSettings. |
| AdvancedThreatProtectionSettingsGetOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsList |
List of advanced threat protection settings for a server. |
| AdvancedThreatProtectionSettingsListByServerNextOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsListByServerOptionalParams |
Optional parameters. |
| AdvancedThreatProtectionSettingsModel |
Advanced threat protection settings of the server. |
| AuthConfig |
Authentication configuration properties of a server. |
| AuthConfigForPatch |
Authentication configuration properties of a server. |
| Backup |
Backup properties of a server. |
| BackupAutomaticAndOnDemand |
Properties of a backup. |
| BackupAutomaticAndOnDemandList |
List of backups. |
| BackupForPatch |
Backup properties of a server. |
| BackupRequestBase |
BackupRequestBase is the base for all backup request. |
| BackupSettings |
The settings for the long term backup. |
| BackupStoreDetails |
Details about the target where the backup content will be stored. |
| BackupsAutomaticAndOnDemand |
Interface representing a BackupsAutomaticAndOnDemand. |
| BackupsAutomaticAndOnDemandCreateHeaders |
Defines headers for BackupsAutomaticAndOnDemand_create operation. |
| BackupsAutomaticAndOnDemandCreateOptionalParams |
Optional parameters. |
| BackupsAutomaticAndOnDemandDeleteHeaders |
Defines headers for BackupsAutomaticAndOnDemand_delete operation. |
| BackupsAutomaticAndOnDemandDeleteOptionalParams |
Optional parameters. |
| BackupsAutomaticAndOnDemandGetOptionalParams |
Optional parameters. |
| BackupsAutomaticAndOnDemandListByServerNextOptionalParams |
Optional parameters. |
| BackupsAutomaticAndOnDemandListByServerOptionalParams |
Optional parameters. |
| BackupsLongTermRetention |
Interface representing a BackupsLongTermRetention. |
| BackupsLongTermRetentionCheckPrerequisitesExceptionHeaders |
Defines headers for BackupsLongTermRetention_checkPrerequisites operation. |
| BackupsLongTermRetentionCheckPrerequisitesHeaders |
Defines headers for BackupsLongTermRetention_checkPrerequisites operation. |
| BackupsLongTermRetentionCheckPrerequisitesOptionalParams |
Optional parameters. |
| BackupsLongTermRetentionGetOptionalParams |
Optional parameters. |
| BackupsLongTermRetentionListByServerNextOptionalParams |
Optional parameters. |
| BackupsLongTermRetentionListByServerOptionalParams |
Optional parameters. |
| BackupsLongTermRetentionOperation |
Response for the LTR backup Operation API call |
| BackupsLongTermRetentionRequest |
The request that is made for a long term retention backup. |
| BackupsLongTermRetentionResponse |
Response for the LTR backup API call |
| BackupsLongTermRetentionStartExceptionHeaders |
Defines headers for BackupsLongTermRetention_start operation. |
| BackupsLongTermRetentionStartHeaders |
Defines headers for BackupsLongTermRetention_start operation. |
| BackupsLongTermRetentionStartOptionalParams |
Optional parameters. |
| CapabilitiesByLocation |
Interface representing a CapabilitiesByLocation. |
| CapabilitiesByLocationListNextOptionalParams |
Optional parameters. |
| CapabilitiesByLocationListOptionalParams |
Optional parameters. |
| CapabilitiesByServer |
Interface representing a CapabilitiesByServer. |
| CapabilitiesByServerListNextOptionalParams |
Optional parameters. |
| CapabilitiesByServerListOptionalParams |
Optional parameters. |
| Capability |
Capability for the Azure Database for PostgreSQL flexible server. |
| CapabilityBase |
Base object for representing capability |
| CapabilityList |
List of capabilities for the Azure Database for PostgreSQL flexible server. |
| CapturedLog |
Log file. |
| CapturedLogList |
List of log files. |
| CapturedLogs |
Interface representing a CapturedLogs. |
| CapturedLogsListByServerNextOptionalParams |
Optional parameters. |
| CapturedLogsListByServerOptionalParams |
Optional parameters. |
| CheckNameAvailabilityRequest |
The check availability request body. |
| CheckNameAvailabilityResponse |
The check availability result. |
| Cluster |
Cluster properties of a server. |
| Configuration |
Configuration (also known as server parameter). |
| ConfigurationForUpdate |
Configuration (also known as server parameter). |
| ConfigurationList |
List of configurations (also known as server parameters). |
| Configurations |
Interface representing a Configurations. |
| ConfigurationsGetOptionalParams |
Optional parameters. |
| ConfigurationsListByServerNextOptionalParams |
Optional parameters. |
| ConfigurationsListByServerOptionalParams |
Optional parameters. |
| ConfigurationsPutHeaders |
Defines headers for Configurations_put operation. |
| ConfigurationsPutOptionalParams |
Optional parameters. |
| ConfigurationsUpdateHeaders |
Defines headers for Configurations_update operation. |
| ConfigurationsUpdateOptionalParams |
Optional parameters. |
| DataEncryption |
Data encryption properties of a server. |
| Database |
Represents a database. |
| DatabaseList |
List of all databases in a server. |
| DatabaseMigrationState |
Migration state of a database. |
| Databases |
Interface representing a Databases. |
| DatabasesCreateHeaders |
Defines headers for Databases_create operation. |
| DatabasesCreateOptionalParams |
Optional parameters. |
| DatabasesDeleteHeaders |
Defines headers for Databases_delete operation. |
| DatabasesDeleteOptionalParams |
Optional parameters. |
| DatabasesGetOptionalParams |
Optional parameters. |
| DatabasesListByServerNextOptionalParams |
Optional parameters. |
| DatabasesListByServerOptionalParams |
Optional parameters. |
| DbLevelValidationStatus |
Validation status summary for a database. |
| DbServerMetadata |
Database server metadata. |
| DelegatedSubnetUsage |
Delegated subnet usage data. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). |
| FastProvisioningEditionCapability |
Capability of a fast provisioning compute tier. |
| FirewallRule |
Firewall rule. |
| FirewallRuleList |
List of firewall rules. |
| FirewallRules |
Interface representing a FirewallRules. |
| FirewallRulesCreateOrUpdateHeaders |
Defines headers for FirewallRules_createOrUpdate operation. |
| FirewallRulesCreateOrUpdateOptionalParams |
Optional parameters. |
| FirewallRulesDeleteHeaders |
Defines headers for FirewallRules_delete operation. |
| FirewallRulesDeleteOptionalParams |
Optional parameters. |
| FirewallRulesGetOptionalParams |
Optional parameters. |
| FirewallRulesListByServerNextOptionalParams |
Optional parameters. |
| FirewallRulesListByServerOptionalParams |
Optional parameters. |
| HighAvailability |
High availability properties of a server. |
| HighAvailabilityForPatch |
High availability properties of a server. |
| ImpactRecord |
Impact on some metric if this recommended action is applied. |
| LtrPreBackupRequest |
A request that is made for pre-backup. |
| LtrPreBackupResponse |
Response for the LTR pre-backup API call |
| LtrServerBackupOperationList |
A list of long term retention backup operations for server. |
| MaintenanceWindow |
Maintenance window properties of a server. |
| MaintenanceWindowForPatch |
Maintenance window properties of a server. |
| Migration |
Properties of a migration. |
| MigrationList |
List of migrations. |
| MigrationNameAvailability |
Availability of a migration name. |
| MigrationResourceForPatch |
Migration. |
| MigrationSecretParameters |
Migration secret parameters. |
| MigrationSecretParametersForPatch |
Migration secret parameters. |
| MigrationStatus |
State of migration. |
| MigrationSubstateDetails |
Details of migration substate. |
| Migrations |
Interface representing a Migrations. |
| MigrationsCancelOptionalParams |
Optional parameters. |
| MigrationsCheckNameAvailabilityOptionalParams |
Optional parameters. |
| MigrationsCreateOptionalParams |
Optional parameters. |
| MigrationsGetOptionalParams |
Optional parameters. |
| MigrationsListByTargetServerNextOptionalParams |
Optional parameters. |
| MigrationsListByTargetServerOptionalParams |
Optional parameters. |
| MigrationsUpdateOptionalParams |
Optional parameters. |
| NameAvailability |
Interface representing a NameAvailability. |
| NameAvailabilityCheckGloballyOptionalParams |
Optional parameters. |
| NameAvailabilityCheckWithLocationOptionalParams |
Optional parameters. |
| NameAvailabilityModel |
Availability of a name. |
| NameProperty |
Name property for quota usage |
| Network |
Network properties of a server. |
| ObjectRecommendation |
Object recommendation properties. |
| ObjectRecommendationDetails |
Recommendation details for the recommended action. |
| ObjectRecommendationList |
List of available object recommendations. |
| ObjectRecommendationPropertiesAnalyzedWorkload |
Workload information for the recommended action. |
| ObjectRecommendationPropertiesImplementationDetails |
Implementation details for the recommended action. |
| Operation |
REST API operation definition. |
| OperationDisplay |
Display metadata associated with the operation. |
| OperationList |
List of resource provider operations. |
| Operations |
Interface representing a Operations. |
| OperationsListNextOptionalParams |
Optional parameters. |
| OperationsListOptionalParams |
Optional parameters. |
| PostgreSQLManagementFlexibleServerClientOptionalParams |
Optional parameters. |
| PrivateDnsZoneSuffix |
Interface representing a PrivateDnsZoneSuffix. |
| PrivateDnsZoneSuffixGetOptionalParams |
Optional parameters. |
| PrivateEndpoint |
The private endpoint resource. |
| PrivateEndpointConnection |
The private endpoint connection resource. |
| PrivateEndpointConnectionList |
List of private endpoint connections. |
| PrivateEndpointConnections |
Interface representing a PrivateEndpointConnections. |
| PrivateEndpointConnectionsDeleteHeaders |
Defines headers for PrivateEndpointConnections_delete operation. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsGetOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsListByServerNextOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsListByServerOptionalParams |
Optional parameters. |
| PrivateEndpointConnectionsUpdateHeaders |
Defines headers for PrivateEndpointConnections_update operation. |
| PrivateEndpointConnectionsUpdateOptionalParams |
Optional parameters. |
| PrivateLinkResource |
A private link resource. |
| PrivateLinkResourceList |
A list of private link resources |
| PrivateLinkResources |
Interface representing a PrivateLinkResources. |
| PrivateLinkResourcesGetOptionalParams |
Optional parameters. |
| PrivateLinkResourcesListByServerNextOptionalParams |
Optional parameters. |
| PrivateLinkResourcesListByServerOptionalParams |
Optional parameters. |
| PrivateLinkServiceConnectionState |
A collection of information about the state of the connection between service consumer and provider. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| QuotaUsage |
Quota usage for servers |
| QuotaUsageList |
Capability for the PostgreSQL server |
| QuotaUsages |
Interface representing a QuotaUsages. |
| QuotaUsagesListNextOptionalParams |
Optional parameters. |
| QuotaUsagesListOptionalParams |
Optional parameters. |
| Replica |
Replica properties of a server. |
| Replicas |
Interface representing a Replicas. |
| ReplicasListByServerOptionalParams |
Optional parameters. |
| Resource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| RestartParameter |
PostgreSQL database engine restart parameters. |
| Server |
Properties of a server. |
| ServerEditionCapability |
Capabilities in terms of compute tier. |
| ServerForPatch |
Represents a server to be updated. |
| ServerList |
A list of servers. |
| ServerSku |
Compute information of a server. |
| ServerSkuCapability |
Capabilities in terms of compute. |
| ServerThreatProtectionSettings |
Interface representing a ServerThreatProtectionSettings. |
| ServerThreatProtectionSettingsCreateOrUpdateHeaders |
Defines headers for ServerThreatProtectionSettings_createOrUpdate operation. |
| ServerThreatProtectionSettingsCreateOrUpdateOptionalParams |
Optional parameters. |
| ServerVersionCapability |
Capabilities in terms of major versions of PostgreSQL database engine. |
| Servers |
Interface representing a Servers. |
| ServersCreateOrUpdateHeaders |
Defines headers for Servers_createOrUpdate operation. |
| ServersCreateOrUpdateOptionalParams |
Optional parameters. |
| ServersDeleteHeaders |
Defines headers for Servers_delete operation. |
| ServersDeleteOptionalParams |
Optional parameters. |
| ServersGetOptionalParams |
Optional parameters. |
| ServersListByResourceGroupNextOptionalParams |
Optional parameters. |
| ServersListByResourceGroupOptionalParams |
Optional parameters. |
| ServersListBySubscriptionNextOptionalParams |
Optional parameters. |
| ServersListBySubscriptionOptionalParams |
Optional parameters. |
| ServersRestartHeaders |
Defines headers for Servers_restart operation. |
| ServersRestartOptionalParams |
Optional parameters. |
| ServersStartHeaders |
Defines headers for Servers_start operation. |
| ServersStartOptionalParams |
Optional parameters. |
| ServersStopHeaders |
Defines headers for Servers_stop operation. |
| ServersStopOptionalParams |
Optional parameters. |
| ServersUpdateHeaders |
Defines headers for Servers_update operation. |
| ServersUpdateOptionalParams |
Optional parameters. |
| Sku |
Compute information of a server. |
| SkuForPatch |
Compute information of a server. |
| Storage |
Storage properties of a server. |
| StorageEditionCapability |
Capabilities in terms of storage tier. |
| StorageMbCapability |
Storage size (in MB) capability. |
| StorageTierCapability |
Capability of a storage tier. |
| SupportedFeature |
Features supported. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| TuningOptions |
Impact on some metric if this recommended action is applied. |
| TuningOptionsGetOptionalParams |
Optional parameters. |
| TuningOptionsList |
List of server tuning options. |
| TuningOptionsListByServerNextOptionalParams |
Optional parameters. |
| TuningOptionsListByServerOptionalParams |
Optional parameters. |
| TuningOptionsListRecommendationsNextOptionalParams |
Optional parameters. |
| TuningOptionsListRecommendationsOptionalParams |
Optional parameters. |
| TuningOptionsOperations |
Interface representing a TuningOptionsOperations. |
| UserAssignedIdentity |
Identities associated with a server. |
| UserIdentity |
User assigned managed identity associated with a server. |
| ValidationDetails |
Details for the validation for migration. |
| ValidationMessage |
Validation message object. |
| ValidationSummaryItem |
Validation summary object. |
| VirtualEndpoint |
Pair of virtual endpoints for a server. |
| VirtualEndpointResourceForPatch |
Pair of virtual endpoints for a server. |
| VirtualEndpoints |
Interface representing a VirtualEndpoints. |
| VirtualEndpointsCreateHeaders |
Defines headers for VirtualEndpoints_create operation. |
| VirtualEndpointsCreateOptionalParams |
Optional parameters. |
| VirtualEndpointsDeleteHeaders |
Defines headers for VirtualEndpoints_delete operation. |
| VirtualEndpointsDeleteOptionalParams |
Optional parameters. |
| VirtualEndpointsGetOptionalParams |
Optional parameters. |
| VirtualEndpointsList |
List of virtual endpoints. |
| VirtualEndpointsListByServerNextOptionalParams |
Optional parameters. |
| VirtualEndpointsListByServerOptionalParams |
Optional parameters. |
| VirtualEndpointsUpdateHeaders |
Defines headers for VirtualEndpoints_update operation. |
| VirtualEndpointsUpdateOptionalParams |
Optional parameters. |
| VirtualNetworkSubnetUsage |
Interface representing a VirtualNetworkSubnetUsage. |
| VirtualNetworkSubnetUsageListOptionalParams |
Optional parameters. |
| VirtualNetworkSubnetUsageModel |
Virtual network subnet usage data. |
| VirtualNetworkSubnetUsageParameter |
Virtual network subnet usage parameter |
Type Aliases
| AdministratorsMicrosoftEntraCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| AdministratorsMicrosoftEntraDeleteResponse |
Contains response data for the delete operation. |
| AdministratorsMicrosoftEntraGetResponse |
Contains response data for the get operation. |
| AdministratorsMicrosoftEntraListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| AdministratorsMicrosoftEntraListByServerResponse |
Contains response data for the listByServer operation. |
| AdvancedThreatProtectionSettingsGetResponse |
Contains response data for the get operation. |
| AdvancedThreatProtectionSettingsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| AdvancedThreatProtectionSettingsListByServerResponse |
Contains response data for the listByServer operation. |
| AzureManagedDiskPerformanceTier |
Defines values for AzureManagedDiskPerformanceTier. Known values supported by the serviceP1: Entry-level SSD for minimal IOPS, ideal for light development or testing workloads. |
| BackupType |
Defines values for BackupType. 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. |
| BackupsAutomaticAndOnDemandCreateResponse |
Contains response data for the create operation. |
| BackupsAutomaticAndOnDemandDeleteResponse |
Contains response data for the delete operation. |
| BackupsAutomaticAndOnDemandGetResponse |
Contains response data for the get operation. |
| BackupsAutomaticAndOnDemandListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| BackupsAutomaticAndOnDemandListByServerResponse |
Contains response data for the listByServer operation. |
| BackupsLongTermRetentionCheckPrerequisitesResponse |
Contains response data for the checkPrerequisites operation. |
| BackupsLongTermRetentionGetResponse |
Contains response data for the get operation. |
| BackupsLongTermRetentionListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| BackupsLongTermRetentionListByServerResponse |
Contains response data for the listByServer operation. |
| BackupsLongTermRetentionStartResponse |
Contains response data for the start operation. |
| Cancel |
Defines values for Cancel. Known values supported by the serviceTrue: Cancel must be triggered for the entire migration. |
| CapabilitiesByLocationListNextResponse |
Contains response data for the listNext operation. |
| CapabilitiesByLocationListResponse |
Contains response data for the list operation. |
| CapabilitiesByServerListNextResponse |
Contains response data for the listNext operation. |
| CapabilitiesByServerListResponse |
Contains response data for the list operation. |
| CapabilityStatus |
Defines values for CapabilityStatus. |
| CapturedLogsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| CapturedLogsListByServerResponse |
Contains response data for the listByServer operation. |
| CheckNameAvailabilityReason |
Defines values for CheckNameAvailabilityReason. Known values supported by the serviceInvalid |
| ConfigurationDataType |
Defines values for ConfigurationDataType. Known values supported by the serviceBoolean: A boolean value. |
| ConfigurationsGetResponse |
Contains response data for the get operation. |
| ConfigurationsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| ConfigurationsListByServerResponse |
Contains response data for the listByServer operation. |
| ConfigurationsPutResponse |
Contains response data for the put operation. |
| ConfigurationsUpdateResponse |
Contains response data for the update operation. |
| CreateMode |
Defines values for CreateMode. 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 |
Defines values for CreateModeForPatch. Known values supported by the serviceDefault: It's equivalent to 'Update'. |
| CreatedByType |
Defines values for CreatedByType. Known values supported by the serviceUser |
| DataEncryptionType |
Defines values for DataEncryptionType. Known values supported by the serviceSystemManaged: Encryption managed by Azure using platform managed keys for simplicity and compliance. |
| DatabasesCreateResponse |
Contains response data for the create operation. |
| DatabasesDeleteResponse |
Contains response data for the delete operation. |
| DatabasesGetResponse |
Contains response data for the get operation. |
| DatabasesListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| DatabasesListByServerResponse |
Contains response data for the listByServer operation. |
| EncryptionKeyStatus |
Defines values for EncryptionKeyStatus. Known values supported by the serviceValid: Key is valid and can be used for encryption. |
| ExecutionStatus |
Defines values for ExecutionStatus. Known values supported by the serviceRunning: The operation is currently running. |
| FailoverMode |
Defines values for FailoverMode. Known values supported by the servicePlannedFailover: Triggers a failover from primary to standby without killing the primary database process first. This is a graceful failover that attempts to preserve data consistency. |
| FastProvisioningSupport |
Defines values for FastProvisioningSupport. Known values supported by the serviceEnabled: Fast provisioning is supported. |
| FeatureStatus |
Defines values for FeatureStatus. Known values supported by the serviceEnabled: Feature is enabled. |
| FirewallRulesCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| FirewallRulesDeleteResponse |
Contains response data for the delete operation. |
| FirewallRulesGetResponse |
Contains response data for the get operation. |
| FirewallRulesListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| FirewallRulesListByServerResponse |
Contains response data for the listByServer operation. |
| GeographicallyRedundantBackup |
Defines values for GeographicallyRedundantBackup. Known values supported by the serviceEnabled: Server is configured to create geographically redundant backups. |
| GeographicallyRedundantBackupSupport |
Defines values for GeographicallyRedundantBackupSupport. Known values supported by the serviceEnabled: Geographically redundant backups are supported. |
| HighAvailabilityMode |
Defines values for HighAvailabilityMode. Known values supported by the serviceZoneRedundant: High availability is enabled for the server, with standby server in a different availability zone than that of the primary. |
| HighAvailabilityState |
Defines values for HighAvailabilityState. Known values supported by the serviceNotEnabled: High availability is not enabled for the server. |
| IdentityType |
Defines values for IdentityType. Known values supported by the serviceNone: No managed identity is assigned to the server. |
| LocationRestricted |
Defines values for LocationRestricted. Known values supported by the serviceEnabled: Location is restricted. |
| LogicalReplicationOnSourceServer |
Defines values for LogicalReplicationOnSourceServer. Known values supported by the serviceTrue: Logical replication will be set up on the source server. |
| MicrosoftEntraAuth |
Defines values for MicrosoftEntraAuth. Known values supported by the serviceEnabled: Server supports Microsoft Entra authentication. |
| MigrateRolesAndPermissions |
Defines values for MigrateRolesAndPermissions. Known values supported by the serviceTrue: Roles and permissions will be migrated. |
| MigrationDatabaseState |
Defines values for MigrationDatabaseState. Known values supported by the serviceInProgress: Migration is in progress for the database. |
| MigrationDetailsLevel |
Defines values for MigrationDetailsLevel. Known values supported by the serviceDefault: Default level of details. |
| MigrationListFilter |
Defines values for MigrationListFilter. Known values supported by the serviceActive: Only active (in-progress) migrations. |
| MigrationMode |
Defines values for MigrationMode. Known values supported by the serviceOffline: Offline migration mode. |
| MigrationNameAvailabilityReason |
Defines values for MigrationNameAvailabilityReason. Known values supported by the serviceInvalid: Migration name is invalid. |
| MigrationOption |
Defines values for MigrationOption. Known values supported by the serviceValidate: Validate the migration without performing it. |
| MigrationState |
Defines values for MigrationState. Known values supported by the serviceInProgress: Migration is in progress. |
| MigrationSubstate |
Defines values for MigrationSubstate. Known values supported by the servicePerformingPreRequisiteSteps: Performing pre-requisite steps for migration. |
| MigrationsCancelResponse |
Contains response data for the cancel operation. |
| MigrationsCheckNameAvailabilityResponse |
Contains response data for the checkNameAvailability operation. |
| MigrationsCreateResponse |
Contains response data for the create operation. |
| MigrationsGetResponse |
Contains response data for the get operation. |
| MigrationsListByTargetServerNextResponse |
Contains response data for the listByTargetServerNext operation. |
| MigrationsListByTargetServerResponse |
Contains response data for the listByTargetServer operation. |
| MigrationsUpdateResponse |
Contains response data for the update operation. |
| NameAvailabilityCheckGloballyResponse |
Contains response data for the checkGlobally operation. |
| NameAvailabilityCheckWithLocationResponse |
Contains response data for the checkWithLocation operation. |
| OnlineStorageResizeSupport |
Defines values for OnlineStorageResizeSupport. Known values supported by the serviceEnabled: Resizing the storage without interrupting the operation of the database engine is supported. |
| OperationOrigin |
Defines values for OperationOrigin. Known values supported by the serviceNotSpecified: The origin is not specified. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| OverwriteDatabasesOnTargetServer |
Defines values for OverwriteDatabasesOnTargetServer. Known values supported by the serviceTrue: Databases on the target server can be overwritten when already present. |
| PasswordBasedAuth |
Defines values for PasswordBasedAuth. Known values supported by the serviceEnabled: Server supports password based authentication. |
| PostgresMajorVersion |
Defines values for PostgresMajorVersion. Known values supported by the service18: PostgreSQL 18. |
| PrincipalType |
Defines values for PrincipalType. Known values supported by the serviceUnknown: The principal type is not known or not specified. |
| PrivateDnsZoneSuffixGetResponse |
Contains response data for the get operation. |
| PrivateEndpointConnectionProvisioningState |
Defines values for PrivateEndpointConnectionProvisioningState. Known values supported by the serviceSucceeded |
| PrivateEndpointConnectionsDeleteResponse |
Contains response data for the delete operation. |
| PrivateEndpointConnectionsGetResponse |
Contains response data for the get operation. |
| PrivateEndpointConnectionsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| PrivateEndpointConnectionsListByServerResponse |
Contains response data for the listByServer operation. |
| PrivateEndpointConnectionsUpdateResponse |
Contains response data for the update operation. |
| PrivateEndpointServiceConnectionStatus |
Defines values for PrivateEndpointServiceConnectionStatus. Known values supported by the servicePending |
| PrivateLinkResourcesGetResponse |
Contains response data for the get operation. |
| PrivateLinkResourcesListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| PrivateLinkResourcesListByServerResponse |
Contains response data for the listByServer operation. |
| QuotaUsagesListNextResponse |
Contains response data for the listNext operation. |
| QuotaUsagesListResponse |
Contains response data for the list operation. |
| ReadReplicaPromoteMode |
Defines values for ReadReplicaPromoteMode. Known values supported by the serviceStandalone: Read replica will become an independent server. |
| ReadReplicaPromoteOption |
Defines values for ReadReplicaPromoteOption. Known values supported by the servicePlanned: The operation will wait for data in the read replica to be fully synchronized with its source server, before it initiates the operation. |
| RecommendationTypeEnum |
Defines values for RecommendationTypeEnum. Known values supported by the serviceCreateIndex |
| RecommendationTypeParameterEnum |
Defines values for RecommendationTypeParameterEnum. Known values supported by the serviceCreateIndex |
| ReplicasListByServerResponse |
Contains response data for the listByServer operation. |
| ReplicationRole |
Defines values for ReplicationRole. Known values supported by the serviceNone: No replication role assigned; the server operates independently. |
| ReplicationState |
Defines values for ReplicationState. Known values supported by the serviceActive: Read replica is fully synchronized and actively replicating data from the primary server. |
| ServerPublicNetworkAccessState |
Defines values for ServerPublicNetworkAccessState. 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 |
Defines values for ServerState. 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. |
| ServerThreatProtectionSettingsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| ServersCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
| ServersDeleteResponse |
Contains response data for the delete operation. |
| ServersGetResponse |
Contains response data for the get operation. |
| ServersListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| ServersListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| ServersListBySubscriptionNextResponse |
Contains response data for the listBySubscriptionNext operation. |
| ServersListBySubscriptionResponse |
Contains response data for the listBySubscription operation. |
| ServersRestartResponse |
Contains response data for the restart operation. |
| ServersStartResponse |
Contains response data for the start operation. |
| ServersStopResponse |
Contains response data for the stop operation. |
| ServersUpdateResponse |
Contains response data for the update operation. |
| SkuTier |
Defines values for SkuTier. Known values supported by the serviceBurstable |
| SourceType |
Defines values for SourceType. Known values supported by the serviceOnPremises: On-premises PostgreSQL server. |
| SslMode |
Defines values for SslMode. Known values supported by the servicePrefer: Prefer SSL connection. If the server does not support SSL, the connection will be established without SSL. |
| StartDataMigration |
Defines values for StartDataMigration. Known values supported by the serviceTrue: Data migration must start right away. |
| StorageAutoGrow |
Defines values for StorageAutoGrow. 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 |
Defines values for StorageAutoGrowthSupport. Known values supported by the serviceEnabled: Storage autogrow is supported. |
| StorageType |
Defines values for StorageType. Known values supported by the servicePremium_LRS: Standard Solid State Disk (SSD) backed storage offering consistent performance for general purpose workloads. |
| ThreatProtectionName |
Defines values for ThreatProtectionName. Known values supported by the serviceDefault: Default advanced threat protection settings. |
| ThreatProtectionState |
Defines values for ThreatProtectionState. |
| TriggerCutover |
Defines values for TriggerCutover. Known values supported by the serviceTrue: Cutover must be triggered for the entire migration. |
| TuningOptionParameterEnum |
Defines values for TuningOptionParameterEnum. Known values supported by the serviceindex |
| TuningOptionsGetResponse |
Contains response data for the get operation. |
| TuningOptionsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| TuningOptionsListByServerResponse |
Contains response data for the listByServer operation. |
| TuningOptionsListRecommendationsNextResponse |
Contains response data for the listRecommendationsNext operation. |
| TuningOptionsListRecommendationsResponse |
Contains response data for the listRecommendations operation. |
| ValidationState |
Defines values for ValidationState. Known values supported by the serviceFailed: Validation has failed. |
| VirtualEndpointType |
Defines values for VirtualEndpointType. Known values supported by the serviceReadWrite: Read-write endpoint. |
| VirtualEndpointsCreateResponse |
Contains response data for the create operation. |
| VirtualEndpointsDeleteResponse |
Contains response data for the delete operation. |
| VirtualEndpointsGetResponse |
Contains response data for the get operation. |
| VirtualEndpointsListByServerNextResponse |
Contains response data for the listByServerNext operation. |
| VirtualEndpointsListByServerResponse |
Contains response data for the listByServer operation. |
| VirtualEndpointsUpdateResponse |
Contains response data for the update operation. |
| VirtualNetworkSubnetUsageListResponse |
Contains response data for the list operation. |
| ZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport |
Defines values for ZoneRedundantHighAvailabilityAndGeographicallyRedundantBackupSupport. Known values supported by the serviceEnabled: High availability with zone redundancy is supported in conjunction with geographically redundant backups. |
| ZoneRedundantHighAvailabilitySupport |
Defines values for ZoneRedundantHighAvailabilitySupport. Known values supported by the serviceEnabled: High availability with zone redundancy is supported. |
Enums
Functions
| get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value produced by the byPage iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value on the IteratorResult from a byPage iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.