client.baseline_configurations¶
Access security baseline assessments, profiles, and active configurations.
Property¶
client.baseline_configurations
Methods¶
get_all() -> AssetBaselineAssessmentResults: fetch per-device baseline assessment rows.get_all_files() -> AssetBaselineAssessmentResults: fetch per-device baseline assessment rows through the export-backed path.profiles() -> BaselineConfigurationResults: list baseline profiles created by the organization.profilesById(id: str) -> BaselineConfigurationResults: fetch one baseline profile by ID.active() -> BaselineConfigurationResults: list configurations being assessed in active baseline profiles.activeById(id: str) -> BaselineConfigurationResults: fetch one active baseline configuration by ID.exceptions() -> BaselineConfigurationResults: list security baseline assessment exceptions.exceptionsById(id: str) -> BaselineConfigurationResults: fetch one security baseline assessment exception by ID.assessmentByMachine() -> AssetConfigurationResults: fetch secure configuration assessment rows by machine.assessmentByMachineFiles() -> AssetConfigurationResults: fetch secure configuration assessment rows via export files.
Notes¶
get_all()andget_all_files()return assessment rows, not the same wrapper used byprofiles()andactive().- Use
profiles()andactive()when you need baseline metadata rather than per-device assessment output. exceptions()andexceptionsById()target undocumented baseline exception paths.
API¶
BaselineConfigurationResults
¶
BaselineConfigurationResults(
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/baselineConfigurations endpoint.
AssetConfigurationResults
¶
AssetConfigurationResults(
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/assetConfigurations endpoint.
BaselineConfigurationEndpoint
¶
BaselineConfigurationEndpoint(http: Client, auth: MSALAuth)
Endpoint for /api/baselineConfigurations.
get_all
¶
get_all() -> AssetBaselineAssessmentResults
Get the security baseline compliance assessment for a machine.
Returns all security baselines assessments for all devices, on a per-device basis.
It returns a table with a separate entry for every unique combination of DeviceId, ProfileId, ConfigurationId.
Docs: - https://learn.microsoft.com/en-us/defender-endpoint/api/export-security-baseline-assessment - https://learn.microsoft.com/en-us/defender-endpoint/api/export-security-baseline-assessment#1-export-security-baselines-assessment-json-response
get_all_files
¶
get_all_files() -> AssetBaselineAssessmentResults
Get the security baseline compliance assessment for a machine as a file.
Same Results as get_all but exported as a file instead of in the response body.
Recommended for larger data sets, as it returns zipped files with the data instead of returning it in the response body.
Docs: - https://learn.microsoft.com/en-us/defender-endpoint/api/export-security-baseline-assessment - https://learn.microsoft.com/en-us/defender-endpoint/api/export-security-baseline-assessment#2-export-security-baselines-assessment-via-files
profiles
¶
profiles() -> BaselineConfigurationResults
Retrieves a list of all security baselines assessment profiles created by the organization.
Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-security-baselines-assessment-profiles
profilesById
¶
profilesById(id: str) -> BaselineConfigurationResults
Retrieves a specific security baselines assessment profile by its ID.
Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-security-baselines-assessment-profiles
active
¶
active() -> BaselineConfigurationResults
Retrieves a list of the configurations being assessed in active baseline profiles.
Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-security-baselines-assessment-configurations
activeById
¶
activeById(id: str) -> BaselineConfigurationResults
Retrieves a specific security baseline assessment active by its ID.
Docs: https://learn.microsoft.com/en-us/defender-endpoint/api/get-security-baselines-assessment-configurations
exceptions
¶
exceptions() -> BaselineConfigurationResults
Retrieves a list of all security baseline assessment exceptions.
Docs: Null (undocumented endpoint)
exceptionsById
¶
exceptionsById(id: str) -> BaselineConfigurationResults
Retrieves a specific security baseline assessment exception by its ID.
Docs: Null (undocumented endpoint)
assessmentByMachine
¶
assessmentByMachine() -> AssetConfigurationResults
Get the secure configuration assessment for a machine.
This response contains the Secure Configuration Assessment on your exposed devices, and returns an entry for every unique combination of DeviceId, ConfigurationId.
Docs: - https://learn.microsoft.com/en-us/defender-endpoint/api/get-assessment-secure-config - https://learn.microsoft.com/en-us/defender-endpoint/api/get-assessment-secure-config#1-export-secure-configuration-assessment-json-response
assessmentByMachineFiles
¶
assessmentByMachineFiles() -> AssetConfigurationResults
Get the secure configuration assessment for a machine as a file.
Same Results as assessmentByMachine but exported as a file instead of in the response body.
Recommended for larger data sets, as it returns zipped files with the data instead of returning it in the response body.
Docs: - https://learn.microsoft.com/en-us/defender-endpoint/api/get-assessment-secure-config - https://learn.microsoft.com/en-us/defender-endpoint/api/get-assessment-secure-config#2-export-secure-configuration-assessment-via-files