Kql Dashboard

Warning

The functions are not fully tested yet. Use with caution. Please report any issues to the GitHub repository.

kql_dashboard_create

kql_dashboard_create(workspace_id: str, display_name: str, kql_dashboard_path: str, description: str = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Create a kql dashboard.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to create the kql dashboard in.	required
display_name	str	The display name of the kql dashboard.	required
kql_dashboard_path	str	The path to the kql dashboard to load content from.	required
description	str | None	The description of the kql dashboard.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

kql_dashboard_get

kql_dashboard_get(workspace_id: str, kql_dashboard_id: str, preview: bool = True) -> requests.Response

Get a kql dashboard.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the kql dashboard from.	required
kql_dashboard_id	str	The id of the kql dashboard to get.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

kql_dashboard_list

kql_dashboard_list(workspace_id: str, continuation_token: str = None, preview: bool = True) -> requests.Response

List kql dashboards for a workspace.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to list kql dashboards for.	required
continuation_token	str | None	A token for retrieving the next page of results.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

kql_dashboard_update

kql_dashboard_update(workspace_id: str, kql_dashboard_id: str, display_name: str = None, description: str = None, preview: bool = True) -> requests.Response

Update a kql dashboard.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
kql_dashboard_id	str	The id of the kql dashboard to update.	required
display_name	str | None	The display name of the kql dashboard.	None
description	str | None	The description of the kql dashboard.	None
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

kql_dashboard_delete

kql_dashboard_delete(workspace_id: str, kql_dashboard_id: str, preview: bool = True) -> requests.Response

Delete a kql dashboard.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to delete.	required
kql_dashboard_id	str	The id of the kql dashboard to delete.	required
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

kql_dashboard_get_definition

kql_dashboard_get_definition(workspace_id: str, kql_dashboard_id: str, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Get the definition of a kql dashboard.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to get the kql dashboard definition from.	required
kql_dashboard_id	str	The id of the kql dashboard to get the definition from.	required
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.

kql_dashboard_update_definition

kql_dashboard_update_definition(workspace_id: str, kql_dashboard_id: str, kql_dashboard_path: str, update_metadata: bool = None, await_lro: bool = None, timeout: int = 60 * 5, preview: bool = True) -> requests.Response

Update the definition of a kql dashboard.

Parameters:

Name	Type	Description	Default
workspace_id	str	The id of the workspace to update.	required
kql_dashboard_id	str	The id of the kql dashboard to update.	required
kql_dashboard_path	str	The path to the kql dashboard to load content from.	required
update_metadata	bool | None	When set to true, the item's metadata is updated using the metadata in the .platform file.	None
await_lro	bool | None	Whether to await the long running operation.	None
timeout	int	Timeout for the long running operation (seconds). Defaults to 5 minutes.	60 * 5
preview	bool	Whether to preview the request. You will be asked to confirm the request before it is executed. Defaults to True.	True

Returns:

Type	Description
Response	The response from the request.