Policy States - List Query Results For Resource Group

Tjänst:: Policy

API-version:: 2024-10-01

Frågar principtillstånd för resurserna under resursgruppen.

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

Med valfria parametrar:

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}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
policyStatesResource	path	True	PolicyStatesResource	Den virtuella resursen under PrincipStates-resurstyp. I ett angivet tidsintervall representerar "senaste" de senaste principtillstånden, medan "standard" representerar alla principtillstånd.
resourceGroupName	path	True	string	Namn på resursgrupp.
subscriptionId	path	True	string	Microsoft Azure prenumerations-ID.
api-version	query	True	string	Klient-API-version.
$apply	query		string	OData tillämpar uttryck för sammansättningar.
$filter	query		string	OData-filteruttryck.
$from	query		string (date-time)	ISO 8601-formaterad tidsstämpel som anger starttiden för intervallet som ska frågas. När det inte anges använder tjänsten ($to – 1 dag).
$orderby	query		string	Orderuttryck med OData-notation. Ett eller flera kommaavgränsade kolumnnamn med ett valfritt "desc" (standard) eller "asc", t.ex. "$orderby=PolicyAssignmentId, ResourceId asc".
$select	query		string	Välj uttryck med OData-notation. Begränsar kolumnerna för varje post till bara de begärda, t.ex. "$select=PolicyAssignmentId, ResourceId".
$skiptoken	query		string	Skiptoken tillhandahålls endast om ett tidigare svar returnerade ett partiellt resultat som en del av nextLink-elementet.
$to	query		string (date-time)	ISO 8601-formaterad tidsstämpel som anger sluttiden för intervallet som ska frågas. När det inte anges använder tjänsten begärandetiden.
$top	query		integer (int32) minimum: 0	Maximalt antal poster som ska returneras.

Svar

Name	Typ	Description
200 OK	PolicyStatesQueryResults	Frågeresultat.
Other Status Codes	QueryFailure	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Query latest at resource group scope

Query latest at resource group scope with next link

Query latest at resource group scope

Exempelbegäran

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

Exempelsvar

Statuskod:: 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

Exempelbegäran

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

Exempelsvar

Statuskod:: 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"
      ]
    }
  ]
}

Definitioner

Name	Description
ComponentStateDetails	Information om komponenttillstånd.
Error	Feldefinition.
ExpressionEvaluationDetails	Utvärderingsinformation om principspråkuttryck.
IfNotExistsEvaluationDetails	Utvärderingsinformation om IfNotExists-effekten.
PolicyEvaluationDetails	Information om principutvärdering.
PolicyState	Principtillståndspost.
PolicyStatesQueryResults	Frågeresultat.
PolicyStatesResource	Den virtuella resursen under PrincipStates-resurstyp. I ett angivet tidsintervall representerar "senaste" de senaste principtillstånden, medan "standard" representerar alla principtillstånd.
QueryFailure	Felsvar.

ComponentStateDetails

Objekt

Information om komponenttillstånd.

Name	Typ	Description
complianceState	string	Komponentefterlevnadstillstånd.
id	string	Komponent-ID.
name	string	Komponentnamn.
timestamp	string (date-time)	Tidsstämpel för utvärdering av komponentefterlevnad.
type	string	Komponenttyp.

Error

Objekt

Feldefinition.

Name	Typ	Description
code	string	Tjänstspecifik felkod som fungerar som understatus för HTTP-felkoden.
message	string	Beskrivning av felet.

ExpressionEvaluationDetails

Objekt

Utvärderingsinformation om principspråkuttryck.

Name	Typ	Description
expression	string	Uttrycket utvärderas.
expressionKind	string	Den typ av uttryck som utvärderades.
expressionValue	object	Uttryckets värde.
operator	string	Operator för att jämföra uttrycksvärdet och målvärdet.
path	string	Egenskapssökväg om uttrycket är ett fält eller ett alias.
result	string	Utvärderingsresultat.
targetValue	object	Målvärde som ska jämföras med uttrycksvärdet.

IfNotExistsEvaluationDetails

Objekt

Utvärderingsinformation om IfNotExists-effekten.

Name	Typ	Description
resourceId	string	ID för den senast utvärderade resursen för IfNotExists-effekten.
totalResources	integer	Totalt antal resurser som existensvillkoret är tillämpligt på.

PolicyEvaluationDetails

Objekt

Information om principutvärdering.

