Partager via


Remediations - List For Management Group

Obtient toutes les corrections du groupe d’administration.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?$top={$top}&$filter={$filter}&api-version=2021-10-01

Paramètres URI

Nom Dans Obligatoire Type Description
managementGroupId
path True

string

ID du groupe d’administration.

managementGroupsNamespace
path True

ManagementGroupsNamespaceType

Espace de noms pour Microsoft Management RP ; seul « Microsoft.Management » est autorisé.

api-version
query True

string

Version de l’API cliente.

$filter
query

string

Expression de filtre OData.

$top
query

integer

int32

Nombre maximal d’enregistrements à retourner.

Réponses

Nom Type Description
200 OK

RemediationListResult

Corrections récupérées.

Other Status Codes

ErrorResponse

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

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation Emprunter l’identité de votre compte d’utilisateur

Exemples

List remediations at management group scope
List remediations at management group scope with query parameters

List remediations at management group scope

Exemple de requête

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01

Exemple de réponse

{
  "value": [
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        "provisioningState": "Succeeded",
        "createdOn": "2018-09-13T21:51:09.075918Z",
        "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z",
        "resourceDiscoveryMode": "ExistingNonCompliant",
        "deploymentStatus": {
          "totalDeployments": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
        "resourceCount": 42,
        "parallelDeployments": 6,
        "failureThreshold": {
          "percentage": 0.1
        }
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "type": "Microsoft.PolicyInsights/remediations",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "createdByType": "User",
        "createdAt": "2018-09-13T21:51:09.075918Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-09-13T21:52:10.0011706Z"
      }
    },
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        "provisioningState": "Succeeded",
        "createdOn": "2018-09-13T21:49:16.4638131Z",
        "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z",
        "resourceDiscoveryMode": "ExistingNonCompliant",
        "deploymentStatus": {
          "totalDeployments": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "957378d3-a143-421e-8b0e-3048dff01932"
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
      "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
      "type": "Microsoft.PolicyInsights/remediations",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "createdByType": "User",
        "createdAt": "2018-09-13T21:49:16.4638131Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
      }
    }
  ]
}

List remediations at management group scope with query parameters

Exemple de requête

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?$top=1&$filter=PolicyAssignmentId eq '/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'&api-version=2021-10-01

Exemple de réponse

{
  "value": [
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        "provisioningState": "Succeeded",
        "createdOn": "2018-09-13T21:51:09.075918Z",
        "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z",
        "resourceDiscoveryMode": "ExistingNonCompliant",
        "deploymentStatus": {
          "totalDeployments": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6",
        "resourceCount": 42,
        "parallelDeployments": 6,
        "failureThreshold": {
          "percentage": 0.1
        }
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "type": "Microsoft.PolicyInsights/remediations",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "createdByType": "User",
        "createdAt": "2018-09-13T21:51:09.075918Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-09-13T21:52:10.0011706Z"
      }
    }
  ]
}

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.

ErrorDefinition

Définition de l’erreur.

ErrorResponse

Réponse d’erreur.

FailureThreshold

Paramètres du seuil d’échec de correction

ManagementGroupsNamespaceType

Espace de noms pour Microsoft Management RP ; seul « Microsoft.Management » est autorisé.

Remediation

Définition de correction.

RemediationDeploymentSummary

Le déploiement status résumé de tous les déploiements créés par la correction.

RemediationFilters

Filtres qui seront appliqués pour déterminer les ressources à corriger.

RemediationListResult

Liste des corrections.

ResourceDiscoveryMode

La façon dont les ressources à corriger sont découvertes. La valeur par défaut est ExistingNonCompliant si elle n’est pas spécifiée.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

TypedErrorInfo

Détails de l’erreur spécifique au scénario.

createdByType

Type d’identité qui a créé la ressource.

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Définition de l’erreur.

Nom Type Description
additionalInfo

TypedErrorInfo[]

Détails d’erreur supplémentaires spécifiques au scénario.

code

string

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

details

ErrorDefinition[]

Détails de l’erreur interne.

message

string

Description de l'erreur.

target

string

Cible de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error

ErrorDefinition

Détails de l’erreur.

FailureThreshold

