Remediations - Cancel At Subscription

Référence

Service:: Policy

Version d'API:: 2021-10-01

Annule une correction au niveau de l’étendue de l’abonnement.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
remediationName	path	True	string	Nom de la correction.
subscriptionId	path	True	string	ID d’abonnement Microsoft Azure.
api-version	query	True	string	Version de l’API cliente.

Réponses

Nom	Type	Description
200 OK	Remediation	Correction annulée.
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

Cancel a remediation at subscription scope

Exemple de requête

POST https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/Microsoft.PolicyInsights/remediations/myRemediation/cancel?api-version=2021-10-01

import com.azure.core.util.Context;

/** Samples for Remediations CancelAtSubscription. */
public final class Main {
    /*
     * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelSubscriptionScope.json
     */
    /**
     * Sample code: Cancel a remediation at subscription scope.
     *
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void cancelARemediationAtSubscriptionScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.remediations().cancelAtSubscriptionWithResponse("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

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_subscription_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="35ee058e-5fa0-414c-8145-3ebb8d09b6e2",
    )

    response = client.remediations.cancel_at_subscription(
        remediation_name="myRemediation",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelSubscriptionScope.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

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_CancelSubscriptionScope.json
func ExampleRemediationsClient_CancelAtSubscription() {
	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().CancelAtSubscription(ctx, "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("/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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("/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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

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

/**
 * This sample demonstrates how to Cancels a remediation at subscription scope.
 *
 * @summary Cancels a remediation at subscription scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelSubscriptionScope.json
 */
async function cancelARemediationAtSubscriptionScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "35ee058e-5fa0-414c-8145-3ebb8d09b6e2";
  const remediationName = "myRemediation";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.remediations.cancelAtSubscription(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

Exemple de réponse

Code d’état:: 200

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/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"
  }
}

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 de seuil d’échec de correction
Remediation	Définition de correction.
RemediationDeploymentSummary	Le déploiement status résumé pour tous les déploiements créés par la correction.
RemediationFilters	Filtres qui seront appliqués pour déterminer les ressources à corriger.
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 de 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.

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é pour tous les déploiements créés par la correction.
properties.failureThreshold	FailureThreshold	Paramètres de seuil d’échec de correction
properties.filters	RemediationFilters	Filtres qui seront appliqués pour déterminer les ressources à corriger.
properties.lastUpdatedOn	string	Heure à laquelle la correction a été mise à jour pour la dernière fois.
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 corrigée affecte une définition d’ensemble 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 Évaluation, Annulé, Annulation, Échec, Terminé ou Réussi.
properties.resourceCount	integer	Détermine le nombre maximal de ressources qui peuvent ê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é pour 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 de ressources qui seront corrigés.

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 jugées 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 dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

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.

Partager via

Remediations - Cancel At Subscription

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Cancel a remediation at subscription scope

Exemple de requête

Exemple de réponse

Définitions

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo

Ressources supplémentaires