Database Sql Vulnerability Assessment Scan Result - Get

Referencia

Service:: SQL Database

API Version:: 2023-08-01-preview

Obtiene un registro de examen de evaluación de vulnerabilidades de una base de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	El nombre de la base de datos.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
scanId	path	True	string	Identificador de examen del examen de evaluación de vulnerabilidades de SQL del que se va a recuperar el resultado.
scanResultId	path	True	string	Identificador del resultado del examen del resultado específico que se va a recuperar.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
vulnerabilityAssessmentName	path	True	SqlVulnerabilityAssessmentName	Nombre de la evaluación de vulnerabilidades de SQL.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	SqlVulnerabilityAssessmentScanResults	Se recuperaron correctamente los resultados del examen de evaluación de vulnerabilidades de SQL para el identificador.
Other Status Codes	ErrorResponse	Respuestas de error: *** 400 SqlVulnerabilityAssessmentIsDisabled: la característica de evaluación de vulnerabilidades de SQL está deshabilitada. Habilite la característica antes de ejecutar otras operaciones de evaluación de vulnerabilidades de SQL. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter: el cliente proporcionó un valor de parámetro no válido. 400 InvalidSqlVulnerabilityAssessmentBaselineInput: la entrada de línea de base de evaluación de vulnerabilidades de SQL es nula o está vacía. 400 InvalidSqlVulnerabilityAssessmentSettingsInput: la entrada de la configuración de evaluación de vulnerabilidades de SQL es nula o está vacía. 400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet: los resultados de la evaluación de vulnerabilidades de SQL aún no están disponibles, inténtelo de nuevo más tarde. 400 SqlVulnerabilityAssessmentInvalidRuleId: el identificador de regla de evaluación de vulnerabilidades de SQL no es válido. 400 SqlVulnerabilityAssessmentScanDoesNotExist: el examen de evaluación de vulnerabilidades de SQL no existe. 400 SqlVulnerabilityAssessmentNoBaseline: no se encontró ninguna línea de base para el examen más reciente en el recurso. 400 SqlVulnerabilityAssessmentNoRuleBaseline: no se encontró ninguna línea base de evaluación de vulnerabilidades de SQL 400 SqlVulnerabilityAssessmentBaselineNoScanResults: no se han encontrado resultados de examen para el identificador de regla. Para establecer una línea base, debe haber resultados para esta regla en el examen más reciente disponible. 400 SqlVulnerabilityAssessmentBadBinaryRuleFormat: la entrada para la regla binaria no es una representación booleana 400 SqlVulnerabilityAssessmentBadRuleFormat: los resultados proporcionados no cumplen el diseño real de los resultados del examen. 400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat: los resultados proporcionados no cumplen el diseño real de los resultados del examen. 400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat: la entrada para la regla binaria no es una representación booleana 400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId: no se han encontrado resultados de examen para una de las reglas. Para establecer una línea base, debe haber resultados para esta regla en el examen más reciente disponible. 400 SqlVulnerabilityAssessmentEmptyBaseline: línea base no establecida porque los resultados son nulos o vacíos 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 SourceDatabaseNotFound: la base de datos de origen no existe. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress: el examen de evaluación de vulnerabilidades de SQL ya está en curso 409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled: la evaluación de vulnerabilidades está habilitada en este servidor o en una de sus bases de datos subyacentes con una versión incompatible. Puede encontrar https://aka.ms/SQLVAStoragelessDocumentationinformación adicional de solución de problemas. 500 DatabaseIsUnavailable: error al cargar. Vuelva a intentarlo más tarde.

Nombre

Tipo

Description

200 OK

SqlVulnerabilityAssessmentScanResults

Se recuperaron correctamente los resultados del examen de evaluación de vulnerabilidades de SQL para el identificador.

Other Status Codes

ErrorResponse

Respuestas de error: ***

