DatabaseVulnerabilityAssessmentScansOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

SqlManagementClient's

<xref:database_vulnerability_assessment_scans> attribute.

Constructor

DatabaseVulnerabilityAssessmentScansOperations(*args, **kwargs)

Methods

begin_initiate_scan	Executes a Vulnerability Assessment database scan.
export	Convert an existing scan result to a human readable format. If already exists nothing happens.
get	Gets a vulnerability assessment scan record of a database.
list_by_database	Lists the vulnerability assessment scans of a database.

begin_initiate_scan

Executes a Vulnerability Assessment database scan.

async begin_initiate_scan(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: str | VulnerabilityAssessmentName, scan_id: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
vulnerability_assessment_name Required	str or VulnerabilityAssessmentName The name of the vulnerability assessment. "default" Required.
scan_id Required	str The vulnerability assessment scan Id of the scan to retrieve. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

export

Convert an existing scan result to a human readable format. If already exists nothing happens.

async export(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: str | VulnerabilityAssessmentName, scan_id: str, **kwargs: Any) -> DatabaseVulnerabilityAssessmentScansExport

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the scanned database. Required.
vulnerability_assessment_name Required	str or VulnerabilityAssessmentName The name of the vulnerability assessment. "default" Required.
scan_id Required	str The vulnerability assessment scan Id. Required.

Returns

Type	Description
DatabaseVulnerabilityAssessmentScansExport	DatabaseVulnerabilityAssessmentScansExport or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets a vulnerability assessment scan record of a database.

async get(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: str | VulnerabilityAssessmentName, scan_id: str, **kwargs: Any) -> VulnerabilityAssessmentScanRecord

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
vulnerability_assessment_name Required	str or VulnerabilityAssessmentName The name of the vulnerability assessment. "default" Required.
scan_id Required	str The vulnerability assessment scan Id of the scan to retrieve. Required.

Returns

Type	Description
VulnerabilityAssessmentScanRecord	VulnerabilityAssessmentScanRecord or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_database

Lists the vulnerability assessment scans of a database.

list_by_database(resource_group_name: str, server_name: str, database_name: str, vulnerability_assessment_name: str | VulnerabilityAssessmentName, **kwargs: Any) -> AsyncItemPaged[VulnerabilityAssessmentScanRecord]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.
server_name Required	str The name of the server. Required.
database_name Required	str The name of the database. Required.
vulnerability_assessment_name Required	str or VulnerabilityAssessmentName The name of the vulnerability assessment. "default" Required.

Returns

Type	Description
AsyncItemPaged[VulnerabilityAssessmentScanRecord]	An iterator like instance of either VulnerabilityAssessmentScanRecord or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.sql.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv268\\Lib\\site-packages\\azure\\mgmt\\sql\\models\\__init__.py'>