azure.mgmt.loganalytics.models module

class azure.mgmt.loganalytics.models.LinkTarget(*, customer_id: str = None, display_name: str = None, workspace_name: str = None, location: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Metadata for a workspace that isn’t linked to an Azure subscription.

Parameters
  • customer_id (str) – The GUID that uniquely identifies the workspace.

  • display_name (str) – The display name of the workspace.

  • workspace_name (str) – The DNS valid workspace name.

  • location (str) – The location of the workspace.

class azure.mgmt.loganalytics.models.Tag(*, name: str, value: str, **kwargs)[source]

Bases: msrest.serialization.Model

A tag of a saved search.

All required parameters must be populated in order to send to Azure.

Parameters
  • name (str) – Required. The tag name.

  • value (str) – Required. The tag value.

class azure.mgmt.loganalytics.models.CoreSummary(*, number_of_documents: int, status: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The core summary of a search.

All required parameters must be populated in order to send to Azure.

Parameters
  • status (str) – The status of a core summary.

  • number_of_documents (long) – Required. The number of documents of a core summary.

class azure.mgmt.loganalytics.models.SearchSort(*, name: str = None, order=None, **kwargs)[source]

Bases: msrest.serialization.Model

The sort parameters for search.

Parameters
  • name (str) – The name of the field the search query is sorted on.

  • order (str or SearchSortEnum) – The sort order of the search. Possible values include: ‘asc’, ‘desc’

class azure.mgmt.loganalytics.models.SearchMetadataSchema(*, name: str = None, version: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

Schema metadata for search.

Parameters
  • name (str) – The name of the metadata schema.

  • version (int) – The version of the metadata schema.

class azure.mgmt.loganalytics.models.SearchMetadata(*, search_id: str = None, result_type: str = None, total: int = None, top: int = None, id: str = None, core_summaries=None, status: str = None, start_time=None, last_updated=None, e_tag: str = None, sort=None, request_time: int = None, aggregated_value_field: str = None, aggregated_grouping_fields: str = None, sum: int = None, max: int = None, schema=None, **kwargs)[source]

Bases: msrest.serialization.Model

Metadata for search results.

Parameters
  • search_id (str) – The request id of the search.

  • result_type (str) – The search result type.

  • total (long) – The total number of search results.

  • top (long) – The number of top search results.

  • id (str) – The id of the search results request.

  • core_summaries (list[CoreSummary]) – The core summaries.

  • status (str) – The status of the search results.

  • start_time (datetime) – The start time for the search.

  • last_updated (datetime) – The time of last update.

  • e_tag (str) – The ETag of the search results.

  • sort (list[SearchSort]) – How the results are sorted.

  • request_time (long) – The request time.

  • aggregated_value_field (str) – The aggregated value field.

  • aggregated_grouping_fields (str) – The aggregated grouping fields.

  • sum (long) – The sum of all aggregates returned in the result set.

  • max (long) – The max of all aggregates returned in the result set.

  • schema (SearchMetadataSchema) – The schema.

class azure.mgmt.loganalytics.models.SavedSearch(*, category: str, display_name: str, query: str, version: int, e_tag: str = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Value object for saved search results.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

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

  • name (str) – The name of the saved search.

  • type (str) – The type of the saved search.

Parameters
  • e_tag (str) – The etag of the saved search.

  • category (str) – Required. The category of the saved search. This helps the user to find a saved search faster.

  • display_name (str) – Required. Saved search display name.

  • query (str) – Required. The query expression for the saved search. Please see https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-search-reference for reference.

  • version (long) – Required. The version number of the query lanuage. Only verion 1 is allowed here.

  • tags (list[Tag]) – The tags attached to the saved search.

class azure.mgmt.loganalytics.models.SavedSearchesListResult(*, metadata=None, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The saved search operation response.

Parameters
class azure.mgmt.loganalytics.models.SearchError(*, type: str = None, message: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Details for a search error.

Parameters
  • type (str) – The error type.

  • message (str) – The error message.

class azure.mgmt.loganalytics.models.SearchResultsResponse(*, metadata=None, value=None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

The get search result operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The id of the search, which includes the full url.

Parameters
  • metadata (SearchMetadata) – The metadata from search results.

  • value (list[object]) – The array of result values.

  • error (SearchError) – The error.

class azure.mgmt.loganalytics.models.SearchSchemaValue(*, indexed: bool, stored: bool, facet: bool, name: str = None, display_name: str = None, type: str = None, owner_type=None, **kwargs)[source]

Bases: msrest.serialization.Model

Value object for schema results.

All required parameters must be populated in order to send to Azure.

Parameters
  • name (str) – The name of the schema.

  • display_name (str) – The display name of the schema.

  • type (str) – The type.

  • indexed (bool) – Required. The boolean that indicates the field is searchable as free text.

  • stored (bool) – Required. The boolean that indicates whether or not the field is stored.

  • facet (bool) – Required. The boolean that indicates whether or not the field is a facet.

  • owner_type (list[str]) – The array of workflows containing the field.

class azure.mgmt.loganalytics.models.SearchGetSchemaResponse(*, metadata=None, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

The get schema operation response.

Parameters
class azure.mgmt.loganalytics.models.SearchHighlight(*, pre: str = None, post: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Highlight details.

Parameters
  • pre (str) – The string that is put before a matched result.

  • post (str) – The string that is put after a matched result.

class azure.mgmt.loganalytics.models.SearchParameters(*, query: str, top: int = None, highlight=None, start=None, end=None, **kwargs)[source]

Bases: msrest.serialization.Model

Parameters specifying the search query and range.

All required parameters must be populated in order to send to Azure.

Parameters
  • top (long) – The number to get from the top.

  • highlight (SearchHighlight) – The highlight that looks for all occurences of a string.

  • query (str) – Required. The query to search.

  • start (datetime) – The start date filter, so the only query results returned are after this date.

  • end (datetime) – The end date filter, so the only query results returned are before this date.

class azure.mgmt.loganalytics.models.StorageAccount(*, id: str, key: str, **kwargs)[source]

Bases: msrest.serialization.Model

Describes a storage account connection.

All required parameters must be populated in order to send to Azure.

Parameters
  • id (str) – Required. The Azure Resource Manager ID of the storage account resource.

  • key (str) – Required. The storage account key.

class azure.mgmt.loganalytics.models.StorageInsightStatus(*, state, description: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The status of the storage insight.

All required parameters must be populated in order to send to Azure.

Parameters
  • state (str or StorageInsightState) – Required. The state of the storage insight connection to the workspace. Possible values include: ‘OK’, ‘ERROR’

  • description (str) – Description of the state of the storage insight.

class azure.mgmt.loganalytics.models.StorageInsight(*, storage_account, tags=None, containers=None, tables=None, e_tag: str = None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models.proxy_resource_py3.ProxyResource

The top level storage insight resource container.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
Parameters
  • tags (dict[str, str]) – Resource tags

  • containers (list[str]) – The names of the blob containers that the workspace should read

  • tables (list[str]) – The names of the Azure tables that the workspace should read

  • storage_account (StorageAccount) – Required. The storage account connection details

  • e_tag (str) – The ETag of the storage insight.

class azure.mgmt.loganalytics.models.Resource(*, location: str = None, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

The resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters
  • location (str) – Resource location

  • tags (dict[str, str]) – Resource tags

class azure.mgmt.loganalytics.models.ProxyResource(*, tags=None, **kwargs)[source]

Bases: msrest.serialization.Model

Common properties of proxy resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters

tags (dict[str, str]) – Resource tags

class azure.mgmt.loganalytics.models.WorkspacePurgeBodyFilters(*, column: str = None, operator: str = None, value=None, **kwargs)[source]

Bases: msrest.serialization.Model

User-defined filters to return data which will be purged from the table.

Parameters
  • column (str) – The column of the table over which the given query should run

  • operator (str) – A query operator to evaluate over the provided column and value(s).

  • value (object) – the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= ‘2017-09-01’) or array of values.

class azure.mgmt.loganalytics.models.WorkspacePurgeBody(*, table: str, filters, **kwargs)[source]

Bases: msrest.serialization.Model

Describes the body of a purge request for an App Insights Workspace.

All required parameters must be populated in order to send to Azure.

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

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

class azure.mgmt.loganalytics.models.WorkspacePurgeResponse(*, operation_id: str, **kwargs)[source]

Bases: msrest.serialization.Model

Response containing operationId for a specific purge action.

All required parameters must be populated in order to send to Azure.

Parameters

operation_id (str) – Required. Id to use when querying for status for a particular purge operation.

class azure.mgmt.loganalytics.models.WorkspacePurgeStatusResponse(*, status, **kwargs)[source]

Bases: msrest.serialization.Model

Response containing status for a specific purge operation.

All required parameters must be populated in order to send to Azure.

Parameters

status (str or PurgeState) – Required. Status of the operation represented by the requested Id. Possible values include: ‘Pending’, ‘Completed’

class azure.mgmt.loganalytics.models.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Display metadata associated with the operation.

Parameters
  • provider (str) – Service provider: Microsoft OperationsManagement.

  • resource (str) – Resource on which the operation is performed etc.

  • operation (str) – Type of operation: get, read, delete, etc.

class azure.mgmt.loganalytics.models.Operation(*, name: str = None, display=None, **kwargs)[source]

Bases: msrest.serialization.Model

Supported operation of OperationalInsights resource provider.

Parameters
  • name (str) – Operation name: {provider}/{resource}/{operation}

  • display (OperationDisplay) – Display metadata associated with the operation.

class azure.mgmt.loganalytics.models.LinkedService(*, resource_id: str, tags=None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models.proxy_resource_py3.ProxyResource

The top level Linked service resource container.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters
  • tags (dict[str, str]) – Resource tags

  • resource_id (str) – Required. The resource id of the resource that will be linked to the workspace.

class azure.mgmt.loganalytics.models.DataSource(*, properties, kind, tags=None, e_tag: str = None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models.proxy_resource_py3.ProxyResource

Datasources under OMS Workspace.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables
  • id (str) – Resource ID.

  • name (str) – Resource name.

  • type (str) – Resource type.

Parameters
  • tags (dict[str, str]) – Resource tags

  • properties (object) – Required. The data source properties in raw json format, each kind of data source have it’s own schema.

  • e_tag (str) – The ETag of the data source.

  • kind (str or DataSourceKind) – Required. Possible values include: ‘AzureActivityLog’, ‘ChangeTrackingPath’, ‘ChangeTrackingDefaultPath’, ‘ChangeTrackingDefaultRegistry’, ‘ChangeTrackingCustomRegistry’, ‘CustomLog’, ‘CustomLogCollection’, ‘GenericDataSource’, ‘IISLogs’, ‘LinuxPerformanceObject’, ‘LinuxPerformanceCollection’, ‘LinuxSyslog’, ‘LinuxSyslogCollection’, ‘WindowsEvent’, ‘WindowsPerformanceCounter’

class azure.mgmt.loganalytics.models.DataSourceFilter(*, kind=None, **kwargs)[source]

Bases: msrest.serialization.Model

DataSource filter. Right now, only filter by kind is supported.

Parameters

kind (str or DataSourceKind) – Possible values include: ‘AzureActivityLog’, ‘ChangeTrackingPath’, ‘ChangeTrackingDefaultPath’, ‘ChangeTrackingDefaultRegistry’, ‘ChangeTrackingCustomRegistry’, ‘CustomLog’, ‘CustomLogCollection’, ‘GenericDataSource’, ‘IISLogs’, ‘LinuxPerformanceObject’, ‘LinuxPerformanceCollection’, ‘LinuxSyslog’, ‘LinuxSyslogCollection’, ‘WindowsEvent’, ‘WindowsPerformanceCounter’

class azure.mgmt.loganalytics.models.IntelligencePack(*, name: str = None, enabled: bool = None, display_name: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

Intelligence Pack containing a string name and boolean indicating if it’s enabled.

Parameters
  • name (str) – The name of the intelligence pack.

  • enabled (bool) – The enabled boolean for the intelligence pack.

  • display_name (str) – The display name of the intelligence pack.

class azure.mgmt.loganalytics.models.SharedKeys(*, primary_shared_key: str = None, secondary_shared_key: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The shared keys for a workspace.

Parameters
  • primary_shared_key (str) – The primary shared key of a workspace.

  • secondary_shared_key (str) – The secondary shared key of a workspace.

class azure.mgmt.loganalytics.models.MetricName(*, value: str = None, localized_value: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The name of a metric.

Parameters
  • value (str) – The system name of the metric.

  • localized_value (str) – The localized name of the metric.

class azure.mgmt.loganalytics.models.UsageMetric(*, name=None, unit: str = None, current_value: float = None, limit: float = None, next_reset_time=None, quota_period: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A metric describing the usage of a resource.

Parameters
  • name (MetricName) – The name of the metric.

  • unit (str) – The units used for the metric.

  • current_value (float) – The current value of the metric.

  • limit (float) – The quota limit for the metric.

  • next_reset_time (datetime) – The time that the metric’s value will reset.

  • quota_period (str) – The quota period that determines the length of time between value resets.

class azure.mgmt.loganalytics.models.ManagementGroup(*, server_count: int = None, is_gateway: bool = None, name: str = None, id: str = None, created=None, data_received=None, version: str = None, sku: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

A management group that is connected to a workspace.

Parameters
  • server_count (int) – The number of servers connected to the management group.

  • is_gateway (bool) – Gets or sets a value indicating whether the management group is a gateway.

  • name (str) – The name of the management group.

  • id (str) – The unique ID of the management group.

  • created (datetime) – The datetime that the management group was created.

  • data_received (datetime) – The last datetime that the management group received data.

  • version (str) – The version of System Center that is managing the management group.

  • sku (str) – The SKU of System Center that is managing the management group.

class azure.mgmt.loganalytics.models.Sku(*, name, **kwargs)[source]

Bases: msrest.serialization.Model

The SKU (tier) of a workspace.

All required parameters must be populated in order to send to Azure.

Parameters

name (str or SkuNameEnum) – Required. The name of the SKU. Possible values include: ‘Free’, ‘Standard’, ‘Premium’, ‘Unlimited’, ‘PerNode’, ‘PerGB2018’, ‘Standalone’

class azure.mgmt.loganalytics.models.Workspace(*, location: str = None, tags=None, provisioning_state=None, source: str = None, customer_id: str = None, portal_url: str = None, sku=None, retention_in_days: int = None, e_tag: str = None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models.resource_py3.Resource

The top level Workspace resource container.

Variables are only populated by the server, and will be ignored when sending a request.

Variables
  • id (str) – Resource Id

  • name (str) – Resource name

  • type (str) – Resource type

Parameters
  • location (str) – Resource location

  • tags (dict[str, str]) – Resource tags

  • provisioning_state (str or EntityStatus) – The provisioning state of the workspace. Possible values include: ‘Creating’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Deleting’, ‘ProvisioningAccount’

  • source (str) – The source of the workspace. Source defines where the workspace was created. ‘Azure’ implies it was created in Azure. ‘External’ implies it was created via the Operational Insights Portal. This value is set on the service side and read-only on the client side.

  • customer_id (str) – The ID associated with the workspace. Setting this value at creation time allows the workspace being created to be linked to an existing workspace.

  • portal_url (str) – The URL of the Operational Insights portal for this workspace. This value is set on the service side and read-only on the client side.

  • sku (Sku) – The SKU of the workspace.

  • retention_in_days (int) – The workspace data retention in days. -1 means Unlimited retention for the Unlimited Sku. 730 days is the maximum allowed for all other Skus.

  • e_tag (str) – The ETag of the workspace.

class azure.mgmt.loganalytics.models.StorageInsightPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of StorageInsight object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.UsageMetricPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of UsageMetric object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.ManagementGroupPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ManagementGroup object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.WorkspacePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Workspace object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.LinkedServicePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of LinkedService object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.DataSourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataSource object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

Bring async to Paging.

“async_command” is mandatory keyword argument for this mixin to work.

class azure.mgmt.loganalytics.models.SearchSortEnum[source]

Bases: str, enum.Enum

An enumeration.

asc = 'asc'
desc = 'desc'
class azure.mgmt.loganalytics.models.StorageInsightState[source]

Bases: str, enum.Enum

An enumeration.

error = 'ERROR'
ok = 'OK'
class azure.mgmt.loganalytics.models.PurgeState[source]

Bases: str, enum.Enum

An enumeration.

completed = 'Completed'
pending = 'Pending'
class azure.mgmt.loganalytics.models.DataSourceKind[source]

Bases: str, enum.Enum

An enumeration.

azure_activity_log = 'AzureActivityLog'
change_tracking_custom_registry = 'ChangeTrackingCustomRegistry'
change_tracking_default_path = 'ChangeTrackingDefaultPath'
change_tracking_default_registry = 'ChangeTrackingDefaultRegistry'
change_tracking_path = 'ChangeTrackingPath'
custom_log = 'CustomLog'
custom_log_collection = 'CustomLogCollection'
generic_data_source = 'GenericDataSource'
iis_logs = 'IISLogs'
linux_performance_collection = 'LinuxPerformanceCollection'
linux_performance_object = 'LinuxPerformanceObject'
linux_syslog = 'LinuxSyslog'
linux_syslog_collection = 'LinuxSyslogCollection'
windows_event = 'WindowsEvent'
windows_performance_counter = 'WindowsPerformanceCounter'
class azure.mgmt.loganalytics.models.SkuNameEnum[source]

Bases: str, enum.Enum

An enumeration.

free = 'Free'
per_gb2018 = 'PerGB2018'
per_node = 'PerNode'
premium = 'Premium'
standalone = 'Standalone'
standard = 'Standard'
unlimited = 'Unlimited'
class azure.mgmt.loganalytics.models.EntityStatus[source]

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
provisioning_account = 'ProvisioningAccount'
succeeded = 'Succeeded'