Skip to main content

report

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

Overview​

Namereport
TypeResource
Idazure_extras.app_compliance_automation.report

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
namestringThe name of the resource.
certRecordsarrayList of synchronized certification records.
complianceStatusobjectReport compliance status.
errorsarrayList of report error codes.
lastTriggerTimestring (date-time)Report last collection trigger time.
nextTriggerTimestring (date-time)Report next collection trigger time.
offerGuidstringA 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".
provisioningStatestringAzure lifecycle management. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Deleting", "Fixing", "Verifying", and "Updating".
resourcesarrayList of resource data. Required.
statusstringReport status. Known values are: "Active", "Failed", "Reviewing", and "Disabled".
storageInfoobjectThe information of 'bring your own storage' account binding to the report.
subscriptionsarrayList of subscription Ids.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tenantIdstringReport's tenant id.
timeZonestringReport 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". Required.
triggerTimestring (date-time)Report collection trigger time. Required.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectreport_nameGet the AppComplianceAutomation report and its properties.
listselect$skipToken, $top, $select, $filter, $orderby, offerGuid, reportCreatorTenantIdGet the AppComplianceAutomation report list for the tenant.
create_or_updateinsertreport_name, propertiesCreate a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.
updateupdatereport_nameUpdate an exiting AppComplianceAutomation report.
create_or_updatereplacereport_name, propertiesCreate a new AppComplianceAutomation report or update an exiting AppComplianceAutomation report.
deletedeletereport_nameDelete an AppComplianceAutomation report.
get_scoping_questionsexecreport_nameFix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed.
nested_resource_check_name_availabilityexecreport_nameChecks the report's nested resource name availability, e.g: Webhooks, Evidences, Snapshots.
fixexecreport_nameFix the AppComplianceAutomation report error. e.g: App Compliance Automation Tool service unregistered, automation removed.
sync_cert_recordexecreport_name, certRecordSynchronize attestation record from app compliance.
verifyexecreport_nameVerify 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.

NameDatatypeDescription
report_namestringReport Name. Required.
$filterstringThe filter to apply on the operation. Default value is None.
$orderbystringOData order by query option. Default value is None.
$selectstringOData Select statement. Limits the properties on each entry to just those requested, e.g. ?$select=reportName,id. Default value is None.
$skipTokenstringSkip over when retrieving results. Default value is None.
$topintegerNumber of elements to return when retrieving results. Default value is None.
offerGuidstringThe offerGuid which mapping to the reports. Default value is None.
reportCreatorTenantIdstringThe tenant id of the report creator. Default value is None.

SELECT examples​

Get the AppComplianceAutomation report and its properties.

SELECT
id,
name,
certRecords,
complianceStatus,
errors,
lastTriggerTime,
nextTriggerTime,
offerGuid,
provisioningState,
resources,
status,
storageInfo,
subscriptions,
systemData,
tenantId,
timeZone,
triggerTime,
type
FROM azure_extras.app_compliance_automation.report
WHERE report_name = '{{ report_name }}' -- required
;

INSERT examples​

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

INSERT INTO azure_extras.app_compliance_automation.report (
properties,
report_name
)
SELECT 
'{{ properties }}' /* required */,
'{{ report_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

UPDATE examples​

Update an exiting AppComplianceAutomation report.

UPDATE azure_extras.app_compliance_automation.report
SET 
properties = '{{ properties }}'
WHERE 
report_name = '{{ report_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples​

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

REPLACE azure_extras.app_compliance_automation.report
SET 
properties = '{{ properties }}'
WHERE 
report_name = '{{ report_name }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples​

Delete an AppComplianceAutomation report.

DELETE FROM azure_extras.app_compliance_automation.report
WHERE report_name = '{{ report_name }}' --required
;

Lifecycle Methods​

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

EXEC azure_extras.app_compliance_automation.report.get_scoping_questions 
@report_name='{{ report_name }}' --required
;