400 SqlVulnerabilityAssessmentIsDisabled: la característica de evaluación de vulnerabilidades de SQL está deshabilitada. Habilite la característica antes de ejecutar otras operaciones de evaluación de vulnerabilidades de SQL.
400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter: el cliente proporcionó un valor de parámetro no válido.
400 InvalidSqlVulnerabilityAssessmentBaselineInput: la entrada de línea de base de evaluación de vulnerabilidades de SQL es nula o está vacía.
400 InvalidSqlVulnerabilityAssessmentSettingsInput: la entrada de la configuración de evaluación de vulnerabilidades de SQL es nula o está vacía.
400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet: los resultados de la evaluación de vulnerabilidades de SQL aún no están disponibles, inténtelo de nuevo más tarde.
400 SqlVulnerabilityAssessmentInvalidRuleId: el identificador de regla de evaluación de vulnerabilidades de SQL no es válido.
400 SqlVulnerabilityAssessmentScanDoesNotExist: el examen de evaluación de vulnerabilidades de SQL no existe.
400 SqlVulnerabilityAssessmentNoBaseline: no se encontró ninguna línea de base para el examen más reciente en el recurso.
400 SqlVulnerabilityAssessmentNoRuleBaseline: no se encontró ninguna línea base de evaluación de vulnerabilidades de SQL
400 SqlVulnerabilityAssessmentBaselineNoScanResults: no se han encontrado resultados de examen para el identificador de regla. Para establecer una línea base, debe haber resultados para esta regla en el examen más reciente disponible.
400 SqlVulnerabilityAssessmentBadBinaryRuleFormat: la entrada para la regla binaria no es una representación booleana
400 SqlVulnerabilityAssessmentBadRuleFormat: los resultados proporcionados no cumplen el diseño real de los resultados del examen.
400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat: los resultados proporcionados no cumplen el diseño real de los resultados del examen.
400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat: la entrada para la regla binaria no es una representación booleana
400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId: no se han encontrado resultados de examen para una de las reglas. Para establecer una línea base, debe haber resultados para esta regla en el examen más reciente disponible.
400 SqlVulnerabilityAssessmentEmptyBaseline: línea base no establecida porque los resultados son nulos o vacíos
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado.
404 SourceDatabaseNotFound: la base de datos de origen no existe.
404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor.
409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress: el examen de evaluación de vulnerabilidades de SQL ya está en curso
409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled: la evaluación de vulnerabilidades está habilitada en este servidor o en una de sus bases de datos subyacentes con una versión incompatible. Puede encontrar https://aka.ms/SQLVAStoragelessDocumentationinformación adicional de solución de problemas.
500 DatabaseIsUnavailable: error al cargar. Vuelva a intentarlo más tarde.

Ejemplos

Get a database SQL Vulnerability Assessment scan result for scan id and scan result id

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "properties": {
    "ruleId": "VA1234",
    "status": "NonFinding",
    "errorMessage": null,
    "isTrimmed": false,
    "queryResults": [
      [
        "a1",
        "a2",
        "a3"
      ],
      [
        "b1",
        "b2",
        "b3"
      ]
    ],
    "remediation": {
      "description": "Remove users",
      "scripts": [
        "drop user a",
        "drop user b"
      ],
      "automated": false,
      "portalLink": null
    },
    "baselineAdjustedResult": null,
    "ruleMetadata": {
      "ruleId": "VA1234",
      "severity": "Informational",
      "category": "information",
      "ruleType": "NegativeList",
      "title": "This is the title",
      "description": "This is an example check",
      "rationale": "This is important",
      "queryCheck": {
        "query": "Select a1,a2, a3",
        "expectedResult": [],
        "columnNames": [
          "col1",
          "col2",
          "col3"
        ]
      },
      "benchmarkReferences": [
        {
          "benchmark": "fedramp",
          "reference": "v1"
        }
      ]
    }
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityassessmenttest-4711/providers/Microsoft.Sql/servers/vulnerabilityassessmenttest-6411/sqlVulnerabilityAssessments/Default/scans/scanId1/scanResults/VA1234",
  "name": "VA1234",
  "type": "Microsoft.Sql/servers/sqlVulnerabilityAssessments/scans/scanResults"
}

Definiciones

Nombre	Description
Baseline	Detalles de línea de base de evaluación de vulnerabilidades de SQL
BaselineAdjustedResult	Resultados ajustados de línea base de evaluación de vulnerabilidades de SQL
BenchmarkReference	Referencia de pruebas comparativas de evaluación de vulnerabilidades de SQL
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
QueryCheck	Objeto de comprobación de consultas de evaluación de vulnerabilidades de SQL.
Remediation	Detalles de corrección de evaluación de vulnerabilidades de SQL.
RuleSeverity	Gravedad de la regla de evaluación de vulnerabilidades de SQL.
RuleStatus	Estado de línea de base de evaluación de vulnerabilidades de SQL
RuleType	Tipo de regla de evaluación de vulnerabilidades de SQL.
SqlVulnerabilityAssessmentName	Nombre de la evaluación de vulnerabilidades de SQL.
SqlVulnerabilityAssessmentScanResults
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
VaRule	Detalles de los metadatos de la regla de evaluación de vulnerabilidades de SQL.

Baseline

Detalles de línea de base de evaluación de vulnerabilidades de SQL

Nombre	Tipo	Description
expectedResults	string[]	Resultados esperados de la línea base de evaluación de vulnerabilidades de SQL
updatedTime	string	Hora de actualización de línea base de evaluación de vulnerabilidades de SQL (UTC)

BaselineAdjustedResult

Resultados ajustados de línea base de evaluación de vulnerabilidades de SQL

