Delen via


Policy States - List Query Results For Resource Group

Statussen van querybeleid voor de resources onder de resourcegroep.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults?api-version=2019-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 PolicyStates resourcetype. In een bepaald tijdsbereik staat 'meest recente' voor 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-expressie toepassen voor aggregaties.

$filter
query

string

OData-filterexpressie.

$from
query

string

date-time

Tijdstempel met ISO 8601-indeling die de begintijd aangeeft van het interval om een query uit te voeren. Wanneer deze niet is opgegeven, gebruikt de service ($to - 1 dag).

$orderby
query

string

De expressie ordenen met behulp van de 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

Selecteer de expressie met behulp van de OData-notatie. Beperkt de kolommen voor elke record tot alleen de kolommen die zijn aangevraagd, 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

Tijdstempel met ISO 8601-indeling die de eindtijd aangeeft van het interval dat moet worden opgevraagd. Wanneer deze niet is opgegeven, gebruikt de service aanvraagtijd.

$top
query

integer

int32

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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Sample Request

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

Sample Response

{
  "@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"
    }
  ]
}

Sample Request

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

Sample Response

{
  "@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 de onderdeelstatus.

Error

Foutdefinitie.

ExpressionEvaluationDetails

Evaluatiedetails van beleidstaalexpressies.

IfNotExistsEvaluationDetails

Evaluatiedetails van het IfNotExists-effect.

PolicyEvaluationDetails

Details van beleidsevaluatie.

PolicyState

Beleidsstatusrecord.

PolicyStatesQueryResults

Queryresultaten.

PolicyStatesResource

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

QueryFailure

Foutreactie.

ComponentStateDetails

Details van de onderdeelstatus.

Name Type Description
complianceState

string

Nalevingsstatus van onderdelen.

id

string

Onderdeel-id.

name

string

Onderdeelnaam.

timestamp

string

Tijdstempel van evaluatie van onderdeelcompatibiliteit.

type

string

Onderdeeltype.

Error

Foutdefinitie.

Name Type Description
code

string

Servicespecifieke foutcode die fungeert als de substatus voor de HTTP-foutcode.

message

string

Beschrijving van de fout.

ExpressionEvaluationDetails

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 om de expressiewaarde en de doelwaarde te vergelijken.

path

string

Eigenschapspad als de expressie een veld of een alias is.

result

string

Evaluatieresultaat.

targetValue

object

Doelwaarde die moet worden vergeleken met de expressiewaarde.

IfNotExistsEvaluationDetails

Evaluatiedetails van het IfNotExists-effect.

Name Type Description
resourceId

string

Id van de laatst geëvalueerde resource voor het IfNotExists-effect.

totalResources

integer

Totaal aantal resources waarop de bestaansvoorwaarde van toepassing is.

PolicyEvaluationDetails

Details van beleidsevaluatie.

Name Type Description
evaluatedExpressions

ExpressionEvaluationDetails[]

Details van de geëvalueerde expressies.

ifNotExistsDetails

IfNotExistsEvaluationDetails

Evaluatiedetails van het IfNotExists-effect.

PolicyState

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 beleidsstatusrecords geen entiteits-id hebben.

complianceState

string

Nalevingsstatus van de resource.

components

ComponentStateDetails[]

Statuscompatibiliteitsrecords van onderdelen worden alleen ingevuld wanneer de URL de component $expand=components bevat.

effectiveParameters

string

Effectieve parameters voor de beleidstoewijzing.

isCompliant

boolean

Vlag die aangeeft of de resource compatibel is met de beleidstoewijzing die 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 vertegenwoordigen van de beheergroepen waaronder de resource zich bevindt.

policyAssignmentId

string

Beleidstoewijzings-id.

policyAssignmentName

string

Naam van beleidstoewijzing.

policyAssignmentOwner

string

Eigenaar van beleidstoewijzing.

policyAssignmentParameters

string

Parameters voor beleidstoewijzing.

policyAssignmentScope

string

Bereik van beleidstoewijzing.

policyAssignmentVersion

string

Geëvalueerde versie van beleidstoewijzing.

policyDefinitionAction

string

Beleidsdefinitieactie, dat wil zeggen effect.

policyDefinitionCategory

string

Beleidsdefinitiecategorie.

policyDefinitionGroupNames

string[]

Namen van beleidsdefinitiegroepen.

policyDefinitionId

string

Beleidsdefinitie-id.

policyDefinitionName

string

Naam van beleidsdefinitie.

policyDefinitionReferenceId

string

Referentie-id voor de beleidsdefinitie in de beleidsset, als de beleidstoewijzing voor een beleidsset is.

policyDefinitionVersion

string

Geëvalueerde beleidsdefinitieversie.

policyEvaluationDetails

PolicyEvaluationDetails

Details van beleidsevaluatie.

policySetDefinitionCategory

string

Definitiecategorie van de beleidsset, als de beleidstoewijzing voor een beleidsset is.

policySetDefinitionId

string

Definitie-id van beleidsset, als de beleidstoewijzing voor een beleidsset is.

policySetDefinitionName

string

Definitienaam van beleidsset, als de beleidstoewijzing voor een beleidsset is.

policySetDefinitionOwner

string

Eigenaar van de beleidssetdefinitie, als de beleidstoewijzing voor een beleidsset is.

policySetDefinitionParameters

string

Parameters voor beleidssetdefinities, als de beleidstoewijzing voor een beleidsset is.

policySetDefinitionVersion

string

Geëvalueerde versie van de definitie van de beleidsset.

resourceGroup

string

Naam van de resourcegroep.

resourceId

string

Resource-id.

resourceLocation

string

Resourcelocatie.

resourceTags

string

Lijst met resourcetags.

resourceType

string

Resourcetype.

subscriptionId

string

Abonnements-id.

timestamp

string

Tijdstempel voor de beleidsstatusrecord.

PolicyStatesQueryResults

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

Aantal OData-entiteiten; vertegenwoordigt het aantal geretourneerde beleidsstatusrecords.

@odata.nextLink

string

Odata volgende koppeling; URL om de volgende set resultaten op te halen.

value

PolicyState[]

Queryresultaten.

PolicyStatesResource

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

Name Type Description
default

string

latest

string

QueryFailure

Foutreactie.

Name Type Description
error

Error

Foutdefinitie.