Set-CsArchivingConfiguration
上次修改主題的時間： 2012-03-27
修改立即訊息 (IM) 封存設定的現有集合。
語法
Set-CsArchivingConfiguration [-Identity <XdsIdentity>] [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
Set-CsArchivingConfiguration [-ArchiveDuplicateMessages <$true | $false>] [-BlockOnArchiveFailure <$true | $false>] [-CachePurgingInterval <UInt32>] [-Confirm [<SwitchParameter>]] [-EnableArchiving <None | ImOnly | ImAndWebConf>] [-EnablePurging <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-KeepArchivingDataForDays <UInt32>] [-PurgeExportedArchivesOnly <$true | $false>] [-PurgeHourOfDay <UInt32>] [-WhatIf [<SwitchParameter>]]
詳細描述
有許多組織認為，保留使用者參與之所有 IM 工作階段和會議的記錄是相當有用的。另外，也有一些組織會強制保留這些記錄。例如，根據法律規定，許多金融界的組織都必須保留所有電子通訊的副本。
為了封存立即訊息，您必須至少設定一個 封存伺服器。設定 封存伺服器 之後，您必須執行兩個額外的步驟。首先，需要在全域範圍上啟用封存 (如需詳細資訊，請參閱＜Set-CsArchivingConfiguration＞主題)。或者，也可以針對不同站台設定自訂的封存設定。
其次，您必須使用封存原則，指出將要封存其 IM 工作階段的使用者。不會封存 IM 工作階段，除非使用需要封存 IM 工作階段的原則。
在安裝 Lync Server 2010 時，系統會為您建立通用封存組態設定集合。根據預設，這些設定會套用至整個組織。或者，您也可以使用 New-CsArchivingConfiguration 指令程式來針對各個站台建立自訂的組態設定。無論如何，您都可以使用 Set-CsArchivingConfiguration 指令程式，來修改現有集合或封存組態設定的屬性值。
誰可以執行此 Cmdlet：下列群組的成員預設會獲授權可以在本機上執行 Set-CsArchivingConfiguration Cmdlet：RTCUniversalServerAdmins。若要傳回所有獲指派此 Cmdlet 的角色存取控制 (RBAC) 角色清單 (包括您自行建立的自訂 RBAC 角色)，請在 Windows PowerShell 提示字元中執行下列命令：
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsArchivingConfiguration"}
參數
| 參數 | 必要 | 類型 | 描述 |
|---|---|---|---|
Identity |
選用 |
Xds 識別身份 |
代表要修改之封存組態設定集合的唯一識別碼。若要修改通用設定，請省略此參數或使用下列語法：-Identity global。若要修改站台範圍上的設定，請使用 "site:" 首碼，後面加上站台名稱。例如：-Identity "site:Redmond"。 |
Instance |
選用 |
ArchivingSettings 物件 |
允許您將物件參照傳遞給 Cmdlet，而不設定個別參數值。 |
ArchiveDuplicateMessages |
選用 |
布林值 |
指定應如何封存「跨集區」立即訊息。假設一個簡單範例：Ken Myer (在集區 1 中擁有一個帳戶) 傳送立即訊息給 Pilar Ackerman (在集區 2 中擁有一個帳戶)；接著 Pilar 傳送一則立即訊息來回覆 Ken。如果 ArchiveDuplicateMessages 已設定為 False，則 (根據內建的演算法) 工作階段記錄將記錄於集區 1 或集區 2 中，但不會同時記錄於兩者中。如果 ArchiveDuplicateMessages 已設定為 True (預設值)，記錄將同時記錄於這兩個集區中。 |
BlockOnArchiveFailure |
選用 |
布林值 |
若為 True，則 IM 服務隨時都會因為無法封存立即訊息而暫停。若設定為 False (預設值)，即使無法封存立即訊息，IM 都將繼續執行。 |
CachePurgingInterval |
選用 |
整數 |
指出系統清除記錄的頻率 (以小時為單位)，其中並未啟用任何參與者來進行封存。根據設計，所有群組 IM 工作階段和會議工作階段都會在執行時加以記錄。系統會在指定的時間間隔判斷這些工作階段中的任何參與者是否已啟用來進行封存。如果系統發現某個工作階段中並未啟用任何參與者來進行封存，則將從資料庫中刪除該記錄。 CachePurgeInterval 屬性可以設定為任何介於 4 和 168 (含) 之間的整數值。預設值為 24。 |
EnableArchiving |
選用 |
字串 |
指出要將哪些項目 (如果有的話) 儲存至封存資料庫。有效值為： None。不會將任何項目封存至資料庫。此為預設值。 ImOnly。會將 IM 工作階段封存至資料庫。 ImAndWebConf。會將 IM 和 Web 會議工作階段封存至資料庫。 |
EnablePurging |
選用 |
布林值 |
若為 True，則當封存的立即訊息符合下列條件時，即會定期從資料庫移除這些立即訊息：1) 較 KeepArchivingDataForDays 屬性中指定的值還舊；或者，2) 已匯出並標記為刪除。 若為 False，將不會自動從資料庫刪除立即訊息。 |
KeepArchivingDataForDays |
選用 |
整數 |
在自動刪除封存的立即訊息之前，這類立即訊息應於資料庫中保留的天數 (介於 1 和 2562 之間)。預設值為 14。 唯有當 EnablePurging 已設定為 True 時，此屬性才會生效。 |
PurgeExportedArchivesOnly |
選用 |
布林值 |
若為 True，則系統將只會清除已匯出 (因而已標記為刪除) 的立即訊息。尚未匯出的立即訊息將保留於資料庫中，即使這些立即訊息較 KeepArchivingDataForDays 屬性指定的值還舊也一樣。 |
PurgeHourOfDay |
選用 |
整數 |
指出要在一天中的哪個時間從封存資料庫刪除到期的記錄。時間是以 24 小時制指定，0 代表午夜 (12:00 AM)，而 23 則代表 11:00 PM。請注意，只能指定一天中的小時。這表示您可以排程要在 4:00 AM 執行清除，但無法將之排程為在 4:30 AM 或 4:15 AM (舉例來說) 執行。預設值為 2 (2:00 AM)。 只有在 EnablePurging 屬性設為 True 時，才會進行資料庫清除作業。 |
Force |
選用 |
切換參數 |
隱藏顯示當執行命令時可能發生的任何非嚴重錯誤訊息。 |
WhatIf |
選用 |
切換參數 |
描述執行命令後的結果，但無須實際執行命令。 |
Confirm |
選用 |
切換參數 |
執行命令前先要求您確認。 |
輸入類型
Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings 物件。Set-CsArchivingConfiguration 會接受封存組態物件的管線傳送資料。
傳回類型
Set-CsArchivingConfiguration 不會傳回值或物件。反之，指令程式會設定 Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings 物件的執行個體。
範例
-------------------------- 範例 1 --------------------------
Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30
在上述範例中，會使用 Set-CsArchivingConfiguration，來修改 Identity 為 site:Redmond 之封存組態設定的兩個屬性。首先，此命令會將 ArchiveDuplicateMessages 屬性設為 False；這樣能防止伺服器多次封存相同的立即訊息工作階段。命令也會使用 KeepArchivingDataForDays 參數來指示伺服器，將立即訊息保留 30 天。
-------------------------- 範例 2 --------------------------
Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30
範例 2 是範例 1 所示指令的的變化：但在此例中，會針對已設定於站台範圍上的所有封存設定來修改 ArchiveDuplicateMessages 和 KeepArchivingDataForDays 屬性的值。為了完成這項工作，命令會先使用 Get-CsArchivingConfiguration 及 Filter 參數，以傳回設定在站台範圍之所有封存設定的集合；篩選值 "site:*" 會確保設定的 Identity 開頭字元為 "site"：才會傳回。然後將篩選過的集合傳送到 Set-CsArchivingConfiguration，這會修改集合中每一個項目的兩個屬性值。
-------------------------- 範例 3 --------------------------
Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly"
在範例 3 中，會修改所有同時允許 IM 工作階段和 Web 會議封存的封存組態設定；當此命令完成之後，就只會針對 IM 工作階段封存允許這些設定。為達成此目的，命令會先呼叫 Get-CsArchivingConfiguration 且不指定任何參數，以傳回組織目前所使用的所有封存組態設定集合。然後將此集合傳送到 Where-Object 指令程式，它只會挑選出 EnableArchiving 屬性等於 (-eq) "ImAndWebConf" 的設定。接著將此篩選過的集合傳送到 Set-CsArchivingConfiguration，這會取得集合中的每個項目，並將 EnableArchiving 的值變更為 "ImOnly"。