Share via


SqlServerDevOpsAuditingSettingData Class

Definition

A class representing the SqlServerDevOpsAuditingSetting data model. A server DevOps auditing settings.

public class SqlServerDevOpsAuditingSettingData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Sql.SqlServerDevOpsAuditingSettingData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Sql.SqlServerDevOpsAuditingSettingData>
type SqlServerDevOpsAuditingSettingData = class
    inherit ResourceData
    interface IJsonModel<SqlServerDevOpsAuditingSettingData>
    interface IPersistableModel<SqlServerDevOpsAuditingSettingData>
Public Class SqlServerDevOpsAuditingSettingData
Inherits ResourceData
Implements IJsonModel(Of SqlServerDevOpsAuditingSettingData), IPersistableModel(Of SqlServerDevOpsAuditingSettingData)
Inheritance
SqlServerDevOpsAuditingSettingData
Implements

Constructors

SqlServerDevOpsAuditingSettingData()

Initializes a new instance of SqlServerDevOpsAuditingSettingData.

Properties

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
IsAzureMonitorTargetEnabled

Specifies whether DevOps audit events are sent to Azure Monitor. In order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.

When using REST API to configure DevOps audit, Diagnostic Settings with 'DevOpsOperationsAudit' diagnostic logs category on the master database should be also created.

Diagnostic Settings URI format: PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview

For more information, see Diagnostic Settings REST API or Diagnostic Settings PowerShell

IsManagedIdentityInUse

Specifies whether Managed Identity is used to access blob storage.

Name

The name of the resource.

(Inherited from ResourceData)
ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
State

Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.

StorageAccountAccessKey

Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, not specifying the storageAccountAccessKey will use SQL server system-assigned managed identity to access the storage. Prerequisites for using managed identity authentication:

  1. Assign SQL Server a system-assigned managed identity in Azure Active Directory (AAD).
  2. Grant SQL Server identity access to the storage account by adding 'Storage Blob Data Contributor' RBAC role to the server identity. For more information, see Auditing to storage using Managed Identity authentication
StorageAccountSubscriptionId

Specifies the blob storage subscription Id.

StorageEndpoint

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<SqlServerDevOpsAuditingSettingData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SqlServerDevOpsAuditingSettingData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SqlServerDevOpsAuditingSettingData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SqlServerDevOpsAuditingSettingData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SqlServerDevOpsAuditingSettingData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to