Sql Vulnerability Assessment Scans - Get

Referencia

Servicio:: Defender for Cloud

Versión de la API:: 2023-02-01-preview

Obtiene los detalles del examen de un único registro de examen.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceId	path	True	string	Identificador del recurso.
scanId	path	True	string	Identificador de examen. Escriba "latest" para obtener el registro de examen para el examen más reciente.
api-version	query	True	string	La versión de api.
workspaceId	query	True	string	Identificador del área de trabajo.

Respuestas

Nombre	Tipo	Description
200 OK	Scan	Devuelve los detalles del registro de examen.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get scan details of a scan record

Get scan details of the latest scan record

Get scan details of a scan record

Solicitud de ejemplo

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/Scheduled-20200623?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview


/**
 * Samples for SqlVulnerabilityAssessmentScans Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
     * sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
     */
    /**
     * Sample code: Get scan details of a scan record.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getScanDetailsOfAScanRecord(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sqlVulnerabilityAssessmentScans().getWithResponse("Scheduled-20200623",
            "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_Get.json
func ExampleSQLVulnerabilityAssessmentScansClient_Get_getScanDetailsOfAScanRecord() {
	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().Get(ctx, "Scheduled-20200623", "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.Scan = armsecurity.Scan{
	// 	Name: to.Ptr("Scheduled-20200623"),
	// 	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-20200623"),
	// 	Properties: &armsecurity.ScanProperties{
	// 		Database: to.Ptr("master"),
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.723Z"); 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-06-23T06:49:00.645Z"); 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),
	// 	},
	// }
}

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 the scan details of a single scan record.
 *
 * @summary Gets the scan details of a single scan record.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
 */
