Server DevOps Audit Settings - Create Or Update

Ссылка

Служба:: SQL Database

Версия API:: 2023-08-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
devOpsAuditingSettingsName	path	True	DevOpsAuditingSettingsName
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API, используемая для запроса.

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

Имя	Обязательно	Тип	Описание
properties.state	True	BlobAuditingPolicyState	Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.
properties.isAzureMonitorTargetEnabled		boolean	Указывает, отправляются ли события аудита DevOps в Azure Monitor. Чтобы отправить события в Azure Monitor, укажите "Состояние" как "Включено" и "IsAzureMonitorTargetEnabled" как true. При использовании REST API для настройки аудита DevOps необходимо также создать параметры диагностики с категорией журналов диагностики DevOpsOperationsAudit в базе данных master. Формат URI URI параметров диагностики: 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 Дополнительные сведения см. в разделе параметры диагностики REST API или параметров диагностики PowerShell
properties.isManagedIdentityInUse		boolean	Указывает, используется ли управляемое удостоверение для доступа к хранилищу BLOB-объектов
properties.storageAccountAccessKey		string	Указывает ключ идентификатора учетной записи хранения аудита. Если задано состояние "Включено" и storageEndpoint не указано, что storageAccountAccessKey будет использовать управляемое удостоверение, назначаемое системой SQL Server, для доступа к хранилищу. Необходимые условия для использования проверки подлинности управляемого удостоверения: Назначьте управляемое удостоверение, назначаемое системой, в Azure Active Directory (AAD). Предоставьте удостоверению SQL Server доступ к учетной записи хранения, добавив роль RBAC "Участник данных BLOB-объектов хранилища" в удостоверение сервера. Дополнительные сведения см. в статье Аудит хранилища с помощью проверки подлинности управляемого удостоверения
properties.storageAccountSubscriptionId		string (uuid)	Указывает идентификатор подписки хранилища BLOB-объектов.
properties.storageEndpoint		string	Указывает конечную точку хранилища BLOB-объектов (например, https://MyAccount.blob.core.windows.net). Если состояние включено, требуется storageEndpoint или isAzureMonitorTargetEnabled.

Ответы

Имя	Тип	Описание
200 OK	ServerDevOpsAuditingSettings	Успешно обновлены параметры аудита DevOps.
202 Accepted		Выполняется обновление параметров аудита DevOps. Заголовки Location: string
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра 400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра 400 InvalidServerDevOpsAuditSettingsCreateRequest — запрос политики аудита DevOps для создания сервера DevOps не существует или не имеет объекта свойств. 400 DataSecurityInvalidUserSuppliedParameter — недопустимое значение параметра было предоставлено клиентом. 400 InvalidServerDevOpsAuditSettingsName — недопустимое имя политики DevOps сервера. 400 DevOpsAuditInvalidStorageAccountCredentials — указанная учетная запись хранения или ключ доступа недопустимы. 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 OperationIdNotFound — операция с идентификатором не существует. 409 ServerDevOpsAuditSettingsInProgress. Настройка аудита DevOps сервера уже выполняется. 409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено. 409 OperationCancelled — операция отменена пользователем. 409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе. 429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 500 OperationTimedOut — время ожидания операции истекло и автоматически откатился. Повторите операцию. 503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Имя

Тип

Описание

200 OK

ServerDevOpsAuditingSettings

Успешно обновлены параметры аудита DevOps.

202 Accepted

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

Заголовки

Location: string

Other Status Codes

ErrorResponse

Ответы на ошибки: ***

400 ManagedInstanceStoppingOrStoppingOrStopped — конфликтующая операция, отправленная во время остановки или остановки экземпляра
400 ManagedInstanceStarting — конфликтующая операция, отправленная во время запуска экземпляра
400 InvalidServerDevOpsAuditSettingsCreateRequest — запрос политики аудита DevOps для создания сервера DevOps не существует или не имеет объекта свойств.
400 DataSecurityInvalidUserSuppliedParameter — недопустимое значение параметра было предоставлено клиентом.
400 InvalidServerDevOpsAuditSettingsName — недопустимое имя политики DevOps сервера.
400 DevOpsAuditInvalidStorageAccountCredentials — указанная учетная запись хранения или ключ доступа недопустимы.
404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 OperationIdNotFound — операция с идентификатором не существует.
409 ServerDevOpsAuditSettingsInProgress. Настройка аудита DevOps сервера уже выполняется.
409 CannotCancelOperation — операция управления находится в состоянии, которое не может быть отменено.
409 OperationCancelled — операция отменена пользователем.
409 Operation Прервана — операция с ресурсом не удалось завершить, так как она была прервана другой операцией в том же ресурсе.
429 SubscriptionTooManyCreateUpdateRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.
429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.
500 OperationTimedOut — время ожидания операции истекло и автоматически откатился. Повторите операцию.
503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Примеры

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=2023-08-01

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

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

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

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

Код состояния:: 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=2023-08-01

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

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

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

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

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

Определения

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

BlobAuditingPolicyState

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

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

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

createdByType

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

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

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

DevOpsAuditingSettingsName

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

Значение	Описание
Default

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

Сведения об ошибке.

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

ErrorResponse

Object

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

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

ServerDevOpsAuditingSettings

Object

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

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
properties.isAzureMonitorTargetEnabled	boolean	Указывает, отправляются ли события аудита DevOps в Azure Monitor. Чтобы отправить события в Azure Monitor, укажите "Состояние" как "Включено" и "IsAzureMonitorTargetEnabled" как true. При использовании REST API для настройки аудита DevOps необходимо также создать параметры диагностики с категорией журналов диагностики DevOpsOperationsAudit в базе данных master. Формат URI URI параметров диагностики: 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 Дополнительные сведения см. в разделе параметры диагностики REST API или параметров диагностики PowerShell
properties.isManagedIdentityInUse	boolean	Указывает, используется ли управляемое удостоверение для доступа к хранилищу BLOB-объектов
properties.state	BlobAuditingPolicyState	Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.
properties.storageAccountAccessKey	string	Указывает ключ идентификатора учетной записи хранения аудита. Если задано состояние "Включено" и storageEndpoint не указано, что storageAccountAccessKey будет использовать управляемое удостоверение, назначаемое системой SQL Server, для доступа к хранилищу. Необходимые условия для использования проверки подлинности управляемого удостоверения: Назначьте управляемое удостоверение, назначаемое системой, в Azure Active Directory (AAD). Предоставьте удостоверению SQL Server доступ к учетной записи хранения, добавив роль RBAC "Участник данных BLOB-объектов хранилища" в удостоверение сервера. Дополнительные сведения см. в статье Аудит хранилища с помощью проверки подлинности управляемого удостоверения
properties.storageAccountSubscriptionId	string (uuid)	Указывает идентификатор подписки хранилища BLOB-объектов.
properties.storageEndpoint	string	Указывает конечную точку хранилища BLOB-объектов (например, https://MyAccount.blob.core.windows.net). Если состояние включено, требуется storageEndpoint или isAzureMonitorTargetEnabled.
systemData	systemData	SystemData of ServerDevOpsAuditSettingsResource.
type	string	Тип ресурса.

systemData

Object

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

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

Поделиться через

Server DevOps Audit Settings - Create Or Update

Параметры URI

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

Ответы

Примеры

Update a server's DevOps audit settings with all params

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

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

Update a server's DevOps audit settings with minimal input

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

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

Определения

BlobAuditingPolicyState

createdByType

DevOpsAuditingSettingsName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ServerDevOpsAuditingSettings

systemData

Дополнительные ресурсы