Sql Pool Vulnerability Assessments - List

Service:

Synapse

API Version:

2021-06-01

Listas las directivas de evaluación de vulnerabilidades asociadas a un grupo de SQL.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}/vulnerabilityAssessments?api-version=2021-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
sqlPoolName	path	True	string	Nombre del grupo de SQL
subscriptionId	path	True	string	Identificador de la suscripción de destino.
workspaceName	path	True	string	El nombre del área de trabajo.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	SqlPoolVulnerabilityAssessmentListResult	Aceptar
Other Status Codes		Respuestas de error: *** 400 InvalidStorageAccountName: la cuenta de almacenamiento proporcionada no es válida o no existe. 400 InvalidStorageAccountCredentials: la firma de acceso compartido de la cuenta de almacenamiento proporcionada o la clave de almacenamiento de la cuenta no es válida. 400 VulnerabilityAssessmentInvalidPolicy: la configuración de evaluación de vulnerabilidades no existe o el almacenamiento no es válido especificado en la configuración. 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath: se debe proporcionar la ruta de acceso del contenedor de storage si no está establecida en la directiva de nivel de servidor. 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated: no se pudo ejecutar la operación de evaluación de vulnerabilidades porque la base de datos está en pausa. Por favor reanudarlo. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado. 404 SourceDatabaseNotFound: la base de datos de origen no existe. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress: el examen de evaluación de vulnerabilidades ya está en curso. 500 DatabaseIsUnavailable: error al cargar. Vuelva a intentarlo más tarde.

Ejemplos

Get a vulnerability assessment of a SQL Analytics pool

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments?api-version=2021-06-01

Java

/** Samples for SqlPoolVulnerabilityAssessments List. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessments.json
     */
    /**
     * Sample code: Get a vulnerability assessment of a SQL Analytics pool.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void getAVulnerabilityAssessmentOfASQLAnalyticsPool(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolVulnerabilityAssessments()
            .list(
                "vulnerabilityaseessmenttest-4799",
                "vulnerabilityaseessmenttest-6440",
                "testdb",
                com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# USAGE
    python list_sql_pool_vulnerability_assessments.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 = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.sql_pool_vulnerability_assessments.list(
        resource_group_name="vulnerabilityaseessmenttest-4799",
        workspace_name="vulnerabilityaseessmenttest-6440",
        sql_pool_name="testdb",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessments.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 armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessments.json
func ExampleSQLPoolVulnerabilityAssessmentsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSQLPoolVulnerabilityAssessmentsClient().NewListPager("vulnerabilityaseessmenttest-4799", "vulnerabilityaseessmenttest-6440", "testdb", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.SQLPoolVulnerabilityAssessmentListResult = armsynapse.SQLPoolVulnerabilityAssessmentListResult{
		// 	Value: []*armsynapse.SQLPoolVulnerabilityAssessment{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default"),
		// 			Properties: &armsynapse.SQLPoolVulnerabilityAssessmentProperties{
		// 				RecurringScans: &armsynapse.VulnerabilityAssessmentRecurringScansProperties{
		// 					EmailSubscriptionAdmins: to.Ptr(true),
		// 					Emails: []*string{
		// 						to.Ptr("email1@mail.com"),
		// 						to.Ptr("email2@mail.com")},
		// 						IsEnabled: to.Ptr(true),
		// 					},
		// 				},
		// 		}},
		// 	}
	}
}

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 { SynapseManagementClient } = require("@azure/arm-synapse");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists the vulnerability assessment policies associated with a SQL pool.
 *
 * @summary Lists the vulnerability assessment policies associated with a SQL pool.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessments.json
 */
