Set-AipServiceTemplateProperty
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)
次の使用例は、新しいユーザーと権限 新しい起動 - 機密コンテンツ に既存の保護テンプレートを更新します。 既存のテンプレートでマーケティング部門に対するビュー権限とエクスポート権限が付与されているのに対し (変更しないでください)、エンジニアリング部門もビュー権限を持っている必要があります。
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 人の新しいユーザーとその異なる権限を既存のテンプレートに追加します。
新しいユーザーとその権限は、
パラメーター
-ContentExpirationDate
テンプレートで保護されたコンテンツの有効期限が切れる日付を指定します。
このパラメーターは、
型: | DateTime |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ContentExpirationOption
テンプレートで保護されているコンテンツのコンテンツの有効期限の種類を指定します。
このパラメーターに使用できる値は次のとおりです。
- しない. コンテンツが無期限に利用可能であることを示します。
- OnDateを
します。 コンテンツが特定の固定日に期限切れであることを示します。 - AfterDaysを
します。コンテンツが保護されてから指定された日数だけ使用できるようになることを示します。
型: | ContentExpirationType |
指定可能な値: | Never, OnDate, AfterDays |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ContentValidityDuration
保護の最初の日から、テンプレートで保護されたコンテンツの有効期限が切れるまでの日数を指定します。
このパラメーターは、
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | 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"
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-EnableInLegacyApps
部門別テンプレートをサポートしていないクライアント アプリケーションでの部門別テンプレートの動作を決定します。 このシナリオでは、すべてのユーザーが使用可能なテンプレートの一覧から部門別テンプレートを表示できるかどうか、または一覧に部門別テンプレートを表示できないユーザーを決定します。
部門別テンプレートは、ScopedIdentities パラメーターを使用するか、Azure Information Protection のスコープ 付きポリシーで保護設定を作成することによって作成できます。 部門テンプレートは、Azure クラシック ポータル (現在は廃止) を使用して作成されている場合もあります。
True に設定され、テンプレートが部門別テンプレートである場合、ユーザーがテンプレートのスコープのメンバーであるかどうかに関係なく、すべてのユーザーにテンプレートが表示されるため、テンプレートを選択できます。
Falseに設定すると、ユーザーはテンプレートを表示しないため、ユーザーがテンプレートのターゲット スコープのメンバーである場合でも、テンプレートを選択できません。
この設定は、部門別テンプレートではないテンプレートには影響せず、部門別テンプレートをネイティブにサポートするクライアント アプリケーションにも影響しません。 また、この設定は、Exchange オンプレミスではなく Exchange Online を使用する Outlook on the web にも影響しません。また、このシナリオでは、部門別テンプレートがユーザーに表示されることはありません。
この設定は、部門別テンプレートによって保護されているコンテンツにユーザーがアクセスできるかどうかには影響しないことに注意してください。これは、ユーザーが表示する機能にのみ影響するため、テンプレート自体を選択します。
既定で部門別テンプレートをサポートしていないアプリケーションがある場合は、カスタム RMS テンプレートダウンロード スクリプト またはその他のツールを使用して、これらのテンプレートをローカル RMS クライアント フォルダーにデプロイできます。 その後、これらのアプリケーションは部門別テンプレートを正しく表示します。
すべてのテンプレートをダウンロードしたクライアント コンピューターから、テンプレート ファイルをコピーして他のコンピューターに貼り付けることができます。
型: | Boolean |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LicenseValidityDuration
このテンプレートで保護されているコンテンツの使用ライセンスの有効期間を指定します。 この値は、使用ライセンスが
この値を小さくすると、取り消されたコンテンツやポリシーが変更されたコンテンツに、これらの変更後に長時間アクセスできないようにすることで、ドキュメント所有者をより詳細に制御できます。
この値を大きくすると、インターネット ネットワーク接続を必要とせずに、ユーザーがコンテンツにアクセスする自由が増えます。
無制限アクセスを指定するには、-1
保護されたコンテンツにアクセスするたびに使用ライセンスを取得する必要があり、コンテンツがインターネット接続でのみ使用可能であることを指定するには、0を指定します。
各組織には最大使用ライセンス有効期間があり、既定では 30 日間
使用ライセンスの有効期間に異なる値がある場合 (たとえば、テナントに 1 つの値、テンプレートに 1 つの値) がある場合、Azure Information Protection では最も制限の厳しい値が使用されます。
型: | Int32 |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Names
テンプレートの名前の一覧を指定します。
Azure Information Protection を使用するすべてのサービスとアプリケーションでこれらの文字をサポートできるわけではないため、名前に次の文字を含めないでください。< > % & / ? ; + \ : #
Windows PowerShell のハッシュ テーブル構文を使用して、複数のロケール ID の名前と説明を作成します。 名前と説明のペアが少なくとも 1 つ必要です。 名前と説明のロケール ID は相互に一致する必要があります。
$names = @{}
$names[1033] = "機密コンテンツ"
$names[1034] = "Contenido confidencial"
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RightsDefinitions
New-AipServiceRightsDefinition コマンドレットを使用して指定される権限定義オブジェクトの一覧を指定します。
これらの権限定義オブジェクトは、テンプレートを適用して保護されているコンテンツに個々のユーザーまたはグループを付与する権限を表します。
型: | System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ScopedIdentities
電子メール アドレス (アカウントまたはグループ) でユーザーを一覧表示します。そのため、アプリケーションから部門別テンプレートを表示して選択できます。
指定したユーザーがテンプレートを表示するには、アプリケーションが部門別テンプレートをサポートしているか、EnableInLegacyApps パラメーターを Trueに設定する必要があります。
型: | System.Collections.Generic.List`1[System.String] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Status
テンプレートの状態を指定します。 有効な値は、
- アーカイブされたテンプレートは、以前に保護されたコンテンツを使用できますが、ユーザーには表示されません。
- 発行されたテンプレートはユーザーに配布され、コンテンツを保護するために使用できるようになります。
型: | TemplateStatus |
指定可能な値: | Archived, Published |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TemplateId
保護テンプレートの GUID を指定します。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |