Database Sql Vulnerability Assessment Scan Result - Get

서비스:

SQL Database

API 버전:

2024-05-01-preview

데이터베이스의 취약성 평가 검사 레코드를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
databaseName	path	True	string	데이터베이스의 이름입니다.
resourceGroupName	path	True	string	리소스를 포함하는 리소스 그룹의 이름입니다. Azure Resource Manager API 또는 포털에서 이 값을 가져올 수 있습니다.
scanId	path	True	string	결과를 검색할 SQL 취약성 평가 검사의 검사 ID입니다.
scanResultId	path	True	string	검색할 특정 결과의 검사 결과 ID입니다.
serverName	path	True	string	서버의 이름입니다.
subscriptionId	path	True	string	Azure 구독을 식별하는 구독 ID입니다.
vulnerabilityAssessmentName	path	True	SqlVulnerabilityAssessmentName	SQL 취약성 평가의 이름입니다.
api-version	query	True	string	요청에 사용할 API 버전입니다.

응답

Name	형식	Description
200 OK	SqlVulnerabilityAssessmentScanResults	ID에 대한 SQL 취약성 평가 검사 결과를 검색했습니다.
Other Status Codes	ErrorResponse	오류 응답: *** 400 SqlVulnerabilityAssessmentIsDisabled - SQL 취약성 평가 기능을 사용할 수 없습니다. 다른 SQL 취약성 평가 작업을 실행하기 전에 기능을 사용하도록 설정하세요. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - 클라이언트에서 잘못된 매개 변수 값을 제공했습니다. 400 InvalidSqlVulnerabilityAssessmentBaselineInput - SQL 취약성 평가 기준 입력이 null이거나 비어 있습니다. 400 InvalidSqlVulnerabilityAssessmentSettingsInput - SQL 취약성 평가 설정 입력이 null이거나 비어 있음 400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet - SQL 취약성 평가 결과를 아직 사용할 수 없습니다. 나중에 다시 시도하세요. 400 SqlVulnerabilityAssessmentInvalidRuleId - SQL 취약성 평가 규칙 ID가 잘못되었습니다. 400 SqlVulnerabilityAssessmentScanDoesNotExist - SQL 취약성 평가 검사가 없습니다. 400 SqlVulnerabilityAssessmentNoBaseline - 리소스의 최신 검사에 대한 기준이 없습니다. 400 SqlVulnerabilityAssessmentNoRuleBaseline - SQL 취약성 평가 기준이 없습니다. 400 SqlVulnerabilityAssessmentBaselineNoScanResults - 규칙 ID에 대한 검색 결과가 없습니다. 기준을 설정하려면 사용 가능한 최신 검사에서 이 규칙에 대한 결과가 있어야 합니다. 400 SqlVulnerabilityAssessmentBadBinaryRuleFormat - 이진 규칙에 대한 입력은 부울 표현이 아닙니다. 400 SqlVulnerabilityAssessmentBadRuleFormat - 제공된 결과가 검사 결과의 실제 레이아웃을 준수하지 않음 400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat - 제공된 결과가 검사 결과의 실제 레이아웃을 준수하지 않습니다. 400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat - 이진 규칙에 대한 입력은 부울 표현이 아닙니다. 400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId - 규칙 중 하나에 대한 검사 결과가 없습니다. 기준을 설정하려면 사용 가능한 최신 검사에서 이 규칙에 대한 결과가 있어야 합니다. 400 SqlVulnerabilityAssessmentEmptyBaseline - 결과가 null이거나 비어 있으므로 기준이 설정되지 않음 404 SubscriptionDoesNotHaveServer - 요청된 서버를 찾을 수 없습니다. 404 SourceDatabaseNotFound - 원본 데이터베이스가 없습니다. 404 DatabaseDoesNotExist - 사용자가 이 서버 인스턴스에 없는 데이터베이스 이름을 지정했습니다. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - SQL 취약성 평가 검사가 이미 진행 중입니다. 409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled - 취약성 평가는 이 서버 또는 호환되지 않는 버전이 있는 기본 데이터베이스 중 하나에서 사용하도록 설정됩니다. 추가 문제 해결 정보는 https://aka.ms/SQLVAStoragelessDocumentation찾을 수 있습니다. 500 DatabaseIsUnavailable - 로드하지 못했습니다. 나중에 다시 시도하세요.

