-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into colab_template_iam
- Loading branch information
Showing
42 changed files
with
3,310 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| # Copyright 2025 Google Inc. | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| --- | ||
| name: ReferenceList | ||
| description: Reference lists are user-defined lists of values which users can use in multiple Rules. | ||
| min_version: 'beta' | ||
| references: | ||
| guides: | ||
| 'Google SecOps Guides': 'https://cloud.google.com/chronicle/docs/secops/secops-overview' | ||
| api: 'https://cloud.google.com/chronicle/docs/reference/rest/v1alpha/projects.locations.instances.referenceLists' | ||
| base_url: projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists | ||
| self_link: projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists/{{reference_list_id}} | ||
| create_url: projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists?referenceListId={{reference_list_id}} | ||
| id_format: projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists/{{reference_list_id}} | ||
| import_format: | ||
| - projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists/{{reference_list_id}} | ||
| update_verb: PATCH | ||
| update_mask: true | ||
| exclude_delete: true | ||
|
|
||
| examples: | ||
| - name: 'chronicle_referencelist_basic' | ||
| primary_resource_id: 'example' | ||
| min_version: 'beta' | ||
| vars: | ||
| reference_list_id: reference_list_id | ||
| test_env_vars: | ||
| chronicle_id: 'CHRONICLE_ID' | ||
|
|
||
| parameters: | ||
| - name: location | ||
| type: String | ||
| description: The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". | ||
| immutable: true | ||
| url_param_only: true | ||
| required: true | ||
| - name: instance | ||
| type: String | ||
| description: The unique identifier for the Chronicle instance, which is the same as the customer ID. | ||
| immutable: true | ||
| url_param_only: true | ||
| required: true | ||
| - name: referenceListId | ||
| type: String | ||
| description: |- | ||
| Required. The ID to use for the reference list. This is also the display name for | ||
| the reference list. It must satisfy the following requirements: | ||
| - Starts with letter. | ||
| - Contains only letters, numbers and underscore. | ||
| - Has length < 256. | ||
| - Must be unique. | ||
| immutable: true | ||
| url_param_only: true | ||
| required: true | ||
| properties: | ||
| - name: name | ||
| type: String | ||
| description: |- | ||
| Output only. The resource name of the reference list. | ||
| Format: | ||
| projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list} | ||
| output: true | ||
| - name: description | ||
| type: String | ||
| description: Required. A user-provided description of the reference list. | ||
| required: true | ||
| - name: entries | ||
| type: Array | ||
| description: |- | ||
| Required. The entries of the reference list. | ||
| When listed, they are returned in the order that was specified at creation | ||
| or update. The combined size of the values of the reference list may not | ||
| exceed 6MB. | ||
| This is returned only when the view is REFERENCE_LIST_VIEW_FULL. | ||
| required: true | ||
| item_type: | ||
| type: NestedObject | ||
| properties: | ||
| - name: value | ||
| type: String | ||
| description: Required. The value of the entry. Maximum length is 512 characters. | ||
| required: true | ||
| - name: scopeInfo | ||
| type: NestedObject | ||
| output: true | ||
| description: ScopeInfo specifies the scope info of the reference list. | ||
| properties: | ||
| - name: referenceListScope | ||
| type: NestedObject | ||
| description: ReferenceListScope specifies the list of scope names of the reference list. | ||
| required: true | ||
| properties: | ||
| - name: scopeNames | ||
| type: Array | ||
| description: |- | ||
| Optional. The list of scope names of the reference list. The scope names should be | ||
| full resource names and should be of the format: | ||
| "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}". | ||
| item_type: | ||
| type: String | ||
| - name: displayName | ||
| type: String | ||
| description: Output only. The unique display name of the reference list. | ||
| output: true | ||
| - name: revisionCreateTime | ||
| type: String | ||
| description: Output only. The timestamp when the reference list was last updated. | ||
| output: true | ||
| - name: rules | ||
| type: Array | ||
| description: |- | ||
| Output only. The resource names for the associated self-authored Rules that use this | ||
| reference list. | ||
| This is returned only when the view is REFERENCE_LIST_VIEW_FULL. | ||
| output: true | ||
| item_type: | ||
| type: String | ||
| - name: syntaxType | ||
| type: String | ||
| description: |2- | ||
| Possible values: | ||
| REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING | ||
| REFERENCE_LIST_SYNTAX_TYPE_REGEX | ||
| REFERENCE_LIST_SYNTAX_TYPE_CIDR | ||
| required: true | ||
| - name: ruleAssociationsCount | ||
| type: Integer | ||
| description: Output only. The count of self-authored rules using the reference list. | ||
| output: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # Copyright 2025 Google Inc. | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| --- | ||
| name: RuleDeployment | ||
| description: The RuleDeployment resource represents the deployment state of a Rule. | ||
| min_version: 'beta' | ||
| references: | ||
| guides: | ||
| 'Google SecOps Guides': 'https://cloud.google.com/chronicle/docs/secops/secops-overview' | ||
| api: 'https://cloud.google.com/chronicle/docs/reference/rest/v1alpha/RuleDeployment' | ||
| base_url: projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rules}}/deployments | ||
| self_link: projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment | ||
| create_url: projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment?updateMask=enabled,alerting,archived,runFrequency | ||
| id_format: projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment | ||
| import_format: | ||
| - projects/{{project}}/locations/{{location}}/instances/{{instance}}/rules/{{rule}}/deployment | ||
| create_verb: PATCH | ||
| update_verb: PATCH | ||
| update_mask: true | ||
| exclude_delete: true | ||
|
|
||
| examples: | ||
| - name: 'chronicle_ruledeployment_basic' | ||
| primary_resource_id: 'example' | ||
| min_version: 'beta' | ||
| test_env_vars: | ||
| chronicle_id: 'CHRONICLE_ID' | ||
|
|
||
| parameters: | ||
| - name: location | ||
| type: String | ||
| description: The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". | ||
| immutable: true | ||
| url_param_only: true | ||
| required: true | ||
| - name: instance | ||
| type: String | ||
| description: The unique identifier for the Chronicle instance, which is the same as the customer ID. | ||
| immutable: true | ||
| url_param_only: true | ||
| required: true | ||
| - name: rule | ||
| type: String | ||
| description: The Rule ID of the rule. | ||
| immutable: true | ||
| url_param_only: true | ||
| required: true | ||
| properties: | ||
| - name: name | ||
| type: String | ||
| description: |- | ||
| The resource name of the rule deployment. | ||
| Note that RuleDeployment is a child of the overall Rule, not any individual | ||
| revision, so the resource ID segment for the Rule resource must not | ||
| reference a specific revision. | ||
| Format: | ||
| projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/deployment | ||
| output: true | ||
| - name: enabled | ||
| type: Boolean | ||
| description: Whether the rule is currently deployed continuously against incoming data. | ||
| - name: alerting | ||
| type: Boolean | ||
| description: |- | ||
| Whether detections resulting from this deployment should be considered | ||
| alerts. | ||
| - name: archived | ||
| type: Boolean | ||
| description: |- | ||
| The archive state of the rule deployment. | ||
| Cannot be set to true unless enabled is set to false. | ||
| If set to true, alerting will automatically be set to false. | ||
| If currently set to true, enabled, alerting, and run_frequency cannot be | ||
| updated. | ||
| - name: archiveTime | ||
| type: String | ||
| description: Output only. The timestamp when the rule deployment archive state was last set to true. | ||
| If the rule deployment's current archive state is not set to true, the field will be empty. | ||
| output: true | ||
| - name: runFrequency | ||
| type: String | ||
| description: |2- | ||
| The run frequency of the rule deployment. | ||
| Possible values: | ||
| LIVE | ||
| HOURLY | ||
| DAILY | ||
| - name: executionState | ||
| type: String | ||
| description: |2- | ||
| The execution state of the rule deployment. | ||
| Possible values: | ||
| DEFAULT | ||
| LIMITED | ||
| PAUSED | ||
| output: true | ||
| - name: producerRules | ||
| type: Array | ||
| description: |2- | ||
| Output only. The names of the associated/chained producer rules. Rules are considered | ||
| producers for this rule if this rule explicitly filters on their ruleid. | ||
| Format: | ||
| projects/{project}/locations/{location}/instances/{instance}/rules/{rule} | ||
| output: true | ||
| item_type: | ||
| type: String | ||
| - name: consumerRules | ||
| type: Array | ||
| description: |2- | ||
| Output only. The names of the associated/chained consumer rules. Rules are considered | ||
| consumers of this rule if their rule text explicitly filters on this rule's ruleid. | ||
| Format: | ||
| projects/{project}/locations/{location}/instances/{instance}/rules/{rule} | ||
| output: true | ||
| item_type: | ||
| type: String | ||
| - name: lastAlertStatusChangeTime | ||
| type: String | ||
| description: Output only. The timestamp when the rule deployment alert state was lastly changed. | ||
| This is filled regardless of the current alert state.E.g. if the current alert status is false, | ||
| this timestamp will be the timestamp when the alert status was changed to false. | ||
| output: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.