@azure/arm-postgresql-flexible package

Classes

PostgreSQLManagementFlexibleServerClient

Interfaces

ActiveDirectoryAdministrator	Represents an Active Directory administrator.
ActiveDirectoryAdministratorAdd	Represents an Active Directory administrator.
AdminCredentials	Server admin credentials.
AdministratorListResult	A list of active directory administrators.
Administrators	Interface representing a Administrators.
AdministratorsCreateHeaders	Defines headers for Administrators_create operation.
AdministratorsCreateOptionalParams	Optional parameters.
AdministratorsDeleteHeaders	Defines headers for Administrators_delete operation.
AdministratorsDeleteOptionalParams	Optional parameters.
AdministratorsGetOptionalParams	Optional parameters.
AdministratorsListByServerNextOptionalParams	Optional parameters.
AdministratorsListByServerOptionalParams	Optional parameters.
AuthConfig	Authentication configuration properties of a server
Backup	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.
Backups	Interface representing a Backups.
BackupsCreateHeaders	Defines headers for Backups_create operation.
BackupsCreateOptionalParams	Optional parameters.
BackupsDeleteHeaders	Defines headers for Backups_delete operation.
BackupsDeleteOptionalParams	Optional parameters.
BackupsGetOptionalParams	Optional parameters.
BackupsListByServerNextOptionalParams	Optional parameters.
BackupsListByServerOptionalParams	Optional parameters.
CapabilitiesListResult	Capability for the PostgreSQL server
CapabilityBase	Base object for representing capability
CheckMigrationNameAvailabilityOptionalParams	Optional parameters.
CheckNameAvailability	Interface representing a CheckNameAvailability.
CheckNameAvailabilityExecuteOptionalParams	Optional parameters.
CheckNameAvailabilityRequest	The check availability request body.
CheckNameAvailabilityResponse	The check availability result.
CheckNameAvailabilityWithLocation	Interface representing a CheckNameAvailabilityWithLocation.
CheckNameAvailabilityWithLocationExecuteOptionalParams	Optional parameters.
Configuration	Represents a Configuration.
ConfigurationForUpdate	Represents a Configuration.
ConfigurationListResult	A list of server configurations.
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.
DatabaseListResult	A List of databases.
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 an individual database
DbMigrationStatus	Migration status of an individual 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	Represents capability of a fast provisioning edition
FirewallRule	Represents a server firewall rule.
FirewallRuleListResult	A 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.
FlexibleServer	Interface representing a FlexibleServer.
FlexibleServerCapability	Capability for the PostgreSQL server
FlexibleServerEditionCapability	Flexible server edition capabilities.
FlexibleServerStartLtrBackupExceptionHeaders	Defines headers for FlexibleServer_startLtrBackup operation.
FlexibleServerStartLtrBackupHeaders	Defines headers for FlexibleServer_startLtrBackup operation.
FlexibleServerStartLtrBackupOptionalParams	Optional parameters.
FlexibleServerTriggerLtrPreBackupExceptionHeaders	Defines headers for FlexibleServer_triggerLtrPreBackup operation.
FlexibleServerTriggerLtrPreBackupHeaders	Defines headers for FlexibleServer_triggerLtrPreBackup operation.
FlexibleServerTriggerLtrPreBackupOptionalParams	Optional parameters.
GetPrivateDnsZoneSuffix	Interface representing a GetPrivateDnsZoneSuffix.
GetPrivateDnsZoneSuffixExecuteOptionalParams	Optional parameters.
HighAvailability	High availability properties of a server
LocationBasedCapabilities	Interface representing a LocationBasedCapabilities.
LocationBasedCapabilitiesExecuteNextOptionalParams	Optional parameters.
LocationBasedCapabilitiesExecuteOptionalParams	Optional parameters.
LogFile	Represents a logFile.
LogFileListResult	A List of logFiles.
LogFiles	Interface representing a LogFiles.
LogFilesListByServerNextOptionalParams	Optional parameters.
LogFilesListByServerOptionalParams	Optional parameters.
LtrBackupOperations	Interface representing a LtrBackupOperations.
LtrBackupOperationsGetOptionalParams	Optional parameters.
LtrBackupOperationsListByServerNextOptionalParams	Optional parameters.
LtrBackupOperationsListByServerOptionalParams	Optional parameters.
LtrBackupRequest	The request that is made for a long term retention backup.
LtrBackupResponse	Response for the LTR backup API call
LtrPreBackupRequest	A request that is made for pre-backup.
LtrPreBackupResponse	Response for the LTR pre-backup API call
LtrServerBackupOperation	Response for the LTR backup Operation API call
LtrServerBackupOperationList	A list of long term retention backup operations for server.
MaintenanceWindow	Maintenance window properties of a server.
MigrationNameAvailabilityResource	Represents a migration name's availability.
MigrationResource	Represents a migration resource.
MigrationResourceForPatch	Represents a migration resource for patch.
MigrationResourceListResult	A list of migration resources.
MigrationSecretParameters	Migration secret parameters.
MigrationStatus	Migration status.
MigrationSubStateDetails	Migration sub state details.
Migrations	Interface representing a Migrations.
MigrationsCreateOptionalParams	Optional parameters.
MigrationsDeleteOptionalParams	Optional parameters.
MigrationsGetOptionalParams	Optional parameters.
MigrationsListByTargetServerNextOptionalParams	Optional parameters.
MigrationsListByTargetServerOptionalParams	Optional parameters.
MigrationsUpdateOptionalParams	Optional parameters.
NameAvailability	Represents a resource name availability.
Network	Network properties of a server.
Operation	REST API operation definition.
OperationDisplay	Display metadata associated with the operation.
OperationListResult	A list of resource provider operations.
Operations	Interface representing a Operations.
OperationsListOptionalParams	Optional parameters.
PostgreSQLManagementFlexibleServerClientOptionalParams	Optional parameters.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	The private endpoint connection resource.
PrivateEndpointConnectionDeleteHeaders	Defines headers for PrivateEndpointConnection_delete operation.
PrivateEndpointConnectionDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionListResult	A list of private endpoint connections.
PrivateEndpointConnectionOperations	Interface representing a PrivateEndpointConnectionOperations.
PrivateEndpointConnectionUpdateHeaders	Defines headers for PrivateEndpointConnection_update operation.
PrivateEndpointConnectionUpdateOptionalParams	Optional parameters.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServerNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByServerOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource.
PrivateLinkResourceListResult	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
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	Represents server restart parameters.
Server	Represents a server.
ServerBackup	Server backup properties
ServerBackupListResult	A list of server backups.
ServerCapabilities	Interface representing a ServerCapabilities.
ServerCapabilitiesListNextOptionalParams	Optional parameters.
ServerCapabilitiesListOptionalParams	Optional parameters.
ServerForUpdate	Represents a server to be updated.
ServerListResult	A list of servers.
ServerSku	Sku information related properties of a server.
ServerSkuCapability	Sku capability
ServerThreatProtectionListResult	A list of the server's Advanced Threat Protection settings.
ServerThreatProtectionSettings	Interface representing a ServerThreatProtectionSettings.
ServerThreatProtectionSettingsCreateOrUpdateHeaders	Defines headers for ServerThreatProtectionSettings_createOrUpdate operation.
ServerThreatProtectionSettingsCreateOrUpdateOptionalParams	Optional parameters.
ServerThreatProtectionSettingsGetOptionalParams	Optional parameters.
ServerThreatProtectionSettingsListByServerNextOptionalParams	Optional parameters.
ServerThreatProtectionSettingsListByServerOptionalParams	Optional parameters.
ServerThreatProtectionSettingsModel	Server's Advanced Threat Protection settings.
ServerVersionCapability	Server version capabilities.
Servers	Interface representing a Servers.
ServersCreateHeaders	Defines headers for Servers_create operation.
ServersCreateOptionalParams	Optional parameters.
ServersDeleteHeaders	Defines headers for Servers_delete operation.
ServersDeleteOptionalParams	Optional parameters.
ServersGetOptionalParams	Optional parameters.
ServersListByResourceGroupNextOptionalParams	Optional parameters.
ServersListByResourceGroupOptionalParams	Optional parameters.
ServersListNextOptionalParams	Optional parameters.
ServersListOptionalParams	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	Sku information related properties of a server.
Storage	Storage properties of a server
StorageEditionCapability	Storage edition capability
StorageMbCapability	storage size in MB capability
StorageTierCapability	Represents capability of a storage tier
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'
UserAssignedIdentity	Information describing the identities associated with this application.
UserIdentity	Describes a single user-assigned identity associated with the application.
ValidationDetails	Details for the validation for migration
ValidationMessage	Validation message object
ValidationSummaryItem	Validation summary object
VirtualEndpointResource	Represents a virtual endpoint for a server.
VirtualEndpointResourceForPatch	Represents a virtual endpoint 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.
VirtualEndpointsListByServerNextOptionalParams	Optional parameters.
VirtualEndpointsListByServerOptionalParams	Optional parameters.
VirtualEndpointsListResult	A list of virtual endpoints.
VirtualEndpointsUpdateHeaders	Defines headers for VirtualEndpoints_update operation.
VirtualEndpointsUpdateOptionalParams	Optional parameters.
VirtualNetworkSubnetUsage	Interface representing a VirtualNetworkSubnetUsage.
VirtualNetworkSubnetUsageExecuteOptionalParams	Optional parameters.
VirtualNetworkSubnetUsageParameter	Virtual network subnet usage parameter
VirtualNetworkSubnetUsageResult	Virtual network subnet usage data.

