azure.mgmt.loganalytics.operations module

class azure.mgmt.loganalytics.operations.DataExportsOperations(client, config, serializer, deserializer)[source]

Bases: object

DataExportsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, workspace_name, data_export_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a data export.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • data_export_name (str) – The data export rule name.

  • parameters (DataExport) – The parameters required to create or update a data export.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns DataExport or ClientRawResponse<DataExport> if raw==True

Return type

AzureOperationPoller[DataExport] or AzureOperationPoller[ClientRawResponse[DataExport]]

Raises

DataExportErrorResponseException

delete(resource_group_name, workspace_name, data_export_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • data_export_name (str) – The data export rule name.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

DataExportErrorResponseException

get(resource_group_name, workspace_name, data_export_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a data export instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • data_export_name (str) – The data export rule name.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DataExport or ClientRawResponse if raw=true

Return type

DataExport or ClientRawResponse

Raises

DataExportErrorResponseException

list_by_workspace(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of DataExport

Return type

DataExportPaged[DataExport]

Raises

DataExportErrorResponseException

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.DataSourcesOperations(client, config, serializer, deserializer)[source]

Bases: object

DataSourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, workspace_name, data_source_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or update a data source.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • data_source_name (str) – The name of the datasource resource.

  • parameters (DataSource) – The parameters required to create or update a datasource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DataSource or ClientRawResponse if raw=true

Return type

DataSource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, workspace_name, data_source_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a data source instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • data_source_name (str) – Name of the datasource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, workspace_name, data_source_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a datasource instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • data_source_name (str) – Name of the datasource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

DataSource or ClientRawResponse if raw=true

Return type

DataSource or ClientRawResponse

Raises

CloudError

list_by_workspace(resource_group_name, workspace_name, filter, skiptoken=None, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • filter (str) – The filter to apply on the operation.

  • skiptoken (str) – Starting point of the collection of data source instances.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of DataSource

Return type

DataSourcePaged[DataSource]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.IntelligencePacksOperations(client, config, serializer, deserializer)[source]

Bases: object

IntelligencePacksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

disable(resource_group_name, workspace_name, intelligence_pack_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • intelligence_pack_name (str) – The name of the intelligence pack to be disabled.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

enable(resource_group_name, workspace_name, intelligence_pack_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • intelligence_pack_name (str) – The name of the intelligence pack to be enabled.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

list(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[IntelligencePack] or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.LinkedServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

LinkedServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, workspace_name, linked_service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a linked service.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • linked_service_name (str) – Name of the linkedServices resource

  • parameters (LinkedService) – The parameters required to create or update a linked service.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LinkedService or ClientRawResponse<LinkedService> if raw==True

Return type

AzureOperationPoller[LinkedService] or AzureOperationPoller[ClientRawResponse[LinkedService]]

Raises

CloudError

delete(resource_group_name, workspace_name, linked_service_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a linked service instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • linked_service_name (str) – Name of the linked service.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns LinkedService or ClientRawResponse<LinkedService> if raw==True

Return type

AzureOperationPoller[LinkedService] or AzureOperationPoller[ClientRawResponse[LinkedService]]

Raises

CloudError

get(resource_group_name, workspace_name, linked_service_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a linked service instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • linked_service_name (str) – Name of the linked service.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LinkedService or ClientRawResponse if raw=true

Return type

LinkedService or ClientRawResponse

Raises

CloudError

list_by_workspace(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of LinkedService

Return type

LinkedServicePaged[LinkedService]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.LinkedStorageAccountsOperations(client, config, serializer, deserializer)[source]

Bases: object

LinkedStorageAccountsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, workspace_name, data_source_type, storage_account_ids=None, custom_headers=None, raw=False, **operation_config)[source]

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.

  • workspace_name (str) – The name of the workspace.

  • data_source_type (str or DataSourceType) – Linked storage accounts type. Possible values include: ‘CustomLogs’, ‘AzureWatson’

  • storage_account_ids (list[str]) – Linked storage accounts resources ids.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LinkedStorageAccountsResource or ClientRawResponse if raw=true

Return type

LinkedStorageAccountsResource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, workspace_name, data_source_type, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • data_source_type (str or DataSourceType) – Linked storage accounts type. Possible values include: ‘CustomLogs’, ‘AzureWatson’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, workspace_name, data_source_type, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • data_source_type (str or DataSourceType) – Linked storage accounts type. Possible values include: ‘CustomLogs’, ‘AzureWatson’

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

LinkedStorageAccountsResource or ClientRawResponse if raw=true

Return type

LinkedStorageAccountsResource or ClientRawResponse

Raises

CloudError

list_by_workspace(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of LinkedStorageAccountsResource

Return type

LinkedStorageAccountsResourcePaged[LinkedStorageAccountsResource]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.ManagementGroupsOperations(client, config, serializer, deserializer)[source]

Bases: object

ManagementGroupsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

list(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of ManagementGroup

Return type

ManagementGroupPaged[ManagementGroup]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the available OperationalInsights Rest API operations.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Operation

Return type

OperationPaged[Operation]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.OperationStatusesOperations(client, config, serializer, deserializer)[source]

Bases: object

OperationStatusesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

get(location, async_operation_id, custom_headers=None, raw=False, **operation_config)[source]

Get the status of a long running azure asynchronous operation.

Parameters
  • location (str) – The region name of operation.

  • async_operation_id (str) – The operation Id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

OperationStatus or ClientRawResponse if raw=true

Return type

OperationStatus or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.SharedKeysOperations(client, config, serializer, deserializer)[source]

Bases: object

SharedKeysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

get_shared_keys(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the shared keys for a workspace.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SharedKeys or ClientRawResponse if raw=true

Return type

SharedKeys or ClientRawResponse

Raises

CloudError

regenerate(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SharedKeys or ClientRawResponse if raw=true

Return type

SharedKeys or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.UsagesOperations(client, config, serializer, deserializer)[source]

Bases: object

UsagesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

list(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of UsageMetric

Return type

UsageMetricPaged[UsageMetric]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.WorkspacesOperations(client, config, serializer, deserializer)[source]

Bases: object

WorkspacesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

available_service_tiers(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the available service tiers for the workspace.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[AvailableServiceTier] or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, workspace_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a workspace.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • parameters (Workspace) – The parameters required to create or update a workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Workspace or ClientRawResponse<Workspace> if raw==True

Return type

AzureOperationPoller[Workspace] or AzureOperationPoller[ClientRawResponse[Workspace]]

Raises

CloudError

delete(resource_group_name, workspace_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a workspace instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

CloudError

get(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a workspace instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Workspace or ClientRawResponse if raw=true

Return type

Workspace or ClientRawResponse

Raises

CloudError

list(custom_headers=None, raw=False, **operation_config)[source]

Gets the workspaces in a subscription.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Workspace

Return type

WorkspacePaged[Workspace]

Raises

CloudError

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Gets workspaces in a resource group.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Workspace

Return type

WorkspacePaged[Workspace]

Raises

CloudError

update(resource_group_name, workspace_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates a workspace.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • parameters (WorkspacePatch) – The parameters required to patch a workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Workspace or ClientRawResponse if raw=true

Return type

Workspace or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.ClustersOperations(client, config, serializer, deserializer)[source]

Bases: object

ClustersOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Create or update a Log Analytics cluster.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • cluster_name (str) – The name of the Log Analytics cluster.

  • parameters (Cluster) – The parameters required to create or update a Log Analytics cluster.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns Cluster or ClientRawResponse<Cluster> if raw==True

Return type

AzureOperationPoller[Cluster] or AzureOperationPoller[ClientRawResponse[Cluster]]

Raises

ClusterErrorResponseException

delete(resource_group_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]

Deletes a cluster instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • cluster_name (str) – Name of the Log Analytics Cluster.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True

Return type

AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]

Raises

ClusterErrorResponseException

get(resource_group_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a Log Analytics cluster instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • cluster_name (str) – Name of the Log Analytics Cluster.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Cluster or ClientRawResponse if raw=true

Return type

Cluster or ClientRawResponse

Raises

ClusterErrorResponseException

list(custom_headers=None, raw=False, **operation_config)[source]

Gets the Log Analytics clusters in a subscription.

Parameters
  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Cluster

Return type

ClusterPaged[Cluster]

Raises

ClusterErrorResponseException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[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.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of Cluster

Return type

ClusterPaged[Cluster]

Raises

ClusterErrorResponseException

update(resource_group_name, cluster_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Updates a Log Analytics cluster.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • cluster_name (str) – Name of the Log Analytics Cluster.

  • parameters (ClusterPatch) – The parameters required to patch a Log Analytics cluster.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

Cluster or ClientRawResponse if raw=true

Return type

Cluster or ClientRawResponse

Raises

ClusterErrorResponseException

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.StorageInsightConfigsOperations(client, config, serializer, deserializer)[source]

Bases: object

StorageInsightConfigsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, workspace_name, storage_insight_name, parameters, custom_headers=None, raw=False, **operation_config)[source]

Create or update a storage insight.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • storage_insight_name (str) – Name of the storageInsightsConfigs resource

  • parameters (StorageInsight) – The parameters required to create or update a storage insight.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

StorageInsight or ClientRawResponse if raw=true

Return type

StorageInsight or ClientRawResponse

Raises

CloudError

delete(resource_group_name, workspace_name, storage_insight_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes a storageInsightsConfigs resource.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • storage_insight_name (str) – Name of the storageInsightsConfigs resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, workspace_name, storage_insight_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a storage insight instance.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • storage_insight_name (str) – Name of the storageInsightsConfigs resource

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

StorageInsight or ClientRawResponse if raw=true

Return type

StorageInsight or ClientRawResponse

Raises

CloudError

list_by_workspace(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

An iterator like instance of StorageInsight

Return type

StorageInsightPaged[StorageInsight]

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.SavedSearchesOperations(client, config, serializer, deserializer)[source]

Bases: object

SavedSearchesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

create_or_update(resource_group_name, workspace_name, saved_search_id, parameters, custom_headers=None, raw=False, **operation_config)[source]

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.

  • workspace_name (str) – The name of the workspace.

  • saved_search_id (str) – The id of the saved search.

  • parameters (SavedSearch) – The parameters required to save a search.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SavedSearch or ClientRawResponse if raw=true

Return type

SavedSearch or ClientRawResponse

Raises

CloudError

delete(resource_group_name, workspace_name, saved_search_id, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • saved_search_id (str) – The id of the saved search.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, workspace_name, saved_search_id, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • saved_search_id (str) – The id of the saved search.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SavedSearch or ClientRawResponse if raw=true

Return type

SavedSearch or ClientRawResponse

Raises

CloudError

list_by_workspace(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[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.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SavedSearchesListResult or ClientRawResponse if raw=true

Return type

SavedSearchesListResult or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.GatewaysOperations(client, config, serializer, deserializer)[source]

Bases: object

GatewaysOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

delete(resource_group_name, workspace_name, gateway_id, custom_headers=None, raw=False, **operation_config)[source]

Delete a Log Analytics gateway.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • gateway_id (str) – The Log Analytics gateway Id.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.SchemaOperations(client, config, serializer, deserializer)[source]

Bases: object

SchemaOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

get(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the schema for a given workspace.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

SearchGetSchemaResponse or ClientRawResponse if raw=true

Return type

SearchGetSchemaResponse or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>
class azure.mgmt.loganalytics.operations.WorkspacePurgeOperations(client, config, serializer, deserializer)[source]

Bases: object

WorkspacePurgeOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters
  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2020-03-01-preview”.

get_purge_status(resource_group_name, workspace_name, purge_id, custom_headers=None, raw=False, **operation_config)[source]

Gets status of an ongoing purge operation.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • purge_id (str) – In a purge status request, this is the Id of the operation the status of which is returned.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

WorkspacePurgeStatusResponse or ClientRawResponse if raw=true

Return type

WorkspacePurgeStatusResponse or ClientRawResponse

Raises

CloudError

purge(resource_group_name, workspace_name, table, filters, custom_headers=None, raw=False, **operation_config)[source]

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.

Parameters
  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • workspace_name (str) – The name of the workspace.

  • table (str) – Table from which to purge data.

  • filters (list[WorkspacePurgeBodyFilters]) – The set of columns and filters (queries) to run over them to purge the resulting data.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_configOperation configuration overrides.

Returns

WorkspacePurgeResponse or ClientRawResponse if raw=true

Return type

WorkspacePurgeResponse or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.loganalytics.models' from '/usr/lib/python3/dist-packages/azure/mgmt/loganalytics/models/__init__.py'>