server_dev_ops_audit_settings

Creates, updates, deletes, gets or lists a server_dev_ops_audit_settings resource.

Overview

Name	server_dev_ops_audit_settings
Type	Resource
Id	azure.sql.server_dev_ops_audit_settings

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
isAzureMonitorTargetEnabled	boolean	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	boolean	Specifies whether Managed Identity is used to access blob storage.
state	string	Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageAccountAccessKey	string	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	string	Specifies the blob storage subscription Id.
storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net _). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
isAzureMonitorTargetEnabled	boolean	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	boolean	Specifies whether Managed Identity is used to access blob storage.
state	string	Specifies the state of the audit. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required. Required. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
storageAccountAccessKey	string	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	string	Specifies the blob storage subscription Id.
storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net _). If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled is required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, dev_ops_auditing_settings_name, subscription_id		Gets a server's DevOps audit settings.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists DevOps audit settings of a server.
create_or_update	insert	resource_group_name, server_name, dev_ops_auditing_settings_name, subscription_id		Creates or updates a server's DevOps audit settings.
create_or_update	replace	resource_group_name, server_name, dev_ops_auditing_settings_name, subscription_id		Creates or updates a server's DevOps audit settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dev_ops_auditing_settings_name	string	"Default" Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a server's DevOps audit settings.

SELECT
id,
name,
isAzureMonitorTargetEnabled,
isManagedIdentityInUse,
state,
storageAccountAccessKey,
storageAccountSubscriptionId,
storageEndpoint,
systemData,
type
FROM azure.sql.server_dev_ops_audit_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND dev_ops_auditing_settings_name = '{{ dev_ops_auditing_settings_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists DevOps audit settings of a server.

SELECT
id,
name,
isAzureMonitorTargetEnabled,
isManagedIdentityInUse,
state,
storageAccountAccessKey,
storageAccountSubscriptionId,
storageEndpoint,
systemData,
type
FROM azure.sql.server_dev_ops_audit_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a server's DevOps audit settings.

INSERT INTO azure.sql.server_dev_ops_audit_settings (
properties,
resource_group_name,
server_name,
dev_ops_auditing_settings_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ dev_ops_auditing_settings_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: server_dev_ops_audit_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the server_dev_ops_audit_settings resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the server_dev_ops_audit_settings resource.
  - name: dev_ops_auditing_settings_name
    value: "{{ dev_ops_auditing_settings_name }}"
    description: Required parameter for the server_dev_ops_audit_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the server_dev_ops_audit_settings resource.
  - name: properties
    description: |
      Resource properties.
    value:
      isAzureMonitorTargetEnabled: {{ isAzureMonitorTargetEnabled }}
      isManagedIdentityInUse: {{ isManagedIdentityInUse }}
      state: "{{ state }}"
      storageEndpoint: "{{ storageEndpoint }}"
      storageAccountAccessKey: "{{ storageAccountAccessKey }}"
      storageAccountSubscriptionId: "{{ storageAccountSubscriptionId }}"

REPLACE examples

create_or_update

Creates or updates a server's DevOps audit settings.

REPLACE azure.sql.server_dev_ops_audit_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND dev_ops_auditing_settings_name = '{{ dev_ops_auditing_settings_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;