Policy States - Summarize For Policy Set Definition

Résume les États de stratégie pour la définition de l’ensemble de stratégies de niveau d’abonnement.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/policySetDefinitions/{policySetDefinitionName}/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top={$top}&$from={$from}&$to={$to}&$filter={$filter}

Paramètres URI

Name In Required Type Description
authorizationNamespace
path True
  • string

Espace de noms pour le fournisseur de ressources d’autorisation Microsoft ; seul « Microsoft. Authorization » est autorisé.

policySetDefinitionName
path True
  • string

Nom de la définition de l’ensemble de stratégies.

policyStatesSummaryResource
path True
  • string

Ressource virtuelle sous le type de ressource PolicyStates pour la synthèse de l’action. Dans un intervalle de temps donné, 'latest’représente les derniers États de stratégie et est la seule valeur autorisée.

subscriptionId
path True
  • string

ID d’abonnement Microsoft Azure.

api-version
query True
  • string

Version de l’API cliente.

$filter
query
  • string

Expression de filtre OData.

$from
query
  • string
date-time

Horodatage au format ISO 8601 spécifiant l’heure de début de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise ($to-1-jour).

$to
query
  • string
date-time

Horodatage au format ISO 8601 spécifiant l’heure de fin de l’intervalle à interroger. Lorsqu’il n’est pas spécifié, le service utilise le temps de requête.

$top
query
  • integer
int32

Nombre maximal d’enregistrements à retourner.

Réponses

Name Type Description
200 OK

Résumer les résultats.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

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

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Summarize at policy set definition scope

Sample Request

POST https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/summarize?api-version=2019-10-01&$top=1&$from=2019-10-05T18:00:00Z&$to=2019-10-06T18:00:00Z&$filter=PolicyDefinitionAction eq 'deny'

Sample Response

{
  "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": null,
      "@odata.context": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/$metadata#summary/$entity",
      "results": {
        "queryResultsUri": "https://management.azure.com/subscriptions/fffedd8f-ffff-fffd-fffd-fffed2f84852/providers/Microsoft.Authorization/policySetDefinitions/3e3807c1-65c9-49e0-a406-82d8ae3e338c/providers/Microsoft.PolicyInsights/policyStates/latest/queryResults?api-version=2019-10-01&$from=2019-10-05 18:00:00Z&$to=2019-10-06 18:00:00Z&$filter=(PolicyDefinitionAction eq 'deny') and IsCompliant eq false",
        "nonCompliantResources": 0,
        "nonCompliantPolicies": 0,
        "resourceDetails": [
          {
            "complianceState": "compliant",
            "count": 140
          }
        ],
        "policyDetails": [
          {
            "complianceState": "compliant",
            "count": 1
          }
        ],
        "policyGroupDetails": [
          {
            "complianceState": "compliant",
            "count": 1
          }
        ]
      },
      "policyAssignments": []
    }
  ]
}

Définitions

ComplianceDetail

Cumul de l’état de conformité.

Error

Définition de l’erreur.

PolicyAssignmentSummary

Résumé de l’attribution de stratégie.

PolicyDefinitionSummary

Résumé de la définition de stratégie.

PolicyGroupSummary

Résumé du groupe de définitions de stratégie.

QueryFailure

Réponse d’erreur.

SummarizeResults

Résumer les résultats des actions.

Summary

Résumé des résultats.

SummaryResults

Résumé de la conformité au niveau d’un résumé particulier.

ComplianceDetail

Cumul de l’état de conformité.

Name Type Description
complianceState
  • string

État de conformité.

count
  • integer

Valeur de nombre résumée pour cet état de conformité.

Error

Définition de l’erreur.

Name Type Description
code
  • string

Code d’erreur spécifique au service qui sert de sous-état du code d’erreur HTTP.

message
  • string

Description de l'erreur.

PolicyAssignmentSummary

Résumé de l’attribution de stratégie.

Name Type Description
policyAssignmentId
  • string

ID d’attribution de stratégie.

policyDefinitions

Résumé des définitions de stratégie.

policyGroups

Résumé du groupe de définitions de stratégie.

policySetDefinitionId
  • string

ID de définition de l’ensemble de stratégies, si l’attribution de stratégie concerne un ensemble de stratégies.

results

Résumé de la conformité de l’attribution de stratégie.

PolicyDefinitionSummary

Résumé de la définition de stratégie.

Name Type Description
effect
  • string

Effet de stratégie, c.-à-d. action de définition de stratégie.

policyDefinitionGroupNames
  • string[]

Noms des groupes de définitions de stratégie.

policyDefinitionId
  • string

ID de définition de stratégie.

policyDefinitionReferenceId
  • string

ID de référence de la définition de stratégie.

results

Résumé de la conformité pour la définition de stratégie.

PolicyGroupSummary

Résumé du groupe de définitions de stratégie.

Name Type Description
policyGroupName
  • string

Nom du groupe de stratégies.

results

Résumé de la conformité pour le groupe de définitions de stratégie.

QueryFailure

Réponse d’erreur.

Name Type Description
error

Définition de l’erreur.

SummarizeResults

Résumer les résultats des actions.

Name Type Description
@odata.context
  • string

Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées.

@odata.count
  • integer

Nombre d’entités OData ; représente le nombre de résumés retournés ; toujours défini sur 1.

value

Résumer les résultats des actions.

Summary

Résumé des résultats.

Name Type Description
@odata.context
  • string

Chaîne de contexte OData ; utilisé par les clients OData pour résoudre les informations de type en fonction des métadonnées.

@odata.id
  • string

ID d’entité OData ; toujours défini sur null, car les résumés n’ont pas d’ID d’entité.

policyAssignments

Résumé des attributions de stratégie.

results

Résumé de la conformité pour toutes les attributions de stratégie.

SummaryResults

Résumé de la conformité au niveau d’un résumé particulier.

Name Type Description
nonCompliantPolicies
  • integer

Nombre de stratégies non conformes.

nonCompliantResources
  • integer

Nombre de ressources non conformes.

policyDetails

Résumé de l’artefact de stratégie à ce niveau. Pour le niveau de l’étendue de la requête, il représente le résumé de l’attribution de stratégie. Pour le niveau d’attribution de stratégie, il représente le résumé des définitions de stratégie.

policyGroupDetails

Résumé du groupe de définitions de stratégie à ce niveau.

queryResultsUri
  • string

URI HTTP Après l’action queryResults sur Microsoft. PolicyInsights pour récupérer les résultats bruts pour le résumé de la conformité. Cette propriété n’est pas disponible par défaut dans les versions ultérieures de l’API, mais elle peut être interrogée explicitement.

resourceDetails

Résumé des ressources à ce niveau.