リテンションポリシー (Mini)

他のリソース内にネストされたときに使用されるリテンションポリシーのMini版の表示。

string

必須

リテンションポリシーを表す一意の識別子。

例:

"12345"

type

enum<string>

必須

値は常にretention_policyになります。

利用可能なオプション:

retention_policy

例:

"retention_policy"

policy_name

string

リテンションポリシーの名前。

例:

"Some Policy Name"

retention_length

string<int32>

リテンションポリシーの期間。この値はリテンションポリシーがコンテンツに割り当てられた後、有効である日数を示します。ポリシーのpolicy_typeがindefiniteである場合は、retention_lengthもindefiniteになります。

例:

"365"

disposition_action

enum<string>

リテンションポリシーの廃棄アクション。このアクションをpermanently_deleteに設定すると、ポリシーによって保持されているコンテンツが完全に削除されます。remove_retentionに設定すると、コンテンツへのリテンションポリシーの適用が解除され、リテンションポリシーの有効期限が切れた後は、ユーザーがコンテンツを削除できるようになります。

利用可能なオプション:

permanently_delete,

remove_retention

例:

"permanently_delete"

max_extension_length

リテンション期間を延長できる上限。この値は、ポリシーが適用されているファイルのリテンション期間を延長できる日数を指定します。ポリシーのタイプが「finite」以外、廃棄アクションが「permanently_delete」以外、または延長期間の上限が定義されていない場合、このフィールドは「none」に設定されます。

利用可能なオプション:

none

例:

"365"

Documentation Index