Share via

az acat report snapshot

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 snapshot command. Learn more about extensions.

Manage ACAT report snapshots.

Commands

Name Description Type Status
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 snapshot download

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

az acat report snapshot 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.

Property Value
Parameter group: Parameters Arguments
Accepted values: ComplianceDetailedPdfReport, CompliancePdfReport, ComplianceReport, ResourceList
--report-name

Report Name.

--snapshot-name

Snapshot Name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

The offerGuid which mapping to the reports.

Property Value
Parameter group: Parameters Arguments
--tenant

Tenant id.

Property Value
Parameter group: Parameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az acat report snapshot list

List the AppComplianceAutomation snapshot list.

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

Required Parameters

--report-name

Report Name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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.

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--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.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False