Audit Manager v1 API - Class GenerateAuditScopeReportRequest (1.3.0)

public sealed class GenerateAuditScopeReportRequest : IMessage<GenerateAuditScopeReportRequest>, IEquatable<GenerateAuditScopeReportRequest>, IDeepCloneable<GenerateAuditScopeReportRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Audit Manager v1 API class GenerateAuditScopeReportRequest.

Request message for [GenerateAuditScopeReport][google.cloud.auditmanager.v1.AuditManager.GenerateAuditScopeReport].

Inheritance

object > GenerateAuditScopeReportRequest

Namespace

Google.Cloud.AuditManager.V1

Assembly

Google.Cloud.AuditManager.V1.dll

Constructors

GenerateAuditScopeReportRequest()

public GenerateAuditScopeReportRequest()

GenerateAuditScopeReportRequest(GenerateAuditScopeReportRequest)

public GenerateAuditScopeReportRequest(GenerateAuditScopeReportRequest other)
Parameter
Name Description
other GenerateAuditScopeReportRequest

Properties

ComplianceFramework

public string ComplianceFramework { get; set; }

Required. Framework (set of controls) that the audit scope report is generated against. For example, NIST_800_53.

Property Value
Type Description
string

ComplianceStandard

[Obsolete]
public string ComplianceStandard { get; set; }

Optional. Deprecated. The standard (industry or regulatory requirements) that the audit scope report is run against.

Use the compliance_framework field instead.

Property Value
Type Description
string

ReportFormat

public GenerateAuditScopeReportRequest.Types.AuditScopeReportFormat ReportFormat { get; set; }

Required. Format for the audit scope report.

Property Value
Type Description
GenerateAuditScopeReportRequestTypesAuditScopeReportFormat

Scope

public string Scope { get; set; }

Required. Project or folder that the audit scope report is generated for, in one of the following formats:

  • projects/{project}/locations/{location}
  • folders/{folder}/locations/{location}
  • organizations/{organization}/locations/{location}
Property Value
Type Description
string

ValidateOnly

public bool ValidateOnly { get; set; }

Optional. If true, only validates the request and does not generate the audit scope report. This executes standard request validation (such as schema, framework existence, scope, and IAM checks) and skips the apply phase.

Use this field for the following purposes:

  • Infrastructure as Code (IaC): Allow tools like Terraform to run dry-run mutations (e.g., terraform plan) without creating real resources or incurring costs.
  • User Interface Validation: Enable real-time form and permission validation in custom UIs before submitting requests.
  • CI/CD & Automation: Test your scripts, permissions, and parameters safely without consuming resource quotas.
Property Value
Type Description
bool