SQL Monitor 13

Creates a new temporary object that holds information about a Azure SQL Managed Instance.

Syntax

New-SqlMonitorAzureSqlManagedInstance [-FullName] <string> [-BaseMonitor] <BaseMonitor> [[-Group] <Group>] [[-Alias] <string>] [[-UserName] <string>] [[-Password] <string>] [[-AzureAuthenticationMode] <string>] [[-NetworkProtocol] <string>] [[-Port] <int>] [[-PacketSize] <int>] [[-ConnectionTimeout] <int>] [[-ExecutionTimeout] <int>] [[-EncryptConnection] <bool>] [[-TrustServerCertificate] <bool>] [<CommonParameters>]

Description

The New-SqlMonitorAzureSqlManagedInstance cmdlet creates a new temporary object that holds information about a Azure SQL Managed Instance. The returned object needs to be passed to Add-SqlMonitorMonitoredObject, as it does not add anything to SQL Monitor on its own.

Parameters

`-FullName <String>`

The full address of the Azure SQL Database instance to be monitored, e.g. "sample.database.windows.net".

Aliases	None
Required?	true
Position?	1
Default Value	None
Accept Pipeline Input	True (ByValue)
Accept Wildcard Characters	false

`-BaseMonitor <BaseMonitor>`

The base monitor to add the monitored object to. For more informatiom, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.

Aliases	None
Required?	true
Position?	2
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Group <Group>`

Group object - use Get-Group or related methods to find the group.

Aliases	None
Required?	false
Position?	3
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Alias <String>`

Alias (display name)

Aliases	None
Required?	false
Position?	4
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-UserName <String>`

Username to connect to Azure SQL Managed Instance with.

Aliases	None
Required?	false
Position?	5
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Password <String>`

Password to connect to Azure SQL Managed Instance with.

Aliases	None
Required?	false
Position?	6
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-AzureAuthenticationMode <String>`

"SqlServerAuthentication", "AzureActiveDirectoryPassword" or "AzureActiveDirectoryIntegrated" authentication mode which is used to connect to Azure SQL Managed Instance.

Aliases	None
Required?	false
Position?	7
Default Value	SqlServerAuthentication
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-NetworkProtocol <String>`

SQL Network Protocol. Valid values are 'default', 'sharedMemory', 'namedPipes' and 'tcpip'.

Aliases	None
Required?	false
Position?	8
Default Value	None
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-Port <Int32>`

SQL Server port number.

Aliases	None
Required?	false
Position?	9
Default Value	0
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-PacketSize <Int32>`

Packet size.

Aliases	None
Required?	false
Position?	10
Default Value	0
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ConnectionTimeout <Int32>`

Connection time-out.

Aliases	None
Required?	false
Position?	11
Default Value	0
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ExecutionTimeout <Int32>`

Execution time-out.

Aliases	None
Required?	false
Position?	12
Default Value	0
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-EncryptConnection <Boolean>`

Encrypt connection.

Aliases	None
Required?	false
Position?	13
Default Value	False
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-TrustServerCertificate <Boolean>`

Trust server certificate

Aliases	None
Required?	false
Position?	14
Default Value	False
Accept Pipeline Input	False
Accept Wildcard Characters	false

`-ProgressAction <ActionPreference>`

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.

None.
You cannot pipe input to this cmdlet.

Examples

-------------------------- EXAMPLE 1 --------------------------

$instance = New-SqlMonitorAzureSqlManagedInstance -FullName "sample.database.windows.net" -BaseMonitor $BaseMonitor -UserName "sql_username" -Password "sql_pass"
$instance | Add-SqlMonitorMonitoredObject