New-RedgateMonitorAzureFlexHost
Published 08 January 2025
Creates a new temporary object that holds information about an Azure Flex Host.
Syntax
- New-RedgateMonitorAzureFlexHost [[-FullName] <string>] [[-BaseMonitor] <BaseMonitor>] [[-Group] <Group>] [[-AzureApiAuthenticationMode] <AzureApiAuthenticationMode>] [[-ServicePrincipalCredential] <ServicePrincipalCredential>]
Description
The New-RedgateMonitorAzureflexHost cmdlet creates a new temporary object that holds information about an Azure Flex Host. The returned object needs to be passed to Add-RedgateMonitorMonitoredObject, as it does not add anything to Redgate Monitor on its own.
Parameters
-FullName
<String>
The address of the monitored object e.g. "sample.id.us-west-1.postgres.database.azure.com".
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-BaseMonitor
<BaseMonitor>
The base monitor to add the monitored object to.
| Aliases | None |
| Required? | false |
| 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 |
-AzureApiAuthenticationMode
<AzureApiAuthenticationMode>
Values can be ServicePrincipal or ManagedIdentity
| Aliases | None |
| Required? | false |
| Position? | 4 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ServicePrincipalCredential
<ServicePrincipalCredential>
Generate from Configuration > Manage cloud service credentials
| Aliases | None |
| Required? | false |
| Position? | 5 |
| 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 --------------------------
- $server = New-RedgateMonitorAzureflexHost -HostName "localhost" -BaseMonitor $BaseMonitor -AzureApiAuthenticationMode "ServicePrincipal" -ServicePrincipalCredentialId "service_principal_id"
- $instance = New-RedgateMonitorPostgreSql -FullName "localhost" -BaseMonitor $BaseMonitor -UserName "pg_username" -Password "pg_pass" -Port 5432
- $server, $instance | Add-RedgateMonitorMonitoredObject
