Package version:

Interface ElasticPools

Interface representing a ElasticPools.

Hierarchy

ElasticPools

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginFailover beginFailoverAndWait beginUpdate beginUpdateAndWait get listByServer listMetricDefinitions listMetrics

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPool, options?: ElasticPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>
Creates or updates an elastic pool.
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.
- Optional options: ElasticPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>
- Defined in operationsInterfaces/elasticPools.ts:97

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPool, options?: ElasticPoolsCreateOrUpdateOptionalParams): Promise<ElasticPool>
Creates or updates an elastic pool.
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.
- Optional options: ElasticPoolsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ElasticPool>
- Defined in operationsInterfaces/elasticPools.ts:118

beginDelete

beginDelete(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes an elastic pool.
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.
- Optional options: ElasticPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/elasticPools.ts:133

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsDeleteOptionalParams): Promise<void>
Deletes an elastic pool.
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.
- Optional options: ElasticPoolsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/elasticPools.ts:147

beginFailover

beginFailover(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Failovers an elastic pool.
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.
- Optional options: ElasticPoolsFailoverOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/elasticPools.ts:198

beginFailoverAndWait

beginFailoverAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsFailoverOptionalParams): Promise<void>
Failovers an elastic pool.
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.
- Optional options: ElasticPoolsFailoverOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/elasticPools.ts:212

beginUpdate

beginUpdate(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: ElasticPoolsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>
Updates an elastic pool.
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.
- Optional options: ElasticPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>
- Defined in operationsInterfaces/elasticPools.ts:162

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serverName: string, elasticPoolName: string, parameters: ElasticPoolUpdate, options?: ElasticPoolsUpdateOptionalParams): Promise<ElasticPool>
Updates an elastic pool.
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.
- Optional options: ElasticPoolsUpdateOptionalParams
  
  The options parameters.
Returns Promise<ElasticPool>
- Defined in operationsInterfaces/elasticPools.ts:183

get

get(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsGetOptionalParams): Promise<ElasticPool>
Gets an elastic pool.
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.
- Optional options: ElasticPoolsGetOptionalParams
  
  The options parameters.
Returns Promise<ElasticPool>
- Defined in operationsInterfaces/elasticPools.ts:82

listByServer

listByServer(resourceGroupName: string, serverName: string, options?: ElasticPoolsListByServerOptionalParams): PagedAsyncIterableIterator<ElasticPool>
Gets all elastic pools in 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: ElasticPoolsListByServerOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ElasticPool>
- Defined in operationsInterfaces/elasticPools.ts:69

listMetricDefinitions

listMetricDefinitions(resourceGroupName: string, serverName: string, elasticPoolName: string, options?: ElasticPoolsListMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<MetricDefinition>
Returns elastic pool metric definitions.
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.
- Optional options: ElasticPoolsListMetricDefinitionsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<MetricDefinition>
- Defined in operationsInterfaces/elasticPools.ts:56

listMetrics

listMetrics(resourceGroupName: string, serverName: string, elasticPoolName: string, filter: string, options?: ElasticPoolsListMetricsOptionalParams): PagedAsyncIterableIterator<Metric>
Returns elastic pool metrics.
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.
- Optional options: ElasticPoolsListMetricsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Metric>
- Defined in operationsInterfaces/elasticPools.ts:41

Interface ElasticPools

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

parameters: ElasticPool

Optional options: ElasticPoolsCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

parameters: ElasticPool

Optional options: ElasticPoolsCreateOrUpdateOptionalParams

Returns Promise<ElasticPool>

beginDelete

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

Optional options: ElasticPoolsDeleteOptionalParams

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

beginDeleteAndWait

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

Optional options: ElasticPoolsDeleteOptionalParams

Returns Promise<void>

beginFailover

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

Optional options: ElasticPoolsFailoverOptionalParams

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

beginFailoverAndWait

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

Optional options: ElasticPoolsFailoverOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

parameters: ElasticPoolUpdate

Optional options: ElasticPoolsUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ElasticPool>, ElasticPool>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

parameters: ElasticPoolUpdate

Optional options: ElasticPoolsUpdateOptionalParams

Returns Promise<ElasticPool>

get

Parameters

resourceGroupName: string

serverName: string

elasticPoolName: string

Optional options: ElasticPoolsGetOptionalParams

Returns Promise<ElasticPool>

listByServer

Parameters

resourceGroupName: string

serverName: string

Optional options: ElasticPoolsListByServerOptionalParams

Returns PagedAsyncIterableIterator<ElasticPool>

listMetricDefinitions

Parameters

`Optional` options: ElasticPoolsCreateOrUpdateOptionalParams

`Optional` options: ElasticPoolsCreateOrUpdateOptionalParams

`Optional` options: ElasticPoolsDeleteOptionalParams

`Optional` options: ElasticPoolsDeleteOptionalParams

`Optional` options: ElasticPoolsFailoverOptionalParams

`Optional` options: ElasticPoolsFailoverOptionalParams

`Optional` options: ElasticPoolsUpdateOptionalParams

`Optional` options: ElasticPoolsUpdateOptionalParams

`Optional` options: ElasticPoolsGetOptionalParams

`Optional` options: ElasticPoolsListByServerOptionalParams

`Optional` options: ElasticPoolsListMetricDefinitionsOptionalParams

`Optional` options: ElasticPoolsListMetricsOptionalParams