Sql Pool Security Alert Policies - List

Service:

Synapse

API Version:

2021-06-01

Répertorier les stratégies d’alerte de sécurité du pool Sql
Obtenez la liste des stratégies d’alerte de sécurité du pool Sql.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
sqlPoolName	path	True	string	Nom du pool SQL
subscriptionId	path	True	string	ID de l’abonnement cible.
workspaceName	path	True	string	Nom de l’espace de travail.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ListSqlPoolSecurityAlertPolicies	Ok
Other Status Codes		Réponses d’erreur : *** 400 SecurityAlertPoliciesInvalidStorageAccountName : le compte de stockage fourni n’est pas valide ou n’existe pas. 400 SecurityAlertPoliciesInvalidStorageAccountCredentials : la clé d’accès au compte de stockage fournie n’est pas valide. 400 InvalidServerSecurityAlertPolicyCreateRequest : la demande de stratégie d’alerte de sécurité détection des menaces du serveur de création n’existe pas ou n’a pas d’objet properties. 400 DataSecurityInvalidUserSuppliedParameter : une valeur de paramètre non valide a été fournie par le client. 400 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 400 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Veuillez réessayer ultérieurement 409 ServerSecurityAlertPolicyInProgress - Définir la stratégie d’alerte de sécurité du serveur est déjà en cours 409 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 500 DatabaseIsUnavailable - Échec du chargement. Veuillez réessayer plus tard. 500 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 500 GetServerSecurityAlertPolicyFailed - Échec de l’obtention des paramètres de détection des menaces

Exemples

Get a security alert of a SQL Analytics pool

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb/securityAlertPolicies?api-version=2021-06-01

Java

/** Samples for SqlPoolSecurityAlertPolicies List. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolSecurityAlertPolicies_List.json
     */
    /**
     * Sample code: Get a security alert of a SQL Analytics pool.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void getASecurityAlertOfASQLAnalyticsPool(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .sqlPoolSecurityAlertPolicies()
            .list("securityalert-6852", "securityalert-2080", "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 sql_pool_security_alert_policies_list.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_security_alert_policies.list(
        resource_group_name="securityalert-6852",
        workspace_name="securityalert-2080",
        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/SqlPoolSecurityAlertPolicies_List.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/SqlPoolSecurityAlertPolicies_List.json
func ExampleSQLPoolSecurityAlertPoliciesClient_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.NewSQLPoolSecurityAlertPoliciesClient().NewListPager("securityalert-6852", "securityalert-2080", "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.ListSQLPoolSecurityAlertPolicies = armsynapse.ListSQLPoolSecurityAlertPolicies{
		// 	Value: []*armsynapse.SQLPoolSecurityAlertPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb"),
		// 			Properties: &armsynapse.SecurityAlertPolicyProperties{
		// 				CreationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-08T00:00:00.000Z"); return t}()),
		// 				DisabledAlerts: []*string{
		// 					to.Ptr("Usage_Anomaly")},
		// 					EmailAccountAdmins: to.Ptr(true),
		// 					EmailAddresses: []*string{
		// 						to.Ptr("test@microsoft.com"),
		// 						to.Ptr("user@microsoft.com")},
		// 						RetentionDays: to.Ptr[int32](0),
		// 						State: to.Ptr(armsynapse.SecurityAlertPolicyStateEnabled),
		// 						StorageAccountAccessKey: to.Ptr(""),
		// 					},
		// 			}},
		// 		}
	}
}

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 Get a list of Sql pool's security alert policies.
 *
 * @summary Get a list of Sql pool's security alert policies.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolSecurityAlertPolicies_List.json
 */
async function getASecurityAlertOfASqlAnalyticsPool() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "securityalert-6852";
  const workspaceName = "securityalert-2080";
  const sqlPoolName = "testdb";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.sqlPoolSecurityAlertPolicies.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/SqlPoolSecurityAlertPolicies_List.json
// this example is just showing the usage of "SqlPoolSecurityAlertPolicies_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 = "securityalert-6852";
string workspaceName = "securityalert-2080";
string sqlPoolName = "testdb";
ResourceIdentifier synapseSqlPoolResourceId = SynapseSqlPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, sqlPoolName);
SynapseSqlPoolResource synapseSqlPool = client.GetSynapseSqlPoolResource(synapseSqlPoolResourceId);

// get the collection of this SynapseSqlPoolSecurityAlertPolicyResource
SynapseSqlPoolSecurityAlertPolicyCollection collection = synapseSqlPool.GetSynapseSqlPoolSecurityAlertPolicies();

// invoke the operation and iterate over the result
await foreach (SynapseSqlPoolSecurityAlertPolicyResource 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
    SynapseSqlPoolSecurityAlertPolicyData 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/securityalert-6852/providers/Microsoft.Synapse/workspaces/securityalert-2080/sqlPools/testdb",
      "name": "default",
      "type": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies",
      "properties": {
        "state": "Enabled",
        "emailAccountAdmins": true,
        "emailAddresses": [
          "test@microsoft.com",
          "user@microsoft.com"
        ],
        "disabledAlerts": [
          "Usage_Anomaly"
        ],
        "retentionDays": 0,
        "storageAccountAccessKey": "",
        "creationTime": "2018-10-08T00:00:00Z"
      }
    }
  ]
}

Définitions

Nom	Description
ListSqlPoolSecurityAlertPolicies	Liste des stratégies d’alerte de sécurité du pool SQL.
SecurityAlertPolicyState	Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur le pool Sql spécifique.
SqlPoolSecurityAlertPolicy	Une stratégie d’alerte de sécurité de pool Sql.

ListSqlPoolSecurityAlertPolicies

Liste des stratégies d’alerte de sécurité du pool SQL.

Nom	Type	Description
nextLink	string	Lien pour récupérer la page de résultats suivante.
value	SqlPoolSecurityAlertPolicy[]	Tableau de résultats.

SecurityAlertPolicyState

Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur le pool Sql spécifique.

Nom	Type	Description
Disabled	string
Enabled	string
New	string

SqlPoolSecurityAlertPolicy

Une stratégie d’alerte de sécurité de pool Sql.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.creationTime	string	Spécifie l’heure de création UTC de la stratégie.
properties.disabledAlerts	string[]	Spécifie un tableau d’alertes qui sont désactivées. Les valeurs autorisées sont les suivantes : Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action
properties.emailAccountAdmins	boolean	Spécifie que l’alerte est envoyée aux administrateurs de compte.
properties.emailAddresses	string[]	Spécifie un tableau d’adresses de messagerie auxquelles l’alerte est envoyée.
properties.retentionDays	integer	Spécifie le nombre de jours à conserver dans les journaux d’audit détection des menaces.
properties.state	SecurityAlertPolicyState	Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur le pool Sql spécifique.
properties.storageAccountAccessKey	string	Spécifie la clé d’identificateur du compte de stockage d’audit détection des menaces.
properties.storageEndpoint	string	Spécifie le point de terminaison de stockage d’objets blob (par exemple https://MyAccount.blob.core.windows.net). Ce stockage blob contient tous les journaux d’audit de détection des menaces.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »