Blog posts, articles, and books are hostage to the passing of time and the evolution of technology. I’ve known this truth for years, but it does keep on recurring at regular intervals. For instance, this week I’ve been working on my session for the European SharePoint Conference (ESPC), which takes place in Copenhagen from November 28 to December 1.
My session is about managing Teams for success, a topic that’s impossible to cover in the allotted hour. Focus is therefore necessary, and I’ve decided to discuss issues like Teams sprawl and automation. While preparing my slides, I looked at a Petri.com article I wrote in April 2019 covering the lack of a Teams directory and how to generate such a directory. A Teams directory helps those who create teams know if a suitable team is already available. It also helps users find teams that they might want to join.
Finding Areas for Improvement
The code in the script I wrote then is not what I would write now. This is natural. We all accumulate knowledge over time and that knowledge guides us on how we solve problems. New technology and updates become available too, and the combination of new technology and new knowledge makes it inevitable that the solution to a problem will probably explore new approaches. There was nothing I could do but start reviewing the code to find areas for improvement.
After the review, I found one technology gap and a couple of ways to improve the script:
Teams has changed the format of the internal identifier used to create the deeplink to a team. Recently-created teams use the new format while older teams have the old format. Obviously, the code needs to cope with both formats.
The old script uses cmdlets from the Microsoft Teams and Exchange Online management PowerShell modules. Although Microsoft has improved both modules since 2019, using the Microsoft Graph PowerShell SDK should aid performance, especially when the number of teams in a tenant grows into the thousands. At least, that’s the theory.
The output (an HTML file and a CSV file) could be improved. For instance, the ImportExcel module supports the generation of nicely-formatted Excel worksheets instead of plain CSV files.
Rewriting Code
Replacing the Get-Team and Get-UnifiedGroup cmdlets with the Microsoft Graph PowerShell SDK is straightforward. The Get-MgTeam cmdlet does the job for both. Thus, to find the set of teams in a tenant, we run:
[Array]$Teams = Get-MgTeam -All
This is equivalent to running the Get-MgGroup cmdlet with a filter to find team-enabled groups:
Afterward, it’s a matter of looping through the set of teams to retrieve information about each team. This is when I hit a problem in that the data returned for a team by Get-MgTeam doesn’t include the internal identifier (a value like 19:BxPfo_xgaoGDQMvyuDzztvrQjLWNRvY6sGoLWGLriHA1@thread.tacv2). This is true even if you specify that the cmdlet should return the InternalId property by specifying it in the Property parameter.
The internal identifier is necessary to form the deeplink for a team. A full deeplink contains the internal identifier, the group identifier for the team, and the tenant identifier. A user can click a deeplink to go direct to a team and apply to join the team if it interests them. Here’s what a complete deeplink looks like:
Although a solution exists, it’s neither elegant nor satisfactory. The extra calls to Get-MgTeam slow down the script and remove some of the benefit of using Graph API requests instead of the Teams and Exchange Online cmdlets. Not returning the internal identifier for multiple teams might not happen for the sake of performance (the identifier might require retrieval from a separate data store), but it seems like a bug when the cmdlet fails to retrieve the property when explicitly requested. I used version 1.15 of the Microsoft Graph PowerShell SDK and it’s possible that Microsoft will fix the problem in a future version.
The Value of a General-Purpose Cmdlet
The previous iteration of the script uses the Get-UnifiedGroup cmdlet. One of the big advantages of this cmdlet is that it returns interesting information like the group owners and counts for members and external members. You don’t have to request this information. The cmdlet returns it automatically.
However, switching to the Microsoft Graph PowerShell SDK means that the script must include code to retrieve this information. This isn’t very difficult (this article covers the basics), but it’s another thing to do.
Improving Output
As noted above, I used the ImportExcel module to output an Excel worksheet instead of a CSV file. I also wanted to improve the effectiveness of the HTML page by making the deeplink clickable. Playing around with adding the HTML <a href=> tag didn’t work so well until I formatted the output with these commands:
Figure 1 shows the HTML output. Obviously, other team properties could feature in the directory. The intention here is to explore what’s possible and demonstrate the technique rather than to set a standard for Teams directories.
Figure 1: Teams Directory in a HTML file
For instance, the directory includes all teams. You might decide that it’s better to include just public teams because users can join these teams without owner approval.
Making the Directory Available to Teams Users
Several ways exist to make the Teams Directory available to users:
Publish the page on a corporate web site.
Import the Excel worksheet into a SharePoint Online list and make the list available to users (for example, as a channel tab).
Use the Print function from a browser to create a PDF. Upload the PDF to SharePoint Online and create a channel tab pointing to the PDF. Remember to hold down the CTRL key when clicking the links in the PDF.
Import the HTML and XLSX files into SharePoint Online and allow users to download the files from there.
Figure 2 shows the how the Teams viewer displays a PDF created from the web page that was imported into SharePoint Online and accessed through a channel tab.
Figure 2: Teams Directory viewed as a PDF file accessed through a channel tab
Ongoing Maintenance is the Hard Part
Creating a Teams Directory isn’t particularly difficult. In this case, the only technical difficulty was figuring out how to create the deeplink. The issues involved in the ongoing maintenance of the directory are more prosaic, such as:
How often do you refresh the directory.
What mechanism to use to refresh the directory (An Azure Automation runbook is a good way to generate files periodically).
What’s the best way to make the directory available to users?
The updated script is available on GitHub. If you find another way to generate a Teams Directory, please let me know with a comment.
{"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}