async function getAVulnerabilityAssessmentOfASqlAnalyticsPool() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName =
    process.env["SYNAPSE_RESOURCE_GROUP"] || "vulnerabilityaseessmenttest-4799";
  const workspaceName = "vulnerabilityaseessmenttest-6440";
  const sqlPoolName = "testdb";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sqlPoolVulnerabilityAssessments.list(
    resourceGroupName,
    workspaceName,
    sqlPoolName
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/ListSqlPoolVulnerabilityAssessments.json
// this example is just showing the usage of "SqlPoolVulnerabilityAssessments_List" 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 SynapseSqlPoolResource created on azure
// for more information of creating SynapseSqlPoolResource, please refer to the document of SynapseSqlPoolResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "vulnerabilityaseessmenttest-4799";
string workspaceName = "vulnerabilityaseessmenttest-6440";
string sqlPoolName = "testdb";
ResourceIdentifier synapseSqlPoolResourceId = SynapseSqlPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sqlPoolName);
SynapseSqlPoolResource synapseSqlPool = client.GetSynapseSqlPoolResource(synapseSqlPoolResourceId);

// get the collection of this SynapseSqlPoolVulnerabilityAssessmentResource
SynapseSqlPoolVulnerabilityAssessmentCollection collection = synapseSqlPool.GetSynapseSqlPoolVulnerabilityAssessments();

// invoke the operation and iterate over the result
await foreach (SynapseSqlPoolVulnerabilityAssessmentResource item in collection.GetAllAsync())
{
    // the variable item 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
    SynapseSqlPoolVulnerabilityAssessmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Synapse/workspaces/vulnerabilityaseessmenttest-6440/sqlPools/testdb/vulnerabilityAssessments/default",
      "name": "default",
      "type": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments",
      "properties": {
        "recurringScans": {
          "isEnabled": true,
          "emailSubscriptionAdmins": true,
          "emails": [
            "email1@mail.com",
            "email2@mail.com"
          ]
        }
      }
    }
  ]
}

Definiciones

Nombre	Description
SqlPoolVulnerabilityAssessment	Una evaluación de vulnerabilidades del grupo de Sql.
SqlPoolVulnerabilityAssessmentListResult	Una lista de las evaluaciones de vulnerabilidades del grupo de Sql.
VulnerabilityAssessmentRecurringScansProperties	Propiedades de exámenes periódicos de evaluación de vulnerabilidades.

SqlPoolVulnerabilityAssessment

Una evaluación de vulnerabilidades del grupo de Sql.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.recurringScans	VulnerabilityAssessmentRecurringScansProperties	La configuración de exámenes periódicos
properties.storageAccountAccessKey	string	Especifica la clave de identificador de la cuenta de almacenamiento para los resultados del examen de evaluación de vulnerabilidades. Si no se especifica "StorageContainerSasKey", se requiere storageAccountAccessKey.
properties.storageContainerPath	string	Ruta de acceso del contenedor de Blob Storage para contener los resultados del examen (por ejemplo, https://myStorage.blob.core.windows.net/VaScans/). Se requiere si la directiva de evaluación de vulnerabilidades de nivel de servidor no se establece.
properties.storageContainerSasKey	string	Firma de acceso compartido (clave SAS) que tiene acceso de escritura al contenedor de blobs especificado en el parámetro "storageContainerPath". Si no se especifica "storageAccountAccessKey", se requiere StorageContainerSasKey.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SqlPoolVulnerabilityAssessmentListResult

Una lista de las evaluaciones de vulnerabilidades del grupo de Sql.

Nombre	Tipo	Description
nextLink	string	Vínculo para recuperar la página siguiente de resultados.
value	SqlPoolVulnerabilityAssessment[]	Matriz de resultados.

VulnerabilityAssessmentRecurringScansProperties

Propiedades de exámenes periódicos de evaluación de vulnerabilidades.

Nombre	Tipo	Valor predeterminado	Description
emailSubscriptionAdmins	boolean	True	Especifica que la notificación de examen de programación se enviará a los administradores de la suscripción.
emails	string[]		Especifica una matriz de direcciones de correo electrónico a las que se envía la notificación de examen.
isEnabled	boolean		Estado de exámenes periódicos.