Policy States - List Query Results For Resource Group

Layanan:: Policy

Versi API:: 2024-10-01

Mengkueri status kebijakan untuk sumber daya di bawah grup sumber daya.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2024-10-01

Dengan parameter opsional:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2024-10-01&$top={$top}&$orderby={$orderby}&$select={$select}&$from={$from}&$to={$to}&$filter={$filter}&$apply={$apply}&$skiptoken={$skiptoken}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
policyStatesResource	path	True	PolicyStatesResource	Sumber daya virtual di bawah Jenis sumber daya PolicyStates. Dalam rentang waktu tertentu, 'terbaru' mewakili status kebijakan terbaru, sedangkan 'default' mewakili semua status kebijakan.
resourceGroupName	path	True	string	Nama grup sumber daya.
subscriptionId	path	True	string	ID langganan Microsoft Azure.
api-version	query	True	string	Versi Api Klien.
$apply	query		string	OData menerapkan ekspresi untuk agregasi.
$filter	query		string	Ekspresi filter OData.
$from	query		string (date-time)	Tanda waktu berformat ISO 8601 yang menentukan waktu mulai interval untuk kueri. Ketika tidak ditentukan, layanan menggunakan ($to - 1 hari).
$orderby	query		string	Mengurutkan ekspresi menggunakan notasi OData. Satu atau beberapa nama kolom yang dipisahkan koma dengan "desc" opsional (default) atau "asc", misalnya "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Pilih ekspresi menggunakan notasi OData. Membatasi kolom pada setiap rekaman hanya untuk yang diminta, misalnya "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken hanya disediakan jika respons sebelumnya mengembalikan hasil parsial sebagai bagian dari elemen nextLink.
$to	query		string (date-time)	Tanda waktu berformat ISO 8601 yang menentukan waktu akhir interval untuk kueri. Ketika tidak ditentukan, layanan menggunakan waktu permintaan.
$top	query		integer (int32) minimum: 0	Jumlah maksimum rekaman yang akan dikembalikan.

Respons

Nama	Jenis	Deskripsi
200 OK	PolicyStatesQueryResults	Hasil kueri.
Other Status Codes	QueryFailure	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

Query latest at resource group scope

Query latest at resource group scope with next link

Query latest at resource group scope

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01

Respon sampel

Kode status:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ],
      "policyDefinitionVersion": "1.0.0-preview",
      "policySetDefinitionVersion": "2.0.1",
      "policyAssignmentVersion": "1.0.0"
    }
  ]
}

Query latest at resource group scope with next link

Permintaan sampel

HTTP

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2024-10-01&$skiptoken=WpmWfBSvPhkAK6QD

Respon sampel

Kode status:: 200

{
  "@odata.nextLink": null,
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest",
  "@odata.count": 2,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/24813039-7534-408a-9842-eb99f45721b1",
      "effectiveParameters": null,
      "isCompliant": false,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "NonCompliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    },
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourcegroups/myResourceGroup/providers/Microsoft.PolicyInsights/policyStates/$metadata#latest/$entity",
      "timestamp": "2019-10-09T18:42:42Z",
      "resourceId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/mysa1",
      "policyAssignmentId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyAssignments/3f3c4330183b4e218fe6fd29",
      "policyDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policyDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "effectiveParameters": null,
      "isCompliant": true,
      "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "resourceType": "/Microsoft.Storage/storageAccounts",
      "resourceLocation": "eastus",
      "resourceGroup": "myResourceGroup",
      "resourceTags": "tbd",
      "policyAssignmentName": "3f3c4330183b4e218fe6fd29",
      "policyAssignmentOwner": "tbd",
      "policyAssignmentParameters": "{}",
      "policyAssignmentScope": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852",
      "policyDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e3682",
      "policyDefinitionAction": "audit",
      "policyDefinitionCategory": "tbd",
      "policySetDefinitionId": "/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c",
      "policySetDefinitionOwner": null,
      "policySetDefinitionCategory": null,
      "policySetDefinitionParameters": null,
      "managementGroupIds": "mymg,fff988bf-fff1-ffff-fffb-fffcd011db47",
      "policyDefinitionReferenceId": null,
      "complianceState": "Compliant",
      "policyDefinitionGroupNames": [
        "myGroup"
      ]
    }
  ]
}

Definisi

Nama	Deskripsi
ComponentStateDetails	Detail status komponen.
Error	Definisi kesalahan.
ExpressionEvaluationDetails	Detail evaluasi ekspresi bahasa kebijakan.
IfNotExistsEvaluationDetails	Detail evaluasi efek IfNotExists.
PolicyEvaluationDetails	Detail evaluasi kebijakan.
PolicyState	Catatan status kebijakan.
PolicyStatesQueryResults	Hasil kueri.
PolicyStatesResource	Sumber daya virtual di bawah Jenis sumber daya PolicyStates. Dalam rentang waktu tertentu, 'terbaru' mewakili status kebijakan terbaru, sedangkan 'default' mewakili semua status kebijakan.
QueryFailure	Respons kesalahan.

ComponentStateDetails

Objek

Detail status komponen.

Nama	Jenis	Deskripsi
complianceState	string	Status kepatuhan komponen.
id	string	Id Komponen.
name	string	Nama komponen.
timestamp	string (date-time)	Tanda waktu evaluasi kepatuhan komponen.
type	string	Jenis komponen.

Error

Objek

Definisi kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan khusus layanan yang berfungsi sebagai substatus untuk kode kesalahan HTTP.
message	string	Deskripsi kesalahan.

ExpressionEvaluationDetails

Objek

Detail evaluasi ekspresi bahasa kebijakan.

