Skip to content

Commit 92b0814

Browse files
KateyanneKateyanne
authored
Merge pull request MicrosoftDocs#6464 from frankpeng7/application-access-policy
Added documents for application access policy cmdlets
2 parents 8945661 + 153043a commit 92b0814

File tree

5 files changed

+480
-0
lines changed

5 files changed

+480
-0
lines changed

‎skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/get-csapplicationaccesspolicy
4+
applicable: Skype for Business Online
5+
title: Get-CsApplicationAccessPolicy
6+
schema: 2.0.0
7+
manager: zhengni
8+
author: frankpeng7
9+
ms.author: frpeng
10+
ms.reviewer:
11+
---
12+
13+
# Get-CsApplicationAccessPolicy
14+
15+
## SYNOPSIS
16+
17+
Retrieves information about the application access policy configured for use in the tenant.
18+
19+
## SYNTAX
20+
21+
### Identity
22+
23+
```
24+
Get-CsApplicationAccessPolicy [-Identity <XdsIdentity>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
This cmdlet retrieves information about the application access policy configured for use in the tenant.
30+
31+
## EXAMPLES
32+
33+
### Retrieve all application access policies
34+
35+
```
36+
PS C:\> Get-CsApplicationAccessPolicy
37+
```
38+
39+
The command shown above returns information of all application access policies that have been configured for use in the tenant.
40+
41+
### Retrieve specific application access policy
42+
43+
```
44+
PS C:\> Get-CsApplicationAccessPolicy -Identity "ASimplePolicy"
45+
```
46+
47+
In the command shown above, information is returned for a single application access policy: the policy with the Identity ASimplePolicy.
48+
49+
50+
## PARAMETERS
51+
52+
### -Identity
53+
54+
Unique identifier assigned to the policy when it was created.
55+
56+
```yaml
57+
Type: XdsIdentity
58+
Parameter Sets: (All)
59+
Aliases:
60+
61+
Required: True
62+
Position: 1
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
## INPUTS
69+
70+
## OUTPUTS
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
76+
[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
77+
[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md)
78+
[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
79+
[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)

‎skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/grant-csapplicationaccesspolicy
4+
applicable: Skype for Business Online
5+
title: Grant-CsApplicationAccessPolicy
6+
schema: 2.0.0
7+
manager: zhengni
8+
author: frankpeng7
9+
ms.author: frpeng
10+
ms.reviewer:
11+
---
12+
13+
# Grant-CsApplicationAccessPolicy
14+
15+
## SYNOPSIS
16+
17+
Assigns a per-user application access policy to one or more users. After assigning an application access policy to a user, the applications configured in the policy will be authorized to access online meetings on behalf of that user.
18+
19+
## SYNTAX
20+
21+
### FileName
22+
23+
```
24+
Grant-CsApplicationAccessPolicy [-Identity <UserIdParameter>] [-PolicyName <String>] [-Global]
25+
```
26+
27+
## DESCRIPTION
28+
29+
This cmdlet assigns a per-user application access policy to one or more users. After assigning an application access policy to a user, the applications configured in the policy will be authorized to access online meetings on behalf of that user.
30+
31+
## EXAMPLES
32+
33+
### Assign an application access policy to a user
34+
35+
```
36+
PS C:\> Grant-CsApplicationAccessPolicy -Identity "dc17674c-81d9-4adb-bfb2-8f6a442e4624" -PolicyName "ASimplePolicy"
37+
```
38+
39+
The command shown above assigns the per-user application access policy "ASimplePolicy" to the user with object ID "dc17674c-81d9-4adb-bfb2-8f6a442e4624".
40+
41+
### Unassign an application access policy from a user
42+
43+
```
44+
PS C:\> Grant-CsApplicationAccessPolicy -Identity "dc17674c-81d9-4adb-bfb2-8f6a442e4624" -PolicyName $Null
45+
```
46+
47+
In the command shown above, any per-user application access policy previously assigned to the user with user (object) ID "dc17674c-81d9-4adb-bfb2-8f6a442e4624" is unassigned from that user; as a result, applications configured in the policy can no longer access online meetings on behalf of that user. To unassign a per-user policy, set the PolicyName to a null value ($Null).
48+
49+
### Assign an application access policy to all users in the tenant
50+
51+
```
52+
PS C:\> Get-CsOnlineUser | Grant-CsApplicationAccessPolicy -PolicyName "ASimplePolicy"
53+
```
54+
55+
The command shown above assigns the per-user application access policy ASimplePolicy to all the users in the tenant. To do this, the command first calls the `Get-CsOnlineUser` cmdlet to get all user accounts enabled for Skype for Business Online. Those user accounts are then piped to the `Grant-CsApplicationAccessPolicy` cmdlet, which assigns each user the application access policy "ASimplePolicy".
56+
57+
### Assign an application access policy to users who have not been assigned one
58+
59+
```
60+
PS C:\> Grant-CsApplicationAccessPolicy -PolicyName "ASimplePolicy" -Global
61+
```
62+
63+
The command shown above assigns the per-user application access policy "ASimplePoicy" to all the users in the tenant, except any that have an explicit policy assignment.
64+
65+
## PARAMETERS
66+
67+
### -Identity
68+
69+
Indicates the user (object) ID of the user account to be assigned the per-user application access policy.
70+
71+
```yaml
72+
Type: UserIdParameter
73+
Parameter Sets: (All)
74+
Aliases:
75+
76+
Required: True
77+
Position: 0
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
### -PolicyName
84+
85+
Name of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:ASimplePolicy has a PolicyName equal to ASimplePolicy.
86+
87+
```yaml
88+
Type: PSListModifier
89+
Parameter Sets: (All)
90+
Aliases:
91+
92+
Required: False
93+
Position: Named
94+
Default value: None
95+
Accept pipeline input: False
96+
Accept wildcard characters: False
97+
```
98+
99+
### -Global
100+
101+
When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant, except any that have an explicit policy assignment. To skip a warning when you do this operation, specify this parameter.
102+
103+
```yaml
104+
Type: SwitchParameter
105+
Parameter Sets:(All)
106+
Aliases:
107+
108+
Required: False
109+
Position: Named
110+
Default value: None
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
115+
## INPUTS
116+
117+
## OUTPUTS
118+
119+
## NOTES
120+
121+
## RELATED LINKS
122+
123+
[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
124+
[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
125+
[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
126+
[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)

‎skype/skype-ps/skype/New-CsApplicationAccessPolicy.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/new-csapplicationaccesspolicy
4+
applicable: Skype for Business Online
5+
title: New-CsApplicationAccessPolicy
6+
schema: 2.0.0
7+
manager: zhengni
8+
author: frankpeng7
9+
ms.author: frpeng
10+
ms.reviewer:
11+
---
12+
13+
# New-CsApplicationAccessPolicy
14+
15+
## SYNOPSIS
16+
17+
Creates a new application access policy. Application access policy contains a list of application (client) IDs. When granted to a user, those applications will be authorized to access online meetings on behalf of that user.
18+
19+
## SYNTAX
20+
21+
### Identity
22+
23+
```
24+
New-CsApplicationAccessPolicy [-Identity <XdsIdentity>] [-AppIds <PSListModifier>] [-Description <String>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
This cmdlet creates a new application access policy. Application access policy contains a list of application (client) IDs. When granted to a user, those applications will be authorized to access online meetings on behalf of that user.
30+
31+
## EXAMPLES
32+
33+
### Create a new application access policy with one app ID
34+
35+
```
36+
PS C:\> New-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds "d39597bf-8407-40ca-92ef-1ec26b885b7b" -Description "Some description"
37+
```
38+
39+
The command shown above shows how to create a new policy with one app IDs configured.
40+
41+
### Create a new application access policy with multiple app IDs
42+
43+
```
44+
PS C:\> New-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds "d39597bf-8407-40ca-92ef-1ec26b885b71", "57caaef9-5ed0-48d5-8862-e5abfa71b3e1", "dc17674c-81d9-4adb-bfb2-8f6a442e4620" -Description "Some description"
45+
```
46+
47+
The command shown above shows how to create a new policy with a list of (three) app IDs configured.
48+
49+
50+
## PARAMETERS
51+
52+
### -Identity
53+
54+
Unique identifier assigned to the policy when it was created.
55+
56+
```yaml
57+
Type: XdsIdentity
58+
Parameter Sets: (All)
59+
Aliases:
60+
61+
Required: True
62+
Position: 1
63+
Default value: None
64+
Accept pipeline input: False
65+
Accept wildcard characters: False
66+
```
67+
68+
### -AppIds
69+
70+
A list of application (client) IDs. For details of application (client) ID, refer to: [Get tenant and app ID values for signing in](https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal#get-tenant-and-app-id-values-for-signing-in).
71+
72+
```yaml
73+
Type: PSListModifier
74+
Parameter Sets: (All)
75+
Aliases:
76+
77+
Required: False
78+
Position: Named
79+
Default value: None
80+
Accept pipeline input: False
81+
Accept wildcard characters: False
82+
```
83+
84+
### -Description
85+
86+
Specifies the description of the policy.
87+
88+
```yaml
89+
Type: String
90+
Parameter Sets: (All)
91+
Aliases:
92+
93+
Required: False
94+
Position: Named
95+
Default value: None
96+
Accept pipeline input: False
97+
Accept wildcard characters: False
98+
```
99+
100+
## INPUTS
101+
102+
## OUTPUTS
103+
104+
## NOTES
105+
106+
## RELATED LINKS
107+
108+
[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md)
109+
[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
110+
[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
111+
[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)

‎skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
external help file: Microsoft.Rtc.Management.dll-help.xml
3+
online version: https://docs.microsoft.com/powershell/module/skype/remove-csapplicationaccesspolicy
4+
applicable: Skype for Business Online
5+
title: Remove-CsApplicationAccessPolicy
6+
schema: 2.0.0
7+
manager: zhengni
8+
author: frankpeng7
9+
ms.author: frpeng
10+
ms.reviewer:
11+
---
12+
13+
# Remove-CsApplicationAccessPolicy
14+
15+
## SYNOPSIS
16+
17+
Deletes an existing application access policy.
18+
19+
## SYNTAX
20+
21+
### Identity
22+
23+
```
24+
Remove-CsApplicationAccessPolicy [-Identity <XdsIdentity>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
This cmdlet deletes an existing application access policy.
30+
31+
## EXAMPLES
32+
33+
### Remove an application access policy
34+
35+
```
36+
PS C:\> Remove-CsApplicationAccessPolicy -Identity "ASimplePolicy"
37+
```
38+
39+
The command shown above deletes the application access policy ASimplePolicy.
40+
41+
## PARAMETERS
42+
43+
### -Identity
44+
45+
Unique identifier assigned to the policy when it was created.
46+
47+
```yaml
48+
Type: XdsIdentity
49+
Parameter Sets: (All)
50+
Aliases:
51+
52+
Required: True
53+
Position: 1
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
## INPUTS
60+
61+
## OUTPUTS
62+
63+
## NOTES
64+
65+
## RELATED LINKS
66+
67+
[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
68+
[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md)
69+
[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
70+
[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)

0 commit comments

Comments
 (0)