evidences

Creates, updates, deletes, gets or lists an evidences resource.

Overview

Name	evidences
Type	Resource
Id	azure_extras.app_compliance_automation.evidences

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Evidence property.

list_by_report

Azure operation completed successfully.

Name	Datatype	Description
properties	object	Evidence property.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	reportName, evidenceName		Get the evidence metadata
list_by_report	select	reportName	$skipToken, $top, $select, $filter, $orderby, offerGuid, reportCreatorTenantId	Returns a paginated list of evidences for a specified report.
create_or_update	insert	reportName, evidenceName, data__properties	offerGuid, reportCreatorTenantId	Create or Update an evidence a specified report
delete	delete	reportName, evidenceName		Delete an existent evidence from a specified report
download	exec	reportName, evidenceName		Download evidence file.

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
evidenceName	string	The evidence name.
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 evidence metadata

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

list_by_report

Returns a paginated list of evidences for a specified report.

SELECT
properties
FROM azure_extras.app_compliance_automation.evidences
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 }}'
;

INSERT examples

create_or_update

Create or Update an evidence a specified report

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

Manifest

# Description fields are for documentation purposes
- name: evidences
  props:
    - name: reportName
      value: string
      description: Required parameter for the evidences resource.
    - name: evidenceName
      value: string
      description: Required parameter for the evidences resource.
    - name: properties
      value: object
      description: |
        Evidence property.
    - name: offerGuid
      value: string
      description: The offerGuid which mapping to the reports.
    - name: reportCreatorTenantId
      value: string
      description: The tenant id of the report creator.

DELETE examples

delete

Delete an existent evidence from a specified report

DELETE FROM azure_extras.app_compliance_automation.evidences
WHERE reportName = '{{ reportName }}' --required
AND evidenceName = '{{ evidenceName }}' --required
;

Lifecycle Methods

download

Download evidence file.

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