Remove-CsVoiceRoute
トピックの最終更新日: 2012-03-25
ボイス ルートを削除します。ボイス ルートには、エンタープライズ VoIP ユーザーからの呼び出しを公衆交換電話網 (PSTN) または構内交換機 (PBX) の電話番号へルーティングする方法についての Microsoft Lync Server 2010 に対する指示が含まれます。
構文
Remove-CsVoiceRoute -Identity <XdsGlobalRelativeIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
既存のボイス ルートを削除する場合は、このコマンドレットを使用します。ボイス ルートは PSTN によって音声ポリシーと関連付けられているため、ボイス ルートを削除しても音声ポリシーに関連する値は変更されません。削除されたボイス ルートのパターンと一致する番号のルーティングが変更されるだけです。
このコマンドレットを実行できるユーザー:既定では、次のグループのメンバーが Remove-CsVoiceRoute コマンドレットをローカルで実行することを承認されています。RTCUniversalServerAdmins。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsVoiceRoute"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
XdsGlobalRelativeIdentity |
削除するボイス ルートを一意に識別する文字列です(ルート名にスペースが含まれる場合 (Test Route など)、すべての文字列を二重引用符で囲む必要があります)。 |
Force |
省略可能 |
SwitchParameter |
変更を行う前に表示されるように設定されているすべての確認メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route オブジェクト。パイプライン処理されたボイス ルート オブジェクトの入力を受け入れます。
戻り値の種類
Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route 型のオブジェクトを削除します。
例
-------------------------- 例 1 --------------------------
Remove-CsVoiceRoute -Identity Route1
Route1 という Identity を持つボイス ルートの設定を削除します。
-------------------------- 例 2 --------------------------
Get-CsVoiceRoute | Remove-CsVoiceRoute
このコマンドを実行すると、組織からすべてのボイス ルートが削除されます。最初に、Get-CsVoiceRoute コマンドレットを使用してすべてのボイス ルートを取得します。次に取得したボイス ルートを Remove-CsVoiceRoute にパイプ処理して、1 つずつ削除します。
-------------------------- 例 3 --------------------------
Get-CsVoiceRoute -Filter *Redmond* | Remove-CsVoiceRoute
このコマンドを実行すると、"Redmond" という文字列を含む Identity を持つボイス ルートがすべて削除されます。最初に Get-CsVoiceRoute コマンドレットを Filter パラメーターを指定して呼び出します。Filter パラメーターの値は、ワイルドカード文字 (*) で囲まれた Redmond という文字列です。この値により、この文字列が Identity のどの部分にあっても良いということが指定されます。Identity に文字列 Redmond を含むボイス ルートをすべて取得した後、取得したボイス ルートを Remove-CsVoiceRoute にパイプ処理して、各ボイス ルートを削除します。