Get-CsAutoAttendant
Use the Get-CsAutoAttendant cmdlet to get information about your Auto Attendants (AA).
Syntax
Default (Default)
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
Applicable: Microsoft Teams
If specified, the retrieved auto attendants would be sorted in descending order.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExcludeContent
Applicable: Microsoft Teams
If specified, only auto attendants' names, identities and associated application instances will be retrieved.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-First
Applicable: Microsoft Teams
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.
Parameter properties
| Type: | System.UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Microsoft Teams
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.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-IncludeStatus
Applicable: Microsoft Teams
If specified, the status records for each auto attendant in the result set are also retrieved.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NameFilter
Applicable: Microsoft Teams
If specified, only auto attendants whose names match that value would be returned.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Skip
Applicable: Microsoft Teams
The Skip parameter skips the first N auto attendants. It is intended to be used in conjunction with the -First parameter for pagination purposes.
Parameter properties
| Type: | System.UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SortBy
Applicable: Microsoft Teams
If specified, the retrieved auto attendants would be sorted by the specified property.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Tenant
Applicable: Microsoft Teams
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
System.String
The Get-CsAutoAttendant cmdlet accepts a string as the Identity parameter.