Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Servers

Package version

Class representing a Servers.

Hierarchy

  • Servers

Index

Constructors

Methods

Constructors

constructor

Methods

beginCreate

  • beginCreate(resourceGroupName: string, serverName: string, parameters: ServerForCreate, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Creates a new server or updates an existing server. The update action will overwrite the existing 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: ServerForCreate

      The required parameters for creating or updating a server.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginDeleteMethod

  • beginDeleteMethod(resourceGroupName: string, serverName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • 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: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginRestart

  • beginRestart(resourceGroupName: string, serverName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Restarts 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: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

beginUpdate

  • beginUpdate(resourceGroupName: string, serverName: string, parameters: ServerUpdateParameters, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

  • Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

    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: ServerUpdateParameters

      The required parameters for updating a server.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRestAzure.LROPoller>

    Promise<msRestAzure.LROPoller>

create

  • create(resourceGroupName: string, serverName: string, parameters: ServerForCreate, options?: msRest.RequestOptionsBase): Promise<Models.ServersCreateResponse>

  • Creates a new server or updates an existing server. The update action will overwrite the existing 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: ServerForCreate

      The required parameters for creating or updating a server.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ServersCreateResponse>

    Promise<Models.ServersCreateResponse>

deleteMethod

  • deleteMethod(resourceGroupName: string, serverName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • 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: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

get

  • get(resourceGroupName: string, serverName: string, options?: msRest.RequestOptionsBase): Promise<Models.ServersGetResponse>
  • get(resourceGroupName: string, serverName: string, callback: msRest.ServiceCallback<Server>): void
  • get(resourceGroupName: string, serverName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Server>): void

  • Gets information about 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: msRest.RequestOptionsBase

    Returns Promise<Models.ServersGetResponse>

    Promise<Models.ServersGetResponse>

  • 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.

    • callback: msRest.ServiceCallback<Server>

      The callback

    Returns 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: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Server>

      The callback

    Returns void

list

  • list(options?: msRest.RequestOptionsBase): Promise<Models.ServersListResponse>
  • list(callback: msRest.ServiceCallback<ServerListResult>): void
  • list(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ServerListResult>): void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ServersListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ServerListResult>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ServerListResult>): void

  • List all the servers in a given resource group.

    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: msRest.RequestOptionsBase

    Returns Promise<Models.ServersListByResourceGroupResponse>

    Promise<Models.ServersListByResourceGroupResponse>

  • 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.

    • callback: msRest.ServiceCallback<ServerListResult>

      The callback

    Returns 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.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ServerListResult>

      The callback

    Returns void

restart

  • restart(resourceGroupName: string, serverName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

  • Restarts 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: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

update

  • update(resourceGroupName: string, serverName: string, parameters: ServerUpdateParameters, options?: msRest.RequestOptionsBase): Promise<Models.ServersUpdateResponse>

  • Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.

    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: ServerUpdateParameters

      The required parameters for updating a server.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ServersUpdateResponse>

    Promise<Models.ServersUpdateResponse>

Generated using TypeDoc