Add-RedgateMonitorServicePrincipalCredential
Published 08 January 2025
Adds an Azure Service Principal credential to the specified base monitor.
Syntax
Add-RedgateMonitorServicePrincipalCredential [-BaseMonitor] <BaseMonitor> [-Name] <string> [-TenantId] <string> [-ClientId] <string> [-ClientSecret] <string> [<CommonParameters>]
Description
Adds an Azure Service Principal credential to the base monitor which can be retrieved using Get-RedgateMonitorServicePrincipalCredential.
This cmdlet is kept for backwards compatibility. Prefer using New-RedgateMonitorAzureTenantCredential | Add-RedgateMonitorCloudProviderCredential instead. For AWS credentials, use New-RedgateMonitorAwsIamUserCredential | Add-RedgateMonitorCloudProviderCredential.
Parameters
-BaseMonitor
<BaseMonitor>
{{ Fill BaseMonitor Description }}
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Name
<String>
{{ Fill Name Description }}
| Aliases | None |
| Required? | true |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-TenantId
<String>
{{ Fill TenantId Description }}
| Aliases | None |
| Required? | true |
| Position? | 3 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ClientId
<String>
{{ Fill ClientId Description }}
| Aliases | None |
| Required? | true |
| Position? | 4 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ClientSecret
<String>
{{ Fill ClientSecret Description }}
| Aliases | None |
| Required? | true |
| 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, -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.
-
[BaseMonitor] See Get-RedgateMonitorBaseMonitor.
-
[string] Name for the credential.
-
[string] Tenant Id for Azure Service Principal.
-
[string] Client Id for Azure Service Principal.
-
[string] Client Secret for Azure Service Principal.
Examples
-------------------------- EXAMPLE 1 --------------------------
Add-RedgateMonitorServicePrincipalCredential -BaseMonitor $BaseMonitor -Name "myPrincipal" -TenantId "tenant-id" -ClientId "client-id" -ClientSecret "client-secret"
This command adds an Azure Service Principal credential.
