ElasticPools class

Class representing a ElasticPools.

Constructors

ElasticPools(SqlManagementClientContext)

Create a ElasticPools.

Methods

beginCreateOrUpdate(string, string, string, ElasticPool, msRest.RequestOptionsBase)

Creates or updates an elastic pool.

beginDeleteMethod(string, string, string, msRest.RequestOptionsBase)

Deletes an elastic pool.

beginFailover(string, string, string, msRest.RequestOptionsBase)

Failovers an elastic pool.

beginUpdate(string, string, string, ElasticPoolUpdate, msRest.RequestOptionsBase)

Updates an elastic pool.

createOrUpdate(string, string, string, ElasticPool, msRest.RequestOptionsBase)

Creates or updates an elastic pool.

deleteMethod(string, string, string, msRest.RequestOptionsBase)

Deletes an elastic pool.

failover(string, string, string, msRest.RequestOptionsBase)

Failovers an elastic pool.

get(string, string, string, msRest.RequestOptionsBase)

Gets an elastic pool.

get(string, string, string, RequestOptionsBase, ServiceCallback<ElasticPool>)
get(string, string, string, ServiceCallback<ElasticPool>)
listByServer(string, string, ElasticPoolsListByServerOptionalParams, ServiceCallback<ElasticPoolListResult>)
listByServer(string, string, Models.ElasticPoolsListByServerOptionalParams)

Gets all elastic pools in a server.

listByServer(string, string, ServiceCallback<ElasticPoolListResult>)
listByServerNext(string, msRest.RequestOptionsBase)

Gets all elastic pools in a server.

listByServerNext(string, RequestOptionsBase, ServiceCallback<ElasticPoolListResult>)
listByServerNext(string, ServiceCallback<ElasticPoolListResult>)
listMetricDefinitions(string, string, string, msRest.RequestOptionsBase)

Returns elastic pool metric definitions.

listMetricDefinitions(string, string, string, RequestOptionsBase, ServiceCallback<MetricDefinitionListResult>)
listMetricDefinitions(string, string, string, ServiceCallback<MetricDefinitionListResult>)
listMetrics(string, string, string, string, msRest.RequestOptionsBase)

Returns elastic pool metrics.

listMetrics(string, string, string, string, RequestOptionsBase, ServiceCallback<MetricListResult>)
listMetrics(string, string, string, string, ServiceCallback<MetricListResult>)
update(string, string, string, ElasticPoolUpdate, msRest.RequestOptionsBase)

Updates an elastic pool.

Constructor Details

ElasticPools(SqlManagementClientContext)

Create a ElasticPools.

new ElasticPools(client: SqlManagementClientContext)

Parameters

client
SqlManagementClientContext

Reference to the service client.

Method Details

beginCreateOrUpdate(string, string, string, ElasticPool, msRest.RequestOptionsBase)

Creates or updates an elastic pool.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPool, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

parameters
ElasticPool

The elastic pool parameters.

options
msRest.RequestOptionsBase

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod(string, string, string, msRest.RequestOptionsBase)

Deletes an elastic pool.