Nombre	Tipo	Description
baseline	Baseline	Detalles de línea de base de evaluación de vulnerabilidades de SQL
resultsNotInBaseline	string[]	Resultados de la evaluación de vulnerabilidades de SQL que no están en la línea base
resultsOnlyInBaseline	string[]	Resultados de la evaluación de vulnerabilidades de SQL que se encuentran en la línea base.
status	RuleStatus	Estado de línea de base de evaluación de vulnerabilidades de SQL

BenchmarkReference

Referencia de pruebas comparativas de evaluación de vulnerabilidades de SQL

Nombre	Tipo	Description
benchmark	string	Nombre del banco de pruebas de evaluación de vulnerabilidades de SQL
reference	string	Referencia del banco de pruebas de evaluación de vulnerabilidades de SQL.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

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.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

QueryCheck

Objeto de comprobación de consultas de evaluación de vulnerabilidades de SQL.

Nombre	Tipo	Description
columnNames	string[]	Nombres de columna de evaluación de vulnerabilidades de SQL del resultado esperado de la consulta.
expectedResult	string[]	Resultado esperado de la consulta de evaluación de vulnerabilidades de SQL.
query	string	Consulta de reglas de evaluación de vulnerabilidades de SQL.

Remediation

Detalles de corrección de evaluación de vulnerabilidades de SQL.

Nombre	Tipo	Description
automated	boolean	La evaluación de vulnerabilidades de SQL está automatizada.
description	string	Descripción de la corrección de evaluación de vulnerabilidades de SQL.
portalLink	string	Vínculo opcional evaluación de vulnerabilidades de SQL para corregirlo en Azure Portal.
scripts	string[]	Script de corrección de evaluación de vulnerabilidades de SQL.

RuleSeverity

Gravedad de la regla de evaluación de vulnerabilidades de SQL.

Nombre	Tipo	Description
High	string
Informational	string
Low	string
Medium	string
Obsolete	string

RuleStatus

Estado de línea de base de evaluación de vulnerabilidades de SQL

Nombre	Tipo	Description
Finding	string
InternalError	string
NonFinding	string

RuleType

Tipo de regla de evaluación de vulnerabilidades de SQL.

Nombre	Tipo	Description
BaselineExpected	string
Binary	string
NegativeList	string
PositiveList	string

SqlVulnerabilityAssessmentName

Nombre de la evaluación de vulnerabilidades de SQL.

Nombre	Tipo	Description
default	string

SqlVulnerabilityAssessmentScanResults

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.baselineAdjustedResult	BaselineAdjustedResult	Resultado de la regla de evaluación de vulnerabilidades de SQL ajustado con la línea base.
properties.errorMessage	string	Mensaje de error de evaluación de vulnerabilidades de SQL.
properties.isTrimmed	boolean	La evaluación de vulnerabilidades de SQL es el recorte de los resultados de la consulta.
properties.queryResults	string[]	Resultados de la consulta de evaluación de vulnerabilidades de SQL que se ejecutaron.
properties.remediation	Remediation	Evaluación de vulnerabilidades de SQL los detalles de corrección.
properties.ruleId	string	Identificador de regla de evaluación de vulnerabilidades de SQL.
properties.ruleMetadata	VaRule	Metadatos de la regla de evaluación de vulnerabilidades de SQL.
properties.status	RuleStatus	Estado del resultado de la regla de evaluación de vulnerabilidades de SQL.
systemData	systemData	SystemData de AdvancedThreatProtectionResource.
type	string	Tipo de recurso.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

VaRule

Detalles de los metadatos de la regla de evaluación de vulnerabilidades de SQL.

Nombre	Tipo	Description
benchmarkReferences	BenchmarkReference[]	Referencias de pruebas comparativas de evaluación de vulnerabilidades de SQL.
category	string	Categoría de regla de evaluación de vulnerabilidades de SQL.
description	string	Descripción de la regla de evaluación de vulnerabilidades de SQL.
queryCheck	QueryCheck	Detalles de la consulta de la regla de evaluación de vulnerabilidades de SQL.
rationale	string	Justificación de la regla de evaluación de vulnerabilidades de SQL.
ruleId	string	Identificador de regla de evaluación de vulnerabilidades de SQL.
ruleType	RuleType	Tipo de regla de evaluación de vulnerabilidades de SQL.
severity	RuleSeverity	Gravedad de la regla de evaluación de vulnerabilidades de SQL.
title	string	Título de la regla de evaluación de vulnerabilidades de SQL.

Compartir a través de

Database Sql Vulnerability Assessment Scan Result - Get

Parámetros de identificador URI

Respuestas

Ejemplos

Get a database SQL Vulnerability Assessment scan result for scan id and scan result id

Sample Request

Sample Response

Definiciones

Baseline

BaselineAdjustedResult

BenchmarkReference

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryCheck

Remediation

RuleSeverity

RuleStatus

RuleType

SqlVulnerabilityAssessmentName

SqlVulnerabilityAssessmentScanResults

systemData

VaRule

Recursos adicionales