Add-AzureRemoteAppUser
Adds a user to an Azure RemoteApp collection.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
Default (Default)
Add-AzureRemoteAppUser
[-CollectionName] <String>
[-Type] <PrincipalProviderType>
[-UserUpn] <String[]>
[-Alias <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
The Add-AzureRemoteAppUser cmdlet adds a user to an Azure RemoteApp collection.
Examples
Example 1: Add a user using a Microsoft Account
PS C:\> Add-AzureRemoteAppUser -CollectionName "Contoso" -UserType MicrosoftAccount -UserUpn "PattiFuller@contoso.com"
This command adds the Microsoft Account PattiFuller@contoso.com to the collection named Contoso.
Example 2: Add a user using a Microsoft Entra account
PS C:\> Add-AzureRemoteAppUser -CollectionName "Contoso" -UserType OrgId -UserUpn "PattiFuller@contoso.com"
This command adds the Microsoft Entra account PattiFuller@contoso.com to the collection named Contoso.
Parameters
-Alias
Specifies a published program alias. You can use this parameter only in per-app publishing mode.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CollectionName
Specifies the name of the Azure RemoteApp collection.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Specifies a user type. The acceptable values for this parameter are: OrgId or MicrosoftAccount.
Parameter properties
| Type: | PrincipalProviderType |
| Default value: | None |
| Accepted values: | OrgId, MicrosoftAccount |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserUpn
Specifies the User Principal Name (UPN) of a user, for example, PattiFuller@contoso.com.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.