Remediations - Cancel At Management Group

Service:

Policy

API Version:

2021-10-01

Cancela una corrección en el ámbito del grupo de administración.

POST https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel?api-version=2021-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
managementGroupId	path	True	string	Identificador del grupo de administración.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	Espacio de nombres para el RP de administración de Microsoft; solo se permite "Microsoft.Management".
remediationName	path	True	string	Nombre de la corrección.
api-version	query	True	string	Versión de api de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	Remediation	Corrección que se canceló.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

Cancel a remediation at management group scope

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Remediations CancelAtManagementGroup. */
public final class Main {
    /*
     * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelManagementGroupScope.json
     */
    /**
     * Sample code: Cancel a remediation at management group scope.
     *
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void cancelARemediationAtManagementGroupScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.remediations().cancelAtManagementGroupWithResponse("financeMg", "myRemediation", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.policyinsights import PolicyInsightsClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-policyinsights
# USAGE
    python remediations_cancel_management_group_scope.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = PolicyInsightsClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.remediations.cancel_at_management_group(
        management_group_id="financeMg",
        remediation_name="myRemediation",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelManagementGroupScope.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armpolicyinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/policyinsights/armpolicyinsights"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/05a9cdab363b8ec824094ee73950c04594325172/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelManagementGroupScope.json
func ExampleRemediationsClient_CancelAtManagementGroup() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armpolicyinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewRemediationsClient().CancelAtManagementGroup(ctx, "financeMg", "myRemediation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Remediation = armpolicyinsights.Remediation{
	// 	Name: to.Ptr("myRemediation"),
	// 	Type: to.Ptr("Microsoft.PolicyInsights/remediations"),
	// 	ID: to.Ptr("/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/myRemediation"),
	// 	Properties: &armpolicyinsights.RemediationProperties{
	// 		CorrelationID: to.Ptr("a14e1d60-dae9-4771-b4be-a556d69e77a6"),
	// 		CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T21:51:09.075Z"); return t}()),
	// 		DeploymentStatus: &armpolicyinsights.RemediationDeploymentSummary{
	// 			FailedDeployments: to.Ptr[int32](0),
	// 			SuccessfulDeployments: to.Ptr[int32](2),
	// 			TotalDeployments: to.Ptr[int32](2),
	// 		},
	// 		FailureThreshold: &armpolicyinsights.RemediationPropertiesFailureThreshold{
	// 			Percentage: to.Ptr[float32](0.1),
	// 		},
	// 		LastUpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T21:52:10.001Z"); return t}()),
	// 		ParallelDeployments: to.Ptr[int32](6),
	// 		PolicyAssignmentID: to.Ptr("/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ResourceCount: to.Ptr[int32](42),
	// 		ResourceDiscoveryMode: to.Ptr(armpolicyinsights.ResourceDiscoveryModeExistingNonCompliant),
	// 		StatusMessage: to.Ptr("Remediation extended status"),
	// 	},
	// 	SystemData: &armpolicyinsights.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T21:51:09.075Z"); return t}()),
	// 		CreatedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef6"),
	// 		CreatedByType: to.Ptr(armpolicyinsights.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-09-13T21:52:10.001Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("b69a9388-9488-4534-b470-7ec6d41beef6"),
	// 		LastModifiedByType: to.Ptr(armpolicyinsights.CreatedByTypeUser),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { PolicyInsightsClient } = require("@azure/arm-policyinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Cancels a remediation at management group scope.
 *
 * @summary Cancels a remediation at management group scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelManagementGroupScope.json
 */
async function cancelARemediationAtManagementGroupScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const managementGroupId = "financeMg";
  const remediationName = "myRemediation";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.remediations.cancelAtManagementGroup(
    managementGroupId,
    remediationName
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "properties": {
    "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "provisioningState": "Cancelling",
    "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/myRemediation",
  "name": "myRemediation",
  "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

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorDefinition	Definición de error.
ErrorResponse	Respuesta de error.
FailureThreshold	La configuración del umbral de error de corrección
ManagementGroupsNamespaceType	Espacio de nombres para el RP de administración de Microsoft; 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.
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.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDefinition

Definición de error.

Nombre	Tipo	Description
additionalInfo	TypedErrorInfo[]	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	ErrorDefinition[]	Detalles internos del error.
message	string	Descripción del error.
target	string	Destino del error.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	ErrorDefinition	Los detalles del error.

FailureThreshold

La configuración del umbral de error de corrección

Nombre	Tipo	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

Espacio de nombres para el RP de administración de Microsoft; solo se permite "Microsoft.Management".

Nombre	Tipo	Description
Microsoft.Management	string

Remediation

Definición de corrección.

Nombre	Tipo	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 en la que se creó la corrección.
properties.deploymentStatus	RemediationDeploymentSummary	Resumen del estado de implementación de todas las implementaciones creadas por la corrección.
properties.failureThreshold	FailureThreshold	La configuración del umbral de error de corrección
properties.filters	RemediationFilters	Filtros que se aplicarán para determinar qué recursos corregir.
properties.lastUpdatedOn	string	Hora en 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. Se requiere 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. Esto hace referencia a toda la tarea de corrección, no a implementaciones individuales. Los valores permitidos son Evaluación, Cancelación, Cancelación, Error, Completado o Correcto.
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	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	systemData	Metadatos de Azure Resource Manager que contienen información sobre los valores de 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.

Nombre	Tipo	Description
failedDeployments	integer	Número de implementaciones requeridas por la corrección que ha producido un error.
successfulDeployments	integer	Número de implementaciones requeridas por la corrección que se han realizado correctamente.
totalDeployments	integer	Número de implementaciones requeridas por la corrección.

RemediationFilters

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

Nombre	Tipo	Description
locations	string[]	Ubicaciones de recursos que se corregirán.

ResourceDiscoveryMode

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

Nombre	Tipo	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, a continuación, corrija los recursos encontrados como no compatibles.

systemData

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

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	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	createdByType	Tipo de identidad que modificó por última vez el recurso.

TypedErrorInfo

Detalles de error específicos del escenario.

Nombre	Tipo	Description
info		Detalles específicos del error del escenario.
type	string	Tipo de detalles de error incluidos.