Skip to content

client.settings

Inspect Defender data-export (raw streaming) settings configured for the tenant.

Property

client.settings

Methods

  • dataExportSettings() -> DataExportSettingsResults: retrieve current data-export settings.

Notes

  • This is an undocumented Defender API surface; field stability is not guaranteed upstream.
  • The method name preserves the upstream Defender API path (/api/dataExportSettings) rather than normalising to snake_case, consistent with the package convention of mirroring API names for filter and lookup methods.
  • Returns a lazy BaseResults subclass; call to_dicts(), to_arrow(), or to_polars() to materialize.

See also

API

DataExportSettingsResults

DataExportSettingsResults(
    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/dataExportSettings endpoint.

DataExportSettingsEndpoint

DataExportSettingsEndpoint(http: Client, auth: MSALAuth)

Endpoint for /api/dataExportSettings.

dataExportSettings

dataExportSettings() -> DataExportSettingsResults

Retrieves the data export settings for the tenant.

Docs: Null (undocumented endpoint)