Database Sql Vulnerability Assessment Scans - List By Sql Vulnerability Assessments

服務:: SQL Database

API 版本:: 2023-08-01

列出資料庫的弱點評估掃描。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/default/scans?api-version=2023-08-01

URI 參數

名稱	位於	必要	類型	Description
databaseName	path	True	string	資料庫的名稱。
resourceGroupName	path	True	string	包含資源的資源群組名稱。您可以從 Azure Resource Manager API 或入口網站取得此值。
serverName	path	True	string	伺服器的名稱。
subscriptionId	path	True	string	識別 Azure 訂用帳戶的訂用帳戶標識碼。
vulnerabilityAssessmentName	path	True	VulnerabilityAssessmentName	弱點評估的名稱。
api-version	query	True	string	要用於要求的 API 版本。

回應

名稱	類型	Description
200 OK	SqlVulnerabilityAssessmentScanRecordListResult	已成功擷取資料庫弱點評估掃描記錄。
Other Status Codes	ErrorResponse	錯誤回應： *** 400 SqlVulnerabilityAssessmentIsDisabled - SQL 弱點評估功能已停用。請先啟用此功能，再執行其他 SQL 弱點評估作業。 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - 用戶端提供無效的參數值。 400 InvalidSqlVulnerabilityAssessmentBaselineInput - SQL 弱點評估基準輸入為 Null 或空白。 400 InvalidSqlVulnerabilityAssessmentSettingsInput - SQL 弱點評估設定輸入為 Null 或空白 400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet - SQL 弱點評估結果尚無法使用，請稍後再試一次。 400 SqlVulnerabilityAssessmentInvalidRuleId - SQL 弱點評估規則標識碼無效。 400 SqlVulnerabilityAssessmentScanDoesNotExist - SQL 弱點評估掃描不存在。 400 SqlVulnerabilityAssessmentNoBaseline - 找不到資源中最新掃描的基準 400 SqlVulnerabilityAssessmentNoRuleBaseline - 找不到 SQL 弱點評估基準 400 SqlVulnerabilityAssessmentBaselineNoScanResults - 找不到規則標識符的掃描結果。若要設定基準，在最新的掃描中必須有此規則的結果 400 SqlVulnerabilityAssessmentBadBinaryRuleFormat - 二進位規則的輸入不是布爾值表示法 400 SqlVulnerabilityAssessmentBadRuleFormat - 所提供的結果不符合掃描結果的實際配置 400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat - 所提供的結果不符合掃描結果的實際配置 400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat - 二進位規則的輸入不是布爾值表示法 400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId - 找不到其中一個規則的掃描結果。若要設定基準，在最新的掃描中必須有此規則的結果 400 SqlVulnerabilityAssessmentEmptyBaseline - 基準未設定，因為結果為 Null 或空白 404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器 404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。 404 SourceDatabaseNotFound - 源資料庫不存在。 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - SQL 弱點評估掃描正在進行中 409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled - 此伺服器或其其中一個基礎資料庫已啟用不相容的版本。您可以在 https://aka.ms/SQLVAStoragelessDocumentation找到其他疑難解答資訊。 500 DatabaseIsUnavailable - 載入失敗。請稍後再試一次。

名稱

類型

Description

200 OK

SqlVulnerabilityAssessmentScanRecordListResult

已成功擷取資料庫弱點評估掃描記錄。

Other Status Codes

ErrorResponse

錯誤回應： ***

400 SqlVulnerabilityAssessmentIsDisabled - SQL 弱點評估功能已停用。請先啟用此功能，再執行其他 SQL 弱點評估作業。
400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - 用戶端提供無效的參數值。
400 InvalidSqlVulnerabilityAssessmentBaselineInput - SQL 弱點評估基準輸入為 Null 或空白。
400 InvalidSqlVulnerabilityAssessmentSettingsInput - SQL 弱點評估設定輸入為 Null 或空白
400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet - SQL 弱點評估結果尚無法使用，請稍後再試一次。
400 SqlVulnerabilityAssessmentInvalidRuleId - SQL 弱點評估規則標識碼無效。
400 SqlVulnerabilityAssessmentScanDoesNotExist - SQL 弱點評估掃描不存在。
400 SqlVulnerabilityAssessmentNoBaseline - 找不到資源中最新掃描的基準
400 SqlVulnerabilityAssessmentNoRuleBaseline - 找不到 SQL 弱點評估基準
400 SqlVulnerabilityAssessmentBaselineNoScanResults - 找不到規則標識符的掃描結果。若要設定基準，在最新的掃描中必須有此規則的結果
400 SqlVulnerabilityAssessmentBadBinaryRuleFormat - 二進位規則的輸入不是布爾值表示法
400 SqlVulnerabilityAssessmentBadRuleFormat - 所提供的結果不符合掃描結果的實際配置
400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat - 所提供的結果不符合掃描結果的實際配置
400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat - 二進位規則的輸入不是布爾值表示法
400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId - 找不到其中一個規則的掃描結果。若要設定基準，在最新的掃描中必須有此規則的結果
400 SqlVulnerabilityAssessmentEmptyBaseline - 基準未設定，因為結果為 Null 或空白
404 SubscriptionDoesNotHaveServer - 找不到要求的伺服器
404 DatabaseDoesNotExist - 使用者已指定此伺服器實例上不存在的資料庫名稱。
404 SourceDatabaseNotFound - 源資料庫不存在。
409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - SQL 弱點評估掃描正在進行中
409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled - 此伺服器或其其中一個基礎資料庫已啟用不相容的版本。您可以在 https://aka.ms/SQLVAStoragelessDocumentation找到其他疑難解答資訊。
500 DatabaseIsUnavailable - 載入失敗。請稍後再試一次。

