Get-MSTTeam

Teams: Get teams with properties

Script

#Requires -Version 5.1

[CmdletBinding()]
Param(
    [string]$GroupId,
    [bool]$Archived,
    [string]$DisplayName,
    [string]$MailNickName,
    [ValidateSet('Public', 'Private')]
    [string]$Visibility,
    [ValidateSet('*', 'GroupId', 'DisplayName', 'Description', 'Visibility', 'MailNickName', 'Archived')]
    [string[]]$Properties = @('GroupId', 'DisplayName', 'Description', 'Visibility', 'MailNickName', 'Archived')
)

Process {
    try {
        if ($Properties -contains '*') {
            $Properties = @('*')
        }
        [hashtable]$getArgs = @{'ErrorAction' = 'Stop'; 'Archived' = $Archived}

        if (-not [System.String]::IsNullOrWhiteSpace($GroupId)) {
            $getArgs.Add('GroupId', $GroupId)
        }
        if (-not [System.String]::IsNullOrWhiteSpace($DisplayName)) {
            $getArgs.Add('DisplayName', $DisplayName)
        }
        if (-not [System.String]::IsNullOrWhiteSpace($MailNickName)) {
            $getArgs.Add('MailNickName', $MailNickName)
        }
        if (-not [System.String]::IsNullOrWhiteSpace($Visibility)) {
            $getArgs.Add('Visibility', $Visibility)
        }

        $result = Get-Team @getArgs | Sort-Object DisplayName | Select-Object $Properties

        if ($null -eq $result -or $result.Count -eq 0) {
            Write-Output "No teams found"
            return
        }
        foreach ($item in $result) {
            $item | Add-Member -NotePropertyName Timestamp -NotePropertyValue (Get-Date -Format 'yyyy-MM-dd HH:mm:ss') -PassThru -Force
        }
    }
    catch { throw }
}

Customize

GroupId string

GroupId of the team

Archived bool

Filters to return teams that have been archived or not

DisplayName string

Filters to return teams with a full match to the provided display name

MailNickName string

Specify the mail nickname of the team to return

Visibility string

Filters to return teams with a specific visibility value

Properties string

List of properties to expand. Use * for all properties