Sql Vulnerability Assessment Scan Result - Get

リファレンス

Service:: SQL Database

API Version:: 2023-08-01-preview

データベースの脆弱性評価スキャンレコードを取得します。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースが含まれているリソースグループの名前。この値は、Azure リソースマネージャー 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 のバージョン。
systemDatabaseName	query	True	VulnerabilityAssessmentSystemDatabaseName	SQL 脆弱性評価システムデータベース名。

応答

名前	型	説明
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 - 読み込みに失敗しました。後で再度お試しください。

名前

型

説明

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 system 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/sqlVulnerabilityAssessments/default/scans/scanId1/scanResults/VA1234?systemDatabaseName=master&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"
}

定義

名前	説明
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 脆弱性評価ルールのメタデータの詳細。
VulnerabilityAssessmentSystemDatabaseName	SQL 脆弱性評価システムデータベース名。

Baseline

SQL 脆弱性評価のベースラインの詳細

名前	型	説明
expectedResults	string[]	SQL 脆弱性評価ベースラインの期待される結果
updatedTime	string	SQL 脆弱性評価のベースライン更新時刻 (UTC)

BaselineAdjustedResult

SQL 脆弱性評価ベースラインの調整結果

名前	型	説明
baseline	Baseline	SQL 脆弱性評価のベースラインの詳細
resultsNotInBaseline	string[]	ベースラインにない SQL 脆弱性評価の結果
resultsOnlyInBaseline	string[]	ベースラインにある SQL 脆弱性評価の結果。
status	RuleStatus	SQL 脆弱性評価のベースラインの状態

BenchmarkReference

SQL 脆弱性評価ベンチマークリファレンス

名前	型	説明
benchmark	string	SQL 脆弱性評価ベンチマーク名
reference	string	SQL 脆弱性評価ベンチマークリファレンス。

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

QueryCheck

SQL 脆弱性評価クエリチェックオブジェクト。

名前	型	説明
columnNames	string[]	クエリの予想される結果の SQL 脆弱性評価列名。
expectedResult	string[]	SQL 脆弱性評価クエリの予想される結果。
query	string	SQL 脆弱性評価ルールクエリ。

Remediation

SQL 脆弱性評価の修復の詳細。

名前	型	説明
automated	boolean	SQL 脆弱性評価は修復が自動化されています。
description	string	SQL 脆弱性評価の修復の説明。
portalLink	string	AZURE Portal で修復するための SQL 脆弱性評価の省略可能なリンク。
scripts	string[]	SQL 脆弱性評価の修復スクリプト。

RuleSeverity

SQL 脆弱性評価ルールの重大度。

名前	型	説明
High	string
Informational	string
Low	string
Medium	string
Obsolete	string

RuleStatus

SQL 脆弱性評価のベースラインの状態

名前	型	説明
Finding	string
InternalError	string
NonFinding	string

RuleType

SQL 脆弱性評価ルールの種類。

名前	型	説明
BaselineExpected	string
Binary	string
NegativeList	string
PositiveList	string

SqlVulnerabilityAssessmentName

SQL 脆弱性評価の名前。

名前	型	説明
default	string

SqlVulnerabilityAssessmentScanResults

名前	型	説明
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

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

VaRule

SQL 脆弱性評価ルールのメタデータの詳細。

名前	型	説明
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 脆弱性評価ルールのタイトル。

VulnerabilityAssessmentSystemDatabaseName

SQL 脆弱性評価システムデータベース名。

名前	型	説明
master	string

次の方法で共有

Sql Vulnerability Assessment Scan Result - Get

URI パラメーター

応答

例

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

Sample Request

Sample Response

定義

Baseline

BaselineAdjustedResult

BenchmarkReference

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryCheck

Remediation

RuleSeverity

RuleStatus

RuleType

SqlVulnerabilityAssessmentName

SqlVulnerabilityAssessmentScanResults

systemData

VaRule

VulnerabilityAssessmentSystemDatabaseName

その他のリソース