ElasticPools interface

Interface representing a ElasticPools.

Methods

beginCreateOrUpdate(string, string, string, ElasticPool, ElasticPoolsCreateOrUpdateOptionalParams)

Creates or updates an elastic pool.

beginCreateOrUpdateAndWait(string, string, string, ElasticPool, ElasticPoolsCreateOrUpdateOptionalParams)

Creates or updates an elastic pool.

beginDelete(string, string, string, ElasticPoolsDeleteOptionalParams)

Deletes an elastic pool.

beginDeleteAndWait(string, string, string, ElasticPoolsDeleteOptionalParams)

Deletes an elastic pool.

beginFailover(string, string, string, ElasticPoolsFailoverOptionalParams)

Failovers an elastic pool.

beginFailoverAndWait(string, string, string, ElasticPoolsFailoverOptionalParams)

Failovers an elastic pool.

beginUpdate(string, string, string, ElasticPoolUpdate, ElasticPoolsUpdateOptionalParams)

Updates an elastic pool.

beginUpdateAndWait(string, string, string, ElasticPoolUpdate, ElasticPoolsUpdateOptionalParams)

Updates an elastic pool.

get(string, string, string, ElasticPoolsGetOptionalParams)

Gets an elastic pool.

listByServer(string, string, ElasticPoolsListByServerOptionalParams)

Gets all elastic pools in a server.

listMetricDefinitions(string, string, string, ElasticPoolsListMetricDefinitionsOptionalParams)

Returns elastic pool metric definitions.

listMetrics(string, string, string, string, ElasticPoolsListMetricsOptionalParams)

Returns elastic pool metrics.

Method Details

beginCreateOrUpdate(string, string, string, ElasticPool, ElasticPoolsCreateOrUpdateOptionalParams)

Creates or updates an elastic pool.

function beginCreateOrUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPool, options?: ElasticPoolsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ElasticPoolsCreateOrUpdateResponse>, ElasticPoolsCreateOrUpdateResponse>>

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
ElasticPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginCreateOrUpdateAndWait(string, string, string, ElasticPool, ElasticPoolsCreateOrUpdateOptionalParams)

Creates or updates an elastic pool.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPool, options?: ElasticPoolsCreateOrUpdateOptionalParams): Promise<ElasticPoolsCreateOrUpdateResponse>

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
ElasticPoolsCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, string, ElasticPoolsDeleteOptionalParams)

Deletes an elastic pool.

function beginDelete(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsDeleteOptionalParams): Promise<PollerLike<PollOperationState<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.

elasticPoolName

string

The name of the elastic pool.

options
ElasticPoolsDeleteOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait(string, string, string, ElasticPoolsDeleteOptionalParams)

Deletes an elastic pool.

function beginDeleteAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsDeleteOptionalParams): 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.

elasticPoolName

string

The name of the elastic pool.

options
ElasticPoolsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, string, ElasticPoolsFailoverOptionalParams)

Failovers an elastic pool.

function beginFailover(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsFailoverOptionalParams): Promise<PollerLike<PollOperationState<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.

elasticPoolName

string

The name of the elastic pool to failover.

options
ElasticPoolsFailoverOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginFailoverAndWait(string, string, string, ElasticPoolsFailoverOptionalParams)

Failovers an elastic pool.

function beginFailoverAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsFailoverOptionalParams): 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.

elasticPoolName

string

The name of the elastic pool to failover.

options
ElasticPoolsFailoverOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, ElasticPoolUpdate, ElasticPoolsUpdateOptionalParams)

Updates an elastic pool.

function beginUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: ElasticPoolsUpdateOptionalParams): Promise<PollerLike<PollOperationState<ElasticPoolsUpdateResponse>, ElasticPoolsUpdateResponse>>

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
ElasticPoolsUpdateOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<ElasticPoolsUpdateResponse>, ElasticPoolsUpdateResponse>>

beginUpdateAndWait(string, string, string, ElasticPoolUpdate, ElasticPoolsUpdateOptionalParams)

Updates an elastic pool.

function beginUpdateAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: ElasticPoolsUpdateOptionalParams): Promise<ElasticPoolsUpdateResponse>

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
ElasticPoolsUpdateOptionalParams

The options parameters.

Returns

get(string, string, string, ElasticPoolsGetOptionalParams)

Gets an elastic pool.

function get(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsGetOptionalParams): Promise<ElasticPoolsGetResponse>

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
ElasticPoolsGetOptionalParams

The options parameters.

Returns

listByServer(string, string, ElasticPoolsListByServerOptionalParams)

Gets all elastic pools in a server.

function listByServer(resourceGroupName: string, serverName: string, options?: ElasticPoolsListByServerOptionalParams): PagedAsyncIterableIterator<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.

options
ElasticPoolsListByServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ElasticPool>

listMetricDefinitions(string, string, string, ElasticPoolsListMetricDefinitionsOptionalParams)

Returns elastic pool metric definitions.

function listMetricDefinitions(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition>

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
ElasticPoolsListMetricDefinitionsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MetricDefinition>

listMetrics(string, string, string, string, ElasticPoolsListMetricsOptionalParams)

Returns elastic pool metrics.

function listMetrics(resourceGroupName: string, serverName: string, elasticPoolName: string, filter: string, options?: ElasticPoolsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric>

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
ElasticPoolsListMetricsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Metric>