[Index]

Model: device/exchange/ManagementRoleAssignment

Model Details

Title Description Details
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
OrganizationId
  • Field Name: OrganizationId
  • Type: String
RecipientRelativeWriteScope The RecipientRelativeWriteScope parameter specifies the type of restriction to apply to a recipient scope. The available types are None, Organization, MyGAL, Self, and MyDistributionGroups. The RecipientRelativeWriteScope parameter is automatically set when the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters are used. Even though the NotApplicable, OU, MyDirectReports, CustomRecipientScope, MyExecutive, MailboxICanDelegate and ExclusiveRecipientScope values appear in the syntax block for this parameter, they can't be used directly on the command line. They are used internally by the cmdlet.
  • Field Name: RecipientRelativeWriteScope
  • Type: String
EffectiveUserName
  • Field Name: EffectiveUserName
  • Type: String
SecurityGroup * The SecurityGroup parameter specifies the name of the management role group or universal USG to assign the management role to. If you specify the SecurityGroup parameter, you can't specify the Policy, Computer, or User parameters. If the role group or USG name contains spaces, enclose the name in quotation marks (").
  • Field Name: SecurityGroup
  • Type: String
RecipientWriteScope The RecipientWriteScope parameter returns only the role assignments associated with the recipient scope restriction type specified. The valid values are None, MyGAL, Self, OU, CustomRecipientScope, MyDistributionGroups, and ExclusiveRecipientScope.
  • Field Name: RecipientWriteScope
  • Type: String
