Skip to content

Commit 2a3e6a5

Browse files
authored
Merge pull request #12979 from CLYVR/patch-50
Update New-CsAutoAttendantCallFlow.md
2 parents 415cca9 + 0f1fcc0 commit 2a3e6a5

12 files changed

+1222
-2
lines changed
Lines changed: 206 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: tomkau
4+
external help file: Microsoft.Rtc.Management.dll-Help.xml
5+
Locale: en-US
6+
manager: bulenteg
7+
Module Name: MicrosoftTeams
8+
ms.author: tomkau
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmainlineattendantappointmentbookingflow
10+
schema: 2.0.0
11+
title: Get-CsMainlineAttendantAppointmentBookingFlow
12+
---
13+
14+
# Get-CsMainlineAttendantAppointmentBookingFlow
15+
16+
## SYNOPSIS
17+
The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet returns the identified Mainline attendant appointment booking flow.
18+
19+
## SYNTAX
20+
21+
```
22+
Get-CsMainlineAttendantAppointmentBookingFlow [-Identity <Guid>] [-Tenant <Guid>] [-First <Int32>] [-Skip <Int32>] [-ExcludeContent <Switch>] [-Sort <String>] [-Descending <Switch>] [-NameFilter <String>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
The Get-CsMainlineAttendantAppointmentBookingFlow cmdlet lets you retrieve information about the Mainline attendant appointment booking flows n your organization.
27+
28+
## EXAMPLES
29+
30+
### -------------------------- Example 1 --------------------------
31+
```
32+
Get-CsMainlineAttendantAppointmentBookingFlow
33+
```
34+
35+
This example gets the first 100 Mainline attendant appointment booking flows in the organization.
36+
37+
### -------------------------- Example 2 --------------------------
38+
```
39+
Get-CsMainlineAttendantAppointmentBookingFlow -Identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01
40+
```
41+
42+
This example gets the Mainline attendant appointment booking flow with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01. If no appointment booking flow exists with the identity 5e3a575e-1faa-49ff-83c2-5cf1c36c0e01, then this example generates an error.
43+
44+
## PARAMETERS
45+
46+
### -Identity
47+
48+
> Applicable: Microsoft Teams
49+
50+
PARAMVALUE: Guid
51+
52+
```yaml
53+
Type: Guid
54+
Parameter Sets: (All)
55+
Aliases:
56+
57+
Required: False
58+
Position: Named
59+
Default value: None
60+
Accept pipeline input: False
61+
Accept wildcard characters: False
62+
```
63+
64+
### -Tenant
65+
66+
> Applicable: Microsoft Teams
67+
68+
PARAMVALUE: Guid
69+
70+
```yaml
71+
Type: Guid
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: False
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -First
83+
84+
> Applicable: Microsoft Teams
85+
86+
The First parameter gets the first N appointment flows, up to a maximum of 100 at a time.
87+
When not specified, the default behavior is to return the first 100 appointment flows. It is intended to be used in conjunction with the `-Skip` parameter for pagination purposes.
88+
If a number greater than 100 is supplied, the request will fail.
89+
90+
```yaml
91+
Type: Int32
92+
Parameter Sets: (All)
93+
Aliases:
94+
95+
Required: False
96+
Position: Named
97+
Default value: 100
98+
Accept pipeline input: False
99+
Accept wildcard characters: False
100+
```
101+
102+
### -Skip
103+
104+
> Applicable: Microsoft Teams
105+
106+
The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes.
107+
108+
```yaml
109+
Type: Int32
110+
Parameter Sets: (All)
111+
Aliases:
112+
113+
Required: False
114+
Position: Named
115+
Default value: None
116+
Accept pipeline input: False
117+
Accept wildcard characters: False
118+
```
119+
120+
### -ExcludeContent
121+
122+
> Applicable: Microsoft Teams
123+
124+
The ExcludeContent parameter only displays the Name and Id of the appointment flow.
125+
126+
```yaml
127+
Type: SwitchParameter
128+
Parameter Sets: (All)
129+
Aliases:
130+
131+
Required: False
132+
Position: Named
133+
Default value: None
134+
Accept pipeline input: False
135+
Accept wildcard characters: False
136+
```
137+
138+
### -Sort
139+
140+
> Applicable: Microsoft Teams
141+
142+
The Sort parameter specifies the property used to sort.
143+
144+
```yaml
145+
Type: String
146+
Parameter Sets: (All)
147+
Aliases:
148+
149+
Required: True
150+
Position: Named
151+
Default value: Name
152+
Accept pipeline input: False
153+
Accept wildcard characters: False
154+
```
155+
156+
### -Descending
157+
158+
> Applicable: Microsoft Teams
159+
160+
The Descending parameter sorts appointment booking flows in descending order
161+
162+
```yaml
163+
Type: SwitchParameter
164+
Parameter Sets: (All)
165+
Aliases:
166+
167+
Required: False
168+
Position: Named
169+
Default value: None
170+
Accept pipeline input: False
171+
Accept wildcard characters: False
172+
```
173+
174+
### -NameFilter
175+
176+
> Applicable: Microsoft Teams
177+
178+
The NameFilter parameter returns appointment booking flows where the name contains specified string
179+
180+
```yaml
181+
Type: String
182+
Parameter Sets: (All)
183+
Aliases:
184+
185+
Required: True
186+
Position: Named
187+
Default value: None
188+
Accept pipeline input: False
189+
Accept wildcard characters: False
190+
```
191+
192+
### CommonParameters
193+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
194+
195+
## INPUTS
196+
197+
### Identity
198+
Represents the unique identifier of an appointment booking flow.
199+
200+
## OUTPUTS
201+
202+
### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue
203+
204+
## NOTES
205+
206+
## RELATED LINKS
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
applicable: Microsoft Teams
3+
author: tomkau
4+
external help file: Microsoft.Rtc.Management.dll-Help.xml
5+
Locale: en-US
6+
manager: bulenteg
7+
Module Name: MicrosoftTeams
8+
ms.author: tomkau
9+
online version: https://learn.microsoft.com/powershell/module/microsoftteams/get-csmainlineattendantflow
10+
schema: 2.0.0
11+
title: Get-CsMainlineAttendantFlow
12+
---
13+
14+
# Get-CsMainlineAttendantFlow
15+
16+
## SYNOPSIS
17+
The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization
18+
19+
## SYNTAX
20+
21+
```
22+
Get-CsMainlineAttendantFlow [-MaConfigId <String>] [-Type <String>] [-FlowId <String>] [-Tenant <Guid>] [<CommonParameters>]
23+
```
24+
25+
## DESCRIPTION
26+
The Get-CsMainlineAttendantFlow cmdlet returns information about the Mainline Attendant flows configured in your organization.
27+
28+
> [!CAUTION]
29+
> This cmdlet will only work for customers that are participating in the Voice Applications private preview for these features. General Availability for this functionality has not been determined at this time.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```
35+
Get-CsMainlineAttendantFlow
36+
```
37+
38+
This example will list all the Mainline Attendant flows in the tenant.
39+
40+
### Example 2
41+
```
42+
Get-CsMainlineAttendantFlow -MaConfig 0b31bbe5-e2a0-4117-9b6f-956bca6023f8
43+
```
44+
45+
This example will list all the Mainline Attendant flows associated with the specific configuration id.
46+
47+
### Example 3
48+
```
49+
Get-CsMainlineAttendantFlow -Type Type 1 | Type 2
50+
```
51+
52+
This example will list all the Mainline Attendant flows with the specified type.
53+
54+
### Example 4
55+
```
56+
Get-CsMainlineAttendantFlow -FlowId 956bca6-e2a0-4117-9b6f-023f80b31bbe5
57+
```
58+
59+
This example will list the Mainline Attendant flow with the specified flow id.
60+
61+
## PARAMETERS
62+
63+
### -MaConfigId
64+
The Mainline Attendant configuration Id
65+
66+
```yaml
67+
Type: String
68+
Parameter Sets: (All)
69+
Aliases:
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### -Type
79+
The Mainline Attendant flow type
80+
81+
PARAMVALUE: Appointment | QuestionAndAnswer
82+
83+
```yaml
84+
Type: String
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -FlowId
96+
The Mainline Attendant flow id
97+
98+
```yaml
99+
Type: String
100+
Parameter Sets: (All)
101+
Aliases:
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### CommonParameters
111+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
112+
113+
## INPUTS
114+
115+
## OUTPUTS
116+
117+
### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue
118+
119+
## NOTES
120+
121+
## RELATED LINKS
122+

0 commit comments

Comments
 (0)