snapshot

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

Overview

Name	snapshot
Type	Resource
Id	azure_extras.app_compliance_automation.snapshot

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
complianceResults	array	List of compliance results.
createdAt	string (date-time)	The timestamp of resource creation (UTC).
provisioningState	string	Azure lifecycle management. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
reportProperties	object	The report essential info.
reportSystemData	object	Metadata pertaining to creation and last modification of the resource.
snapshotName	string	Snapshot name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
complianceResults	array	List of compliance results.
createdAt	string (date-time)	The timestamp of resource creation (UTC).
provisioningState	string	Azure lifecycle management. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
reportProperties	object	The report essential info.
reportSystemData	object	Metadata pertaining to creation and last modification of the resource.
snapshotName	string	Snapshot name.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	report_name, snapshot_name		Get the AppComplianceAutomation snapshot and its properties.
list	select	report_name	$skipToken, $top, $select, $filter, $orderby, offerGuid, reportCreatorTenantId	Get the AppComplianceAutomation snapshot list.
download	exec	report_name, snapshot_name, 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
report_name	string	Report Name. Required.
snapshot_name	string	Snapshot Name. Required.
$filter	string	The filter to apply on the operation. Default value is None.
$orderby	string	OData order by query option. Default value is None.
$select	string	OData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id. Default value is None.
$skipToken	string	Skip over when retrieving results. Default value is None.
$top	integer	Number of elements to return when retrieving results. Default value is None.
offerGuid	string	The offerGuid which mapping to the reports. Default value is None.
reportCreatorTenantId	string	The tenant id of the report creator. Default value is None.

SELECT examples

get

Get the AppComplianceAutomation snapshot and its properties.

SELECT
id,
name,
complianceResults,
createdAt,
provisioningState,
reportProperties,
reportSystemData,
snapshotName,
systemData,
type
FROM azure_extras.app_compliance_automation.snapshot
WHERE report_name = '{{ report_name }}' -- required
AND snapshot_name = '{{ snapshot_name }}' -- required
;

list

Get the AppComplianceAutomation snapshot list.

SELECT
id,
name,
complianceResults,
createdAt,
provisioningState,
reportProperties,
reportSystemData,
snapshotName,
systemData,
type
FROM azure_extras.app_compliance_automation.snapshot
WHERE report_name = '{{ report_name }}' -- 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.snapshot.download 
@report_name='{{ report_name }}' --required, 
@snapshot_name='{{ snapshot_name }}' --required 
@@json=
'{
"reportCreatorTenantId": "{{ reportCreatorTenantId }}", 
"downloadType": "{{ downloadType }}", 
"offerGuid": "{{ offerGuid }}"
}'
;