Remediations - Get At Resource

サービス:: Policy

API バージョン:: 2024-10-01

リソーススコープで既存の修復を取得します。

GET https://management.azure.com/{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}?api-version=2024-10-01

URI パラメーター

名前	/	必須	型	説明
remediationName	path	True	string	修復の名前。
resourceId	path	True	string	リソース ID。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	Remediation	取得した修復。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

Get remediation at individual resource scope

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/providers/microsoft.storage/storageaccounts/storAc1/providers/Microsoft.PolicyInsights/remediations/storageRemediation?api-version=2024-10-01

応答のサンプル

状態コード:: 200

{
  "properties": {
    "policyAssignmentId": "/subscriptions/35ee058e-5fa0-414c-8145-3ebb8d09b6e2/resourcegroups/myResourceGroup/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": 1,
      "successfulDeployments": 1,
      "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.storage/storageaccounts/storAc1/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"
  }
}

定義

名前	説明
createdByType	リソースを作成した ID の種類。
ErrorDefinition	エラー定義。
ErrorResponse	エラー応答。
FailureThreshold	修復エラーのしきい値の設定
Remediation	修復の定義。
RemediationDeploymentSummary	修復によって作成されたすべてのデプロイのデプロイ状態の概要。
RemediationFilters	修復するリソースを決定するために適用されるフィルター。
ResourceDiscoveryMode	修復するリソースが検出される方法。指定しない場合、既定値は ExistingNonCompliant です。
systemData	リソースの作成と最後の変更に関連するメタデータ。
TypedErrorInfo	シナリオ固有のエラーの詳細。

createdByType

列挙

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

値	説明
User
Application
ManagedIdentity
Key

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

Remediation

Object

修復の定義。

名前	型	説明
id	string	修復の ID。
name	string	修復の名前。
properties.correlationId	string	修復の関連付け ID。アクティビティログで修復に関連するイベントを検索するために使用できます。
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	修復する必要があるポリシー割り当てのリソース ID。
properties.policyDefinitionReferenceId	string	修復する必要がある個々の定義のポリシー定義参照 ID。修復対象のポリシー割り当てがポリシーセット定義を割り当てるときに必要です。
properties.provisioningState	string	修復の状態。これは、個々のデプロイではなく、修復タスク全体を指します。使用できる値は、評価、取り消し、取り消し、失敗、完了、または成功です。
properties.resourceCount	integer (int32)	修復ジョブによって修復できるリソースの最大数を決定します。指定しない場合は、既定のリソース数が使用されます。
properties.resourceDiscoveryMode	ResourceDiscoveryMode	修復するリソースが検出される方法。指定しない場合、既定値は ExistingNonCompliant です。
properties.statusMessage	string	修復状態メッセージ。修復の状態に関する追加の詳細を提供します。
systemData	systemData	create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。
type	string	修復の種類。

RemediationDeploymentSummary

Object

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

名前	型	説明
failedDeployments	integer	失敗した修復に必要なデプロイの数。
successfulDeployments	integer	成功した修復に必要なデプロイの数。
totalDeployments	integer	修復に必要なデプロイの数。

RemediationFilters

Object

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

名前	型	説明
locations	string[]	修復されるリソースの場所。
resourceIds	string[]	修復されるリソースの ID。最大 100 個の ID を指定できます。このフィルターは、ReEvaluateCompliance が ReEvaluateCompliance に設定されている場合は使用できず、指定された場合は空にすることはできません。

ResourceDiscoveryMode

列挙

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

値	説明
ExistingNonCompliant	既に準拠していないことがわかっているリソースを修復します。
ReEvaluateCompliance	リソースのコンプライアンス状態を再評価し、非準拠であることが判明したリソースを修復します。このモードではresourceIdsフィルターは使用できません。

systemData

Object

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

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TypedErrorInfo

Object

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

名前	型	説明
info		シナリオ固有のエラーの詳細。
type	string	含まれるエラーの詳細の種類。

次の方法で共有

Remediations - Get At Resource

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

Get remediation at individual resource scope

要求のサンプル

応答のサンプル

定義

createdByType

ErrorDefinition

ErrorResponse

FailureThreshold

Remediation

RemediationDeploymentSummary

RemediationFilters

ResourceDiscoveryMode

systemData

TypedErrorInfo