azure.mgmt.loganalytics.operations module¶

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.ClustersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s clusters attribute.

begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: _models.Cluster, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster][source]¶

begin_create_or_update(resource_group_name: str, cluster_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster]

Create or update a Log Analytics cluster.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – The name of the Log Analytics cluster. Required.
parameters (Cluster or IO) – The parameters required to create or update a Log Analytics cluster. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Cluster or the result of cls(response)

Return type

LROPoller[Cluster]

Raises

begin_delete(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a cluster instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – Name of the Log Analytics Cluster. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

begin_update(resource_group_name: str, cluster_name: str, parameters: _models.ClusterPatch, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster][source]¶

begin_update(resource_group_name: str, cluster_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Cluster]

Updates a Log Analytics cluster.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – Name of the Log Analytics Cluster. Required.
parameters (ClusterPatch or IO) – The parameters required to patch a Log Analytics cluster. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Cluster or the result of cls(response)

Return type

LROPoller[Cluster]

Raises

get(resource_group_name: str, cluster_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Cluster[source]¶

Gets a Log Analytics cluster instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
cluster_name (str) – Name of the Log Analytics Cluster. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Cluster or the result of cls(response)

Return type

Cluster

Raises

list(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Cluster][source]¶

Gets the Log Analytics clusters in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Cluster or the result of cls(response)
Return type: ItemPaged[Cluster]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Cluster][source]¶

Gets Log Analytics clusters in a resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Cluster or the result of cls(response)
Return type: ItemPaged[Cluster]
Raises: HttpResponseError –

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.DataExportsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s data_exports attribute.

create_or_update(resource_group_name: str, workspace_name: str, data_export_name: str, parameters: _models.DataExport, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataExport[source]¶

create_or_update(resource_group_name: str, workspace_name: str, data_export_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataExport

Create or update a data export.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_export_name (str) – The data export rule name. Required.
parameters (DataExport or IO) – The parameters required to create or update a data export. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

DataExport or the result of cls(response)

Return type

DataExport

Raises

delete(resource_group_name: str, workspace_name: str, data_export_name: str, **kwargs: Any) → None [source]¶

Deletes the specified data export in a given workspace..

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_export_name (str) – The data export rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, workspace_name: str, data_export_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.DataExport[source]¶

Gets a data export instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_export_name (str) – The data export rule name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataExport or the result of cls(response)

Return type

DataExport

Raises

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.DataExport][source]¶

Lists the data export instances within a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataExport or the result of cls(response)

Return type

ItemPaged[DataExport]

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.DataSourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s data_sources attribute.

create_or_update(resource_group_name: str, workspace_name: str, data_source_name: str, parameters: _models.DataSource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataSource[source]¶

create_or_update(resource_group_name: str, workspace_name: str, data_source_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DataSource

Create or update a data source.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_source_name (str) – The name of the datasource resource. Required.
parameters (DataSource or IO) – The parameters required to create or update a datasource. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

DataSource or the result of cls(response)

Return type

DataSource

Raises

delete(resource_group_name: str, workspace_name: str, data_source_name: str, **kwargs: Any) → None [source]¶

Deletes a data source instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_source_name (str) – Name of the datasource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, workspace_name: str, data_source_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.DataSource[source]¶

Gets a datasource instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_source_name (str) – Name of the datasource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DataSource or the result of cls(response)

Return type

DataSource

Raises

list_by_workspace(resource_group_name: str, workspace_name: str, filter: str, skiptoken: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.DataSource][source]¶

Gets the first page of data source instances in a workspace with the link to the next page.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
filter (str) – The filter to apply on the operation. Required.
skiptoken (str) – Starting point of the collection of data source instances. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DataSource or the result of cls(response)

Return type

ItemPaged[DataSource]

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.DeletedWorkspacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s deleted_workspaces attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Workspace][source]¶

Gets recently deleted workspaces in a subscription, available for recovery.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Workspace or the result of cls(response)
Return type: ItemPaged[Workspace]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Workspace][source]¶

Gets recently deleted workspaces in a resource group, available for recovery.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Workspace or the result of cls(response)
Return type: ItemPaged[Workspace]
Raises: HttpResponseError –

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.GatewaysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s gateways attribute.

delete(resource_group_name: str, workspace_name: str, gateway_id: str, **kwargs: Any) → None [source]¶

Delete a Log Analytics gateway.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
gateway_id (str) – The Log Analytics gateway Id. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.IntelligencePacksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s intelligence_packs attribute.

disable(resource_group_name: str, workspace_name: str, intelligence_pack_name: str, **kwargs: Any) → None [source]¶

Disables an intelligence pack for a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
intelligence_pack_name (str) – The name of the intelligence pack to be disabled. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

enable(resource_group_name: str, workspace_name: str, intelligence_pack_name: str, **kwargs: Any) → None [source]¶

Enables an intelligence pack for a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
intelligence_pack_name (str) – The name of the intelligence pack to be enabled. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

list(resource_group_name: str, workspace_name: str, **kwargs: Any) → List[azure.mgmt.loganalytics.models._models_py3.IntelligencePack][source]¶

Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of IntelligencePack or the result of cls(response)

Return type

list[IntelligencePack]

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.LinkedServicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s linked_services attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, linked_service_name: str, parameters: _models.LinkedService, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LinkedService][source]¶

begin_create_or_update(resource_group_name: str, workspace_name: str, linked_service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.LinkedService]

Create or update a linked service.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
linked_service_name (str) – Name of the linkedServices resource. Required.
parameters (LinkedService or IO) – The parameters required to create or update a linked service. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LinkedService or the result of cls(response)

Return type

LROPoller[LinkedService]

Raises

begin_delete(resource_group_name: str, workspace_name: str, linked_service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.loganalytics.models._models_py3.LinkedService][source]¶

Deletes a linked service instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
linked_service_name (str) – Name of the linked service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either LinkedService or the result of cls(response)

Return type

LROPoller[LinkedService]

Raises

get(resource_group_name: str, workspace_name: str, linked_service_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LinkedService[source]¶

Gets a linked service instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
linked_service_name (str) – Name of the linked service. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LinkedService or the result of cls(response)

Return type

LinkedService

Raises

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LinkedService][source]¶

Gets the linked services instances in a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LinkedService or the result of cls(response)

Return type

ItemPaged[LinkedService]

Raises

LinkedStorageAccountsResource

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.LinkedStorageAccountsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s linked_storage_accounts attribute.

create_or_update(resource_group_name: str, workspace_name: str, data_source_type: Union[str, _models.DataSourceType], parameters: _models.LinkedStorageAccountsResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkedStorageAccountsResource[source]¶

create_or_update(resource_group_name: str, workspace_name: str, data_source_type: Union[str, _models.DataSourceType], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LinkedStorageAccountsResource

Create or Update a link relation between current workspace and a group of storage accounts of a specific data source type.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_source_type (str or DataSourceType) – Linked storage accounts type. Known values are: “CustomLogs”, “AzureWatson”, “Query”, “Ingestion”, and “Alerts”. Required.
parameters (LinkedStorageAccountsResource or IO) – The parameters required to create or update linked storage accounts. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LinkedStorageAccountsResource or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, workspace_name: str, data_source_type: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceType], **kwargs: Any) → None [source]¶

Deletes all linked storage accounts of a specific data source type associated with the specified workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_source_type (str or DataSourceType) – Linked storage accounts type. Known values are: “CustomLogs”, “AzureWatson”, “Query”, “Ingestion”, and “Alerts”. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

LinkedStorageAccountsResource

get(resource_group_name: str, workspace_name: str, data_source_type: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceType], **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsResource[source]¶

Gets all linked storage account of a specific data source type associated with the specified workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
data_source_type (str or DataSourceType) – Linked storage accounts type. Known values are: “CustomLogs”, “AzureWatson”, “Query”, “Ingestion”, and “Alerts”. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LinkedStorageAccountsResource or the result of cls(response)

Return type

Raises

ItemPaged[LinkedStorageAccountsResource]

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsResource][source]¶

