Thousands of Objects to Process Might Be a Graph Task
A reader asked about how to report details of 3,500 distribution lists and their owners. Normally, once the need exists to process thousands of Exchange Online articles, I think about using the Graph API (the Groups API in this case) to retrieve the set of distribution lists. The Graph API is a lot faster to find objects, but more code must be written, and an app registered in Azure AD. In any case, if the need is for a one-off report, you don’t need to go near the Graph as plain and simple PowerShell will serve nicely.
Writing Plain PowerShell to Create the Report
There aren’t many challenges involved in creating the script. Exchange Online stores the owners (managers) of a distribution list in the list’s ManagedBy property. Examining the property, we find one or more names of mailboxes or distribution lists. For example:
All Company Employees {Administrator, Kim Akers}
We could fetch the set of distribution lists and output whatever properties seem to make sense (display name, managed by, and email address), but we can retrieve more precise information by using the name of each owner to fetch its display name and email address, which is what I ended up doing with the Get-Recipient cmdlet. If you’re happy to report the owner information returned by the Get-DistributionGroup cmdlet, you can speed up processing by removing the code used to fetch the owner details.
After fetching details of each distribution list, all that’s left to do is create a record in a PowerShell list. Here’s the core code from the script. You’ll note that I exclude room lists from the set of distribution lists fetched from Exchange.
$OrgName = (Get-OrganizationConfig).DisplayName
Write-Host "Finding Distribution lists in" $OrgName "..."
[array]$DLs = Get-DistributionGroup -ResultSize Unlimited -Filter {RecipientTypeDetails -ne "Roomlist"} | Select DisplayName, ExternalDirectoryObjectId, ManagedBy
If (!($DLs)) { Write-Host "No distribution lists found - exiting" ; break }
$Report = [System.Collections.Generic.List[Object]]::new()
Write-Host "Reporting Distribution lists and their managers..."
ForEach ($DL in $DLs) {
$ManagerList = [System.Collections.Generic.List[Object]]::new()
ForEach ($Manager in $DL.ManagedBy) {
$Recipient = Get-Recipient -Identity $Manager -ErrorAction SilentlyContinue
If (!($Recipient)) { # Can't resolve manager
$Recipient = "Unknown user" }
$ManagerLine = [PSCustomObject][Ordered]@{
DisplayName = $Recipient.DisplayName
UPN = $Recipient.WIndowsLiveID }
$ManagerList.Add($ManagerLine)
} # End processing managers
$Managers = $ManagerList.DisplayName -join ", "
$DLLine = [PSCustomObject][Ordered]@{
DisplayName = $DL.DisplayName
Managers = $Managers
EMailAddress = $DL.PrimarySmtpAddress }
$Report.Add($DLLine)
} # End processing DL
After processing all the distribution lists, we create the report, which I did in both HTML (Figure 1) and CSV format, and the job is done. You can download the script from GitHub.
Figure 1: A HTML report of distribution lists and their managers
Using the Graph API
I describe above some current limitations using the Groups Graph API with distribution lists. One situation where the Graph shines is to report the membership of distribution lists. As you might recall, distribution lists support nesting, so it’s entirely possible that a distribution list might have several other distribution lists in its membership. I cover how to do this in a Practical365.com article. The output of that script is shown in Figure 2.
Figure 2: The report with expanded membership information
If you look at the script code, you’ll see that I use Get-DistributionGroup to fetch the set of distribution lists. It’s possible to do the same with a Graph query like the one shown below ($ characters are escaped for use with PowerShell). This is an advanced Azure AD query (see this page for more information). Get-GraphData is a function written to return data from a Graph query (the function is included in the script).
$Uri = "https://graph.microsoft.com/beta/groups?`$filter=Mailenabled eq true and not groupTypes/any(c:c+eq+'Unified')&`$count=true"
[array]$DLs = Get-GraphData -AccessToken $Token -Uri $uri
However, the data returned by the Groups API does not include the owner information. In fact, the List Owners call in the Groups API can’t currently return owners of distribution lists, which means that you need to use PowerShell to get this information, and because you need to run Get-DistributionGroup to get the owner list, there’s no point in using both the Graph query and Get-DistributionGroup as this just slows things down.
I’ve updated the distribution list membership script to report the expanded details of distribution list owners as described above. Now you have two choices for how to report distribution lists and their owners – with or without membership information.
Quick and Dirty Code
The script written to create the distribution list ownership report is very much a quick hack, using bits of other scripts (like the one to report the membership of Microsoft 365 groups), all stitched together with speed. Having a bag of tricks available in the form of a GitHub repository of scripts makes tenant administration just a little easier!
PS. There’s nothing in the code which is specific to Exchange Online. It should run without alteration against Exchange Server.The second script depends on the Microsoft Graph API and won’t run against Exchange Server.
Learn how to exploit the Office 365 data available to tenant administrators through the Office 365 for IT Pros eBook. We love figuring out how things work.
2 Replies to “How to Create a Report of Distribution Lists and their Owners”
Thank you for the script, it works great! I only noticed that if some owners has two or more email addresses (external ones, for example), their name will appear two, three or more times in the owner’s column. Is there a way to avoid this?
Many thanks for your help!
{"id":null,"mode":"button","open_style":"in_modal","currency_code":"EUR","currency_symbol":"\u20ac","currency_type":"decimal","blank_flag_url":"https:\/\/office365itpros.com\/wp-content\/plugins\/tip-jar-wp\/\/assets\/images\/flags\/blank.gif","flag_sprite_url":"https:\/\/office365itpros.com\/wp-content\/plugins\/tip-jar-wp\/\/assets\/images\/flags\/flags.png","default_amount":100,"top_media_type":"featured_image","featured_image_url":"https:\/\/office365itpros.com\/wp-content\/uploads\/2022\/11\/cover-141x200.jpg","featured_embed":"","header_media":null,"file_download_attachment_data":null,"recurring_options_enabled":true,"recurring_options":{"never":{"selected":true,"after_output":"One time only"},"weekly":{"selected":false,"after_output":"Every week"},"monthly":{"selected":false,"after_output":"Every month"},"yearly":{"selected":false,"after_output":"Every year"}},"strings":{"current_user_email":"","current_user_name":"","link_text":"Virtual Tip Jar","complete_payment_button_error_text":"Check info and try again","payment_verb":"Pay","payment_request_label":"Office 365 for IT Pros","form_has_an_error":"Please check and fix the errors above","general_server_error":"Something isn't working right at the moment. Please try again.","form_title":"Office 365 for IT Pros","form_subtitle":null,"currency_search_text":"Country or Currency here","other_payment_option":"Other payment option","manage_payments_button_text":"Manage your payments","thank_you_message":"Thank you for supporting the work of Office 365 for IT Pros!","payment_confirmation_title":"Office 365 for IT Pros","receipt_title":"Your Receipt","print_receipt":"Print Receipt","email_receipt":"Email Receipt","email_receipt_sending":"Sending receipt...","email_receipt_success":"Email receipt successfully sent","email_receipt_failed":"Email receipt failed to send. Please try again.","receipt_payee":"Paid to","receipt_statement_descriptor":"This will show up on your statement as","receipt_date":"Date","receipt_transaction_id":"Transaction ID","receipt_transaction_amount":"Amount","refund_payer":"Refund from","login":"Log in to manage your payments","manage_payments":"Manage Payments","transactions_title":"Your Transactions","transaction_title":"Transaction Receipt","transaction_period":"Plan Period","arrangements_title":"Your Plans","arrangement_title":"Manage Plan","arrangement_details":"Plan Details","arrangement_id_title":"Plan ID","arrangement_payment_method_title":"Payment Method","arrangement_amount_title":"Plan Amount","arrangement_renewal_title":"Next renewal date","arrangement_action_cancel":"Cancel Plan","arrangement_action_cant_cancel":"Cancelling is currently not available.","arrangement_action_cancel_double":"Are you sure you'd like to cancel?","arrangement_cancelling":"Cancelling Plan...","arrangement_cancelled":"Plan Cancelled","arrangement_failed_to_cancel":"Failed to cancel plan","back_to_plans":"\u2190 Back to Plans","update_payment_method_verb":"Update","sca_auth_description":"Your have a pending renewal payment which requires authorization.","sca_auth_verb":"Authorize renewal payment","sca_authing_verb":"Authorizing payment","sca_authed_verb":"Payment successfully authorized!","sca_auth_failed":"Unable to authorize! Please try again.","login_button_text":"Log in","login_form_has_an_error":"Please check and fix the errors above","uppercase_search":"Search","lowercase_search":"search","uppercase_page":"Page","lowercase_page":"page","uppercase_items":"Items","lowercase_items":"items","uppercase_per":"Per","lowercase_per":"per","uppercase_of":"Of","lowercase_of":"of","back":"Back to plans","zip_code_placeholder":"Zip\/Postal Code","download_file_button_text":"Download File","input_field_instructions":{"tip_amount":{"placeholder_text":"How much would you like to tip?","initial":{"instruction_type":"normal","instruction_message":"How much would you like to tip? Choose any currency."},"empty":{"instruction_type":"error","instruction_message":"How much would you like to tip? Choose any currency."},"invalid_curency":{"instruction_type":"error","instruction_message":"Please choose a valid currency."}},"recurring":{"placeholder_text":"Recurring","initial":{"instruction_type":"normal","instruction_message":"How often would you like to give this?"},"success":{"instruction_type":"success","instruction_message":"How often would you like to give this?"},"empty":{"instruction_type":"error","instruction_message":"How often would you like to give this?"}},"name":{"placeholder_text":"Name on Credit Card","initial":{"instruction_type":"normal","instruction_message":"Enter the name on your card."},"success":{"instruction_type":"success","instruction_message":"Enter the name on your card."},"empty":{"instruction_type":"error","instruction_message":"Please enter the name on your card."}},"privacy_policy":{"terms_title":"Terms and conditions","terms_body":null,"terms_show_text":"View Terms","terms_hide_text":"Hide Terms","initial":{"instruction_type":"normal","instruction_message":"I agree to the terms."},"unchecked":{"instruction_type":"error","instruction_message":"Please agree to the terms."},"checked":{"instruction_type":"success","instruction_message":"I agree to the terms."}},"email":{"placeholder_text":"Your email address","initial":{"instruction_type":"normal","instruction_message":"Enter your email address"},"success":{"instruction_type":"success","instruction_message":"Enter your email address"},"blank":{"instruction_type":"error","instruction_message":"Enter your email address"},"not_an_email_address":{"instruction_type":"error","instruction_message":"Make sure you have entered a valid email address"}},"note_with_tip":{"placeholder_text":"Your note here...","initial":{"instruction_type":"normal","instruction_message":"Attach a note to your tip (optional)"},"empty":{"instruction_type":"normal","instruction_message":"Attach a note to your tip (optional)"},"not_empty_initial":{"instruction_type":"normal","instruction_message":"Attach a note to your tip (optional)"},"saving":{"instruction_type":"normal","instruction_message":"Saving note..."},"success":{"instruction_type":"success","instruction_message":"Note successfully saved!"},"error":{"instruction_type":"error","instruction_message":"Unable to save note note at this time. Please try again."}},"email_for_login_code":{"placeholder_text":"Your email address","initial":{"instruction_type":"normal","instruction_message":"Enter your email to log in."},"success":{"instruction_type":"success","instruction_message":"Enter your email to log in."},"blank":{"instruction_type":"error","instruction_message":"Enter your email to log in."},"empty":{"instruction_type":"error","instruction_message":"Enter your email to log in."}},"login_code":{"initial":{"instruction_type":"normal","instruction_message":"Check your email and enter the login code."},"success":{"instruction_type":"success","instruction_message":"Check your email and enter the login code."},"blank":{"instruction_type":"error","instruction_message":"Check your email and enter the login code."},"empty":{"instruction_type":"error","instruction_message":"Check your email and enter the login code."}},"stripe_all_in_one":{"initial":{"instruction_type":"normal","instruction_message":"Enter your credit card details here."},"empty":{"instruction_type":"error","instruction_message":"Enter your credit card details here."},"success":{"instruction_type":"normal","instruction_message":"Enter your credit card details here."},"invalid_number":{"instruction_type":"error","instruction_message":"The card number is not a valid credit card number."},"invalid_expiry_month":{"instruction_type":"error","instruction_message":"The card's expiration month is invalid."},"invalid_expiry_year":{"instruction_type":"error","instruction_message":"The card's expiration year is invalid."},"invalid_cvc":{"instruction_type":"error","instruction_message":"The card's security code is invalid."},"incorrect_number":{"instruction_type":"error","instruction_message":"The card number is incorrect."},"incomplete_number":{"instruction_type":"error","instruction_message":"The card number is incomplete."},"incomplete_cvc":{"instruction_type":"error","instruction_message":"The card's security code is incomplete."},"incomplete_expiry":{"instruction_type":"error","instruction_message":"The card's expiration date is incomplete."},"incomplete_zip":{"instruction_type":"error","instruction_message":"The card's zip code is incomplete."},"expired_card":{"instruction_type":"error","instruction_message":"The card has expired."},"incorrect_cvc":{"instruction_type":"error","instruction_message":"The card's security code is incorrect."},"incorrect_zip":{"instruction_type":"error","instruction_message":"The card's zip code failed validation."},"invalid_expiry_year_past":{"instruction_type":"error","instruction_message":"The card's expiration year is in the past"},"card_declined":{"instruction_type":"error","instruction_message":"The card was declined."},"missing":{"instruction_type":"error","instruction_message":"There is no card on a customer that is being charged."},"processing_error":{"instruction_type":"error","instruction_message":"An error occurred while processing the card."},"invalid_request_error":{"instruction_type":"error","instruction_message":"Unable to process this payment, please try again or use alternative method."},"invalid_sofort_country":{"instruction_type":"error","instruction_message":"The billing country is not accepted by SOFORT. Please try another country."}}}},"fetched_oembed_html":false}
Thank you for the script, it works great! I only noticed that if some owners has two or more email addresses (external ones, for example), their name will appear two, three or more times in the owner’s column. Is there a way to avoid this?
Many thanks for your help!
I’ll take a look and see what’s happening…