`client.authenticated_agents`¶

Inspect authenticated scan agents.

Property¶

client.authenticated_agents

Methods¶

get_all(query: DeviceAuthenticatedAgentsQuery | None = None) -> DeviceAuthenticatedAgentsQueryResults: list scan agents.
get(id: str) -> DeviceAuthenticatedAgentsQueryResults: fetch one scan agent by ID.

Notes¶

DeviceAuthenticatedAgentsQuery is currently a placeholder query model and exists mainly for consistency and future-proofing.
Both methods use the standard lazy materialization pattern.

API¶

Microsoft Defender for Endpoint authenticated-scan endpoint models and client surface.

This module defines: - DeviceAuthenticatedAgentsQuery and AuthenticatedDefinitionsQuery request models. - AuthenticatedScanHistoryQuery for history pagination. - Payload models for creating, updating, and deleting scan definitions (AuthenticatedDefinitionsAlterPayload, ScannerAgentRefPayload, etc.). - *Results wrappers mapped to Arrow schemas for scan agents, definitions, and history records. - DeviceAuthenticatedAgentsEndpoint and AuthenticatedDefinitionsEndpoint with methods for retrieving agents, listing/creating/updating/deleting scan definitions, and querying scan history by definition or session ID.

Endpoint methods return lazy BaseResults subclasses and defer HTTP requests until a terminal materialization method is called.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-authenticated-scan-agent

DeviceAuthenticatedAgentsQuery ¶

Query parameters for the /api/DeviceAuthenticatedScanAgents endpoint. Endpoint doesn't have any documented query parameters, but this class is left here for consistency and future-proofing.

DeviceAuthenticatedAgentsQueryResults ¶

DeviceAuthenticatedAgentsQueryResults(
    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 wrapper for device authenticated scan agents queries.

DeviceAuthenticatedAgentsEndpoint ¶

DeviceAuthenticatedAgentsEndpoint(
    http: Client, auth: MSALAuth
)

get_all ¶

get_all(
    query: DeviceAuthenticatedAgentsQuery | None = None,
) -> DeviceAuthenticatedAgentsQueryResults

Get all device authenticated scan agents.

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

get ¶

get(id: str) -> DeviceAuthenticatedAgentsQueryResults

Get a single device authenticated scan agent by ID.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-agent-details

client.authenticated_agents¶