Package version:

Interface Servers

Interface representing a Servers.

Hierarchy

Servers

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginImportDatabase beginImportDatabaseAndWait beginRefreshStatus beginRefreshStatusAndWait beginUpdate beginUpdateAndWait checkNameAvailability get list listByResourceGroup

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Server>, Server>>
Creates or updates a 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.
- Optional options: ServersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Server>, Server>>
- Defined in operationsInterfaces/servers.ts:80

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, parameters: Server, options?: ServersCreateOrUpdateOptionalParams): Promise<Server>
Creates or updates a 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.
- Optional options: ServersCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Server>
- Defined in operationsInterfaces/servers.ts:99

beginDelete

beginDelete(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes a 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.
- Optional options: ServersDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/servers.ts:112

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<void>
Deletes a 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.
- Optional options: ServersDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/servers.ts:124

beginImportDatabase

beginImportDatabase(resourceGroupName: string, serverName: string, parameters: ImportNewDatabaseDefinition, options?: ServersImportDatabaseOptionalParams): Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
Imports a bacpac into a new database.
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.
- Optional options: ServersImportDatabaseOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ImportExportOperationResult>, ImportExportOperationResult>>
- Defined in operationsInterfaces/servers.ts:170

beginImportDatabaseAndWait

beginImportDatabaseAndWait(resourceGroupName: string, serverName: string, parameters: ImportNewDatabaseDefinition, options?: ServersImportDatabaseOptionalParams): Promise<ImportExportOperationResult>
Imports a bacpac into a new database.
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.
- Optional options: ServersImportDatabaseOptionalParams
  
  The options parameters.
Returns Promise<ImportExportOperationResult>
- Defined in operationsInterfaces/servers.ts:189

beginRefreshStatus

beginRefreshStatus(resourceGroupName: string, serverName: string, options?: ServersRefreshStatusOptionalParams): Promise<SimplePollerLike<OperationState<RefreshExternalGovernanceStatusOperationResult>, RefreshExternalGovernanceStatusOperationResult>>
Refresh external governance enablement status.
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.
- Optional options: ServersRefreshStatusOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<RefreshExternalGovernanceStatusOperationResult>, RefreshExternalGovernanceStatusOperationResult>>
- Defined in operationsInterfaces/servers.ts:202

beginRefreshStatusAndWait

beginRefreshStatusAndWait(resourceGroupName: string, serverName: string, options?: ServersRefreshStatusOptionalParams): Promise<RefreshExternalGovernanceStatusOperationResult>
Refresh external governance enablement status.
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.
- Optional options: ServersRefreshStatusOptionalParams
  
  The options parameters.
Returns Promise<RefreshExternalGovernanceStatusOperationResult>
- Defined in operationsInterfaces/servers.ts:219

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, parameters: ServerUpdate, options?: ServersUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Server>, Server>>
Updates a 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.
- Optional options: ServersUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<Server>, Server>>
- Defined in operationsInterfaces/servers.ts:137

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, parameters: ServerUpdate, options?: ServersUpdateOptionalParams): Promise<Server>
Updates a 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.
- Optional options: ServersUpdateOptionalParams
  
  The options parameters.
Returns Promise<Server>
- Defined in operationsInterfaces/servers.ts:156

checkNameAvailability

checkNameAvailability(parameters: CheckNameAvailabilityRequest, options?: ServersCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityResponse>
Determines whether a resource can be created with the specified name.
Parameters
- parameters: CheckNameAvailabilityRequest
  
  The name availability request parameters.
- Optional options: ServersCheckNameAvailabilityOptionalParams
  
  The options parameters.
Returns Promise<CheckNameAvailabilityResponse>
- Defined in operationsInterfaces/servers.ts:56

get

get(resourceGroupName: string, serverName: string, options?: ServersGetOptionalParams): Promise<Server>
Gets a 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.
- Optional options: ServersGetOptionalParams
  
  The options parameters.
Returns Promise<Server>
- Defined in operationsInterfaces/servers.ts:67

list

list(options?: ServersListOptionalParams): PagedAsyncIterableIterator<Server>
Gets a list of all servers in the subscription.
Parameters
- Optional options: ServersListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Server>
- Defined in operationsInterfaces/servers.ts:40

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Server>
Gets a list of servers in a resource groups.
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.
- Optional options: ServersListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Server>
- Defined in operationsInterfaces/servers.ts:47

Interface Servers

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

parameters: Server

Optional options: ServersCreateOrUpdateOptionalParams

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

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

parameters: Server

Optional options: ServersCreateOrUpdateOptionalParams

Returns Promise<Server>

beginDelete

Parameters

resourceGroupName: string

serverName: string

Optional options: ServersDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

Optional options: ServersDeleteOptionalParams

Returns Promise<void>

beginImportDatabase

Parameters

resourceGroupName: string

serverName: string

parameters: ImportNewDatabaseDefinition

Optional options: ServersImportDatabaseOptionalParams

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

beginImportDatabaseAndWait

Parameters

resourceGroupName: string

serverName: string

parameters: ImportNewDatabaseDefinition

Optional options: ServersImportDatabaseOptionalParams

Returns Promise<ImportExportOperationResult>

beginRefreshStatus

Parameters

resourceGroupName: string

serverName: string

Optional options: ServersRefreshStatusOptionalParams

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

beginRefreshStatusAndWait

Parameters

resourceGroupName: string

serverName: string

Optional options: ServersRefreshStatusOptionalParams

Returns Promise<RefreshExternalGovernanceStatusOperationResult>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

parameters: ServerUpdate

Optional options: ServersUpdateOptionalParams

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

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

parameters: ServerUpdate

Optional options: ServersUpdateOptionalParams

Returns Promise<Server>

checkNameAvailability

Parameters

parameters: CheckNameAvailabilityRequest

Optional options: ServersCheckNameAvailabilityOptionalParams

Returns Promise<CheckNameAvailabilityResponse>

get

Parameters

resourceGroupName: string

serverName: string

`Optional` options: ServersCreateOrUpdateOptionalParams

`Optional` options: ServersCreateOrUpdateOptionalParams

`Optional` options: ServersDeleteOptionalParams

`Optional` options: ServersDeleteOptionalParams

`Optional` options: ServersImportDatabaseOptionalParams

`Optional` options: ServersImportDatabaseOptionalParams

`Optional` options: ServersRefreshStatusOptionalParams

`Optional` options: ServersRefreshStatusOptionalParams

`Optional` options: ServersUpdateOptionalParams

`Optional` options: ServersUpdateOptionalParams

`Optional` options: ServersCheckNameAvailabilityOptionalParams

`Optional` options: ServersGetOptionalParams

`Optional` options: ServersListOptionalParams

`Optional` options: ServersListByResourceGroupOptionalParams