Package version:

Interface AssessmentsMetadata

Interface representing a AssessmentsMetadata.

Hierarchy

AssessmentsMetadata

Index

Methods

createInSubscription deleteInSubscription get getInSubscription list listBySubscription

Methods

createInSubscription

createInSubscription(assessmentMetadataName: string, assessmentMetadata: SecurityAssessmentMetadataResponse, options?: AssessmentsMetadataCreateInSubscriptionOptionalParams): Promise<SecurityAssessmentMetadataResponse>
Create metadata information on an assessment type in a specific subscription
Parameters
- assessmentMetadataName: string
  
  The Assessment Key - Unique key for the assessment type
- assessmentMetadata: SecurityAssessmentMetadataResponse
  
  AssessmentMetadata object
- Optional options: AssessmentsMetadataCreateInSubscriptionOptionalParams
  
  The options parameters.
Returns Promise<SecurityAssessmentMetadataResponse>
- Defined in operationsInterfaces/assessmentsMetadata.ts:64

deleteInSubscription

deleteInSubscription(assessmentMetadataName: string, options?: AssessmentsMetadataDeleteInSubscriptionOptionalParams): Promise<void>
Delete metadata information on an assessment type in a specific subscription, will cause the deletion of all the assessments of that type in that subscription
Parameters
- assessmentMetadataName: string
  
  The Assessment Key - Unique key for the assessment type
- Optional options: AssessmentsMetadataDeleteInSubscriptionOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/assessmentsMetadata.ts:75

get

get(assessmentMetadataName: string, options?: AssessmentsMetadataGetOptionalParams): Promise<SecurityAssessmentMetadataResponse>
Get metadata information on an assessment type
Parameters
- assessmentMetadataName: string
  
  The Assessment Key - Unique key for the assessment type
- Optional options: AssessmentsMetadataGetOptionalParams
  
  The options parameters.
Returns Promise<SecurityAssessmentMetadataResponse>
- Defined in operationsInterfaces/assessmentsMetadata.ts:45

getInSubscription

getInSubscription(assessmentMetadataName: string, options?: AssessmentsMetadataGetInSubscriptionOptionalParams): Promise<SecurityAssessmentMetadataResponse>
Get metadata information on an assessment type in a specific subscription
Parameters
- assessmentMetadataName: string
  
  The Assessment Key - Unique key for the assessment type
- Optional options: AssessmentsMetadataGetInSubscriptionOptionalParams
  
  The options parameters.
Returns Promise<SecurityAssessmentMetadataResponse>
- Defined in operationsInterfaces/assessmentsMetadata.ts:54

list

list(options?: AssessmentsMetadataListOptionalParams): PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse>
Get metadata information on all assessment types
Parameters
- Optional options: AssessmentsMetadataListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse>
- Defined in operationsInterfaces/assessmentsMetadata.ts:30

listBySubscription

listBySubscription(options?: AssessmentsMetadataListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse>
Get metadata information on all assessment types in a specific subscription
Parameters
- Optional options: AssessmentsMetadataListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse>
- Defined in operationsInterfaces/assessmentsMetadata.ts:37

Generated using TypeDoc