Server DevOps Audit Settings - Create Or Update
Создает или обновляет параметры аудита DevOps сервера.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/devOpsAuditingSettings/Default?api-version=2023-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
dev
|
path | True | ||
resource
|
path | True |
string |
Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала. |
server
|
path | True |
string |
Имя сервера. |
subscription
|
path | True |
string |
Идентификатор подписки, идентифицирующий подписку Azure. |
api-version
|
query | True |
string |
Версия API, используемая для запроса. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
properties.state | True |
Указывает состояние аудита. Если состояние включено, необходимо использовать 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, для доступа к хранилищу. Необходимые условия для использования проверки подлинности управляемого удостоверения:
|
|
properties.storageAccountSubscriptionId |
string (uuid) |
Указывает идентификатор подписки хранилища BLOB-объектов. |
|
properties.storageEndpoint |
string |
Указывает конечную точку хранилища BLOB-объектов (например, https://MyAccount.blob.core.windows.net). Если состояние включено, требуется storageEndpoint или isAzureMonitorTargetEnabled. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Успешно обновлены параметры аудита DevOps. |
|
202 Accepted |
Выполняется обновление параметров аудита DevOps. Заголовки Location: string |
|
Other Status Codes |
Ответы на ошибки: ***
|
Примеры
Update a server's Dev |
Update a server's Dev |
Update a server's DevOps audit settings with all params
Образец запроса
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
}
}
Пример ответа
{
"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
}
}
Update a server's DevOps audit settings with minimal input
Образец запроса
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"
}
}
Пример ответа
{
"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"
}
}
Определения
Имя | Описание |
---|---|
Blob |
Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled. |
created |
Тип удостоверения, создавшего ресурс. |
Dev |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
Error |
Сведения об ошибке. |
Error |
Ответ на ошибку |
Server |
Параметры аудита DevOps сервера. |
system |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
BlobAuditingPolicyState
Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled.
Значение | Описание |
---|---|
Disabled | |
Enabled |
createdByType
Тип удостоверения, создавшего ресурс.
Значение | Описание |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
DevOpsAuditingSettingsName
Значение | Описание |
---|---|
Default |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
Имя | Тип | Описание |
---|---|---|
info |
object |
Дополнительные сведения. |
type |
string |
Дополнительный тип сведений. |
ErrorDetail
Сведения об ошибке.
Имя | Тип | Описание |
---|---|---|
additionalInfo |
Дополнительные сведения об ошибке. |
|
code |
string |
Код ошибки. |
details |
Сведения об ошибке. |
|
message |
string |
Сообщение об ошибке. |
target |
string |
Целевой объект ошибки. |
ErrorResponse
Ответ на ошибку
Имя | Тип | Описание |
---|---|---|
error |
Объект ошибки. |
ServerDevOpsAuditingSettings
Параметры аудита 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 |
Указывает состояние аудита. Если состояние включено, необходимо использовать storageEndpoint или isAzureMonitorTargetEnabled. |
|
properties.storageAccountAccessKey |
string |
Указывает ключ идентификатора учетной записи хранения аудита. Если задано состояние "Включено" и storageEndpoint не указано, что storageAccountAccessKey будет использовать управляемое удостоверение, назначаемое системой SQL Server, для доступа к хранилищу. Необходимые условия для использования проверки подлинности управляемого удостоверения:
|
properties.storageAccountSubscriptionId |
string (uuid) |
Указывает идентификатор подписки хранилища BLOB-объектов. |
properties.storageEndpoint |
string |
Указывает конечную точку хранилища BLOB-объектов (например, https://MyAccount.blob.core.windows.net). Если состояние включено, требуется storageEndpoint или isAzureMonitorTargetEnabled. |
systemData |
SystemData of ServerDevOpsAuditSettingsResource. |
|
type |
string |
Тип ресурса. |
systemData
Метаданные, относящиеся к созданию и последнему изменении ресурса.
Имя | Тип | Описание |
---|---|---|
createdAt |
string (date-time) |
Метка времени создания ресурса (UTC). |
createdBy |
string |
Удостоверение, создающее ресурс. |
createdByType |
Тип удостоверения, создавшего ресурс. |
|
lastModifiedAt |
string (date-time) |
Метка времени последнего изменения ресурса (UTC) |
lastModifiedBy |
string |
Идентификатор, который последний раз изменил ресурс. |
lastModifiedByType |
Тип удостоверения, который последний раз изменил ресурс. |