Remediations - Cancel At Resource

Odwołanie

Usługa:: Policy

Wersja interfejsu API:: 2021-10-01

Anuluj korygowanie w zakresie zasobów.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
remediationName	path	True	string	Nazwa korygowania.
resourceId	path	True	string	Identyfikator zasobu.
api-version	query	True	string	Wersja interfejsu API klienta.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Remediation	Skorygowanie, które zostało anulowane.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Cancel a remediation at individual resource scope

Przykładowe żądanie

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


/**
 * Samples for Remediations CancelAtResource.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/
     * Remediations_CancelResourceScope.json
     */
    /**
     * Sample code: Cancel a remediation at individual resource scope.
     * 
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void cancelARemediationAtIndividualResourceScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.remediations().cancelAtResourceWithResponse(
            "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1",
            "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_resource_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_resource(
        resource_id="subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1",
        remediation_name="myRemediation",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelResourceScope.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_CancelResourceScope.json
func ExampleRemediationsClient_CancelAtResource() {
	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().CancelAtResource(ctx, "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1", "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/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/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.085Z"); return t}()),
	// 		DeploymentStatus: &armpolicyinsights.RemediationDeploymentSummary{
	// 			FailedDeployments: to.Ptr[int32](0),
	// 			SuccessfulDeployments: to.Ptr[int32](1),
	// 			TotalDeployments: to.Ptr[int32](1),
	// 		},
	// 		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

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

/**
 * This sample demonstrates how to Cancel a remediation at resource scope.
 *
 * @summary Cancel a remediation at resource scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelResourceScope.json
 */
async function cancelARemediationAtIndividualResourceScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceId =
    "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1";
  const remediationName = "myRemediation";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.remediations.cancelAtResource(resourceId, 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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.PolicyInsights.Models;
using Azure.ResourceManager.PolicyInsights;

// Generated from example definition: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_CancelResourceScope.json
// this example is just showing the usage of "Remediations_CancelAtResource" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this PolicyRemediationResource created on azure
// for more information of creating PolicyRemediationResource, please refer to the document of PolicyRemediationResource
string resourceId = "subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1";
string remediationName = "myRemediation";
ResourceIdentifier policyRemediationResourceId = PolicyRemediationResource.CreateResourceIdentifier(resourceId, remediationName);
PolicyRemediationResource policyRemediation = client.GetPolicyRemediationResource(policyRemediationResourceId);

// invoke the operation
PolicyRemediationResource result = await policyRemediation.CancelAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PolicyRemediationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "provisioningState": "Cancelling",
    "createdOn": "2018-09-13T21:51:09.085918Z",
    "lastUpdatedOn": "2018-09-13T21:52:10.0011706Z",
    "resourceDiscoveryMode": "ExistingNonCompliant",
    "deploymentStatus": {
      "totalDeployments": 1,
      "successfulDeployments": 1,
      "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.storage/storageaccounts/storAc1/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"
  }
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorDefinition	Definicja błędu.
ErrorResponse	Odpowiedź na błąd.
FailureThreshold	Ustawienia progu niepowodzenia korygowania
Remediation	Definicja korygowania.
RemediationDeploymentSummary	Podsumowanie stanu wdrożenia dla wszystkich wdrożeń utworzonych przez korygowanie.
RemediationFilters	Filtry, które zostaną zastosowane w celu określenia, które zasoby mają zostać skorygowane.
ResourceDiscoveryMode	Sposób odnajdowania zasobów do skorygowania. Wartość domyślna to ExistingNonCompliant, jeśli nie zostanie określona.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TypedErrorInfo	Szczegóły błędu specyficzne dla scenariusza.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

ErrorDefinition

Objekt

Definicja błędu.

Nazwa	Typ	Opis
additionalInfo	TypedErrorInfo[]	Dodatkowe szczegóły błędu specyficzne dla scenariusza.
code	string	Kod błędu specyficzny dla usługi, który służy jako podstatu kodu błędu HTTP.
details	ErrorDefinition[]	Szczegóły błędu wewnętrznego.
message	string	Opis błędu.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	ErrorDefinition	Szczegóły błędu.

FailureThreshold

Objekt

Ustawienia progu niepowodzenia korygowania

Nazwa	Typ	Opis
percentage	number (float)	Liczba z zakresu od 0,0 do 1,0 reprezentująca próg niepowodzenia procentowego. Korygowanie zakończy się niepowodzeniem, jeśli wartość procentowa nieudanych operacji korygowania (tj. nieudanych wdrożeń) przekroczy ten próg.

Remediation

Objekt

Definicja korygowania.

Nazwa	Typ	Opis
id	string	Identyfikator korygowania.
name	string	Nazwa korygowania.
properties.correlationId	string	Identyfikator korelacji korygowania. Może służyć do znajdowania zdarzeń związanych z korygowaniem w dzienniku aktywności.
properties.createdOn	string (date-time)	Godzina utworzenia korygowania.
properties.deploymentStatus	RemediationDeploymentSummary	Podsumowanie stanu wdrożenia dla wszystkich wdrożeń utworzonych przez korygowanie.
properties.failureThreshold	FailureThreshold	Ustawienia progu niepowodzenia korygowania
properties.filters	RemediationFilters	Filtry, które zostaną zastosowane w celu określenia, które zasoby mają zostać skorygowane.
properties.lastUpdatedOn	string (date-time)	Czas ostatniej aktualizacji korygowania.
properties.parallelDeployments	integer (int32)	Określa liczbę zasobów do skorygowania w danym momencie. Może służyć do zwiększenia lub zmniejszenia tempa korygowania. Jeśli nie zostanie podana, zostanie użyta domyślna wartość wdrożeń równoległych.
properties.policyAssignmentId	string	Identyfikator zasobu przypisania zasad, który powinien zostać skorygowany.
properties.policyDefinitionReferenceId	string	Identyfikator odwołania definicji zasad dla pojedynczej definicji, która powinna zostać skorygowana. Wymagane, gdy przypisanie zasad jest korygowane, przypisuje definicję zestawu zasad.
properties.provisioningState	string	Stan korygowania. Dotyczy to całego zadania korygowania, a nie poszczególnych wdrożeń. Dozwolone wartości to Ocena, Anulowanie, Anulowanie, Niepowodzenie, Zakończenie lub Powodzenie.
properties.resourceCount	integer (int32)	Określa maksymalną liczbę zasobów, które można skorygować za pomocą zadania korygowania. Jeśli nie zostanie podana, zostanie użyta domyślna liczba zasobów.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Sposób odnajdowania zasobów do skorygowania. Wartość domyślna to ExistingNonCompliant, jeśli nie zostanie określona.
properties.statusMessage	string	Komunikat o stanie korygowania. Zawiera dodatkowe szczegóły dotyczące stanu korygowania.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ korygowania.

RemediationDeploymentSummary

Objekt

Podsumowanie stanu wdrożenia dla wszystkich wdrożeń utworzonych przez korygowanie.

Nazwa	Typ	Opis
failedDeployments	integer	Liczba wdrożeń wymaganych przez korygowanie, które zakończyły się niepowodzeniem.
successfulDeployments	integer	Liczba wdrożeń wymaganych przez korygowanie, które zakończyły się pomyślnie.
totalDeployments	integer	Liczba wdrożeń wymaganych przez korygowanie.

RemediationFilters

Objekt

Filtry, które zostaną zastosowane w celu określenia, które zasoby mają zostać skorygowane.

Nazwa	Typ	Opis
locations	string[]	Lokalizacje zasobów, które zostaną skorygowane.

ResourceDiscoveryMode

Wyliczanie

Sposób odnajdowania zasobów do skorygowania. Wartość domyślna to ExistingNonCompliant, jeśli nie zostanie określona.

Wartość	Opis
ExistingNonCompliant	Koryguj zasoby, które są już znane jako niezgodne.
ReEvaluateCompliance	Ponownie oceń stan zgodności zasobów, a następnie koryguj zasoby, które nie są zgodne.

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

TypedErrorInfo

Objekt

Szczegóły błędu specyficzne dla scenariusza.

Nazwa	Typ	Opis
info		Szczegóły błędu specyficzne dla scenariusza.
type	string	Typ dołączonych szczegółów błędu.