Condividi tramite


Policy States - List Query Results For Resource Group

Esegue query sugli stati dei criteri per le risorse nel gruppo di risorse.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
policyStatesResource
path True

PolicyStatesResource

Risorsa virtuale in PolicyStates il tipo di risorsa. In un intervallo di tempo specificato, 'latest' rappresenta gli stati dei criteri più recenti, mentre 'default' rappresenta tutti gli stati dei criteri.

resourceGroupName
path True

string

Nome del gruppo di risorse.

subscriptionId
path True

string

ID abbonamento Microsoft Azure.

api-version
query True

string

Versione dell'API client.

$apply
query

string

OData applica l'espressione per le aggregazioni.

$filter
query

string

Espressione di filtro OData.

$from
query

string (date-time)

Timestamp formattato ISO 8601 che specifica l'ora di inizio dell'intervallo su cui eseguire la query. Se non specificato, il servizio usa ($to - 1 giorno).

$orderby
query

string

Ordinamento dell'espressione utilizzando la notazione OData. Uno o più nomi di colonna delimitati da virgole con un "desc" facoltativo (impostazione predefinita) o "asc", ad esempio "$orderby=PolicyAssignmentId, ResourceId asc".

$select
query

string

Selezionare l'espressione usando la notazione OData. Limita le colonne di ogni record solo a quelle richieste, ad esempio "$select=PolicyAssignmentId, ResourceId".

$skiptoken
query

string

Skiptoken viene fornito solo se una risposta precedente ha restituito un risultato parziale come parte dell'elemento nextLink.

$to
query

string (date-time)

Timestamp formattato ISO 8601 che specifica l'ora di fine dell'intervallo su cui eseguire la query. Se non specificato, il servizio usa l'ora della richiesta.

$top
query

integer (int32)

minimum: 0

Numero massimo di record da restituire.

Risposte

Nome Tipo Descrizione
200 OK

PolicyStatesQueryResults

Risultati della query.

Other Status Codes

QueryFailure

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory OAuth2 Flow

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Query latest at resource group scope
Query latest at resource group scope with next link

Query latest at resource group scope

Esempio di richiesta

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

Risposta di esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
ComponentStateDetails

Dettagli dello stato del componente.

Error

Definizione di errore.

ExpressionEvaluationDetails

Dettagli di valutazione delle espressioni del linguaggio dei criteri.

IfNotExistsEvaluationDetails

Dettagli di valutazione dell'effetto IfNotExists.

PolicyEvaluationDetails

Dettagli della valutazione dei criteri.

PolicyState

Record dello stato dei criteri.

PolicyStatesQueryResults

Risultati della query.

PolicyStatesResource

Risorsa virtuale in PolicyStates il tipo di risorsa. In un intervallo di tempo specificato, 'latest' rappresenta gli stati dei criteri più recenti, mentre 'default' rappresenta tutti gli stati dei criteri.

QueryFailure

Risposta di errore.

ComponentStateDetails

Dettagli dello stato del componente.

Nome Tipo Descrizione
complianceState

string

Stato di conformità del componente.

id

string

ID componente.

name

string

Nome componente.

timestamp

string (date-time)

Timestamp di valutazione della conformità dei componenti.

type

string

Tipo di componente.

Error

Definizione di errore.

Nome Tipo Descrizione
code

string

Codice di errore specifico del servizio che funge da stato secondario per il codice di errore HTTP.

message

string

Descrizione dell'errore.

ExpressionEvaluationDetails

Dettagli di valutazione delle espressioni del linguaggio dei criteri.

Nome Tipo Descrizione
expression

string

Espressione valutata.

expressionKind

string

Tipo di espressione valutata.

expressionValue

object

Valore dell'espressione.

operator

string

Operatore per confrontare il valore dell'espressione e il valore di destinazione.

path

string

Percorso della proprietà se l'espressione è un campo o un alias.

result

string

Risultato della valutazione.

targetValue

object

Valore di destinazione da confrontare con il valore dell'espressione.

IfNotExistsEvaluationDetails

Dettagli di valutazione dell'effetto IfNotExists.

Nome Tipo Descrizione
resourceId

string

ID dell'ultima risorsa valutata per l'effetto IfNotExists.

totalResources

integer

Numero totale di risorse a cui è applicabile la condizione di esistenza.

PolicyEvaluationDetails

Dettagli della valutazione dei criteri.

