Skip to content

Commit 0381983

Browse files
chrisdachrisda
committed
Updates to AuthServer cmdlets
Per Issue #3081
1 parent ab6ab59 commit 0381983

File tree

5 files changed

+93
-44
lines changed

5 files changed

+93
-44
lines changed

‎exchange/exchange-ps/exchange/move-and-migration/Resume-PublicFolderMigrationRequest.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
external help file: Microsoft.Exchange.ProvisioningAndMigration-Help.xml
3-
applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
3+
applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
44
title: Resume-PublicFolderMigrationRequest
55
schema: 2.0.0
66
author: chrisda
77
ms.author: chrisda
88
ms.reviewer:
9-
monikerRange: "exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps"
9+
monikerRange: "exchserver-ps-2013 || exchserver-ps-2016 || exchserver-ps-2019 || exchonline-ps"
1010
---
1111

1212
# Resume-PublicFolderMigrationRequest
@@ -57,7 +57,7 @@ The Identity parameter specifies the identity of the migration request. This par
5757
Type: PublicFolderMigrationRequestIdParameter
5858
Parameter Sets: (All)
5959
Aliases:
60-
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
60+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
6161
Required: True
6262
Position: 1
6363
Default value: None
@@ -76,7 +76,7 @@ The Confirm switch specifies whether to show or hide the confirmation prompt. Ho
7676
Type: SwitchParameter
7777
Parameter Sets: (All)
7878
Aliases: cf
79-
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
79+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
8080
Required: False
8181
Position: Named
8282
Default value: None
@@ -93,7 +93,7 @@ The DomainController parameter specifies the domain controller that's used by th
9393
Type: Fqdn
9494
Parameter Sets: (All)
9595
Aliases:
96-
Applicable: Exchange Server 2016, Exchange Server 2019
96+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
9797
Required: False
9898
Position: Named
9999
Default value: None
@@ -108,7 +108,7 @@ The WhatIf switch simulates the actions of the command. You can use this switch
108108
Type: SwitchParameter
109109
Parameter Sets: (All)
110110
Aliases: wi
111-
Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Online
111+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
112112
Required: False
113113
Position: Named
114114
Default value: None

‎exchange/exchange-ps/exchange/organization/Get-AuthServer.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,42 +33,55 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
3333

3434
### -------------------------- Example 1 --------------------------
3535
```
36-
Get-AuthServer | Format-List *
36+
Get-AuthServer
3737
```
3838

39-
This example retrieves all settings for all authorization servers in the Exchange organization.
39+
This example returns a summary list of all authorization servers in the Exchange organization.
40+
41+
### -------------------------- Example 2 --------------------------
42+
```
43+
Get-AuthServer -Identity WindowsAzureAC | Format-List
44+
```
45+
46+
This example retrieves detailed information for the authorization server named WindowsAzureAC.
4047

4148
## PARAMETERS
4249

43-
### -DomainController
44-
This parameter is available only in on-premises Exchange.
50+
### -Identity
51+
The Identity parameter specifies the authorization server object that you want to view. You can use any value that uniquely identifies the authorization server. For example:
4552

46-
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
53+
- Name
54+
55+
- Distinguished name (DN)
56+
57+
- GUID
4758

4859
```yaml
49-
Type: Fqdn
60+
Type: AuthServerIdParameter
5061
Parameter Sets: (All)
5162
Aliases:
52-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
63+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
5364
Required: False
54-
Position: Named
65+
Position: 1
5566
Default value: None
56-
Accept pipeline input: False
67+
Accept pipeline input: True
5768
Accept wildcard characters: False
5869
```
5970
60-
### -Identity
61-
The Identity parameter specifies the identity of an authorization server.
71+
### -DomainController
72+
This parameter is available only in on-premises Exchange.
73+
74+
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
6275
6376
```yaml
64-
Type: AuthServerIdParameter
77+
Type: Fqdn
6578
Parameter Sets: (All)
6679
Aliases:
67-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
80+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
6881
Required: False
69-
Position: 1
82+
Position: Named
7083
Default value: None
71-
Accept pipeline input: True
84+
Accept pipeline input: False
7285
Accept wildcard characters: False
7386
```
7487

