Remediations - List For Management Group

Ottiene tutte le correzioni per il gruppo di gestione.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
managementGroupId
path True

string

ID gruppo di gestione.

managementGroupsNamespace
path True

ManagementGroupsNamespaceType

Spazio dei nomi per Microsoft Management RP; solo "Microsoft.Management" è consentito.

api-version
query True

string

Versione dell'API client.

$filter
query

string

Espressione di filtro OData.

$top
query

integer

int32

Numero massimo di record da restituire.

Risposte

Nome Tipo Descrizione
200 OK

RemediationListResult

Correzioni recuperate.

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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

List remediations at management group scope

Sample Request

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

Sample Response

{
  "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

Sample Request

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

Sample Response

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

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.

ErrorDefinition

Definizione di errore.

ErrorResponse

Risposta di errore.

FailureThreshold

Impostazioni di soglia degli errori di correzione

ManagementGroupsNamespaceType

Spazio dei nomi per Microsoft Management RP; solo "Microsoft.Management" è consentito.

Remediation

Definizione di correzione.

RemediationDeploymentSummary

Riepilogo dello stato della distribuzione per tutte le distribuzioni create dalla correzione.

RemediationFilters

Filtri che verranno applicati per determinare quali risorse correggere.

RemediationListResult

Elenco delle correzioni.

ResourceDiscoveryMode

Il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è EsistenteNonCompliant se non specificato.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

TypedErrorInfo

Dettagli degli errori specifici dello scenario.

createdByType

Tipo di identità che ha creato la risorsa.

Nome Tipo Descrizione
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorDefinition

Definizione di errore.

Nome Tipo Descrizione
additionalInfo

TypedErrorInfo[]

Dettagli aggiuntivi sugli errori specifici dello scenario.

code

string

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

details

ErrorDefinition[]

Dettagli dell'errore interno.

message

string

Descrizione dell'errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore.

Nome Tipo Descrizione
error

ErrorDefinition

Dettagli dell'errore.

FailureThreshold

Impostazioni di soglia degli errori di correzione

Nome Tipo Descrizione
percentage

number

Numero compreso tra 0,0 e 1,0 che rappresenta la soglia di errore percentuale. La correzione avrà esito negativo se la percentuale di operazioni di correzione non riuscite (ovvero distribuzioni non riuscite) supera questa soglia.

ManagementGroupsNamespaceType

Spazio dei nomi per Microsoft Management RP; solo "Microsoft.Management" è consentito.

Nome Tipo Descrizione
Microsoft.Management

string

Remediation

Definizione di correzione.

Nome Tipo Descrizione
id

string

ID della correzione.

name

string

Nome della correzione.

properties.correlationId

string

ID correlazione di correzione. Può essere usato per trovare eventi correlati alla correzione nel log attività.

properties.createdOn

string

Ora in cui è stata creata la correzione.

properties.deploymentStatus

RemediationDeploymentSummary

Riepilogo dello stato della distribuzione per tutte le distribuzioni create dalla correzione.

properties.failureThreshold

FailureThreshold

Impostazioni di soglia degli errori di correzione

properties.filters

RemediationFilters

Filtri che verranno applicati per determinare quali risorse correggere.

properties.lastUpdatedOn

string

Ora in cui è stata aggiornata l'ultima correzione.

properties.parallelDeployments

integer

Determina il numero di risorse da correggere in qualsiasi momento. Può essere usato per aumentare o ridurre il ritmo della correzione. Se non specificato, viene usato il valore predefinito delle distribuzioni parallele.

properties.policyAssignmentId

string

ID risorsa dell'assegnazione di criteri da correggere.

properties.policyDefinitionReferenceId

string

ID di riferimento alla definizione dei criteri della singola definizione che deve essere correzionato. Obbligatorio quando l'assegnazione di criteri da correggere assegna una definizione del set di criteri.

properties.provisioningState

string

Stato della correzione. Ciò fa riferimento all'intera attività di correzione, non alle singole distribuzioni. I valori consentiti sono La valutazione, l'annullamento, l'annullamento, il completamento o l'esito positivo.

properties.resourceCount

integer

Determina il numero massimo di risorse che possono essere correttive dal processo di correzione. Se non specificato, viene usato il conteggio delle risorse predefinito.

properties.resourceDiscoveryMode

ResourceDiscoveryMode

Il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è EsistenteNonCompliant se non specificato.

properties.statusMessage

string

Messaggio di stato di correzione. Fornisce altri dettagli sullo stato della correzione.

systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createBy e modificateBy.

type

string

Tipo della correzione.

RemediationDeploymentSummary

Riepilogo dello stato della distribuzione per tutte le distribuzioni create dalla correzione.

Nome Tipo Descrizione
failedDeployments

integer

Numero di distribuzioni richieste dalla correzione non riuscita.

successfulDeployments

integer

Numero di distribuzioni richieste dalla correzione riuscita.

totalDeployments

integer

Numero di distribuzioni richieste dalla correzione.

RemediationFilters

Filtri che verranno applicati per determinare quali risorse correggere.

Nome Tipo Descrizione
locations

string[]

Percorsi delle risorse che verranno risolti.

RemediationListResult

Elenco delle correzioni.

Nome Tipo Descrizione
nextLink

string

URL per ottenere il set successivo di risultati.

value

Remediation[]

Matrice di definizioni di correzione.

ResourceDiscoveryMode

Il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è EsistenteNonCompliant se non specificato.

Nome Tipo Descrizione
ExistingNonCompliant

string

Correggere le risorse già note come non conformi.

ReEvaluateCompliance

string

Rivalutare lo stato di conformità delle risorse e quindi correggere le risorse trovate non conformi.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string

Timestamp della creazione di risorse (UTC).

createdBy

string

Identità che ha creato la risorsa.

createdByType

createdByType

Tipo di identità che ha creato la risorsa.

lastModifiedAt

string

Timestamp dell'ultima modifica della risorsa (UTC)

lastModifiedBy

string

Identità che ha modificato l'ultima risorsa.

lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima risorsa.

TypedErrorInfo

Dettagli degli errori specifici dello scenario.

Nome Tipo Descrizione
info

Dettagli dell'errore specifico dello scenario.

type

string

Tipo di dettagli di errore inclusi.