Skip to content

Commit f217079

Browse files
committed
Test-ServicePrincipalAuthorization
1 parent 9ff0da0 commit f217079

File tree

3 files changed

+147
-0
lines changed

3 files changed

+147
-0
lines changed
Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
---
2+
external help file: Microsoft.Exchange.RolesAndAccess-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/test-serviceprincipalauthorization
4+
applicable: Exchange Online
5+
title: Test-ServicePrincipalAuthorization
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Test-ServicePrincipalAuthorization
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Test-ServicePrincipalAuthorization cmdlet to test
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Test-ServicePrincipalAuthorization [-Identity] <ServicePrincipalIdParameter>
25+
[-Confirm]
26+
[-Organization <OrganizationIdParameter>]
27+
[-Resource <UserIdParameter>]
28+
[-WhatIf]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
34+
35+
## EXAMPLES
36+
37+
### Example 1
38+
```powershell
39+
{{ Add example code here }}
40+
```
41+
42+
{{ Add example description here }}
43+
44+
## PARAMETERS
45+
46+
### -Identity
47+
The Identity parameter specifies the service principal that you want to test. You can use any value that uniquely identifies the service principal. For example:
48+
49+
- Name
50+
- Distinguished name (DN)
51+
- GUID
52+
- AppId
53+
- ServiceId
54+
55+
```yaml
56+
Type: ServicePrincipalIdParameter
57+
Parameter Sets: (All)
58+
Aliases:
59+
Applicable: Exchange Online
60+
61+
Required: True
62+
Position: 0
63+
Default value: None
64+
Accept pipeline input: True (ByPropertyName, ByValue)
65+
Accept wildcard characters: False
66+
```
67+
68+
### -Confirm
69+
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
70+
71+
- Destructive cmdlets (for example, Remove-\* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: `-Confirm:$false`.
72+
- Most other cmdlets (for example, New-\* and Set-\* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
73+
74+
```yaml
75+
Type: SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases: cf
78+
Applicable: Exchange Online
79+
80+
Required: False
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
### -Organization
88+
{{ Fill Organization Description }}
89+
90+
```yaml
91+
Type: OrganizationIdParameter
92+
Parameter Sets: (All)
93+
Aliases:
94+
Applicable: Exchange Online
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: True (ByPropertyName, ByValue)
100+
Accept wildcard characters: False
101+
```
102+
103+
### -Resource
104+
{{ Fill Resource Description }}
105+
106+
```yaml
107+
Type: UserIdParameter
108+
Parameter Sets: (All)
109+
Aliases:
110+
Applicable: Exchange Online
111+
112+
Required: False
113+
Position: Named
114+
Default value: None
115+
Accept pipeline input: True (ByPropertyName, ByValue)
116+
Accept wildcard characters: False
117+
```
118+
119+
### -WhatIf
120+
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
121+
122+
```yaml
123+
Type: SwitchParameter
124+
Parameter Sets: (All)
125+
Aliases: wi
126+
Applicable: Exchange Online
127+
128+
Required: False
129+
Position: Named
130+
Default value: None
131+
Accept pipeline input: False
132+
Accept wildcard characters: False
133+
```
134+
135+
### CommonParameters
136+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
137+
138+
## INPUTS
139+
140+
## OUTPUTS
141+
142+
## NOTES
143+
144+
## RELATED LINKS

exchange/exchange-ps/exchange/exchange.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1674,6 +1674,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
16741674

16751675
### [Test-OAuthConnectivity](Test-OAuthConnectivity.md)
16761676

1677+
### [Test-ServicePrincipalAuthorization](Test-ServicePrincipalAuthorization.md)
1678+
16771679
### [Test-SystemHealth](Test-SystemHealth.md)
16781680

16791681
### [Update-ExchangeHelp](Update-ExchangeHelp.md)

exchange/mapping/serviceMapping.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -820,6 +820,7 @@
820820
"Set-SettingOverride": "organization",
821821
"Test-ApplicationAccessPolicy": "organization",
822822
"Test-OAuthConnectivity": "organization",
823+
"Test-ServicePrincipalAuthorization": "organization",
823824
"Test-SystemHealth": "organization",
824825
"Update-ExchangeHelp": "organization",
825826
"Disable-JournalArchiving": "policy-and-compliance",

0 commit comments

Comments
 (0)