Get-CsAutoAttendant

Module:: MicrosoftTeamsPowerShell

Applies to:: Microsoft Teams

Use the Get-CsAutoAttendant cmdlet to get information about your Auto Attendants (AA).

Syntax

Get-CsAutoAttendant
   [-Identity <String>]
   [-First <UInt32>]
   [-Skip <UInt32>]
   [-NameFilter <String>]
   [-SortBy <String>]
   [-Descending]
   [-IncludeStatus]
   [-ExcludeContent]
   [-Tenant <Guid>]
   [<CommonParameters>]

Description

The Get-CsAutoAttendant cmdlet returns information about the AAs in your organization.

Examples

Example 1

Get-CsAutoAttendant

This example gets the first 100 auto attendants in the organization.

Example 2

Get-CsAutoAttendant -Identity "f7a821dc-2d69-5ae8-8525-bcb4a4556093"

# Id                       : f7a821dc-2d69-5ae8-8525-bcb4a4556093
# TenantId                 : 977c9d5b-2dae-5d82-aada-628bc1c14213
# Name                     : Main Auto Attendant
# LanguageId               : en-US
# VoiceId                  : Female
# DefaultCallFlow          : Default Call Flow
# Operator                 :
# TimeZoneId               : Pacific Standard Time
# VoiceResponseEnabled     : False
# CallFlows                :
# Schedules                :
# CallHandlingAssociations :
# Status                   :
# DialByNameResourceId     :
# DirectoryLookupScope     :
# ApplicationInstances     : {fa2f17ec-ebd5-43f8-81ac-959c245620fa, 56421bbe-5649-4208-a60c-24dbeded6f18, c7af9c3c-ae40-455d-a37c-aeec771e623d}

This example gets the AA that has the identity of f7a821dc-2d69-5ae8-8525-bcb4a4556093.

Example 3

Get-CsAutoAttendant -First 10

This example gets the first ten auto attendants configured for use in the organization.

Example 4

Get-CsAutoAttendant -Skip 5 -First 10

This example skips initial 5 auto attendants and gets the next 10 AAs configured in the organization.

Parameters

-Descending

If specified, the retrieved auto attendants would be sorted in descending order.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-ExcludeContent

If specified, only auto attendants' names, identities and associated application instances will be retrieved.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-First

The First parameter gets the first N auto attendants, up to a maximum of 100 at a time. When not specified, the default behavior is to return the first 100 auto attendants. It is intended to be used in conjunction with the -Skip parameter for pagination purposes. If a number greater than 100 is supplied, the request will fail.

Type:	System.UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Identity

The identity for the AA to be retrieved. If this parameter is not specified, then all created AAs in the organization are returned. If you specify this parameter, you can't specify the other parameters.

Type:	System.String
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-IncludeStatus

If specified, the status records for each auto attendant in the result set are also retrieved.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-NameFilter

If specified, only auto attendants whose names match that value would be returned.

Type:	System.String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Skip

The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the -First parameter for pagination purposes.

Type:	System.UInt32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-SortBy

If specified, the retrieved auto attendants would be sorted by the specified property.

Type:	System.String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

-Tenant

Type:	System.Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Microsoft Teams

Inputs

System.String

The Get-CsAutoAttendant cmdlet accepts a string as the Identity parameter.

Outputs

Microsoft.Rtc.Management.Hosted.OAA.Models.AutoAttendant

Share via