Sql Vulnerability Assessment Scans - List

參考

服務:: Defender for Cloud

API 版本:: 2023-02-01-preview

取得掃描記錄的清單。

GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans?workspaceId={workspaceId}&api-version=2023-02-01-preview

URI 參數

名稱	位於	必要	類型	Description
resourceId	path	True	string	資源的標識碼。
api-version	query	True	string	API 版本。
workspaceId	query	True	string	工作區標識碼。

回應

名稱	類型	Description
200 OK	Scans	傳回掃描記錄的清單。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List scan details

範例要求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview


/**
 * Samples for SqlVulnerabilityAssessmentScans List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
     * sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_List.json
     */
    /**
     * Sample code: List scan details.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listScanDetails(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sqlVulnerabilityAssessmentScans().listWithResponse("55555555-6666-7777-8888-999999999999",
            "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master",
            com.azure.core.util.Context.NONE);
    }
}

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

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_List.json
func ExampleSQLVulnerabilityAssessmentScansClient_List() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLVulnerabilityAssessmentScansClient().List(ctx, "55555555-6666-7777-8888-999999999999", "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Scans = armsecurity.Scans{
	// 	Value: []*armsecurity.Scan{
	// 		{
	// 			Name: to.Ptr("Scheduled-20200225"),
	// 			Type: to.Ptr("Microsoft.Security/sqlVulnerabilityAssessments/scans"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200225"),
	// 			Properties: &armsecurity.ScanProperties{
	// 				Database: to.Ptr("master"),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-25T11:38:07.860Z"); return t}()),
	// 				HighSeverityFailedRulesCount: to.Ptr[int32](3),
	// 				IsBaselineApplied: to.Ptr(false),
	// 				LastScanTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.645Z"); return t}()),
	// 				LowSeverityFailedRulesCount: to.Ptr[int32](1),
	// 				MediumSeverityFailedRulesCount: to.Ptr[int32](2),
	// 				Server: to.Ptr("server1"),
	// 				SQLVersion: to.Ptr("15.0.2000"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-25T11:34:29.139Z"); return t}()),
	// 				State: to.Ptr(armsecurity.ScanStateFailed),
	// 				TotalFailedRulesCount: to.Ptr[int32](6),
	// 				TotalPassedRulesCount: to.Ptr[int32](20),
	// 				TotalRulesCount: to.Ptr[int32](26),
	// 				TriggerType: to.Ptr(armsecurity.ScanTriggerTypeRecurring),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("scan_20200226_113429"),
	// 			Type: to.Ptr("Microsoft.Security/sqlVulnerabilityAssessments/scans"),
	// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/scan_20200226_113429"),
	// 			Properties: &armsecurity.ScanProperties{
	// 				Database: to.Ptr("master"),
	// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-26T11:38:07.860Z"); return t}()),
	// 				HighSeverityFailedRulesCount: to.Ptr[int32](0),
	// 				IsBaselineApplied: to.Ptr(true),
	// 				LastScanTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.645Z"); return t}()),
	// 				LowSeverityFailedRulesCount: to.Ptr[int32](0),
	// 				MediumSeverityFailedRulesCount: to.Ptr[int32](0),
	// 				Server: to.Ptr("server1"),
	// 				SQLVersion: to.Ptr("15.0.2000"),
	// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-26T11:34:29.139Z"); return t}()),
	// 				State: to.Ptr(armsecurity.ScanStatePassed),
	// 				TotalFailedRulesCount: to.Ptr[int32](0),
	// 				TotalPassedRulesCount: to.Ptr[int32](26),
	// 				TotalRulesCount: to.Ptr[int32](26),
	// 				TriggerType: to.Ptr(armsecurity.ScanTriggerTypeOnDemand),
	// 			},
	// 	}},
	// }
}

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

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a list of scan records.
 *
 * @summary Gets a list of scan records.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_List.json
 */
async function listScanDetails() {
  const workspaceId = "55555555-6666-7777-8888-999999999999";
  const resourceId =
    "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.sqlVulnerabilityAssessmentScans.list(workspaceId, resourceId);
  console.log(result);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_List.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentScans_List" 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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this SqlVulnerabilityAssessmentScanResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", resourceId));