Type Aliases

ActiveDirectoryAuthEnum	Defines values for ActiveDirectoryAuthEnum. KnownActiveDirectoryAuthEnum can be used interchangeably with ActiveDirectoryAuthEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
AdministratorsCreateResponse	Contains response data for the create operation.
AdministratorsGetResponse	Contains response data for the get operation.
AdministratorsListByServerNextResponse	Contains response data for the listByServerNext operation.
AdministratorsListByServerResponse	Contains response data for the listByServer operation.
ArmServerKeyType	Defines values for ArmServerKeyType. KnownArmServerKeyType can be used interchangeably with ArmServerKeyType, this enum contains the known values that the service supports. Known values supported by the service SystemManaged AzureKeyVault
AzureManagedDiskPerformanceTiers	Defines values for AzureManagedDiskPerformanceTiers. KnownAzureManagedDiskPerformanceTiers can be used interchangeably with AzureManagedDiskPerformanceTiers, 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
BackupsCreateResponse	Contains response data for the create operation.
BackupsDeleteResponse	Contains response data for the delete operation.
BackupsGetResponse	Contains response data for the get operation.
BackupsListByServerNextResponse	Contains response data for the listByServerNext operation.
BackupsListByServerResponse	Contains response data for the listByServer operation.
CancelEnum	Defines values for CancelEnum. KnownCancelEnum can be used interchangeably with CancelEnum, this enum contains the known values that the service supports. Known values supported by the service True False
CapabilityStatus	Defines values for CapabilityStatus.
CheckMigrationNameAvailabilityResponse	Contains response data for the checkMigrationNameAvailability operation.
CheckNameAvailabilityExecuteResponse	Contains response data for the execute operation.
CheckNameAvailabilityReason	Defines values for CheckNameAvailabilityReason. KnownCheckNameAvailabilityReason can be used interchangeably with CheckNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists
CheckNameAvailabilityWithLocationExecuteResponse	Contains response data for the execute operation.
ConfigurationDataType	Defines values for ConfigurationDataType. KnownConfigurationDataType can be used interchangeably with ConfigurationDataType, this enum contains the known values that the service supports. Known values supported by the service Boolean Numeric Integer Enumeration
ConfigurationsGetResponse	Contains response data for the get operation.
ConfigurationsListByServerNextResponse	Contains response data for the listByServerNext operation.
ConfigurationsListByServerResponse	Contains response data for the listByServer operation.
ConfigurationsPutResponse	Contains response data for the put operation.
ConfigurationsUpdateResponse	Contains response data for the update operation.
CreateMode	Defines values for CreateMode. KnownCreateMode can be used interchangeably with CreateMode, this enum contains the known values that the service supports. Known values supported by the service Default Create Update PointInTimeRestore GeoRestore Replica ReviveDropped
CreateModeForUpdate	Defines values for CreateModeForUpdate. KnownCreateModeForUpdate can be used interchangeably with CreateModeForUpdate, this enum contains the known values that the service supports. Known values supported by the service Default Update
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DatabasesCreateResponse	Contains response data for the create 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.
ExecutionStatus	Defines values for ExecutionStatus. KnownExecutionStatus can be used interchangeably with ExecutionStatus, this enum contains the known values that the service supports. Known values supported by the service Running Cancelled Failed Succeeded
FailoverMode	Defines values for FailoverMode. KnownFailoverMode can be used interchangeably with FailoverMode, this enum contains the known values that the service supports. Known values supported by the service PlannedFailover ForcedFailover PlannedSwitchover ForcedSwitchover
FastProvisioningSupportedEnum	Defines values for FastProvisioningSupportedEnum. KnownFastProvisioningSupportedEnum can be used interchangeably with FastProvisioningSupportedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
FirewallRulesCreateOrUpdateResponse	Contains response data for the createOrUpdate 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.
FlexibleServerStartLtrBackupResponse	Contains response data for the startLtrBackup operation.
FlexibleServerTriggerLtrPreBackupResponse	Contains response data for the triggerLtrPreBackup operation.
GeoBackupSupportedEnum	Defines values for GeoBackupSupportedEnum. KnownGeoBackupSupportedEnum can be used interchangeably with GeoBackupSupportedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
GeoRedundantBackupEnum	Defines values for GeoRedundantBackupEnum. KnownGeoRedundantBackupEnum can be used interchangeably with GeoRedundantBackupEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
GetPrivateDnsZoneSuffixExecuteResponse	Contains response data for the execute operation.
HaMode	Defines values for HaMode. KnownHaMode can be used interchangeably with HaMode, this enum contains the known values that the service supports. Known values supported by the service SameZone ZoneRedundant
HighAvailabilityMode	Defines values for HighAvailabilityMode. KnownHighAvailabilityMode can be used interchangeably with HighAvailabilityMode, this enum contains the known values that the service supports. Known values supported by the service Disabled ZoneRedundant SameZone
IdentityType	Defines values for IdentityType. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service None UserAssigned SystemAssigned
KeyStatusEnum	Defines values for KeyStatusEnum. KnownKeyStatusEnum can be used interchangeably with KeyStatusEnum, this enum contains the known values that the service supports. Known values supported by the service Valid Invalid
LocationBasedCapabilitiesExecuteNextResponse	Contains response data for the executeNext operation.
LocationBasedCapabilitiesExecuteResponse	Contains response data for the execute operation.
LogFilesListByServerNextResponse	Contains response data for the listByServerNext operation.
LogFilesListByServerResponse	Contains response data for the listByServer operation.
LogicalReplicationOnSourceDbEnum	Defines values for LogicalReplicationOnSourceDbEnum. KnownLogicalReplicationOnSourceDbEnum can be used interchangeably with LogicalReplicationOnSourceDbEnum, this enum contains the known values that the service supports. Known values supported by the service True False
LtrBackupOperationsGetResponse	Contains response data for the get operation.
LtrBackupOperationsListByServerNextResponse	Contains response data for the listByServerNext operation.
LtrBackupOperationsListByServerResponse	Contains response data for the listByServer operation.
MigrateRolesEnum	Defines values for MigrateRolesEnum. KnownMigrateRolesEnum can be used interchangeably with MigrateRolesEnum, this enum contains the known values that the service supports. Known values supported by the service True False
MigrationDbState	Defines values for MigrationDbState. KnownMigrationDbState can be used interchangeably with MigrationDbState, this enum contains the known values that the service supports. Known values supported by the service InProgress WaitingForCutoverTrigger Failed Canceled Succeeded Canceling
MigrationDetailsLevel	Defines values for MigrationDetailsLevel. KnownMigrationDetailsLevel can be used interchangeably with MigrationDetailsLevel, this enum contains the known values that the service supports. Known values supported by the service Default Summary Full
MigrationListFilter	Defines values for MigrationListFilter. KnownMigrationListFilter can be used interchangeably with MigrationListFilter, this enum contains the known values that the service supports. Known values supported by the service Active All
MigrationMode	Defines values for MigrationMode. KnownMigrationMode can be used interchangeably with MigrationMode, this enum contains the known values that the service supports. Known values supported by the service Offline Online
MigrationNameAvailabilityReason	Defines values for MigrationNameAvailabilityReason. KnownMigrationNameAvailabilityReason can be used interchangeably with MigrationNameAvailabilityReason, this enum contains the known values that the service supports. Known values supported by the service Invalid AlreadyExists
MigrationOption	Defines values for MigrationOption. KnownMigrationOption can be used interchangeably with MigrationOption, this enum contains the known values that the service supports. Known values supported by the service Validate Migrate ValidateAndMigrate
MigrationState	Defines values for MigrationState. KnownMigrationState can be used interchangeably with MigrationState, this enum contains the known values that the service supports. Known values supported by the service InProgress WaitingForUserAction Canceled Failed Succeeded ValidationFailed CleaningUp
MigrationSubState	Defines values for MigrationSubState. KnownMigrationSubState can be used interchangeably with MigrationSubState, this enum contains the known values that the service supports. Known values supported by the service PerformingPreRequisiteSteps WaitingForLogicalReplicationSetupRequestOnSourceDB WaitingForDBsToMigrateSpecification WaitingForTargetDBOverwriteConfirmation WaitingForDataMigrationScheduling WaitingForDataMigrationWindow MigratingData WaitingForCutoverTrigger CompletingMigration Completed CancelingRequestedDBMigrations ValidationInProgress
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.
OnlineResizeSupportedEnum	Defines values for OnlineResizeSupportedEnum. KnownOnlineResizeSupportedEnum can be used interchangeably with OnlineResizeSupportedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
OperationOrigin	Defines values for OperationOrigin. KnownOperationOrigin can be used interchangeably with OperationOrigin, this enum contains the known values that the service supports. Known values supported by the service NotSpecified user system
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service Full Customer On-Demand
OverwriteDbsInTargetEnum	Defines values for OverwriteDbsInTargetEnum. KnownOverwriteDbsInTargetEnum can be used interchangeably with OverwriteDbsInTargetEnum, this enum contains the known values that the service supports. Known values supported by the service True False
PasswordAuthEnum	Defines values for PasswordAuthEnum. KnownPasswordAuthEnum can be used interchangeably with PasswordAuthEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
PrincipalType	Defines values for PrincipalType. KnownPrincipalType can be used interchangeably with PrincipalType, this enum contains the known values that the service supports. Known values supported by the service Unknown User Group ServicePrincipal
PrivateEndpointConnectionDeleteResponse	Contains response data for the delete operation.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionUpdateResponse	Contains response data for the update 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.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByServerNextResponse	Contains response data for the listByServerNext operation.
PrivateLinkResourcesListByServerResponse	Contains response data for the listByServer operation.
ReadReplicaPromoteMode	Defines values for ReadReplicaPromoteMode. KnownReadReplicaPromoteMode can be used interchangeably with ReadReplicaPromoteMode, this enum contains the known values that the service supports. Known values supported by the service standalone switchover
ReplicasListByServerResponse	Contains response data for the listByServer operation.
ReplicationPromoteOption	Defines values for ReplicationPromoteOption. KnownReplicationPromoteOption can be used interchangeably with ReplicationPromoteOption, this enum contains the known values that the service supports. Known values supported by the service planned forced
ReplicationRole	Defines values for ReplicationRole. KnownReplicationRole can be used interchangeably with ReplicationRole, this enum contains the known values that the service supports. Known values supported by the service None Primary AsyncReplica GeoAsyncReplica
ReplicationState	Defines values for ReplicationState. KnownReplicationState can be used interchangeably with ReplicationState, this enum contains the known values that the service supports. Known values supported by the service Active Catchup Provisioning Updating Broken Reconfiguring
RestrictedEnum	Defines values for RestrictedEnum. KnownRestrictedEnum can be used interchangeably with RestrictedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ServerCapabilitiesListNextResponse	Contains response data for the listNext operation.
ServerCapabilitiesListResponse	Contains response data for the list operation.
ServerHAState	Defines values for ServerHAState. KnownServerHAState can be used interchangeably with ServerHAState, this enum contains the known values that the service supports. Known values supported by the service NotEnabled CreatingStandby ReplicatingData FailingOver Healthy RemovingStandby
ServerPublicNetworkAccessState	Defines values for ServerPublicNetworkAccessState. KnownServerPublicNetworkAccessState can be used interchangeably with ServerPublicNetworkAccessState, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ServerState	Defines values for ServerState. KnownServerState can be used interchangeably with ServerState, this enum contains the known values that the service supports. Known values supported by the service Ready Dropping Disabled Starting Stopping Stopped Updating
ServerThreatProtectionSettingsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ServerThreatProtectionSettingsGetResponse	Contains response data for the get operation.
ServerThreatProtectionSettingsListByServerNextResponse	Contains response data for the listByServerNext operation.
ServerThreatProtectionSettingsListByServerResponse	Contains response data for the listByServer operation.
ServerVersion	Defines values for ServerVersion. KnownServerVersion can be used interchangeably with ServerVersion, this enum contains the known values that the service supports. Known values supported by the service 16 15 14 13 12 11
ServersCreateResponse	Contains response data for the create 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.
ServersListNextResponse	Contains response data for the listNext operation.
ServersListResponse	Contains response data for the list operation.
ServersUpdateResponse	Contains response data for the update operation.
SkuTier	Defines values for SkuTier. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Burstable GeneralPurpose MemoryOptimized
SourceType	Defines values for SourceType. KnownSourceType can be used interchangeably with SourceType, this enum contains the known values that the service supports. Known values supported by the service OnPremises AWS GCP AzureVM PostgreSQLSingleServer AWS_RDS AWS_AURORA AWS_EC2 GCP_CloudSQL GCP_AlloyDB GCP_Compute EDB
SslMode	Defines values for SslMode. KnownSslMode can be used interchangeably with SslMode, this enum contains the known values that the service supports. Known values supported by the service Prefer Require VerifyCA VerifyFull
StartDataMigrationEnum	Defines values for StartDataMigrationEnum. KnownStartDataMigrationEnum can be used interchangeably with StartDataMigrationEnum, this enum contains the known values that the service supports. Known values supported by the service True False
StorageAutoGrow	Defines values for StorageAutoGrow. KnownStorageAutoGrow can be used interchangeably with StorageAutoGrow, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
StorageAutoGrowthSupportedEnum	Defines values for StorageAutoGrowthSupportedEnum. KnownStorageAutoGrowthSupportedEnum can be used interchangeably with StorageAutoGrowthSupportedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
StorageType	Defines values for StorageType. KnownStorageType can be used interchangeably with StorageType, this enum contains the known values that the service supports. Known values supported by the service Premium_LRS PremiumV2_LRS
ThreatProtectionName	Defines values for ThreatProtectionName. KnownThreatProtectionName can be used interchangeably with ThreatProtectionName, this enum contains the known values that the service supports. Known values supported by the service Default
ThreatProtectionState	Defines values for ThreatProtectionState.
TriggerCutoverEnum	Defines values for TriggerCutoverEnum. KnownTriggerCutoverEnum can be used interchangeably with TriggerCutoverEnum, this enum contains the known values that the service supports. Known values supported by the service True False
ValidationState	Defines values for ValidationState. KnownValidationState can be used interchangeably with ValidationState, this enum contains the known values that the service supports. Known values supported by the service Failed Succeeded Warning
VirtualEndpointType	Defines values for VirtualEndpointType. KnownVirtualEndpointType can be used interchangeably with VirtualEndpointType, this enum contains the known values that the service supports. Known values supported by the service ReadWrite
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.
VirtualNetworkSubnetUsageExecuteResponse	Contains response data for the execute operation.
ZoneRedundantHaAndGeoBackupSupportedEnum	Defines values for ZoneRedundantHaAndGeoBackupSupportedEnum. KnownZoneRedundantHaAndGeoBackupSupportedEnum can be used interchangeably with ZoneRedundantHaAndGeoBackupSupportedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ZoneRedundantHaSupportedEnum	Defines values for ZoneRedundantHaSupportedEnum. KnownZoneRedundantHaSupportedEnum can be used interchangeably with ZoneRedundantHaSupportedEnum, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled

