Get-RedgateMonitorServicePrincipalCredential
Published 08 January 2025
Gets Azure Service Principal credentials on the selected Base Monitor.
Syntax
Get-RedgateMonitorServicePrincipalCredential [[-BaseMonitor] <BaseMonitor>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-RedgateMonitorServicePrincipalCredential cmdlet gets details of Azure Service Principal credentials from the Redgate Monitor Server.
This cmdlet is kept for backwards compatibility. Prefer using Get-RedgateMonitorCloudProviderCredential instead. For AWS credentials, use Get-RedgateMonitorCloudProviderCredential -Provider AWS.
Connect-RedgateMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor name to get credentials from. If not provided, all base monitors are queried.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
{{ Fill Name Description }}
| Aliases | None |
| Required? | false |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable, and -ProgressAction. 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 Azure Service Principal credentials on the specified base monitor.
-------------------------- EXAMPLE 2 --------------------------
Get-RedgateMonitorServicePrincipalCredential -Name "ServicePrincipalCredentialName"
This command will get the Azure Service Principal Credential with the name "ServicePrincipalCredentialName" from all base monitors.