List All Distribution Groups
Get information on all existing Distribution Groups.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| User Name | String | Yes | User name used to authenticate to the Office 365 web service. |
| Password | Password | Yes | Password used to authenticate to the Office 365 web service. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Distribution Groups | Array | Array containing information on all Distribution Groups. |
| Groups Count | Number | The number of Distribution Groups returned within the array. |
| Runspace ID | String | ID used by Microsoft. |
| Group Type | String | The type of Distribution Group. |
| SAM Account Name | String | The SAM account name of the distribution group. |
| Bypass Nested Moderation Enabled | Boolean | If the Distribution Group is configured has bypass nested moderation enabled or not. |
| Member Join Restriction | String | The configured member join restriction of the Distribution Group. |
| Member Depart Restriction | String | The configured member depart restriction of the Distribution Group. |
| Expansion Server | String | Server name for Microsoft use. |
| Report to Manager Enabled | Boolean | Specifies whether the group reports to a manager in case of changes. |
| Report to Originator Enabled | Boolean | Specifies whether the group reports to the creator in case of changes. |
| Send Message to Originator Enabled | Boolean | Specifies whether the creator gets a message. |
| Alias | String | Alias of the Distribution Group. |
| Arbitration Mailbox | String | Name of the arbitration mailbox in case of issues. |
| Organizational Unit | String | Name of the OU in AD. |
| Custom Attribute 1 | String | Custom attribute 1 of the Distribution Group. |
| Custom Attribute 2 | String | Custom attribute 2 of the Distribution Group. |
| Custom Attribute 3 | String | Custom attribute 3 of the Distribution Group. |
| Custom Attribute 4 | String | Custom attribute 4 of the Distribution Group. |
| Custom Attribute 5 | String | Custom attribute 5 of the Distribution Group. |
| Custom Attribute 6 | String | Custom attribute 6 of the Distribution Group. |
| Custom Attribute 7 | String | Custom attribute 7 of the Distribution Group. |
| Custom Attribute 8 | String | Custom attribute 8 of the Distribution Group. |
| Custom Attribute 9 | String | Custom attribute 9 of the Distribution Group. |
| Custom Attribute 10 | String | Custom attribute 10 of the Distribution Group. |
| Custom Attribute 11 | String | Custom attribute 11 of the Distribution Group. |
| Custom Attribute 12 | String | Custom attribute 12 of the Distribution Group. |
| Custom Attribute 13 | String | Custom attribute 13 of the Distribution Group. |
| Custom Attribute 14 | String | Custom attribute 14 of the Distribution Group. |
| Custom Attribute 15 | String | Custom attribute 15 of the Distribution Group. |
| Display Name | String | Display name of the Distribution Group. |
| External Directory Object ID | String | The external directory object ID of the Distribution Group. |
| Hidden from address List Enabled | String | Whether the Distribution Group is configured to be hidden from Exchange address lists or not. |
| Last Exchange Changed Time | Date | The date and time the Distribution Group was last changed. |
| Legacy Exchange DN | String | The legacy distinguished name of the Distribution Group. |
| Max Send Size | String | The maximum size message that can be sent from the Distribution Group. |
| Max Receive Size | String | The maximum size message that can be received by the Distribution Group. |
| Moderation Enabled | Boolean | Whether or not moderation is enabled on the Distribution Group. |
| Email Address Policy Enabled | Boolean | Whether or not email address policy is enabled in the Distribution Group. |
| Primary SMTP Address | String | The primary SMTP address of the Distribution Group. |
| Recipient Type | String | The type of Distribution Group recipient. |
| Recipient Type Details | String | Details of the type of Distribution Group recipient. |
| Require Sender Authentication Enabled | Boolean | Whether required sender authentication is enabled on the Distribution Group or not. |
| Simple Display Name | String | Simple display name of the Distribution Group. |
| Send Moderation Notifications | String | Whether or not send moderation notification is enabled for the Distribution Group. |
| Windows Email Address | String | The Windows email address of the Distribution Group. |
| Mail Tip | String | The mail tip for the Distribution Group. |
| Partner Object ID | String | The partner object ID of the Distribution Group. |
| Identity | String | Identity of the Distribution Group. |
| Is Valid | Boolean | Whether or not the group is valid. |
| Exchange Version | String | The version of the Exchange server that is hosting the Distribution Group. |
| Name | String | Name of the Distribution Group. |
| Distinguished Name | String | The distinguished name of the Distribution Group. |
| GUID | String | GUID of the Distribution Group. |
| Object Category | String | The object category of the Distribution Group. |
| When Changed | Date | The date and time the Distribution Group was last changed. |
| When Created | Date | The date and time the Distribution Group was created. |
| When Changed UTC | String | The date and time in UTC format the Distribution Group was last changed. |
| When Created UTC | String | The date and time in UTC format the Distribution Group was created. |
| Organizational ID | String | The organizational ID of the Distribution Group. |
| Originating Server | String | The originating server of the Distribution Group. |
| Result String | String | Object Execution Error Details. |
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| User Name | String | Yes | Office365Admin@ABC.onmicrosoft.com |
| Password | Password | Yes | <link to start parameter> |