AssessmentsMetadata interface

Package:

@azure/arm-security

Interface representing a AssessmentsMetadata.

Methods

createInSubscription(string, SecurityAssessmentMetadataResponse, AssessmentsMetadataCreateInSubscriptionOptionalParams)	Create metadata information on an assessment type in a specific subscription
deleteInSubscription(string, AssessmentsMetadataDeleteInSubscriptionOptionalParams)	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
get(string, AssessmentsMetadataGetOptionalParams)	Get metadata information on an assessment type
getInSubscription(string, AssessmentsMetadataGetInSubscriptionOptionalParams)	Get metadata information on an assessment type in a specific subscription
list(AssessmentsMetadataListOptionalParams)	Get metadata information on all assessment types
listBySubscription(AssessmentsMetadataListBySubscriptionOptionalParams)	Get metadata information on all assessment types in a specific subscription

Method Details

createInSubscription(string, SecurityAssessmentMetadataResponse, AssessmentsMetadataCreateInSubscriptionOptionalParams)

Create metadata information on an assessment type in a specific subscription

function createInSubscription(assessmentMetadataName: string, assessmentMetadata: SecurityAssessmentMetadataResponse, options?: AssessmentsMetadataCreateInSubscriptionOptionalParams): Promise<SecurityAssessmentMetadataResponse>

Parameters

assessmentMetadataName

string

The Assessment Key - Unique key for the assessment type

assessmentMetadata

SecurityAssessmentMetadataResponse

AssessmentMetadata object

options

AssessmentsMetadataCreateInSubscriptionOptionalParams

The options parameters.

Returns

Promise<SecurityAssessmentMetadataResponse>

deleteInSubscription(string, AssessmentsMetadataDeleteInSubscriptionOptionalParams)

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

function deleteInSubscription(assessmentMetadataName: string, options?: AssessmentsMetadataDeleteInSubscriptionOptionalParams): Promise<void>

Parameters

assessmentMetadataName

string

The Assessment Key - Unique key for the assessment type

options

AssessmentsMetadataDeleteInSubscriptionOptionalParams

The options parameters.

Returns

Promise<void>

get(string, AssessmentsMetadataGetOptionalParams)

Get metadata information on an assessment type

function get(assessmentMetadataName: string, options?: AssessmentsMetadataGetOptionalParams): Promise<SecurityAssessmentMetadataResponse>

Parameters

assessmentMetadataName

string

The Assessment Key - Unique key for the assessment type

options

AssessmentsMetadataGetOptionalParams

The options parameters.

Returns

Promise<SecurityAssessmentMetadataResponse>

getInSubscription(string, AssessmentsMetadataGetInSubscriptionOptionalParams)

Get metadata information on an assessment type in a specific subscription

function getInSubscription(assessmentMetadataName: string, options?: AssessmentsMetadataGetInSubscriptionOptionalParams): Promise<SecurityAssessmentMetadataResponse>

Parameters

assessmentMetadataName

string

The Assessment Key - Unique key for the assessment type

options

AssessmentsMetadataGetInSubscriptionOptionalParams

The options parameters.

Returns

Promise<SecurityAssessmentMetadataResponse>

list(AssessmentsMetadataListOptionalParams)

Get metadata information on all assessment types

function list(options?: AssessmentsMetadataListOptionalParams): PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse, SecurityAssessmentMetadataResponse[], PageSettings>

Parameters

options

AssessmentsMetadataListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse, SecurityAssessmentMetadataResponse[], PageSettings>

listBySubscription(AssessmentsMetadataListBySubscriptionOptionalParams)

Get metadata information on all assessment types in a specific subscription

function listBySubscription(options?: AssessmentsMetadataListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse, SecurityAssessmentMetadataResponse[], PageSettings>

Parameters

options

AssessmentsMetadataListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SecurityAssessmentMetadataResponse, SecurityAssessmentMetadataResponse[], PageSettings>