Merge pull request #6464 from frankpeng7/application-access-policy

Added documents for application access policy cmdlets
MicrosoftDocs · Sep 11, 2020 · 92b0814 · 92b0814
2 parents 8945661 + 153043a
commit 92b0814
Show file tree

Hide file tree

Showing 5 changed files with 480 additions and 0 deletions.
diff --git a/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Get-CsApplicationAccessPolicy.md
@@ -0,0 +1,79 @@
+---
+external help file: Microsoft.Rtc.Management.dll-help.xml
+online version: https://docs.microsoft.com/powershell/module/skype/get-csapplicationaccesspolicy
+applicable: Skype for Business Online
+title: Get-CsApplicationAccessPolicy
+schema: 2.0.0
+manager: zhengni
+author: frankpeng7
+ms.author: frpeng
+ms.reviewer:
+---
+
+# Get-CsApplicationAccessPolicy
+
+## SYNOPSIS
+
+Retrieves information about the application access policy configured for use in the tenant.
+
+## SYNTAX
+
+### Identity
+
+```
+Get-CsApplicationAccessPolicy [-Identity <XdsIdentity>] 
+```
+
+## DESCRIPTION
+
+This cmdlet retrieves information about the application access policy configured for use in the tenant.
+
+## EXAMPLES
+
+### Retrieve all application access policies
+
+```
+PS C:\> Get-CsApplicationAccessPolicy
+```
+
+The command shown above returns information of all application access policies that have been configured for use in the tenant.
+
+### Retrieve specific application access policy
+
+```
+PS C:\> Get-CsApplicationAccessPolicy -Identity "ASimplePolicy"
+```
+
+In the command shown above, information is returned for a single application access policy: the policy with the Identity ASimplePolicy.
+
+
+## PARAMETERS
+
+### -Identity
+
+Unique identifier assigned to the policy when it was created.
+
+```yaml
+Type: XdsIdentity
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
+[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md)
+[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
+[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)
diff --git a/skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Grant-CsApplicationAccessPolicy.md
@@ -0,0 +1,126 @@
+---
+external help file: Microsoft.Rtc.Management.dll-help.xml
+online version: https://docs.microsoft.com/powershell/module/skype/grant-csapplicationaccesspolicy
+applicable: Skype for Business Online
+title: Grant-CsApplicationAccessPolicy
+schema: 2.0.0
+manager: zhengni
+author: frankpeng7
+ms.author: frpeng
+ms.reviewer:
+---
+
+# Grant-CsApplicationAccessPolicy
+
+## SYNOPSIS
+
+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.
+
+## SYNTAX
+
+### FileName
+
+```
+Grant-CsApplicationAccessPolicy [-Identity <UserIdParameter>] [-PolicyName <String>] [-Global]
+```
+
+## DESCRIPTION
+
+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.
+
+## EXAMPLES
+
+### Assign an application access policy to a user
+
+```
+PS C:\> Grant-CsApplicationAccessPolicy -Identity "dc17674c-81d9-4adb-bfb2-8f6a442e4624" -PolicyName "ASimplePolicy"
+```
+
+The command shown above assigns the per-user application access policy "ASimplePolicy" to the user with object ID "dc17674c-81d9-4adb-bfb2-8f6a442e4624".
+
+### Unassign an application access policy from a user
+
+```
+PS C:\> Grant-CsApplicationAccessPolicy -Identity "dc17674c-81d9-4adb-bfb2-8f6a442e4624" -PolicyName $Null
+```
+
+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).
+
+### Assign an application access policy to all users in the tenant
+
+```
+PS C:\> Get-CsOnlineUser | Grant-CsApplicationAccessPolicy -PolicyName "ASimplePolicy"
+```
+
+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".
+
+### Assign an application access policy to users who have not been assigned one
+
+```
+PS C:\> Grant-CsApplicationAccessPolicy -PolicyName "ASimplePolicy" -Global
+```
+
+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.
+
+## PARAMETERS
+
+### -Identity
+
+Indicates the user (object) ID of the user account to be assigned the per-user application access policy. 
+
+```yaml
+Type: UserIdParameter
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PolicyName
+
+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.
+
+```yaml
+Type: PSListModifier
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Global
+
+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.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets:(All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
+[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
+[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
+[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)
diff --git a/skype/skype-ps/skype/New-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/New-CsApplicationAccessPolicy.md
@@ -0,0 +1,111 @@
+---
+external help file: Microsoft.Rtc.Management.dll-help.xml
+online version: https://docs.microsoft.com/powershell/module/skype/new-csapplicationaccesspolicy
+applicable: Skype for Business Online
+title: New-CsApplicationAccessPolicy
+schema: 2.0.0
+manager: zhengni
+author: frankpeng7
+ms.author: frpeng
+ms.reviewer:
+---
+
+# New-CsApplicationAccessPolicy
+
+## SYNOPSIS
+
+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.
+
+## SYNTAX
+
+### Identity
+
+```
+New-CsApplicationAccessPolicy [-Identity <XdsIdentity>] [-AppIds <PSListModifier>] [-Description <String>]
+```
+
+## DESCRIPTION
+
+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.
+
+## EXAMPLES
+
+### Create a new application access policy with one app ID
+
+```
+PS C:\> New-CsApplicationAccessPolicy -Identity "ASimplePolicy" -AppIds "d39597bf-8407-40ca-92ef-1ec26b885b7b" -Description "Some description"
+```
+
+The command shown above shows how to create a new policy with one app IDs configured.
+
+### Create a new application access policy with multiple app IDs
+
+```
+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"
+```
+
+The command shown above shows how to create a new policy with a list of (three) app IDs configured.
+
+
+## PARAMETERS
+
+### -Identity
+
+Unique identifier assigned to the policy when it was created.
+
+```yaml
+Type: XdsIdentity
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -AppIds
+
+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).
+
+```yaml
+Type: PSListModifier
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Description
+
+Specifies the description of the policy.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md)
+[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
+[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)
+[Remove-CsApplicationAccessPolicy](Remove-CsApplicationAccessPolicy.md)
diff --git a/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md b/skype/skype-ps/skype/Remove-CsApplicationAccessPolicy.md
@@ -0,0 +1,70 @@
+---
+external help file: Microsoft.Rtc.Management.dll-help.xml
+online version: https://docs.microsoft.com/powershell/module/skype/remove-csapplicationaccesspolicy
+applicable: Skype for Business Online
+title: Remove-CsApplicationAccessPolicy
+schema: 2.0.0
+manager: zhengni
+author: frankpeng7
+ms.author: frpeng
+ms.reviewer:
+---
+
+# Remove-CsApplicationAccessPolicy
+
+## SYNOPSIS
+
+Deletes an existing application access policy.
+
+## SYNTAX
+
+### Identity
+
+```
+Remove-CsApplicationAccessPolicy [-Identity <XdsIdentity>]
+```
+
+## DESCRIPTION
+
+This cmdlet deletes an existing application access policy.
+
+## EXAMPLES
+
+### Remove an application access policy
+
+```
+PS C:\> Remove-CsApplicationAccessPolicy -Identity "ASimplePolicy"
+```
+
+The command shown above deletes the application access policy ASimplePolicy.
+
+## PARAMETERS
+
+### -Identity
+
+Unique identifier assigned to the policy when it was created.
+
+```yaml
+Type: XdsIdentity
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
+[New-CsApplicationAccessPolicy](New-CsApplicationAccessPolicy.md)
+[Grant-CsApplicationAccessPolicy](Grant-CsApplicationAccessPolicy.md)
+[Get-CsApplicationAccessPolicy](Get-CsApplicationAccessPolicy.md)
+[Set-CsApplicationAccessPolicy](Set-CsApplicationAccessPolicy.md)