reports

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

Overview

Name	reports
Type	Resource
Id	azure_extras.app_compliance_automation.reports

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Report property.

list

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Report property.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	reportName		Get the AppComplianceAutomation report and its properties.
list	select		$skipToken, $top, $select, $filter, $orderby, offerGuid, reportCreatorTenantId	Get the AppComplianceAutomation report list for the tenant.
create_or_update	insert	reportName, data__properties		Create a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.
update	update	reportName		Update an exiting AppComplianceAutomation report.
delete	delete	reportName		Delete an AppComplianceAutomation report.
nested_resource_check_name_availability	exec	reportName		Checks the report's nested resource name availability, e.g: Webhooks, Evidences, Snapshots.
fix	exec	reportName		Fix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed.
sync_cert_record	exec	reportName, certRecord		Synchronize attestation record from app compliance.
verify	exec	reportName		Verify the AppComplianceAutomation report health status.

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.
$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 report and its properties.

SELECT
properties
FROM azure_extras.app_compliance_automation.reports
WHERE reportName = '{{ reportName }}' -- required
;

list

Get the AppComplianceAutomation report list for the tenant.

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

INSERT examples

create_or_update

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

INSERT INTO azure_extras.app_compliance_automation.reports (
data__properties,
reportName
)
SELECT 
'{{ properties }}' /* required */,
'{{ reportName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: reports
  props:
    - name: reportName
      value: string
      description: Required parameter for the reports resource.
    - name: properties
      value: object
      description: |
        Report property.

UPDATE examples

update

Update an exiting AppComplianceAutomation report.

UPDATE azure_extras.app_compliance_automation.reports
SET 
data__properties = '{{ properties }}'
WHERE 
reportName = '{{ reportName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete an AppComplianceAutomation report.

DELETE FROM azure_extras.app_compliance_automation.reports
WHERE reportName = '{{ reportName }}' --required
;

Lifecycle Methods

nested_resource_check_name_availability

Checks the report's nested resource name availability, e.g: Webhooks, Evidences, Snapshots.

EXEC azure_extras.app_compliance_automation.reports.nested_resource_check_name_availability 
@reportName='{{ reportName }}' --required 
@@json=
'{
"name": "{{ name }}", 
"type": "{{ type }}"
}'
;

fix

Fix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed.

EXEC azure_extras.app_compliance_automation.reports.fix 
@reportName='{{ reportName }}' --required
;

sync_cert_record

Synchronize attestation record from app compliance.

EXEC azure_extras.app_compliance_automation.reports.sync_cert_record 
@reportName='{{ reportName }}' --required 
@@json=
'{
"certRecord": "{{ certRecord }}"
}'
;

verify

Verify the AppComplianceAutomation report health status.

EXEC azure_extras.app_compliance_automation.reports.verify 
@reportName='{{ reportName }}' --required
;