gcloud audit-manager audit-scopes generate

NAME
gcloud audit-manager audit-scopes generate - generate Audit Scope
SYNOPSIS
gcloud audit-manager audit-scopes generate --compliance-framework=COMPLIANCE_FRAMEWORK --location=LOCATION --output-file-name=OUTPUT_FILE_NAME --report-format=REPORT_FORMAT (--folder=FOLDER     | --organization=ORGANIZATION     | --project=PROJECT) [--output-directory=OUTPUT_DIRECTORY] [--parameter-overrides=[PARAMETER_OVERRIDES,…]] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
Generate a new Audit Scope.
EXAMPLES
To generate an Audit Scope in the us-central1 region, for a project with ID 123 against the compliance framework organizations/456/locations/global/frameworks/builtin-nist-800-53-revision5 in odf format, run:
gcloud audit-manager audit-scopes generate --project="123" --location="us-central1" --compliance-framework="organizations/456/locations/global/frameworks/builtin-nist-800-53-revision5" --report-format="odf" --output-directory="scopes/currentyear" --output-file-name="auditreport"

If the compliance framework is parameterized, to generate the same Audit Scope while overriding cloud control parameters defined in the file overrides.json, run:

gcloud audit-manager audit-scopes generate --project="123" --location="us-central1" --compliance-framework="organizations/456/locations/global/frameworks/builtin-nist-800-53-revision5" --report-format="odf" --output-directory="scopes/currentyear" --output-file-name="auditreport" --parameter-overrides="overrides.json"
REQUIRED FLAGS
--compliance-framework=COMPLIANCE_FRAMEWORK
Compliance Framework against which the Report must be generated. Eg: FEDRAMP_MODERATE
--location=LOCATION
The location where the scope should be generated.
--output-file-name=OUTPUT_FILE_NAME
The name by while scope report should be created .
--report-format=REPORT_FORMAT
The format in which the audit scope report should be created. REPORT_FORMAT must be (only one value is supported): odf.
Exactly one of these must be specified:
--folder=FOLDER
Folder Id for which to generate audit scope
--organization=ORGANIZATION
Organization Id for which to generate audit scope
--project=PROJECT
Project Id for which to generate audit scope
OPTIONAL FLAGS
--output-directory=OUTPUT_DIRECTORY
The directory path where the scope report should be created .
--parameter-overrides=[PARAMETER_OVERRIDES,…]
Overrides for the parameters of parameterized cloud controls, applied when the audit runs. Map from cloud control resource name to the overrides for that cloud control.
KEY
Full resource name of the cloud control, for example organizations/123/locations/global/cloudControls/my-control, as returned by gcloud compliance-manager cloud-controls list.
VALUE
Parameter overrides for the cloud control.
parameters
Parameters to override.
name
Name of the parameter.
parameterValue
Value of the parameter. Set exactly one of the following fields.
boolValue
A boolean value.
numberValue
A numeric value.
oneofValue
The selected sub-parameter of a oneOf parameter, with its own name and parameterValue. Can be nested up to 3 levels.
name
Name of the parameter.
parameterValue
Value of the parameter. Set exactly one of the following fields.
boolValue
A boolean value.
numberValue
A numeric value.
stringListValue
A list of strings.
values
The strings in the list.
stringValue
A string value.
stringListValue
A list of strings.
values
The strings in the list.
stringValue
A string value.
Shorthand Example:
--parameter-overrides=string={parameters=[{name=string,parameterValue={boolValue=boolean,numberValue=float,oneofValue={name=string,parameterValue={boolValue=boolean,numberValue=float,stringListValue={values=[string]},stringValue=string}},stringListValue={values=[string]},stringValue=string}}]}

JSON Example:

--parameter-overrides='{"string": {"parameters": [{"name": "string", "parameterValue": {"boolValue": boolean, "numberValue": float, "oneofValue": {"name": "string", "parameterValue": {"boolValue": boolean, "numberValue": float, "stringListValue": {"values": ["string"]}, "stringValue": "string"}}, "stringListValue": {"values": ["string"]}, "stringValue": "string"}}]}}'

File Example:

--parameter-overrides=path_to_file.(yaml|json)
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES
This variant is also available:
gcloud alpha audit-manager audit-scopes generate