Sql Vulnerability Assessment Rule Baseline - Create Or Update

Service:

SQL Database

API Version:

2022-11-01-preview

Tworzy lub aktualizuje punkt odniesienia reguły oceny luk w zabezpieczeniach bazy danych.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/sqlVulnerabilityAssessments/default/baselines/default/rules/{ruleId}?systemDatabaseName=master&api-version=2022-11-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
baselineName	path	True	BaselineName
resourceGroupName	path	True	string	Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
ruleId	path	True	string	Identyfikator reguły oceny luk w zabezpieczeniach.
serverName	path	True	string	Nazwa serwera.
subscriptionId	path	True	string	Identyfikator subskrypcji identyfikujący subskrypcję platformy Azure.
vulnerabilityAssessmentName	path	True	VulnerabilityAssessmentName	Nazwa oceny luk w zabezpieczeniach.
api-version	query	True	string	Wersja interfejsu API do użycia dla żądania.
systemDatabaseName	query	True	VulnerabilityAssessmentSystemDatabaseName	Nazwa bazy danych systemu oceny luk w zabezpieczeniach.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.latestScan	True	boolean	Flaga najnowszego skanowania
properties.results	True	string[]	Wynik linii bazowej reguły

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DatabaseSqlVulnerabilityAssessmentRuleBaseline	Pomyślnie ustaw punkt odniesienia reguły oceny luk w zabezpieczeniach.
Other Status Codes		Odpowiedzi na błędy: *** 400 SqlVulnerabilityAssessmentIsDisabled — funkcja oceny luk w zabezpieczeniach SQL jest wyłączona. Włącz tę funkcję przed wykonaniem innych operacji oceny luk w zabezpieczeniach SQL. 400 InvalidSqlVulnerabilityAssessmentBaselineInput — dane wejściowe oceny luk w zabezpieczeniach SQL mają wartość null lub są puste. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter — klient podał nieprawidłową wartość parametru. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter — klient podał nieprawidłową wartość parametru. 400 InvalidSqlVulnerabilityAssessmentBaselineInput — dane wejściowe oceny luk w zabezpieczeniach SQL mają wartość null lub są puste. 400 InvalidSqlVulnerabilityAssessmentSettingsInput — dane wejściowe ustawienia oceny luk w zabezpieczeniach SQL mają wartość null lub są puste 400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet — wyniki oceny luk w zabezpieczeniach SQL nie są jeszcze dostępne. Spróbuj ponownie później. 400 SqlVulnerabilityAssessmentInvalidRuleId — identyfikator reguły oceny luk w zabezpieczeniach SQL jest nieprawidłowy. 400 SqlVulnerabilityAssessmentScanDoesNotExist — skanowanie oceny luk w zabezpieczeniach SQL nie istnieje. 400 SqlVulnerabilityAssessmentNoBaseline — nie znaleziono planu bazowego dla najnowszego skanowania w zasobie 400 SqlVulnerabilityAssessmentNoRuleBaseline — nie znaleziono punktu odniesienia oceny luk w zabezpieczeniach SQL 400 SqlVulnerabilityAssessmentBaselineNoScanResults — nie znaleziono wyników skanowania dla identyfikatora reguły. Aby ustawić punkt odniesienia, należy uzyskać wyniki dla tej reguły w najnowszym dostępnym skanowaniu 400 SqlVulnerabilityAssessmentBadBinaryRuleFormat — dane wejściowe dla reguły binarnej nie są reprezentacją logiczną 400 SqlVulnerabilityAssessmentBadRuleFormat — podane wyniki nie są zgodne z rzeczywistym układem wyników skanowania 400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat — podane wyniki nie są zgodne z rzeczywistym układem wyników skanowania 400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat — dane wejściowe dla reguły binarnej nie są reprezentacją logiczną 400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId — nie znaleziono wyników skanowania dla jednej z reguł. Aby ustawić punkt odniesienia, należy uzyskać wyniki dla tej reguły w najnowszym dostępnym skanowaniu 400 SqlVulnerabilityAssessmentEmptyBaseline — nie ustawiono planu bazowego, ponieważ wyniki mają wartość null lub są puste 404 SubscriptionDoesNotHaveServer — nie znaleziono żądanego serwera 404 SourceDatabaseNotFound — źródłowa baza danych nie istnieje. 404 DatabaseDoesNotExist — użytkownik określił nazwę bazy danych, która nie istnieje w tym wystąpieniu serwera. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress — skanowanie oceny luk w zabezpieczeniach SQL jest już w toku 409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled — ocena luk w zabezpieczeniach jest włączona na tym serwerze lub w jednej z jego bazowych baz danych z niezgodną wersją. Dodatkowe informacje dotyczące rozwiązywania problemów można znaleźć.https://aka.ms/SQLVAStoragelessDocumentation 500 DatabaseIsUnavailable — ładowanie nie powiodło się. Spróbuj ponownie później.

