Policy States - List Query Results For Resource Group

Service:: Policy

API-versie:: 2024-10-01

Query's met beleidsstatussen voor de resources onder de resourcegroep.

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

Met optionele parameters:

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

Name	In	Vereist	Type	Description
policyStatesResource	path	True	PolicyStatesResource	De virtuele resource onder Het resourcetype PolicyStates. In een bepaald tijdsbereik vertegenwoordigt 'latest' de meest recente beleidsstatus(s), terwijl 'standaard' alle beleidsstatussen vertegenwoordigt.
resourceGroupName	path	True	string	Naam van de resourcegroep.
subscriptionId	path	True	string	Microsoft Azure abonnements-ID.
api-version	query	True	string	Client-API-versie.
$apply	query		string	OData past expressies toe voor aggregaties.
$filter	query		string	OData-filterexpressie.
$from	query		string (date-time)	Met ISO 8601 opgemaakte tijdstempel wordt de begintijd van het interval opgegeven waarop een query moet worden uitgevoerd. Wanneer deze niet is opgegeven, gebruikt de service ($to - 1 dag).
$orderby	query		string	Expressie ordenen met behulp van OData-notatie. Een of meer door komma's gescheiden kolomnamen met een optionele 'desc' (de standaardinstelling) of 'asc', bijvoorbeeld '$orderby=PolicyAssignmentId, ResourceId asc'.
$select	query		string	Expressie selecteren met behulp van OData-notatie. Beperkt de kolommen voor elke record tot alleen de aangevraagde records, bijvoorbeeld '$select=PolicyAssignmentId, ResourceId'.
$skiptoken	query		string	Skiptoken wordt alleen opgegeven als een eerder antwoord een gedeeltelijk resultaat heeft geretourneerd als onderdeel van het nextLink-element.
$to	query		string (date-time)	Met ISO 8601 opgemaakte tijdstempel wordt de eindtijd van het interval opgegeven waarop een query moet worden uitgevoerd. Wanneer deze niet is opgegeven, gebruikt de service de aanvraagtijd.
$top	query		integer (int32) minimum: 0	Maximum aantal records dat moet worden geretourneerd.

Antwoorden

Name	Type	Description
200 OK	PolicyStatesQueryResults	Queryresultaten.
Other Status Codes	QueryFailure	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Query latest at resource group scope

Query latest at resource group scope with next link

Query latest at resource group scope

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ComponentStateDetails	Details van onderdeelstatus.
Error	Foutdefinitie.
ExpressionEvaluationDetails	Evaluatiedetails van beleidstaalexpressies.
IfNotExistsEvaluationDetails	Evaluatiedetails van het effect IfNotExists.
PolicyEvaluationDetails	Details van beleidsevaluatie.
PolicyState	Beleidsstatusrecord.
PolicyStatesQueryResults	Queryresultaten.
PolicyStatesResource	De virtuele resource onder Het resourcetype PolicyStates. In een bepaald tijdsbereik vertegenwoordigt 'latest' de meest recente beleidsstatus(s), terwijl 'standaard' alle beleidsstatussen vertegenwoordigt.
QueryFailure	Foutreactie.

ComponentStateDetails

Object

Details van onderdeelstatus.

Name	Type	Description
complianceState	string	Nalevingsstatus van onderdelen.
id	string	Onderdeel-id.
name	string	Onderdeelnaam.
timestamp	string (date-time)	Tijdstempel voor evaluatie van onderdeelnaleving.
type	string	Onderdeeltype.

Error

Object

Foutdefinitie.

Name	Type	Description
code	string	Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.
message	string	Beschrijving van de fout.

ExpressionEvaluationDetails

Object

Evaluatiedetails van beleidstaalexpressies.

Name	Type	Description
expression	string	Expressie geëvalueerd.
expressionKind	string	Het type expressie dat is geëvalueerd.
expressionValue	object	Waarde van de expressie.
operator	string	Operator voor het vergelijken van de expressiewaarde en de doelwaarde.
path	string	Eigenschapspad als de expressie een veld of alias is.
result	string	Evaluatieresultaat.
targetValue	object	Doelwaarde die moet worden vergeleken met de expressiewaarde.

IfNotExistsEvaluationDetails

Object

Evaluatiedetails van het effect IfNotExists.

Name	Type	Description
resourceId	string	Id van de laatst geëvalueerde resource voor IfNotExists-effect.
totalResources	integer	Het totale aantal resources waarop de bestaansvoorwaarde van toepassing is.

PolicyEvaluationDetails

Object

Details van beleidsevaluatie.

