通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzSynapseSqlAuditSetting

  • 参考
模块:
Az.Synapse

更改 Azure Synapse Analytics 工作区的审核设置。

语法

Set-AzSynapseSqlAuditSetting
   [-AuditActionGroup <AuditActionGroups[]>]
   [-PredicateExpression <String>]
   [-StorageKeyType <String>]
   [-RetentionInDays <UInt32>]
   [-BlobStorageTargetState <String>]
   [-StorageAccountResourceId <String>]
   [-EventHubTargetState <String>]
   [-EventHubName <String>]
   [-EventHubAuthorizationRuleResourceId <String>]
   [-LogAnalyticsTargetState <String>]
   [-WorkspaceResourceId <String>]
   [-PassThru]
   [[-ResourceGroupName] <String>]
   [-WorkspaceName] <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSynapseSqlAuditSetting
   [-AuditActionGroup <AuditActionGroups[]>]
   [-PredicateExpression <String>]
   [-StorageKeyType <String>]
   [-RetentionInDays <UInt32>]
   [-BlobStorageTargetState <String>]
   [-StorageAccountResourceId <String>]
   [-EventHubTargetState <String>]
   [-EventHubName <String>]
   [-EventHubAuthorizationRuleResourceId <String>]
   [-LogAnalyticsTargetState <String>]
   [-WorkspaceResourceId <String>]
   [-PassThru]
   -WorkspaceObject <PSSynapseWorkspace>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzSynapseSqlAuditSetting
   [-AuditActionGroup <AuditActionGroups[]>]
   [-PredicateExpression <String>]
   [-StorageKeyType <String>]
   [-RetentionInDays <UInt32>]
   [-BlobStorageTargetState <String>]
   [-StorageAccountResourceId <String>]
   [-EventHubTargetState <String>]
   [-EventHubName <String>]
   [-EventHubAuthorizationRuleResourceId <String>]
   [-LogAnalyticsTargetState <String>]
   [-WorkspaceResourceId <String>]
   [-PassThru]
   -ResourceId <String>
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

说明

Set-AzSynapseSqlAuditSetting cmdlet 更改 Azure Synapse Analytics 工作区的审核设置。 当 blob 存储是审核日志的目标时，请指定 StorageAccountResourceId 参数来确定审核日志的存储帐户，以及用于定义存储密钥的 StorageKeyType 参数。 还可以通过设置 RetentionInDays 参数的值来定义审核日志的保留期。

示例

示例 1

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -StorageKeyType Primary

启用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的 Blob 存储审核策略。

示例 2

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Disabled

禁用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的 Blob 存储审核策略。

示例 3

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -StorageKeyType Primary -PredicateExpression "statement <> 'select 1'"

启用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的 Blob 存储审核策略，并使用 T-SQL 谓词进行高级筛选。

示例 4

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -PredicateExpression ""

从名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的审核策略中删除高级筛选设置。

示例 5

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId"

启用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的事件中心审核策略。

示例 6

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -EventHubTargetState Disabled

禁用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的事件中心审核策略。

示例 7

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/myworkspace"

启用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的 Log Analytics 审核策略。

示例 8

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -LogAnalyticsTargetState Disabled

禁用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的 Log Analytics 审核策略。

示例 9

Get-AzSynapseWorkspace -Name ContosoWorkspace | Set-AzSynapseSqlAuditSetting -BlobStorageTargetState Disabled

通过管道禁用名为 ContosoWorkspace 的 Azure Synapse Analytics 工作区的 Blob 存储审核策略。

示例 10

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -LogAnalyticsTargetState Enabled -WorkspaceResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/myworkspace" -BlobStorageTargetState Disabled

禁用将 Azure Synapse Analytics 工作区的审核记录发送到 Blob 存储，并启用将其发送到 Log Analytics。

示例 11

Set-AzSynapseSqlAuditSetting -WorkspaceName ContosoWorkspace -BlobStorageTargetState Enabled -StorageAccountResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourcegroup01/providers/Microsoft.Storage/storageAccounts/mystorage" -EventHubTargetState Enabled -EventHubName "EventHubName" -EventHubAuthorizationRuleResourceId "EventHubAuthorizationRuleResourceId" -LogAnalyticsTargetState Enabled  -WorkspaceResourceId "/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2"

启用将 Azure Synapse Analytics 工作区的审核记录发送到 Blob 存储、事件中心和日志分析。

参数

-AsJob

在后台运行 cmdlet

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-AuditActionGroup

建议使用的操作组集是以下组合 - 这将审核针对数据库执行的所有查询和存储过程，以及成功和失败的登录：

“BATCH_COMPLETED_GROUP”，

“SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP”，

“FAILED_DATABASE_AUTHENTICATION_GROUP”

上述组合也是默认配置的集。 这些组涵盖针对数据库执行的所有 SQL 语句和存储过程，不应与其他组结合使用，因为这将导致重复的审核日志。

有关详细信息，请参阅 https://learn.microsoft.com/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups。

类型:AuditActionGroups[]
接受的值:BATCH_STARTED_GROUP, BATCH_COMPLETED_GROUP, 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
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-BlobStorageTargetState

指示 Blob 存储是否是审核记录的目标。

类型:String
接受的值:Enabled, Disabled
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EventHubAuthorizationRuleResourceId

事件中心授权规则的资源 ID

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EventHubName

事件中心的名称。 如果在提供 EventHubAuthorizationRuleResourceId 时未指定任何内容，则会选择默认事件中心。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-EventHubTargetState

指示事件中心是否是审核记录的目标。

类型:String
接受的值:Enabled, Disabled
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-LogAnalyticsTargetState

指示 Log Analytics 是否是审核记录的目标。

类型:String
接受的值:Enabled, Disabled
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PassThru

默认情况下，此 Cmdlet 不返回对象。 如果指定了此开关，则如果成功，则返回 true。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-PredicateExpression

用于筛选审核日志的 T-SQL 谓词（WHERE 子句）。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

资源组名称。

类型:String
Position:0
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceId

Synapse 工作区的资源标识符。

类型:String
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-RetentionInDays

审核日志的保留天数。

类型:Nullable<T>[UInt32]
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-StorageAccountResourceId

存储帐户资源 ID

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-StorageKeyType

指定要使用的存储访问密钥之一。

类型:String
接受的值:Primary, Secondary
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-WorkspaceName

Synapse 工作区的名称。

类型:String
Position:1
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-WorkspaceObject

工作区输入对象，通常通过管道传递。

类型:PSSynapseWorkspace
别名:InputObject
Position:Named
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-WorkspaceResourceId

要向其发送审核日志的 Log Analytics 工作区的工作区 ID（Log Analytics 工作区的资源 ID）。 示例：/subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

PSSynapseWorkspace

输出

Microsoft.Azure.Commands.Synapse.Models.WorkspaceAuditModel