ServersOperations interface

Interface representing a Servers operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginMigrateNetworkMode
beginMigrateNetworkModeAndWait
beginRestart
beginRestartAndWait
beginStart
beginStartAndWait
beginStartMajorVersionUpgradePrecheck
beginStartMajorVersionUpgradePrecheckAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate

Creates a new server.

delete

Deletes or drops an existing server.

get

Gets information about an existing server.

listByResourceGroup

Lists all servers in a resource group.

listBySubscription

Lists all servers in a subscription.

migrateNetworkMode

Migrates an Azure Database for PostgreSQL server from VNet integration to a Private Link network model.

restart

Restarts PostgreSQL database engine in a server.

start

Starts a stopped server.

startMajorVersionUpgradePrecheck

Start Major Version Upgrade Prechecks.

stop

Stops a server.

update

Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

Property Value

(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams) => Promise<Server>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => Promise<void>

beginMigrateNetworkMode

Warning

This API is now deprecated.

use migrateNetworkMode instead

beginMigrateNetworkMode: (resourceGroupName: string, serverName: string, options?: ServersMigrateNetworkModeOptionalParams) => Promise<SimplePollerLike<OperationState<MigrateNetworkStatus>, MigrateNetworkStatus>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersMigrateNetworkModeOptionalParams) => Promise<SimplePollerLike<OperationState<MigrateNetworkStatus>, MigrateNetworkStatus>>

beginMigrateNetworkModeAndWait

Warning

This API is now deprecated.

use migrateNetworkMode instead

beginMigrateNetworkModeAndWait: (resourceGroupName: string, serverName: string, options?: ServersMigrateNetworkModeOptionalParams) => Promise<MigrateNetworkStatus>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersMigrateNetworkModeOptionalParams) => Promise<MigrateNetworkStatus>

beginRestart

Warning

This API is now deprecated.

use restart instead

beginRestart: (resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

beginRestartAndWait: (resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => Promise<void>

beginStartMajorVersionUpgradePrecheck

Warning

This API is now deprecated.

use startMajorVersionUpgradePrecheck instead

beginStartMajorVersionUpgradePrecheck: (resourceGroupName: string, serverName: string, body: StartMajorVersionUpgradePrecheckRequest, options?: ServersStartMajorVersionUpgradePrecheckOptionalParams) => Promise<SimplePollerLike<OperationState<StartMajorVersionUpgradePrecheckResponse>, StartMajorVersionUpgradePrecheckResponse>>

Property Value

(resourceGroupName: string, serverName: string, body: StartMajorVersionUpgradePrecheckRequest, options?: ServersStartMajorVersionUpgradePrecheckOptionalParams) => Promise<SimplePollerLike<OperationState<StartMajorVersionUpgradePrecheckResponse>, StartMajorVersionUpgradePrecheckResponse>>

beginStartMajorVersionUpgradePrecheckAndWait

Warning

This API is now deprecated.

use startMajorVersionUpgradePrecheck instead

beginStartMajorVersionUpgradePrecheckAndWait: (resourceGroupName: string, serverName: string, body: StartMajorVersionUpgradePrecheckRequest, options?: ServersStartMajorVersionUpgradePrecheckOptionalParams) => Promise<StartMajorVersionUpgradePrecheckResponse>

Property Value

(resourceGroupName: string, serverName: string, body: StartMajorVersionUpgradePrecheckRequest, options?: ServersStartMajorVersionUpgradePrecheckOptionalParams) => Promise<StartMajorVersionUpgradePrecheckResponse>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Server>, Server>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams) => Promise<Server>

createOrUpdate

Creates a new server.

createOrUpdate: (resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Server>, Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams) => PollerLike<OperationState<Server>, Server>

delete

Deletes or drops an existing server.

delete: (resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets information about an existing server.

get: (resourceGroupName: string, serverName: string, options?: ServersGetOptionalParams) => Promise<Server>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersGetOptionalParams) => Promise<Server>

listByResourceGroup

Lists all servers in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

Property Value

(resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

listBySubscription

Lists all servers in a subscription.

listBySubscription: (options?: ServersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

Property Value

(options?: ServersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Server, Server[], PageSettings>

migrateNetworkMode

Migrates an Azure Database for PostgreSQL server from VNet integration to a Private Link network model.

migrateNetworkMode: (resourceGroupName: string, serverName: string, options?: ServersMigrateNetworkModeOptionalParams) => PollerLike<OperationState<MigrateNetworkStatus>, MigrateNetworkStatus>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersMigrateNetworkModeOptionalParams) => PollerLike<OperationState<MigrateNetworkStatus>, MigrateNetworkStatus>

restart

Restarts PostgreSQL database engine in a server.

restart: (resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams) => PollerLike<OperationState<void>, void>

start

Starts a stopped server.

start: (resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams) => PollerLike<OperationState<void>, void>

startMajorVersionUpgradePrecheck

Start Major Version Upgrade Prechecks.

startMajorVersionUpgradePrecheck: (resourceGroupName: string, serverName: string, body: StartMajorVersionUpgradePrecheckRequest, options?: ServersStartMajorVersionUpgradePrecheckOptionalParams) => PollerLike<OperationState<StartMajorVersionUpgradePrecheckResponse>, StartMajorVersionUpgradePrecheckResponse>

Property Value

(resourceGroupName: string, serverName: string, body: StartMajorVersionUpgradePrecheckRequest, options?: ServersStartMajorVersionUpgradePrecheckOptionalParams) => PollerLike<OperationState<StartMajorVersionUpgradePrecheckResponse>, StartMajorVersionUpgradePrecheckResponse>

stop

Stops a server.

stop: (resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams) => PollerLike<OperationState<void>, void>

update

Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.

update: (resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams) => PollerLike<OperationState<Server>, Server>

Property Value

(resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams) => PollerLike<OperationState<Server>, Server>