REST Resource: folders.securityHealthAnalyticsSettings.customModules

リソース: SecurityHealthAnalyticsCustomModule

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

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

string

変更不可。カスタム モジュールのリソース名。形式は「organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}」、「folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}」、「projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}」です。

ID {customModule} はサーバーによって生成され、ユーザーが設定することはできません。1 ~ 20 桁の数字です。

displayName

string

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

enablementState

enum (EnablementState)

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

updateTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

lastEditor

string

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

ancestorModule

string

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

customConfig

object (CustomConfig)

ユーザーが指定したモジュールのカスタム構成。

cloudProvider

enum (CloudProvider)

カスタム モジュールのクラウド プロバイダ。

EnablementState

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

列挙型
ENABLEMENT_STATE_UNSPECIFIED 有効化状態が未指定。
ENABLED 指定された CRM リソースでモジュールが有効になっている。
DISABLED 指定された CRM リソースでモジュールが無効になっている。
INHERITED 状態は祖先モジュールから継承されます。モジュールは、CRM 階層内で継承されていない最も近い祖先モジュールに基づいて、有効または無効になります。

CloudProvider

カスタム モジュールの使用可能なクラウド プロバイダ。

列挙型
CLOUD_PROVIDER_UNSPECIFIED クラウド プロバイダが指定されていません。
GOOGLE_CLOUD_PLATFORM ビッグデータ分析プラットフォームです。
AMAZON_WEB_SERVICES Amazon Web Services(AWS)。
MICROSOFT_AZURE Microsoft Azure。

メソッド

create

指定された CRM 親のスコープに常駐 SecurityHealthAnalyticsCustomModule を作成し、指定された親のすべての CRM 子孫に継承された SecurityHealthAnalyticsCustomModule を作成します。

delete

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

get

SecurityHealthAnalyticsCustomModule を取得します。

list

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

listDescendant

指定された CRM 親とその親のすべての CRM 子孫のすべての SecurityHealthAnalyticsCustomModule のリストを返します。

patch

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

simulate

特定の SecurityHealthAnalyticsCustomModule とリソースをシミュレートします。