Redgate Monitor 14

Help for older versions available.

Where are you using Redgate Monitor? (pick the closest answer)

New-RedgateMonitorMicrosoftEntraId

Creates a new temporary object that holds information about a MicrosoftEntraId.

Syntax

  1. New-RedgateMonitorMicrosoftEntraId -Name <string> -BaseMonitor <BaseMonitor> [-ServicePrincipalCredential <ServicePrincipalCredential>] [<CommonParameters>]
  2.  

Description

The New-RedgateMonitorMicrosoftEntraId cmdlet creates a new temporary object that holds information about a MicrosoftEntraId. The returned object needs to be passed to Add-RedgateMonitorMonitoredIamObject, as it does not add anything to Redgate Monitor on its own.

Parameters

-Name <String>

The name of the monitored object e.g. "[azure-directory-name]".

Aliases None
Required? true
Position? named
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 information, see https://documentation.red-gate.com/monitor14/api/powershell-api/powershell-cmdlet-reference/get-redgatemonitorbasemonitor.

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

-ServicePrincipalCredential <ServicePrincipalCredential>

The Service Principal Credential to connect to Microsoft Graph API.

Aliases None
Required? false
Position? named
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.

  • None.
    You cannot pipe input to this cmdlet.

Examples

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

  1. $entraID = New-RedgateMonitorMicrosoftEntraId -Name "testing" -BaseMonitor $BaseMonitor
  2. $entraID | Add-RedgateMonitorMonitoredIamObject

-------------------------- EXAMPLE 2 --------------------------

  1. $azureTenantCredential = Get-RedgateMonitorServicePrincipalCredential -Name "azureApp"
  2. $entraID = New-RedgateMonitorMicrosoftEntraId -Name "testing" -BaseMonitor $BaseMonitor -ServicePrincipalCredential $azureTenantCredential
  3. $entraID | Add-RedgateMonitorMonitoredIamObject


Didn't find what you were looking for?