예제

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

샘플 요청

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=2024-05-01-preview

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python database_sql_vulnerability_assessment_scans_results.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.database_sql_vulnerability_assessment_scan_result.get(
        resource_group_name="vulnerabilityassessmenttest-4711",
        server_name="vulnerabilityassessmenttest-6411",
        database_name="master",
        vulnerability_assessment_name="default",
        scan_id="scanId1",
        scan_result_id="VA1234",
    )
    print(response)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScansResults.json
if __name__ == "__main__":
    main()

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/examples/DatabaseSqlVulnerabilityAssessmentScansResults.json
// this example is just showing the usage of "DatabaseSqlVulnerabilityAssessmentScanResult_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 SqlDatabaseSqlVulnerabilityAssessmentScanResource created on azure
// for more information of creating SqlDatabaseSqlVulnerabilityAssessmentScanResource, please refer to the document of SqlDatabaseSqlVulnerabilityAssessmentScanResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "vulnerabilityassessmenttest-4711";
string serverName = "vulnerabilityassessmenttest-6411";
string databaseName = "master";
VulnerabilityAssessmentName vulnerabilityAssessmentName = VulnerabilityAssessmentName.Default;
string scanId = "scanId1";
ResourceIdentifier sqlDatabaseSqlVulnerabilityAssessmentScanResourceId = SqlDatabaseSqlVulnerabilityAssessmentScanResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, scanId);
SqlDatabaseSqlVulnerabilityAssessmentScanResource sqlDatabaseSqlVulnerabilityAssessmentScan = client.GetSqlDatabaseSqlVulnerabilityAssessmentScanResource(sqlDatabaseSqlVulnerabilityAssessmentScanResourceId);

// get the collection of this SqlDatabaseSqlVulnerabilityAssessmentScanResultResource
SqlDatabaseSqlVulnerabilityAssessmentScanResultCollection collection = sqlDatabaseSqlVulnerabilityAssessmentScan.GetSqlDatabaseSqlVulnerabilityAssessmentScanResults();

// invoke the operation
string scanResultId = "VA1234";
NullableResponse<SqlDatabaseSqlVulnerabilityAssessmentScanResultResource> response = await collection.GetIfExistsAsync(scanResultId);
SqlDatabaseSqlVulnerabilityAssessmentScanResultResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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
    SqlVulnerabilityAssessmentScanResultData 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

샘플 응답

상태 코드:

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

정의

Name	Description
Baseline	SQL 취약성 평가 기준 세부 정보
BaselineAdjustedResult	SQL 취약성 평가 기준 조정 결과
BenchmarkReference	SQL 취약성 평가 벤치마크 참조
createdByType	리소스를 만든 ID의 형식입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
QueryCheck	SQL 취약성 평가 쿼리 검사 개체입니다.
Remediation	SQL 취약성 평가 수정 세부 정보입니다.
RuleSeverity	SQL 취약성 평가 규칙 심각도입니다.
RuleStatus	SQL 취약성 평가 기준 상태
RuleType	SQL 취약성 평가 규칙 유형입니다.
SqlVulnerabilityAssessmentName	SQL 취약성 평가의 이름입니다.
SqlVulnerabilityAssessmentScanResults
systemData	리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
VaRule	SQL 취약성 평가 규칙 메타데이터 세부 정보입니다.

Baseline

Object

SQL 취약성 평가 기준 세부 정보

Name	형식	Description
expectedResults	string[]	SQL 취약성 평가 기준 예상 결과
updatedTime	string (date-time)	SQL 취약성 평가 기준 업데이트 시간(UTC)

BaselineAdjustedResult

Object

SQL 취약성 평가 기준 조정 결과