Nama	Jenis	Deskripsi
expression	string	Ekspresi dievaluasi.
expressionKind	string	Jenis ekspresi yang dievaluasi.
expressionValue	object	Nilai ekspresi.
operator	string	Operator untuk membandingkan nilai ekspresi dan nilai target.
path	string	Jalur properti jika ekspresi adalah bidang atau alias.
result	string	Hasil evaluasi.
targetValue	object	Nilai target yang akan dibandingkan dengan nilai ekspresi.

IfNotExistsEvaluationDetails

Objek

Detail evaluasi efek IfNotExists.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya terakhir yang dievaluasi untuk efek IfNotExists.
totalResources	integer	Jumlah total sumber daya yang kondisi keberadaannya berlaku.

PolicyEvaluationDetails

Objek

Detail evaluasi kebijakan.

Nama	Jenis	Deskripsi
evaluatedExpressions	ExpressionEvaluationDetails[]	Detail ekspresi yang dievaluasi.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Detail evaluasi efek IfNotExists.

PolicyState

Objek

Catatan status kebijakan.

Nama	Jenis	Deskripsi
@odata.context	string	String konteks OData; digunakan oleh klien OData untuk mengatasi informasi jenis berdasarkan metadata.
@odata.id	string	ID entitas OData; selalu diatur ke null karena rekaman status kebijakan tidak memiliki ID entitas.
complianceState	string	Status kepatuhan sumber daya.
components	ComponentStateDetails[]	Rekaman kepatuhan status komponen diisi hanya ketika URL berisi klausa $expand=components.
effectiveParameters	string	Parameter efektif untuk penetapan kebijakan.
isCompliant	boolean	Bendera yang menyatakan apakah sumber daya mematuhi penetapan kebijakan yang dievaluasi. Properti ini tidak digunakan lagi; silakan gunakan ComplianceState sebagai gantinya.
managementGroupIds	string	Daftar ID grup manajemen yang dipisahkan koma, yang mewakili hierarki grup manajemen tempat sumber daya berada.
policyAssignmentId	string	ID penetapan kebijakan.
policyAssignmentName	string	Nama penetapan kebijakan.
policyAssignmentOwner	string	Pemilik penetapan kebijakan.
policyAssignmentParameters	string	Parameter penetapan kebijakan.
policyAssignmentScope	string	Cakupan penetapan kebijakan.
policyAssignmentVersion	string	Versi penetapan kebijakan yang dievaluasi.
policyDefinitionAction	string	Tindakan definisi kebijakan, yaitu efek.
policyDefinitionCategory	string	Kategori definisi kebijakan.
policyDefinitionGroupNames	string[]	Nama grup definisi kebijakan.
policyDefinitionId	string	ID definisi kebijakan.
policyDefinitionName	string	Nama definisi kebijakan.
policyDefinitionReferenceId	string	ID referensi untuk definisi kebijakan di dalam kumpulan kebijakan, jika penetapan kebijakan adalah untuk kumpulan kebijakan.
policyDefinitionVersion	string	Versi definisi kebijakan yang dievaluasi.
policyEvaluationDetails	PolicyEvaluationDetails	Detail evaluasi kebijakan.
policySetDefinitionCategory	string	Kategori definisi kumpulan kebijakan, jika penetapan kebijakan adalah untuk kumpulan kebijakan.
policySetDefinitionId	string	ID definisi kumpulan kebijakan, jika penetapan kebijakan adalah untuk kumpulan kebijakan.
policySetDefinitionName	string	Nama definisi kumpulan kebijakan, jika penetapan kebijakan adalah untuk kumpulan kebijakan.
policySetDefinitionOwner	string	Pemilik definisi set kebijakan, jika penetapan kebijakan adalah untuk kumpulan kebijakan.
policySetDefinitionParameters	string	Parameter definisi kumpulan kebijakan, jika penetapan kebijakan adalah untuk kumpulan kebijakan.
policySetDefinitionVersion	string	Versi definisi kumpulan kebijakan yang dievaluasi.
resourceGroup	string	Nama grup sumber daya.
resourceId	string	ID Sumber Daya.
resourceLocation	string	Lokasi sumber daya.
resourceTags	string	Daftar tag sumber daya.
resourceType	string	Jenis sumber daya.
subscriptionId	string	ID Langganan.
timestamp	string (date-time)	Tanda waktu untuk rekaman status kebijakan.

PolicyStatesQueryResults

Objek

Hasil kueri.

Nama	Jenis	Deskripsi
@odata.context	string	String konteks OData; digunakan oleh klien OData untuk mengatasi informasi jenis berdasarkan metadata.
@odata.count	integer (int32) minimum: 0	Jumlah entitas OData; menunjukkan jumlah rekaman status kebijakan yang dikembalikan.
@odata.nextLink	string	Tautan odata berikutnya; URL untuk mendapatkan serangkaian hasil berikutnya.
value	PolicyState[]	Hasil kueri.

PolicyStatesResource

Enumerasi

Sumber daya virtual di bawah Jenis sumber daya PolicyStates. Dalam rentang waktu tertentu, 'terbaru' mewakili status kebijakan terbaru, sedangkan 'default' mewakili semua status kebijakan.

Nilai	Deskripsi
default
latest

QueryFailure

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Definisi kesalahan.

Bagikan melalui

Policy States - List Query Results For Resource Group

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

Query latest at resource group scope

Permintaan sampel

Respon sampel

Query latest at resource group scope with next link

Permintaan sampel

Respon sampel

Definisi

ComponentStateDetails

Error

ExpressionEvaluationDetails

IfNotExistsEvaluationDetails

PolicyEvaluationDetails

PolicyState

PolicyStatesQueryResults

PolicyStatesResource

QueryFailure