Get-SqlMonitorAzureSqlServer
Published 14 February 2023
Gets the details of all of the Azure SQL Servers monitored by SQL Monitor.
Syntax
Get-SqlMonitorAzureSqlServer [-BaseMonitor <BaseMonitor>] [-Name <string>] [-SuppressDeprecationWarning] [<CommonParameters>] Get-SqlMonitorAzureSqlServer [-Name <string>] [-Group <Group>] [-SuppressDeprecationWarning] [<CommonParameters>]
Description
The Get-SqlMonitorAzureSqlServer cmdlet gets details of Azure SQL Servers from the SQL Monitor Server.
Without parameters, this cmdlet will get all Azure SQL Servers from the SQL Monitor Server.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor to get Azure SQL Servers from. For more informatiom, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The Azure SQL Server name to match.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Group
<Group>
{{ Fill Group Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-SuppressDeprecationWarning
<SwitchParameter>
{{ Fill SuppressDeprecationWarning Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | False |
| 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.
-
[BaseMonitor] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-BaseMonitor.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[AzureSqlServer] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-AzureSqlServer.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorAzureSqlServer
This command will get all Azure SQL Servers from SQL Monitor Server.
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorAzureSqlServer -BaseMonitor $baseMonitor
This command will get all Azure SQL Servers on the specified base monitor from SQL Monitor Server.
-------------------------- EXAMPLE 3 --------------------------
Get-SqlMonitorAzureSqlServer -BaseMonitor $baseMonitor -Name "ExampleAzureSqlServer"
This command will get all Azure SQL Servers with the name "ExampleAzureSqlServer" on the specified base monitor from SQL Monitor Server.
