Remediations - Delete At Management Group

Ссылка

Служба:: Policy

Версия API:: 2021-10-01

Удаляет существующую исправление в области группы управления.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
managementGroupId	path	True	string	Идентификатор группы управления.
managementGroupsNamespace	path	True	ManagementGroupsNamespaceType	Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".
remediationName	path	True	string	Имя исправления.
api-version	query	True	string	Версия клиентского API.

Ответы

Имя	Тип	Описание
200 OK	Remediation	Удаленная исправление.
204 No Content		Исправление не существовало.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Delete remediation at management group scope

Образец запроса

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


/**
 * Samples for Remediations DeleteAtManagementGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/
     * Remediations_DeleteManagementGroupScope.json
     */
    /**
     * Sample code: Delete remediation at management group scope.
     * 
     * @param manager Entry point to PolicyInsightsManager.
     */
    public static void deleteRemediationAtManagementGroupScope(
        com.azure.resourcemanager.policyinsights.PolicyInsightsManager manager) {
        manager.remediations().deleteAtManagementGroupWithResponse("financeMg", "storageRemediation",
            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_delete_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.delete_at_management_group(
        management_group_id="financeMg",
        remediation_name="storageRemediation",
    )
    print(response)


# x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_DeleteManagementGroupScope.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_DeleteManagementGroupScope.json
func ExampleRemediationsClient_DeleteAtManagementGroup() {
	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().DeleteAtManagementGroup(ctx, "financeMg", "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("/providers/Microsoft.Management/managementGroups/financeMg/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("/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 Deletes an existing remediation at management group scope.
 *
 * @summary Deletes an existing remediation at management group scope.
 * x-ms-original-file: specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2021-10-01/examples/Remediations_DeleteManagementGroupScope.json
 */
async function deleteRemediationAtManagementGroupScope() {
  const subscriptionId =
    process.env["POLICYINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const managementGroupId = "financeMg";
  const remediationName = "storageRemediation";
  const credential = new DefaultAzureCredential();
  const client = new PolicyInsightsClient(credential, subscriptionId);
  const result = await client.remediations.deleteAtManagementGroup(
    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

Пример ответа

Код состояния:: 200

{
  "properties": {
    "policyAssignmentId": "/providers/Microsoft.Management/managementGroups/financeMg/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": "/providers/Microsoft.Management/managementGroups/financeMg/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"
  }
}

Код состояния:: 204

Определения

Имя	Описание
createdByType	Тип удостоверения, создавшего ресурс.
ErrorDefinition	Определение ошибки.
ErrorResponse	Ответ на ошибку.
FailureThreshold	Параметры порогового значения сбоя исправления
ManagementGroupsNamespaceType	Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".
Remediation	Определение исправления.
RemediationDeploymentSummary	Сводка о состоянии развертывания для всех развертываний, созданных исправлением.
RemediationFilters	Фильтры, которые будут применены для определения ресурсов для исправления.
ResourceDiscoveryMode	Способ обнаружения ресурсов для исправления. Значение по умолчанию для ExistingNonCompliant, если оно не указано.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
TypedErrorInfo	Сведения о конкретной ошибке сценария.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorDefinition

Object

Определение ошибки.

Имя	Тип	Описание
additionalInfo	TypedErrorInfo[]	Дополнительные сведения об ошибке для конкретного сценария.
code	string	Код ошибки конкретной службы, который служит подстатусом для кода ошибки HTTP.
details	ErrorDefinition[]	Сведения о внутренней ошибке.
message	string	Описание ошибки.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
error	ErrorDefinition	Сведения об ошибке.

FailureThreshold

Object

Параметры порогового значения сбоя исправления

Имя	Тип	Описание
percentage	number (float)	Число от 0,0 до 1,0, представляющее пороговое значение процента сбоя. Исправление завершится ошибкой, если процент неудачных операций исправления (т. е. неудачных развертываний) превышает это пороговое значение.

ManagementGroupsNamespaceType

Перечисление

Пространство имен для RP управления Майкрософт; Разрешено только "Microsoft.Management".

Значение	Описание
Microsoft.Management

Remediation

Object

Определение исправления.

Имя	Тип	Описание
id	string	Идентификатор исправления.
name	string	Имя исправления.
properties.correlationId	string	Идентификатор корреляции исправления. Можно использовать для поиска событий, связанных с исправлением в журнале действий.
properties.createdOn	string (date-time)	Время создания исправления.
properties.deploymentStatus	RemediationDeploymentSummary	Сводка о состоянии развертывания для всех развертываний, созданных исправлением.
properties.failureThreshold	FailureThreshold	Параметры порогового значения сбоя исправления
properties.filters	RemediationFilters	Фильтры, которые будут применены для определения ресурсов для исправления.
properties.lastUpdatedOn	string (date-time)	Время последнего обновления исправления.
properties.parallelDeployments	integer (int32)	Определяет, сколько ресурсов необходимо исправить в любое время. Можно использовать для увеличения или уменьшения скорости исправления. Если это не указано, используется значение параллельных развертываний по умолчанию.
properties.policyAssignmentId	string	Идентификатор ресурса назначения политики, который следует исправить.
properties.policyDefinitionReferenceId	string	Идентификатор ссылки на определение политики отдельного определения, которое должно быть исправлено. Обязательный при исправлении назначения политики назначает определение набора политик.
properties.provisioningState	string	Состояние исправления. Это относится ко всей задаче исправления, а не к отдельным развертываниям. Допустимые значения: оценка, отмена, отмена, сбой, завершение или успешное выполнение.
properties.resourceCount	integer (int32)	Определяет максимальное количество ресурсов, которые могут быть исправлены заданием исправления. Если это не указано, используется число ресурсов по умолчанию.
properties.resourceDiscoveryMode	ResourceDiscoveryMode	Способ обнаружения ресурсов для исправления. Значение по умолчанию для ExistingNonCompliant, если оно не указано.
properties.statusMessage	string	Сообщение о состоянии исправления. Предоставляет дополнительные сведения о состоянии исправления.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
type	string	Тип исправления.

RemediationDeploymentSummary

Object

Сводка о состоянии развертывания для всех развертываний, созданных исправлением.

Имя	Тип	Описание
failedDeployments	integer	Количество развертываний, необходимых для исправления, завершившемся сбоем.
successfulDeployments	integer	Количество развертываний, необходимых для исправления, которое выполнено успешно.
totalDeployments	integer	Количество развертываний, необходимых для исправления.

RemediationFilters

Object

Фильтры, которые будут применены для определения ресурсов для исправления.

Имя	Тип	Описание
locations	string[]	Расположения ресурсов, которые будут исправлены.

ResourceDiscoveryMode

Перечисление

Способ обнаружения ресурсов для исправления. Значение по умолчанию для ExistingNonCompliant, если оно не указано.

Значение	Описание
ExistingNonCompliant	Исправьте ресурсы, которые уже известны как не соответствующие требованиям.
ReEvaluateCompliance	Повторно оцените состояние соответствия ресурсов, а затем исправьте ресурсы, которые будут признаны несоответствующим.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

TypedErrorInfo

Object

Сведения о конкретной ошибке сценария.

Имя	Тип	Описание
info		Сведения о конкретной ошибке сценария.
type	string	Тип включенных сведений об ошибке.

Поделиться через

Remediations - Delete At Management Group

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

Delete remediation at management group scope

Образец запроса

Пример ответа

Определения

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

ManagementGroupsNamespaceType

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo

Дополнительные ресурсы