Get-AzureRmSqlServerAuditingPolicy

NAME Get-AzureRmSqlServerAuditingPolicy



SYNOPSIS

Gets the auditing policy of a SQL server.





SYNTAX

Get-AzureRmSqlServerAuditingPolicy [-ResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] -ServerName <String> [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmSqlServerAuditingPolicy cmdlet gets the auditing policy of an Azure SQL server. Specify the ResourceGroupName , ServerName , and

DatabaseName parameters to identify the database. This cmdlet returns a policy that is used by the Azure SQL databases that are both defined in

the specified Azure SQL server and use its auditing policy.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of the resource group to which the Azure SQL server is assigned.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ServerName <String>

Specifies the name of the Azure SQL server for which this cmdlet gets the auditing policy.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.Sql.Security.Model.ServerAuditingPolicyModel







NOTES









Example 1: Get the auditing policy of an Azure SQL server with Table auditing defined on it



PS C:\\>Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01"

EventType : {PlainSQL_Success, PlainSQL_Failure, ParameterizedSQL_Success, ParameterizedSQL_Failure...}

TableIdentifier : MyAuditTableName

FullAuditLogsTableName : SQLDBAuditLogsMyAuditTableName

ResourceGroupName : resourcegroup01

ServerName : server01

AuditType : Table

AuditState : Enabled

StorageAccountName : mystorage

StorageKeyType : Primary

RetentionInDays : 0









Example 2: Get the auditing policy of an Azure SQL server with Blob auditing defined on it



PS C:\\>Get-AzureRmSqlServerAuditingPolicy -ResourceGroupName "resourcegroup01" -ServerName "server01"

AuditActionGroup : {SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP, FAILED_DATABASE_AUTHENTICATION_GROUP,

BATCH_COMPLETED_GROUP, ...}

ResourceGroupName : resourcegroup01

ServerName : server01

AuditType : Blob

AuditState : Enabled

StorageAccountName : mystorage

StorageKeyType : Primary

RetentionInDays : 0











RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... tingpolicy

Set-AzureRmSqlServerAuditingPolicy

Use-AzureRmSqlServerAuditingPolicy

SQL Database Documentation https://docs.microsoft.com/azure/sql-database/