functions/teams/team/Get-MgaTeamChannel.ps1
|
function Get-MgaTeamChannel { <# .SYNOPSIS Get channels from a Microsoft Teams Team .DESCRIPTION Get channel(s) from Microsoft Teams Team(s) with current settings via Microsoft Graph API .PARAMETER InputObject A team object piped in. .PARAMETER Name The name of the team(s) to query. (Client Side filtering) .PARAMETER Id The Id of the team(s) to query. (Client Side filtering) .PARAMETER ResultSize The amount of objects to query within API calls to MSGraph. To avoid long waitings while query a large number of items, the graph api only query a special amount of items within one call. A value of 0 represents "unlimited" and results in query all items wihtin a call. The default is 100. .PARAMETER Token The token representing an established connection to the Microsoft Graph Api. Can be created by using New-MgaAccessToken. Can be omitted if a connection has been registered using the -Register parameter on New-MgaAccessToken. .EXAMPLE PS C:\> Get-MgaTeamChannel $team Returns all channels from team in variable $team. Assuming that the variable $team is representing a team queried earlier by Get-MgaTeam .EXAMPLE PS C:\> $team | Get-MgaTeamChannel -Name "General" Returns the Channel "General" from team in variable $team. Assuming that the variable $team is representing a team queried earlier by Get-MgaTeam .EXAMPLE PS C:\> $team | Get-MgaTeamChannel -ResultSize 5 Retrieves only the first 5 channels from team in variable $team. Assuming that the variable $team is representing a team queried earlier by Get-MgaTeam #> [CmdletBinding(ConfirmImpact = 'Low', DefaultParameterSetName = 'Default')] [OutputType([MSGraph.Teams.TeamChannel])] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Position = 0)] [Alias('Team', 'TeamName', 'TeamID')] [MSGraph.Teams.TeamParameter[]] $InputObject, [Alias('Filter', 'NameFilter', 'FilterName', 'DisplayName')] [string] $Name, [Alias('FilterId', 'IdFilter')] [string] $Id, [Int64] $ResultSize = (Get-PSFConfigValue -FullName 'MSGraph.Query.ResultSize' -Fallback 100), [MSGraph.Core.AzureAccessToken] $Token ) begin { $requiredPermission = "Group.Read.All" $Token = Invoke-TokenScopeValidation -Token $Token -Scope $requiredPermission -FunctionName $MyInvocation.MyCommand #region helper subfunctions #endregion helper subfunctions } process { Write-PSFMessage -Level VeryVerbose -Message "Gettings team(s) channel by parameterset $($PSCmdlet.ParameterSetName)" -Tag "ParameterSetHandling" #Write-PSFMessage -Level Important -Message "This command uses beta version of Microsoft Graph API. Be aware, that this is not supported in production! Use carefully." -Tag "QueryData" foreach ($teamItem in $InputObject) { #region checking input object type and query message if required if ($teamItem.psobject.TypeNames[0] -like "System.String") { $teamItem = Resolve-MailObjectFromString -Object $teamItem -User $User -Token $Token -NoNameResolving -FunctionName $MyInvocation.MyCommand if (-not $teamItem) { continue } } #endregion checking input object type and query message if required #region query data $invokeParam = @{ "Field" = "teams/$($teamItem.Id)/channels" "Token" = $Token 'UserUnspecific' = $true "ResultSize" = $ResultSize "ApiVersion" = "v1.0" "FunctionName" = $MyInvocation.MyCommand } Write-PSFMessage -Level Verbose -Message "Getting channel from team '$($teamItem)'" -Tag "QueryData" $data = Invoke-MgaRestMethodGet @invokeParam if ($Name) { [array]$data = $data | Where-Object displayName -Like $Name } if ($Id) { [array]$data = $data | Where-Object Id -Like $Id } #endregion query data #region output data Write-PSFMessage -Level VeryVerbose -Message "Output $($data.Count) objects." -Tag "OutputData" foreach ($output in $data) { if($output.Email) { $_email = [mailaddress]::new($output.Email) } else { $_email = $null } $outputObject = [MSGraph.Teams.TeamChannel]::new( $output.Id, $output.DisplayName, $output.Description, $output.isFavoriteByDefault, $output.WebUrl, $_email, $output.User, $output ) Write-PSFMessage -Level Debug -Message "Output channel '$($outputObject)'." -Tag "OutputData" $outputObject } #endregion output data } } end { } } |