Set-AipServiceTemplateProperty

  • リファレンス
モジュール:
AIPService

Azure Information Protectionの保護テンプレートのプロパティまたはプロパティを更新します。

構文

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>]

説明

Set-AipServiceTemplateProperty コマンドレットは、Azure Information Protectionの保護テンプレートのプロパティまたはプロパティを更新します。 これらのプロパティのほとんどは、Azure portalで更新できます。

このコマンドレットを使用すると、テンプレートは GUID によって識別されます。これは、既存の保護テンプレートを参照する必要があります。 このコマンドレットを使用して既定のテンプレートを更新することはできません。

Get-AipServiceTemplate コマンドレットを使用して、テンプレート ID を取得できます。

重要

保護テンプレートのプロパティを更新すると、これらのプロパティの既存の設定は警告なしで上書き (補足されません) されるため、更新するプロパティに必要なすべての設定を必ず指定してください。

ベスト プラクティスとして、 Export-AipServiceTemplate コマンドレットを使用して、このコマンドレットを実行する前に既存のテンプレートをバックアップします。 その後、元の構成に戻す必要がある場合は、 Import-AipServiceTemplate コマンドレットを使用してテンプレートを復元できます。

Azure portalで構成する方法など、保護テンプレートの詳細については、「Azure Information Protection のテンプレートの構成と管理」を参照してください。

Azure Information Protection統合ラベル付けクライアントを使用しますか?

Azure Information Protection 統合ラベル付けクライアントは、保護テンプレートを間接的に使用します。 統合ラベル付けクライアントがある場合は、保護テンプレートを直接変更する代わりに、ラベルベースのコマンドレットを使用することをお勧めします。

詳細については、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)

次の使用例は、既存の保護テンプレート の新しい起動 - 新 しいユーザーと権限の機密コンテンツを更新します。 既存のテンプレートでマーケティング部門に対する表示とエクスポートの権限が付与されているのに対し (変更しないでください)、エンジニアリング部門も View 権限を持つ必要があります。

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

この一連のコマンドは、テンプレートに既に定義されている既存のユーザーと権限を上書きすることなく、既存のテンプレートに 2 人の新しいユーザーとその異なる権限を追加します。

新しいユーザーとその権限は、DOCEDIT および EXTRACT 権限が付与されている pattiful.contoso.com (組織内のユーザー) です。ビュー evannar@vanarsdelltd.com権限が付与されている (別の組織のユーザー)。 これらのユーザーとその権限は、配列を使用して権限定義オブジェクトに追加され、テンプレートの既存の権限定義に追加されます。

パラメーター

-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のハッシュ テーブル構文を使用して、複数のロケール ID の名前と説明を作成します。 名前/説明の組み合わせが少なくとも 1 つ必要です。 名前と説明のロケール ID は相互に一致している必要があります。

$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 Information Protectionのスコープポリシーで保護設定を作成することによって作成できます。 部門テンプレートは、Azure クラシック ポータルを使用して作成された場合もあります (現在は廃止されました)。

  • True に設定され、テンプレートが部門別テンプレートである場合、すべてのユーザーはテンプレートを表示するため、ユーザーがテンプレートのスコープのメンバーであるかどうかに関係なく、テンプレートを選択できます。

  • False に設定すると、ユーザーがテンプレートのターゲット スコープのメンバーである場合でも、テンプレートは表示されないため選択できません。

この設定は、部門別テンプレートではないテンプレートには影響しません。また、部門別テンプレートをネイティブにサポートするクライアント アプリケーションにも影響しません。 この設定は、Exchange オンプレミスではなくExchange Onlineを使用するOutlook on the webにも影響しません。このシナリオでは、部門別テンプレートはユーザーに表示されません。

この設定は、部門別テンプレートによって保護されているコンテンツにユーザーがアクセスできるかどうかには影響しません。これは、ユーザーが表示する機能にのみ影響するため、テンプレート自体を選択します。

既定で部門別テンプレートをサポートしていないアプリケーションがある場合は、 カスタム 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 パラメーターに指定する値は、その値より小さくする必要があります。

使用ライセンスの有効期間に異なる値がある場合 (たとえば、テナントに 1 つの値、テンプレート用に 1 つの値)、Azure Information Protectionは最も制限の厳しい値を使用します。

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

-Names

テンプレートの名前の一覧を指定します。

Azure Information Protection を使用するすべてのサービスとアプリケーションでこれらの文字をサポートできるわけではないため、名前に次の文字を含めないでください。< > % & / ? ; + \ : #

Windows PowerShellのハッシュ テーブル構文を使用して、複数のロケール ID の名前と説明を作成します。 名前/説明の組み合わせが少なくとも 1 つ必要です。 名前と説明のロケール ID は相互に一致している必要があります。

$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 コマンドレットを使用して指定される権限定義オブジェクトの一覧を指定します。

これらの権限定義オブジェクトは、テンプレートを適用して保護されているコンテンツに個々のユーザーまたはグループを付与する権限を表します。

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