Remediations - Cancel At Resource Group

Служба:: Policy

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

Отменяет исправление в области группы ресурсов.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
remediationName	path	True	string	Имя исправления.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Microsoft Azure subscription ID.
api-version	query	True	string	Версия клиентского API.

Ответы

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

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

azure_auth

Azure Active Directory OAuth2 Flow

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

Области

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

Примеры

Cancel a remediation at resource group scope

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

HTTP

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

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

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

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/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/resourcegroups/myResourceGroup/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"
  }
}

Определения

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

createdByType

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

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

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

ErrorDefinition

Объект

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

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

ErrorResponse

Объект

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

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

FailureThreshold

Объект

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

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

Remediation

Объект

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

Имя	Тип	Описание
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

Объект

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

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

RemediationFilters

Объект

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

Имя	Тип	Описание
locations	string[]	Расположения ресурсов, которые будут исправлены.
resourceIds	string[]	Идентификаторы ресурсов, которые будут исправлены. Может указывать не более 100 идентификаторов. Этот фильтр нельзя использовать, если параметр ReEvaluateCompliance имеет значение ReEvaluateCompliance и не может быть пустым при условии предоставления.

ResourceDiscoveryMode

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

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

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

systemData

Объект

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

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

TypedErrorInfo

Объект

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

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