你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Remediations - Create Or Update At Subscription

在订阅范围内创建或更新修正。

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

URI 参数

Name In Required Type Description
remediationName
path True
  • string

修正的名称。

subscriptionId
path True
  • string

Microsoft Azure订阅 ID。

api-version
query True
  • string

客户端 API 版本。

请求正文

Name Type Description
properties.failureThreshold

修正失败阈值设置

properties.filters

将应用于确定要修正的资源的筛选器。

properties.parallelDeployments
  • integer

确定在任何给定时间修正多少个资源。 可用于增加或减少修正速度。 如果未提供,则使用默认并行部署值。

properties.policyAssignmentId
  • string

应修正的策略分配的资源 ID。

properties.policyDefinitionReferenceId
  • string

应修正的各个定义的策略定义引用 ID。 在修正策略分配时需要分配策略集定义。

properties.resourceCount
  • integer

确定可由修正作业修正的最大资源数。 如果未提供,则使用默认资源计数。

properties.resourceDiscoveryMode

发现要修正的资源的方式。 如果未指定,则默认为 ExistingNonCompliant。

响应

Name Type Description
200 OK

更新后的修正。

201 Created

创建的修正。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Create remediation at subscription scope
Create remediation at subscription scope with all properties

Create remediation at subscription scope

Sample Request

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

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5"
  }
}

Sample Response

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "provisioningState": "Accepted",
    "createdOn": "2018-09-12T20:58:58.7531298Z",
    "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z",
    "resourceDiscoveryMode": "ExistingNonCompliant",
    "deploymentStatus": {
      "totalDeployments": 2,
      "successfulDeployments": 0,
      "failedDeployments": 0
    },
    "statusMessage": "Remediation extended status",
    "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6"
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation",
  "name": "storageRemediation",
  "type": "Microsoft.PolicyInsights/remediations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2018-09-12T20:58:58.7531298Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-09-12T20:58:58.7531298Z"
  }
}
{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "provisioningState": "Accepted",
    "createdOn": "2018-09-12T20:58:58.7531298Z",
    "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z",
    "resourceDiscoveryMode": "ExistingNonCompliant",
    "deploymentStatus": {
      "totalDeployments": 2,
      "successfulDeployments": 0,
      "failedDeployments": 0
    },
    "statusMessage": "Remediation extended status",
    "correlationId": "a14e1d60-dae9-4771-b4be-a556d69e77a6"
  },
  "id": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.policyinsights/remediations/storageRemediation",
  "name": "storageRemediation",
  "type": "Microsoft.PolicyInsights/remediations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2018-09-12T20:58:58.7531298Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-09-12T20:58:58.7531298Z"
  }
}

Create remediation at subscription scope with all properties

Sample Request

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

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "policyDefinitionReferenceId": "8c8fa9e4",
    "resourceDiscoveryMode": "ReEvaluateCompliance",
    "filters": {
      "locations": [
        "eastus",
        "westus"
      ]
    },
    "resourceCount": 42,
    "parallelDeployments": 6,
    "failureThreshold": {
      "percentage": 0.1
    }
  }
}