Paramètres du seuil d’échec de correction

Nom Type Description
percentage

number

Nombre compris entre 0,0 et 1,0 représentant le seuil de pourcentage d’échec. La correction échoue si le pourcentage d’opérations de correction ayant échoué (c’est-à-dire les déploiements ayant échoué) dépasse ce seuil.

ManagementGroupsNamespaceType

Espace de noms pour Microsoft Management RP ; seul « Microsoft.Management » est autorisé.

Nom Type Description
Microsoft.Management

string

Remediation

Définition de correction.

Nom Type Description
id

string

ID de la correction.

name

string

Nom de la correction.

properties.correlationId

string

ID de corrélation de correction. Peut être utilisé pour rechercher des événements liés à la correction dans le journal d’activité.

properties.createdOn

string

Heure à laquelle la correction a été créée.

properties.deploymentStatus

RemediationDeploymentSummary

Le déploiement status résumé de tous les déploiements créés par la correction.

properties.failureThreshold

FailureThreshold

Paramètres du seuil d’échec de correction

properties.filters

RemediationFilters

Filtres qui seront appliqués pour déterminer les ressources à corriger.

properties.lastUpdatedOn

string

Heure de la dernière mise à jour de la correction.

properties.parallelDeployments

integer

Détermine le nombre de ressources à corriger à un moment donné. Peut être utilisé pour augmenter ou réduire le rythme de la correction. Si elle n’est pas fournie, la valeur par défaut des déploiements parallèles est utilisée.

properties.policyAssignmentId

string

ID de ressource de l’affectation de stratégie qui doit être corrigée.

properties.policyDefinitionReferenceId

string

ID de référence de définition de stratégie de la définition individuelle qui doit être corrigée. Obligatoire lorsque l’affectation de stratégie en cours de correction affecte une définition de jeu de stratégies.

properties.provisioningState

string

Status de la correction. Cela fait référence à l’ensemble de la tâche de correction, et non à des déploiements individuels. Les valeurs autorisées sont Evaluation, Canceled, Cancelling, Failed, Complete ou Succeeded.

properties.resourceCount

integer

Détermine le nombre maximal de ressources pouvant être corrigées par le travail de correction. S’il n’est pas fourni, le nombre de ressources par défaut est utilisé.

properties.resourceDiscoveryMode

ResourceDiscoveryMode

La façon dont les ressources à corriger sont découvertes. La valeur par défaut est ExistingNonCompliant si elle n’est pas spécifiée.

properties.statusMessage

string

Message de correction status. Fournit des détails supplémentaires sur l’état de la correction.

systemData

systemData

Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.

type

string

Type de la correction.

RemediationDeploymentSummary

Le déploiement status résumé de tous les déploiements créés par la correction.

Nom Type Description
failedDeployments

integer

Nombre de déploiements requis par la correction qui ont échoué.

successfulDeployments

integer

Nombre de déploiements requis par la correction qui ont réussi.

totalDeployments

integer

Nombre de déploiements requis par la correction.

RemediationFilters

Filtres qui seront appliqués pour déterminer les ressources à corriger.

Nom Type Description
locations

string[]

Emplacements des ressources qui seront corrigés.

RemediationListResult

Liste des corrections.

Nom Type Description
nextLink

string

URL permettant d’obtenir l’ensemble de résultats suivant.

value

Remediation[]

Tableau de définitions de correction.

ResourceDiscoveryMode

La façon dont les ressources à corriger sont découvertes. La valeur par défaut est ExistingNonCompliant si elle n’est pas spécifiée.

Nom Type Description
ExistingNonCompliant

string

Corriger les ressources qui sont déjà connues pour être non conformes.

ReEvaluateCompliance

string

Réévaluez l’état de conformité des ressources, puis corrigez les ressources non conformes.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string

Horodatage de la création de ressources (UTC).

createdBy

string

Identité qui a créé la ressource.

createdByType

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt

string

Horodatage de la dernière modification de la ressource (UTC)

lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

TypedErrorInfo

Détails de l’erreur spécifique au scénario.

Nom Type Description
info

Détails de l’erreur spécifique au scénario.

type

string

Type de détails d’erreur inclus.