Name	Type	Description
evaluatedExpressions	ExpressionEvaluationDetails[]	Details van de geëvalueerde expressies.
ifNotExistsDetails	IfNotExistsEvaluationDetails	Evaluatiedetails van het effect IfNotExists.

PolicyState

Object

Beleidsstatusrecord.

Name	Type	Description
@odata.context	string	OData-contexttekenreeks; wordt gebruikt door OData-clients om typegegevens op te lossen op basis van metagegevens.
@odata.id	string	OData-entiteits-id; altijd ingesteld op null omdat records voor beleidsstatus geen entiteits-id hebben.
complianceState	string	Nalevingsstatus van de resource.
components	ComponentStateDetails[]	Nalevingsrecords voor onderdelenstatussen worden alleen ingevuld wanneer de URL $expand=component onderdelen bevat.
effectiveParameters	string	Effectieve parameters voor de beleidstoewijzing.
isCompliant	boolean	Vlag die aangeeft of de resource compatibel is met de beleidstoewijzing waarop deze is geëvalueerd. Deze eigenschap is afgeschaft; Gebruik in plaats daarvan ComplianceState.
managementGroupIds	string	Door komma's gescheiden lijst met beheergroep-id's, die de hiërarchie van de beheergroepen vertegenwoordigen waaronder de resource zich bevindt.
policyAssignmentId	string	Id van beleidstoewijzing.
policyAssignmentName	string	Naam van beleidstoewijzing.
policyAssignmentOwner	string	Eigenaar van beleidstoewijzing.
policyAssignmentParameters	string	Beleidstoewijzingsparameters.
policyAssignmentScope	string	Bereik van beleidstoewijzing.
policyAssignmentVersion	string	Versie van beleidstoewijzing geëvalueerd.
policyDefinitionAction	string	Actie voor beleidsdefinitie, bijvoorbeeld effect.
policyDefinitionCategory	string	Categorie beleidsdefinitie.
policyDefinitionGroupNames	string[]	Namen van beleidsdefinitiegroepen.
policyDefinitionId	string	Id van beleidsdefinitie.
policyDefinitionName	string	Naam van beleidsdefinitie.
policyDefinitionReferenceId	string	Referentie-id voor de beleidsdefinitie in de beleidsset, als de beleidstoewijzing voor een beleidsset is.
policyDefinitionVersion	string	Versie van beleidsdefinitie geëvalueerd.
policyEvaluationDetails	PolicyEvaluationDetails	Details van beleidsevaluatie.
policySetDefinitionCategory	string	Definitiecategorie van beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionId	string	Definitie-id van beleidsset, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionName	string	Naam van beleidssetdefinitie, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionOwner	string	Eigenaar van beleidssetdefinitie, als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionParameters	string	Definitieparameters voor beleidssets als de beleidstoewijzing voor een beleidsset is.
policySetDefinitionVersion	string	Geëvalueerde definitieversie van beleidsset.
resourceGroup	string	Naam van de resourcegroep.
resourceId	string	Resource-id.
resourceLocation	string	Resourcelocatie.
resourceTags	string	Lijst met resourcetags.
resourceType	string	Type bron
subscriptionId	string	Abonnements-id.
timestamp	string (date-time)	Tijdstempel voor de beleidsstatusrecord.

PolicyStatesQueryResults

Object

Queryresultaten.

Name	Type	Description
@odata.context	string	OData-contexttekenreeks; wordt gebruikt door OData-clients om typegegevens op te lossen op basis van metagegevens.
@odata.count	integer (int32) minimum: 0	Aantal OData-entiteiten; vertegenwoordigt het aantal geretourneerde beleidsstatusrecords.
@odata.nextLink	string	Odata next link; URL voor het ophalen van de volgende set resultaten.
value	PolicyState[]	Queryresultaten.

PolicyStatesResource

Opsomming

De virtuele resource onder Het resourcetype PolicyStates. In een bepaald tijdsbereik vertegenwoordigt 'latest' de meest recente beleidsstatus(s), terwijl 'standaard' alle beleidsstatussen vertegenwoordigt.

Waarde	Description
default
latest

QueryFailure

Object

Foutreactie.

Name	Type	Description
error	Error	Foutdefinitie.

Delen via

Policy States - List Query Results For Resource Group

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

Query latest at resource group scope

Voorbeeldaanvraag

Voorbeeldrespons

Query latest at resource group scope with next link

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ComponentStateDetails

Error

ExpressionEvaluationDetails

IfNotExistsEvaluationDetails

PolicyEvaluationDetails

PolicyState

PolicyStatesQueryResults

PolicyStatesResource

QueryFailure