Remediations - Cancel At Subscription

Referência

Serviço:: Policy

Versão da API:: 2021-10-01

Cancela uma correção no escopo da assinatura.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
remediationName	path	True	string	O nome da correção.
subscriptionId	path	True	string	ID da assinatura do Microsoft Azure.
api-version	query	True	string	Versão da API do cliente.

Respostas

Nome	Tipo	Description
200 OK	Remediation	A correção que foi cancelada.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Cancel a remediation at subscription scope

Solicitação de exemplo

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


/**
 * 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", 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_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

Resposta de exemplo

Código de status:: 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"
  }
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorDefinition	Definição de erro.
ErrorResponse	Resposta de erro.
FailureThreshold	As configurações de limite de falha de correção
Remediation	A definição de correção.
RemediationDeploymentSummary	O resumo do status da implantação para todas as implantações criadas pela correção.
RemediationFilters	Os filtros que serão aplicados para determinar quais recursos serão corrigidos.
ResourceDiscoveryMode	A maneira como os recursos a serem corrigidos são descobertos. O padrão será ExistingNonCompliant se não for especificado.
systemData	Metadados relativos à criação e última modificação do recurso.
TypedErrorInfo	Detalhes de erro específicos do cenário.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorDefinition

Objeto

Definição de erro.

Nome	Tipo	Description
additionalInfo	TypedErrorInfo[]	Detalhes de erro específicos do cenário adicional.
code	string	Código de erro específico do serviço que serve como substatus para o código de erro HTTP.
details	ErrorDefinition[]	Detalhes internos do erro.
message	string	Descrição do erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
error	ErrorDefinition	Os detalhes do erro.

FailureThreshold

Objeto

As configurações de limite de falha de correção

Nome	Tipo	Description
percentage	number (float)	Um número entre 0,0 e 1,0 que representa o limite de falha percentual. A correção falhará se o percentual de operações de correção com falha (ou seja, implantações com falha) exceder esse limite.

Remediation

Objeto

A definição de correção.

Nome	Tipo	Description
id	string	A ID da correção.
name	string	O nome da correção.
properties.correlationId	string	A ID de correlação de correção. Pode ser usado para localizar eventos relacionados à correção no log de atividades.
properties.createdOn	string (date-time)	O momento em que a correção foi criada.
properties.deploymentStatus	RemediationDeploymentSummary	O resumo do status da implantação para todas as implantações criadas pela correção.
properties.failureThreshold	FailureThreshold	As configurações de limite de falha de correção
properties.filters	RemediationFilters	Os filtros que serão aplicados para determinar quais recursos serão corrigidos.
properties.lastUpdatedOn	string (date-time)	A hora em que a correção foi atualizada pela última vez.
properties.parallelDeployments	integer (int32)	Determina quantos recursos serão corrigidos a qualquer momento. Pode ser usado para aumentar ou reduzir o ritmo da correção. Se não for fornecido, o valor de implantações paralelas padrão será usado.
properties.policyAssignmentId	string	A ID do recurso da atribuição de política que deve ser corrigida.
properties.policyDefinitionReferenceId	string	A ID de referência de definição de política da definição individual que deve ser corrigida. Necessário quando a atribuição de política que está sendo corrigida atribui uma definição de conjunto de políticas.
properties.provisioningState	string	O status da correção. Isso se refere a toda a tarefa de correção, não a implantações individuais. Os valores permitidos são Avaliação, Cancelamento, Cancelamento, Falha, Conclusão ou Êxito.
properties.resourceCount	integer (int32)	Determina o número máximo de recursos que podem ser corrigidos pelo trabalho de correção. Se não for fornecido, a contagem de recursos padrão será usada.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	A maneira como os recursos a serem corrigidos são descobertos. O padrão será ExistingNonCompliant se não for especificado.
properties.statusMessage	string	A mensagem de status de correção. Fornece detalhes adicionais sobre o estado da correção.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo da correção.

RemediationDeploymentSummary

Objeto

O resumo do status da implantação para todas as implantações criadas pela correção.

Nome	Tipo	Description
failedDeployments	integer	O número de implantações necessárias para a correção que falharam.
successfulDeployments	integer	O número de implantações necessárias para a correção que foi bem-sucedida.
totalDeployments	integer	O número de implantações exigido pela correção.

RemediationFilters

Objeto

Os filtros que serão aplicados para determinar quais recursos serão corrigidos.

Nome	Tipo	Description
locations	string[]	Os locais de recurso que serão corrigidos.

ResourceDiscoveryMode

Enumeração

A maneira como os recursos a serem corrigidos são descobertos. O padrão será ExistingNonCompliant se não for especificado.

Valor	Description
ExistingNonCompliant	Corrija recursos que já são conhecidos por não estarem em conformidade.
ReEvaluateCompliance	Avalie novamente o estado de conformidade dos recursos e, em seguida, corrija os recursos considerados não compatíveis.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TypedErrorInfo

Objeto

Detalhes de erro específicos do cenário.

Nome	Tipo	Description
info		Os detalhes de erro específicos do cenário.
type	string	O tipo de detalhes de erro incluídos.

Compartilhar via

Remediations - Cancel At Subscription

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Cancel a remediation at subscription scope

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo

Recursos adicionais