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

Name In Required Type Description
managementGroupId
path True
  • string

ID gruppo di gestione.

managementGroupsNamespace
path True

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

api-version
query True
  • string

Versione api client.

$filter
query
  • string

Espressione di filtro OData.

$top
query
  • integer
int32

Numero massimo di record da restituire.

Risposte

Name Type Description
200 OK

Correzioni recuperate.

Other Status Codes

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

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
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

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; è consentito solo "Microsoft.Management".

Remediation

Definizione di correzione.

RemediationDeploymentSummary

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

RemediationFilters

Filtri che verranno applicati per determinare le risorse da correggere.

RemediationListResult

Elenco di correzioni.

ResourceDiscoveryMode

Viene individuato il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è ExistingNonCompliant se non specificato.

systemData

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

TypedErrorInfo

Dettagli di errore specifici dello scenario.

createdByType

Tipo di identità che ha creato la risorsa.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorDefinition

Definizione di errore.

Name Type Description
additionalInfo

Dettagli aggiuntivi sull'errore specifici dello scenario.

code
  • string

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

details

Dettagli dell'errore interno.

message
  • string

Descrizione dell'errore.

target
  • string

Destinazione dell'errore.

ErrorResponse

Risposta di errore.

Name Type Description
error

Dettagli dell'errore.

FailureThreshold

Impostazioni di soglia degli errori di correzione

Name Type Description
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 (ad esempio le distribuzioni non riuscite) supera questa soglia.

ManagementGroupsNamespaceType

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

Name Type Description
Microsoft.Management
  • string

Remediation

Definizione di correzione.

Name Type Description
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

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

properties.failureThreshold

Impostazioni di soglia degli errori di correzione

properties.filters

Filtri che verranno applicati per determinare le risorse da correggere.

properties.lastUpdatedOn
  • string

Ora dell'ultimo aggiornamento della 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 dei criteri da correggere.

properties.policyDefinitionReferenceId
  • string

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

properties.provisioningState
  • string

Stato della correzione.

properties.resourceCount
  • integer

Determina il numero massimo di risorse che è possibile correggere dal processo di correzione. Se non specificato, viene usato il numero di risorse predefinito.

properties.resourceDiscoveryMode

Viene individuato il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è ExistingNonCompliant se non specificato.

properties.statusMessage
  • string

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

systemData

Azure Resource Manager metadati contenenti le informazioni createdBy e modifiedBy.

type
  • string

Tipo della correzione.

RemediationDeploymentSummary

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

Name Type Description
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 le risorse da correggere.

Name Type Description
locations
  • string[]

Percorsi delle risorse che verranno corretti.

RemediationListResult

Elenco di correzioni.

Name Type Description
nextLink
  • string

URL per ottenere il set di risultati successivo.

value

Matrice di definizioni di correzione.

ResourceDiscoveryMode

Viene individuato il modo in cui vengono individuate le risorse da correggere. Il valore predefinito è ExistingNonCompliant se non specificato.

Name Type Description
ExistingNonCompliant
  • string

Correggere le risorse già note come non conformi.

ReEvaluateCompliance
  • string

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

systemData

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

Name Type Description
createdAt
  • string

Timestamp della creazione di risorse (UTC).

createdBy
  • string

Identità che ha creato la risorsa.

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 volta la risorsa.

lastModifiedByType

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

TypedErrorInfo

Dettagli di errore specifici dello scenario.

Name Type Description
info

Dettagli dell'errore specifico dello scenario.

type
  • string

Tipo di dettagli dell'errore inclusi.