SqlVulnerabilityAssessmentScanCollection collection = client.GetSqlVulnerabilityAssessmentScans(scopeId);

// invoke the operation and iterate over the result
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
await foreach (SqlVulnerabilityAssessmentScanResource item in collection.GetAllAsync(workspaceId))
{
    // 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/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200225",
      "name": "Scheduled-20200225",
      "type": "Microsoft.Security/sqlVulnerabilityAssessments/scans",
      "properties": {
        "triggerType": "Recurring",
        "state": "Failed",
        "server": "server1",
        "database": "master",
        "sqlVersion": "15.0.2000",
        "startTime": "2020-02-25T11:34:29.1399864Z",
        "endTime": "2020-02-25T11:38:07.8606151Z",
        "highSeverityFailedRulesCount": 3,
        "mediumSeverityFailedRulesCount": 2,
        "lowSeverityFailedRulesCount": 1,
        "totalPassedRulesCount": 20,
        "totalFailedRulesCount": 6,
        "totalRulesCount": 26,
        "isBaselineApplied": false,
        "lastScanTime": "2020-06-23T06:49:00.6455136+00:00"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/scan_20200226_113429",
      "name": "scan_20200226_113429",
      "type": "Microsoft.Security/sqlVulnerabilityAssessments/scans",
      "properties": {
        "triggerType": "OnDemand",
        "state": "Passed",
        "server": "server1",
        "database": "master",
        "sqlVersion": "15.0.2000",
        "startTime": "2020-02-26T11:34:29.1399864Z",
        "endTime": "2020-02-26T11:38:07.8606151Z",
        "highSeverityFailedRulesCount": 0,
        "mediumSeverityFailedRulesCount": 0,
        "lowSeverityFailedRulesCount": 0,
        "totalPassedRulesCount": 26,
        "totalFailedRulesCount": 0,
        "totalRulesCount": 26,
        "isBaselineApplied": true,
        "lastScanTime": "2020-06-23T06:49:00.6455136+00:00"
      }
    }
  ]
}

定義

名稱	Description
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
Scan	弱點評估掃描記錄。
ScanProperties	弱點評估掃描記錄屬性。
Scans	弱點評估掃描記錄的清單。
ScanState	掃描狀態。
ScanTriggerType	掃描觸發程序類型。

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

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

CloudErrorBody

錯誤詳細數據。

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

Scan

弱點評估掃描記錄。

名稱	類型	Description
id	string	資源標識碼
name	string	資源名稱
properties	ScanProperties	弱點評估掃描記錄屬性。
type	string	資源類型

ScanProperties

弱點評估掃描記錄屬性。

名稱	類型	Description
database	string	資料庫名稱。
endTime	string	掃描結果有效，直到結束時間（UTC）。
highSeverityFailedRulesCount	integer	嚴重性較高的失敗規則數目。
isBaselineApplied	boolean	為此資料庫建立的基準，並具有一或多個規則。
lastScanTime	string	上次掃描時間。
lowSeverityFailedRulesCount	integer	具有低嚴重性之失敗規則的數目。
mediumSeverityFailedRulesCount	integer	具有中等嚴重性之失敗規則的數目。
server	string	伺服器名稱。
sqlVersion	string	SQL 版本。
startTime	string	掃描開始時間（UTC）。
state	ScanState	掃描狀態。
totalFailedRulesCount	integer	失敗規則總數。
totalPassedRulesCount	integer	已傳遞規則總數。
totalRulesCount	integer	評估的規則總數。
triggerType	ScanTriggerType	掃描觸發程序類型。

Scans

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

名稱	類型	Description
value	Scan[]	弱點評估掃描記錄的清單。

ScanState

掃描狀態。

名稱	類型	Description
Failed	string	失敗
FailedToRun	string	FailedToRun
InProgress	string	InProgress
Passed	string	通過

ScanTriggerType

掃描觸發程序類型。

名稱	類型	Description
OnDemand	string	OnDemand
Recurring	string	經常性

共用方式為

Sql Vulnerability Assessment Scans - List

URI 參數

回應

安全性

azure_auth

範圍

範例

List scan details

範例要求

範例回覆

定義

CloudError

CloudErrorBody

ErrorAdditionalInfo

Scan

ScanProperties

Scans

ScanState

ScanTriggerType

其他資源