|
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.dll-Help.xml |
| 3 | +online version: https://learn.microsoft.com/powershell/module/teams/Get-CsMainlineAttendantAppointmentBookingFlow |
| 4 | +applicable: Microsoft Teams |
| 5 | +title: Get-CsMainlineAttendantAppointmentBookingFlow |
| 6 | +schema: 2.0.0 |
| 7 | +ms.reviewer: |
| 8 | +manager: bulenteg |
| 9 | +author: tomkau |
| 10 | +ms.author: tomkau |
| 11 | +ms.reviewer: williamlooney |
| 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 | +PARAMVALUE: Guid |
| 48 | + |
| 49 | +```yaml |
| 50 | +Type: Guid |
| 51 | +Parameter Sets: (All) |
| 52 | +Aliases: |
| 53 | +applicable: Microsoft Teams |
| 54 | + |
| 55 | +Required: False |
| 56 | +Position: Named |
| 57 | +Default value: None |
| 58 | +Accept pipeline input: False |
| 59 | +Accept wildcard characters: False |
| 60 | +``` |
| 61 | +
|
| 62 | +### -Tenant |
| 63 | +PARAMVALUE: Guid |
| 64 | +
|
| 65 | +```yaml |
| 66 | +Type: Guid |
| 67 | +Parameter Sets: (All) |
| 68 | +Aliases: |
| 69 | +applicable: Microsoft Teams |
| 70 | + |
| 71 | +Required: False |
| 72 | +Position: Named |
| 73 | +Default value: None |
| 74 | +Accept pipeline input: False |
| 75 | +Accept wildcard characters: False |
| 76 | +``` |
| 77 | +
|
| 78 | +### -First |
| 79 | +The First parameter gets the first N appointment flows, up to a maximum of 100 at a time. |
| 80 | +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. |
| 81 | +If a number greater than 100 is supplied, the request will fail. |
| 82 | + |
| 83 | +```yaml |
| 84 | +Type: Int32 |
| 85 | +Parameter Sets: (All) |
| 86 | +Aliases: |
| 87 | +applicable: Microsoft Teams |
| 88 | +
|
| 89 | +Required: False |
| 90 | +Position: Named |
| 91 | +Default value: 100 |
| 92 | +Accept pipeline input: False |
| 93 | +Accept wildcard characters: False |
| 94 | +``` |
| 95 | + |
| 96 | +### -Skip |
| 97 | +The Skip parameter skips the first N appointment flows. It is intended to be used in conjunction with the `-First` parameter for pagination purposes. |
| 98 | + |
| 99 | +```yaml |
| 100 | +Type: Int32 |
| 101 | +Parameter Sets: (All) |
| 102 | +Aliases: |
| 103 | +applicable: Microsoft Teams |
| 104 | +
|
| 105 | +Required: False |
| 106 | +Position: Named |
| 107 | +Default value: None |
| 108 | +Accept pipeline input: False |
| 109 | +Accept wildcard characters: False |
| 110 | +``` |
| 111 | + |
| 112 | +### -ExcludeContent |
| 113 | +The ExcludeContent parameter only displays the Name and Id of the appointment flow. |
| 114 | + |
| 115 | +```yaml |
| 116 | +Type: SwitchParameter |
| 117 | +Parameter Sets: (All) |
| 118 | +Aliases: |
| 119 | +applicable: Microsoft Teams |
| 120 | +
|
| 121 | +Required: False |
| 122 | +Position: Named |
| 123 | +Default value: None |
| 124 | +Accept pipeline input: False |
| 125 | +Accept wildcard characters: False |
| 126 | +``` |
| 127 | + |
| 128 | +### -Sort |
| 129 | +The Sort parameter specifies the property used to sort. |
| 130 | + |
| 131 | +```yaml |
| 132 | +Type: String |
| 133 | +Parameter Sets: (All) |
| 134 | +Aliases: |
| 135 | +applicable: Microsoft Teams |
| 136 | +
|
| 137 | +Required: True |
| 138 | +Position: Named |
| 139 | +Default value: Name |
| 140 | +Accept pipeline input: False |
| 141 | +Accept wildcard characters: False |
| 142 | +``` |
| 143 | + |
| 144 | +### -Descending |
| 145 | +The Descending parameter sorts appointment booking flows in descending order |
| 146 | + |
| 147 | +```yaml |
| 148 | +Type: SwitchParameter |
| 149 | +Parameter Sets: (All) |
| 150 | +Aliases: |
| 151 | +applicable: Microsoft Teams |
| 152 | +
|
| 153 | +Required: False |
| 154 | +Position: Named |
| 155 | +Default value: None |
| 156 | +Accept pipeline input: False |
| 157 | +Accept wildcard characters: False |
| 158 | +``` |
| 159 | + |
| 160 | +### -NameFilter |
| 161 | +The NameFilter parameter returns appointment booking flows where the name contains specified string |
| 162 | + |
| 163 | +```yaml |
| 164 | +Type: String |
| 165 | +Parameter Sets: (All) |
| 166 | +Aliases: |
| 167 | +applicable: Microsoft Teams |
| 168 | +
|
| 169 | +Required: True |
| 170 | +Position: Named |
| 171 | +Default value: None |
| 172 | +Accept pipeline input: False |
| 173 | +Accept wildcard characters: False |
| 174 | +``` |
| 175 | + |
| 176 | +### CommonParameters |
| 177 | +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). |
| 178 | + |
| 179 | +## INPUTS |
| 180 | + |
| 181 | +### Identity |
| 182 | +Represents the unique identifier of an appointment booking flow. |
| 183 | + |
| 184 | +## OUTPUTS |
| 185 | + |
| 186 | +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue |
| 187 | + |
| 188 | +## NOTES |
| 189 | + |
| 190 | +## RELATED LINKS |
0 commit comments