Remediations - Cancel At Management Group

Referenz

Dienst:: Policy

API-Version:: 2021-10-01

Bricht eine Korrektur im Verwaltungsgruppenbereich ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
managementGroupId	path	True	string	Verwaltungsgruppen-ID.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	Der Namespace für Microsoft Management RP; nur "Microsoft.Management" ist zulässig.
remediationName	path	True	string	Der Name der Wartung.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Remediation	Die Korrektur, die abgebrochen wurde.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Cancel a remediation at management group scope

Beispielanforderung

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


/**
 * 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",
            com.azure.core.util.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_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

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

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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDefinition	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
FailureThreshold	Einstellungen für fehlerbehebungsschwellenwerte
ManagementGroupsNamespaceType	Der Namespace für Microsoft Management RP; nur "Microsoft.Management" ist zulässig.
Remediation	Die Wartungsdefinition.
RemediationDeploymentSummary	Die Bereitstellungsstatuszusammenfassung für alle Bereitstellungen, die von der Wartung erstellt wurden.
RemediationFilters	Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen korrigiert werden sollen.
ResourceDiscoveryMode	Die Art und Weise, wie Ressourcen behoben werden können, werden ermittelt. Wird standardmäßig auf "ExistingNonCompliant" festgelegt, falls nicht angegeben.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
TypedErrorInfo	Szenariospezifische Fehlerdetails.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

ErrorDefinition

Objekt

Fehlerdefinition.

Name	Typ	Beschreibung
additionalInfo	TypedErrorInfo[]	Weitere szenariospezifische Fehlerdetails.
code	string	Dienstspezifischer Fehlercode, der als Unterstatus für den HTTP-Fehlercode dient.
details	ErrorDefinition[]	Interne Fehlerdetails.
message	string	Beschreibung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDefinition	Die Fehlerdetails.

FailureThreshold

Objekt

Einstellungen für fehlerbehebungsschwellenwerte

Name	Typ	Beschreibung
percentage	number (float)	Eine Zahl zwischen 0,0 und 1,0, die den Prozentsatzfehlerschwellenwert darstellt. Die Korrektur schlägt fehl, wenn der Prozentsatz der fehlgeschlagenen Wartungsvorgänge (d. h. fehlgeschlagene Bereitstellungen) diesen Schwellenwert überschreitet.

ManagementGroupsNamespaceType

Enumeration

Der Namespace für Microsoft Management RP; nur "Microsoft.Management" ist zulässig.

Wert	Beschreibung
Microsoft.Management

Remediation

Objekt

Die Wartungsdefinition.

Name	Typ	Beschreibung
id	string	Die ID der Wartung.
name	string	Der Name der Wartung.
properties.correlationId	string	Die Korrelations-ID der Korrektur. Kann verwendet werden, um Ereignisse im Zusammenhang mit der Behebung im Aktivitätsprotokoll zu finden.
properties.createdOn	string (date-time)	Der Zeitpunkt, zu dem die Wartung erstellt wurde.
properties.deploymentStatus	RemediationDeploymentSummary	Die Bereitstellungsstatuszusammenfassung für alle Bereitstellungen, die von der Wartung erstellt wurden.
properties.failureThreshold	FailureThreshold	Einstellungen für fehlerbehebungsschwellenwerte
properties.filters	RemediationFilters	Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen korrigiert werden sollen.
properties.lastUpdatedOn	string (date-time)	Der Zeitpunkt, zu dem die Wartung zuletzt aktualisiert wurde.
properties.parallelDeployments	integer (int32)	Bestimmt, wie viele Ressourcen zu einem bestimmten Zeitpunkt behoben werden sollen. Kann verwendet werden, um das Tempo der Behebung zu erhöhen oder zu reduzieren. Wenn nicht angegeben, wird der Standardwert für parallele Bereitstellungen verwendet.
properties.policyAssignmentId	string	Die Ressourcen-ID der Richtlinienzuordnung, die korrigiert werden soll.
properties.policyDefinitionReferenceId	string	Die Richtliniendefinitionsreferenz-ID der einzelnen Definition, die korrigiert werden soll. Erforderlich, wenn die zu korrigierende Richtlinienzuweisung eine Richtliniensatzdefinition zuweist.
properties.provisioningState	string	Der Status der Behebung. Dies bezieht sich auf die gesamte Wartungsaufgabe, nicht auf einzelne Bereitstellungen. Zulässige Werte sind "Auswerten", "Abbrechen", "Abbrechen", "Fehlgeschlagen", "Abgeschlossen" oder "Erfolgreich".
properties.resourceCount	integer (int32)	Bestimmt die maximale Anzahl von Ressourcen, die durch den Wartungsauftrag behoben werden können. Wenn nicht angegeben, wird die Standardressourcenanzahl verwendet.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Die Art und Weise, wie Ressourcen behoben werden können, werden ermittelt. Wird standardmäßig auf "ExistingNonCompliant" festgelegt, falls nicht angegeben.
properties.statusMessage	string	Die Statusmeldung zur Behebung. Enthält zusätzliche Details zum Zustand der Behebung.
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
type	string	Der Typ der Wartung.

RemediationDeploymentSummary

Objekt

Die Bereitstellungsstatuszusammenfassung für alle Bereitstellungen, die von der Wartung erstellt wurden.

Name	Typ	Beschreibung
failedDeployments	integer	Die Anzahl der Bereitstellungen, die für die Fehlgeschlagene Wartung erforderlich sind.
successfulDeployments	integer	Die Anzahl der Bereitstellungen, die von der erfolgreichen Wartung erforderlich sind.
totalDeployments	integer	Die Anzahl der Bereitstellungen, die für die Wartung erforderlich sind.

RemediationFilters

Objekt

Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen korrigiert werden sollen.

Name	Typ	Beschreibung
locations	string[]	Die Ressourcenspeicherorte, die korrigiert werden.

ResourceDiscoveryMode

Enumeration

Die Art und Weise, wie Ressourcen behoben werden können, werden ermittelt. Wird standardmäßig auf "ExistingNonCompliant" festgelegt, falls nicht angegeben.

Wert	Beschreibung
ExistingNonCompliant	Korrigieren Sie Ressourcen, die bereits als nicht kompatibel bekannt sind.
ReEvaluateCompliance	Überprüfen Sie den Compliancestatus der Ressourcen erneut, und korrigieren Sie dann die ressourcen, die als nicht konform erkannt wurden.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TypedErrorInfo

Objekt

Szenariospezifische Fehlerdetails.

Name	Typ	Beschreibung
info		Die szenariospezifischen Fehlerdetails.
type	string	Der Typ der enthaltenen Fehlerdetails.

Freigeben über

Remediations - Cancel At Management Group

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

Cancel a remediation at management group scope

Beispielanforderung

Beispiel für eine Antwort

Definitionen

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

ManagementGroupsNamespaceType

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo