Bagikan melalui

Server DevOps Audit Settings - Create Or Update

Layanan:
SQL Database
Versi API:
2023-08-01

Membuat atau memperbarui pengaturan audit DevOps server.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
devOpsAuditingSettingsName
 path True

DevOpsAuditingSettingsName

resourceGroupName
 path True

string

Nama grup sumber daya yang berisi sumber daya. Anda dapat memperoleh nilai ini dari API Azure Resource Manager 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 akan digunakan untuk permintaan tersebut.

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 Pengaturan Diagnostik REST API atau Pengaturan Diagnostik PowerShell
properties.isManagedIdentityInUse

boolean

Menentukan apakah Identitas Terkelola digunakan untuk mengakses penyimpanan blob
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:

  1. Tetapkan SQL Server identitas terkelola yang ditetapkan sistem di Azure Active Directory (AAD).
  2. Berikan akses identitas SQL Server ke akun penyimpanan dengan menambahkan peran RBAC 'Kontributor Data Blob Penyimpanan' ke identitas server. Untuk informasi selengkapnya, lihat audit ke penyimpanan menggunakan autentikasi Identitas Terkelola
properties.storageAccountSubscriptionId

string (uuid)

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.

Header

Location: string
Other Status Codes

ErrorResponse

Respons Kesalahan: ***

  • 400 ManagedInstanceStoppingOrStopped - Operasi yang bertentangan dikirimkan saat instans dalam status berhenti/dihentikan

  • 400 ManagedInstanceStarting - Operasi bertentangan yang dikirimkan saat instans dalam status mulai

  • 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 ServerNotInSubscriptionResourceGroup - Server yang ditentukan tidak ada di grup sumber daya dan langganan yang ditentukan.

  • 404 SubscriptionDoesNotHaveServer - Server yang diminta tidak ditemukan

  • 404 OperationIdNotFound - Operasi dengan Id tidak ada.

  • 409 ServerDevOpsAuditSettingsInProgress - Set server DevOps audit sudah berlangsung.

  • 409 CannotCancelOperation - Operasi manajemen dalam keadaan yang tidak dapat dibatalkan.

  • 409 OperationCancelled - Operasi telah dibatalkan oleh pengguna.

  • 409 OperationInterrupted - Operasi pada sumber daya tidak dapat diselesaikan karena terganggu oleh operasi lain pada sumber daya yang sama.

  • 429 SubscriptionTooManyCreateUpdateRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

  • 429 SubscriptionTooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

  • 500 OperationTimedOut - Waktu operasi habis dan secara otomatis digulung balik. Silakan coba lagi operasi ini.

  • 503 TooManyRequests - Permintaan di luar permintaan maks yang dapat diproses oleh sumber daya yang tersedia.

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

Permintaan sampel

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
  }
}

Respon sampel

Kode status:
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
  }
}
Kode status:
202

Update a server's DevOps audit settings with minimal input

Permintaan sampel

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"
  }
}

Respon sampel

Kode status:
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"
  }
}
Kode status:
202

Definisi

Nama Deskripsi
BlobAuditingPolicyState

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

Jenis identitas yang membuat sumber daya.
DevOpsAuditingSettingsName
ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.
ErrorDetail

Detail kesalahan.
ErrorResponse

Respons kesalahan
ServerDevOpsAuditingSettings

Pengaturan audit DevOps server.
systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

BlobAuditingPolicyState

Enumerasi

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

Nilai Deskripsi
Enabled
Disabled

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai Deskripsi
User
Application
ManagedIdentity
Key

DevOpsAuditingSettingsName

Enumerasi
Nilai Deskripsi
Default

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.
type

string

Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.
code

string

Kode kesalahan.
details

ErrorDetail[]

Detail kesalahan.
message

string

Pesan kesalahan.
target

string

Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

ServerDevOpsAuditingSettings

Objek

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 Pengaturan Diagnostik REST API atau Pengaturan Diagnostik PowerShell
properties.isManagedIdentityInUse

boolean

Menentukan apakah Identitas Terkelola digunakan untuk mengakses penyimpanan blob
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:

  1. Tetapkan SQL Server identitas terkelola yang ditetapkan sistem di Azure Active Directory (AAD).
  2. Berikan akses identitas SQL Server ke akun penyimpanan dengan menambahkan peran RBAC 'Kontributor Data Blob Penyimpanan' ke identitas server. Untuk informasi selengkapnya, lihat audit ke penyimpanan menggunakan autentikasi Identitas Terkelola
properties.storageAccountSubscriptionId

string (uuid)

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

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama Jenis Deskripsi
createdAt

string (date-time)

Tanda waktu pembuatan sumber daya (UTC).
createdBy

string

Identitas yang membuat sumber daya.
createdByType

createdByType

Jenis identitas yang membuat sumber daya.
lastModifiedAt

string (date-time)

Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy

string

Identitas yang terakhir mengubah sumber daya.
lastModifiedByType

createdByType

Jenis identitas yang terakhir memodifikasi sumber daya.