`client.score`¶

Access exposure and configuration score data.

Property¶

client.score

Methods¶

get() -> ScoreResults: fetch the organization exposure score.
byMachineGroups() -> ScoreResults: fetch exposure score by machine group.
configurationScore() -> ScoreResults: fetch Microsoft Secure Score for Devices.
configurationScoreById(id: str) -> ScoreResults: fetch Microsoft Secure Score for Devices by ID.

Notes¶

All methods return the same ScoreResults wrapper even though they target different score paths.

API¶

ScoreResults ¶

ScoreResults(
    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/exposureScore endpoint.

ScoreEndpoint ¶

ScoreEndpoint(http: Client, auth: MSALAuth)

Endpoint for /api/exposureScore.

get ¶

get() -> ScoreResults

Retrieves the organizational exposure score.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-exposure-score

byMachineGroups ¶

byMachineGroups() -> ScoreResults

Retrieves the exposure score for each machine group.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-machine-group-exposure-score

configurationScore ¶

configurationScore() -> ScoreResults

Retrieves Microsoft Secure Score for Devices.

Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-device-secure-score

configurationScoreById ¶

configurationScoreById(id: str) -> ScoreResults

Retrieves Microsoft Secure Score for Devices by ID.