Przykłady

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

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/sqlVulnerabilityAssessments/default/baselines/default/rules/VA1001?systemDatabaseName=master&api-version=2022-11-01-preview

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python 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.sql_vulnerability_assessment_rule_baseline.create_or_update(
        resource_group_name="vulnerabilityaseessmenttest-4799",
        server_name="vulnerabilityaseessmenttest-6440",
        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/2022-11-01-preview/examples/SqlVulnerabilityAssessmentRuleBaselineCreate.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

Go

package armsql_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/sql/armsql/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c78b5d8bd3aff2d82a5f034d9164b1a9ac030e09/specification/sql/resource-manager/Microsoft.Sql/preview/2022-11-01-preview/examples/SqlVulnerabilityAssessmentRuleBaselineCreate.json
func ExampleVulnerabilityAssessmentRuleBaselineClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsql.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewVulnerabilityAssessmentRuleBaselineClient().CreateOrUpdate(ctx, "vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", armsql.VulnerabilityAssessmentNameDefault, armsql.BaselineNameDefault, "VA1001", armsql.DatabaseSQLVulnerabilityAssessmentRuleBaselineInput{
		Properties: &armsql.DatabaseSQLVulnerabilityAssessmentRuleBaselineInputProperties{
			LatestScan: to.Ptr(false),
			Results: [][]*string{
				{
					to.Ptr("userA"),
					to.Ptr("SELECT")},
				{
					to.Ptr("userB"),
					to.Ptr("SELECT")},
				{
					to.Ptr("userC"),
					to.Ptr("SELECT")}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DatabaseSQLVulnerabilityAssessmentRuleBaseline = armsql.DatabaseSQLVulnerabilityAssessmentRuleBaseline{
	// 	Name: to.Ptr("Scan123"),
	// 	Type: to.Ptr("Microsoft.Sql/servers/vulnerabilityAssessments/rules/baselines"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/sqlVulnerabilityAssessments/default/rules/VA1001"),
	// 	Properties: &armsql.DatabaseSQLVulnerabilityAssessmentRuleBaselineProperties{
	// 		Results: [][]*string{
	// 			[]*string{
	// 				to.Ptr("userA"),
	// 				to.Ptr("SELECT")},
	// 				[]*string{
	// 					to.Ptr("userB"),
	// 					to.Ptr("SELECT")},
	// 					[]*string{
	// 						to.Ptr("userC"),
	// 						to.Ptr("SELECT")}},
	// 					},
	// 				}
}

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a database's vulnerability assessment rule baseline.
 *
 * @summary Creates or updates a database's vulnerability assessment rule baseline.
 * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/preview/2022-11-01-preview/examples/SqlVulnerabilityAssessmentRuleBaselineCreate.json
 */
async function createsOrUpdatesADatabaseVulnerabilityAssessmentRuleBaseline() {
  const subscriptionId =
    process.env["SQL_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SQL_RESOURCE_GROUP"] || "vulnerabilityaseessmenttest-4799";
  const serverName = "vulnerabilityaseessmenttest-6440";
  const vulnerabilityAssessmentName = "default";
  const baselineName = "default";
  const ruleId = "VA1001";
  const parameters = {
    latestScan: false,
    results: [
      ["userA", "SELECT"],
      ["userB", "SELECT"],
      ["userC", "SELECT"],
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.sqlVulnerabilityAssessmentRuleBaseline.createOrUpdate(
    resourceGroupName,
    serverName,
    vulnerabilityAssessmentName,
    baselineName,
    ruleId,
    parameters
  );
  console.log(result);
}

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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Sql;
using Azure.ResourceManager.Sql.Models;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/preview/2022-11-01-preview/examples/SqlVulnerabilityAssessmentRuleBaselineCreate.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentRuleBaseline_CreateOrUpdate" 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 SqlServerSqlVulnerabilityAssessmentBaselineRuleResource created on azure
// for more information of creating SqlServerSqlVulnerabilityAssessmentBaselineRuleResource, please refer to the document of SqlServerSqlVulnerabilityAssessmentBaselineRuleResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "vulnerabilityaseessmenttest-4799";
string serverName = "vulnerabilityaseessmenttest-6440";
VulnerabilityAssessmentName vulnerabilityAssessmentName = VulnerabilityAssessmentName.Default;
SqlVulnerabilityAssessmentBaselineName baselineName = SqlVulnerabilityAssessmentBaselineName.Default;
string ruleId = "VA1001";
ResourceIdentifier sqlServerSqlVulnerabilityAssessmentBaselineRuleResourceId = SqlServerSqlVulnerabilityAssessmentBaselineRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, vulnerabilityAssessmentName, baselineName, ruleId);
SqlServerSqlVulnerabilityAssessmentBaselineRuleResource sqlServerSqlVulnerabilityAssessmentBaselineRule = client.GetSqlServerSqlVulnerabilityAssessmentBaselineRuleResource(sqlServerSqlVulnerabilityAssessmentBaselineRuleResourceId);

// invoke the operation
SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent content = new SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent()
{
    IsLatestScan = false,
    Results =
    {
    new string[]
    {
    "userA","SELECT"
    },new string[]
    {
    "userB","SELECT"
    },new string[]
    {
    "userC","SELECT"
    }
    },
};
ArmOperation<SqlServerSqlVulnerabilityAssessmentBaselineRuleResource> lro = await sqlServerSqlVulnerabilityAssessmentBaselineRule.UpdateAsync(WaitUntil.Completed, content);
SqlServerSqlVulnerabilityAssessmentBaselineRuleResource result = lro.Value;

// 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
SqlVulnerabilityAssessmentBaselineRuleData 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

Sample Response

Status code:

200

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

Definicje

Nazwa	Opis
BaselineName
createdByType	Typ tożsamości, która utworzyła zasób.
DatabaseSqlVulnerabilityAssessmentRuleBaseline	Punkt odniesienia reguły oceny luk w zabezpieczeniach SQL bazy danych.
DatabaseSqlVulnerabilityAssessmentRuleBaselineInput	Dane wejściowe reguły oceny luk w zabezpieczeniach SQL bazy danych.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
VulnerabilityAssessmentName	Nazwa oceny luk w zabezpieczeniach.
VulnerabilityAssessmentSystemDatabaseName	Nazwa bazy danych systemu oceny luk w zabezpieczeniach.

BaselineName

Nazwa	Typ	Opis
default	string

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Punkt odniesienia reguły oceny luk w zabezpieczeniach SQL bazy danych.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.results	string[]	Wynik linii bazowej reguły
systemData	systemData	SystemData elementu DatabaseSqlVulnerabilityAssessmentRuleBaselineResource.
type	string	Typ zasobu.

DatabaseSqlVulnerabilityAssessmentRuleBaselineInput

Dane wejściowe reguły oceny luk w zabezpieczeniach SQL bazy danych.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
properties.latestScan	boolean	Flaga najnowszego skanowania
properties.results	string[]	Wynik linii bazowej reguły
systemData	systemData	SystemData elementu DatabaseSqlVulnerabilityAssessmentRuleBaselineInputResource.
type	string	Typ zasobu.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

VulnerabilityAssessmentName

Nazwa oceny luk w zabezpieczeniach.

Nazwa	Typ	Opis
default	string

VulnerabilityAssessmentSystemDatabaseName

Nazwa bazy danych systemu oceny luk w zabezpieczeniach.

Nazwa	Typ	Opis
master	string