Skip to content

Commit 59bf29d

Browse files
nsshommonsshommo
committed
Cleanup & Updated
1 parent e9577cc commit 59bf29d

File tree

1 file changed

+7
-122
lines changed

1 file changed

+7
-122
lines changed

‎exchange/exchange-ps/exchange/Set-PartnerApplication.md

Lines changed: 7 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,6 @@ schema: 2.0.0
66
# Set-PartnerApplication
77

88
## SYNOPSIS
9-
!!! Exchange Server 2013
10-
11-
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
12-
13-
Use the Set-PartnerApplication cmdlet to configure a partner application.
14-
15-
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
16-
17-
!!! Exchange Server 2016, Exchange Online
18-
199
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
2010

2111
Use the Set-PartnerApplication cmdlet to configure partner application configurations.
@@ -28,17 +18,17 @@ For information about the parameter sets in the Syntax section below, see Exchan
2818
```
2919
Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter>
3020
[-AcceptSecurityIdentifierInformation <$true | $false>] [-ActAsPermissions <String[]>]
31-
[-ApplicationIdentifier <String>] [-AppOnlyPermissions <String[]>] [-Confirm] [-DomainController <Fqdn>]
32-
[-Enabled <$true | $false>] [-IssuerIdentifier <String>] [-LinkedAccount <UserIdParameter>] [-Name <String>]
21+
[-ApplicationIdentifier <String>] [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>]
22+
[-LinkedAccount <UserIdParameter>] [-Name <String>]
3323
[-Realm <String>] [-WhatIf] [-AccountType <OrganizationalAccount | ConsumerAccount>] [<CommonParameters>]
3424
```
3525

3626
### Set1
3727
```
3828
Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter>
3929
[-AcceptSecurityIdentifierInformation <$true | $false>] [-ActAsPermissions <String[]>]
40-
[-AppOnlyPermissions <String[]>] [-AuthMetadataUrl <String>] [-Confirm] [-DomainController <Fqdn>]
41-
[-Enabled <$true | $false>] [-IssuerIdentifier <String>] [-LinkedAccount <UserIdParameter>] [-Name <String>]
30+
[-AuthMetadataUrl <String>] [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>]
31+
[-LinkedAccount <UserIdParameter>] [-Name <String>]
4232
[-TrustAnySSLCertificate] [-WhatIf] [-AccountType <OrganizationalAccount | ConsumerAccount>]
4333
[<CommonParameters>]
4434
```
@@ -47,41 +37,19 @@ Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter>
4737
```
4838
Set-PartnerApplication [-Identity] <PartnerApplicationIdParameter>
4939
[-AcceptSecurityIdentifierInformation <$true | $false>] [-ActAsPermissions <String[]>]
50-
[-AppOnlyPermissions <String[]>] [-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>]
51-
[-IssuerIdentifier <String>] [-LinkedAccount <UserIdParameter>] [-Name <String>] [-RefreshAuthMetadata]
40+
[-Confirm] [-DomainController <Fqdn>] [-Enabled <$true | $false>]
41+
[-LinkedAccount <UserIdParameter>] [-Name <String>] [-RefreshAuthMetadata]
5242
[-WhatIf] [-AccountType <OrganizationalAccount | ConsumerAccount>] [<CommonParameters>]
5343
```
5444

5545
## DESCRIPTION
56-
!!! Exchange Server 2013
57-
58-
In Microsoft Exchange Server 2013, you can configure partner applications such as Microsoft SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange 2013 resources. For details, see Integration with SharePoint and Lync. We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the \\Exchange Server\\V15\\Scripts folder to configure partner applications.
59-
60-
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Partner applications - configure" entry in the Sharing and collaboration permissions topic.
61-
62-
!!! Exchange Server 2016, Exchange Online
63-
6446
You can configure partner applications such as SharePoint to access Exchange resources. Use the New-PartnerApplication cmdlet to create a partner application configuration for an application that needs to access Exchange resources. For details, see Plan Exchange 2016 integration with SharePoint and Skype for Business. We recommend that you use the Configure-EnterprisePartnerApplication.ps1 script in the %ExchangeInstallPath%Scripts folder to configure partner applications.
6547

6648
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).
6749

6850
## EXAMPLES
6951

70-
### Example 1 -------------------------- (Exchange Server 2013)
71-
```
72-
Set-PartnerApplication HRApp -RefreshAuthMetadata
73-
```
74-
75-
This example refreshes the auth metadata for the HRApp partner application.
76-
77-
### Example 1 -------------------------- (Exchange Server 2016)
78-
```
79-
Set-PartnerApplication HRApp -RefreshAuthMetadata
80-
```
81-
82-
This example refreshes the auth metadata for the HRApp partner application.
83-
84-
### Example 1 -------------------------- (Exchange Online)
52+
### Example 1
8553
```
8654
Set-PartnerApplication HRApp -RefreshAuthMetadata
8755
```
@@ -91,14 +59,6 @@ This example refreshes the auth metadata for the HRApp partner application.
9159
## PARAMETERS
9260

