Remediations - List For Management Group

管理グループのすべての修復を取得します。

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?api-version=2021-10-01
GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations?$top={$top}&$filter={$filter}&api-version=2021-10-01

URI パラメーター

Name In Required Type Description
managementGroupId
path True
  • string

管理グループ ID。

managementGroupsNamespace
path True

Microsoft Management RP の名前空間。"Microsoft.Management" のみが許可されます。

api-version
query True
  • string

クライアント API のバージョン。

$filter
query
  • string

OData フィルター式。

$top
query
  • integer
int32

返すレコードの最大数。

応答

Name Type Description
200 OK

取得した修復。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

List remediations at management group scope
List remediations at management group scope with query parameters

List remediations at management group scope

Sample Request

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

Sample Response

{
  "value": [
    {
      "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/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "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"
      }
    },
    {
      "properties": {
        "policyAssignmentId": "/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5",
        "provisioningState": "Succeeded",
        "createdOn": "2018-09-13T21:49:16.4638131Z",
        "lastUpdatedOn": "2018-09-13T21:50:18.4647478Z",
        "resourceDiscoveryMode": "ExistingNonCompliant",
        "deploymentStatus": {
          "totalDeployments": 2,
          "successfulDeployments": 2,
          "failedDeployments": 0
        },
        "statusMessage": "Remediation extended status",
        "correlationId": "957378d3-a143-421e-8b0e-3048dff01932"
      },
      "id": "/providers/Microsoft.Management/managementGroups/financeMg/providers/microsoft.policyinsights/remediations/0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
      "name": "0866f0cc-6cb3-422c-9fb6-a4e3e2266da8",
      "type": "Microsoft.PolicyInsights/remediations",
      "systemData": {
        "createdBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "createdByType": "User",
        "createdAt": "2018-09-13T21:49:16.4638131Z",
        "lastModifiedBy": "b69a9388-9488-4534-b470-7ec6d41beef6",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2018-09-13T21:50:18.4647478Z"
      }
    }
  ]
}

List remediations at management group scope with query parameters

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/financeMg/providers/Microsoft.PolicyInsights/remediations?$top=1&$filter=PolicyAssignmentId eq '/providers/microsoft.management/managementGroups/financeMg/providers/microsoft.authorization/policyassignments/b101830944f246d8a14088c5'&api-version=2021-10-01

Sample Response

{
  "value": [
    {
      "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/790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "name": "790996e6-9871-4b1f-9cd9-ec42cd6ced1e",
      "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

リソースを作成した ID の種類。

ErrorDefinition

エラー定義。

ErrorResponse

エラー応答。

FailureThreshold

修復エラーのしきい値の設定

ManagementGroupsNamespaceType

Microsoft Management RP の名前空間。"Microsoft.Management" のみが許可されます。

Remediation

修復の定義。

RemediationDeploymentSummary

修復によって作成されたすべてのデプロイの展開状態の概要。

RemediationFilters

修復するリソースを決定するために適用されるフィルター。

RemediationListResult

修復の一覧。

ResourceDiscoveryMode

修復するリソースが検出される方法。 指定しない場合は、ExistingNonCompliant が既定値になります。

systemData

リソースの作成と最後の変更に関連するメタデータ。

TypedErrorInfo

シナリオ固有のエラーの詳細。

createdByType

リソースを作成した ID の種類。

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 までの数値。 失敗した修復操作 (デプロイの失敗) の割合がこのしきい値を超えると、修復は失敗します。

ManagementGroupsNamespaceType

Microsoft Management RP の名前空間。"Microsoft.Management" のみが許可されます。

Name Type Description
Microsoft.Management
  • string

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

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

type
  • string

修復の種類。

RemediationDeploymentSummary

修復によって作成されたすべてのデプロイの展開状態の概要。

Name Type Description
failedDeployments
  • integer

失敗した修復に必要なデプロイの数。

successfulDeployments
  • integer

成功した修復に必要なデプロイの数。

totalDeployments
  • integer

修復に必要なデプロイの数。

RemediationFilters

修復するリソースを決定するために適用されるフィルター。

Name Type Description
locations
  • string[]

修復されるリソースの場所。

RemediationListResult

修復の一覧。

Name Type Description
nextLink
  • string

次の結果セットを取得する URL。

value

修復定義の配列。

ResourceDiscoveryMode

修復するリソースが検出される方法。 指定しない場合は、ExistingNonCompliant が既定値になります。

Name Type Description
ExistingNonCompliant
  • string

既に準拠していないことがわかっているリソースを修復します。

ReEvaluateCompliance
  • string

リソースのコンプライアンス状態を再評価し、非準拠であることが判明したリソースを修復します。

systemData

リソースの作成と最後の変更に関連するメタデータ。

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

リソースを作成した ID の種類。

lastModifiedAt
  • string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy
  • string

リソースを最後に変更した ID。

lastModifiedByType

リソースを最後に変更した ID の種類。

TypedErrorInfo

シナリオ固有のエラーの詳細。

Name Type Description
info

シナリオ固有のエラーの詳細。

type
  • string

含まれるエラーの詳細の種類。