Sql Vulnerability Assessment Scan Result - Get

Serviço:

SQL Database

Versão da API:

2024-05-01-preview

Obtém um registro de verificação de avaliação de vulnerabilidade de um banco de dados.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/default/scans/{scanId}/scanResults/{scanResultId}?systemDatabaseName=master&api-version=2024-05-01-preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos que contém o recurso. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
scanId	path	True	string	A id de verificação da verificação de Avaliação de Vulnerabilidade do SQL para recuperar o resultado.
scanResultId	path	True	string	O id do resultado da verificação do resultado específico a ser recuperado.
serverName	path	True	string	O nome do servidor.
subscriptionId	path	True	string	A ID de assinatura que identifica uma assinatura do Azure.
vulnerabilityAssessmentName	path	True	SqlVulnerabilityAssessmentName	O nome da Avaliação de Vulnerabilidade do SQL.
api-version	query	True	string	A versão da API a ser usada para a solicitação.
systemDatabaseName	query	True	VulnerabilityAssessmentSystemDatabaseName	O nome do banco de dados do sistema de avaliação de vulnerabilidades SQL.

Respostas

Name	Tipo	Description
200 OK	SqlVulnerabilityAssessmentScanResults	Resultados da verificação da Avaliação de Vulnerabilidade do SQL recuperados com êxito para id.
Other Status Codes	ErrorResponse	Respostas de erro: *** 400 SqlVulnerabilityAssessmentIsDisabled - O recurso de avaliação de vulnerabilidade do SQL está desabilitado. habilite o recurso antes de executar outras operações de avaliação de vulnerabilidade SQL. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - Um valor de parâmetro inválido foi fornecido pelo cliente. 400 InvalidSqlVulnerabilityAssessmentBaselineInput - A entrada da linha de base da avaliação de vulnerabilidade do SQL é nula ou vazia. 400 InvalidSqlVulnerabilityAssessmentSettingsInput - A entrada da configuração de avaliação de vulnerabilidade do SQL é nula ou vazia 400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet - Os resultados da avaliação de vulnerabilidade do SQL ainda não estão disponíveis, tente novamente mais tarde. 400 SqlVulnerabilityAssessmentInvalidRuleId - A id da regra de avaliação de vulnerabilidade do SQL é inválida. 400 SqlVulnerabilityAssessmentScanDoesNotExist - A verificação de avaliação de vulnerabilidade do SQL não existe. 400 SqlVulnerabilityAssessmentNoBaseline - Nenhuma linha de base foi encontrada para a verificação mais recente no recurso 400 SqlVulnerabilityAssessmentNoRuleBaseline - Nenhuma linha de base de avaliação de vulnerabilidade SQL foi encontrada 400 SqlVulnerabilityAssessmentBaselineNoScanResults - Não foram encontrados resultados de verificação para a ID da regra. Para definir uma linha de base, deve haver resultados para essa regra na última verificação disponível 400 SqlVulnerabilityAssessmentBadBinaryRuleFormat - A entrada para regra binária não é uma representação booleana 400 SqlVulnerabilityAssessmentBadRuleFormat - Os resultados fornecidos não estão em conformidade com o layout real dos resultados da verificação 400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat - Os resultados fornecidos não estão em conformidade com o layout real dos resultados da verificação 400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat - A entrada para regra binária não é uma representação booleana 400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId - Não foram encontrados resultados de verificação para uma das regras. Para definir uma linha de base, deve haver resultados para essa regra na última verificação disponível 400 SqlVulnerabilityAssessmentEmptyBaseline - Linha de base não definida porque os resultados são nulos ou vazios 404 SubscriptionDoesNotHaveServer - O servidor solicitado não foi encontrado 404 SourceDatabaseNotFound - O banco de dados de origem não existe. 404 DatabaseDoesNotExist - O usuário especificou um nome de banco de dados que não existe nesta instância do servidor. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - A verificação de avaliação de vulnerabilidade do SQL já está em andamento 409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled - A Avaliação de Vulnerabilidades está habilitada neste servidor ou em um de seus bancos de dados subjacentes com uma versão incompatível. Informações adicionais de solução de problemas podem ser encontradas https://aka.ms/SQLVAStoragelessDocumentation. 500 DatabaseIsUnavailable - Falha ao carregar. Tente novamente mais tarde.

Exemplos

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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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"
}

Definições

Name	Description
Baseline	Detalhes da linha de base da Avaliação de Vulnerabilidade do SQL
BaselineAdjustedResult	Resultados ajustados da linha de base da Avaliação de Vulnerabilidades SQL
BenchmarkReference	Referência de benchmark de Avaliação de Vulnerabilidade do SQL
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
QueryCheck	Objeto de verificação de consulta de Avaliação de Vulnerabilidade do SQL.
Remediation	Detalhes de correção da Avaliação de Vulnerabilidade do SQL.
RuleSeverity	Gravidade da regra de Avaliação de Vulnerabilidade do SQL.
RuleStatus	Status da linha de base da Avaliação de Vulnerabilidade do SQL
RuleType	Tipo de regra de Avaliação de Vulnerabilidade SQL.
SqlVulnerabilityAssessmentName	O nome da Avaliação de Vulnerabilidade do SQL.
SqlVulnerabilityAssessmentScanResults
systemData	Metadados referentes à criação e última modificação do recurso.
VaRule	Detalhes dos metadados da regra de Avaliação de Vulnerabilidade do SQL.
VulnerabilityAssessmentSystemDatabaseName	O nome do banco de dados do sistema de avaliação de vulnerabilidades SQL.

