|
| 1 | +--- |
| 2 | +external help file: |
| 3 | +applicable: Skype for Business Online |
| 4 | +title: Clear-CsOnlineTelephoneNumberReservation |
| 5 | +schema: 2.0.0 |
| 6 | +--- |
| 7 | + |
| 8 | +# Clear-CsOnlineTelephoneNumberReservation |
| 9 | + |
| 10 | +## SYNOPSIS |
| 11 | +Use the `Clear-CsOnlineTelephoneNumberReservation` cmdlet to clear a reserved list of telephone numbers before they are acquired. |
| 12 | +The telephone numbers will then be available for search and reservation again. |
| 13 | + |
| 14 | +## SYNTAX |
| 15 | + |
| 16 | +``` |
| 17 | +Clear-CsOnlineTelephoneNumberReservation [-Tenant <Guid>] -ReservationId <String> |
| 18 | + -InventoryType <String> [-DomainController <Fqdn>] [-Force] [<CommonParameters>] |
| 19 | +``` |
| 20 | + |
| 21 | +## DESCRIPTION |
| 22 | +This cmdlet will fail if any of the numbers in the reservation have already been assigned. |
| 23 | +An error message will identify the source of the failure. |
| 24 | + |
| 25 | +## EXAMPLES |
| 26 | + |
| 27 | +### -------------------------- Example 1 -------------------------- |
| 28 | +``` |
| 29 | +Clear-CsOnlineTelephoneNumberReservation -ReservationId b1ae43f5-07ab-4b81-be32-4b8cc2d11f75 -InventoryType Service |
| 30 | +``` |
| 31 | + |
| 32 | +This example clears a reservation with an inventory type of "Service". |
| 33 | + |
| 34 | + |
| 35 | +## PARAMETERS |
| 36 | + |
| 37 | +### -InventoryType |
| 38 | +Specifies the target telephone number type for the cmdlet. |
| 39 | +Acceptable values are: |
| 40 | + |
| 41 | +- "Service" for numbers assigned to conferencing support. |
| 42 | + |
| 43 | +- "Subscriber" for numbers supporting public switched telephone network (PSTN) functions. |
| 44 | + |
| 45 | +```yaml |
| 46 | +Type: String |
| 47 | +Parameter Sets: (All) |
| 48 | +Aliases: |
| 49 | +Applicable: Skype for Business Online |
| 50 | + |
| 51 | +Required: False |
| 52 | +Position: Named |
| 53 | +Default value: None |
| 54 | +Accept pipeline input: False |
| 55 | +Accept wildcard characters: False |
| 56 | +``` |
| 57 | +
|
| 58 | +### -ReservationId |
| 59 | +Specifies the identification of the reservation you want to clear. |
| 60 | +
|
| 61 | +```yaml |
| 62 | +Type: String |
| 63 | +Parameter Sets: (All) |
| 64 | +Aliases: |
| 65 | +Applicable: Skype for Business Online |
| 66 | + |
| 67 | +Required: False |
| 68 | +Position: Named |
| 69 | +Default value: None |
| 70 | +Accept pipeline input: False |
| 71 | +Accept wildcard characters: False |
| 72 | +``` |
| 73 | +
|
| 74 | +### -DomainController |
| 75 | +This parameter is reserved for internal Microsoft use. |
| 76 | +
|
| 77 | +```yaml |
| 78 | +Type: Fqdn |
| 79 | +Parameter Sets: (All) |
| 80 | +Aliases: DC |
| 81 | +Applicable: Skype for Business Online |
| 82 | + |
| 83 | +Required: False |
| 84 | +Position: Named |
| 85 | +Default value: None |
| 86 | +Accept pipeline input: False |
| 87 | +Accept wildcard characters: False |
| 88 | +``` |
| 89 | +
|
| 90 | +### -Force |
| 91 | +The Force switch specifies whether to suppress warning and confirmation messages. |
| 92 | +It can be useful in scripting to suppress interactive prompts. |
| 93 | +If the Force switch isn't provided in the command, you're prompted for administrative input if required. |
| 94 | +
|
| 95 | +```yaml |
| 96 | +Type: SwitchParameter |
| 97 | +Parameter Sets: (All) |
| 98 | +Aliases: |
| 99 | +Applicable: Skype for Business Online |
| 100 | + |
| 101 | +Required: False |
| 102 | +Position: Named |
| 103 | +Default value: None |
| 104 | +Accept pipeline input: False |
| 105 | +Accept wildcard characters: False |
| 106 | +``` |
| 107 | +
|
| 108 | +### -Tenant |
| 109 | +This parameter is reserved for internal Microsoft use. |
| 110 | +
|
| 111 | +```yaml |
| 112 | +Type: Guid |
| 113 | +Parameter Sets: (All) |
| 114 | +Aliases: |
| 115 | +Applicable: Skype for Business Online |
| 116 | + |
| 117 | +Required: False |
| 118 | +Position: Named |
| 119 | +Default value: None |
| 120 | +Accept pipeline input: False |
| 121 | +Accept wildcard characters: False |
| 122 | +``` |
| 123 | +
|
| 124 | +### CommonParameters |
| 125 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). |
| 126 | +
|
| 127 | +## INPUTS |
| 128 | +
|
| 129 | +### |
| 130 | +None |
| 131 | +
|
| 132 | +## OUTPUTS |
| 133 | +
|
| 134 | +### |
| 135 | +None |
| 136 | +
|
| 137 | +## NOTES |
| 138 | +
|
| 139 | +## RELATED LINKS |
| 140 | +
|
| 141 | +[Online version:](https://docs.microsoft.com/en-us/powershell/module/skype/Clear-CsOnlineTelephoneNumberReservation?view=skype-ps) |
0 commit comments