Evidence interface
Interface representing a Evidence.
Methods
| create |
Create or Update an evidence a specified report |
| delete(string, string, Evidence |
Delete an existent evidence from a specified report |
| download(string, string, Evidence |
Download evidence file. |
| get(string, string, Evidence |
Get the evidence metadata |
| list |
Returns a paginated list of evidences for a specified report. |
Method Details
createOrUpdate(string, string, EvidenceResource, EvidenceCreateOrUpdateOptionalParams)
Create or Update an evidence a specified report
function createOrUpdate(reportName: string, evidenceName: string, properties: EvidenceResource, options?: EvidenceCreateOrUpdateOptionalParams): Promise<EvidenceResource>Parameters
- reportName
-
string
Report Name.
- evidenceName
-
string
The evidence name.
- properties
- EvidenceResource
Parameters for the create or update operation
The options parameters.
Returns
Promise<EvidenceResource>
delete(string, string, EvidenceDeleteOptionalParams)
Delete an existent evidence from a specified report
function delete(reportName: string, evidenceName: string, options?: EvidenceDeleteOptionalParams): Promise<void>Parameters
- reportName
-
string
Report Name.
- evidenceName
-
string
The evidence name.
- options
- EvidenceDeleteOptionalParams
The options parameters.
Returns
Promise<void>
download(string, string, EvidenceFileDownloadRequest, EvidenceDownloadOptionalParams)
Download evidence file.
function download(reportName: string, evidenceName: string, body: EvidenceFileDownloadRequest, options?: EvidenceDownloadOptionalParams): Promise<EvidenceFileDownloadResponse>Parameters
- reportName
-
string
Report Name.
- evidenceName
-
string
The evidence name.
Parameters for the query operation
- options
- EvidenceDownloadOptionalParams
The options parameters.
Returns
Promise<EvidenceFileDownloadResponse>
get(string, string, EvidenceGetOptionalParams)
Get the evidence metadata
function get(reportName: string, evidenceName: string, options?: EvidenceGetOptionalParams): Promise<EvidenceResource>Parameters
- reportName
-
string
Report Name.
- evidenceName
-
string
The evidence name.
- options
- EvidenceGetOptionalParams
The options parameters.
Returns
Promise<EvidenceResource>
listByReport(string, EvidenceListByReportOptionalParams)
Returns a paginated list of evidences for a specified report.
function listByReport(reportName: string, options?: EvidenceListByReportOptionalParams): PagedAsyncIterableIterator<EvidenceResource, EvidenceResource[], PageSettings>Parameters
- reportName
-
string
Report Name.
The options parameters.