Server DevOps Audit Settings - Create Or Update

Referensi

Service:: SQL Database

API Version:: 2021-11-01

Membuat atau memperbarui pengaturan audit DevOps server.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
devOpsAuditingSettingsName	path	True	string	Nama pengaturan audit devops. Ini harus selalu 'default'.
resourceGroupName	path	True	string	Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari Azure Resource Manager API atau portal.
serverName	path	True	string	Nama server.
subscriptionId	path	True	string	ID langganan yang mengidentifikasi langganan Azure.
api-version	query	True	string	Versi API yang digunakan untuk permintaan.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
properties.state	True	BlobAuditingPolicyState	Menentukan status audit. Jika status Diaktifkan, storageEndpoint atau isAzureMonitorTargetEnabled diperlukan.
properties.isAzureMonitorTargetEnabled		boolean	Menentukan apakah peristiwa audit DevOps dikirim ke Azure Monitor. Untuk mengirim peristiwa ke Azure Monitor, tentukan 'State' sebagai 'Enabled' dan 'IsAzureMonitorTargetEnabled' sebagai true. Saat menggunakan REST API untuk mengonfigurasi audit DevOps, Pengaturan Diagnostik dengan kategori log diagnostik 'DevOpsOperationsAudit' pada database master juga harus dibuat. Format URI Pengaturan Diagnostik: 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 Untuk informasi selengkapnya, lihat Rest API Pengaturan Diagnostik atau PowerShell Pengaturan Diagnostik
properties.storageAccountAccessKey		string	Menentukan kunci pengidentifikasi akun penyimpanan audit. Jika status Diaktifkan dan storageEndpoint ditentukan, tidak menentukan storageAccountAccessKey akan menggunakan identitas terkelola yang ditetapkan sistem server SQL untuk mengakses penyimpanan. Prasyarat untuk menggunakan autentikasi identitas terkelola: Tetapkan SQL Server identitas terkelola yang ditetapkan sistem di Azure Active Directory (AAD). Berikan akses identitas SQL Server ke akun penyimpanan dengan menambahkan peran RBAC 'Kontributor Data Blob Penyimpanan' ke identitas server. Untuk informasi selengkapnya, lihat Mengaudit ke penyimpanan menggunakan autentikasi Identitas Terkelola
properties.storageAccountSubscriptionId		string	Menentukan Id langganan penyimpanan blob.
properties.storageEndpoint		string	Menentukan titik akhir penyimpanan blob (misalnya https://MyAccount.blob.core.windows.net). Jika status Diaktifkan, storageEndpoint atau isAzureMonitorTargetEnabled diperlukan.

Respons

Nama	Jenis	Deskripsi
200 OK	ServerDevOpsAuditingSettings	Berhasil memperbarui pengaturan audit DevOps.
202 Accepted		Memperbarui pengaturan DevOps audit sedang berlangsung.
Other Status Codes		Respons Kesalahan: *** 400 InvalidServerDevOpsAuditSettingsCreateRequest - Permintaan kebijakan audit DevOps buat server tidak ada atau tidak memiliki objek properti. 400 DataSecurityInvalidUserSuppliedParameter - Nilai parameter yang tidak valid disediakan oleh klien. 400 InvalidServerDevOpsAuditSettingsName - Nama kebijakan DevOps server tidak valid. 400 DevOpsAuditInvalidStorageAccountCredentials - Akun penyimpanan atau kunci akses yang disediakan tidak valid. 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan 404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan. 409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit sudah berlangsung.

Nama

Jenis

Deskripsi

200 OK

ServerDevOpsAuditingSettings

Berhasil memperbarui pengaturan audit DevOps.

202 Accepted

Memperbarui pengaturan DevOps audit sedang berlangsung.

Other Status Codes

Respons Kesalahan: ***

400 InvalidServerDevOpsAuditSettingsCreateRequest - Permintaan kebijakan audit DevOps buat server tidak ada atau tidak memiliki objek properti.
400 DataSecurityInvalidUserSuppliedParameter - Nilai parameter yang tidak valid disediakan oleh klien.
400 InvalidServerDevOpsAuditSettingsName - Nama kebijakan DevOps server tidak valid.
400 DevOpsAuditInvalidStorageAccountCredentials - Akun penyimpanan atau kunci akses yang disediakan tidak valid.
404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan
404 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan.
409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit sudah berlangsung.

Contoh

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

Definisi

Nama	Deskripsi
BlobAuditingPolicyState	Menentukan status audit. Jika status Diaktifkan, storageEndpoint atau isAzureMonitorTargetEnabled diperlukan.
createdByType	Jenis identitas yang membuat sumber daya.
ServerDevOpsAuditingSettings	Pengaturan audit DevOps server.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

BlobAuditingPolicyState

Menentukan status audit. Jika status Diaktifkan, storageEndpoint atau isAzureMonitorTargetEnabled diperlukan.

Nama	Jenis	Deskripsi
Disabled	string
Enabled	string

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ServerDevOpsAuditingSettings

Pengaturan audit DevOps server.

Nama	Jenis	Deskripsi
id	string	ID Sumber Daya.
name	string	Nama sumber daya.
properties.isAzureMonitorTargetEnabled	boolean	Menentukan apakah peristiwa audit DevOps dikirim ke Azure Monitor. Untuk mengirim peristiwa ke Azure Monitor, tentukan 'State' sebagai 'Enabled' dan 'IsAzureMonitorTargetEnabled' sebagai true. Saat menggunakan REST API untuk mengonfigurasi audit DevOps, Pengaturan Diagnostik dengan kategori log diagnostik 'DevOpsOperationsAudit' pada database master juga harus dibuat. Format URI Pengaturan Diagnostik: 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 Untuk informasi selengkapnya, lihat Rest API Pengaturan Diagnostik atau PowerShell Pengaturan Diagnostik
properties.state	BlobAuditingPolicyState	Menentukan status audit. Jika status Diaktifkan, storageEndpoint atau isAzureMonitorTargetEnabled diperlukan.
properties.storageAccountAccessKey	string	Menentukan kunci pengidentifikasi akun penyimpanan audit. Jika status Diaktifkan dan storageEndpoint ditentukan, tidak menentukan storageAccountAccessKey akan menggunakan identitas terkelola yang ditetapkan sistem server SQL untuk mengakses penyimpanan. Prasyarat untuk menggunakan autentikasi identitas terkelola: Tetapkan SQL Server identitas terkelola yang ditetapkan sistem di Azure Active Directory (AAD). Berikan akses identitas SQL Server ke akun penyimpanan dengan menambahkan peran RBAC 'Kontributor Data Blob Penyimpanan' ke identitas server. Untuk informasi selengkapnya, lihat Mengaudit ke penyimpanan menggunakan autentikasi Identitas Terkelola
properties.storageAccountSubscriptionId	string	Menentukan Id langganan penyimpanan blob.
properties.storageEndpoint	string	Menentukan titik akhir penyimpanan blob (misalnya https://MyAccount.blob.core.windows.net). Jika status Diaktifkan, storageEndpoint atau isAzureMonitorTargetEnabled diperlukan.
systemData	systemData	SystemData dari ServerDevOpsAuditSettingsResource.
type	string	Jenis sumber daya

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir memodifikasi sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

Server DevOps Audit Settings - Create Or Update

Parameter URI

Isi Permintaan

Respons

Contoh

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

Definisi

BlobAuditingPolicyState

createdByType

ServerDevOpsAuditingSettings

systemData

Sumber Daya Tambahan: