Sql Vulnerability Assessment Baseline Rules - Create Or Update

Riferimento

Servizio:: Defender for Cloud

Versione API:: 2023-02-01-preview

Crea una baseline per una regola in un database. Sovrascriverà eventuali risultati esistenti in precedenza.

PUT https://management.azure.com/{resourceId}/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/{ruleId}?workspaceId={workspaceId}&api-version=2023-02-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceId	path	True	string	Identificatore della risorsa.
ruleId	path	True	string	ID regola.
api-version	query	True	string	Versione dell'API.
workspaceId	query	True	string	ID dell'area di lavoro.

Corpo della richiesta

Nome	Tipo	Descrizione
latestScan	boolean	Ottenere i risultati dall'analisi più recente.
results	string[]	Risultati previsti da inserire nella linea di base. Lasciare vuoto questo campo LatestScan == true.

Risposte

Nome	Tipo	Descrizione
200 OK	RuleResults	Impostare correttamente la baseline della regola di valutazione della vulnerabilità.
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Create a baseline

Create a baseline using the latest scan results

Create a baseline

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/VA1234?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview

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


import java.util.Arrays;

/**
 * Samples for SqlVulnerabilityAssessmentBaselineRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
     * sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_Put.json
     */
    /**
     * Sample code: Create a baseline.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createABaseline(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sqlVulnerabilityAssessmentBaselineRules().define("VA1234").withExistingResourceId(
            "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master")
            .withLatestScan(false)
            .withResults(Arrays.asList(Arrays.asList("userA", "SELECT"), Arrays.asList("userB", "SELECT")))
            .withWorkspaceId("55555555-6666-7777-8888-999999999999").create();
    }
}

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

package armsecurity_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/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_Put.json
func ExampleSQLVulnerabilityAssessmentBaselineRulesClient_CreateOrUpdate_createABaseline() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLVulnerabilityAssessmentBaselineRulesClient().CreateOrUpdate(ctx, "VA1234", "55555555-6666-7777-8888-999999999999", "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master", &armsecurity.SQLVulnerabilityAssessmentBaselineRulesClientCreateOrUpdateOptions{Body: &armsecurity.RuleResultsInput{
		LatestScan: to.Ptr(false),
		Results: [][]*string{
			{
				to.Ptr("userA"),
				to.Ptr("SELECT")},
			{
				to.Ptr("userB"),
				to.Ptr("SELECT")}},
	},
	})
	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.RuleResults = armsecurity.RuleResults{
	// 	Name: to.Ptr("VA1234"),
	// 	Type: to.Ptr("Microsoft.Security/sqlVulnerabilityAssessments/baselineRules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/VA1234"),
	// 	Properties: &armsecurity.RuleResultsProperties{
	// 		Results: [][]*string{
	// 			[]*string{
	// 				to.Ptr("userA"),
	// 				to.Ptr("SELECT")},
	// 				[]*string{
	// 					to.Ptr("userB"),
	// 					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

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

/**
 * This sample demonstrates how to Creates a Baseline for a rule in a database. Will overwrite any previously existing results.
 *
 * @summary Creates a Baseline for a rule in a database. Will overwrite any previously existing results.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_Put.json
 */
async function createABaseline() {
  const ruleId = "VA1234";
  const workspaceId = "55555555-6666-7777-8888-999999999999";
  const resourceId =
    "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
  const body = {
    latestScan: false,
    results: [
      ["userA", "SELECT"],
      ["userB", "SELECT"],
    ],
  };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.sqlVulnerabilityAssessmentBaselineRules.createOrUpdate(
    ruleId,
    workspaceId,
    resourceId,
    options,
  );
  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

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_Put.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentBaselineRules_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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this SqlVulnerabilityAssessmentBaselineRuleResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", resourceId));
SqlVulnerabilityAssessmentBaselineRuleCollection collection = client.GetSqlVulnerabilityAssessmentBaselineRules(scopeId);

// invoke the operation
string ruleId = "VA1234";
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent content = new SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent()
{
    LatestScan = false,
    Results =
    {
    new string[]
    {
    "userA","SELECT"
    },new string[]
    {
    "userB","SELECT"
    }
    },
};
ArmOperation<SqlVulnerabilityAssessmentBaselineRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, ruleId, workspaceId, content);
SqlVulnerabilityAssessmentBaselineRuleResource 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

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/VA1234",
  "name": "VA1234",
  "type": "Microsoft.Security/sqlVulnerabilityAssessments/baselineRules",
  "properties": {
    "results": [
      [
        "userA",
        "SELECT"
      ],
      [
        "userB",
        "SELECT"
      ]
    ]
  }
}

Create a baseline using the latest scan results

Esempio di richiesta

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/VA1234?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview

{
  "latestScan": true,
  "results": []
}


import java.util.Arrays;

