Health Reports - Get
リソースの正常性レポートを取得する
GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/healthReports/{healthReportName}?api-version=2023-05-01-preview
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
health
|
path | True |
string |
正常性レポート キー - 正常性レポートの種類の一意のキー 正規表現パターン: |
resource
|
path | True |
string |
リソースの識別子。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
Other Status Codes |
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
Get health report of resource
要求のサンプル
GET https://management.azure.com/subscriptions/a1efb6ca-fbc5-4782-9aaa-5c7daded1ce2/resourcegroups/E2E-IBB0WX/providers/Microsoft.Security/securityconnectors/AwsConnectorAllOfferings/providers/Microsoft.Security/healthReports/909c629a-bf39-4521-8e4f-10b443a0bc02?api-version=2023-05-01-preview
応答のサンプル
{
"id": "/subscriptions/a1efb6ca-fbc5-4782-9aaa-5c7daded1ce2/resourcegroups/E2E-IBB0WX/providers/Microsoft.Security/securityconnectors/AwsConnectorAllOfferings/providers/Microsoft.Security/healthReports/909c629a-bf39-4521-8e4f-10b443a0bc02",
"name": "909c629a-bf39-4521-8e4f-10b443a0bc02",
"type": "Microsoft.Security/healthReports",
"properties": {
"resourceDetails": {
"source": "Aws",
"id": "/subscriptions/a1efb6ca-fbc5-4782-9aaa-5c7daded1ce2/resourcegroups/E2E-IBB0WX/providers/Microsoft.Security/securityconnectors/AwsConnectorAllOfferings",
"connectorId": "bb7ad9cc-26b6-48ec-a5b4-23fc23be2733"
},
"environmentDetails": {
"nativeResourceId": "arn:aws:iam::827098768879",
"environmentHierarchyId": "a1efb6ca-fbc5-4782-9aaa-5c7daded1ce2",
"organizationalHierarchyId": "e81b978c-11be-449f-a392-42c0ed96bb91",
"subscriptionId": "a1efb6ca-fbc5-4782-9aaa-5c7daded1ce2",
"tenantId": "a1efb6ca-fbc5-4782-9aaa-5c7daded1ce2"
},
"healthDataClassification": {
"component": "Connectivity",
"scope": "Connectors"
},
"status": {
"code": "NotHealthy",
"statusChangeDate": "2023-01-12T09:07:18.6759138Z",
"firstEvaluationDate": "2023-01-12T09:07:18.6759138Z",
"lastScannedDate": "2023-04-25T09:02:20.1349133Z"
},
"affectedDefendersPlans": [],
"issues": [
{
"issueKey": "414af15d-207e-4c63-b8eb-624d1b652e45",
"issueName": "AWS CloudFormation StackSet name invalid or does not exist",
"securityValues": [
"Connectivity to AWS member accounts"
],
"issueDescription": "A problem was identified with the AWS CloudFormation StackSet. The StackSet is used to create stacks across multiple accounts. To grant Defender for Cloud access to your member accounts, there is a need to run the StackSet on the member accounts.",
"remediationSteps": "Validate that the StackSet name in AWS matches the name provided in the onboarding set up: StackSet name can be found in AWS Management Console -> CloudFormation -> StackSets -> StackSet name In case the names do not match, update the StackSet name to match the StackSet name provided in the onboarding set up. In case the StackSet does not exist, re-run the CloudFormation template only for StackSet. Navigate to CloudFormation 'StackSets' in AWS Management Console -> Click 'Create StackSet' -> Choose 'Upload a template file', `Choose file` and select the downloaded template. Make sure to enter the exact StackSet name as it was provided in the onboarding set up. Download template link ",
"remediationScript": "",
"issueAdditionalData": {
"StacksetName": "ProdStackSet"
}
}
]
}
}
定義
名前 | 説明 |
---|---|
environment |
リソースの環境の詳細 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
health |
正常性レポートの分類 |
Health |
正常性レポート リソース |
issue |
リソースの異常の原因となった問題 |
resource |
正常性レポートのリソースの詳細 |
source |
正常性レポートの状態 |
status |
正常性レポートの状態 |
status |
正常性レポートの状態 |
environmentDetails
リソースの環境の詳細
名前 | 型 | 説明 |
---|---|---|
environmentHierarchyId |
string |
コネクタの階層 ID (Azure の場合はサブスクリプション ID、MC の場合は hierarchyId ID) |
nativeResourceId |
string |
リソースのネイティブ リソース ID (Azure の場合はリソース ID、MC の場合はネイティブ リソース ID) |
organizationalHierarchyId |
string |
コネクタの組織階層 ID (Azure の場合はサブスクリプション ID、MC の場合は組織の hierarchyId ID) |
subscriptionId |
string |
サブスクリプション ID |
tenantId |
string |
テナント ID |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
エラー オブジェクト。 |
healthDataClassification
正常性レポートの分類
名前 | 型 | 説明 |
---|---|---|
component |
string |
このコンポーネントは、問題をスキャンするエージェント/サービスの名前を記述します |
scenario |
string |
このシナリオでは、コンポーネントの正常性シナリオの問題について説明します |
scope |
string |
正常性レポートのリソース スコープ |
HealthReport
正常性レポート リソース
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソース ID |
name |
string |
リソース名 |
properties.affectedDefendersPlans |
string[] |
異常なレポートによる影響を受ける防御者の計画 |
properties.affectedDefendersSubPlans |
string[] |
異常なレポートによる影響を受ける防御者のサブプラン |
properties.environmentDetails |
リソースの環境の詳細 |
|
properties.healthDataClassification |
正常性レポートの分類 |
|
properties.issues |
issue[] |
レポート内の問題のコレクション |
properties.reportAdditionalData |
object |
特定の正常性レポートの追加データ。このフィールドには、リソースと正常性シナリオの詳細を含めることができます。 |
properties.resourceDetails |
正常性レポートのリソースの詳細 |
|
properties.status |
正常性レポートの状態 |
|
type |
string |
リソースの種類 |
issue
リソースの異常の原因となった問題
名前 | 型 | 説明 |
---|---|---|
issueAdditionalData |
object |
特定の問題の追加データ。 追加データは問題の種類によって異なります |
issueDescription |
string |
問題の説明 |
issueKey |
string |
一意の問題キー |
issueName |
string |
問題の名前 |
remediationScript |
string |
この問題を解決するための修復スクリプト |
remediationSteps |
string |
この正常性の問題を軽減するために行うべきことの人間が判読できる説明 |
securityValues |
string[] |
問題の影響を受ける MDC が提供する影響を受けるセキュリティ値 (推奨事項、アラートなど) |
resourceDetails
正常性レポートのリソースの詳細
名前 | 型 | 説明 |
---|---|---|
connectorId |
string |
コネクタの ID |
id |
string |
リソースの Azure ID |
source |
正常性レポートの状態 |
source
正常性レポートの状態
名前 | 型 | 説明 |
---|---|---|
Aws |
string |
|
Azure |
string |
|
Gcp |
string |
status
正常性レポートの状態
名前 | 型 | 説明 |
---|---|---|
code |
正常性レポートの状態 |
|
firstEvaluationDate |
string |
正常性レポートのリソースが初めてスキャンされた日付 |
lastScannedDate |
string |
リソースが前回スキャンされた日付 |
reason |
string |
指定された状態の理由 |
statusChangeDate |
string |
前回正常性レポートの状態が変更された日付 |
statusName
正常性レポートの状態
名前 | 型 | 説明 |
---|---|---|
Healthy |
string |
|
NotApplicable |
string |
|
NotHealthy |
string |