`client.recommendations`¶

Access recommendation records and recommendation-related entities.

Property¶

client.recommendations

Methods¶

get_all(query: RecommendationQuery | None = None) -> RecommendationResults: list recommendations.
get(id: str) -> RecommendationResults: fetch one recommendation by ID.
software(id: str) -> ProductDTOResults: fetch software related to a recommendation.
machineReferences(id: str) -> MachineReferencesResults: fetch machine references for a recommendation.
vulnerabilities(id: str) -> VulnerabilityDTOResults: fetch vulnerabilities related to a recommendation.

Notes¶

The method name machineReferences uses camelCase because it follows the current package surface.

API¶

RecommendationQuery ¶

Query parameters for the /api/recommendations endpoint.

RecommendationResults ¶

RecommendationResults(
    endpoint: BaseEndpoint,
    params: dict[str, str],
    *,
    path: str | None = None,
    single: bool = False,
    files: bool = False,
    method: str = "GET",
    request_kwargs: dict[str, Any] | None = None,
    use_concurrent_skip_pagination: bool | None = None,
    skip_page_size: int | None = None,
    skip_max_concurrent: int | None = None,
)

Results from the /api/recommendations endpoint.

RecommendationsEndpoint ¶

RecommendationsEndpoint(http: Client, auth: MSALAuth)

Endpoint for /api/recommendations.

get_all ¶

get_all(
    query: RecommendationQuery | None = None,
) -> RecommendationResults

Get all recommendations matching the query parameters.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-all-recommendations

get ¶

get(id: str) -> RecommendationResults

Get a single recommendation by ID.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-recommendation-by-id

software ¶

software(id: str) -> ProductDTOResults

Get software details for a recommendation by ID.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/list-recommendation-software

machineReferences ¶

machineReferences(id: str) -> MachineReferencesResults

Get machine references for a recommendation by ID.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/list-recommendation-machine-references

vulnerabilities ¶

vulnerabilities(id: str) -> VulnerabilityDTOResults

Get vulnerability details for a recommendation by ID.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/list-recommendation-vulnerabilities

client.recommendations¶