[Index]

Model: device/exchangeonline/RoleGroup

Model Details: device/exchangeonline/RoleGroup

Title Description Details
LinkedGroup
  • Field Name: LinkedGroup
  • Type: String
DisplayName The DisplayName parameter specifies the friendly name of the role group. If the name contains spaces, enclose the name in quotation marks ("). This parameter can have a maximum length of 256 characters.
  • Field Name: DisplayName
  • Type: String
LinkedDomainController * This parameter is available only in on-premises Exchange 2016. The LinkedDomainController parameter specifies the fully qualified domain name (FQDN) or IP address of the domain controller in the forest where the foreign USG resides. The domain controller you specify is used to get security information for the foreign USG specified by the LinkedForeignGroup parameter. If you use the LinkedDomainController parameter, you must specify a foreign USG with the LinkedForeignGroup parameter, and you can't use the Members parameter.
  • Field Name: LinkedDomainController
  • Type: String
OrganizationId
  • Field Name: OrganizationId
  • Type: String
LinkedCredential This parameter is available only in on-premises Exchange 2016. The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential (http://go.microsoft.com/fwlink/p/?linkId=142122).
  • Field Name: LinkedCredential
  • Type: String
Capabilities
  • Field Name: Capabilities
  • Type: String
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
Name * The Name parameter specifies the name of the new role group. The name can have a maximum of 64 characters. If the name contains spaces, enclose the name in quotation marks ("). If you create a linked role group, we recommend that you include the name of the foreign forest in the name of the role group so that you can more easily associate the linked role group and the associated foreign forest. This is especially important if you have multiple forests.
  • Field Name: Name
  • Type: String
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
Description The Description parameter specifies the description that's displayed when the role group is viewed using the Get-RoleGroup cmdlet. Enclose the description in quotation marks (").
  • Field Name: Description
  • Type: String
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PSComputerName
  • Field Name: PSComputerName
  • Type: String
ManagedBy The ManagedBy parameter specifies the users or USGs who can modify the configuration of a role group or add and remove members to or from a role group. You can use the name, distinguished name (DN), or primary SMTP address of the user or USG that you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). If you want to add more than one user or USG, separate them using commas.
  • Field Name: ManagedBy.[n]
  • Type: Array
Members The Members parameter specifies the mailboxes or USGs to add as a member of the role group. You can use the name, DN, or primary SMTP address of the user or USG you want to add. If the name of the user or USG contains spaces, enclose the name in quotation marks ("). If you want to add more than one user or USG, separate them using commas. If you use the Members parameter, you can't use the LinkedForeignGroup, LinkedDomainController, or LinkedCredential parameters.
  • Field Name: Members.[n]
  • Type: Array
CustomConfigWriteScope This parameter is available only in on-premises Exchange 2016. The CustomConfigWriteScope parameter specifies the existing configuration-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks ("). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes.
  • Field Name: CustomConfigWriteScope
  • Type: String
CustomRecipientWriteScope The CustomRecipientWriteScope parameter specifies the existing recipient-based management scope to associate with management role assignments created with this role group. If the management scope name contains spaces, enclose the name in quotation marks ("). Use the Get-ManagementScope cmdlet to retrieve a list of existing management scopes. If you use the CustomRecipientWriteScope parameter, you can't use the RecipientOrganizationalUnitScope parameter.
  • Field Name: CustomRecipientWriteScope
  • Type: String
Identity The Identity parameter specifies the role group to retrieve. If the name of the role group contains spaces, enclose the name in quotation marks ("). If the Identity parameter isn't specified, all role groups are returned.
  • Field Name: Identity
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
RoleAssignments
  • Field Name: RoleAssignments.[n]
  • Type: Array
Roles The Roles parameter specifies the management roles to assign to the role group when it's created. If a role name contains spaces, enclose the name in quotation marks ("). If you want to assign more that one role, separate the role names with commas. For a list of built-in management roles that you can assign to a role group, see Built-in management roles.
  • Field Name: Roles.[n]
  • Type: Array
LinkedPartnerOrganizationId
  • Field Name: LinkedPartnerOrganizationId
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
RoleGroupType
  • Field Name: RoleGroupType
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
LinkedPartnerGroupId
  • Field Name: LinkedPartnerGroupId
  • Type: String
ExternalDirectoryObjectId
  • Field Name: ExternalDirectoryObjectId
  • Type: String
DomainController This parameter is available only in on-premises Exchange 2016. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
  • Field Name: DomainController
  • Type: String
SamAccountName This parameter is available only in on-premises Exchange 2016. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, _, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and รถ match). The maximum length is 20 characters.
  • Field Name: SamAccountName
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
RecipientOrganizationalUnitScope This parameter is available only in on-premises Exchange 2016. The RecipientOrganizationalUnitScope parameter specifies the organizational unit (OU) scope added to the role assignments created when the role group is created. If you use the RecipientOrganizationalUnitScope parameter, you can't use the CustomRecipientWriteScope parameter. 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
LinkedForeignGroup * This parameter is available only in on-premises Exchange 2016. The LinkedForeignGroup parameter specifies the name of the foreign USG you want to link this role group to. If the foreign USG name contains spaces, enclose the name in quotation marks ("). If you use the LinkedForeignGroup parameter, you must specify a domain controller in the LinkedDomainController parameter, and you can't use the Members parameter.
  • Field Name: LinkedForeignGroup
  • Type: String
ObjectState
  • Field Name: ObjectState
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
Id
  • Field Name: Id
  • Type: String