Remove-CsMediaConfiguration
トピックの最終更新日: 2012-03-26
指定したメディア構成設定のコレクションを削除します。
構文
Remove-CsMediaConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
解説
このコマンドレットを実行すると、メディア設定のコレクションが削除されます。これらの設定は、クライアント エンドポイント間の音声通話およびビデオ通話に関係するものです。
このコマンドレットは、グローバル メディア設定の削除にも使用できます。ただしこの場合、設定は実際に削除されるのではなく、既定値にリセットされるだけです。
このコマンドレットを実行できるユーザー: 既定では、Remove-CsMediaConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalServerAdmins グループのメンバーです。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsMediaConfiguration"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
必須 |
XdsIdentity |
削除するメディア構成設定の一意の識別子です。この識別子によって、この構成を適用するスコープ (グローバル、サイト、またはサービス) を指定します。 |
Force |
省略可能 |
SwitchParameter |
変更を行う前に表示されるように設定されているすべての確認メッセージを表示しないようにします。 |
WhatIf |
省略可能 |
SwitchParameter |
実際にコマンドを実行せずに、コマンドの実行結果がわかります。 |
Confirm |
省略可能 |
SwitchParameter |
コマンドの実行前に確認メッセージを表示します。 |
入力の種類
Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings オブジェクトです。メディア構成オブジェクトのパイプ処理による入力を受け入れます。
戻り値の種類
Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings 型のオブジェクトを削除します。
例
-------------------------- 例 1 --------------------------
Remove-CsMediaConfiguration -Identity site:Redmond1
例 1 では、Remove-CsMediaConfiguration を使用して site:Redmond1 という ID を持つメディア構成コレクションを削除しています。メディア設定がサイト スコープから削除されると、グローバル メディア設定がサイトで自動的に使用開始されます。
-------------------------- 例 2 --------------------------
Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "RequireEncryption"} | Remove-CsMediaConfiguration
上記の例では、Get-CsMediaConfiguration、Where-Object、および Remove-CsMediaConfiguration の 3 つのコマンドレットを使用して、会話に参加した全員への暗号化が必要なメディア構成コレクションをすべて削除しています。この操作を実行するため、最初に Get-CsMediaConfiguration を使用して組織内のすべてのメディア構成コレクションを戻しています。次に、この情報が Where-Object にパイプ処理されます。これにより、パイプライン データを EncryptionLevel プロパティが RequireEncryption に等しい (-eq) コレクションに制限するフィルターが適用されます。最後に、フィルターされたデータ セットを Remove-CsMediaConfiguration に渡して、セット内の各項目を削除しています。
-------------------------- 例 3 --------------------------
Get-CsMediaConfiguration -Filter service:* | Remove-CsMediaConfiguration
この例では、サービス スコープ (ここでは構成が特定のサービスに適用されています) で定義されているメディア構成をすべて削除しています。この操作を実行するため、まず service:* というフィルターを使用して Get-CsMediaConfiguration を呼び出しています。このフィルターによって、Identity が service で始まるすべてのメディア構成コレクション (すなわちサービス スコープの全コレクション) が取得されます。次に、取得したコレクションを Remove-CsMediaConfiguration にパイプ処理しています。この結果、これらのコレクションがすべて削除されます。