‎exchange/exchange-ps/exchange/organization/New-AuthServer.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -50,53 +50,61 @@ New-AuthServer [-Name] <String> -Type <Unknown | MicrosoftACS | Facebook | Linke
5050
## DESCRIPTION
5151
Partner applications authorized by Exchange can access their resources after they're authenticated using server-to-server authentication. A partner application can authenticate by using self-issued tokens trusted by Exchange or by using an authorization server trusted by Exchange.
5252

53-
The New-AuthServer cmdlet creates a trusted authorization server object in Exchange, which allows it to trust tokens issued by the authorization server.
54-
5553
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://technet.microsoft.com/library/mt432940.aspx).
5654

5755
## EXAMPLES
5856

5957
### -------------------------- Example 1 --------------------------
6058
```
61-
New-AuthServer HRAppAuth -AuthMetadataUrl http://hrappauth.contoso.com/metadata/json/1
59+
New-AuthServer -Name WindowsAzureACS -AuthMetadataUrl https://accounts.accesscontrol.windows.net/contoso.onmicrosoft.com/metadata/json/1
6260
```
6361

64-
This command creates an authorization server.
62+
This command creates an authorization server object with the specified settings.
6563

6664
## PARAMETERS
6765

68-
### -AuthMetadataUrl
69-
The AuthMetadataUrl parameter specifies the URL for the Office 365 authorization server for your cloud-based organization. For details, see the Office 365 documentation.
66+
### -Name
67+
The Name parameter specifies a unique name for the authorization server object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
7068

7169
```yaml
7270
Type: String
73-
Parameter Sets: AuthMetadataUrl, NativeClientAuthServer
71+
Parameter Sets: (All)
7472
Aliases:
7573
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
7674
Required: True
77-
Position: Named
75+
Position: 1
7876
Default value: None
7977
Accept pipeline input: False
8078
Accept wildcard characters: False
8179
```
8280
83-
### -Name
84-
The Name parameter specifies a name for the authorization server.
81+
### -AuthMetadataUrl
82+
The AuthMetadataUrl parameter specifies the URL for the Office 365 authorization server for your cloud-based organization. For details, see the Office 365 documentation.
8583
8684
```yaml
8785
Type: String
88-
Parameter Sets: (All)
86+
Parameter Sets: AuthMetadataUrl, NativeClientAuthServer
8987
Aliases:
9088
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
9189
Required: True
92-
Position: 1
90+
Position: Named
9391
Default value: None
9492
Accept pipeline input: False
9593
Accept wildcard characters: False
9694
```
9795
9896
### -Type
99-
This parameter is reserved for internal Microsoft use.
97+
The Type parameter specifies the type of authorization tokens that are issued by the authorization server. Valid values are:
98+
99+
- ADFS
100+
101+
- AzureAD
102+
103+
- Facebook
104+
105+
- LinkedIn
106+
107+
- MicrosoftACS
100108
101109
```yaml
102110
Type: Unknown | MicrosoftACS | Facebook | LinkedIn | ADFS | AzureAD
@@ -145,7 +153,11 @@ Accept wildcard characters: False
145153
```
146154
147155
### -Enabled
148-
The Enabled parameter specifies whether the authorization server is enabled. Set the parameter to $false to prevent authorization tokens issued by this authorization server from being accepted.
156+
The Enabled parameter specifies whether the authorization server is enabled. Valid values are:
157+
158+
- $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value
159+
160+
- $false: Authorization tokens that are issued by the authorization server are are not accepted.
149161
150162
```yaml
151163
Type: $true | $false
@@ -160,7 +172,9 @@ Accept wildcard characters: False
160172
```
161173
162174
### -TrustAnySSLCertificate
163-
This parameter is reserved for internal Microsoft use.
175+
The TrustAnySSLCertificate switch specifies whether Exchange should accept certificates from an untrusted certification authority. You don't need to specify a value with this switch.
176+
177+
We don't recommend using this switch in a production environment.
164178
165179
```yaml
166180
Type: SwitchParameter

‎exchange/exchange-ps/exchange/organization/Remove-AuthServer.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,18 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
3535
Remove-AuthServer AMC
3636
```
3737