Name	Typ	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Information om de utvärderade uttrycken.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Utvärderingsinformation om IfNotExists-effekten.

PolicyState

Objekt

Principtillståndspost.

Name	Typ	Description
@odata.context	string	OData-kontextsträng; används av OData-klienter för att matcha typinformation baserat på metadata.
@odata.id	string	OData-entitets-ID; alltid inställt på null eftersom principtillståndsposter inte har något entitets-ID.
complianceState	string	Resursens efterlevnadstillstånd.
components	ComponentStateDetails[]	Komponenternas tillståndsefterlevnadsposter fylls endast i när URL:en innehåller $expand=components-satsen.
effectiveParameters	string	Effektiva parametrar för principtilldelningen.
isCompliant	boolean	Flagga som anger om resursen är kompatibel med den principtilldelning som den utvärderades mot. Den här egenskapen är inaktuell. Använd ComplianceState i stället.
managementGroupIds	string	Kommaavgränsad lista över hanteringsgrupps-ID:t, som representerar hierarkin för de hanteringsgrupper som resursen finns under.
policyAssignmentId	string	Principtilldelnings-ID.
policyAssignmentName	string	Namn på principtilldelning.
policyAssignmentOwner	string	Principtilldelningsägare.
policyAssignmentParameters	string	Principtilldelningsparametrar.
policyAssignmentScope	string	Principtilldelningsomfång.
policyAssignmentVersion	string	Utvärderad principtilldelningsversion.
policyDefinitionAction	string	Principdefinitionsåtgärd, d.v.s. effekt.
policyDefinitionCategory	string	Principdefinitionskategori.
policyDefinitionGroupNames	string[]	Grupnamn för principdefinition.
policyDefinitionId	string	Principdefinitions-ID.
policyDefinitionName	string	Namn på principdefinition.
policyDefinitionReferenceId	string	Referens-ID för principdefinitionen i principuppsättningen, om principtilldelningen är för en principuppsättning.
policyDefinitionVersion	string	Utvärderad principdefinitionsversion.
policyEvaluationDetails	PolicyEvaluationDetails	Information om principutvärdering.
policySetDefinitionCategory	string	Definitionskategori för principuppsättning, om principtilldelningen är för en principuppsättning.
policySetDefinitionId	string	Principuppsättningsdefinitions-ID, om principtilldelningen är för en principuppsättning.
policySetDefinitionName	string	Definitionsnamn för principuppsättning, om principtilldelningen är för en principuppsättning.
policySetDefinitionOwner	string	Principuppsättningens definitionsägare, om principtilldelningen är för en principuppsättning.
policySetDefinitionParameters	string	Definitionsparametrar för principuppsättningar, om principtilldelningen är för en principuppsättning.
policySetDefinitionVersion	string	Utvärderad definitionsversion för principuppsättningar.
resourceGroup	string	Namn på resursgrupp.
resourceId	string	Resurs-ID.
resourceLocation	string	Resursplats.
resourceTags	string	Lista över resurstaggar.
resourceType	string	Resurstyp.
subscriptionId	string	Prenumerations-ID.
timestamp	string (date-time)	Tidsstämpel för principtillståndsposten.

PolicyStatesQueryResults

Objekt

Frågeresultat.

Name	Typ	Description
@odata.context	string	OData-kontextsträng; används av OData-klienter för att matcha typinformation baserat på metadata.
@odata.count	integer (int32) minimum: 0	Antal OData-entiteter. representerar antalet principtillståndsposter som returneras.
@odata.nextLink	string	Odata nästa länk; URL för att hämta nästa uppsättning resultat.
value	PolicyState[]	Frågeresultat.

PolicyStatesResource

Uppräkning

Den virtuella resursen under PrincipStates-resurstyp. I ett angivet tidsintervall representerar "senaste" de senaste principtillstånden, medan "standard" representerar alla principtillstånd.

Värde	Description
default
latest

QueryFailure

Objekt

Felsvar.

Name	Typ	Description
error	Error	Feldefinition.

Dela via

Policy States - List Query Results For Resource Group

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Query latest at resource group scope

Exempelbegäran

Exempelsvar

Query latest at resource group scope with next link

Exempelbegäran

Exempelsvar

Definitioner

ComponentStateDetails

Error

ExpressionEvaluationDetails

IfNotExistsEvaluationDetails

PolicyEvaluationDetails

PolicyState

PolicyStatesQueryResults

PolicyStatesResource

QueryFailure