Remediations - Get At Resource

Layanan:

Policy

Versi API:

2024-10-01

Mendapatkan remediasi yang ada di cakupan sumber daya.

GET https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}?api-version=2024-10-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
remediationName	path	True	string	Nama remediasi.
resourceId	path	True	string	ID Sumber Daya.
api-version	query	True	string	Versi Api Klien.

Respons

Nama	Jenis	Deskripsi
200 OK	Remediation	Remediasi yang diambil.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Get remediation at individual resource scope

Permintaan sampel

HTTP

GET https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/Microsoft.PolicyInsights/remediations/storageRemediation?api-version=2024-10-01

Respon sampel

Kode status:

200

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "provisioningState": "Succeeded",
    "createdOn": "2018-09-13T21:51:09.075918Z",
    "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z",
    "resourceDiscoveryMode": "ExistingNonCompliant",
    "deploymentStatus": {
      "totalDeployments": 1,
      "successfulDeployments": 1,
      "failedDeployments": 0
    },
    "statusMessage": "Remediation extended status",
    "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
    "resourceCount": 42,
    "parallelDeployments": 6,
    "failureThreshold": {
      "percentage": 0.1
    }
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/microsoft.policyinsights/remediations/storageRemediation",
  "name": "storageRemediation",
  "type": "Microsoft.PolicyInsights/remediations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2018-09-13T21:51:09.075918Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-09-13T21:52:10.0011706Z"
  }
}

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorDefinition	Definisi kesalahan.
ErrorResponse	Respons kesalahan.
FailureThreshold	Pengaturan ambang kegagalan remediasi
Remediation	Definisi remediasi.
RemediationDeploymentSummary	Ringkasan status penyebaran untuk semua penyebaran yang dibuat oleh remediasi.
RemediationFilters	Filter yang akan diterapkan untuk menentukan sumber daya mana yang akan diperbaiki.
ResourceDiscoveryMode	Cara sumber daya untuk memulihkan ditemukan. Default ke ExistingNonCompliant jika tidak ditentukan.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TypedErrorInfo	Detail kesalahan spesifik skenario.

createdByType

Enumerasi

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

ErrorDefinition

Objek

Definisi kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	TypedErrorInfo[]	Detail kesalahan spesifik skenario tambahan.
code	string	Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.
details	ErrorDefinition[]	Detail kesalahan internal.
message	string	Deskripsi kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	ErrorDefinition	Rincian kesalahan.

FailureThreshold

Objek

Pengaturan ambang kegagalan remediasi

Nama	Jenis	Deskripsi
percentage	number (float)	Angka antara 0,0 hingga 1,0 menunjukkan ambang kegagalan persentase. Remediasi akan gagal jika persentase operasi remediasi yang gagal (yaitu penyebaran yang gagal) melebihi ambang batas ini.

Remediation

Objek

Definisi remediasi.

Nama	Jenis	Deskripsi
id	string	ID remediasi.
name	string	Nama remediasi.
properties.correlationId	string	Id korelasi remediasi. Dapat digunakan untuk menemukan peristiwa yang terkait dengan remediasi di log aktivitas.
properties.createdOn	string (date-time)	Waktu di mana remediasi dibuat.
properties.deploymentStatus	RemediationDeploymentSummary	Ringkasan status penyebaran untuk semua penyebaran yang dibuat oleh remediasi.
properties.failureThreshold	FailureThreshold	Pengaturan ambang kegagalan remediasi
properties.filters	RemediationFilters	Filter yang akan diterapkan untuk menentukan sumber daya mana yang akan diperbaiki.
properties.lastUpdatedOn	string (date-time)	Waktu di mana remediasi terakhir diperbarui.
properties.parallelDeployments	integer (int32)	Menentukan berapa banyak sumber daya yang akan diperbaiki pada waktu tertentu. Dapat digunakan untuk meningkatkan atau mengurangi kecepatan remediasi. Jika tidak disediakan, nilai penyebaran paralel default digunakan.
properties.policyAssignmentId	string	ID sumber daya dari penetapan kebijakan yang harus diperbaiki.
properties.policyDefinitionReferenceId	string	ID referensi definisi kebijakan dari definisi individual yang harus diperbaiki. Diperlukan saat penetapan kebijakan yang sedang diperbaiki menetapkan definisi kumpulan kebijakan.
properties.provisioningState	string	Status remediasi. Ini mengacu pada seluruh tugas remediasi, bukan penyebaran individual. Nilai yang diizinkan adalah Mengevaluasi, Membatalkan, Membatalkan, Gagal, Selesai, atau Berhasil.
properties.resourceCount	integer (int32)	Menentukan jumlah maksimum sumber daya yang dapat diperbaiki oleh pekerjaan remediasi. Jika tidak disediakan, jumlah sumber daya default digunakan.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Cara sumber daya untuk memulihkan ditemukan. Default ke ExistingNonCompliant jika tidak ditentukan.
properties.statusMessage	string	Pesan status remediasi. Memberikan detail tambahan mengenai status remediasi.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createdBy dan modifiedBy.
type	string	Jenis remediasi.

RemediationDeploymentSummary

Objek

Ringkasan status penyebaran untuk semua penyebaran yang dibuat oleh remediasi.

Nama	Jenis	Deskripsi
failedDeployments	integer	Jumlah penyebaran yang diperlukan oleh remediasi yang telah gagal.
successfulDeployments	integer	Jumlah penyebaran yang diperlukan oleh remediasi yang telah berhasil.
totalDeployments	integer	Jumlah penyebaran yang diperlukan oleh remediasi.

RemediationFilters

Objek

Filter yang akan diterapkan untuk menentukan sumber daya mana yang akan diperbaiki.

Nama	Jenis	Deskripsi
locations	string[]	Lokasi sumber daya yang akan diperbaiki.
resourceIds	string[]	ID sumber daya yang akan diperbaiki. Dapat menentukan paling banyak 100 ID. Filter ini tidak dapat digunakan ketika ReEvaluateCompliance diatur ke ReEvaluateCompliance, dan tidak boleh kosong jika disediakan.

ResourceDiscoveryMode

Enumerasi

Cara sumber daya untuk memulihkan ditemukan. Default ke ExistingNonCompliant jika tidak ditentukan.

Nilai	Deskripsi
ExistingNonCompliant	Remediasi sumber daya yang sudah diketahui tidak patuh.
ReEvaluateCompliance	Evaluasi ulang status kepatuhan sumber daya lalu remediasi sumber daya yang ditemukan tidak patuh. Filter resourceIds tidak dapat digunakan dalam mode ini.

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.

TypedErrorInfo

Objek

Detail kesalahan spesifik skenario.

Nama	Jenis	Deskripsi
info		Detail kesalahan spesifik skenario.
type	string	Jenis detail kesalahan yang disertakan.