snapshots

Creates, updates, deletes, gets or lists a snapshots resource.

Overview

Name	snapshots
Type	Resource
Id	azure_extras.app_compliance_automation.snapshots

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Snapshot's property.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Snapshot's property.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	reportName, snapshotName		Get the AppComplianceAutomation snapshot and its properties.
list	select	reportName	$skipToken, $top, $select, $filter, $orderby, offerGuid, reportCreatorTenantId	Get the AppComplianceAutomation snapshot list.
download	exec	reportName, snapshotName, downloadType		Download compliance needs from snapshot, like: Compliance Report, Resource List.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
reportName	string	Report Name.
snapshotName	string	Snapshot Name.
$filter	string	The filter to apply on the operation.
$orderby	string	OData order by query option.
$select	string	OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id.
$skipToken	string	Skip over when retrieving results.
$top	integer (int32)	Number of elements to return when retrieving results.
offerGuid	string	The offerGuid which mapping to the reports.
reportCreatorTenantId	string	The tenant id of the report creator.

SELECT examples

get

Get the AppComplianceAutomation snapshot and its properties.

SELECT
properties
FROM azure_extras.app_compliance_automation.snapshots
WHERE reportName = '{{ reportName }}' -- required
AND snapshotName = '{{ snapshotName }}' -- required
;

list

Get the AppComplianceAutomation snapshot list.

SELECT
properties
FROM azure_extras.app_compliance_automation.snapshots
WHERE reportName = '{{ reportName }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
AND $select = '{{ $select }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
AND offerGuid = '{{ offerGuid }}'
AND reportCreatorTenantId = '{{ reportCreatorTenantId }}'
;

Lifecycle Methods

download

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

EXEC azure_extras.app_compliance_automation.snapshots.download 
@reportName='{{ reportName }}' --required, 
@snapshotName='{{ snapshotName }}' --required 
@@json=
'{
"reportCreatorTenantId": "{{ reportCreatorTenantId }}", 
"downloadType": "{{ downloadType }}", 
"offerGuid": "{{ offerGuid }}"
}'
;