Get-SqlMonitorElasticPool
Published 14 February 2023
Gets the details of all of the Elastic Pools for the given Azure SQL Server.
Syntax
Get-SqlMonitorElasticPool [[-AzureSqlServer] <AzureSqlServer>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-SqlMonitorElasticPool cmdlet gets details of Elastic Pools from a SQL Monitor Server.
Without parameters, this cmdlet gets details of all Elastic Pools.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-AzureSqlServer
<AzureSqlServer>
The Azure SQL Server to limit results to. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorazuresqlserver.
Aliases | None |
Required? | false |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-Name
<String>
The Elastic Pool name to match.
Aliases | None |
Required? | false |
Position? | 2 |
Default Value | None |
Accept Pipeline Input | False |
Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
Aliases | None |
Required? | false |
Position? | named |
Default Value | None |
Accept Pipeline Input | False |
Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
[AzureSqlServer] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-AzureSqlServer.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[ElasticPool] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-ElasticPool.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorElasticPool
This command will get all elastic pools from SQL Monitor Server.
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorElasticPool -AzureSqlServer $azureSqlServer
This command will get all elastic pools on the specified Azure SQL Server from SQL Monitor Server.
-------------------------- EXAMPLE 3 --------------------------
Get-SqlMonitorElasticPool -Name "ExampleElasticPoolName"
This command will get all elastic pools with the name "ExampleElasticPoolName" from SQL Monitor Server.
-------------------------- EXAMPLE 4 --------------------------
Get-SqlMonitorElasticPool -AzureSqlServer $azureSqlServer -Name "ExampleElasticPoolName"
This command will get all elastic pools with the name "ExampleElasticPoolName" on the specified Azure SQL Server from SQL Monitor Server.