Nome Tipo Descrizione
evaluatedExpressions

ExpressionEvaluationDetails[]

Dettagli delle espressioni valutate.

ifNotExistsDetails

IfNotExistsEvaluationDetails

Dettagli di valutazione dell'effetto IfNotExists.

PolicyState

Record dello stato dei criteri.

Nome Tipo Descrizione
@odata.context

string

Stringa di contesto OData; usato dai client OData per risolvere le informazioni sul tipo in base ai metadati.

@odata.id

string

ID entità OData; sempre impostato su Null perché i record di stato dei criteri non hanno un ID entità.

complianceState

string

Stato di conformità della risorsa.

components

ComponentStateDetails[]

I record di conformità dello stato dei componenti vengono popolati solo quando l'URL contiene $expand=clausola components.

effectiveParameters

string

Parametri effettivi per l'assegnazione dei criteri.

isCompliant

boolean

Flag che indica se la risorsa è conforme all'assegnazione di criteri rispetto all'assegnazione di criteri rispetto a cui è stata valutata. Questa proprietà è deprecata; Usare invece ComplianceState.

managementGroupIds

string

Elenco delimitato da virgole degli ID dei gruppi di gestione, che rappresentano la gerarchia dei gruppi di gestione in cui si trova la risorsa.

policyAssignmentId

string

ID assegnazione criteri.

policyAssignmentName

string

Nome dell'assegnazione dei criteri.

policyAssignmentOwner

string

Proprietario dell'assegnazione dei criteri.

policyAssignmentParameters

string

Parametri di assegnazione dei criteri.

policyAssignmentScope

string

Ambito di assegnazione dei criteri.

policyAssignmentVersion

string

Versione dell'assegnazione dei criteri valutata.

policyDefinitionAction

string

Azione di definizione dei criteri, ovvero effetto.

policyDefinitionCategory

string

Categoria di definizione dei criteri.

policyDefinitionGroupNames

string[]

Nomi dei gruppi di definizione dei criteri.

policyDefinitionId

string

ID definizione criteri.

policyDefinitionName

string

Nome della definizione dei criteri.

policyDefinitionReferenceId

string

ID di riferimento per la definizione di criteri all'interno del set di criteri, se l'assegnazione dei criteri è per un set di criteri.

policyDefinitionVersion

string

Versione della definizione dei criteri valutata.

policyEvaluationDetails

PolicyEvaluationDetails

Dettagli della valutazione dei criteri.

policySetDefinitionCategory

string

Categoria di definizione del set di criteri, se l'assegnazione dei criteri è per un set di criteri.

policySetDefinitionId

string

ID definizione del set di criteri, se l'assegnazione dei criteri è per un set di criteri.

policySetDefinitionName

string

Nome della definizione del set di criteri, se l'assegnazione dei criteri è per un set di criteri.

policySetDefinitionOwner

string

Proprietario della definizione del set di criteri, se l'assegnazione dei criteri è per un set di criteri.

policySetDefinitionParameters

string

Parametri di definizione del set di criteri, se l'assegnazione dei criteri è per un set di criteri.

policySetDefinitionVersion

string

Versione della definizione del set di criteri valutata.

resourceGroup

string

Nome del gruppo di risorse.

resourceId

string

ID risorsa.

resourceLocation

string

Percorso della risorsa.

resourceTags

string

Elenco dei tag delle risorse.

resourceType

string

Tipo di risorsa.

subscriptionId

string

ID sottoscrizione.

timestamp

string (date-time)

Timestamp per il record dello stato dei criteri.

PolicyStatesQueryResults

Risultati della query.

Nome Tipo Descrizione
@odata.context

string

Stringa di contesto OData; usato dai client OData per risolvere le informazioni sul tipo in base ai metadati.

@odata.count

integer (int32)

minimum: 0

Numero di entità OData; rappresenta il numero di record di stato dei criteri restituiti.

@odata.nextLink

string

Collegamento successivo di Odata; URL per ottenere il set di risultati successivo.

value

PolicyState[]

Risultati della query.

PolicyStatesResource

Risorsa virtuale in PolicyStates il tipo di risorsa. In un intervallo di tempo specificato, 'latest' rappresenta gli stati dei criteri più recenti, mentre 'default' rappresenta tutti gli stati dei criteri.

Valore Descrizione
default
latest

QueryFailure

Risposta di errore.

Nome Tipo Descrizione
error

Error

Definizione di errore.