Skip to content

Latest commit

 

History

History
198 lines (153 loc) · 5.47 KB

Get-TeamsAutoAttendant.md

File metadata and controls

198 lines (153 loc) · 5.47 KB
external help file Module Name online version schema
TeamsFunctions-help.xml
TeamsFunctions
2.0.0

Get-TeamsAutoAttendant

SYNOPSIS

Queries Auto Attendants and displays friendly Names (UPN or DisplayName)

SYNTAX

Name (Default)

Get-TeamsAutoAttendant [[-Name] <String[]>] [-Detailed] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]
 [<CommonParameters>]

Search

Get-TeamsAutoAttendant [-SearchString <String>] [-Detailed] [-IncludeTotalCount] [-Skip <UInt64>]
 [-First <UInt64>] [<CommonParameters>]

DESCRIPTION

Same functionality as Get-CsAutoAttendant, but display reveals friendly Names, like UserPrincipalName or DisplayName for the following connected Objects Operator and ApplicationInstances (Resource Accounts)

EXAMPLES

EXAMPLE 1

Get-TeamsAutoAttendant

Same result as Get-CsAutoAttendant

EXAMPLE 2

Get-TeamsAutoAttendant -Name "My AutoAttendant"

Returns an Object for every Auto Attendant found with the exact Name "My AutoAttendant"

EXAMPLE 3

Get-TeamsAutoAttendant -Name "My AutoAttendant" -Detailed

Returns an Object for every Auto Attendant found with the exact Name "My AutoAttendant" Detailed view will display all nested Objects indented as a tree

EXAMPLE 4

Get-TeamsAutoAttendant -Name "My AutoAttendant" -SearchString "My AutoAttendant"

Returns an Object for every Auto Attendant found with the exact Name "My AutoAttendant" and Returns an Object for every Auto Attendant matching the String "My AutoAttendant"

EXAMPLE 5

Get-TeamsAutoAttendant -SearchString "My AutoAttendant"

Returns an Object for every Auto Attendant matching the String "My AutoAttendant" Synonymous with Get-CsAutoAttendant -NameFilter "My AutoAttendant", but output shown differently.

PARAMETERS

-Name

Required for ParameterSet Name. Finds all Auto Attendants with this name (unique results). If not provided, all Auto Attendants are queried, returning only the name

Type: String[]
Parameter Sets: Name
Aliases: Identity

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SearchString

Required for ParameterSet Search. Searches all Auto Attendants for this string (multiple results possible).

Type: String
Parameter Sets: Search
Aliases: NameFilter

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Detailed

Optional Switch. Displays nested Objects for all Parameters of the Auto Attendant By default, only Names of nested Objects are shown.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeTotalCount

Reports the total number of objects in the data set (an integer) followed by the selected objects. If the cmdlet cannot determine the total count, it displays "Unknown total count." The integer has an Accuracy property that indicates the reliability of the total count value. The value of Accuracy ranges from 0.0 to 1.0 where 0.0 means that the cmdlet could not count the objects, 1.0 means that the count is exact, and a value between 0.0 and 1.0 indicates an increasingly reliable estimate.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Ignores the specified number of objects and then gets the remaining objects. Enter the number of objects to skip.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-First

Gets only the specified number of objects. Enter the number of objects to get.

Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Object

NOTES

Without any parameters, Get-TeamsAutoAttendant will show names only. Operator and Resource Accounts, etc. are displayed with friendly name. Main difference to Get-CsAutoAttendant (apart from the friendly names) is how the Objects are shown. The connected Objects DefaultCallFlow, CallFlows, Schedules, CallHandlingAssociations and DirectoryLookups are all shown with Name only, but can be queried with .<ObjectName> This also works with Get-CsAutoAttendant, but with the help of "Display" Parameters.

RELATED LINKS

https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/Get-TeamsAutoAttendant.md

https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/about_TeamsAutoAttendant.md

https://github.com/DEberhardt/TeamsFunctions/tree/main/docs/