Sample Response

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "policyDefinitionReferenceId": "8c8fa9e4",
    "resourceDiscoveryMode": "ReEvaluateCompliance",
    "provisioningState": "Accepted",
    "createdOn": "2018-09-12T20:58:58.7531298Z",
    "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z",
    "deploymentStatus": {
      "totalDeployments": 2,
      "successfulDeployments": 0,
      "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/storageRemediation",
  "name": "storageRemediation",
  "type": "Microsoft.PolicyInsights/remediations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2018-09-12T20:58:58.7531298Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-09-12T20:58:58.7531298Z"
  }
}
{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
    "policyDefinitionReferenceId": "8c8fa9e4",
    "resourceDiscoveryMode": "ReEvaluateCompliance",
    "provisioningState": "Accepted",
    "createdOn": "2018-09-12T20:58:58.7531298Z",
    "lastUpdatedOn": "2018-09-12T20:58:58.7531298Z",
    "deploymentStatus": {
      "totalDeployments": 2,
      "successfulDeployments": 0,
      "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/storageRemediation",
  "name": "storageRemediation",
  "type": "Microsoft.PolicyInsights/remediations",
  "systemData": {
    "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "createdByType": "User",
    "createdAt": "2018-09-12T20:58:58.7531298Z",
    "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2018-09-12T20:58:58.7531298Z"
  }
}

定义

createdByType

创建资源的标识的类型。

ErrorDefinition

错误定义。

ErrorResponse

错误响应。

FailureThreshold

修正失败阈值设置

Remediation

修正定义。

RemediationDeploymentSummary

修正创建的所有部署的部署状态摘要。

RemediationFilters

将应用于确定要修正的资源的筛选器。

ResourceDiscoveryMode

发现要修正的资源的方式。 如果未指定,则默认为 ExistingNonCompliant。

systemData

与创建和上次修改资源相关的元数据。

TypedErrorInfo

方案特定的错误详细信息。

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorDefinition

错误定义。

Name Type Description
additionalInfo

其他方案特定的错误详细信息。

code
  • string

服务特定的错误代码,用作 HTTP 错误代码的子状态。

details

内部错误详细信息。

message
  • string

错误的说明。

target
  • string

错误的目标。

ErrorResponse

错误响应。

Name Type Description
error

错误详细信息。

FailureThreshold

修正失败阈值设置

Name Type Description
percentage
  • number

一个介于 0.0 到 1.0 之间的数字,表示百分比故障阈值。 如果失败的修正操作百分比 (即失败的部署) 超过此阈值,则修正将失败。

Remediation

修正定义。

Name Type Description
id
  • string

修正的 ID。

name
  • string

修正的名称。

properties.correlationId
  • string

修正相关 ID。可用于查找与活动日志中的修正相关的事件。

properties.createdOn
  • string

创建修正的时间。

properties.deploymentStatus

修正创建的所有部署的部署状态摘要。

properties.failureThreshold

修正失败阈值设置

properties.filters

将应用于确定要修正的资源的筛选器。

properties.lastUpdatedOn
  • string

上次更新修正的时间。

properties.parallelDeployments
  • integer

确定在任何给定时间修正多少个资源。 可用于增加或减少修正速度。 如果未提供,则使用默认并行部署值。

properties.policyAssignmentId
  • string

应修正的策略分配的资源 ID。

properties.policyDefinitionReferenceId
  • string

应修正的各个定义的策略定义引用 ID。 在修正策略分配时需要分配策略集定义。

properties.provisioningState
  • string

修正的状态。

properties.resourceCount
  • integer

确定可由修正作业修正的最大资源数。 如果未提供,则使用默认资源计数。

properties.resourceDiscoveryMode

发现要修正的资源的方式。 如果未指定,则默认为 ExistingNonCompliant。

properties.statusMessage
  • string

修正状态消息。 提供有关修正状态的其他详细信息。

systemData

Azure 资源管理器包含 createdBy 和 modifiedBy 信息的元数据。

type
  • string

修正的类型。

RemediationDeploymentSummary

修正创建的所有部署的部署状态摘要。

Name Type Description
failedDeployments
  • integer

修正失败所需的部署数。

successfulDeployments
  • integer

已成功修正所需的部署数。

totalDeployments
  • integer

修正所需的部署数。

RemediationFilters

将应用于确定要修正的资源的筛选器。

Name Type Description
locations
  • string[]

要修正的资源位置。

ResourceDiscoveryMode

发现要修正的资源的方式。 如果未指定,则默认为 ExistingNonCompliant。

Name Type Description
ExistingNonCompliant
  • string

修正已知不符合的资源。

ReEvaluateCompliance
  • string

重新评估资源的符合性状态,然后修正发现不符合的资源。

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。

TypedErrorInfo

方案特定的错误详细信息。

Name Type Description
info

方案特定的错误详细信息。

type
  • string

包含的错误详细信息的类型。