Set-AipServiceTemplateProperty

更新 Azure 資訊保護保護範本的屬性或屬性。

Syntax

Set-AipServiceTemplateProperty
   -TemplateId <Guid>
   [-Names <Hashtable>]
   [-Descriptions <Hashtable>]
   [-RightsDefinitions <System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]>]
   [-ContentExpirationOption <ContentExpirationType>]
   [-ContentExpirationDate <DateTime>]
   [-ContentValidityDuration <Int32>]
   [-LicenseValidityDuration <Int32>]
   [-Status <TemplateStatus>]
   [-ScopedIdentities <System.Collections.Generic.List`1[System.String]>]
   [-EnableInLegacyApps <Boolean>]
   [<CommonParameters>]

Description

Set-AipServiceTemplateProperty Cmdlet 會更新 Azure 資訊保護保護範本的屬性或屬性。 您可以在Azure 入口網站中更新其中大部分的屬性。

當您使用此 Cmdlet 時,範本會以其 GUID 來識別,而該範本必須參考現有的保護範本。 您無法使用這個 Cmdlet 來更新預設範本。

您可以使用 Get-AipServiceTemplate Cmdlet 來取得範本識別碼。

重要

當您更新保護範本的屬性時,這些屬性的現有設定將會覆寫 (不會補充) ,因此請務必指定您要更新之屬性所需的所有設定。

最佳做法是使用 Export-AipServiceTemplate Cmdlet,先備份現有的範本,再執行此 Cmdlet。 然後,如果您需要還原為原始組態,您可以使用 Import-AipServiceTemplate Cmdlet 來還原範本。

如需保護範本的詳細資訊,包括如何在Azure 入口網站中設定範本,請參閱設定和管理 Azure 資訊保護的範本

使用 Azure 資訊保護統一標籤用戶端?

Azure 資訊保護統一標籤用戶端會間接使用保護範本。 如果您有統一標籤用戶端,建議您使用以標籤為基礎的 Cmdlet,而不是直接修改您的保護範本。

如需詳細資訊,請參閱 Microsoft 365 檔中的 建立和發佈敏感度標籤

範例

範例 1:更新範本的狀態

PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6428 -Status Published

此命令會將範本狀態設定為 [已發佈]。

範例 2:指定保護範本的使用者和許可權

PS C:\> $r1 = New-AipServiceRightsDefinition -EmailAddress marketing@contoso.com -Rights "VIEW","EXPORT"
PS C:\> $r2 = New-AipServiceRightsDefinition -EmailAddress engineering@contoso.com -Rights "VIEW"
PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6522 -RightsDefinitions ($r1, $r2)

本範例會針對新使用者和許可權更新現有的保護範本 [新增啟動 - 機密內容 ]。 雖然現有的範本授與檢視和匯出許可權給行銷部門 (不應該變更) ,但工程部門現在也必須擁有檢視許可權。

因為指定 RightsDefinitions 參數會覆寫現有的設定,所以第一個許可權定義物件會保留行銷的現有設定,而另一個許可權定義物件會建立新的工程部門許可權。

範例 3:將新的使用者和許可權新增至保護範本

PS C:\> $templateid = "7b1db17a-cb1a-41cf-bad7-b452f9d384c1"
PS C:\> [array]$r = New-AipServiceRightsDefinition -EmailAddress pattiful@contoso.com -Rights "DOCEDIT", "EXTRACT"
PS C:\> $r += New-AipServiceRightsDefinition -EmailAddress evannar@vanarsdelltd.com -Rights "VIEW"
PS C:\> $CurrentRightsDefinitions = [array]((get-AipServiceTemplate -TemplateId $templateid).RightsDefinitions)
PS C:\> $ResultingRightsDefinitions = $CurrentRightsDefinitions + $r
PS C:\> Set-AipServiceTemplateProperty -TemplateId $templateid -RightsDefinition $ResultingRightsDefinitions

這組命令會將兩個新的使用者及其不同的許可權新增至現有的範本,而不會覆寫範本中已定義的現有使用者和許可權。

新使用者及其許可權 pattiful.contoso.com (組織內的使用者) 被授與 DOCEDITEXTRACT 許可權;和 evannar@vanarsdelltd.com (另一個組織) 授與 VIEW 許可權的使用者。 這些使用者及其許可權會使用陣列新增至許可權定義物件,然後新增至範本的現有許可權定義。

參數

-ContentExpirationDate

指定受到範本保護的內容到期的日期。

只有當 ContentExpirationOption 設定為 OnDate時,才使用此參數。

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentExpirationOption

為受到範本保護的內容指定內容到期的類型。

此參數可接受的值為:

  • Never。 指出內容可無限期使用。
  • OnDate。 指出內容會在某個固定日期到期。
  • AfterDays。表示內容在保護後的指定天數內可供使用。
Type:ContentExpirationType
Accepted values:Never, OnDate, AfterDays
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentValidityDuration

指定受到範本保護的內容會在保護起始日之後的第幾天到期。

只有當 ContentExpirationOption 參數設定為 AfterDays 時,才使用此參數。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Descriptions

指定範本描述清單。

使用Windows PowerShell中的雜湊表語法,為多個地區設定識別碼建立名稱和描述。 至少要有一對名稱/描述。 名稱和描述的地區設定識別碼必須相符。

$descriptions =@{}

$descriptions[1033] = 「此內容為機密,不應在外部共用」

$descriptions[1034] = 「Este contenido es confidencial y no debe ser compartido fuera de la organizacion」

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableInLegacyApps

決定用戶端應用程式中不支援部門範本的行為。 在此案例中,決定所有使用者都可以從可用的範本清單中看到部門範本,或使用者看不到清單中的部門範本。

部門範本可以使用ScopedIdentities參數來建立,或在 Azure 資訊保護的範圍原則中建立保護設定。 部門範本可能也已使用 Azure 傳統入口網站建立, (現在已淘汰) 。

  • 如果設定為 True ,而且範本是部門範本,則所有使用者都會看到範本,因此不論使用者是否為範本範圍的成員,都能加以選取。

  • 如果設定為 False,則不會看到任何使用者,因此無法選取範本,即使使用者是範本目標範圍的成員也一樣。

此設定不會影響不是部門範本的範本,也不會影響原生支援部門範本的用戶端應用程式。 此設定也不會影響使用 Exchange Online 而非 Exchange 內部部署的Outlook 網頁版,而且在此案例中,永遠不會向使用者顯示部門範本。

請注意,此設定不會影響使用者是否可以存取受到部門範本保護的內容;它只會影響使用者查看的能力,因此請選取範本本身。

如果您有預設不支援部門範本的應用程式,您可以使用 自訂 RMS 範本下載腳本 或其他工具,將這些範本部署至本機 RMS 用戶端資料夾。 然後,這些應用程式會正確顯示部門範本。

從已下載所有範本的用戶端電腦中,您可以複製範本檔案,然後將檔案貼到其他電腦。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseValidityDuration

指定此範本所保護的內容的使用授權有效期間。 此值會指定為在取得使用授權後離線可用的天數 , (0-9999) 。 在這段期間,使用者可以重新開啟他們先前存取的內容,而不需要網際網路連線。

降低此值可讓文件擁有者有更大的控制權,協助確保已撤銷或變更原則的內容在這些變更之後太久就無法存取。

提高此值可讓使用者更自由地存取內容,而不需要網際網路連線。

若要指定無限制的存取權,請使用 -1

若要指定每次存取受保護的內容時都必須取得使用授權,且該內容只能與網際網路連線搭配使用,請指定 0

每個組織都有預設為 30 天 的最大使用授權有效時間,而且可以使用 Set-AipServiceMaxUseLicenseValidityTime來設定。 您為 LicenseValidityDuration 參數指定的值必須低於該值。

使用授權有效時間有不同的值時,例如租使用者的一個值,一個用於範本,Azure 資訊保護會使用最嚴格的值。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Names

指定範本名稱清單。

請勿在名稱中包含下列任何字元,因為並非所有使用 Azure 資訊保護的服務與應用程式都可以支援這些字元:< > % & / ? ; + \ : #

使用 Windows PowerShell 中的雜湊表語法,建立多個地區設定識別碼的名稱和描述。 至少要有一對名稱/描述。 名稱和描述的地區設定識別碼必須相符。

$names =@{}

$names[1033] = 「機密內容」

$names[1034] = 「Contenido confidencial」

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RightsDefinitions

指定使用 New-AipServiceRightsDefinition Cmdlet 所指定的許可權定義物件清單。

這些許可權定義物件表示將個別使用者或群組授與透過套用範本保護之內容的許可權。

Type:System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ScopedIdentities

列出可從應用程式看到並選取部門範本之使用者的電子郵件地址 (帳戶或群組)。

若要讓指定的使用者看到範本,應用程式必須支援部門範本,或 EnableInLegacyApps 參數必須設定為 True

Type:System.Collections.Generic.List`1[System.String]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

指定範本的狀態。 有效值為: 已發佈封存

  • 已封存的範本可用來取用先前受到保護的內容,但不會對使用者顯示。
  • 已發佈的範本會分送給使用者並啟用,以保護內容。
Type:TemplateStatus
Accepted values:Archived, Published
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TemplateId

指定保護範本的 GUID。

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False