Extended Sql Pool Blob Auditing Policies - List By Sql Pool

リファレンス

Service:: Synapse

API Version:: 2021-06-01

sql プールの拡張監査設定をListsします。

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
sqlPoolName	path	True	string	SQL プール名
subscriptionId	path	True	string	ターゲットサブスクリプションの ID。
workspaceName	path	True	string	ワークスペースの名前。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	ExtendedSqlPoolBlobAuditingPolicyListResult	データベースの拡張監査設定が正常に取得されました。
Other Status Codes		エラー応答: *** 400 BlobAuditingIsNotSupportedOnResourceType - BLOB 監査は現在、このリソースの種類ではサポートされていません。 404 SourceDatabaseNotFound - ソースデータベースが存在しません。 404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。 500 DatabaseIsUnavailable - 読み込みに失敗しました。後で再度お試しください。

名前

型

説明

200 OK

ExtendedSqlPoolBlobAuditingPolicyListResult

データベースの拡張監査設定が正常に取得されました。

Other Status Codes

エラー応答: ***

400 BlobAuditingIsNotSupportedOnResourceType - BLOB 監査は現在、このリソースの種類ではサポートされていません。
404 SourceDatabaseNotFound - ソースデータベースが存在しません。
404 DatabaseDoesNotExist - ユーザーがこのサーバーインスタンスに存在しないデータベース名を指定しました。
500 DatabaseIsUnavailable - 読み込みに失敗しました。後で再度お試しください。

例

List extended auditing settings of a database

Sample Request

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

/** 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

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

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

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
      }
    }
  ]
}

定義

名前	説明
BlobAuditingPolicyState	ポリシーの状態を指定します。 state が Enabled の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
ExtendedSqlPoolBlobAuditingPolicy	拡張 Sql プール BLOB 監査ポリシー。
ExtendedSqlPoolBlobAuditingPolicyListResult	SQL プールの拡張監査設定の一覧。

BlobAuditingPolicyState

ポリシーの状態を指定します。 state が Enabled の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。

名前	型	説明
Disabled	string
Enabled	string

ExtendedSqlPoolBlobAuditingPolicy

拡張 Sql プール BLOB 監査ポリシー。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.auditActionsAndGroups	string[]	監査する Actions-Groups とアクションを指定します。使用する推奨されるアクショングループのセットは次の組み合わせです。これにより、データベースに対して実行されたすべてのクエリとストアドプロシージャ、および成功したログインと失敗したログインが監査されます。 BATCH_COMPLETED_GROUP、SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP、FAILED_DATABASE_AUTHENTICATION_GROUP。上記の組み合わせは、Azure portalからの監査を有効にするときに既定で構成されるセットでもあります。監査するサポートされているアクショングループはです (注: 監査のニーズをカバーする特定のグループのみを選択してください。不要なグループを使用すると、非常に大量の監査レコードが発生する可能性があります。 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 これらは、データベースに対して実行されるすべての sql ステートメントとストアドプロシージャを対象とするグループであり、監査ログが重複するため、他のグループと組み合わせて使用しないでください。詳細については、「データベースレベルの監査アクショングループ」を参照してください。データベース監査ポリシーでは、特定のアクションを指定することもできます (サーバー監査ポリシーにはアクションを指定できないことに注意してください)。監査でサポートされているアクションは次のとおりです。SELECT UPDATE INSERT DELETE EXECUTE RECEIVE REFERENCES 監査するアクションを定義するための一般的な形式は、{action} ON {object} BY {principal} です。上記の形式では、テーブル、ビュー、ストアドプロシージャなどのオブジェクト、またはデータベースまたはスキーマ全体を参照できることに注意してください。後者の場合は、それぞれ DATABASE::{db_name} と SCHEMA::{schema_name} という形式が使用されます。例: DBo.myTable by public SELECT on DATABASE::myDatabase by public SELECT on SCHEMA::mySchema by public 詳細については、「データベースレベルの監査アクション」を参照してください。
properties.isAzureMonitorTargetEnabled	boolean	監査イベントを Azure Monitor に送信するかどうかを指定します。イベントを Azure Monitor に送信するには、'state' を 'Enabled' に、'isAzureMonitorTargetEnabled' を true に指定します。 REST API を使用して監査を構成する場合は、データベースに "SQLSecurityAuditEvents" 診断ログカテゴリを含む診断設定も作成する必要があります。サーバーレベルの監査では、'master' データベースを {databaseName} として使用する必要があることに注意してください。診断設定 URI 形式: 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 詳細については、「診断設定 REST API」または「診断設定 PowerShell」を参照してください。
properties.isStorageSecondaryKeyInUse	boolean	storageAccountAccessKey 値がストレージのセカンダリキーかどうかを指定します。
properties.predicateExpression	string	監査の作成時に where 句の条件を指定します。
properties.queueDelayMs	integer	監査アクションの処理が強制されるまでの時間 (ミリ秒単位) を指定します。既定の最小値は 1000 (1 秒) です。最大値は 2,147,483,647 です。
properties.retentionDays	integer	ストレージアカウントの監査ログに保持する日数を指定します。
properties.state	BlobAuditingPolicyState	ポリシーの状態を指定します。 state が Enabled の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
properties.storageAccountAccessKey	string	監査ストレージアカウントの識別子キーを指定します。 state が Enabled で storageEndpoint が指定されている場合、storageAccountAccessKey を指定しないと、SQL Server システム割り当てマネージド ID を使用してストレージにアクセスします。マネージド ID 認証を使用するための前提条件: Azure Active Directory (AAD) でシステム割り当てマネージド ID SQL Server割り当てます。 "ストレージ BLOB データ共同作成者" RBAC ロールをサーバー ID に追加して、SQL Server ID にストレージアカウントへのアクセス権を付与します。詳細については、「マネージド ID 認証を使用したストレージへの監査」を参照してください。
properties.storageAccountSubscriptionId	string	BLOB ストレージサブスクリプション ID を指定します。
properties.storageEndpoint	string	BLOB ストレージエンドポイント (例: ) を指定します。 https://MyAccount.blob.core.windows.net state が Enabled の場合、storageEndpoint または isAzureMonitorTargetEnabled が必要です。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ExtendedSqlPoolBlobAuditingPolicyListResult

SQL プールの拡張監査設定の一覧。

名前	型	説明
nextLink	string	結果の次のページを取得するためのリンク。
value	ExtendedSqlPoolBlobAuditingPolicy[]	結果の配列。

Extended Sql Pool Blob Auditing Policies - List By Sql Pool

URI パラメーター

応答

例

List extended auditing settings of a database

Sample Request

Sample Response

定義

BlobAuditingPolicyState

ExtendedSqlPoolBlobAuditingPolicy

ExtendedSqlPoolBlobAuditingPolicyListResult

その他のリソース