Gets all linked storage accounts associated with the specified workspace, storage accounts will be sorted by their data source type.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LinkedStorageAccountsResource or the result of cls(response)

Return type

Raises

ItemPaged[ManagementGroup]

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.ManagementGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s management_groups attribute.

list(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.ManagementGroup][source]¶

Gets a list of management groups connected to a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ManagementGroup or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.OperationStatusesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s operation_statuses attribute.

get(location: str, async_operation_id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.OperationStatus[source]¶

Get the status of a long running azure asynchronous operation.

Parameters

location (str) – The region name of operation. Required.
async_operation_id (str) – The operation Id. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationStatus or the result of cls(response)

Return type

OperationStatus

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Operation][source]¶

Lists all of the available OperationalInsights Rest API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.QueriesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s queries attribute.

delete(resource_group_name: str, query_pack_name: str, id: str, **kwargs: Any) → None [source]¶

Deletes a specific Query defined within an Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
id (str) – The id of a specific query defined in the Log Analytics QueryPack. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

LogAnalyticsQueryPackQuery

get(resource_group_name: str, query_pack_name: str, id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery[source]¶

Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
id (str) – The id of a specific query defined in the Log Analytics QueryPack. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPackQuery or the result of cls(response)

Return type

Raises

ItemPaged[LogAnalyticsQueryPackQuery]

list(resource_group_name: str, query_pack_name: str, top: Optional[int] = None, include_body: Optional[bool] = None, skip_token: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery][source]¶

Gets a list of Queries defined within a Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
top (int) – Maximum items returned in page. Default value is None.
include_body (bool) – Flag indicating whether or not to return the body of each applicable query. If false, only return the query information. Default value is None.
skip_token (str) – Base64 encoded token used to fetch the next page of items. Default is null. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LogAnalyticsQueryPackQuery or the result of cls(response)

Return type

Raises

LogAnalyticsQueryPackQuery

put(resource_group_name: str, query_pack_name: str, id: str, query_payload: _models.LogAnalyticsQueryPackQuery, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPackQuery[source]¶

put(resource_group_name: str, query_pack_name: str, id: str, query_payload: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPackQuery

Adds or Updates a specific Query within a Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
id (str) – The id of a specific query defined in the Log Analytics QueryPack. Required.
query_payload (LogAnalyticsQueryPackQuery or IO) – Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPackQuery or the result of cls(response)

Return type

Raises

ItemPaged[LogAnalyticsQueryPackQuery]

search(resource_group_name: str, query_pack_name: str, query_search_properties: _models.LogAnalyticsQueryPackQuerySearchProperties, top: Optional[int] = None, include_body: Optional[bool] = None, skip_token: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[_models.LogAnalyticsQueryPackQuery][source]¶

search(resource_group_name: str, query_pack_name: str, query_search_properties: IO, top: Optional[int] = None, include_body: Optional[bool] = None, skip_token: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → Iterable[_models.LogAnalyticsQueryPackQuery]

Search a list of Queries defined within a Log Analytics QueryPack according to given search properties.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
query_search_properties (LogAnalyticsQueryPackQuerySearchProperties or IO) – Properties by which to search queries in the given Log Analytics QueryPack. Is either a model type or a IO type. Required.
top (int) – Maximum items returned in page. Default value is None.
include_body (bool) – Flag indicating whether or not to return the body of each applicable query. If false, only return the query information. Default value is None.
skip_token (str) – Base64 encoded token used to fetch the next page of items. Default is null. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LogAnalyticsQueryPackQuery or the result of cls(response)

Return type

Raises

LogAnalyticsQueryPackQuery

update(resource_group_name: str, query_pack_name: str, id: str, query_payload: _models.LogAnalyticsQueryPackQuery, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPackQuery[source]¶

update(resource_group_name: str, query_pack_name: str, id: str, query_payload: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPackQuery

Adds or Updates a specific Query within a Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
id (str) – The id of a specific query defined in the Log Analytics QueryPack. Required.
query_payload (LogAnalyticsQueryPackQuery or IO) – Properties that need to be specified to create a new query and add it to a Log Analytics QueryPack. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPackQuery or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.QueryPacksOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s query_packs attribute.

create_or_update(resource_group_name: str, query_pack_name: str, log_analytics_query_pack_payload: _models.LogAnalyticsQueryPack, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPack[source]¶

create_or_update(resource_group_name: str, query_pack_name: str, log_analytics_query_pack_payload: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPack

Creates (or updates) a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
log_analytics_query_pack_payload (LogAnalyticsQueryPack or IO) – Properties that need to be specified to create or update a Log Analytics QueryPack. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPack or the result of cls(response)

Return type

Raises

create_or_update_without_name(resource_group_name: str, log_analytics_query_pack_payload: _models.LogAnalyticsQueryPack, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPack[source]¶

create_or_update_without_name(resource_group_name: str, log_analytics_query_pack_payload: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPack

Creates a Log Analytics QueryPack. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
log_analytics_query_pack_payload (LogAnalyticsQueryPack or IO) – Properties that need to be specified to create or update a Log Analytics QueryPack. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPack or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, query_pack_name: str, **kwargs: Any) → None [source]¶

Deletes a Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, query_pack_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack[source]¶

Returns a Log Analytics QueryPack.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPack or the result of cls(response)

Return type

Raises

list(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack][source]¶

Gets a list of all Log Analytics QueryPacks within a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LogAnalyticsQueryPack or the result of cls(response)
Return type: ItemPaged[LogAnalyticsQueryPack]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack][source]¶

Gets a list of Log Analytics QueryPacks within a resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either LogAnalyticsQueryPack or the result of cls(response)
Return type: ItemPaged[LogAnalyticsQueryPack]
Raises: HttpResponseError –

update_tags(resource_group_name: str, query_pack_name: str, query_pack_tags: _models.TagsResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPack[source]¶

update_tags(resource_group_name: str, query_pack_name: str, query_pack_tags: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LogAnalyticsQueryPack

Updates an existing QueryPack’s tags. To update other fields use the CreateOrUpdate method.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
query_pack_name (str) – The name of the Log Analytics QueryPack resource. Required.
query_pack_tags (TagsResource or IO) – Updated tag information to set into the QueryPack instance. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

LogAnalyticsQueryPack or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.SavedSearchesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s saved_searches attribute.

create_or_update(resource_group_name: str, workspace_name: str, saved_search_id: str, parameters: _models.SavedSearch, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SavedSearch[source]¶

create_or_update(resource_group_name: str, workspace_name: str, saved_search_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SavedSearch

Creates or updates a saved search for a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
saved_search_id (str) – The id of the saved search. Required.
parameters (SavedSearch or IO) – The parameters required to save a search. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

SavedSearch or the result of cls(response)

Return type

SavedSearch

Raises

delete(resource_group_name: str, workspace_name: str, saved_search_id: str, **kwargs: Any) → None [source]¶

Deletes the specified saved search in a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
saved_search_id (str) – The id of the saved search. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, workspace_name: str, saved_search_id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SavedSearch[source]¶

Gets the specified saved search for a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
saved_search_id (str) – The id of the saved search. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SavedSearch or the result of cls(response)

Return type

SavedSearch

Raises

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SavedSearchesListResult[source]¶

Gets the saved searches for a given Log Analytics Workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SavedSearchesListResult or the result of cls(response)

Return type

SavedSearchesListResult

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.SchemaOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s schema attribute.

get(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SearchGetSchemaResponse[source]¶

Gets the schema for a given workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SearchGetSchemaResponse or the result of cls(response)

Return type

SearchGetSchemaResponse

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.SharedKeysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s shared_keys attribute.

get_shared_keys(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SharedKeys[source]¶

Gets the shared keys for a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SharedKeys or the result of cls(response)

Return type

SharedKeys

Raises

regenerate(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.SharedKeys[source]¶

Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SharedKeys or the result of cls(response)

Return type

SharedKeys

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.StorageInsightConfigsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s storage_insight_configs attribute.

create_or_update(resource_group_name: str, workspace_name: str, storage_insight_name: str, parameters: _models.StorageInsight, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StorageInsight[source]¶

create_or_update(resource_group_name: str, workspace_name: str, storage_insight_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StorageInsight

Create or update a storage insight.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
storage_insight_name (str) – Name of the storageInsightsConfigs resource. Required.
parameters (StorageInsight or IO) – The parameters required to create or update a storage insight. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

StorageInsight or the result of cls(response)

Return type

StorageInsight

Raises

delete(resource_group_name: str, workspace_name: str, storage_insight_name: str, **kwargs: Any) → None [source]¶

Deletes a storageInsightsConfigs resource.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
storage_insight_name (str) – Name of the storageInsightsConfigs resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, workspace_name: str, storage_insight_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.StorageInsight[source]¶

Gets a storage insight instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
storage_insight_name (str) – Name of the storageInsightsConfigs resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

StorageInsight or the result of cls(response)

Return type

StorageInsight

Raises

ItemPaged[StorageInsight]

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.StorageInsight][source]¶

Lists the storage insight instances within a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either StorageInsight or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.TablesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s tables attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, table_name: str, parameters: _models.Table, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Table][source]¶

begin_create_or_update(resource_group_name: str, workspace_name: str, table_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Table]

Update or Create a Log Analytics workspace table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
table_name (str) – The name of the table. Required.
parameters (Table or IO) – The parameters required to update table properties. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Table or the result of cls(response)

Return type

LROPoller[Table]

Raises

begin_delete(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete a Log Analytics workspace table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
table_name (str) – The name of the table. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

begin_update(resource_group_name: str, workspace_name: str, table_name: str, parameters: _models.Table, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Table][source]¶

begin_update(resource_group_name: str, workspace_name: str, table_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Table]

Update a Log Analytics workspace table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
table_name (str) – The name of the table. Required.
parameters (Table or IO) – The parameters required to update table properties. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Table or the result of cls(response)

Return type

LROPoller[Table]

Raises

cancel_search(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → None [source]¶

Cancel a log analytics workspace search results table query run.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
table_name (str) – The name of the table. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Table[source]¶

Gets a Log Analytics workspace table.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
table_name (str) – The name of the table. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Table or the result of cls(response)

Return type

Table

Raises

list_by_workspace(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Table][source]¶

Gets all the tables for the specified Log Analytics workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either Table or the result of cls(response)

Return type

ItemPaged[Table]

Raises

migrate(resource_group_name: str, workspace_name: str, table_name: str, **kwargs: Any) → None [source]¶

Migrate a Log Analytics table from support of the Data Collector API and Custom Fields features to support of Data Collection Rule-based Custom Logs.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
table_name (str) – The name of the table. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.UsagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s usages attribute.

list(resource_group_name: str, workspace_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.UsageMetric][source]¶

Gets a list of usage metrics for a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UsageMetric or the result of cls(response)

Return type

ItemPaged[UsageMetric]

Raises

WorkspacePurgeStatusResponse

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.WorkspacePurgeOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s workspace_purge attribute.

get_purge_status(resource_group_name: str, workspace_name: str, purge_id: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeStatusResponse[source]¶

Gets status of an ongoing purge operation.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
purge_id (str) – In a purge status request, this is the Id of the operation the status of which is returned. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkspacePurgeStatusResponse or the result of cls(response)

Return type

Raises

purge(resource_group_name: str, workspace_name: str, body: _models.WorkspacePurgeBody, *, content_type: str = "'application/json'", **kwargs: Any) → _models.WorkspacePurgeResponse[source]¶

purge(resource_group_name: str, workspace_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.WorkspacePurgeResponse

Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected. Log Analytics only supports purge operations required for compliance with GDPR. The Log Analytics product team reserves the right to reject requests for purge operations that are not for the purpose of GDPR compliance. In the event of a dispute, please create a support ticket.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
body (WorkspacePurgeBody or IO) – Describes the body of a request to purge data in a single table of an Log Analytics Workspace. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

WorkspacePurgeResponse or the result of cls(response)

Return type

WorkspacePurgeResponse

Raises

models = <module 'azure.mgmt.loganalytics.models' from '/mnt/vss/_work/1/s/sdk/loganalytics/azure-mgmt-loganalytics/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/loganalytics/models/__init__.py'>¶

class azure.mgmt.loganalytics.operations.WorkspacesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through LogAnalyticsManagementClient’s workspaces attribute.

begin_create_or_update(resource_group_name: str, workspace_name: str, parameters: _models.Workspace, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Workspace][source]¶

begin_create_or_update(resource_group_name: str, workspace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Workspace]

Create or update a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
parameters (Workspace or IO) – The parameters required to create or update a workspace. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either Workspace or the result of cls(response)

Return type

LROPoller[Workspace]

Raises

begin_delete(resource_group_name: str, workspace_name: str, force: Optional[bool] = None, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
force (bool) – Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

get(resource_group_name: str, workspace_name: str, **kwargs: Any) → azure.mgmt.loganalytics.models._models_py3.Workspace[source]¶

Gets a workspace instance.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Workspace or the result of cls(response)

Return type

Workspace

Raises

list(**kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Workspace][source]¶

Gets the workspaces in a subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Workspace or the result of cls(response)
Return type: ItemPaged[Workspace]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.loganalytics.models._models_py3.Workspace][source]¶

Gets workspaces in a resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Workspace or the result of cls(response)
Return type: ItemPaged[Workspace]
Raises: HttpResponseError –

update(resource_group_name: str, workspace_name: str, parameters: _models.WorkspacePatch, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Workspace[source]¶

update(resource_group_name: str, workspace_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Workspace

Updates a workspace.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
workspace_name (str) – The name of the workspace. Required.
parameters (WorkspacePatch or IO) – The parameters required to patch a workspace. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Workspace or the result of cls(response)

Return type

Workspace

Raises