Get-SqlMonitorAzureManagedInstance
Published 21 October 2021
Gets the details of all of the Azure Managed Instances monitored by SQL Monitor.
Syntax
Get-SqlMonitorAzureManagedInstance [[-BaseMonitor] <BaseMonitor>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-SqlMonitorAzureManagedInstance cmdlet gets details of Azure Managed Instances from the SQL Monitor Server.
Without parameters, this cmdlet will get all Azure Managed Instances from the SQL Monitor Server.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor to get managed instances from. For more informatiom, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The Azure Managed Instance name to match.
| Aliases | None |
| Required? | false |
| Position? | 2 |
| 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://documentation.red-gate.com/sm/api/custom-types#CustomTypes-BaseMonitor.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[AzureManagedInstance] For more information, see https://documentation.red-gate.com/sm/api/custom-types#CustomTypes-AzureManagedInstance.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorAzureManagedInstance
This command will get all Azure Managed Instances from SQL Monitor Server.
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorAzureManagedInstance -BaseMonitor $baseMonitor
This command will get all Azure Managed Instances on the specified base monitor from SQL Monitor Server.
-------------------------- EXAMPLE 3 --------------------------
Get-SqlMonitorAzureManagedInstance -BaseMonitor $baseMonitor -Name "ExampleManagedInstance"
This command will get all Azure Managed Instances with the name "ExampleManagedInstance" on the specified base monitor from SQL Monitor Server.
This documentation contains proprietary information and is protected by copyright law.
Copyright © 2026 Red Gate Software Limited. All rights reserved
