< Back
New-RdsRoleAssignment
Post
NAME New-RdsRoleAssignment
SYNTAX
New-RdsRoleAssignment [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -AADTenantId <string> -Deployment
[<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantGroupName <string> -AADTenantId
<string> [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantName <string> [-TenantGroupName
<string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantName <string> -HostPoolName
<string> [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantName <string> -HostPoolName
<string> -AppGroupName <string> [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -Deployment [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantGroupName <string>
[<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantName <string>
[-TenantGroupName <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantName <string> -HostPoolName
<string> [-TenantGroupName <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantName <string> -HostPoolName
<string> -AppGroupName <string> [-TenantGroupName <string>] [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -GroupObjectId <string> -AADTenantId <string> -Deployment
[<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -GroupObjectId <string> -TenantGroupName <string> -AADTenantId
<string> [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -TenantName <string> [-GroupObjectId <string>]
[-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -TenantName <string> -HostPoolName <string> [-GroupObjectId
<string>] [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -TenantName <string> -HostPoolName <string> -AppGroupName
<string> [-GroupObjectId <string>] [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
PARAMETERS
-AADTenantId <string>
AAD Tenant Id
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SignInNameRoleAssignmentTenantGroupScopeParameterSet, SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet,
GroupRoleAssignmentDeploymentScopeParameterSet, GroupRoleAssignmentTenantGroupScopeParameterSet,
GroupRoleAssignmentTenantScopeParameterSet, GroupRoleAssignmentHostPoolScopeParameterSet,
GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-AppGroupName <string>
RDmi Application group name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentAppGroupScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-ApplicationId <string>
The app SPN.
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SPNRoleAssignmentDeploymentScopeParameterSet,
SPNRoleAssignmentTenantGroupScopeParameterSet, SPNRoleAssignmentTenantScopeParameterSet,
SPNRoleAssignmentHostPoolScopeParameterSet, SPNRoleAssignmentAppGroupScopeParameterSet
Aliases SPN, ServicePrincipalName
Dynamic? false
-Deployment
At Deployment Scope
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SPNRoleAssignmentDeploymentScopeParameterSet, GroupRoleAssignmentDeploymentScopeParameterSet
Aliases None
Dynamic? false
-GroupObjectId <string>
AAD Tenant User Group object Id
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name GroupRoleAssignmentDeploymentScopeParameterSet,
GroupRoleAssignmentTenantGroupScopeParameterSet, GroupRoleAssignmentTenantScopeParameterSet,
GroupRoleAssignmentHostPoolScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases AADGroupId, UserGroupObjectId
Dynamic? false
-HostPoolName <string>
RDmi Host pool name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentHostPoolScopeParameterSet,
SignInNameRoleAssignmentAppGroupScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentHostPoolScopeParameterSet,
GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-RoleDefinitionName <string>
Role definition name. For e.g. RDS Reader, RDS Contributor, RDS Owner.
Required? true
Position? 0
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SignInNameRoleAssignmentTenantGroupScopeParameterSet, SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet,
SPNRoleAssignmentDeploymentScopeParameterSet, SPNRoleAssignmentTenantGroupScopeParameterSet,
SPNRoleAssignmentTenantScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentDeploymentScopeParameterSet,
GroupRoleAssignmentTenantGroupScopeParameterSet, GroupRoleAssignmentTenantScopeParameterSet,
GroupRoleAssignmentHostPoolScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-SignInName <string>
The user SignInName.
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SignInNameRoleAssignmentTenantGroupScopeParameterSet, SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet
Aliases Email, UserPrincipalName
Dynamic? false
-TenantGroupName <string>
RDmi Tenant Group name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentTenantGroupScopeParameterSet,
SignInNameRoleAssignmentTenantScopeParameterSet, SignInNameRoleAssignmentHostPoolScopeParameterSet,
SignInNameRoleAssignmentAppGroupScopeParameterSet, SPNRoleAssignmentTenantGroupScopeParameterSet,
SPNRoleAssignmentTenantScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentTenantGroupScopeParameterSet,
GroupRoleAssignmentTenantScopeParameterSet, GroupRoleAssignmentHostPoolScopeParameterSet,
GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-TenantName <string>
RDmi Tenant name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet,
SPNRoleAssignmentTenantScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentTenantScopeParameterSet,
GroupRoleAssignmentHostPoolScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Management.Automation.SwitchParameter
OUTPUTS
System.Object
ALIASES
None
REMARKS
None
SYNTAX
New-RdsRoleAssignment [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -AADTenantId <string> -Deployment
[<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantGroupName <string> -AADTenantId
<string> [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantName <string> [-TenantGroupName
<string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantName <string> -HostPoolName
<string> [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -SignInName <string> -TenantName <string> -HostPoolName
<string> -AppGroupName <string> [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -Deployment [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantGroupName <string>
[<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantName <string>
[-TenantGroupName <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantName <string> -HostPoolName
<string> [-TenantGroupName <string>] [<CommonParameters>]
New-RdsRoleAssignment [-RoleDefinitionName] <string> -ApplicationId <string> -TenantName <string> -HostPoolName
<string> -AppGroupName <string> [-TenantGroupName <string>] [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -GroupObjectId <string> -AADTenantId <string> -Deployment
[<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -GroupObjectId <string> -TenantGroupName <string> -AADTenantId
<string> [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -TenantName <string> [-GroupObjectId <string>]
[-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -TenantName <string> -HostPoolName <string> [-GroupObjectId
<string>] [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
New-RdsRoleAssignment -RoleDefinitionName <string> -TenantName <string> -HostPoolName <string> -AppGroupName
<string> [-GroupObjectId <string>] [-TenantGroupName <string>] [-AADTenantId <string>] [<CommonParameters>]
PARAMETERS
-AADTenantId <string>
AAD Tenant Id
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SignInNameRoleAssignmentTenantGroupScopeParameterSet, SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet,
GroupRoleAssignmentDeploymentScopeParameterSet, GroupRoleAssignmentTenantGroupScopeParameterSet,
GroupRoleAssignmentTenantScopeParameterSet, GroupRoleAssignmentHostPoolScopeParameterSet,
GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-AppGroupName <string>
RDmi Application group name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentAppGroupScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-ApplicationId <string>
The app SPN.
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SPNRoleAssignmentDeploymentScopeParameterSet,
SPNRoleAssignmentTenantGroupScopeParameterSet, SPNRoleAssignmentTenantScopeParameterSet,
SPNRoleAssignmentHostPoolScopeParameterSet, SPNRoleAssignmentAppGroupScopeParameterSet
Aliases SPN, ServicePrincipalName
Dynamic? false
-Deployment
At Deployment Scope
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SPNRoleAssignmentDeploymentScopeParameterSet, GroupRoleAssignmentDeploymentScopeParameterSet
Aliases None
Dynamic? false
-GroupObjectId <string>
AAD Tenant User Group object Id
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name GroupRoleAssignmentDeploymentScopeParameterSet,
GroupRoleAssignmentTenantGroupScopeParameterSet, GroupRoleAssignmentTenantScopeParameterSet,
GroupRoleAssignmentHostPoolScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases AADGroupId, UserGroupObjectId
Dynamic? false
-HostPoolName <string>
RDmi Host pool name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentHostPoolScopeParameterSet,
SignInNameRoleAssignmentAppGroupScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentHostPoolScopeParameterSet,
GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-RoleDefinitionName <string>
Role definition name. For e.g. RDS Reader, RDS Contributor, RDS Owner.
Required? true
Position? 0
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SignInNameRoleAssignmentTenantGroupScopeParameterSet, SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet,
SPNRoleAssignmentDeploymentScopeParameterSet, SPNRoleAssignmentTenantGroupScopeParameterSet,
SPNRoleAssignmentTenantScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentDeploymentScopeParameterSet,
GroupRoleAssignmentTenantGroupScopeParameterSet, GroupRoleAssignmentTenantScopeParameterSet,
GroupRoleAssignmentHostPoolScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-SignInName <string>
The user SignInName.
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentDeploymentScopeParameterSet,
SignInNameRoleAssignmentTenantGroupScopeParameterSet, SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet
Aliases Email, UserPrincipalName
Dynamic? false
-TenantGroupName <string>
RDmi Tenant Group name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentTenantGroupScopeParameterSet,
SignInNameRoleAssignmentTenantScopeParameterSet, SignInNameRoleAssignmentHostPoolScopeParameterSet,
SignInNameRoleAssignmentAppGroupScopeParameterSet, SPNRoleAssignmentTenantGroupScopeParameterSet,
SPNRoleAssignmentTenantScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentTenantGroupScopeParameterSet,
GroupRoleAssignmentTenantScopeParameterSet, GroupRoleAssignmentHostPoolScopeParameterSet,
GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
-TenantName <string>
RDmi Tenant name
Required? true
Position? Named
Accept pipeline input? true (ByPropertyName)
Parameter set name SignInNameRoleAssignmentTenantScopeParameterSet,
SignInNameRoleAssignmentHostPoolScopeParameterSet, SignInNameRoleAssignmentAppGroupScopeParameterSet,
SPNRoleAssignmentTenantScopeParameterSet, SPNRoleAssignmentHostPoolScopeParameterSet,
SPNRoleAssignmentAppGroupScopeParameterSet, GroupRoleAssignmentTenantScopeParameterSet,
GroupRoleAssignmentHostPoolScopeParameterSet, GroupRoleAssignmentAppGroupScopeParameterSet
Aliases None
Dynamic? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
System.Management.Automation.SwitchParameter
OUTPUTS
System.Object
ALIASES
None
REMARKS
None