Get-AzureRmSqlDatabaseAuditingPolicy

NAME Get-AzureRmSqlDatabaseAuditingPolicy



SYNOPSIS

Gets the auditing policy of a database.





SYNTAX

Get-AzureRmSqlDatabaseAuditingPolicy [-ResourceGroupName] <String> [-ServerName] <String> [-DatabaseName] <String> [-DefaultProfile

<IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Get-AzureRmSqlDatabaseAuditingPolicy cmdlet gets the auditing policy of an Azure SQL Database. To use the cmdlet, use the ResourceGroupName ,

ServerName , and DatabaseName parameters to identify the database.





PARAMETERS

-DatabaseName <String>

Specifies the name of the database.



Required? true

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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 database 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 server where the database is located.



Required? true

Position? 1

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.DatabaseAuditingPolicyModel







NOTES









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



PS C:\\>Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"

DatabaseName : database01

UseServerDefault : Disabled

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 database with Blob auditing defined on it



PS C:\\>Get-AzureRmSqlDatabaseAuditingPolicy -ResourceGroupName "ResourceGroup01" -ServerName "Server01" -DatabaseName "Database01"

DatabaseName : database01

AuditAction : {}

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

Remove-AzureRmSqlDatabaseAuditing

Set-AzureRmSqlDatabaseAuditingPolicy