9361
### -Identity
94-
!!! Exchange Server 2013
95-
96-
The Identity parameter specifies the identity of the partner application you want to modify.
97-
98-
99-
100-
!!! Exchange Server 2016, Exchange Online
101-
10262
The Identity parameter specifies the partner application you want to modify. You can use any value that uniquely identifies the partner application. For example:
10363

10464
- Name
@@ -109,8 +69,6 @@ The Identity parameter specifies the partner application you want to modify. You
10969

11070
- GUID
11171

112-
113-
11472
```yaml
11573
Type: PartnerApplicationIdParameter
11674
Parameter Sets: (All)
@@ -141,20 +99,8 @@ Accept wildcard characters: False
14199
```
142100
143101
### -ActAsPermissions
144-
!!! Exchange Server 2013
145-
146-
This parameter is available only in on-premises Exchange.
147-
148-
This parameter is reserved for internal Microsoft use.
149-
150-
151-
152-
!!! Exchange Server 2016, Exchange Online
153-
154102
The ActAsPermissions parameter specifies the delegate permissions that are allowed for the partner application. You can specify multiple values separated by commas.
155103
156-
157-
158104
```yaml
159105
Type: String[]
160106
Parameter Sets: (All)
@@ -184,24 +130,6 @@ Accept pipeline input: False
184130
Accept wildcard characters: False
185131
```
186132
187-
### -AppOnlyPermissions
188-
This parameter is available only in on-premises Exchange.
189-
190-
This parameter is reserved for internal Microsoft use.
191-
192-
```yaml
193-
Type: String[]
194-
Parameter Sets: (All)
195-
Aliases:
196-
Applicable: Exchange Server 2013
197-
198-
Required: False
199-
Position: Named
200-
Default value: None
201-
Accept pipeline input: False
202-
Accept wildcard characters: False
203-
```
204-
205133
### -AuthMetadataUrl
206134
This parameter is available only in on-premises Exchange.
207135
@@ -221,26 +149,12 @@ Accept wildcard characters: False
221149
```
222150
223151
### -Confirm
224-
!!! Exchange Server 2013
225-
226-
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.
227-
228-
- 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.
229-
230-
- 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.
231-
232-
233-
234-
!!! Exchange Server 2016, Exchange Online
235-
236152
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.
237153
238154
- 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.
239155
240156
- 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.
241157
242-
243-
244158
```yaml
245159
Type: SwitchParameter
246160
Parameter Sets: (All)
@@ -288,22 +202,6 @@ Accept pipeline input: False
288202
Accept wildcard characters: False
289203
```
290204
291-
### -IssuerIdentifier
292-
This parameter is reserved for internal Microsoft use.
293-
294-
```yaml
295-
Type: String
296-
Parameter Sets: (All)
297-
Aliases:
298-
Applicable: Exchange Server 2013
299-
300-
Required: False
301-
Position: Named
302-
Default value: None
303-
Accept pipeline input: False
304-
Accept wildcard characters: False
305-
```
306-
307205
### -LinkedAccount
308206
The LinkedAccount parameter specifies a linked Active Directory user account for the application. Exchange evaluates Role Based Access Control (RBAC) permissions for the linked account when authorizing a token used to perform a task.
309207
@@ -337,22 +235,10 @@ Accept wildcard characters: False
337235
```
338236
339237
### -Realm
340-
!!! Exchange Server 2013
341-
342-
This parameter is available only in on-premises Exchange.
343-
344-
The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange 2013 resources.
345-
346-
347-
348-
!!! Exchange Server 2016, Exchange Online
349-
350238
This parameter is available only in on-premises Exchange.
351239
352240
The Realm parameter specifies a security realm for the partner application. If the token is from a domain that's not an accepted domain, Exchange checks the realm specified in the token. In such a scenario, only tokens with the same realm specified in the partner application can access Exchange resources.
353241
354-
355-
356242
```yaml
357243
Type: String
358244
Parameter Sets: Set2
@@ -456,4 +342,3 @@ To see the return types, which are also known as output types, that this cmdlet
456342
## RELATED LINKS
457343
458344
[Online Version](https://technet.microsoft.com/library/22550369-102f-424a-bfa3-98144695ecbe.aspx)
459-

0 commit comments

Comments
 (0)