Microsoft.Synapse-Arbeitsbereiche/sqlPools/auditingSettings

Bicep-Ressourcendefinition

Der Ressourcentyp "workspaces/sqlPools/auditingSettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.Synapse/workspaces/sqlPools/auditingSettings-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01' = {
  parent: resourceSymbolicName
  name: 'default'
  properties: {
    auditActionsAndGroups: [
      'string'
    ]
    isAzureMonitorTargetEnabled: bool
    isStorageSecondaryKeyInUse: bool
    retentionDays: int
    state: 'string'
    storageAccountAccessKey: 'string'
    storageAccountSubscriptionId: 'string'
    storageEndpoint: 'string'
  }
}

Eigenschaftswerte

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Name Beschreibung Wert
Name Der Ressourcenname "default" (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.
Symbolischer Name für Ressource des Typs: Arbeitsbereiche/sqlPools
Eigenschaften Ressourceneigenschaften. SqlPoolBlobAuditingPolicyEigenschaften

SqlPoolBlobAuditingPolicyEigenschaften

Name Beschreibung Wert
auditActionsAndGroups Gibt die zu überwachenden Actions-Groups und Aktionen an.

Die empfohlene Gruppe von Aktionsgruppen ist die folgende Kombination : Dadurch werden alle Abfragen und gespeicherten Prozeduren überwacht, die für die Datenbank ausgeführt werden, sowie erfolgreiche und fehlgeschlagene Anmeldungen:

BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.

Diese oben genannte Kombination ist auch der Satz, der standardmäßig konfiguriert ist, wenn die Überwachung über das Azure-Portal aktiviert wird.

Die unterstützten Aktionsgruppen für die Überwachung sind (Hinweis: Wählen Sie nur bestimmte Gruppen aus, die Ihre Überwachungsanforderungen abdecken. Die Verwendung unnötiger Gruppen könnte zu sehr großen Mengen von Überwachungsdatensätzen führen:

ANWENDUNGSROLLE_PASSWORT_WECHSEL_GRUPPE
BACKUP_RESTORE_GROUP
DATENBANK_ABMELDE_GRUPPE
Datenbankobjekt-Änderungsgruppe
DATENBANK_OBJEKT_EIGENTÜMERSCHAFT_ÄNDERUNGSGRUPPE
Datenbankobjektberechtigungsänderungsgruppe
Datenbankbetriebsgruppe
DATENBANK_BERECHTIGUNGEN_GRUPPE_ÄNDERN
Datenbankhauptgruppenänderung
DATABASE_PRINCIPAL_IMPERSONATION_GRUPPE
Datenbankrollenmitgliederänderungsgruppe
FEHLGESCHLAGENE_DATENBANK_AUTHENTIFIZIERUNG_GRUPPE
SCHEMA_OBJEKT_ZUGRIFFSGRUPPE
Schema-Objekt-Änderungsgruppe
SCHEMA_OBJEKT_EIGENTUMSWECHSEL_GRUPPE
Schema-Objekt-Berechtigungsänderungsgruppe
ERFOLGREICHE_DATENBANK_AUTHENTIFIZIERUNGS_GRUPPE
USER_CHANGE_PASSWORD_GROUP
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP

Dies sind Gruppen, die alle sql-Anweisungen und gespeicherten Prozeduren abdecken, die für die Datenbank ausgeführt werden, und sollten nicht in Kombination mit anderen Gruppen verwendet werden, da dies zu doppelten Überwachungsprotokollen führt.

Weitere Informationen finden Sie unter Database-Level Überwachen von Aktionsgruppen.

Für die Datenbanküberwachungsrichtlinie können auch bestimmte Aktionen angegeben werden (beachten Sie, dass Aktionen für die Serverüberwachungsrichtlinie nicht angegeben werden können). Die unterstützten Aktionen für die Überwachung sind:
AUSWÄHLEN
AKTUALISIEREN
EINFÜGEN
LÖSCHEN
AUSFÜHREN
EMPFANGEN
REFERENZEN

Das allgemeine Formular zum Definieren einer zu überwachenden Aktion lautet:
{Aktion} ON {object} VON {principal}

Beachten Sie, dass <Objekt> im obigen Format auf ein Objekt wie eine Tabelle, Ansicht oder gespeicherte Prozedur oder eine gesamte Datenbank oder ein gesamtes Schema verweisen kann. In letzteren Fällen werden die Formulare DATABASE::{db_name} und SCHEMA::{schema_name} verwendet.

Zum Beispiel:
SELECT auf dbo.myTable von public
SELECT on DATABASE::myDatabase von public
SELECT on SCHEMA::mySchema von public

Weitere Informationen finden Sie unter Database-Level Überwachungsaktionen
string[]
isAzureMonitorTargetEnabled Gibt an, ob Überwachungsereignisse an Azure Monitor gesendet werden.
Um die Ereignisse an Azure Monitor zu senden, geben Sie "state" als "Enabled" und "isAzureMonitorTargetEnabled" als "true" an.

Bei Verwendung der REST-API zum Konfigurieren der Überwachung sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "SQLSecurityAuditEvents" in der Datenbank erstellt werden.
Beachten Sie, dass Sie für die Überwachung auf Serverebene die Datenbank "master" als {databaseName} verwenden sollten.

URI-Format der Diagnoseeinstellungen:
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

Weitere Informationen finden Sie unter REST-API für Diagnoseeinstellungen
oder Diagnoseeinstellungen powerShell-
Bool
isStorageSecondaryKeyInUse Gibt an, ob storageAccountAccessKey-Wert der Sekundärschlüssel des Speichers ist. Bool
retentionDays Gibt die Anzahl der Tage an, die in den Überwachungsprotokollen im Speicherkonto gespeichert werden sollen. Int
Zustand Gibt den Status der Richtlinie an. Wenn der Status aktiviert ist, sind "storageEndpoint" oder "isAzureMonitorTargetEnabled" erforderlich. "Deaktiviert"
"Aktiviert" (erforderlich)
storageAccountAccessKey Gibt den Bezeichnerschlüssel des Überwachungsspeicherkontos an. Wenn der Status "Enabled" ist und "storageEndpoint" angegeben ist, ist "storageAccountAccessKey" erforderlich. Schnur
storageAccountSubscriptionId Gibt die BLOB-Speicherabonnement-ID an. Schnur

Zwänge:
Min. Länge = 36
Maximale Länge = 36
Muster = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageEndpunkt Gibt den BLOB-Speicherendpunkt an (z. B. https://MyAccount.blob.core.windows.net). Wenn der Zustand aktiviert ist, ist "storageEndpoint" erforderlich. Schnur

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "workspaces/sqlPools/auditingSettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Verwendungsbeispiele

Ressourcenformat

Um eine Microsoft.Synapse/workspaces/sqlPools/auditingSettings-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings",
  "apiVersion": "2021-06-01",
  "name": "string",
  "properties": {
    "auditActionsAndGroups": [ "string" ],
    "isAzureMonitorTargetEnabled": "bool",
    "isStorageSecondaryKeyInUse": "bool",
    "retentionDays": "int",
    "state": "string",
    "storageAccountAccessKey": "string",
    "storageAccountSubscriptionId": "string",
    "storageEndpoint": "string"
  }
}

Eigenschaftswerte

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2021-06-01'
Name Der Ressourcenname "default" (erforderlich)
Eigenschaften Ressourceneigenschaften. SqlPoolBlobAuditingPolicyEigenschaften
Art Der Ressourcentyp 'Microsoft.Synapse/workspaces/sqlPools/auditingSettings'

SqlPoolBlobAuditingPolicyEigenschaften

Name Beschreibung Wert
auditActionsAndGroups Gibt die zu überwachenden Actions-Groups und Aktionen an.

Die empfohlene Gruppe von Aktionsgruppen ist die folgende Kombination : Dadurch werden alle Abfragen und gespeicherten Prozeduren überwacht, die für die Datenbank ausgeführt werden, sowie erfolgreiche und fehlgeschlagene Anmeldungen:

BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.

Diese oben genannte Kombination ist auch der Satz, der standardmäßig konfiguriert ist, wenn die Überwachung über das Azure-Portal aktiviert wird.

Die unterstützten Aktionsgruppen für die Überwachung sind (Hinweis: Wählen Sie nur bestimmte Gruppen aus, die Ihre Überwachungsanforderungen abdecken. Die Verwendung unnötiger Gruppen könnte zu sehr großen Mengen von Überwachungsdatensätzen führen:

ANWENDUNGSROLLE_PASSWORT_WECHSEL_GRUPPE
BACKUP_RESTORE_GROUP
DATENBANK_ABMELDE_GRUPPE
Datenbankobjekt-Änderungsgruppe
DATENBANK_OBJEKT_EIGENTÜMERSCHAFT_ÄNDERUNGSGRUPPE
Datenbankobjektberechtigungsänderungsgruppe
Datenbankbetriebsgruppe
DATENBANK_BERECHTIGUNGEN_GRUPPE_ÄNDERN
Datenbankhauptgruppenänderung
DATABASE_PRINCIPAL_IMPERSONATION_GRUPPE
Datenbankrollenmitgliederänderungsgruppe
FEHLGESCHLAGENE_DATENBANK_AUTHENTIFIZIERUNG_GRUPPE
SCHEMA_OBJEKT_ZUGRIFFSGRUPPE
Schema-Objekt-Änderungsgruppe
SCHEMA_OBJEKT_EIGENTUMSWECHSEL_GRUPPE
Schema-Objekt-Berechtigungsänderungsgruppe
ERFOLGREICHE_DATENBANK_AUTHENTIFIZIERUNGS_GRUPPE
USER_CHANGE_PASSWORD_GROUP
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP

Dies sind Gruppen, die alle sql-Anweisungen und gespeicherten Prozeduren abdecken, die für die Datenbank ausgeführt werden, und sollten nicht in Kombination mit anderen Gruppen verwendet werden, da dies zu doppelten Überwachungsprotokollen führt.

Weitere Informationen finden Sie unter Database-Level Überwachen von Aktionsgruppen.

Für die Datenbanküberwachungsrichtlinie können auch bestimmte Aktionen angegeben werden (beachten Sie, dass Aktionen für die Serverüberwachungsrichtlinie nicht angegeben werden können). Die unterstützten Aktionen für die Überwachung sind:
AUSWÄHLEN
AKTUALISIEREN
EINFÜGEN
LÖSCHEN
AUSFÜHREN
EMPFANGEN
REFERENZEN

Das allgemeine Formular zum Definieren einer zu überwachenden Aktion lautet:
{Aktion} ON {object} VON {principal}

Beachten Sie, dass <Objekt> im obigen Format auf ein Objekt wie eine Tabelle, Ansicht oder gespeicherte Prozedur oder eine gesamte Datenbank oder ein gesamtes Schema verweisen kann. In letzteren Fällen werden die Formulare DATABASE::{db_name} und SCHEMA::{schema_name} verwendet.

Zum Beispiel:
SELECT auf dbo.myTable von public
SELECT on DATABASE::myDatabase von public
SELECT on SCHEMA::mySchema von public

Weitere Informationen finden Sie unter Database-Level Überwachungsaktionen
string[]
isAzureMonitorTargetEnabled Gibt an, ob Überwachungsereignisse an Azure Monitor gesendet werden.
Um die Ereignisse an Azure Monitor zu senden, geben Sie "state" als "Enabled" und "isAzureMonitorTargetEnabled" als "true" an.

Bei Verwendung der REST-API zum Konfigurieren der Überwachung sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "SQLSecurityAuditEvents" in der Datenbank erstellt werden.
Beachten Sie, dass Sie für die Überwachung auf Serverebene die Datenbank "master" als {databaseName} verwenden sollten.

URI-Format der Diagnoseeinstellungen:
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

Weitere Informationen finden Sie unter REST-API für Diagnoseeinstellungen
oder Diagnoseeinstellungen powerShell-
Bool
isStorageSecondaryKeyInUse Gibt an, ob storageAccountAccessKey-Wert der Sekundärschlüssel des Speichers ist. Bool
retentionDays Gibt die Anzahl der Tage an, die in den Überwachungsprotokollen im Speicherkonto gespeichert werden sollen. Int
Zustand Gibt den Status der Richtlinie an. Wenn der Status aktiviert ist, sind "storageEndpoint" oder "isAzureMonitorTargetEnabled" erforderlich. "Deaktiviert"
"Aktiviert" (erforderlich)
storageAccountAccessKey Gibt den Bezeichnerschlüssel des Überwachungsspeicherkontos an. Wenn der Status "Enabled" ist und "storageEndpoint" angegeben ist, ist "storageAccountAccessKey" erforderlich. Schnur
storageAccountSubscriptionId Gibt die BLOB-Speicherabonnement-ID an. Schnur

Zwänge:
Min. Länge = 36
Maximale Länge = 36
Muster = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageEndpunkt Gibt den BLOB-Speicherendpunkt an (z. B. https://MyAccount.blob.core.windows.net). Wenn der Zustand aktiviert ist, ist "storageEndpoint" erforderlich. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "workspaces/sqlPools/auditingSettings" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Change Log.

Ressourcenformat

Um eine Microsoft.Synapse/workspaces/sqlPools/auditingSettings-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      auditActionsAndGroups = [
        "string"
      ]
      isAzureMonitorTargetEnabled = bool
      isStorageSecondaryKeyInUse = bool
      retentionDays = int
      state = "string"
      storageAccountAccessKey = "string"
      storageAccountSubscriptionId = "string"
      storageEndpoint = "string"
    }
  }
}

Eigenschaftswerte

Microsoft.Synapse/workspaces/sqlPools/auditingSettings

Name Beschreibung Wert
Name Der Ressourcenname "default" (erforderlich)
Eltern-ID Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: Arbeitsbereiche/sqlPools
Eigenschaften Ressourceneigenschaften. SqlPoolBlobAuditingPolicyEigenschaften
Art Der Ressourcentyp "Microsoft.Synapse/workspaces/sqlPools/auditingSettings@2021-06-01"

SqlPoolBlobAuditingPolicyEigenschaften

Name Beschreibung Wert
auditActionsAndGroups Gibt die zu überwachenden Actions-Groups und Aktionen an.

Die empfohlene Gruppe von Aktionsgruppen ist die folgende Kombination : Dadurch werden alle Abfragen und gespeicherten Prozeduren überwacht, die für die Datenbank ausgeführt werden, sowie erfolgreiche und fehlgeschlagene Anmeldungen:

BATCH_COMPLETED_GROUP,
SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,
FAILED_DATABASE_AUTHENTICATION_GROUP.

Diese oben genannte Kombination ist auch der Satz, der standardmäßig konfiguriert ist, wenn die Überwachung über das Azure-Portal aktiviert wird.

Die unterstützten Aktionsgruppen für die Überwachung sind (Hinweis: Wählen Sie nur bestimmte Gruppen aus, die Ihre Überwachungsanforderungen abdecken. Die Verwendung unnötiger Gruppen könnte zu sehr großen Mengen von Überwachungsdatensätzen führen:

ANWENDUNGSROLLE_PASSWORT_WECHSEL_GRUPPE
BACKUP_RESTORE_GROUP
DATENBANK_ABMELDE_GRUPPE
Datenbankobjekt-Änderungsgruppe
DATENBANK_OBJEKT_EIGENTÜMERSCHAFT_ÄNDERUNGSGRUPPE
Datenbankobjektberechtigungsänderungsgruppe
Datenbankbetriebsgruppe
DATENBANK_BERECHTIGUNGEN_GRUPPE_ÄNDERN
Datenbankhauptgruppenänderung
DATABASE_PRINCIPAL_IMPERSONATION_GRUPPE
Datenbankrollenmitgliederänderungsgruppe
FEHLGESCHLAGENE_DATENBANK_AUTHENTIFIZIERUNG_GRUPPE
SCHEMA_OBJEKT_ZUGRIFFSGRUPPE
Schema-Objekt-Änderungsgruppe
SCHEMA_OBJEKT_EIGENTUMSWECHSEL_GRUPPE
Schema-Objekt-Berechtigungsänderungsgruppe
ERFOLGREICHE_DATENBANK_AUTHENTIFIZIERUNGS_GRUPPE
USER_CHANGE_PASSWORD_GROUP
BATCH_STARTED_GROUP
BATCH_COMPLETED_GROUP

Dies sind Gruppen, die alle sql-Anweisungen und gespeicherten Prozeduren abdecken, die für die Datenbank ausgeführt werden, und sollten nicht in Kombination mit anderen Gruppen verwendet werden, da dies zu doppelten Überwachungsprotokollen führt.

Weitere Informationen finden Sie unter Database-Level Überwachen von Aktionsgruppen.

Für die Datenbanküberwachungsrichtlinie können auch bestimmte Aktionen angegeben werden (beachten Sie, dass Aktionen für die Serverüberwachungsrichtlinie nicht angegeben werden können). Die unterstützten Aktionen für die Überwachung sind:
AUSWÄHLEN
AKTUALISIEREN
EINFÜGEN
LÖSCHEN
AUSFÜHREN
EMPFANGEN
REFERENZEN

Das allgemeine Formular zum Definieren einer zu überwachenden Aktion lautet:
{Aktion} ON {object} VON {principal}

Beachten Sie, dass <Objekt> im obigen Format auf ein Objekt wie eine Tabelle, Ansicht oder gespeicherte Prozedur oder eine gesamte Datenbank oder ein gesamtes Schema verweisen kann. In letzteren Fällen werden die Formulare DATABASE::{db_name} und SCHEMA::{schema_name} verwendet.

Zum Beispiel:
SELECT auf dbo.myTable von public
SELECT on DATABASE::myDatabase von public
SELECT on SCHEMA::mySchema von public

Weitere Informationen finden Sie unter Database-Level Überwachungsaktionen
string[]
isAzureMonitorTargetEnabled Gibt an, ob Überwachungsereignisse an Azure Monitor gesendet werden.
Um die Ereignisse an Azure Monitor zu senden, geben Sie "state" als "Enabled" und "isAzureMonitorTargetEnabled" als "true" an.

Bei Verwendung der REST-API zum Konfigurieren der Überwachung sollten auch Diagnoseeinstellungen mit der Diagnoseprotokollkategorie "SQLSecurityAuditEvents" in der Datenbank erstellt werden.
Beachten Sie, dass Sie für die Überwachung auf Serverebene die Datenbank "master" als {databaseName} verwenden sollten.

URI-Format der Diagnoseeinstellungen:
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

Weitere Informationen finden Sie unter REST-API für Diagnoseeinstellungen
oder Diagnoseeinstellungen powerShell-
Bool
isStorageSecondaryKeyInUse Gibt an, ob storageAccountAccessKey-Wert der Sekundärschlüssel des Speichers ist. Bool
retentionDays Gibt die Anzahl der Tage an, die in den Überwachungsprotokollen im Speicherkonto gespeichert werden sollen. Int
Zustand Gibt den Status der Richtlinie an. Wenn der Status aktiviert ist, sind "storageEndpoint" oder "isAzureMonitorTargetEnabled" erforderlich. "Deaktiviert"
"Aktiviert" (erforderlich)
storageAccountAccessKey Gibt den Bezeichnerschlüssel des Überwachungsspeicherkontos an. Wenn der Status "Enabled" ist und "storageEndpoint" angegeben ist, ist "storageAccountAccessKey" erforderlich. Schnur
storageAccountSubscriptionId Gibt die BLOB-Speicherabonnement-ID an. Schnur

Zwänge:
Min. Länge = 36
Maximale Länge = 36
Muster = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$
storageEndpunkt Gibt den BLOB-Speicherendpunkt an (z. B. https://MyAccount.blob.core.windows.net). Wenn der Zustand aktiviert ist, ist "storageEndpoint" erforderlich. Schnur