Server DevOps Audit Settings - Create Or Update

Ссылка

Service:: SQL Database

API Version:: 2021-11-01

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

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	ServerDevOpsAuditingSettings	Параметры аудита DevOps успешно обновлены.
202 Accepted		Выполняется обновление параметров аудита DevOps.
Other Status Codes		Ответы на ошибки: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest — запрос политики аудита DevOps на создание сервера не существует или не имеет объекта свойств. 400 DataSecurityInvalidUserSuppliedParameter — клиент предоставил недопустимое значение параметра. 400 InvalidServerDevOpsAuditSettingsName — недопустимое имя политики DevOps сервера. 400 DevOpsAuditInvalidStorageAccountCredentials — указанная учетная запись хранения или ключ доступа недопустимы. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 409 ServerDevOpsAuditSettingsInProgress — настройка аудита DevOps сервера уже выполняется.

Имя

Тип

Описание

200 OK

ServerDevOpsAuditingSettings

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

202 Accepted

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

Other Status Codes

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

400 InvalidServerDevOpsAuditSettingsCreateRequest — запрос политики аудита DevOps на создание сервера не существует или не имеет объекта свойств.
400 DataSecurityInvalidUserSuppliedParameter — клиент предоставил недопустимое значение параметра.
400 InvalidServerDevOpsAuditSettingsName — недопустимое имя политики DevOps сервера.
400 DevOpsAuditInvalidStorageAccountCredentials — указанная учетная запись хранения или ключ доступа недопустимы.
404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден
404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке.
409 ServerDevOpsAuditSettingsInProgress — настройка аудита DevOps сервера уже выполняется.

Примеры

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

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

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net",
    "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000",
    "isAzureMonitorTargetEnabled": true
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;
import java.util.UUID;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMax.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with all params.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithAllParams(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withIsAzureMonitorTargetEnabled(true)
                .withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withStorageAccountSubscriptionId(
                    UUID.fromString("00000000-1234-0000-5678-000000000000")),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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
  }
}

Status code:: 202

Update a server's DevOps audit settings with minimal input

Sample Request

HTTP
Java

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

{
  "properties": {
    "state": "Enabled",
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerDevOpsAuditingSettingsInner;
import com.azure.resourcemanager.sql.models.BlobAuditingPolicyState;

/** Samples for ServerDevOpsAuditSettings CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerDevOpsAuditCreateMin.json
     */
    /**
     * Sample code: Update a server's DevOps audit settings with minimal input.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateAServerSDevOpsAuditSettingsWithMinimalInput(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerDevOpsAuditSettings().createOrUpdate("devAuditTestRG",
            "devOpsAuditTestSvr", "default",
            new ServerDevOpsAuditingSettingsInner().withState(BlobAuditingPolicyState.ENABLED)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder"),
            Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 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"
  }
}

Status code:: 202

Определения

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

BlobAuditingPolicyState

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

Имя	Тип	Описание
Disabled	string
Enabled	string

createdByType

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

Имя	Тип	Описание
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

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

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

systemData

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

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

Server DevOps Audit Settings - Create Or Update

Параметры URI

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

Ответы

Примеры

Update a server's DevOps audit settings with all params

Sample Request

Sample Response

Update a server's DevOps audit settings with minimal input

Sample Request

Sample Response

Определения

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

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