Remediations - Cancel At Management Group

Szolgáltatás:: Policy

API-verzió:: 2021-10-01

Megszakítja a szervizelést a felügyeleti csoport hatókörében.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
managementGroupId	path	True	string	Felügyeleti csoport azonosítója.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	A Microsoft Management RP névtere; csak a "Microsoft.Management" engedélyezett.
remediationName	path	True	string	A szervizelés neve.
api-version	query	True	string	Ügyfél API-verziója.

Válaszok

Name	Típus	Description
200 OK	Remediation	A megszüntetett szervizelés.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

Cancel a remediation at management group scope

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
  }
}

Definíciók

Name	Description
createdByType	Az erőforrást létrehozó identitás típusa.
ErrorDefinition	Hibadefiníció.
ErrorResponse	Hibaválasz.
FailureThreshold	A szervizelési hiba küszöbértékének beállításai
ManagementGroupsNamespaceType	A Microsoft Management RP névtere; csak a "Microsoft.Management" engedélyezett.
Remediation	A szervizelési definíció.
RemediationDeploymentSummary	A szervizelés által létrehozott összes üzemelő példány üzembehelyezési állapotának összegzése.
RemediationFilters	A szervizelendő erőforrások meghatározásához alkalmazott szűrők.
ResourceDiscoveryMode	Az erőforrások szervizelésének módja. Ha nincs megadva, alapértelmezés szerint a ExistingNonCompliant lesz.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
TypedErrorInfo	Esetspecifikus hiba részletei.

createdByType

Enumerálás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

ErrorDefinition

Objektum

Hibadefiníció.

Name	Típus	Description
additionalInfo	TypedErrorInfo[]	További esetspecifikus hibaadatok.
code	string	Szolgáltatásspecifikus hibakód, amely a HTTP-hibakód alállapotaként szolgál.
details	ErrorDefinition[]	Belső hiba részletei.
message	string	A hiba leírása.
target	string	A hiba célja.

ErrorResponse

Objektum

Hibaválasz.

Name	Típus	Description
error	ErrorDefinition	A hiba részletei.

FailureThreshold

Objektum

A szervizelési hiba küszöbértékének beállításai

Name	Típus	Description
percentage	number (float)	Egy 0,0 és 1,0 közötti szám, amely a hiba százalékos küszöbértékét jelöli. A szervizelés sikertelen lesz, ha a sikertelen szervizelési műveletek (azaz a sikertelen üzembe helyezések) százalékos aránya meghaladja ezt a küszöbértéket.

ManagementGroupsNamespaceType

Enumerálás

A Microsoft Management RP névtere; csak a "Microsoft.Management" engedélyezett.

Érték	Description
Microsoft.Management

Remediation

Objektum

A szervizelési definíció.

Name	Típus	Description
id	string	A szervizelés azonosítója.
name	string	A szervizelés neve.
properties.correlationId	string	A szervizelési korreláció azonosítója. A tevékenységnaplóban a szervizeléssel kapcsolatos események megkeresésére használható.
properties.createdOn	string (date-time)	A szervizelés létrehozásának időpontja.
properties.deploymentStatus	RemediationDeploymentSummary	A szervizelés által létrehozott összes üzemelő példány üzembehelyezési állapotának összegzése.
properties.failureThreshold	FailureThreshold	A szervizelési hiba küszöbértékének beállításai
properties.filters	RemediationFilters	A szervizelendő erőforrások meghatározásához alkalmazott szűrők.
properties.lastUpdatedOn	string (date-time)	A szervizelés utolsó frissítésének időpontja.
properties.parallelDeployments	integer (int32)	Meghatározza, hogy egy adott időpontban hány erőforrást kell szervizelni. A szervizelés ütemének növeléséhez vagy csökkentéséhez használható. Ha nincs megadva, a rendszer az alapértelmezett párhuzamos üzembe helyezési értéket használja.
properties.policyAssignmentId	string	A szervizelendő szabályzat-hozzárendelés erőforrás-azonosítója.
properties.policyDefinitionReferenceId	string	A szervizelendő egyedi definíció házirenddefiníciós referenciaazonosítója. A szervizelt szabályzat-hozzárendeléshez szükség van egy szabályzatkészlet-definíció hozzárendelésére.
properties.provisioningState	string	A szervizelés állapota. Ez a teljes szervizelési feladatra vonatkozik, nem az egyes üzemelő példányokra. Az engedélyezett értékek a kiértékelés, a megszakítás, a megszakítás, a sikertelen, a befejezett vagy a sikeres érték.
properties.resourceCount	integer (int32)	Meghatározza a szervizelési feladat által szervizelhető erőforrások maximális számát. Ha nincs megadva, a rendszer az alapértelmezett erőforrásszámot használja.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Az erőforrások szervizelésének módja. Ha nincs megadva, alapértelmezés szerint a ExistingNonCompliant lesz.
properties.statusMessage	string	A szervizelési állapot üzenete. További részleteket tartalmaz a szervizelés állapotáról.
systemData	systemData	A createdBy és a modifiedBy adatokat tartalmazó Azure Resource Manager-metaadatok.
type	string	A szervizelés típusa.

RemediationDeploymentSummary

Objektum

A szervizelés által létrehozott összes üzemelő példány üzembehelyezési állapotának összegzése.

Name	Típus	Description
failedDeployments	integer	A sikertelen szervizeléshez szükséges üzembe helyezések száma.
successfulDeployments	integer	A sikeres szervizeléshez szükséges üzembe helyezések száma.
totalDeployments	integer	A szervizeléshez szükséges üzembe helyezések száma.

RemediationFilters

Objektum

A szervizelendő erőforrások meghatározásához alkalmazott szűrők.

Name	Típus	Description
locations	string[]	A szervizelendő erőforráshelyek.

ResourceDiscoveryMode

Enumerálás

Az erőforrások szervizelésének módja. Ha nincs megadva, alapértelmezés szerint a ExistingNonCompliant lesz.

Érték	Description
ExistingNonCompliant	A már ismerten nem megfelelő erőforrások szervizelése.
ReEvaluateCompliance	Értékelje újra az erőforrások megfelelőségi állapotát, majd szervizelje a nem megfelelőnek talált erőforrásokat.

systemData

Objektum

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

TypedErrorInfo

Objektum

Esetspecifikus hiba részletei.

Name	Típus	Description
info		A forgatókönyv konkrét hibaadatai.
type	string	A mellékelt hiba részleteinek típusa.

Megosztás:

Remediations - Cancel At Management Group

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Cancel a remediation at management group scope

Mintakérelem

Mintaválasz

Definíciók

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

ManagementGroupsNamespaceType

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo