Server DevOps Audit Settings - Create Or Update

Служба:: SQL Database

Версия API:: 2025-01-01

Создает или обновляет параметры аудита DevOps сервера.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings/Default?api-version=2025-01-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.state	True	BlobAuditingPolicyState	Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Указывает, отправляются ли события аудита DevOps в Azure Monitor. Чтобы отправить события в Azure Monitor, укажите 'State' как 'Enabled' и 'IsAzureMonitorTargetEnabled' как true. При использовании REST API для настройки аудита DevOps необходимо также создать параметры диагностики с категорией журналов диагностики DevOpsOperationsAudit в базе данных master. Диагностические настройки URI формат: PUT `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Майкрософт.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Дополнительные сведения см. в разделе параметры диагностики REST API или параметров диагностики PowerShell
properties.isManagedIdentityInUse		boolean	Указывает, используется ли управляемое удостоверение для доступа к хранилищу BLOB-объектов
properties.storageAccountAccessKey		string (password)	Указывает ключ идентификатора учетной записи хранения аудита. Если задано состояние "Включено" и storageEndpoint не указано, что storageAccountAccessKey будет использовать управляемое удостоверение, назначаемое системой SQL Server, для доступа к хранилищу. Необходимые условия для использования проверки подлинности управляемого удостоверения: Присвоите SQL Server управляемую идентичность, назначенную системой, в Azure Active Directory (AAD). Предоставьте доступ SQL Server к аккаунту хранения, добавив роль RBAC 'Storage Blob Data Contributor' к идентификатору сервера. Дополнительные сведения см. в статье Аудит хранилища с помощью проверки подлинности управляемого удостоверения
properties.storageAccountSubscriptionId		string (uuid)	Указывает идентификатор подписки хранилища BLOB-объектов.
properties.storageEndpoint		string	Указывает конечную точку хранилища BLOB-объектов (например, `https://MyAccount.blob.core.windows.net`). Если состояние включено, требуется storageEndpoint или isAzureMonitorTargetEnabled.

Ответы

Имя	Тип	Описание
200 OK	ServerDevOpsAuditingSettings	Операция обновления ресурса 'ServerDevOpsAuditingSettings' успешно
202 Accepted		Операция ресурса принята. Заголовки Azure-AsyncOperation: string Location: string
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Имя

Тип

Описание

200 OK

ServerDevOpsAuditingSettings

Операция обновления ресурса 'ServerDevOpsAuditingSettings' успешно

202 Accepted

Операция ресурса принята.

Заголовки

Azure-AsyncOperation: string
Location: string

Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update a server's DevOps audit settings with all params

Update a server's DevOps audit settings with minimal input

Update a server's DevOps audit settings with all params

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/Default?api-version=2025-01-01

{
  "properties": {
    "isAzureMonitorTargetEnabled": true,
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Пример ответа

Код состояния:: 200

{
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "properties": {
    "isAzureMonitorTargetEnabled": true,
    "state": "Enabled",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Код состояния:: 202

Update a server's DevOps audit settings with minimal input

Образец запроса

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/Default?api-version=2025-01-01

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Пример ответа

Код состояния:: 200

{
  "name": "Default",
  "type": "Microsoft.Sql/servers/devOpsAuditingSettings",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/devAuditTestRG/providers/Microsoft.Sql/servers/devOpsAuditTestSvr/devOpsAuditingSettings/default",
  "properties": {
    "state": "Enabled",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Код состояния:: 202

Определения

Имя	Описание
BlobAuditingPolicyState	Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.
createdByType	Тип удостоверения, создавшего ресурс.
DevOpsAuditingSettingsName
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
ServerDevOpsAuditingSettings	Параметры аудита DevOps сервера.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

BlobAuditingPolicyState

Перечисление

Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.

Значение	Описание
Enabled	Enabled
Disabled	Disabled

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Перечисление

Значение	Описание
Default	По умолчанию

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ServerDevOpsAuditingSettings

Объект

Параметры аудита DevOps сервера.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.isAzureMonitorTargetEnabled	boolean	Указывает, отправляются ли события аудита DevOps в Azure Monitor. Чтобы отправить события в Azure Monitor, укажите 'State' как 'Enabled' и 'IsAzureMonitorTargetEnabled' как true. При использовании REST API для настройки аудита DevOps необходимо также создать параметры диагностики с категорией журналов диагностики DevOpsOperationsAudit в базе данных master. Диагностические настройки URI формат: PUT `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Майкрософт.Sql/servers/{serverName}/databases/master/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview` Дополнительные сведения см. в разделе параметры диагностики REST API или параметров диагностики PowerShell
properties.isManagedIdentityInUse	boolean	Указывает, используется ли управляемое удостоверение для доступа к хранилищу BLOB-объектов
properties.state	BlobAuditingPolicyState	Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string (password)	Указывает ключ идентификатора учетной записи хранения аудита. Если задано состояние "Включено" и storageEndpoint не указано, что storageAccountAccessKey будет использовать управляемое удостоверение, назначаемое системой SQL Server, для доступа к хранилищу. Необходимые условия для использования проверки подлинности управляемого удостоверения: Присвоите SQL Server управляемую идентичность, назначенную системой, в Azure Active Directory (AAD). Предоставьте доступ SQL Server к аккаунту хранения, добавив роль RBAC 'Storage Blob Data Contributor' к идентификатору сервера. Дополнительные сведения см. в статье Аудит хранилища с помощью проверки подлинности управляемого удостоверения
properties.storageAccountSubscriptionId	string (uuid)	Указывает идентификатор подписки хранилища BLOB-объектов.
properties.storageEndpoint	string	Указывает конечную точку хранилища BLOB-объектов (например, `https://MyAccount.blob.core.windows.net`). Если состояние включено, требуется storageEndpoint или isAzureMonitorTargetEnabled.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.