[Index]

Model: device/exchange/RoleGroup

Model Details: device/exchange/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 * 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 The LinkedCredential parameter specifies credentials to use to access the domain controller specified by the LinkedDomainController parameter. This parameter requires the creation and passing of a credential object. This credential object is created 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
RoleAssignments
  • Field Name: RoleAssignments.[n]
  • Type: Array
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
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
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
PartnerManaged This parameter is reserved for internal Microsoft use.
  • Field Name: PartnerManaged
  • Type: Boolean
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 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
LinkedPartnerGroupId * This parameter is reserved for internal Microsoft use.
  • Field Name: LinkedPartnerGroupId
  • 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
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
LinkedPartnerOrganizationId * This parameter is reserved for internal Microsoft use.
  • Field Name: LinkedPartnerOrganizationId
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
RoleGroupType
  • Field Name: RoleGroupType
  • Type: String
Organization The Organization parameter is reserved for internal Microsoft use.
  • Field Name: Organization
  • Type: String
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
RunspaceId
  • Field Name: RunspaceId
  • Type: String
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
ExternalDirectoryObjectId This parameter is reserved for internal Microsoft use.
  • Field Name: ExternalDirectoryObjectId
  • 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
SamAccountName The SamAccountName parameter specifies the logon name used to support clients and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This attribute must contain fewer than 20 characters. If you don't specify this parameter, Active Directory creates a value for the SamAccountName parameter automatically, based on the user principal name (UPN).
  • Field Name: SamAccountName
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
WellKnownObjectGuid This parameter is reserved for internal Microsoft use.
  • Field Name: WellKnownObjectGuid
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
RecipientOrganizationalUnitScope 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 * 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
ValidationOrganization This parameter is reserved for internal Microsoft use.
  • Field Name: ValidationOrganization
  • Type: String
Guid
  • Field Name: Guid
  • Type: String