Get-RedgateMonitorDatabase
Published 18 April 2024
Gets the details of all of the Databases for the given SQL Server Instance.
Syntax
Get-RedgateMonitorDatabase [[-Instance] <Instance>] [[-Name] <string>] [<CommonParameters>] Get-RedgateMonitorDatabase [-AzureSqlServer] <AzureSqlServer> [[-Name] <string>] [<CommonParameters>] Get-RedgateMonitorDatabase [-AmazonRdsSqlServer] <AmazonRdsSqlServer> [[-Name] <string>] [<CommonParameters>] Get-RedgateMonitorDatabase [-AzureManagedInstance] <AzureManagedInstance> [[-Name] <string>] [<CommonParameters>]
Description
The Get-RedgateMonitorDatabase cmdlet gets details of Databases for the given SQL Server Instance from the Redgate Monitor Server.
Parameters
-Instance
<Instance>
The Instance to get Databases from.
Aliases | None |
Required? | false |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-AzureSqlServer
<AzureSqlServer>
The Azure SQL Server to limit results to.
Aliases | None |
Required? | true |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-AmazonRdsSqlServer
<AmazonRdsSqlServer>
The AmazonRds SQL Server to limit results to.
Aliases | None |
Required? | true |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-AzureManagedInstance
<AzureManagedInstance>
The Azure Managed Instance to limit results to.
Aliases | None |
Required? | true |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-Name
<String>
The Database 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.
-
[Instance] See Get-RedgateMonitorMonitoredObject -Type SqlServerInstance.
-
[AzureSqlServer] See Get-RedgateMonitorMonitoredObject -Type AzureSqlServer.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[Database] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-Database.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-RedgateMonitorDatabase -Instance $instance
-------------------------- EXAMPLE 2 --------------------------
Get-RedgateMonitorDatabase -Instance $instance -Name "ExampleDatabaseName"
-------------------------- EXAMPLE 3 --------------------------
Get-RedgateMonitorDatabase -AzureSqlServer $azureSqlServer -Name "ExampleDatabaseName"
-------------------------- EXAMPLE 4 --------------------------
Get-RedgateMonitorDatabase -AmazonRdsSqlServer $amazonRdsSqlServer -Name "ExampleDatabaseName"
-------------------------- EXAMPLE 5 --------------------------
Get-RedgateMonitorDatabase -AzureManagedInstance $azureManagedInstance -Name "ExampleDatabaseName"