Custom Recommendations - List

Usługa:

Defender for Cloud

Wersja interfejsu API:

2024-08-01

Pobieranie listy wszystkich odpowiednich zaleceń niestandardowych w zakresie

GET https://management.azure.com/{scope}/providers/Microsoft.Security/customRecommendations?api-version=2024-08-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
scope	path	True	string	Zakres rekomendacji niestandardowej. Prawidłowe zakresy to: grupa zarządzania (format: "providers/Microsoft.Management/managementGroups/{managementGroup}"), subskrypcja (format: "subscriptions/{subscriptionId}") lub łącznik zabezpieczeń (format: "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})"
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CustomRecommendationsList	OK
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List custom recommendations by management group scope

List custom recommendations by security connector scope

List custom recommendations by subscription scope

List custom recommendations by management group scope

Przykładowe żądanie

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/customRecommendations?api-version=2024-08-01

Java

/**
 * Samples for CustomRecommendations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-08-01/examples/CustomRecommendations/
     * ListByManagementGroupCustomRecommendations_example.json
     */
    /**
     * Sample code: List custom recommendations by management group scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listCustomRecommendationsByManagementGroupScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.customRecommendations().list("providers/Microsoft.Management/managementGroups/contoso",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/customRecommendations/MycustomRecommendation1",
      "name": "MycustomRecommendation1",
      "type": "Microsoft.Security/customRecommendations",
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      },
      "properties": {
        "query": "RawEntityMetadata | where Environment == 'GCP' and Identifiers.Type == 'compute.firewalls' | extend IslogConfigEnabled = tobool(Record.logConfig.enable) | extend HealthStatus = iff(IslogConfigEnabled, 'HEALTHY', 'UNHEALTHY')",
        "cloudProviders": [
          "AWS"
        ],
        "severity": "Medium",
        "displayName": "Password Policy",
        "description": "organization passwords policy",
        "remediationDescription": "Change password policy to...",
        "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb",
        "securityIssue": "Vulnerability"
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/customRecommendations/MycustomRecommendation2",
      "name": "MycustomRecommendation2",
      "type": "Microsoft.Security/customRecommendations",
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      },
      "properties": {
        "query": "RawEntityMetadata | where Environment == 'GCP' and Identifiers.Type == 'compute.firewalls' | extend IslogConfigEnabled = tobool(Record.logConfig.enable) | extend HealthStatus = iff(IslogConfigEnabled, 'HEALTHY', 'UNHEALTHY')",
        "cloudProviders": [
          "AWS"
        ],
        "severity": "Medium",
        "displayName": "Password Policy",
        "description": "organization passwords policy",
        "remediationDescription": "Change password policy to...",
        "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb",
        "securityIssue": "Vulnerability"
      }
    }
  ]
}

List custom recommendations by security connector scope

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/customRecommendations?api-version=2024-08-01

Java

/**
 * Samples for CustomRecommendations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-08-01/examples/CustomRecommendations/
     * ListBySecurityConnectorCustomRecommendations_example.json
     */
    /**
     * Sample code: List custom recommendations by security connector scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listCustomRecommendationsBySecurityConnectorScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.customRecommendations().list(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/customRecommendations/MycustomRecommendation1",
      "name": "MycustomRecommendation1",
      "type": "Microsoft.Security/customRecommendations",
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      },
      "properties": {
        "query": "RawEntityMetadata | where Environment == 'GCP' and Identifiers.Type == 'compute.firewalls' | extend IslogConfigEnabled = tobool(Record.logConfig.enable) | extend HealthStatus = iff(IslogConfigEnabled, 'HEALTHY', 'UNHEALTHY')",
        "cloudProviders": [
          "AWS"
        ],
        "severity": "Medium",
        "displayName": "Password Policy",
        "description": "organization passwords policy",
        "remediationDescription": "Change password policy to...",
        "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb",
        "securityIssue": "Vulnerability"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/customRecommendations/MycustomRecommendation2",
      "name": "MycustomRecommendation2",
      "type": "Microsoft.Security/customRecommendations",
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      },
      "properties": {
        "query": "RawEntityMetadata | where Environment == 'GCP' and Identifiers.Type == 'compute.firewalls' | extend IslogConfigEnabled = tobool(Record.logConfig.enable) | extend HealthStatus = iff(IslogConfigEnabled, 'HEALTHY', 'UNHEALTHY')",
        "cloudProviders": [
          "AWS"
        ],
        "severity": "Medium",
        "displayName": "Password Policy",
        "description": "organization passwords policy",
        "remediationDescription": "Change password policy to...",
        "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb",
        "securityIssue": "Vulnerability"
      }
    }
  ]
}

List custom recommendations by subscription scope

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/customRecommendations?api-version=2024-08-01

Java

/**
 * Samples for CustomRecommendations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-08-01/examples/CustomRecommendations/
     * ListBySubscriptionCustomRecommendations_example.json
     */
    /**
     * Sample code: List custom recommendations by subscription scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listCustomRecommendationsBySubscriptionScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.customRecommendations().list("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/customRecommendations/MycustomRecommendation1",
      "name": "MycustomRecommendation1",
      "type": "Microsoft.Security/customRecommendations",
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      },
      "properties": {
        "query": "RawEntityMetadata | where Environment == 'GCP' and Identifiers.Type == 'compute.firewalls' | extend IslogConfigEnabled = tobool(Record.logConfig.enable) | extend HealthStatus = iff(IslogConfigEnabled, 'HEALTHY', 'UNHEALTHY')",
        "cloudProviders": [
          "AWS"
        ],
        "severity": "Medium",
        "displayName": "Password Policy",
        "description": "organization passwords policy",
        "remediationDescription": "Change password policy to...",
        "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb",
        "securityIssue": "Vulnerability"
      }
    },
    {
      "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/customRecommendations/MycustomRecommendation2",
      "name": "MycustomRecommendation2",
      "type": "Microsoft.Security/customRecommendations",
      "systemData": {
        "createdBy": "user@contoso.com",
        "createdByType": "User",
        "createdAt": "2021-08-31T13:47:50.328Z",
        "lastModifiedBy": "user@contoso.com",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2021-08-31T13:47:50.328Z"
      },
      "properties": {
        "query": "RawEntityMetadata | where Environment == 'GCP' and Identifiers.Type == 'compute.firewalls' | extend IslogConfigEnabled = tobool(Record.logConfig.enable) | extend HealthStatus = iff(IslogConfigEnabled, 'HEALTHY', 'UNHEALTHY')",
        "cloudProviders": [
          "AWS"
        ],
        "severity": "Medium",
        "displayName": "Password Policy",
        "description": "organization passwords policy",
        "remediationDescription": "Change password policy to...",
        "assessmentKey": "d5f442f7-7e77-4bcf-a450-a9c1b9a94eeb",
        "securityIssue": "Vulnerability"
      }
    }
  ]
}

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
CustomRecommendation	Zalecenie niestandardowe
CustomRecommendationsList	Lista zaleceń niestandardowych
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
RecommendationSupportedClouds	Lista wszystkich standardowych obsługiwanych chmur.
securityIssue	Ważność, która ma być powiązana z ocenami wygenerowanymi przez to zalecenie.
severityEnum	Ważność, która ma być powiązana z ocenami wygenerowanymi przez to zalecenie.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

CustomRecommendation

Zalecenie niestandardowe

Nazwa	Typ	Opis
id	string	Identyfikator zasobu
name	string	Nazwa zasobu
properties.assessmentKey	string	Klucz metadanych oceny używany podczas generowania oceny dla tego zalecenia.
properties.cloudProviders	RecommendationSupportedClouds[]	Lista wszystkich standardowych obsługiwanych chmur.
properties.description	string	Opis odnoszący się do ocen wygenerowanych przez to zalecenie.
properties.displayName	string	Nazwa wyświetlana ocen wygenerowanych przez to zalecenie.
properties.query	string	Zapytanie KQL reprezentujące wymagane wyniki zalecenia.
properties.remediationDescription	string	Opis korygowania odnoszący się do ocen wygenerowanych przez to zalecenie.
properties.securityIssue	securityIssue	Ważność, która ma być powiązana z ocenami wygenerowanymi przez to zalecenie.
properties.severity	severityEnum	Ważność, która ma być powiązana z ocenami wygenerowanymi przez to zalecenie.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu

CustomRecommendationsList

Lista zaleceń niestandardowych

Nazwa	Typ	Opis
nextLink	string	Link użyty do pobrania następnej strony operacji.
value	CustomRecommendation[]	Kolekcja niestandardowych zaleceń

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

RecommendationSupportedClouds

Lista wszystkich standardowych obsługiwanych chmur.

Nazwa	Typ	Opis
AWS	string
Azure	string
GCP	string

securityIssue

Ważność, która ma być powiązana z ocenami wygenerowanymi przez to zalecenie.

Nazwa	Typ	Opis
AnonymousAccess	string
BestPractices	string
ExcessivePermissions	string
NetworkExposure	string
TrafficEncryption	string
Vulnerability	string

severityEnum

Ważność, która ma być powiązana z ocenami wygenerowanymi przez to zalecenie.

Nazwa	Typ	Opis
High	string
Low	string
Medium	string

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.