@datafire/azure_sql_databasevulnerabilityassessmentscans

Client library for SqlManagementClient

Installation and Usage

npm install --save @datafire/azure_sql_databasevulnerabilityassessmentscans

let azure_sql_databasevulnerabilityassessmentscans = require('@datafire/azure_sql_databasevulnerabilityassessmentscans').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.

Actions

DatabaseVulnerabilityAssessmentScans_ListByDatabase

Lists the vulnerability assessment scans of a database.

azure_sql_databasevulnerabilityassessmentscans.DatabaseVulnerabilityAssessmentScans_ListByDatabase({
  "resourceGroupName": "",
  "serverName": "",
  "databaseName": "",
  "vulnerabilityAssessmentName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • databaseName required string: The name of the database.
  • vulnerabilityAssessmentName required string (values: default): The name of the vulnerability assessment.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

• output VulnerabilityAssessmentScanRecordListResult

DatabaseVulnerabilityAssessmentScans_Get

Gets a vulnerability assessment scan record of a database.

azure_sql_databasevulnerabilityassessmentscans.DatabaseVulnerabilityAssessmentScans_Get({
  "resourceGroupName": "",
  "serverName": "",
  "databaseName": "",
  "vulnerabilityAssessmentName": "",
  "scanId": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • databaseName required string: The name of the database.
  • vulnerabilityAssessmentName required string (values: default): The name of the vulnerability assessment.
  • scanId required string: The vulnerability assessment scan Id of the scan to retrieve.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

• output VulnerabilityAssessmentScanRecord

DatabaseVulnerabilityAssessmentScans_Export

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

azure_sql_databasevulnerabilityassessmentscans.DatabaseVulnerabilityAssessmentScans_Export({
  "resourceGroupName": "",
  "serverName": "",
  "databaseName": "",
  "vulnerabilityAssessmentName": "",
  "scanId": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • databaseName required string: The name of the scanned database.
  • vulnerabilityAssessmentName required string (values: default): The name of the vulnerability assessment.
  • scanId required string: The vulnerability assessment scan Id.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

• output DatabaseVulnerabilityAssessmentScansExport

DatabaseVulnerabilityAssessmentScans_InitiateScan

Executes a Vulnerability Assessment database scan.

azure_sql_databasevulnerabilityassessmentscans.DatabaseVulnerabilityAssessmentScans_InitiateScan({
  "resourceGroupName": "",
  "serverName": "",
  "databaseName": "",
  "vulnerabilityAssessmentName": "",
  "scanId": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • resourceGroupName required string: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
  • serverName required string: The name of the server.
  • databaseName required string: The name of the database.
  • vulnerabilityAssessmentName required string (values: default): The name of the vulnerability assessment.
  • scanId required string: The vulnerability assessment scan Id of the scan to retrieve.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • api-version required string: The API version to use for the request.

Output

Output schema unknown

Definitions

DatabaseVulnerabilityAssessmentScanExportProperties

• DatabaseVulnerabilityAssessmentScanExportProperties object: Properties of the export operation's result.
  • exportedReportLocation string: Location of the exported report (e.g. https://myStorage.blob.core.windows.net/VaScans/scans/serverName/databaseName/scan_scanId.xlsx).

DatabaseVulnerabilityAssessmentScansExport

• DatabaseVulnerabilityAssessmentScansExport object: A database Vulnerability Assessment scan export resource.
  • properties DatabaseVulnerabilityAssessmentScanExportProperties
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type.

VulnerabilityAssessmentScanError

• VulnerabilityAssessmentScanError object: Properties of a vulnerability assessment scan error.
  • code string: The error code.
  • message string: The error message.

VulnerabilityAssessmentScanRecord

• VulnerabilityAssessmentScanRecord object: A vulnerability assessment scan record.
  • properties VulnerabilityAssessmentScanRecordProperties
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type.

VulnerabilityAssessmentScanRecordListResult

• VulnerabilityAssessmentScanRecordListResult object: A list of vulnerability assessment scan records.
  • nextLink string: Link to retrieve next page of results.
  • value array: Array of results.
    • items VulnerabilityAssessmentScanRecord

VulnerabilityAssessmentScanRecordProperties

• VulnerabilityAssessmentScanRecordProperties object: Properties of a vulnerability assessment scan record.
  • endTime string: The scan end time (UTC).
  • errors array: The scan errors.
    • items VulnerabilityAssessmentScanError
  • numberOfFailedSecurityChecks integer: The number of failed security checks.
  • scanId string: The scan ID.
  • startTime string: The scan start time (UTC).
  • state string (values: Passed, Failed, FailedToRun, InProgress): The scan status.
  • storageContainerPath string: The scan results storage container path.
  • triggerType string (values: OnDemand, Recurring): The scan trigger type.