Assessments interface
Interface representing a Assessments.
Methods
| create |
Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result |
| delete(string, string, Assessments |
Delete a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result |
| get(string, string, Assessments |
Get a security assessment on your scanned resource |
| list(string, Assessments |
Get security assessments on all your scanned resources inside a scope |
Method Details
createOrUpdate(string, string, SecurityAssessment, AssessmentsCreateOrUpdateOptionalParams)
Create a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result
function createOrUpdate(resourceId: string, assessmentName: string, assessment: SecurityAssessment, options?: AssessmentsCreateOrUpdateOptionalParams): Promise<SecurityAssessmentResponse>Parameters
- resourceId
-
string
The identifier of the resource.
- assessmentName
-
string
The Assessment Key - Unique key for the assessment type
- assessment
- SecurityAssessment
Calculated assessment on a pre-defined assessment metadata
The options parameters.
Returns
Promise<SecurityAssessmentResponse>
delete(string, string, AssessmentsDeleteOptionalParams)
Delete a security assessment on your resource. An assessment metadata that describes this assessment must be predefined with the same name before inserting the assessment result
function delete(resourceId: string, assessmentName: string, options?: AssessmentsDeleteOptionalParams): Promise<void>Parameters
- resourceId
-
string
The identifier of the resource.
- assessmentName
-
string
The Assessment Key - Unique key for the assessment type
- options
- AssessmentsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, AssessmentsGetOptionalParams)
Get a security assessment on your scanned resource
function get(resourceId: string, assessmentName: string, options?: AssessmentsGetOptionalParams): Promise<SecurityAssessmentResponse>Parameters
- resourceId
-
string
The identifier of the resource.
- assessmentName
-
string
The Assessment Key - Unique key for the assessment type
- options
- AssessmentsGetOptionalParams
The options parameters.
Returns
Promise<SecurityAssessmentResponse>
list(string, AssessmentsListOptionalParams)
Get security assessments on all your scanned resources inside a scope
function list(scope: string, options?: AssessmentsListOptionalParams): PagedAsyncIterableIterator<SecurityAssessmentResponse, SecurityAssessmentResponse[], PageSettings>Parameters
- scope
-
string
Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
- options
- AssessmentsListOptionalParams
The options parameters.
Returns
Azure SDK for JavaScript