REST Resource: folders.locations.securityCenterServices

リソース: SecurityCenterService

特定の Security Command Center サービスを表します。これには、個々のモジュール設定に加えて、トップレベルの有効化などの設定情報が含まれます。サービス設定は、組織、フォルダ、プロジェクトのレベルで構成できます。組織レベルまたはフォルダレベルのサービス設定は、下位のフォルダとプロジェクトに継承されます。

JSON 表現
{
  "name": string,
  "intendedEnablementState": enum (EnablementState),
  "effectiveEnablementState": enum (EnablementState),
  "modules": {
    string: {
      object (ModuleSettings)
    },
    ...
  },
  "updateTime": string,
  "serviceConfig": {
    object
  }
}
フィールド
name

string

ID。サービスの名前。次のいずれかの形式で指定します。

  • organizations/{organization}/locations/{location}/securityCenterServices/{service}
  • folders/{folder}/locations/{location}/securityCenterServices/{service}
  • projects/{project}/locations/{location}/securityCenterServices/{service}

{service} の有効な値は次のとおりです。

  • container-threat-detection
  • event-threat-detection
  • security-health-analytics
  • vm-threat-detection
  • web-security-scanner
intendedEnablementState

enum (EnablementState)

省略可。リソース階層のレベルでサービスが意図する有効化状態。DISABLED 状態は、すべてのモジュールの有効化状態を DISABLED にオーバーライドします。

effectiveEnablementState

enum (EnablementState)

出力専用。リソース階層のレベルでサービスが有効になっている状態。目的の状態が INHERITED に設定されている場合、有効な状態は祖先の有効化状態から継承されます。この状態は、請求の利用資格やオンボーディングのステータスによって、想定される有効化状態とは異なる場合があります。

modules

map (key: string, value: object (ModuleSettings))

省略可。モジュールの構成(サービスのモジュールの有効化状態など)。マップ内にモジュールがない場合、その構成は親から継承されていることを意味します。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

updateTime

string (Timestamp format)

出力専用。サービスが最後に更新された時刻。これは、ユーザーによる明示的な更新が原因である場合や、課金システムの定期購入の有効期限切れなど、別のシステム変更による副作用が原因である場合があります。

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

serviceConfig

object (Struct format)

省略可。サービス固有の追加構成。すべてのサービスでこのフィールドが使用されるわけではありません。

EnablementState

サービスまたはモジュールの有効化状態を表します。

列挙型
ENABLEMENT_STATE_UNSPECIFIED デフォルト値。この値は使用されません。
INHERITED 状態は親リソースから継承されます。意図された有効化の状態として有効ですが、実際の有効化の状態としては有効ではありません。
ENABLED 状態が有効になっている。
DISABLED 状態が無効です。
INGEST_ONLY Security Command Center は、このサービスからの検出結果を取り込むように構成されていますが、このサービスを有効にするようには構成されていません。この状態は、Security Command Center が正しく構成されていないことを示します。この状態は自分で設定することはできません。

ModuleSettings

個々のモジュールの設定。

JSON 表現
{
  "intendedEnablementState": enum (EnablementState),
  "effectiveEnablementState": enum (EnablementState)
}
フィールド
intendedEnablementState

enum (EnablementState)

省略可。リソース階層のレベルでモジュールの目的の有効化状態。

effectiveEnablementState

enum (EnablementState)

出力専用。リソース階層のレベルでモジュールの有効な有効化状態。目的の状態が INHERITED に設定されている場合、有効な状態は祖先の有効化状態から継承されます。この状態は、請求の利用資格やオンボーディングのステータスによって、想定される有効化状態とは異なる場合があります。

メソッド

get

指定された Security Command Center サービスのサービス設定を取得します。

list

指定された親のすべての Security Command Center サービスのリストを返します。

patch

指定された更新マスクを使用して Security Command Center サービスを更新します。