async function getScanDetailsOfAScanRecord() {
  const scanId = "Scheduled-20200623";
  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.get(scanId, 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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityCenter.Models;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentScans_Get" 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 SqlVulnerabilityAssessmentScanResource created on azure
// for more information of creating SqlVulnerabilityAssessmentScanResource, please refer to the document of SqlVulnerabilityAssessmentScanResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
string scanId = "Scheduled-20200623";
ResourceIdentifier sqlVulnerabilityAssessmentScanResourceId = SqlVulnerabilityAssessmentScanResource.CreateResourceIdentifier(resourceId, scanId);
SqlVulnerabilityAssessmentScanResource sqlVulnerabilityAssessmentScan = client.GetSqlVulnerabilityAssessmentScanResource(sqlVulnerabilityAssessmentScanResourceId);

// invoke the operation
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
SqlVulnerabilityAssessmentScanResource result = await sqlVulnerabilityAssessmentScan.GetAsync(workspaceId);

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Respuesta de muestra

status code:: 200

{
  "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-20200623",
  "name": "Scheduled-20200623",
  "type": "Microsoft.Security/sqlVulnerabilityAssessments/scans",
  "properties": {
    "triggerType": "Recurring",
    "state": "Failed",
    "server": "server1",
    "database": "master",
    "sqlVersion": "15.0.2000",
    "startTime": "2020-06-23T06:49:00.6455136+00:00",
    "endTime": "2020-06-23T06:49:00.7236217Z",
    "highSeverityFailedRulesCount": 3,
    "mediumSeverityFailedRulesCount": 2,
    "lowSeverityFailedRulesCount": 1,
    "totalPassedRulesCount": 20,
    "totalFailedRulesCount": 6,
    "totalRulesCount": 26,
    "isBaselineApplied": false,
    "lastScanTime": "2020-06-23T06:49:00.6455136+00:00"
  }
}

Get scan details of the latest scan record

Solicitud de ejemplo

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/latest?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview


/**
 * Samples for SqlVulnerabilityAssessmentScans Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
     * sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
     */
    /**
     * Sample code: Get scan details of the latest scan record.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getScanDetailsOfTheLatestScanRecord(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sqlVulnerabilityAssessmentScans().getWithResponse("latest", "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_GetLatest.json
func ExampleSQLVulnerabilityAssessmentScansClient_Get_getScanDetailsOfTheLatestScanRecord() {
	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().Get(ctx, "latest", "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.Scan = armsecurity.Scan{
	// 	Name: to.Ptr("Scheduled-20200623"),
	// 	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-20200623"),
	// 	Properties: &armsecurity.ScanProperties{
	// 		Database: to.Ptr("master"),
	// 		EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.723Z"); 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-06-23T06:49:00.645Z"); 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),
	// 	},
	// }
}

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 the scan details of a single scan record.
 *
 * @summary Gets the scan details of a single scan record.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
 */
async function getScanDetailsOfTheLatestScanRecord() {
  const scanId = "latest";
  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.get(scanId, 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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.SecurityCenter.Models;
using Azure.ResourceManager.SecurityCenter;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentScans_Get" 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 SqlVulnerabilityAssessmentScanResource created on azure
// for more information of creating SqlVulnerabilityAssessmentScanResource, please refer to the document of SqlVulnerabilityAssessmentScanResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
string scanId = "latest";
ResourceIdentifier sqlVulnerabilityAssessmentScanResourceId = SqlVulnerabilityAssessmentScanResource.CreateResourceIdentifier(resourceId, scanId);
SqlVulnerabilityAssessmentScanResource sqlVulnerabilityAssessmentScan = client.GetSqlVulnerabilityAssessmentScanResource(sqlVulnerabilityAssessmentScanResourceId);

// invoke the operation
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
SqlVulnerabilityAssessmentScanResource result = await sqlVulnerabilityAssessmentScan.GetAsync(workspaceId);

// the variable result 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 = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Respuesta de muestra

status code:: 200

{
  "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-20200623",
  "name": "Scheduled-20200623",
  "type": "Microsoft.Security/sqlVulnerabilityAssessments/scans",
  "properties": {
    "triggerType": "Recurring",
    "state": "Failed",
    "server": "server1",
    "database": "master",
    "sqlVersion": "15.0.2000",
    "startTime": "2020-06-23T06:49:00.6455136+00:00",
    "endTime": "2020-06-23T06:49:00.7236217Z",
    "highSeverityFailedRulesCount": 3,
    "mediumSeverityFailedRulesCount": 2,
    "lowSeverityFailedRulesCount": 1,
    "totalPassedRulesCount": 20,
    "totalFailedRulesCount": 6,
    "totalRulesCount": 26,
    "isBaselineApplied": false,
    "lastScanTime": "2020-06-23T06:49:00.6455136+00:00"
  }
}

Definiciones

Nombre	Description
CloudError	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
CloudErrorBody	Detalle del error.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
Scan	Un registro de examen de evaluación de vulnerabilidades.
ScanProperties	Propiedades del registro de examen de evaluación de vulnerabilidades.
ScanState	Estado del examen.
ScanTriggerType	Tipo de desencadenador de examen.

CloudError

Object

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
error.code	string	Código de error.
error.details	CloudErrorBody[]	Detalles del error.
error.message	string	Mensaje de error.
error.target	string	Destino del error.

CloudErrorBody

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	CloudErrorBody[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

Scan

Object

Un registro de examen de evaluación de vulnerabilidades.

Nombre	Tipo	Description
id	string	Identificador de recurso
name	string	Nombre del recurso
properties	ScanProperties	Propiedades del registro de examen de evaluación de vulnerabilidades.
type	string	Tipo de recurso

ScanProperties

Object

Propiedades del registro de examen de evaluación de vulnerabilidades.

Nombre	Tipo	Description
database	string	Nombre de la base de datos.
endTime	string (date-time)	Los resultados del examen son válidos hasta la hora de finalización (UTC).
highSeverityFailedRulesCount	integer (int32)	Número de reglas con errores con gravedad alta.
isBaselineApplied	boolean	Línea base creada para esta base de datos y tiene una o varias reglas.
lastScanTime	string (date-time)	Hora del último examen.
lowSeverityFailedRulesCount	integer (int32)	Número de reglas con errores con gravedad baja.
mediumSeverityFailedRulesCount	integer (int32)	Número de reglas con error con gravedad media.
server	string	Nombre del servidor.
sqlVersion	string	Versión de SQL.
startTime	string (date-time)	Hora de inicio del examen (UTC).
state	ScanState	Estado del examen.
totalFailedRulesCount	integer (int32)	Número de reglas con error totales.
totalPassedRulesCount	integer (int32)	Número de reglas superada totales.
totalRulesCount	integer (int32)	Número de reglas totales evaluadas.
triggerType	ScanTriggerType	Tipo de desencadenador de examen.

ScanState

Enumeración

Estado del examen.

Valor	Description
Failed	Fracasado
FailedToRun	FailedToRun
InProgress	InProgress
Passed	Pasado

ScanTriggerType

Enumeración

Tipo de desencadenador de examen.

Valor	Description
OnDemand	OnDemand
Recurring	Recurrente

Compartir a través de

Sql Vulnerability Assessment Scans - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Get scan details of a scan record

Solicitud de ejemplo

Respuesta de muestra

Get scan details of the latest scan record

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

ErrorAdditionalInfo

Scan

ScanProperties

ScanState

ScanTriggerType