Get-RedgateMonitorCloudProviderCredential
Published 11 March 2026
Gets all cloud provider credentials on the selected Base Monitor.
Syntax
Get-RedgateMonitorCloudProviderCredential [[-BaseMonitor] <BaseMonitor>] [[-Provider] <CloudProvider>] [[-Name] <string>] [<CommonParameters>]
Description
The Get-RedgateMonitorCloudProviderCredential cmdlet gets details of cloud provider credentials (Azure Service Principals or AWS IAM) from the Redgate Monitor Server.
Connect-RedgateMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor 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 |
-Provider
<CloudProvider>
The cloud provider to retrieve credentials for. If not specified, returns credentials for all providers.
| Aliases | None |
| Required? | false |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Name
<String>
Optional name filter. Only credentials matching this name are returned.
| Aliases | None |
| Required? | false |
| Position? | 3 |
| 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] when Provider is Azure. For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-ServicePrincipalCredential.
-
[AwsCloudServiceCredential] when Provider is AWS. For more information, see https://www.red-gate.com/monitor14/powershell-custom-types#CustomTypes-AwsCloudServiceCredential.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-RedgateMonitorCloudProviderCredential -BaseMonitor $BaseMonitor
This command will get all credentials (Azure and AWS) on the specified base monitor.
-------------------------- EXAMPLE 2 --------------------------
Get-RedgateMonitorCloudProviderCredential -BaseMonitor $BaseMonitor -Provider Azure
This command will get only Azure Service Principal Credentials on the specified base monitor.
-------------------------- EXAMPLE 3 --------------------------
Get-RedgateMonitorCloudProviderCredential -BaseMonitor $BaseMonitor -Provider AWS
This command will get only AWS credentials on the specified base monitor.
-------------------------- EXAMPLE 4 --------------------------
Get-RedgateMonitorCloudProviderCredential -Name "CredentialName"
This command will get the credential with the specified name from all base monitors.
-------------------------- EXAMPLE 5 --------------------------
Get-RedgateMonitorCloudProviderCredential -BaseMonitor $BaseMonitor -Provider AWS -Name "AwsCredentialName"
This command will get the AWS credential with the name "AwsCredentialName" on the specified base monitor.
