Database Sql Vulnerability Assessment Rule Baselines - Create Or Update

Service:

SQL Database

API Version:

2023-08-01

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

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

URI Parameters

Name	In	Required	Type	Description
baselineName	path	True	BaselineName
databaseName	path	True	string	The name of the database.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
ruleId	path	True	string	The vulnerability assessment rule ID.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
vulnerabilityAssessmentName	path	True	VulnerabilityAssessmentName	The name of the vulnerability assessment.
api-version	query	True	string	The API version to use for the request.

Request Body

Name	Required	Type	Description
properties.latestScan	True	boolean	The latest scan flag
properties.results	True	string[]	The rule baseline result

Responses

Name	Type	Description
200 OK	DatabaseSqlVulnerabilityAssessmentRuleBaseline	Successfully set the vulnerability assessment rule baseline.
Other Status Codes	ErrorResponse	*** Error Responses: *** 400 SqlVulnerabilityAssessmentIsDisabled - SQL vulnerability assessment feature is disabled. please enable the feature before executing other SQL vulnerability assessment operations. 400 InvalidSqlVulnerabilityAssessmentBaselineInput - The SQL vulnerability assessment baseline input is null or empty. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - An invalid parameter value was provided by the client. 400 SqlVulnerabilityAssessmentInvalidUserSuppliedParameter - An invalid parameter value was provided by the client. 400 InvalidSqlVulnerabilityAssessmentBaselineInput - The SQL vulnerability assessment baseline input is null or empty. 400 InvalidSqlVulnerabilityAssessmentSettingsInput - The SQL vulnerability assessment setting input is null or empty 400 SqlVulnerabilityAssessmentScanResultsAreNotAvailableYet - SQL vulnerability assessment results are not available yet, please try again later. 400 SqlVulnerabilityAssessmentInvalidRuleId - The SQL vulnerability assessment rule id is invalid. 400 SqlVulnerabilityAssessmentScanDoesNotExist - SQL vulnerability assessment scan does not exist. 400 SqlVulnerabilityAssessmentNoBaseline - No baseline have been found for the latest scan in the resource 400 SqlVulnerabilityAssessmentNoRuleBaseline - No SQL vulnerability assessment baseline was found 400 SqlVulnerabilityAssessmentBaselineNoScanResults - No scan results have been found for rule Id. To set a baseline there must be results for this rule in the latest scan available 400 SqlVulnerabilityAssessmentBadBinaryRuleFormat - Input for binary rule is not a boolean representation 400 SqlVulnerabilityAssessmentBadRuleFormat - The provided results do not comply with the actual layout of the scan results 400 SqlVulnerabilityAssessmentBadRuleWithoutRuleIdFormat - The provided results do not comply with the actual layout of the scan results 400 SqlVulnerabilityAssessmentBadBinaryRuleWithoutRuleIdFormat - Input for binary rule is not a boolean representation 400 SqlVulnerabilityAssessmentBaselineNoScanResultsWithoutRuleId - No scan results have been found for one of the rules. To set a baseline there must be results for this rule in the latest scan available 400 SqlVulnerabilityAssessmentEmptyBaseline - Baseline not set because the results are null or empty 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 404 SourceDatabaseNotFound - The source database does not exist. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - SQL Vulnerability Assessment scan is already in progress 409 SqlVulnerabilityAssessmentStoragefullApiIsEnabled - Vulnerability Assessment is enabled on this server or one of its underlying databases with an incompatible version. Additional troubleshooting information can be found https://aka.ms/SQLVAStoragelessDocumentation. 500 DatabaseIsUnavailable - Loading failed. Please try again later.

Examples

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/databases/testdb/sqlVulnerabilityAssessments/default/baselines/default/rules/VA1001?api-version=2023-08-01

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

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/stable/2023-08-01/examples/DatabaseSqlVulnerabilityAssessmentRuleBaselineCreate.json
// this example is just showing the usage of "DatabaseSqlVulnerabilityAssessmentRuleBaselines_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 SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource created on azure
// for more information of creating SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource, please refer to the document of SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "vulnerabilityaseessmenttest-4799";
string serverName = "vulnerabilityaseessmenttest-6440";
string databaseName = "testdb";
VulnerabilityAssessmentName vulnerabilityAssessmentName = VulnerabilityAssessmentName.Default;
SqlVulnerabilityAssessmentBaselineName baselineName = SqlVulnerabilityAssessmentBaselineName.Default;
string ruleId = "VA1001";
ResourceIdentifier sqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResourceId = SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName, databaseName, vulnerabilityAssessmentName, baselineName, ruleId);
SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource sqlDatabaseSqlVulnerabilityAssessmentBaselineRule = client.GetSqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource(sqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResourceId);

// invoke the operation
SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent content = new SqlVulnerabilityAssessmentBaselineRuleCreateOrUpdateContent
{
    IsLatestScan = false,
    Results = { new string[] { "userA", "SELECT" }, new string[] { "userB", "SELECT" }, new string[] { "userC", "SELECT" } },
};
ArmOperation<SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource> lro = await sqlDatabaseSqlVulnerabilityAssessmentBaselineRule.UpdateAsync(WaitUntil.Completed, content);
SqlDatabaseSqlVulnerabilityAssessmentBaselineRuleResource 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/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"
      ]
    ]
  }
}

Definitions

Name	Description
BaselineName
createdByType	The type of identity that created the resource.
DatabaseSqlVulnerabilityAssessmentRuleBaseline	A database sql vulnerability assessment rule baseline.
DatabaseSqlVulnerabilityAssessmentRuleBaselineInput	A database sql vulnerability assessment rule baseline input.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
systemData	Metadata pertaining to creation and last modification of the resource.
VulnerabilityAssessmentName	The name of the vulnerability assessment.

BaselineName

Enumeration

Value	Description
default

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DatabaseSqlVulnerabilityAssessmentRuleBaseline

Object

A database sql vulnerability assessment rule baseline.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.results	string[]	The rule baseline result
systemData	systemData	SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineResource.
type	string	Resource type.

DatabaseSqlVulnerabilityAssessmentRuleBaselineInput

Object

A database sql vulnerability assessment rule baseline input.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.latestScan	boolean	The latest scan flag
properties.results	string[]	The rule baseline result
systemData	systemData	SystemData of DatabaseSqlVulnerabilityAssessmentRuleBaselineInputResource.
type	string	Resource type.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

VulnerabilityAssessmentName

Enumeration

The name of the vulnerability assessment.

Value	Description
default