Enums

KnownActiveDirectoryAuthEnum	Known values of ActiveDirectoryAuthEnum that the service accepts.
KnownArmServerKeyType	Known values of ArmServerKeyType that the service accepts.
KnownAzureManagedDiskPerformanceTiers	Known values of AzureManagedDiskPerformanceTiers that the service accepts.
KnownCancelEnum	Known values of CancelEnum that the service accepts.
KnownCheckNameAvailabilityReason	Known values of CheckNameAvailabilityReason that the service accepts.
KnownConfigurationDataType	Known values of ConfigurationDataType that the service accepts.
KnownCreateMode	Known values of CreateMode that the service accepts.
KnownCreateModeForUpdate	Known values of CreateModeForUpdate that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownExecutionStatus	Known values of ExecutionStatus that the service accepts.
KnownFailoverMode	Known values of FailoverMode that the service accepts.
KnownFastProvisioningSupportedEnum	Known values of FastProvisioningSupportedEnum that the service accepts.
KnownGeoBackupSupportedEnum	Known values of GeoBackupSupportedEnum that the service accepts.
KnownGeoRedundantBackupEnum	Known values of GeoRedundantBackupEnum that the service accepts.
KnownHaMode	Known values of HaMode that the service accepts.
KnownHighAvailabilityMode	Known values of HighAvailabilityMode that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownKeyStatusEnum	Known values of KeyStatusEnum that the service accepts.
KnownLogicalReplicationOnSourceDbEnum	Known values of LogicalReplicationOnSourceDbEnum that the service accepts.
KnownMigrateRolesEnum	Known values of MigrateRolesEnum that the service accepts.
KnownMigrationDbState	Known values of MigrationDbState that the service accepts.
KnownMigrationDetailsLevel	Known values of MigrationDetailsLevel that the service accepts.
KnownMigrationListFilter	Known values of MigrationListFilter that the service accepts.
KnownMigrationMode	Known values of MigrationMode that the service accepts.
KnownMigrationNameAvailabilityReason	Known values of MigrationNameAvailabilityReason that the service accepts.
KnownMigrationOption	Known values of MigrationOption that the service accepts.
KnownMigrationState	Known values of MigrationState that the service accepts.
KnownMigrationSubState	Known values of MigrationSubState that the service accepts.
KnownOnlineResizeSupportedEnum	Known values of OnlineResizeSupportedEnum that the service accepts.
KnownOperationOrigin	Known values of OperationOrigin that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownOverwriteDbsInTargetEnum	Known values of OverwriteDbsInTargetEnum that the service accepts.
KnownPasswordAuthEnum	Known values of PasswordAuthEnum that the service accepts.
KnownPrincipalType	Known values of PrincipalType that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownReadReplicaPromoteMode	Known values of ReadReplicaPromoteMode that the service accepts.
KnownReplicationPromoteOption	Known values of ReplicationPromoteOption that the service accepts.
KnownReplicationRole	Known values of ReplicationRole that the service accepts.
KnownReplicationState	Known values of ReplicationState that the service accepts.
KnownRestrictedEnum	Known values of RestrictedEnum that the service accepts.
KnownServerHAState	Known values of ServerHAState that the service accepts.
KnownServerPublicNetworkAccessState	Known values of ServerPublicNetworkAccessState that the service accepts.
KnownServerState	Known values of ServerState that the service accepts.
KnownServerVersion	Known values of ServerVersion that the service accepts.
KnownSkuTier	Known values of SkuTier that the service accepts.
KnownSourceType	Known values of SourceType that the service accepts.
KnownSslMode	Known values of SslMode that the service accepts.
KnownStartDataMigrationEnum	Known values of StartDataMigrationEnum that the service accepts.
KnownStorageAutoGrow	Known values of StorageAutoGrow that the service accepts.
KnownStorageAutoGrowthSupportedEnum	Known values of StorageAutoGrowthSupportedEnum that the service accepts.
KnownStorageType	Known values of StorageType that the service accepts.
KnownThreatProtectionName	Known values of ThreatProtectionName that the service accepts.
KnownTriggerCutoverEnum	Known values of TriggerCutoverEnum that the service accepts.
KnownValidationState	Known values of ValidationState that the service accepts.
KnownVirtualEndpointType	Known values of VirtualEndpointType that the service accepts.
KnownZoneRedundantHaAndGeoBackupSupportedEnum	Known values of ZoneRedundantHaAndGeoBackupSupportedEnum that the service accepts.
KnownZoneRedundantHaSupportedEnum	Known values of ZoneRedundantHaSupportedEnum that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.