Extended Sql Pool Blob Auditing Policies - List By Sql Pool

Service:

Synapse

API Version:

2021-06-01

Listák Sql-készlet bővített naplózási beállításait.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
sqlPoolName	path	True	string	SQL-készlet neve
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
workspaceName	path	True	string	A munkaterület neve.
api-version	query	True	string	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	ExtendedSqlPoolBlobAuditingPolicyListResult	Sikeresen lekérte az adatbázis bővített naplózási beállításait.
Other Status Codes		Hibaválaszok: *** 400 BlobAuditingIsNotSupportedOnResourceType – A blobnaplózás jelenleg nem támogatott ehhez az erőforrástípushoz. 404 SourceDatabaseNotFound – A forrásadatbázis nem létezik. 404 DatabaseDoesNotExist – A felhasználó olyan adatbázisnevet adott meg, amely nem létezik ezen a kiszolgálópéldányon. 500 DatabaseIsUnavailable – A betöltés nem sikerült. Próbálkozzon újra később.

Példák

List extended auditing settings of a database

Sample Request

HTTP

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

Java

/** Samples for ExtendedSqlPoolBlobAuditingPolicies ListBySqlPool. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolExtendedAuditingSettingsList.json
     */
    /**
     * Sample code: List extended auditing settings of a database.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void listExtendedAuditingSettingsOfADatabase(
        com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .extendedSqlPoolBlobAuditingPolicies()
            .listBySqlPool(
                "blobauditingtest-6852", "blobauditingtest-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_extended_auditing_settings_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.extended_sql_pool_blob_auditing_policies.list_by_sql_pool(
        resource_group_name="blobauditingtest-6852",
        workspace_name="blobauditingtest-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/SqlPoolExtendedAuditingSettingsList.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/SqlPoolExtendedAuditingSettingsList.json
func ExampleExtendedSQLPoolBlobAuditingPoliciesClient_NewListBySQLPoolPager() {
	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.NewExtendedSQLPoolBlobAuditingPoliciesClient().NewListBySQLPoolPager("blobauditingtest-6852", "blobauditingtest-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.ExtendedSQLPoolBlobAuditingPolicyListResult = armsynapse.ExtendedSQLPoolBlobAuditingPolicyListResult{
		// 	Value: []*armsynapse.ExtendedSQLPoolBlobAuditingPolicy{
		// 		{
		// 			Name: to.Ptr("default"),
		// 			Type: to.Ptr("Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings"),
		// 			ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/extendedAuditingSettings/default"),
		// 			Properties: &armsynapse.ExtendedSQLPoolBlobAuditingPolicyProperties{
		// 				AuditActionsAndGroups: []*string{
		// 				},
		// 				IsAzureMonitorTargetEnabled: to.Ptr(false),
		// 				IsStorageSecondaryKeyInUse: to.Ptr(false),
		// 				PredicateExpression: to.Ptr("statement = 'select 1'"),
		// 				RetentionDays: to.Ptr[int32](0),
		// 				State: to.Ptr(armsynapse.BlobAuditingPolicyStateDisabled),
		// 				StorageAccountSubscriptionID: to.Ptr("00000000-0000-0000-0000-000000000000"),
		// 				StorageEndpoint: 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 Lists extended auditing settings of a Sql pool.
 *
 * @summary Lists extended auditing settings of a Sql pool.
 * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/stable/2021-06-01/examples/SqlPoolExtendedAuditingSettingsList.json
 */
async function listExtendedAuditingSettingsOfADatabase() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "00000000-1111-2222-3333-444444444444";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "blobauditingtest-6852";
  const workspaceName = "blobauditingtest-2080";
  const sqlPoolName = "testdb";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.extendedSqlPoolBlobAuditingPolicies.listBySqlPool(
    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

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-6852/providers/Microsoft.Synapse/workspaces/blobauditingtest-2080/sqlPools/testdb/extendedAuditingSettings/default",
      "name": "default",
      "type": "Microsoft.Synapse/workspaces/sqlPools/extendedAuditingSettings",
      "properties": {
        "state": "Disabled",
        "storageEndpoint": "",
        "retentionDays": 0,
        "auditActionsAndGroups": [],
        "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000",
        "isStorageSecondaryKeyInUse": false,
        "predicateExpression": "statement = 'select 1'",
        "isAzureMonitorTargetEnabled": false
      }
    }
  ]
}

Definíciók

Name	Description
BlobAuditingPolicyState	A szabályzat állapotát határozza meg. Ha az állapot engedélyezve van, akkor a storageEndpoint vagy azAzureMonitorTargetEnabled szükséges.
ExtendedSqlPoolBlobAuditingPolicy	Kiterjesztett Sql-készlet blobnaplózási szabályzata.
ExtendedSqlPoolBlobAuditingPolicyListResult	Az SQL-készlet bővített naplózási beállításainak listája.

BlobAuditingPolicyState

A szabályzat állapotát határozza meg. Ha az állapot engedélyezve van, akkor a storageEndpoint vagy azAzureMonitorTargetEnabled szükséges.

Name	Típus	Description
Disabled	string
Enabled	string

ExtendedSqlPoolBlobAuditingPolicy

