Share via

az acat report

  • Reference

Note

This reference is part of the acat extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az acat report command. Learn more about extensions.

Manage App Compliance Automation Tool reports.

Commands

Name Description Type Status
az acat report create

Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.

 Extension GA
az acat report delete

Delete an AppComplianceAutomation report.

 Extension GA
az acat report download

Download compliance needs from snapshot, like: Compliance Report, Resource List.

 Extension GA
az acat report get-control-assessments

List the AppComplianceAutomation snapshot list.

 Extension GA
az acat report list

List the AppComplianceAutomation report list for the tenant.

 Extension GA
az acat report show

Get the AppComplianceAutomation report and its properties.

 Extension GA
az acat report snapshot

Manage ACAT report snapshots.

 Extension GA
az acat report snapshot download

Download compliance needs from snapshot, like: Compliance Report, Resource List.

 Extension GA
az acat report snapshot list

List the AppComplianceAutomation snapshot list.

 Extension GA
az acat report update

Update a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.

 Extension GA
az acat report wait

Place the CLI in a waiting state until a condition is met.

 Extension GA
az acat report webhook

Manage ACAT report webhooks.

 Extension GA
az acat report webhook create

Create a new AppComplianceAutomation webhook or update an exiting AppComplianceAutomation webhook.

 Extension GA
az acat report webhook delete

Delete an AppComplianceAutomation webhook.

 Extension GA
az acat report webhook list

List the AppComplianceAutomation webhook list.

 Extension GA
az acat report webhook show

Get the AppComplianceAutomation webhook and its properties.

 Extension GA
az acat report webhook update

Update an exiting AppComplianceAutomation webhook.

 Extension GA

az acat report create

Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.

az acat report create --report-name
                      --resources
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--offer-guid]
                      [--storage-info]
                      [--time-zone]
                      [--trigger-time]

Required Parameters

--report-name

Report Name.

--resources

List of resource data. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--offer-guid

A list of comma-separated offerGuids indicates a series of offerGuids that map to the report. For example, "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002" and "00000000-0000-0000-0000-000000000003".

--storage-info

The information of 'bring your own storage' binding to the report Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--time-zone

Report collection trigger time's time zone, the available list can be obtained by executing "Get-TimeZone -ListAvailable" in PowerShell. An example of valid timezone id is "Pacific Standard Time".

Default value: UTC
--trigger-time

Report collection trigger time.

Default value: 2024-09-17 12:00:00
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report delete

Delete an AppComplianceAutomation report.

az acat report delete --report-name
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--yes]

Required Parameters

--report-name

Report Name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report download

Download compliance needs from snapshot, like: Compliance Report, Resource List.

az acat report download --download-type {ComplianceDetailedPdfReport, CompliancePdfReport, ComplianceReport, ResourceList}
                        --report-name
                        --snapshot-name
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--offer-guid]
                        [--tenant]

Required Parameters

--download-type

Indicates the download type.

Accepted values: ComplianceDetailedPdfReport, CompliancePdfReport, ComplianceReport, ResourceList
--report-name

Report Name.

--snapshot-name

Snapshot Name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--offer-guid

The offerGuid which mapping to the reports.

--tenant

Tenant id.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report get-control-assessments

List the AppComplianceAutomation snapshot list.

az acat report get-control-assessments --report-name
                                       [--filter]
                                       [--max-items]
                                       [--next-token]
                                       [--offer-guid]
                                       [--orderby]
                                       [--select]
                                       [--skip-token]
                                       [--tenant]
                                       [--top]

Required Parameters

--report-name

Report Name.

Optional Parameters

--filter

The filter to apply on the operation.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--offer-guid

The offerGuid which mapping to the reports.

--orderby

OData order by query option.

--select

OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.

--skip-token

Skip over when retrieving results.

--tenant

The tenant id of the report creator.

--top

Number of elements to return when retrieving results.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report list

List the AppComplianceAutomation report list for the tenant.

az acat report list [--filter]
                    [--max-items]
                    [--next-token]
                    [--offer-guid]
                    [--orderby]
                    [--select]
                    [--skip-token]
                    [--tenant]
                    [--top]

Optional Parameters

--filter

The filter to apply on the operation.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

--offer-guid

The offerGuid which mapping to the reports.

--orderby

OData order by query option.

--select

OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.

--skip-token

Skip over when retrieving results.

--tenant

The tenant id of the report creator.

--top

Number of elements to return when retrieving results.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report show

Get the AppComplianceAutomation report and its properties.

az acat report show --report-name

Required Parameters

--report-name

Report Name.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report update

Update a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.

az acat report update --report-name
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--offer-guid]
                      [--resources]
                      [--storage-info]
                      [--time-zone]
                      [--trigger-time]

Required Parameters

--report-name

Report Name.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--offer-guid

A list of comma-separated offerGuids indicates a series of offerGuids that map to the report. For example, "00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002" and "00000000-0000-0000-0000-000000000003".

--resources

List of resource data. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--storage-info

The information of 'bring your own storage' binding to the report Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--time-zone

Report collection trigger time's time zone, the available list can be obtained by executing "Get-TimeZone -ListAvailable" in PowerShell. An example of valid timezone id is "Pacific Standard Time".

--trigger-time

Report collection trigger time.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az acat report wait

Place the CLI in a waiting state until a condition is met.

az acat report wait --report-name
                    [--created]
                    [--custom]
                    [--deleted]
                    [--exists]
                    [--interval]
                    [--timeout]
                    [--updated]

Required Parameters

--report-name

Report Name.

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.