SqlPoolVulnerabilityAssessmentScans interface

Package:

@azure/arm-synapse

Interface representing a SqlPoolVulnerabilityAssessmentScans.

Methods

beginInitiateScan(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams)	Executes a Vulnerability Assessment database scan.
beginInitiateScanAndWait(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams)	Executes a Vulnerability Assessment database scan.
export(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansExportOptionalParams)	Convert an existing scan result to a human readable format. If already exists nothing happens
get(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansGetOptionalParams)	Gets a vulnerability assessment scan record of a Sql pool.
list(string, string, string, string, SqlPoolVulnerabilityAssessmentScansListOptionalParams)	Lists the vulnerability assessment scans of a SQL pool.

Method Details

beginInitiateScan(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams)

Executes a Vulnerability Assessment database scan.

function beginInitiateScan(resourceGroupName: string, workspaceName: string, sqlPoolName: string, vulnerabilityAssessmentName: string, scanId: string, options?: SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

vulnerabilityAssessmentName

string

The name of the vulnerability assessment.

scanId

string

The vulnerability assessment scan Id of the scan to retrieve.

options

SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams

The options parameters.

Returns

Promise<PollerLike<PollOperationState<void>, void>>

beginInitiateScanAndWait(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams)

Executes a Vulnerability Assessment database scan.

function beginInitiateScanAndWait(resourceGroupName: string, workspaceName: string, sqlPoolName: string, vulnerabilityAssessmentName: string, scanId: string, options?: SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

vulnerabilityAssessmentName

string

The name of the vulnerability assessment.

scanId

string

The vulnerability assessment scan Id of the scan to retrieve.

options

SqlPoolVulnerabilityAssessmentScansInitiateScanOptionalParams

The options parameters.

Returns

Promise<void>

export(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansExportOptionalParams)

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

function export(resourceGroupName: string, workspaceName: string, sqlPoolName: string, vulnerabilityAssessmentName: string, scanId: string, options?: SqlPoolVulnerabilityAssessmentScansExportOptionalParams): Promise<SqlPoolVulnerabilityAssessmentScansExport>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

vulnerabilityAssessmentName

string

The name of the vulnerability assessment.

scanId

string

The vulnerability assessment scan Id of the scan to retrieve.

options

SqlPoolVulnerabilityAssessmentScansExportOptionalParams

The options parameters.

Returns

Promise<SqlPoolVulnerabilityAssessmentScansExport>

get(string, string, string, string, string, SqlPoolVulnerabilityAssessmentScansGetOptionalParams)

Gets a vulnerability assessment scan record of a Sql pool.

function get(resourceGroupName: string, workspaceName: string, sqlPoolName: string, vulnerabilityAssessmentName: string, scanId: string, options?: SqlPoolVulnerabilityAssessmentScansGetOptionalParams): Promise<VulnerabilityAssessmentScanRecord>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

vulnerabilityAssessmentName

string

The name of the vulnerability assessment.

scanId

string

The vulnerability assessment scan Id of the scan to retrieve.

options

SqlPoolVulnerabilityAssessmentScansGetOptionalParams

The options parameters.

Returns

Promise<VulnerabilityAssessmentScanRecord>

list(string, string, string, string, SqlPoolVulnerabilityAssessmentScansListOptionalParams)

Lists the vulnerability assessment scans of a SQL pool.

function list(resourceGroupName: string, workspaceName: string, sqlPoolName: string, vulnerabilityAssessmentName: string, options?: SqlPoolVulnerabilityAssessmentScansListOptionalParams): PagedAsyncIterableIterator<VulnerabilityAssessmentScanRecord, VulnerabilityAssessmentScanRecord[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

workspaceName

string

The name of the workspace.

sqlPoolName

string

SQL pool name

vulnerabilityAssessmentName

string

The name of the vulnerability assessment.

options

SqlPoolVulnerabilityAssessmentScansListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<VulnerabilityAssessmentScanRecord, VulnerabilityAssessmentScanRecord[], PageSettings>