ElasticPools interface
Interface representing a ElasticPools.
Methods
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<SimplePollerLike<OperationState<ElasticPool>, 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.
- parameters
- ElasticPool
The elastic pool parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>
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<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.
- parameters
- ElasticPool
The elastic pool parameters.
The options parameters.
Returns
Promise<ElasticPool>
beginDelete(string, string, string, ElasticPoolsDeleteOptionalParams)
Deletes an elastic pool.
function beginDelete(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsDeleteOptionalParams): 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.
- elasticPoolName
-
string
The name of the elastic pool.
- options
- ElasticPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<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<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.
- elasticPoolName
-
string
The name of the elastic pool to failover.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<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.
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<SimplePollerLike<OperationState<ElasticPool>, 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.
- parameters
- ElasticPoolUpdate
The elastic pool update parameters.
- options
- ElasticPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>
beginUpdateAndWait(string, string, string, ElasticPoolUpdate, ElasticPoolsUpdateOptionalParams)
Updates an elastic pool.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: ElasticPoolsUpdateOptionalParams): Promise<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.
- parameters
- ElasticPoolUpdate
The elastic pool update parameters.
- options
- ElasticPoolsUpdateOptionalParams
The options parameters.
Returns
Promise<ElasticPool>
get(string, string, string, ElasticPoolsGetOptionalParams)
Gets an elastic pool.
function get(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsGetOptionalParams): Promise<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
- ElasticPoolsGetOptionalParams
The options parameters.
Returns
Promise<ElasticPool>
listByServer(string, string, ElasticPoolsListByServerOptionalParams)
Gets all elastic pools in a server.
function listByServer(resourceGroupName: string, serverName: string, options?: ElasticPoolsListByServerOptionalParams): PagedAsyncIterableIterator<ElasticPool, ElasticPool[], 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.
- serverName
-
string
The name of the server.
The options parameters.
Returns
listMetricDefinitions(string, string, string, ElasticPoolsListMetricDefinitionsOptionalParams)
Returns elastic pool metric definitions.
function listMetricDefinitions(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition, MetricDefinition[], 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.
- serverName
-
string
The name of the server.
- elasticPoolName
-
string
The name of the elastic pool.
The options parameters.
Returns
listMetrics(string, string, string, string, ElasticPoolsListMetricsOptionalParams)
Returns elastic pool metrics.
function listMetrics(resourceGroupName: string, serverName: string, elasticPoolName: string, filter: string, options?: ElasticPoolsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric, Metric[], 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.
- 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.
The options parameters.