function beginDeleteMethod(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

options
msRest.RequestOptionsBase

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

beginFailover(string, string, string, msRest.RequestOptionsBase)

Failovers an elastic pool.

function beginFailover(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool to failover.

options
msRest.RequestOptionsBase

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdate(string, string, string, ElasticPoolUpdate, msRest.RequestOptionsBase)

Updates an elastic pool.

function beginUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

parameters
ElasticPoolUpdate

The elastic pool update parameters.

options
msRest.RequestOptionsBase

Returns

Promise<LROPoller>

Promise<msRestAzure.LROPoller>

createOrUpdate(string, string, string, ElasticPool, msRest.RequestOptionsBase)

Creates or updates an elastic pool.

function createOrUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPool, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

parameters
ElasticPool

The elastic pool parameters.

options
msRest.RequestOptionsBase

Returns

Promise<Models.ElasticPoolsCreateOrUpdateResponse>

Promise<Models.ElasticPoolsCreateOrUpdateResponse>

deleteMethod(string, string, string, msRest.RequestOptionsBase)

Deletes an elastic pool.

function deleteMethod(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

options
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

failover(string, string, string, msRest.RequestOptionsBase)

Failovers an elastic pool.

function failover(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool to failover.

options
msRest.RequestOptionsBase

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

get(string, string, string, msRest.RequestOptionsBase)

Gets an elastic pool.

function get(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

options
msRest.RequestOptionsBase

Returns

Promise<Models.ElasticPoolsGetResponse>

Promise<Models.ElasticPoolsGetResponse>

get(string, string, string, RequestOptionsBase, ServiceCallback<ElasticPool>)

function get(resourceGroupName: string, serverName: string, elasticPoolName: string, options: RequestOptionsBase, callback: ServiceCallback<ElasticPool>)

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.

elasticPoolName

string

The name of the elastic pool.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ElasticPool>

The callback

get(string, string, string, ServiceCallback<ElasticPool>)

function get(resourceGroupName: string, serverName: string, elasticPoolName: string, callback: ServiceCallback<ElasticPool>)

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.

elasticPoolName

string

The name of the elastic pool.

callback

ServiceCallback<ElasticPool>

The callback

listByServer(string, string, ElasticPoolsListByServerOptionalParams, ServiceCallback<ElasticPoolListResult>)

function listByServer(resourceGroupName: string, serverName: string, options: ElasticPoolsListByServerOptionalParams, callback: ServiceCallback<ElasticPoolListResult>)

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
ElasticPoolsListByServerOptionalParams

The optional parameters

callback

ServiceCallback<ElasticPoolListResult>

The callback

listByServer(string, string, Models.ElasticPoolsListByServerOptionalParams)

Gets all elastic pools in a server.

function listByServer(resourceGroupName: string, serverName: string, options?: Models.ElasticPoolsListByServerOptionalParams)

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
Models.ElasticPoolsListByServerOptionalParams

Returns

Promise<Models.ElasticPoolsListByServerResponse>

Promise<Models.ElasticPoolsListByServerResponse>

listByServer(string, string, ServiceCallback<ElasticPoolListResult>)

function listByServer(resourceGroupName: string, serverName: string, callback: ServiceCallback<ElasticPoolListResult>)

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

ServiceCallback<ElasticPoolListResult>

The callback

listByServerNext(string, msRest.RequestOptionsBase)

Gets all elastic pools in a server.

function listByServerNext(nextPageLink: string, options?: msRest.RequestOptionsBase)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
msRest.RequestOptionsBase

Returns

Promise<Models.ElasticPoolsListByServerNextResponse>

Promise<Models.ElasticPoolsListByServerNextResponse>

listByServerNext(string, RequestOptionsBase, ServiceCallback<ElasticPoolListResult>)

function listByServerNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ElasticPoolListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<ElasticPoolListResult>

The callback

listByServerNext(string, ServiceCallback<ElasticPoolListResult>)

function listByServerNext(nextPageLink: string, callback: ServiceCallback<ElasticPoolListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<ElasticPoolListResult>

The callback

listMetricDefinitions(string, string, string, msRest.RequestOptionsBase)

Returns elastic pool metric definitions.

function listMetricDefinitions(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

options
msRest.RequestOptionsBase

Returns

Promise<Models.ElasticPoolsListMetricDefinitionsResponse>

Promise<Models.ElasticPoolsListMetricDefinitionsResponse>

listMetricDefinitions(string, string, string, RequestOptionsBase, ServiceCallback<MetricDefinitionListResult>)

function listMetricDefinitions(resourceGroupName: string, serverName: string, elasticPoolName: string, options: RequestOptionsBase, callback: ServiceCallback<MetricDefinitionListResult>)

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.

elasticPoolName

string

The name of the elastic pool.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<MetricDefinitionListResult>

The callback

listMetricDefinitions(string, string, string, ServiceCallback<MetricDefinitionListResult>)

function listMetricDefinitions(resourceGroupName: string, serverName: string, elasticPoolName: string, callback: ServiceCallback<MetricDefinitionListResult>)

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.

elasticPoolName

string

The name of the elastic pool.

callback

ServiceCallback<MetricDefinitionListResult>

The callback

listMetrics(string, string, string, string, msRest.RequestOptionsBase)

Returns elastic pool metrics.

function listMetrics(resourceGroupName: string, serverName: string, elasticPoolName: string, filter: string, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

filter

string

An OData filter expression that describes a subset of metrics to return.

options
msRest.RequestOptionsBase

Returns

Promise<Models.ElasticPoolsListMetricsResponse>

Promise<Models.ElasticPoolsListMetricsResponse>

listMetrics(string, string, string, string, RequestOptionsBase, ServiceCallback<MetricListResult>)

function listMetrics(resourceGroupName: string, serverName: string, elasticPoolName: string, filter: string, options: RequestOptionsBase, callback: ServiceCallback<MetricListResult>)

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.

elasticPoolName

string

The name of the elastic pool.

filter

string

An OData filter expression that describes a subset of metrics to return.

options

RequestOptionsBase

The optional parameters

callback

ServiceCallback<MetricListResult>

The callback

listMetrics(string, string, string, string, ServiceCallback<MetricListResult>)

function listMetrics(resourceGroupName: string, serverName: string, elasticPoolName: string, filter: string, callback: ServiceCallback<MetricListResult>)

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.

elasticPoolName

string

The name of the elastic pool.

filter

string

An OData filter expression that describes a subset of metrics to return.

callback

ServiceCallback<MetricListResult>

The callback

update(string, string, string, ElasticPoolUpdate, msRest.RequestOptionsBase)

Updates an elastic pool.

function update(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: msRest.RequestOptionsBase)

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.

elasticPoolName

string

The name of the elastic pool.

parameters
ElasticPoolUpdate

The elastic pool update parameters.

options
msRest.RequestOptionsBase

Returns

Promise<Models.ElasticPoolsUpdateResponse>

Promise<Models.ElasticPoolsUpdateResponse>