Add-RedgateMonitorServicePrincipalCredential
Published 08 January 2025
Adds a Service Principal Credential to the specific base monitor.
Syntax
- Add-RedgateMonitorServicePrincipalCredential [-BaseMonitor] <BaseMonitor> [-Name] <string> [-TenantId] <string> [-ClientId] <string> [-ClientSecret] <string> [<CommonParameters>]
Description
Adds a Service Principal Credential to base monitor which can be retrieved using Get-RedgateMonitorServicePrincipalCredential.
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 |
-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.
-
[BaseMonitor] See Get-RedgateMonitorBaseMonitor.
-
[string] Name for Service Principal Credential
-
[string] Tenant Id for Service Principal Credential
-
[string] Client Id for Service Principal Credential
-
[string] Client Secret for Service Principal Credential
Examples
-------------------------- EXAMPLE 1 --------------------------
- Add-RedgateMonitorServicePrincipalCredential -BaseMonitor $BaseMonitor -Name "myPrincipal" -TenantId "tenant-id" -ClientId "client-id" -ClientSecret "client-secret"