Name	형식	Description
baseline	Baseline	SQL 취약성 평가 기준 세부 정보
resultsNotInBaseline	string[]	기준에 없는 SQL 취약성 평가 결과
resultsOnlyInBaseline	string[]	기준선에 있는 SQL 취약성 평가 결과입니다.
status	RuleStatus	SQL 취약성 평가 기준 상태

BenchmarkReference

Object

SQL 취약성 평가 벤치마크 참조

Name	형식	Description
benchmark	string	SQL 취약성 평가 벤치마크 이름
reference	string	SQL 취약성 평가 벤치마크 참조입니다.

createdByType

열거형

리소스를 만든 ID의 형식입니다.

값	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

QueryCheck

Object

SQL 취약성 평가 쿼리 검사 개체입니다.

Name	형식	Description
columnNames	string[]	쿼리 예상 결과의 SQL 취약성 평가 열 이름입니다.
expectedResult	string[]	SQL 취약성 평가 쿼리 예상 결과입니다.
query	string	SQL 취약성 평가 규칙 쿼리.

Remediation

Object

SQL 취약성 평가 수정 세부 정보입니다.

Name	형식	Description
automated	boolean	SQL 취약성 평가는 자동으로 수정됩니다.
description	string	SQL 취약성 평가 수정 설명입니다.
portalLink	string	Azure Portal에서 수정할 SQL 취약성 평가 선택적 링크입니다.
scripts	string[]	SQL 취약성 평가 수정 스크립트.

RuleSeverity

열거형

SQL 취약성 평가 규칙 심각도입니다.

값	Description
High
Medium
Low
Informational
Obsolete

RuleStatus

열거형

SQL 취약성 평가 기준 상태

값	Description
NonFinding
Finding
InternalError

RuleType

열거형

SQL 취약성 평가 규칙 유형입니다.

값	Description
Binary
BaselineExpected
PositiveList
NegativeList

SqlVulnerabilityAssessmentName

열거형

SQL 취약성 평가의 이름입니다.

값	Description
default

SqlVulnerabilityAssessmentScanResults

Object

Name	형식	Description
id	string	리소스 ID입니다.
name	string	리소스 이름입니다.
properties.baselineAdjustedResult	BaselineAdjustedResult	기준선에 따라 조정된 SQL 취약성 평가 규칙 결과입니다.
properties.errorMessage	string	SQL 취약성 평가 오류 메시지입니다.
properties.isTrimmed	boolean	SQL 취약성 평가는 잘려진 쿼리 결과입니다.
properties.queryResults	string[]	실행된 SQL 취약성 평가 쿼리 결과입니다.
properties.remediation	Remediation	SQL 취약성 평가 수정 세부 정보입니다.
properties.ruleId	string	SQL 취약성 평가 규칙 ID입니다.
properties.ruleMetadata	VaRule	SQL 취약성 평가 규칙 메타데이터.
properties.status	RuleStatus	SQL 취약성 평가 규칙 결과 상태입니다.
systemData	systemData	AdvancedThreatProtectionResource의 SystemData입니다.
type	string	리소스 종류입니다.

systemData

Object

리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string (date-time)	리소스 만들기의 타임스탬프(UTC)입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID의 형식입니다.
lastModifiedAt	string (date-time)	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID의 형식입니다.

VaRule

Object

SQL 취약성 평가 규칙 메타데이터 세부 정보입니다.

Name	형식	Description
benchmarkReferences	BenchmarkReference[]	SQL 취약성 평가 벤치마크 참조.
category	string	SQL 취약성 평가 규칙 범주입니다.
description	string	SQL 취약성 평가 규칙 설명입니다.
queryCheck	QueryCheck	SQL 취약성 평가 규칙 쿼리 세부 정보입니다.
rationale	string	SQL 취약성 평가 규칙 근거입니다.
ruleId	string	SQL 취약성 평가 규칙 ID입니다.
ruleType	RuleType	SQL 취약성 평가 규칙 유형입니다.
severity	RuleSeverity	SQL 취약성 평가 규칙 심각도입니다.
title	string	SQL 취약성 평가 규칙 제목입니다.