Sql Vulnerability Assessment Scans - List

Referens

Tjänst:: Defender for Cloud

API-version:: 2023-02-01-preview

Hämtar en lista över genomsökningsposter.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceId	path	True	string	Resursens identifierare.
api-version	query	True	string	API-versionen.
workspaceId	query	True	string	Arbetsytans ID.

Svar

Name	Typ	Description
200 OK	Scans	Returnerar listan över genomsökningsposter.
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

List scan details

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
      }
    }
  ]
}

Definitioner

Name	Description
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
Scan	En genomsökningspost för sårbarhetsbedömning.
ScanProperties	En sårbarhetsbedömning genomsöker postegenskaper.
Scans	En lista över poster för sårbarhetsbedömningsgenomsökning.
ScanState	Genomsökningsstatus.
ScanTriggerType	Typ av genomsökningsutlösare.

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

Scan

En genomsökningspost för sårbarhetsbedömning.

Name	Typ	Description
id	string	Resurs-ID
name	string	Resursnamn
properties	ScanProperties	En sårbarhetsbedömning genomsöker postegenskaper.
type	string	Resurstyp

ScanProperties

En sårbarhetsbedömning genomsöker postegenskaper.

Name	Typ	Description
database	string	Databasnamnet.
endTime	string	Genomsökningsresultatet är giltigt fram till sluttiden (UTC).
highSeverityFailedRulesCount	integer	Antalet misslyckade regler med hög allvarlighetsgrad.
isBaselineApplied	boolean	Baslinje som skapats för den här databasen och har en eller flera regler.
lastScanTime	string	Senaste genomsökningstid.
lowSeverityFailedRulesCount	integer	Antalet misslyckade regler med låg allvarlighetsgrad.
mediumSeverityFailedRulesCount	integer	Antalet misslyckade regler med medelhög allvarlighetsgrad.
server	string	Servernamnet.
sqlVersion	string	SQL-versionen.
startTime	string	Genomsökningens starttid (UTC).
state	ScanState	Genomsökningsstatus.
totalFailedRulesCount	integer	Antalet totalt misslyckade regler.
totalPassedRulesCount	integer	Antalet regler som har godkänts totalt.
totalRulesCount	integer	Antalet bedömda totala regler.
triggerType	ScanTriggerType	Typ av genomsökningsutlösare.

Scans

En lista över poster för sårbarhetsbedömningsgenomsökning.

Name	Typ	Description
value	Scan[]	Lista över poster för sårbarhetsbedömningsgenomsökning.

ScanState

Genomsökningsstatus.

Name	Typ	Description
Failed	string	Misslyckades
FailedToRun	string	FailedToRun
InProgress	string	InProgress
Passed	string	Passerade

ScanTriggerType

Typ av genomsökningsutlösare.

Name	Typ	Description
OnDemand	string	OnDemand
Recurring	string	Återkommande

Dela via

Sql Vulnerability Assessment Scans - List

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

List scan details

Exempelbegäran

Exempelsvar

Definitioner

CloudError

CloudErrorBody

ErrorAdditionalInfo

Scan

ScanProperties

Scans

ScanState

ScanTriggerType

Ytterligare resurser