Remediations - Delete At Resource Group

Service:

Policy

API Version:

2021-10-01

Löscht eine vorhandene Korrektur im Ressourcengruppenbereich.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
remediationName	path	True	string	Der Name der Korrektur.
resourceGroupName	path	True	string	Ressourcengruppenname
subscriptionId	path	True	string	Microsoft Azure-Abonnement-ID.
api-version	query	True	string	Client-API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	Remediation	Die gelöschte Korrektur.
204 No Content		Die Korrektur war nicht vorhanden.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Delete remediation at resource group scope

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for Remediations Delete. */
public final class Main {
    /*
     * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_DeleteResourceGroupScope.json
     */
    /**
     * Sample code: Delete remediation at resource group scope.
     *
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void deleteRemediationAtResourceGroupScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.remediations().deleteByResourceGroupWithResponse("myResourceGroup", "storageRemediation", 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_delete_resource_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="35ee058e-5fa0-414c-8145-3ebb8d09b6e2",
    )

    response = client.remediations.delete_at_resource_group(
        resource_group_name="myResourceGroup",
        remediation_name="storageRemediation",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_DeleteResourceGroupScope.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_DeleteResourceGroupScope.json
func ExampleRemediationsClient_DeleteAtResourceGroup() {
	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().DeleteAtResourceGroup(ctx, "myResourceGroup", "storageRemediation", 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("storageRemediation"),
	// 	Type: to.Ptr("Microsoft.PolicyInsights/remediations"),
	// 	ID: to.Ptr("/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/storageRemediation"),
	// 	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/resourcegroups/myResourceGroup/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 Deletes an existing remediation at resource group scope.
 *
 * @summary Deletes an existing remediation at resource group scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_DeleteResourceGroupScope.json
 */
async function deleteRemediationAtResourceGroupScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "35ee058e-5fa0-414c-8145-3ebb8d09b6e2";
  const resourceGroupName = process.env["POLICYINSIGHTS_RESOURCE_GROUP"] || "myResourceGroup";
  const remediationName = "storageRemediation";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.remediations.deleteAtResourceGroup(
    resourceGroupName,
    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": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/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": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.policyinsights/remediations/storageRemediation",
  "name": "storageRemediation",
  "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"
  }
}

Status code:

204

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorDefinition	Fehlerdefinition.
ErrorResponse	Fehlerantwort.
FailureThreshold	Schwellenwerteinstellungen für Behebungsfehler
Remediation	Die Wartungsdefinition.
RemediationDeploymentSummary	Die Bereitstellung status Zusammenfassung für alle Bereitstellungen, die durch die Wartung erstellt wurden.
RemediationFilters	Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen behoben werden sollen.
ResourceDiscoveryMode	Die Art und Weise, wie Ressourcen zur Behebung ermittelt werden. Wird standardmäßig Auf ExistingNonCompliant festgelegt, wenn nicht angegeben.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
TypedErrorInfo	Szenariospezifische Fehlerdetails.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorDefinition

Fehlerdefinition.

Name	Typ	Beschreibung
additionalInfo	TypedErrorInfo[]	Zusätzliche 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

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDefinition	Die Fehlerdetails.

FailureThreshold

Schwellenwerteinstellungen für Behebungsfehler

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

Remediation

Die Wartungsdefinition.

Name	Typ	Beschreibung
id	string	Die ID der Korrektur.
name	string	Der Name der Korrektur.
properties.correlationId	string	Die Wartungskorrelations-ID. Kann verwendet werden, um Ereignisse im Zusammenhang mit der Behebung im Aktivitätsprotokoll zu finden.
properties.createdOn	string	Der Zeitpunkt, zu dem die Korrektur erstellt wurde.
properties.deploymentStatus	RemediationDeploymentSummary	Die Bereitstellung status Zusammenfassung für alle Bereitstellungen, die durch die Wartung erstellt wurden.
properties.failureThreshold	FailureThreshold	Schwellenwerteinstellungen für Behebungsfehler
properties.filters	RemediationFilters	Die Filter, die angewendet werden, um zu bestimmen, welche Ressourcen behoben werden sollen.
properties.lastUpdatedOn	string	Der Zeitpunkt, zu dem die Korrektur zuletzt aktualisiert wurde.
properties.parallelDeployments	integer	Bestimmt, wie viele Ressourcen zu einem bestimmten Zeitpunkt behoben werden müssen. Kann verwendet werden, um das Tempo der Sanierung zu erhöhen oder zu reduzieren. Falls nicht angegeben, wird der Standardwert für parallele Bereitstellungen verwendet.
properties.policyAssignmentId	string	Die Ressourcen-ID der Richtlinienzuweisung, die behoben werden soll.
properties.policyDefinitionReferenceId	string	Die Referenz-ID der Richtliniendefinition der einzelnen Definition, die behoben 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, Abgebrochen, Abbrechen, Fehler, Abgeschlossen oder Erfolgreich.
properties.resourceCount	integer	Bestimmt die maximale Anzahl von Ressourcen, die vom Wartungsauftrag behoben werden können. Falls nicht angegeben, wird die Standardressourcenanzahl verwendet.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Die Art und Weise, wie Ressourcen zur Behebung ermittelt werden. Wird standardmäßig Auf ExistingNonCompliant festgelegt, wenn nicht angegeben.
properties.statusMessage	string	Die Behebung status Meldung. Stellt zusätzliche Details zum Zustand der Wartung bereit.
systemData	systemData	Azure Resource Manager-Metadaten mit createdBy- und modifiedBy-Informationen.
type	string	Der Typ der Korrektur.

RemediationDeploymentSummary

Die Bereitstellung status Zusammenfassung für alle Bereitstellungen, die durch die Wartung erstellt wurden.

Name	Typ	Beschreibung
failedDeployments	integer	Die Anzahl der Bereitstellungen, die für die Wartung erforderlich sind, bei denen ein Fehler aufgetreten ist.
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

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

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

ResourceDiscoveryMode

Die Art und Weise, wie Ressourcen zur Behebung ermittelt werden. Wird standardmäßig Auf ExistingNonCompliant festgelegt, wenn nicht angegeben.

Name	Typ	Beschreibung
ExistingNonCompliant	string	Korrigieren sie Ressourcen, von denen bereits bekannt ist, dass sie nicht konform sind.
ReEvaluateCompliance	string	Bewerten Sie den Kompatibilitätsstatus der Ressourcen erneut, und korrigieren Sie dann die Ressourcen, die als nicht konform eingestuft wurden.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	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	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

Szenariospezifische Fehlerdetails.

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