Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Use-AzureSqlServerAuditingSetting

Use-AzureSqlServerAuditingSetting

microsoft.azure.commands.sql.dll

Synopsis

Marks an Azure Sql database as using its server's auditing setting.

Syntax

Use-AzureSqlServerAuditingSetting [-DatabaseName] [-PassThru] [-ServerName] [-ResourceGroupName] [<CommonParameters>]

Detailed Description

The Use-AzureSqlServerAuditingSetting cmdlet marks an Azure Sql database as using its server's auditing setting. To use the cmdlet, use the ResourceGroupName, ServerName and DatabaseName parameters to identify the database.If no auditing setting was defined already for the database server, this cmdlet would fail.

It is important to note that this cmdlet can be executed only in Azure Resource Manager mode. To switch to that mode run: Switch-AzureMode AzureResourceManager

Parameters

-DatabaseName <String>

Specifies the name of the database. Wildcards are not permitted.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object describing the auditing setting as well as the database's identifiers (i.e., ResourceGroupName, ServerName and DatabaseName) when the cmdlet succeeds. By default, this cmdlet does not return any output.

Aliases

None

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-ServerName <String>

Specifies the name of the database server holding the database. Wildcards are not permitted.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

Specifies the name of the resource group of the database. Wildcards are not permitted.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Azure.Commands.Sql.Security.Model.AuditingPolicy

Notes

Examples