Role * The Role parameter specifies the existing role to assign. If the role name contains spaces, enclose the name in quotation marks (").
  • Field Name: Role
  • Type: String
RoleAssignmentDelegationType
  • Field Name: RoleAssignmentDelegationType
  • Type: String
Policy * The Policy parameter specifies the name of the management role assignment policy to assign the management role to. The IsEndUserRole property of the role you specify using the Role parameter must be set to $true. If you specify the Policy parameter, you can't specify the SecurityGroup, Computer, or User parameters. If the policy name contains spaces, enclose the name in quotation marks (").
  • Field Name: Policy
  • Type: String
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
RoleAssignee The RoleAssignee parameter specifies the role group, assignment policy, user, or universal security group (USG) for which you want to view role assignments. If the RoleAssignee parameter is used, you can't use the Identity parameter. By default, the command returns both direct role assignments to the role assignee, and indirect role assignments granted to a role assignee through role groups or assignment policies. If the name of the user or USG contains spaces, enclose it in quotation marks (").
  • Field Name: RoleAssignee
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSComputerName
  • Field Name: PSComputerName
  • Type: String
DataObject
  • Field Name: DataObject
  • Type: String
ObjectState
  • Field Name: ObjectState
  • Type: String
User * The User parameter specifies the name or alias of the user to assign the management role to. If you specify the User parameter, you can't specify the SecurityGroup, Computer, or Policy parameters. If the value contains spaces, enclose the name in quotation marks (").
  • Field Name: User
  • Type: String
CustomConfigWriteScope The CustomConfigWriteScope parameter specifies the existing configuration scope to associate with this management role assignment. If you use the CustomConfigWriteScope parameter you can't use the ExclusiveConfigWriteScope parameter. If the management scope name contains spaces, enclose the name in quotation marks (").
  • Field Name: CustomConfigWriteScope
  • Type: String
ExclusiveConfigWriteScope The ExclusiveConfigWriteScope parameter specifies the exclusive configuration-based management scope to associate with the new role assignment. If you use the ExclusiveConfigWriteScope parameter, you can't use the CustomConfigWriteScope parameter. If the scope name contains spaces, enclose the name in quotation marks (").
  • Field Name: ExclusiveConfigWriteScope
  • Type: String
Identity The Identity parameter specifies the name of the role assignment to retrieve. If the name of the role assignment contains spaces, enclose it in quotation marks ("). If the RoleAssignee parameter is used, you can't use the Identity parameter.
  • Field Name: Identity
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
Name The Name parameter specifies a name for the new management role assignment. The maximum length of the name is 64 characters. If the management role assignment name contains spaces, enclose the name in quotation marks ("). If you don't specify a name, one will be created automatically.
  • Field Name: Name
  • Type: String
Enabled The Enabled parameter specifies whether enabled or disabled role assignments should be returned. To return enabled role assignments, specify a value of $true. To return disabled role assignments, specify a value of $false.
  • Field Name: Enabled
  • Type: Boolean
RoleAssigneeName
  • Field Name: RoleAssigneeName
  • Type: String
RoleAssigneeType The RoleAssigneeType parameter specifies the type of role assignee to return. The valid values are User, SecurityGroup, RoleAssignmentPolicy, ForeignSecurityPrincipal, RoleGroup,LinkedRoleGroup, and Computer.
  • Field Name: RoleAssigneeType
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
IgnoreDehydratedFlag This parameter is reserved for internal Microsoft use.
  • Field Name: IgnoreDehydratedFlag
  • Type: Boolean
ExclusiveRecipientWriteScope The ExclusiveRecipientWriteScope parameter specifies the exclusive recipient-based management scope to associate with the new role assignment. If you use the ExclusiveRecipientWriteScope parameter, you can't use the CustomRecipientWriteScope or RecipientOrganizationalUnitScope parameters. If the scope name contains spaces, enclose the name in quotation marks (").
  • Field Name: ExclusiveRecipientWriteScope
  • Type: String
Organization The Organization parameter is reserved for internal Microsoft use.
  • Field Name: Organization
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
UnScopedTopLevel The UnScopedTopLevel switch specifies that the role provided with the Role parameter is an unscoped top level management role. You can only create a role assignment using the UnScopedTopLevel switch if the role specified using the Role parameter is an unscoped top level role.
  • Field Name: UnScopedTopLevel
  • Type: Boolean
Delegating The Delegating parameter specifies whether the user or USG assigned to the role can delegate the role to other users or groups. You don't have to specify a value with the Delegating parameter.
  • Field Name: Delegating
  • Type: Boolean
AssignmentChain
  • Field Name: AssignmentChain
  • Type: String
ConfigWriteScope The ConfigWriteScope parameter specifies the type of management configuration scope to include in the results returned by the cmdlet. The valid values are None, OrganizationConfig, CustomConfigScope, and ExclusiveConfigScope.
  • Field Name: ConfigWriteScope
  • Type: String
DomainController The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
  • Field Name: DomainController
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
CustomRecipientWriteScope The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with this management role assignment. If the management scope name contains spaces, enclose the name in quotation marks ("). If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope or ExclusiveRecipientWriteScope parameters.
  • Field Name: CustomRecipientWriteScope
  • Type: String
RecipientOrganizationalUnitScope The RecipientOrganizationalUnitScope parameter specifies the OU to scope the new role assignment to. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope or ExclusiveRecipientWriteScope parameters. To specify an OU, use the syntax: domain/ou. If the OU name contains spaces, enclose the domain and OU in quotation marks (").
  • Field Name: RecipientOrganizationalUnitScope
  • Type: String
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
RecipientReadScope
  • Field Name: RecipientReadScope
  • Type: String
Computer * The Computer parameter specifies the name of the computer to assign the management role to. If you specify the Computer parameter, you can't specify the SecurityGroup, User, or Policy parameters.
  • Field Name: Computer
  • Type: String
AssignmentMethod The AssignmentMethod parameter specifies the type of role assignment to include in the results returned by the cmdlet. You can specify one or more of the following values: Direct SecurityGroup RoleGroup RoleAssignmentPolicy If you provide more than one value, separate each value with a comma. You must specify a value with the RoleAssignee parameter if you use the AssignmentMethod parameter.
  • Field Name: AssignmentMethod
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
ConfigReadScope
  • Field Name: ConfigReadScope
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
API reference for device/exchange/ManagementRoleAssignment