@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Microsoft Defender for Cloud
@base https://management.azure.com
@version 2020-01-01
@auth OAuth2
@endpoints 6
@toc providers(2), subscriptions(4)

@group providers
@endpoint GET /providers/Microsoft.Security/assessmentMetadata
@desc Get metadata information on all assessment types
@returns(200) OK

@endpoint GET /providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}
@desc Get metadata information on an assessment type
@required {assessmentMetadataName: any # The Assessment Key - Unique key for the assessment type}
@returns(200) OK

@endgroup

@group subscriptions
@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata
@desc Get metadata information on all assessment types in a specific subscription
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}
@desc Get metadata information on an assessment type in a specific subscription
@required {assessmentMetadataName: any # The Assessment Key - Unique key for the assessment type}
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}
@desc Create metadata information on an assessment type in a specific subscription
@required {assessmentMetadataName: any # The Assessment Key - Unique key for the assessment type, assessmentMetadata: map # AssessmentMetadata object}
@returns(200) OK

@endpoint DELETE /subscriptions/{subscriptionId}/providers/Microsoft.Security/assessmentMetadata/{assessmentMetadataName}
@desc 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
@required {assessmentMetadataName: any # The Assessment Key - Unique key for the assessment type}
@returns(200) OK

@endgroup

@end