Baseline

Object

Detalhes da linha de base da Avaliação de Vulnerabilidade do SQL

Name	Tipo	Description
expectedResults	string[]	Resultados esperados da linha de base da Avaliação de Vulnerabilidades do SQL
updatedTime	string (date-time)	Tempo de atualização da linha de base da Avaliação de Vulnerabilidades do SQL (UTC)

BaselineAdjustedResult

Object

Resultados ajustados da linha de base da Avaliação de Vulnerabilidades SQL

Name	Tipo	Description
baseline	Baseline	Detalhes da linha de base da Avaliação de Vulnerabilidades do SQL
resultsNotInBaseline	string[]	Resultados da Avaliação de Vulnerabilidade do SQL que não estão na linha de base
resultsOnlyInBaseline	string[]	Resultados da Avaliação de Vulnerabilidade do SQL que estão na linha de base.
status	RuleStatus	Status da linha de base da Avaliação de Vulnerabilidade do SQL

BenchmarkReference

Object

Referência de benchmark de Avaliação de Vulnerabilidade do SQL

Name	Tipo	Description
benchmark	string	Nome do benchmark da Avaliação de Vulnerabilidade do SQL
reference	string	Referência de benchmark de Avaliação de Vulnerabilidade SQL.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

QueryCheck

Object

Objeto de verificação de consulta de Avaliação de Vulnerabilidade do SQL.

Name	Tipo	Description
columnNames	string[]	Nomes de coluna de Avaliação de Vulnerabilidade SQL do resultado esperado da consulta.
expectedResult	string[]	Resultado esperado da consulta Avaliação de Vulnerabilidade SQL.
query	string	Consulta de regra de Avaliação de Vulnerabilidade SQL.

Remediation

Object

Detalhes de correção da Avaliação de Vulnerabilidade do SQL.

Name	Tipo	Description
automated	boolean	A Avaliação de Vulnerabilidade do SQL é automatizada pela correção.
description	string	Descrição da correção da Avaliação de Vulnerabilidade do SQL.
portalLink	string	Link opcional da Avaliação de Vulnerabilidade do SQL para correção no Portal do Azure.
scripts	string[]	Script de correção da Avaliação de Vulnerabilidades do SQL.

RuleSeverity

Enumeração

Gravidade da regra de Avaliação de Vulnerabilidade do SQL.

Valor	Description
High
Informational
Low
Medium
Obsolete

RuleStatus

Enumeração

Status da linha de base da Avaliação de Vulnerabilidade do SQL

Valor	Description
Finding
InternalError
NonFinding

RuleType

Enumeração

Tipo de regra de Avaliação de Vulnerabilidade SQL.

Valor	Description
BaselineExpected
Binary
NegativeList
PositiveList

SqlVulnerabilityAssessmentName

Enumeração

O nome da Avaliação de Vulnerabilidade do SQL.

Valor	Description
default

SqlVulnerabilityAssessmentScanResults

Object

Name	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
properties.baselineAdjustedResult	BaselineAdjustedResult	Resultado da regra de Avaliação de Vulnerabilidade do SQL ajustado com a linha de base.
properties.errorMessage	string	Mensagem de erro SQL Vulnerability Assessment.
properties.isTrimmed	boolean	A Avaliação de Vulnerabilidade do SQL é o resultado da consulta cortado.
properties.queryResults	string[]	Resultados da consulta Avaliação de Vulnerabilidade do SQL que foi executada.
properties.remediation	Remediation	Avaliação de vulnerabilidade do SQL os detalhes da correção.
properties.ruleId	string	ID da regra de Avaliação de Vulnerabilidade do SQL.
properties.ruleMetadata	VaRule	Metadados da regra de Avaliação de Vulnerabilidade do SQL.
properties.status	RuleStatus	Status do resultado da regra de Avaliação de Vulnerabilidade do SQL.
systemData	systemData	SystemData de AdvancedThreatProtectionResource.
type	string	Tipo de recurso.

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

VaRule

Object

Detalhes dos metadados da regra de Avaliação de Vulnerabilidade do SQL.

Name	Tipo	Description
benchmarkReferences	BenchmarkReference[]	Referências de benchmark do SQL Vulnerability Assessment.
category	string	Categoria da regra de Avaliação de Vulnerabilidade do SQL.
description	string	Descrição da regra de Avaliação de Vulnerabilidade do SQL.
queryCheck	QueryCheck	Detalhes da consulta da regra de Avaliação de Vulnerabilidade do SQL.
rationale	string	Lógica da regra de Avaliação de Vulnerabilidade do SQL.
ruleId	string	ID da regra de Avaliação de Vulnerabilidade do SQL.
ruleType	RuleType	Tipo de regra de Avaliação de Vulnerabilidade SQL.
severity	RuleSeverity	Gravidade da regra de Avaliação de Vulnerabilidade do SQL.
title	string	Título da regra de Avaliação de Vulnerabilidade do SQL.

VulnerabilityAssessmentSystemDatabaseName

Enumeração

O nome do banco de dados do sistema de avaliação de vulnerabilidades SQL.

Valor	Description
master