Servers interface

Package:

@azure/arm-sql

Interface representing a Servers.

Methods

beginCreateOrUpdate(string, string, Server, ServersCreateOrUpdateOptionalParams)	Creates or updates a server.
beginCreateOrUpdateAndWait(string, string, Server, ServersCreateOrUpdateOptionalParams)	Creates or updates a server.
beginDelete(string, string, ServersDeleteOptionalParams)	Deletes a server.
beginDeleteAndWait(string, string, ServersDeleteOptionalParams)	Deletes a server.
beginImportDatabase(string, string, ImportNewDatabaseDefinition, ServersImportDatabaseOptionalParams)	Imports a bacpac into a new database.
beginImportDatabaseAndWait(string, string, ImportNewDatabaseDefinition, ServersImportDatabaseOptionalParams)	Imports a bacpac into a new database.
beginRefreshStatus(string, string, ServersRefreshStatusOptionalParams)	Refresh external governance enablement status.
beginRefreshStatusAndWait(string, string, ServersRefreshStatusOptionalParams)	Refresh external governance enablement status.
beginUpdate(string, string, ServerUpdate, ServersUpdateOptionalParams)	Updates a server.
beginUpdateAndWait(string, string, ServerUpdate, ServersUpdateOptionalParams)	Updates a server.
checkNameAvailability(CheckNameAvailabilityRequest, ServersCheckNameAvailabilityOptionalParams)	Determines whether a resource can be created with the specified name.
get(string, string, ServersGetOptionalParams)	Gets a server.
list(ServersListOptionalParams)	Gets a list of all servers in the subscription.
listByResourceGroup(string, ServersListByResourceGroupOptionalParams)	Gets a list of servers in a resource groups.

Method Details

beginCreateOrUpdate(string, string, Server, ServersCreateOrUpdateOptionalParams)

Creates or updates a 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 that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

Server

The requested server resource state.

options

ServersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Server>, Server>>

beginCreateOrUpdateAndWait(string, string, Server, ServersCreateOrUpdateOptionalParams)

Creates or updates a server.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

Server

The requested server resource state.

options

ServersCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Server>

beginDelete(string, string, ServersDeleteOptionalParams)

Deletes a server.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

ServersDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, ServersDeleteOptionalParams)

Deletes a server.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

ServersDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginImportDatabase(string, string, ImportNewDatabaseDefinition, ServersImportDatabaseOptionalParams)

Imports a bacpac into a new database.

function beginImportDatabase(resourceGroupName: string, serverName: string, parameters: ImportNewDatabaseDefinition, options?: ServersImportDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

ImportNewDatabaseDefinition

The database import request parameters.

options

ServersImportDatabaseOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>

beginImportDatabaseAndWait(string, string, ImportNewDatabaseDefinition, ServersImportDatabaseOptionalParams)

Imports a bacpac into a new database.

function beginImportDatabaseAndWait(resourceGroupName: string, serverName: string, parameters: ImportNewDatabaseDefinition, options?: ServersImportDatabaseOptionalParams): Promise<ImportExportOperationResult>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

ImportNewDatabaseDefinition

The database import request parameters.

options

ServersImportDatabaseOptionalParams

The options parameters.

Returns

Promise<ImportExportOperationResult>

beginRefreshStatus(string, string, ServersRefreshStatusOptionalParams)

Refresh external governance enablement status.

function beginRefreshStatus(resourceGroupName: string, serverName: string, options?: ServersRefreshStatusOptionalParams): Promise<SimplePollerLike<OperationState<RefreshExternalGovernanceStatusOperationResult>, RefreshExternalGovernanceStatusOperationResult>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

ServersRefreshStatusOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<RefreshExternalGovernanceStatusOperationResult>, RefreshExternalGovernanceStatusOperationResult>>

beginRefreshStatusAndWait(string, string, ServersRefreshStatusOptionalParams)

Refresh external governance enablement status.

function beginRefreshStatusAndWait(resourceGroupName: string, serverName: string, options?: ServersRefreshStatusOptionalParams): Promise<RefreshExternalGovernanceStatusOperationResult>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

ServersRefreshStatusOptionalParams

The options parameters.

Returns

Promise<RefreshExternalGovernanceStatusOperationResult>

beginUpdate(string, string, ServerUpdate, ServersUpdateOptionalParams)

Updates a server.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

ServerUpdate

The requested server resource state.

options

ServersUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Server>, Server>>

beginUpdateAndWait(string, string, ServerUpdate, ServersUpdateOptionalParams)

Updates a server.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

parameters

ServerUpdate

The requested server resource state.

options

ServersUpdateOptionalParams

The options parameters.

Returns

Promise<Server>

checkNameAvailability(CheckNameAvailabilityRequest, ServersCheckNameAvailabilityOptionalParams)

Determines whether a resource can be created with the specified name.

function checkNameAvailability(parameters: CheckNameAvailabilityRequest, options?: ServersCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>

Parameters

parameters

CheckNameAvailabilityRequest

The name availability request parameters.

options

ServersCheckNameAvailabilityOptionalParams

The options parameters.

Returns

Promise<CheckNameAvailabilityResponse>

get(string, string, ServersGetOptionalParams)

Gets a server.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName

string

The name of the server.

options

ServersGetOptionalParams

The options parameters.

Returns

Promise<Server>

list(ServersListOptionalParams)

Gets a list of all servers in the subscription.

function list(options?: ServersListOptionalParams): PagedAsyncIterableIterator<Server, Server[], PageSettings>

Parameters

options

ServersListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Server, Server[], PageSettings>

listByResourceGroup(string, ServersListByResourceGroupOptionalParams)

Gets a list of servers in a resource groups.

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

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

options

ServersListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Server, Server[], PageSettings>