Remediations - List For Management Group

Obtiene todas las correcciones del grupo de administración.

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

Parámetros de identificador URI

Name In Required Type Description
managementGroupId
path True
  • string

Identificador del grupo de administración.

managementGroupsNamespace
path True

El espacio de nombres de Microsoft Management RP; solo se permite "Microsoft.Management".

api-version
query True
  • string

Versión de api de cliente.

$filter
query
  • string

Expresión de filtro de OData.

$top
query
  • integer
int32

Número máximo de registros que se van a devolver.

Respuestas

Name Type Description
200 OK

Las correcciones recuperadas.

Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

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 suplantar la cuenta de usuario

Ejemplos

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

Definiciones

createdByType

Tipo de identidad que creó el recurso.

ErrorDefinition

Definición de error.

ErrorResponse

Respuesta de error.

FailureThreshold

Configuración del umbral de error de corrección

ManagementGroupsNamespaceType

El espacio de nombres de Microsoft Management RP; solo se permite "Microsoft.Management".

Remediation

Definición de corrección.

RemediationDeploymentSummary

Resumen del estado de implementación de todas las implementaciones creadas por la corrección.

RemediationFilters

Filtros que se aplicarán para determinar qué recursos corregir.

RemediationListResult

Lista de correcciones.

ResourceDiscoveryMode

Se detecta la forma en que se detectan los recursos para corregirlos. El valor predeterminado es ExistingNonCompliant si no se especifica.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

TypedErrorInfo

Detalles de error específicos del escenario.

createdByType

Tipo de identidad que creó el recurso.

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

ErrorDefinition

Definición de error.

Name Type Description
additionalInfo

Detalles adicionales del error específico del escenario.

code
  • string

Código de error específico del servicio que actúa como subestado para el código de error HTTP.

details

Detalles internos del error.

message
  • string

Descripción del error.

target
  • string

Destino del error.

ErrorResponse

Respuesta de error.

Name Type Description
error

Los detalles del error.

FailureThreshold

Configuración del umbral de error de corrección

Name Type Description
percentage
  • number

Número comprendido entre 0,0 y 1,0 que representa el umbral de error porcentual. Se producirá un error en la corrección si el porcentaje de operaciones de corrección con errores (es decir, implementaciones con errores) supera este umbral.

ManagementGroupsNamespaceType

El espacio de nombres de Microsoft Management RP; solo se permite "Microsoft.Management".

Name Type Description
Microsoft.Management
  • string

Remediation

Definición de corrección.

Name Type Description
id
  • string

Identificador de la corrección.

name
  • string

Nombre de la corrección.

properties.correlationId
  • string

Identificador de correlación de corrección. Se puede usar para buscar eventos relacionados con la corrección en el registro de actividad.

properties.createdOn
  • string

Hora a la que se creó la corrección.

properties.deploymentStatus

Resumen del estado de implementación de todas las implementaciones creadas por la corrección.

properties.failureThreshold

Configuración del umbral de error de corrección

properties.filters

Filtros que se aplicarán para determinar qué recursos corregir.

properties.lastUpdatedOn
  • string

Hora a la que se actualizó por última vez la corrección.

properties.parallelDeployments
  • integer

Determina cuántos recursos corregir en un momento dado. Se puede usar para aumentar o reducir el ritmo de la corrección. Si no se proporciona, se usa el valor predeterminado de implementaciones paralelas.

properties.policyAssignmentId
  • string

Identificador de recurso de la asignación de directiva que se debe corregir.

properties.policyDefinitionReferenceId
  • string

Identificador de referencia de definición de directiva de la definición individual que se debe corregir. Obligatorio cuando la asignación de directiva que se va a corregir asigna una definición de conjunto de directivas.

properties.provisioningState
  • string

Estado de la corrección.

properties.resourceCount
  • integer

Determina el número máximo de recursos que el trabajo de corrección puede corregir. Si no se proporciona, se usa el recuento de recursos predeterminado.

properties.resourceDiscoveryMode

Se detecta la forma en que se detectan los recursos para corregirlos. El valor predeterminado es ExistingNonCompliant si no se especifica.

properties.statusMessage
  • string

Mensaje de estado de corrección. Proporciona detalles adicionales sobre el estado de la corrección.

systemData

Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.

type
  • string

Tipo de corrección.

RemediationDeploymentSummary

Resumen del estado de implementación de todas las implementaciones creadas por la corrección.

Name Type Description
failedDeployments
  • integer

Número de implementaciones requeridas por la corrección que han producido un error.

successfulDeployments
  • integer

Número de implementaciones requeridas por la corrección que se ha realizado correctamente.

totalDeployments
  • integer

Número de implementaciones requeridas por la corrección.

RemediationFilters

Filtros que se aplicarán para determinar qué recursos corregir.

Name Type Description
locations
  • string[]

Las ubicaciones de recursos que se corregirán.

RemediationListResult

Lista de correcciones.

Name Type Description
nextLink
  • string

Dirección URL para obtener el siguiente conjunto de resultados.

value

Matriz de definiciones de corrección.

ResourceDiscoveryMode

Se detecta la forma en que se detectan los recursos para corregirlos. El valor predeterminado es ExistingNonCompliant si no se especifica.

Name Type Description
ExistingNonCompliant
  • string

Corrija los recursos que ya se sabe que no son compatibles.

ReEvaluateCompliance
  • string

Vuelva a evaluar el estado de cumplimiento de los recursos y corrija los recursos encontrados como no compatibles.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Name Type Description
createdAt
  • string

Marca de tiempo de creación de recursos (UTC).

createdBy
  • string

Identidad que creó el recurso.

createdByType

Tipo de identidad que creó el recurso.

lastModifiedAt
  • string

Marca de tiempo de la última modificación del recurso (UTC)

lastModifiedBy
  • string

Identidad que modificó por última vez el recurso.

lastModifiedByType

Tipo de identidad que modificó por última vez el recurso.

TypedErrorInfo

Detalles de error específicos del escenario.

Name Type Description
info

Detalles de error específicos del escenario.

type
  • string

Tipo de detalles de error incluidos.