Gets all Service Principal Credentials on selected Base Monitor. This is used for managing Microsoft Entra (formerly Azure AD) Service Principals.

Syntax

Get-RedgateMonitorServicePrincipalCredential [[-BaseMonitor] <BaseMonitor>] [[-Name] <string>] [<CommonParameters>]
 

Description

The Get-RedgateMonitorServicePrincipalCredential cmdlet gets details of the Service Principal Credential from the Redgate Monitor Server.

Connect-RedgateMonitor must be called before this cmdlet.

Parameters

-BaseMonitor <BaseMonitor>

The Base Monitor name to get Service Principal Credential from if not provided all Service Principal Credentials are returned.

-Name <String>

{{ Fill Name Description }}

-ProgressAction <ActionPreference>

{{ Fill ProgressAction Description }}

<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.

Return values

The output type is the type of the objects that the cmdlet emits.

• [ServicePrincipalCredential] For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-ServicePrincipalCredential.

Examples

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

Get-RedgateMonitorServicePrincipalCredential -BaseMonitor $BaseMonitor

This command will get all Service Principal Credentials on the specified base monitor.

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

Get-RedgateMonitorServicePrincipalCredential -Name "ServicePrincipalCredentialName"

This command will get the Service Principal Credential with the name "ServicePrincipalCredentialName" from all base monitors.

-------------------------- EXAMPLE 3 --------------------------

Get-RedgateMonitorServicePrincipalCredential -BaseMonitor $BaseMonitor -Name "ServicePrincipalCredentialName"

This command will get the Service Principal Credential with the name "ServicePrincipalCredentialName" on the specified base monitor.