Get-AzureRmSqlServerAuditing

Gets the auditing settings of an Azure SQL server.

Caution

The AzureRM PowerShell module will retire on 29 February 2024. For more information, see Migrate Azure PowerShell from AzureRM to Az.

Retirement indicates that the AzureRM PowerShell module will be deprecated, subsequently ceasing to receive support. While this does not inherently mean the module will stop functioning, its use beyond 29 February 2024 will be at the user's discretion and risk, as it will no longer be maintained or updated.

Syntax

Get-AzureRmSqlServerAuditing
   [-ServerName] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-AzureRmSqlServerAuditing cmdlet gets the blob auditing policy of an Azure SQL server. Specify the ResourceGroupName and ServerName parameters to identify the database. This cmdlet returns a policy that is used by the Azure SQL databases that are defined in the specified Azure SQL server.

Examples

Example 1: Get the auditing settings of an Azure SQL server

PS C:\>Get-AzureRmSqlServerAuditing -ResourceGroupName "resourcegroup01" -ServerName "server01"
AuditActionGroup             : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,
                                BATCH_COMPLETED_GROUP, ...}
ResourceGroupName            : resourcegroup01
ServerName                   : server01
AuditState                   : Enabled
StorageAccountName           : mystorage
StorageKeyType               : Primary
RetentionInDays              : 0
StorageAccountSubscriptionId : 7fe3301d-31d3-4668-af5e-211a890ba6e3
PredicateExpression			 : statement <> 'select 1'

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The name of the resource group.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ServerName

SQL server name.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

ServerBlobAuditingSettingsModel