範例

Gets the list of a database vulnerability assessment scan records

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/databases/testdb/sqlVulnerabilityAssessments/default/scans?api-version=2023-08-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/DatabaseSqlVulnerabilityAssessmentScanRecordsListByDatabase.json
// this example is just showing the usage of "DatabaseSqlVulnerabilityAssessmentScans_ListBySqlVulnerabilityAssessments" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlDatabaseSqlVulnerabilityAssessmentResource created on azure
// for more information of creating SqlDatabaseSqlVulnerabilityAssessmentResource, please refer to the document of SqlDatabaseSqlVulnerabilityAssessmentResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "vulnerabilityassessmenttest-4711";
string serverName = "vulnerabilityassessmenttest-6411";
string databaseName = "testdb";
VulnerabilityAssessmentName vulnerabilityAssessmentName = VulnerabilityAssessmentName.Default;
ResourceIdentifier sqlDatabaseSqlVulnerabilityAssessmentResourceId = SqlDatabaseSqlVulnerabilityAssessmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName);
SqlDatabaseSqlVulnerabilityAssessmentResource sqlDatabaseSqlVulnerabilityAssessment = client.GetSqlDatabaseSqlVulnerabilityAssessmentResource(sqlDatabaseSqlVulnerabilityAssessmentResourceId);

// get the collection of this SqlDatabaseSqlVulnerabilityAssessmentScanResource
SqlDatabaseSqlVulnerabilityAssessmentScanCollection collection = sqlDatabaseSqlVulnerabilityAssessment.GetSqlDatabaseSqlVulnerabilityAssessmentScans();

