Get-SqlMonitorDetectedDatabase
Published 29 August 2023
Gets the details of all of the Databases for the given Azuer SQL Server Database Instance.
Syntax
Get-SqlMonitorDetectedDatabase [[-Name] <string>] [<CommonParameters>] Get-SqlMonitorDetectedDatabase [-AzureSqlServerCredentials] <CredentialsTransferObject> [[-Name] <string>] [<CommonParameters>] Get-SqlMonitorDetectedDatabase [-AzureSqlServer] <AzureSqlServer> [[-Name] <string>] [<CommonParameters>]
Description
The Get-DetectedDatabase cmdlet gets details of all the Databases for the given Azure SQL Server Instance regardless of it being added to SQL Monitor.
Parameters
-AzureSqlServerCredentials
<CredentialsTransferObject>
The New Azure SQL Server Database that is going to be added to SQL Monitor to limit the results. For more information, see https://documentation.red-gate.com/sm/api/powershell-api/powershell-cmdlet-reference/new-sqlmonitorazuresqldatabase
Aliases | None |
Required? | true |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | True (ByValue) |
Accept Wildcard Characters | false |
-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? | 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.
-
[AzureSqlServer] See Get-SqlMonitorAzureSqlServer. 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.
-
[Database] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Database.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorDetectedDatabase -AzureSqlServer $azureSqlServer -Name "ExampleDatabaseName"
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorDetectedDatabase -NewAzureSqlServer $newAzureSqlServer -Name "ExampleDatabaseName"