/**
 * Samples for SqlVulnerabilityAssessmentBaselineRules CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
     * sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_PutLatest.json
     */
    /**
     * Sample code: Create a baseline using the latest scan results.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        createABaselineUsingTheLatestScanResults(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.sqlVulnerabilityAssessmentBaselineRules().define("VA1234").withExistingResourceId(
            "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master")
            .withLatestScan(true).withResults(Arrays.asList()).withWorkspaceId("55555555-6666-7777-8888-999999999999")
            .create();
    }
}

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

package armsecurity_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/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_PutLatest.json
func ExampleSQLVulnerabilityAssessmentBaselineRulesClient_CreateOrUpdate_createABaselineUsingTheLatestScanResults() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSQLVulnerabilityAssessmentBaselineRulesClient().CreateOrUpdate(ctx, "VA1234", "55555555-6666-7777-8888-999999999999", "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master", &armsecurity.SQLVulnerabilityAssessmentBaselineRulesClientCreateOrUpdateOptions{Body: &armsecurity.RuleResultsInput{
		LatestScan: to.Ptr(true),
		Results:    [][]*string{},
	},
	})
	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.RuleResults = armsecurity.RuleResults{
	// 	Name: to.Ptr("VA1234"),
	// 	Type: to.Ptr("Microsoft.Security/sqlVulnerabilityAssessments/baselineRules"),
	// 	ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/VA1234"),
	// 	Properties: &armsecurity.RuleResultsProperties{
	// 		Results: [][]*string{
	// 			[]*string{
	// 				to.Ptr("userA"),
	// 				to.Ptr("SELECT")},
	// 				[]*string{
	// 					to.Ptr("userB"),
	// 					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

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

/**
 * This sample demonstrates how to Creates a Baseline for a rule in a database. Will overwrite any previously existing results.
 *
 * @summary Creates a Baseline for a rule in a database. Will overwrite any previously existing results.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_PutLatest.json
 */
async function createABaselineUsingTheLatestScanResults() {
  const ruleId = "VA1234";
  const workspaceId = "55555555-6666-7777-8888-999999999999";
  const resourceId =
    "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
  const body = { latestScan: true, results: [] };
  const options = { body };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const result = await client.sqlVulnerabilityAssessmentBaselineRules.createOrUpdate(
    ruleId,
    workspaceId,
    resourceId,
    options,
  );
  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

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;

// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentsBaselineRuleOperations/ArcMachineBaselineRules_PutLatest.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentBaselineRules_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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this SqlVulnerabilityAssessmentBaselineRuleResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", resourceId));
SqlVulnerabilityAssessmentBaselineRuleCollection collection = client.GetSqlVulnerabilityAssessmentBaselineRules(scopeId);

// invoke the operation
string ruleId = "VA1234";
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent content = new SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent()
{
    LatestScan = true,
    Results =
    {
    },
};
ArmOperation<SqlVulnerabilityAssessmentBaselineRuleResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, ruleId, workspaceId, content);
SqlVulnerabilityAssessmentBaselineRuleResource 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

Risposta di esempio

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/baselineRules/VA1234",
  "name": "VA1234",
  "type": "Microsoft.Security/sqlVulnerabilityAssessments/baselineRules",
  "properties": {
    "results": [
      [
        "userA",
        "SELECT"
      ],
      [
        "userB",
        "SELECT"
      ]
    ]
  }
}

Definizioni

Nome	Descrizione
CloudError	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
CloudErrorBody	Dettagli dell'errore.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
RuleResults	Risultati delle regole.
RuleResultsInput	Input dei risultati della regola.
RuleResultsProperties	Proprietà dei risultati della regola.

CloudError

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error.additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
error.code	string	Codice di errore.
error.details	CloudErrorBody[]	Dettagli dell'errore.
error.message	string	Messaggio di errore.
error.target	string	Destinazione dell'errore.

CloudErrorBody

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	CloudErrorBody[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

RuleResults

Risultati delle regole.

Nome	Tipo	Descrizione
id	string	ID risorsa
name	string	Nome risorsa
properties	RuleResultsProperties	Proprietà dei risultati della regola.
type	string	Tipo di risorsa

RuleResultsInput

Input dei risultati della regola.

Nome	Tipo	Descrizione
latestScan	boolean	Ottenere i risultati dall'analisi più recente.
results	string[]	Risultati previsti da inserire nella linea di base. Lasciare vuoto questo campo LatestScan == true.

RuleResultsProperties

Proprietà dei risultati della regola.

Nome	Tipo	Descrizione
results	string[]	Risultati previsti nella linea di base.

Condividi tramite

Sql Vulnerability Assessment Baseline Rules - Create Or Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

Create a baseline

Esempio di richiesta

Risposta di esempio

Create a baseline using the latest scan results

Esempio di richiesta

Risposta di esempio

Definizioni

CloudError

CloudErrorBody

ErrorAdditionalInfo

RuleResults

RuleResultsInput

RuleResultsProperties

Risorse aggiuntive