Kiterjesztett Sql-készlet blobnaplózási szabályzata.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.auditActionsAndGroups	string[]	A naplózandó Actions-Groups és műveletek megadása. A javasolt műveletcsoportok a következő kombinációt használják : ez az adatbázison végrehajtott összes lekérdezést és tárolt eljárást, valamint a sikeres és sikertelen bejelentkezéseket fogja naplózni: BATCH_COMPLETED_GROUP, SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP. Ez a fenti kombináció az a készlet is, amely alapértelmezés szerint konfigurálva van, amikor engedélyezi a naplózást a Azure Portal. A naplózandó támogatott műveletcsoportok (megjegyzés: csak azokat a csoportokat válassza ki, amelyek lefedik a naplózási igényeket. A szükségtelen csoportok használata nagyon nagy mennyiségű naplózási rekordhoz vezethet: APPLICATION_ROLE_CHANGE_PASSWORD_GROUP BACKUP_RESTORE_GROUP DATABASE_LOGOUT_GROUP DATABASE_OBJECT_CHANGE_GROUP DATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP DATABASE_OBJECT_PERMISSION_CHANGE_GROUP DATABASE_OPERATION_GROUP DATABASE_PERMISSION_CHANGE_GROUP DATABASE_PRINCIPAL_CHANGE_GROUP DATABASE_PRINCIPAL_IMPERSONATION_GROUP DATABASE_ROLE_MEMBER_CHANGE_GROUP FAILED_DATABASE_AUTHENTICATION_GROUP SCHEMA_OBJECT_ACCESS_GROUP SCHEMA_OBJECT_CHANGE_GROUP SCHEMA_OBJECT_ OWNERSHIP_CHANGE_GROUP SCHEMA_OBJECT_PERMISSION_CHANGE_GROUP SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP USER_CHANGE_PASSWORD_GROUP BATCH_STARTED_GROUP BATCH_COMPLETED_GROUP Ezek olyan csoportok, amelyek lefedik az adatbázison végrehajtott összes SQL-utasítást és tárolt eljárást, és nem használhatók más csoportokkal együtt, mivel ez ismétlődő naplózási naplókat eredményez. További információ: Adatbázisszintű naplózási műveletcsoportok. Adatbázis-naplózási szabályzat esetén adott műveletek is megadhatók (vegye figyelembe, hogy a kiszolgálók naplózási házirendje nem adható meg műveletekhez). A naplózás támogatott műveletei a következők: SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES A naplózandó művelet meghatározásának általános űrlapja: {action} ON {object} BY {principal} Vegye figyelembe, hogy a fenti formátumban hivatkozhat egy objektumra, például egy táblára, nézetre vagy tárolt eljárásra, vagy egy teljes adatbázisra vagy sémára. Az utóbbi esetekben a DATABASE::{db_name} és a SCHEMA::{schema_name} űrlapot használja a rendszer. Például: SELECT on dbo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public További információ: Adatbázisszintű naplózási műveletek
properties.isAzureMonitorTargetEnabled	boolean	Meghatározza, hogy a rendszer elküldi-e a naplózási eseményeket az Azure Monitornak. Az események Azure Monitorba való küldéséhez adja meg az "állapot" értéket "Enabled" (Engedélyezve), az "isAzureMonitorTargetEnabled" értéket pedig igazként. Ha REST API-t használ a naplózás konfigurálásához, létre kell hoznia az adatbázis "SQLSecurityAuditEvents" diagnosztikai naplókategória diagnosztikai beállításait is. Vegye figyelembe, hogy a kiszolgálószintű naplózáshoz a "master" adatbázist {databaseName} néven kell használnia. Diagnosztikai beállítások URI formátuma: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview További információ: Diagnosztikai beállítások REST API vagy Diagnosztikai beállítások PowerShell
properties.isStorageSecondaryKeyInUse	boolean	Meghatározza, hogy a storageAccountAccessKey érték-e a tároló másodlagos kulcsa.
properties.predicateExpression	string	Meghatározza annak a feltételnek a feltételét, hogy hol van a záradék a naplózás létrehozásakor.
properties.queueDelayMs	integer	Ezredmásodpercben adja meg, hogy mennyi idő telik el a naplózási műveletek feldolgozásának kényszerítése előtt. Az alapértelmezett minimális érték 1000 (1 másodperc). A maximális érték 2 147 483 647.
properties.retentionDays	integer	Megadja, hogy hány nap maradjon a tárfiók naplóiban.
properties.state	BlobAuditingPolicyState	A szabályzat állapotát határozza meg. Ha az állapot engedélyezve van, akkor a storageEndpoint vagy azAzureMonitorTargetEnabled szükséges.
properties.storageAccountAccessKey	string	Megadja a naplózási tárfiók azonosítókulcsát. Ha az állapot engedélyezve van, és a storageEndpoint meg van adva, a storageAccountAccessKey megadása után az SQL Server rendszer által hozzárendelt felügyelt identitása fogja használni a tároló elérését. A felügyelt identitáshitelesítés használatának előfeltételei: Hozzárendelhet SQL Server egy rendszer által hozzárendelt felügyelt identitást az Azure Active Directoryban (AAD). Adjon SQL Server identitáshoz való hozzáférést a tárfiókhoz, ha hozzáadja a "Storage Blob Data Contributor" RBAC-szerepkört a kiszolgálói identitáshoz. További információ: Naplózás a tárolóba felügyelt identitás hitelesítésével
properties.storageAccountSubscriptionId	string	Megadja a Blob Storage-előfizetés azonosítóját.
properties.storageEndpoint	string	Megadja a blobtároló végpontját (pl. https://MyAccount.blob.core.windows.net). Ha az állapot Engedélyezve, akkor a storageEndpoint vagy azAzureMonitorTargetEnabled szükséges.
type	string	Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ExtendedSqlPoolBlobAuditingPolicyListResult

Az SQL-készlet bővített naplózási beállításainak listája.

Name	Típus	Description
nextLink	string	Hivatkozás az eredmények következő oldalának lekéréséhez.
value	ExtendedSqlPoolBlobAuditingPolicy[]	Eredmények tömbje.