REST Resource: folders.locations.securityHealthAnalyticsCustomModules

リソース: SecurityHealthAnalyticsCustomModule

Security Health Analytics カスタム モジュールのインスタンスを表します。モジュールの完全な名前、表示名、有効化状態、最終更新日時が含まれます。カスタム モジュールは、組織、フォルダ、プロジェクトのいずれのレベルでも作成できます。組織レベルまたはフォルダレベルで作成したカスタム モジュールは、下位のフォルダとプロジェクトに継承されます。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "enablementState": enum (EnablementState),
  "updateTime": string,
  "lastEditor": string,
  "ancestorModule": string,
  "customConfig": {
    object (CustomConfig)
  }
}
フィールド
name

string

ID。カスタム モジュールの完全なリソース名（次のいずれかの形式）。

  • organizations/{organization}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • folders/{folder}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
  • projects/{project}/locations/{location}/securityHealthAnalyticsCustomModules/{custom_module}
displayName

string

省略可。Security Health Analytics カスタム モジュールの表示名。この表示名は、このカスタム モジュールから返されるすべての検出結果の検出結果カテゴリになります。表示名は 1 ～ 128 文字で、先頭は英小文字にします。それ以降は、英数字とアンダースコアのみを使用してください。
enablementState

enum (EnablementState)

省略可。カスタム モジュールの有効化状態。
updateTime

string (Timestamp format)

出力専用。カスタム モジュールが最後に更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
lastEditor

string

出力専用。カスタム モジュールを最後に更新した編集者。
ancestorModule

string

出力専用。カスタム モジュールが継承される組織またはフォルダを指定します。空の場合、カスタム モジュールを表示している組織、フォルダ、またはプロジェクトでカスタム モジュールが作成されたことを示します。
customConfig

object (CustomConfig)

省略可。モジュールのユーザー指定のカスタム構成。

EnablementState

カスタム モジュールの有効化状態。

列挙型
ENABLEMENT_STATE_UNSPECIFIED デフォルト値。この値は使用されません。
ENABLED モジュールが特定の組織、フォルダ、またはプロジェクトで有効になっている。
DISABLED 指定した組織、フォルダ、またはプロジェクトでモジュールが無効になっている。
INHERITED 状態は祖先モジュールから継承されます。モジュールは、リソース階層内で最も近い継承されていない祖先モジュールに基づいて、実質的に ENABLED または DISABLED になります。最上位モジュール（親のないモジュール）を INHERITED 状態に設定しようとすると、INVALID_ARGUMENT エラーが発生します。

メソッド

create

 指定された組織、フォルダ、プロジェクトのスコープに常駐 SecurityHealthAnalyticsCustomModule を作成し、指定された親の子孫であるすべてのフォルダとプロジェクトに継承された SecurityHealthAnalyticsCustomModule リソースを作成します。

delete

 指定された SecurityHealthAnalyticsCustomModule と、リソース階層内のそのすべての子孫を削除します。

get

 SecurityHealthAnalyticsCustomModule を取得します。

list

 指定された親のすべての SecurityHealthAnalyticsCustomModule リソースのリストを返します。

listDescendant

 指定された組織、フォルダ、プロジェクト、およびそのすべての子孫のすべてのリジデント SecurityHealthAnalyticsCustomModule リソースのリストを返します。

patch

 指定された更新マスクに基づいて、指定された名前の SecurityHealthAnalyticsCustomModule を更新します。

simulate

 SecurityHealthAnalyticsCustomModule を使用してリソースを確認した場合の結果をシミュレートします。