38-
This example removes the authorization server AMC.
38+
This example removes the authorization server named AMC.
3939

4040
## PARAMETERS
4141

4242
### -Identity
43-
The Identity parameter specifies the identity of the authorization server.
43+
The Identity parameter specifies the authorization server object that you want to remove. You can use any value that uniquely identifies the authorization server. For example:
44+
45+
- Name
46+
47+
- Distinguished name (DN)
48+
49+
- GUID
4450

4551
```yaml
4652
Type: AuthServerIdParameter

‎exchange/exchange-ps/exchange/organization/Set-AuthServer.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,13 @@ This command disables the authorization server ACS.
6969
## PARAMETERS
7070

7171
### -Identity
72-
The Identity parameter specifies the identity of authorization server.
72+
The Identity parameter specifies the authorization server object that you want to modify. You can use any value that uniquely identifies the authorization server. For example:
73+
74+
- Name
75+
76+
- Distinguished name (DN)
77+
78+
- GUID
7379

7480
```yaml
7581
Type: AuthServerIdParameter
@@ -135,6 +141,12 @@ Accept wildcard characters: False
135141
### -Enabled
136142
The Enabled parameter specifies whether the authorization server is enabled. Only enabled authorization servers can issue and accept tokens. Disabling the authorization server prevents any partner applications configured to use the authorization server from getting a token.
137143
144+
The Enabled parameter specifies whether the authorization server is enabled. Valid values are:
145+
146+
- $true: Authorization tokens that are issued by the authorization server are accepted. This is the default value
147+
148+
- $false: The authorization server does not issue or accept authorization tokens.
149+
138150
```yaml
139151
Type: $true | $false
140152
Parameter Sets: (All)
@@ -148,9 +160,11 @@ Accept wildcard characters: False
148160
```
149161
150162
### -IsDefaultAuthorizationEndpoint
151-
The IsDefaultAuthorizationEndpoint parameter specifies whether this server is the default authorization endpoint. This server's authorization URL is advertised to calling partner applications and applications need to get their OAuth access tokens from this authorization server.
163+
The IsDefaultAuthorizationEndpoint parameter specifies whether this server is the default authorization endpoint. Valid values are:
152164
153-
Valid input for this parameter is $true or $false. The default value is $false.
165+
$true: The authorization server's URL is advertised to calling partner applications and applications that need to get their OAuth access tokens from the authorization server.
166+
167+
$false: The authorization server's URL is not advertised. The default value is $false.
154168
155169
```yaml
156170
Type: $true | $false
@@ -165,7 +179,7 @@ Accept wildcard characters: False
165179
```
166180
167181
### -Name
168-
The Name parameter specifies a name for the authorization server.
182+
The Name parameter specifies a unique name for the authorization server object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
169183
170184
```yaml
171185
Type: String
@@ -180,7 +194,7 @@ Accept wildcard characters: False
180194
```
181195
182196
### -RefreshAuthMetadata
183-
The RefreshAuthMetadata switch specifies whether Exchange should refresh the auth metadata from the specified URL.
197+
The RefreshAuthMetadata switch specifies whether Exchange should refresh the auth metadata from the specified URL. You don't need to specify a value with this switch.
184198
185199
```yaml
186200
Type: SwitchParameter
@@ -195,7 +209,9 @@ Accept wildcard characters: False
195209
```
196210
197211
### -TrustAnySSLCertificate
198-
The TrustAnySSLCertificate switch specifies whether Exchange should accept certificates from an untrusted certification authority. We don't recommend using this switch in a production environment.
212+
The TrustAnySSLCertificate switch specifies whether Exchange should accept certificates from an untrusted certification authority. You don't need to specify a value with this switch.
213+
214+
We don't recommend using this switch in a production environment.
199215
200216
```yaml
201217
Type: SwitchParameter

0 commit comments

Comments
 (0)