Database Sql Vulnerability Assessment Rule Baselines - Create Or Update

リファレンス

サービス:: SQL Database

API バージョン:: 2024-05-01-preview

データベースの脆弱性評価規則のベースラインを作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sqlVulnerabilityAssessments/default/baselines/default/rules/{ruleId}?api-version=2024-05-01-preview

URI パラメーター

名前	/	必須	型	説明
baselineName	path	True	BaselineName
databaseName	path	True	string	データベースの名前。
resourceGroupName	path	True	string	リソースを含むリソースグループの名前。この値は、Azure Resource Manager API またはポータルから取得できます。
ruleId	path	True	string	脆弱性評価規則 ID。
serverName	path	True	string	サーバーの名前。
subscriptionId	path	True	string	Azure サブスクリプションを識別するサブスクリプション ID。
vulnerabilityAssessmentName	path	True	VulnerabilityAssessmentName	脆弱性評価の名前。
api-version	query	True	string	要求に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.latestScan	True	boolean	最新のスキャンフラグ
properties.results	True	string[]	ルールベースラインの結果

応答

名前	型	説明
200 OK	DatabaseSqlVulnerabilityAssessmentRuleBaseline	脆弱性評価規則のベースラインを正常に設定しました。
Other Status Codes	ErrorResponse	エラー応答: *** 400 SqlVulnerabilityAssessmentIsDisabled - SQL 脆弱性評価機能が無効になっています。他の SQL 脆弱性評価操作を実行する前に、この機能を有効にしてください。 400 InvalidSqlVulnerabilityAssessmentBaselineInput - SQL 脆弱性評価ベースライン入力が null または空です。 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。 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

DatabaseSqlVulnerabilityAssessmentRuleBaseline

脆弱性評価規則のベースラインを正常に設定しました。

Other Status Codes

ErrorResponse

エラー応答: ***

400 SqlVulnerabilityAssessmentIsDisabled - SQL 脆弱性評価機能が無効になっています。他の SQL 脆弱性評価操作を実行する前に、この機能を有効にしてください。
400 InvalidSqlVulnerabilityAssessmentBaselineInput - SQL 脆弱性評価ベースライン入力が null または空です。
400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - 無効なパラメーター値がクライアントによって提供されました。
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 - 読み込みに失敗しました。後でもう一度やり直してください。

例

Creates or updates a database's vulnerability assessment rule baseline.

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/sqlVulnerabilityAssessments/default/baselines/default/rules/VA1001?api-version=2024-05-01-preview

{
  "properties": {
    "latestScan": false,
    "results": [
      [
        "userA",
        "SELECT"
      ],
      [
        "userB",
        "SELECT"
      ],
      [
        "userC",
        "SELECT"
      ]
    ]
  }
}

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_rule_baseline_create.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_rule_baselines.create_or_update(
        resource_group_name="vulnerabilityaseessmenttest-4799",
        server_name="vulnerabilityaseessmenttest-6440",
        database_name="testdb",
        vulnerability_assessment_name="default",
        baseline_name="default",
        rule_id="VA1001",
        parameters={
            "properties": {
                "latestScan": False,
                "results": [["userA", "SELECT"], ["userB", "SELECT"], ["userC", "SELECT"]],
            }
        },
    )
    print(response)


# x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2024-05-01-preview/examples/DatabaseSqlVulnerabilityAssessmentRuleBaselineCreate.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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/sqlVulnerabilityAssessments/default/baselines/default/rules/VA1001",
  "name": "Scan123",
  "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments/rules/baselines",
  "properties": {
    "results": [
      [
        "userA",
        "SELECT"
      ],
      [
        "userB",
        "SELECT"
      ],
      [
        "userC",
        "SELECT"
      ]
    ]
  }
}

定義

名前	説明
BaselineName
createdByType	リソースを作成した ID の種類。
DatabaseSqlVulnerabilityAssessmentRuleBaseline	データベース SQL 脆弱性評価規則のベースライン。
DatabaseSqlVulnerabilityAssessmentRuleBaselineInput	データベース SQL 脆弱性評価規則のベースライン入力。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
systemData	リソースの作成と最後の変更に関連するメタデータ。
VulnerabilityAssessmentName	脆弱性評価の名前。

BaselineName

列挙

値	説明
default

createdByType

列挙

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

値	説明
Application
Key
ManagedIdentity
User

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Object

データベース SQL 脆弱性評価規則のベースライン。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.results	string[]	ルールベースラインの結果
systemData	systemData	DatabaseSqlVulnerabilityAssessmentRuleBaselineResource の SystemData。
type	string	リソースの種類。

DatabaseSqlVulnerabilityAssessmentRuleBaselineInput

Object

データベース SQL 脆弱性評価規則のベースライン入力。

名前	型	説明
id	string	リソース ID。
name	string	リソース名。
properties.latestScan	boolean	最新のスキャンフラグ
properties.results	string[]	ルールベースラインの結果
systemData	systemData	DatabaseSqlVulnerabilityAssessmentRuleBaselineInputResource の SystemData。
type	string	リソースの種類。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

systemData

Object

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

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

VulnerabilityAssessmentName

列挙

脆弱性評価の名前。

値	説明
default

次の方法で共有

Database Sql Vulnerability Assessment Rule Baselines - Create Or Update

URI パラメーター

要求本文

応答

例

Creates or updates a database's vulnerability assessment rule baseline.

要求のサンプル

応答のサンプル

定義

BaselineName

createdByType

DatabaseSqlVulnerabilityAssessmentRuleBaseline

DatabaseSqlVulnerabilityAssessmentRuleBaselineInput

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

systemData

VulnerabilityAssessmentName

その他のリソース