Servers interface
Interface representing a Servers.
Methods
Method Details
beginCreateOrUpdate(string, string, Server, ServersCreateOrUpdateOptionalParams)
Creates a new server.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Server>, Server>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- Server
Parameters required to create a new server or to update an existing server.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Server>, Server>>
beginCreateOrUpdateAndWait(string, string, Server, ServersCreateOrUpdateOptionalParams)
Creates a new server.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams): Promise<Server>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- Server
Parameters required to create a new server or to update an existing server.
The options parameters.
Returns
Promise<Server>
beginDelete(string, string, ServersDeleteOptionalParams)
Deletes or drops an existing server.
function beginDelete(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ServersDeleteHeaders>, ServersDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServersDeleteHeaders>, ServersDeleteHeaders>>
beginDeleteAndWait(string, string, ServersDeleteOptionalParams)
Deletes or drops an existing server.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<ServersDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersDeleteOptionalParams
The options parameters.
Returns
Promise<ServersDeleteHeaders>
beginRestart(string, string, ServersRestartOptionalParams)
Restarts PostgreSQL database engine in a server.
function beginRestart(resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams): Promise<SimplePollerLike<OperationState<ServersRestartHeaders>, ServersRestartHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersRestartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServersRestartHeaders>, ServersRestartHeaders>>
beginRestartAndWait(string, string, ServersRestartOptionalParams)
Restarts PostgreSQL database engine in a server.
function beginRestartAndWait(resourceGroupName: string, serverName: string, options?: ServersRestartOptionalParams): Promise<ServersRestartHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersRestartOptionalParams
The options parameters.
Returns
Promise<ServersRestartHeaders>
beginStart(string, string, ServersStartOptionalParams)
Starts a stopped server.
function beginStart(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams): Promise<SimplePollerLike<OperationState<ServersStartHeaders>, ServersStartHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersStartOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServersStartHeaders>, ServersStartHeaders>>
beginStartAndWait(string, string, ServersStartOptionalParams)
Starts a stopped server.
function beginStartAndWait(resourceGroupName: string, serverName: string, options?: ServersStartOptionalParams): Promise<ServersStartHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersStartOptionalParams
The options parameters.
Returns
Promise<ServersStartHeaders>
beginStop(string, string, ServersStopOptionalParams)
Stops a server.
function beginStop(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams): Promise<SimplePollerLike<OperationState<ServersStopHeaders>, ServersStopHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersStopOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServersStopHeaders>, ServersStopHeaders>>
beginStopAndWait(string, string, ServersStopOptionalParams)
Stops a server.
function beginStopAndWait(resourceGroupName: string, serverName: string, options?: ServersStopOptionalParams): Promise<ServersStopHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersStopOptionalParams
The options parameters.
Returns
Promise<ServersStopHeaders>
beginUpdate(string, string, ServerForPatch, ServersUpdateOptionalParams)
Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.
function beginUpdate(resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Server>, Server>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- ServerForPatch
Parameters required to update a server.
- options
- ServersUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Server>, Server>>
beginUpdateAndWait(string, string, ServerForPatch, ServersUpdateOptionalParams)
Updates an existing server. The request body can contain one or multiple of the properties present in the normal server definition.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, parameters: ServerForPatch, options?: ServersUpdateOptionalParams): Promise<Server>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- ServerForPatch
Parameters required to update a server.
- options
- ServersUpdateOptionalParams
The options parameters.
Returns
Promise<Server>
get(string, string, ServersGetOptionalParams)
Gets information about an existing server.
function get(resourceGroupName: string, serverName: string, options?: ServersGetOptionalParams): Promise<Server>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- options
- ServersGetOptionalParams
The options parameters.
Returns
Promise<Server>
listByResourceGroup(string, ServersListByResourceGroupOptionalParams)
Lists all servers in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Server, Server[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(ServersListBySubscriptionOptionalParams)
Lists all servers in a subscription.
function listBySubscription(options?: ServersListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Server, Server[], PageSettings>Parameters
The options parameters.