// invoke the operation and iterate over the result
await foreach (SqlDatabaseSqlVulnerabilityAssessmentScanResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlVulnerabilityAssessmentScanData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/databases/testdb/sqlVulnerabilityAssessments/default/scans/scan001",
      "name": "scan001",
      "type": "Microsoft.Sql/servers/databases/sqlVulnerabilityAssessments/scans",
      "properties": {
        "scanId": "scan001",
        "triggerType": "Recurring",
        "state": "Failed",
        "server": "vulnerabilityassessmenttest-6411",
        "database": "testdb",
        "sqlVersion": "15.0.2000",
        "startTime": "2020-06-23T12:19:00.6455136+05:30",
        "endTime": "2020-06-23T06:49:00.7236217Z",
        "highSeverityFailedRulesCount": 3,
        "mediumSeverityFailedRulesCount": 2,
        "lowSeverityFailedRulesCount": 1,
        "totalPassedRulesCount": 20,
        "totalFailedRulesCount": 6,
        "totalRulesCount": 26,
        "isBaselineApplied": false,
        "lastScanTime": "2020-06-23T12:19:00.6455136+05:30"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/databases/testdb/sqlVulnerabilityAssessments/default/scans/scan002",
      "name": "scan001",
      "type": "Microsoft.Sql/servers/databases/sqlVulnerabilityAssessments/scans",
      "properties": {
        "scanId": "scan002",
        "triggerType": "Recurring",
        "state": "Failed",
        "server": "vulnerabilityassessmenttest-6411",
        "database": "testdb",
        "sqlVersion": "15.0.2000",
        "startTime": "2020-06-23T12:19:00.6455136+05:30",
        "endTime": "2020-06-23T06:49:00.7236217Z",
        "highSeverityFailedRulesCount": 3,
        "mediumSeverityFailedRulesCount": 2,
        "lowSeverityFailedRulesCount": 1,
        "totalPassedRulesCount": 20,
        "totalFailedRulesCount": 6,
        "totalRulesCount": 26,
        "isBaselineApplied": false,
        "lastScanTime": "2020-06-23T12:19:00.6455136+05:30"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/databases/testdb/sqlVulnerabilityAssessments/default/scans/scan003",
      "name": "scan001",
      "type": "Microsoft.Sql/servers/databases/sqlVulnerabilityAssessments/scans",
      "properties": {
        "scanId": "scan003",
        "triggerType": "Recurring",
        "state": "Failed",
        "server": "vulnerabilityassessmenttest-6411",
        "database": "testdb",
        "sqlVersion": "15.0.2000",
        "startTime": "2020-06-23T12:19:00.6455136+05:30",
        "endTime": "2020-06-23T06:49:00.7236217Z",
        "highSeverityFailedRulesCount": 3,
        "mediumSeverityFailedRulesCount": 2,
        "lowSeverityFailedRulesCount": 1,
        "totalPassedRulesCount": 20,
        "totalFailedRulesCount": 6,
        "totalRulesCount": 26,
        "isBaselineApplied": false,
        "lastScanTime": "2020-06-23T12:19:00.6455136+05:30"
      }
    }
  ]
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
SqlVulnerabilityAssessmentScanError	弱點評估掃描錯誤的屬性。
SqlVulnerabilityAssessmentScanRecord	弱點評估掃描記錄。
SqlVulnerabilityAssessmentScanRecordListResult	弱點評估掃描記錄的清單。
systemData	與建立和上次修改資源相關的元數據。
VulnerabilityAssessmentName	弱點評估的名稱。
VulnerabilityAssessmentScanState	掃描狀態。
VulnerabilityAssessmentScanTriggerType	掃描觸發程序類型。

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

SqlVulnerabilityAssessmentScanError

Object

弱點評估掃描錯誤的屬性。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息。

SqlVulnerabilityAssessmentScanRecord

Object

弱點評估掃描記錄。

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties.database	string	資料庫名稱。
properties.endTime	string (date-time)	掃描結束時間（UTC）。
properties.errors	SqlVulnerabilityAssessmentScanError[]	掃描錯誤。
properties.highSeverityFailedRulesCount	integer (int32)	嚴重性較高的失敗規則數目。
properties.isBaselineApplied	boolean	為此資料庫建立的基準，並具有一或多個規則。
properties.lastScanTime	string (date-time)	上次掃描時間。
properties.lowSeverityFailedRulesCount	integer (int32)	具有低嚴重性之失敗規則的數目。
properties.mediumSeverityFailedRulesCount	integer (int32)	具有中等嚴重性之失敗規則的數目。
properties.scanId	string	掃描標識碼。
properties.server	string	伺服器名稱。
properties.sqlVersion	string	SQL 版本。
properties.startTime	string (date-time)	掃描開始時間（UTC）。
properties.state	VulnerabilityAssessmentScanState	掃描狀態。
properties.totalFailedRulesCount	integer (int32)	失敗規則總數。
properties.totalPassedRulesCount	integer (int32)	已傳遞規則總數。
properties.totalRulesCount	integer (int32)	評估的規則總數。
properties.triggerType	VulnerabilityAssessmentScanTriggerType	掃描觸發程序類型。
systemData	systemData	SqlVulnerabilityAssessmentScanRecordResource 的 SystemData。
type	string	資源類型。

SqlVulnerabilityAssessmentScanRecordListResult

Object

弱點評估掃描記錄的清單。

名稱	類型	Description
nextLink	string	連結以擷取下一頁的結果。
value	SqlVulnerabilityAssessmentScanRecord[]	結果的陣列。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

VulnerabilityAssessmentName

列舉型別

弱點評估的名稱。

值	Description
default

VulnerabilityAssessmentScanState

列舉型別

掃描狀態。

值	Description
Passed
Failed
FailedToRun
InProgress

VulnerabilityAssessmentScanTriggerType

列舉型別

掃描觸發程序類型。

值	Description
OnDemand
Recurring

共用方式為

Database Sql Vulnerability Assessment Scans - List By Sql Vulnerability Assessments

URI 參數

回應

範例

Gets the list of a database vulnerability assessment scan records

範例要求

範例回覆

定義

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SqlVulnerabilityAssessmentScanError

SqlVulnerabilityAssessmentScanRecord

SqlVulnerabilityAssessmentScanRecordListResult

systemData

VulnerabilityAssessmentName

VulnerabilityAssessmentScanState

VulnerabilityAssessmentScanTriggerType