Package version:

Interface Assessments

Interface representing a Assessments.

Hierarchy

Assessments

Index

Methods

createOrUpdate delete get list

Methods

createOrUpdate

createOrUpdate(resourceId: string, assessmentName: string, assessment: SecurityAssessment, options?: AssessmentsCreateOrUpdateOptionalParams): Promise<SecurityAssessmentResponse>
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
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
- Optional options: AssessmentsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SecurityAssessmentResponse>
- Defined in operationsInterfaces/assessments.ts:54

delete

delete(resourceId: string, assessmentName: string, options?: AssessmentsDeleteOptionalParams): Promise<void>
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
Parameters
- resourceId: string
  
  The identifier of the resource.
- assessmentName: string
  
  The Assessment Key - Unique key for the assessment type
- Optional options: AssessmentsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/assessments.ts:67

get

get(resourceId: string, assessmentName: string, options?: AssessmentsGetOptionalParams): Promise<SecurityAssessmentResponse>
Get a security assessment on your scanned resource
Parameters
- resourceId: string
  
  The identifier of the resource.
- assessmentName: string
  
  The Assessment Key - Unique key for the assessment type
- Optional options: AssessmentsGetOptionalParams
  
  The options parameters.
Returns Promise<SecurityAssessmentResponse>
- Defined in operationsInterfaces/assessments.ts:41

list

list(scope: string, options?: AssessmentsListOptionalParams): PagedAsyncIterableIterator<SecurityAssessmentResponse>
Get security assessments on all your scanned resources inside a scope
Parameters
- scope: string
  
  Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
- Optional options: AssessmentsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SecurityAssessmentResponse>
- Defined in operationsInterfaces/assessments.ts:31

Generated using TypeDoc