azure.mgmt.loganalytics.models module

exception azure.mgmt.loganalytics.models.ClusterErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ClusterErrorResponse’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

exception azure.mgmt.loganalytics.models.DataExportErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘DataExportErrorResponse’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

exception azure.mgmt.loganalytics.models.ErrorContractException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorContract’.

Parameters

  • deserialize – A deserializer

  • response – Server response to be deserialized.

class azure.mgmt.loganalytics.models.AvailableServiceTier(**kwargs)[source]

Bases: msrest.serialization.Model

Service Tier details.

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

Variables

  • service_tier (str or SkuNameEnum) – The name of the Service Tier. Possible values include: ‘Free’, ‘Standard’, ‘Premium’, ‘PerNode’, ‘PerGB2018’, ‘Standalone’, ‘CapacityReservation’

  • enabled (bool) – True if the Service Tier is enabled for the workspace.

  • minimum_retention (long) – The minimum retention for the Service Tier, in days.

  • maximum_retention (long) – The maximum retention for the Service Tier, in days.

  • default_retention (long) – The default retention for the Service Tier, in days.

  • capacity_reservation_level (long) – The capacity reservation level in GB per day. Returned for the Capacity Reservation Service Tier.

  • last_sku_update (str) – Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier.

class azure.mgmt.loganalytics.models.AzureEntityResource(**kwargs)[source]

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

The resource model definition for a Azure Resource Manager resource with an etag.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • etag (str) – Resource Etag.

class azure.mgmt.loganalytics.models.Cluster(*, location: str, tags=None, identity=None, sku=None, next_link: str = None, key_vault_properties=None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models._models_py3.TrackedResource

The top level Log Analytics cluster 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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • cluster_id (str) – The ID associated with the cluster.

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

Parameters

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

  • location (str) – Required. The geo-location where the resource lives

  • identity (Identity) – The identity of the resource.

  • sku (ClusterSku) – The sku properties.

  • next_link (str) – The link used to get the next page of recommendations.

  • key_vault_properties (KeyVaultProperties) – The associated key properties.

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

Bases: msrest.serialization.Model

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Parameters

error (ErrorResponse) – The details of the error.

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

Bases: msrest.serialization.Model

The top level Log Analytics cluster resource container.

Parameters
class azure.mgmt.loganalytics.models.ClusterSku(*, capacity: int = None, name=None, **kwargs)[source]

Bases: msrest.serialization.Model

The cluster sku definition.

Parameters

  • capacity (long) – The capacity value

  • name (str or ClusterSkuNameEnum) – The name of the SKU. Possible values include: ‘CapacityReservation’

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.DataExport(*, resource_id: str, data_export_id: str = None, all_tables: bool = None, table_names=None, event_hub_name: str = None, enable: bool = None, created_date: str = None, last_modified_date: str = None, **kwargs)[source]

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

The top level data export 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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • data_export_type (str or Type) – The type of the destination resource. Possible values include: ‘StorageAccount’, ‘EventHub’

Parameters

  • data_export_id (str) – The data export rule ID.

  • all_tables (bool) – When ‘true’, all workspace’s tables are exported.

  • table_names (list[str]) – An array of tables to export, for example: [“Heartbeat, SecurityEvent”].

  • resource_id (str) – Required. The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure.

  • event_hub_name (str) – Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.

  • enable (bool) – Active when enabled.

  • created_date (str) – The latest data export rule modification time.

  • last_modified_date (str) – Date and time when the export was last modified.

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

Bases: msrest.serialization.Model

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Parameters

error (ErrorResponse) – The details of the error.

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

Bases: azure.mgmt.loganalytics.models._models_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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

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

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

  • kind (str or DataSourceKind) – Required. Possible values include: ‘WindowsEvent’, ‘WindowsPerformanceCounter’, ‘IISLogs’, ‘LinuxSyslog’, ‘LinuxSyslogCollection’, ‘LinuxPerformanceObject’, ‘LinuxPerformanceCollection’, ‘CustomLog’, ‘CustomLogCollection’, ‘AzureAuditLog’, ‘AzureActivityLog’, ‘GenericDataSource’, ‘ChangeTrackingCustomPath’, ‘ChangeTrackingPath’, ‘ChangeTrackingServices’, ‘ChangeTrackingDataTypeConfiguration’, ‘ChangeTrackingDefaultRegistry’, ‘ChangeTrackingRegistry’, ‘ChangeTrackingLinuxPath’, ‘LinuxChangeTrackingPath’, ‘ChangeTrackingContentLocation’, ‘WindowsTelemetry’, ‘Office365’, ‘SecurityWindowsBaselineConfiguration’, ‘SecurityCenterSecurityWindowsBaselineConfiguration’, ‘SecurityEventCollectionConfiguration’, ‘SecurityInsightsSecurityEventCollectionConfiguration’, ‘ImportComputerGroup’, ‘NetworkMonitoring’, ‘Itsm’, ‘DnsAnalytics’, ‘ApplicationInsights’, ‘SqlDataClassification’

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

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: ‘WindowsEvent’, ‘WindowsPerformanceCounter’, ‘IISLogs’, ‘LinuxSyslog’, ‘LinuxSyslogCollection’, ‘LinuxPerformanceObject’, ‘LinuxPerformanceCollection’, ‘CustomLog’, ‘CustomLogCollection’, ‘AzureAuditLog’, ‘AzureActivityLog’, ‘GenericDataSource’, ‘ChangeTrackingCustomPath’, ‘ChangeTrackingPath’, ‘ChangeTrackingServices’, ‘ChangeTrackingDataTypeConfiguration’, ‘ChangeTrackingDefaultRegistry’, ‘ChangeTrackingRegistry’, ‘ChangeTrackingLinuxPath’, ‘LinuxChangeTrackingPath’, ‘ChangeTrackingContentLocation’, ‘WindowsTelemetry’, ‘Office365’, ‘SecurityWindowsBaselineConfiguration’, ‘SecurityCenterSecurityWindowsBaselineConfiguration’, ‘SecurityEventCollectionConfiguration’, ‘SecurityInsightsSecurityEventCollectionConfiguration’, ‘ImportComputerGroup’, ‘NetworkMonitoring’, ‘Itsm’, ‘DnsAnalytics’, ‘ApplicationInsights’, ‘SqlDataClassification’

class azure.mgmt.loganalytics.models.ErrorAdditionalInfo(**kwargs)[source]

Bases: msrest.serialization.Model

The resource management error additional info.

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

Variables

  • type (str) – The additional info type.

  • info (object) – The additional info.

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

Bases: msrest.serialization.Model

Error details.

Contains details when the response code indicates an error.

Parameters

error (ErrorResponse) – The details of the error.

class azure.mgmt.loganalytics.models.ErrorResponse(**kwargs)[source]

Bases: msrest.serialization.Model

The resource management error response.

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

Variables
class azure.mgmt.loganalytics.models.Identity(*, type, **kwargs)[source]

Bases: msrest.serialization.Model

Identity for the resource.

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

  • principal_id (str) – The principal ID of resource identity.

  • tenant_id (str) – The tenant ID of resource.

Parameters

type (str or IdentityType) – Required. The identity type. Possible values include: ‘SystemAssigned’, ‘None’

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.KeyVaultProperties(*, key_vault_uri: str = None, key_name: str = None, key_version: str = None, **kwargs)[source]

Bases: msrest.serialization.Model

The key vault properties.

Parameters

  • key_vault_uri (str) – The Key Vault uri which holds they key associated with the Log Analytics cluster.

  • key_name (str) – The name of the key associated with the Log Analytics cluster.

  • key_version (str) – The version of the key associated with the Log Analytics cluster.

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

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

The top level Linked service resource container.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

  • resource_id (str) – The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require read access

  • write_access_resource_id (str) – The resource id of the resource that will be linked to the workspace. This should be used for linking resources which require write access

  • provisioning_state (str or LinkedServiceEntityStatus) – The provisioning state of the linked service. Possible values include: ‘Succeeded’, ‘Deleting’, ‘ProvisioningAccount’, ‘Updating’

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

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

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

Linked storage accounts top level resource container.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

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

Parameters

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

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.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.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.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, description: 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.

  • description (str) – Description of operation

class azure.mgmt.loganalytics.models.OperationStatus(*, id: str = None, name: str = None, start_time: str = None, end_time: str = None, status: str = None, error=None, **kwargs)[source]

Bases: msrest.serialization.Model

The status of operation.

Parameters

  • id (str) – The operation Id.

  • name (str) – The operation name.

  • start_time (str) – The start time of the operation.

  • end_time (str) – The end time of the operation.

  • status (str) – The status of the operation.

  • error (ErrorResponse) – The error detail of the operation if any.

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

Bases: msrest.serialization.Model

The private link scope resource reference.

Parameters

  • resource_id (str) – The full resource Id of the private link scope resource.

  • scope_id (str) – The private link scope unique Identifier.

class azure.mgmt.loganalytics.models.ProxyResource(**kwargs)[source]

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

The resource model definition for a ARM proxy resource. It will have everything other than required location and tags.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.loganalytics.models.Resource(**kwargs)[source]

Bases: msrest.serialization.Model

Resource.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

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

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

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

  • etag (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.

  • function_alias (str) – The function alias if query serves as a function.

  • function_parameters (str) – The optional function parameters if query serves as a function. Value should be in the following format: ‘param-name1:type1 = default_value1, param-name2:type2 = default_value2’. For more examples and proper syntax please refer to https://docs.microsoft.com/en-us/azure/kusto/query/functions/user-defined-functions.

  • version (long) – The version number of the query language. The current version is 2 and is the default.

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

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

Bases: msrest.serialization.Model

The saved search list operation response.

Parameters

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

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.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.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.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.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.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.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.StorageInsight(*, storage_account, containers=None, tables=None, e_tag: str = None, tags=None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models._models_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

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • status (StorageInsightStatus) – The status of the storage insight

Parameters

  • 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.

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

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.Table(*, retention_in_days: int = None, **kwargs)[source]

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

Workspace data table definition.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

retention_in_days (int) – The data table data retention in days, between 30 and 730. Setting this property to null will default to the workspace retention.

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.TrackedResource(*, location: str, tags=None, **kwargs)[source]

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

The resource model definition for a ARM tracked top level resource.

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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

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

  • location (str) – Required. The geo-location where the resource lives

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.Workspace(*, location: str, tags=None, provisioning_state=None, sku=None, retention_in_days: int = None, workspace_capping=None, public_network_access_for_ingestion='Enabled', public_network_access_for_query='Enabled', e_tag: str = None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models._models_py3.TrackedResource

The top level Workspace 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) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • customer_id (str) – This is a read-only property. Represents the ID associated with the workspace.

  • private_link_scoped_resources (list[PrivateLinkScopedResource]) – List of linked private link scope resources.

Parameters

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

  • location (str) – Required. The geo-location where the resource lives

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

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

  • retention_in_days (int) – The workspace data retention in days, between 30 and 730.

  • workspace_capping (WorkspaceCapping) – The daily volume cap for ingestion.

  • public_network_access_for_ingestion (str or PublicNetworkAccessType) – The network access type for accessing Log Analytics ingestion. Possible values include: ‘Enabled’, ‘Disabled’. Default value: “Enabled” .

  • public_network_access_for_query (str or PublicNetworkAccessType) – The network access type for accessing Log Analytics query. Possible values include: ‘Enabled’, ‘Disabled’. Default value: “Enabled” .

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

class azure.mgmt.loganalytics.models.WorkspaceCapping(*, daily_quota_gb: float = None, **kwargs)[source]

Bases: msrest.serialization.Model

The daily volume cap for ingestion.

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

Parameters

daily_quota_gb (float) – The workspace daily quota for ingestion.

Variables

  • quota_next_reset_time (str) – The time when the quota will be rest.

  • data_ingestion_status (str or DataIngestionStatus) – The status of data ingestion for this workspace. Possible values include: ‘RespectQuota’, ‘ForceOn’, ‘ForceOff’, ‘OverQuota’, ‘SubscriptionSuspended’, ‘ApproachingQuota’

class azure.mgmt.loganalytics.models.WorkspacePatch(*, provisioning_state=None, sku=None, retention_in_days: int = None, workspace_capping=None, public_network_access_for_ingestion='Enabled', public_network_access_for_query='Enabled', tags=None, **kwargs)[source]

Bases: azure.mgmt.loganalytics.models._models_py3.AzureEntityResource

The top level Workspace resource container.

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

Variables

  • id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

  • name (str) – The name of the resource

  • type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

  • etag (str) – Resource Etag.

  • customer_id (str) – This is a read-only property. Represents the ID associated with the workspace.

  • private_link_scoped_resources (list[PrivateLinkScopedResource]) – List of linked private link scope resources.

Parameters

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

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

  • retention_in_days (int) – The workspace data retention in days, between 30 and 730.

  • workspace_capping (WorkspaceCapping) – The daily volume cap for ingestion.

  • public_network_access_for_ingestion (str or PublicNetworkAccessType) – The network access type for accessing Log Analytics ingestion. Possible values include: ‘Enabled’, ‘Disabled’. Default value: “Enabled” .

  • public_network_access_for_query (str or PublicNetworkAccessType) – The network access type for accessing Log Analytics query. Possible values include: ‘Enabled’, ‘Disabled’. Default value: “Enabled” .

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

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.WorkspacePurgeBodyFilters(*, column: str = None, operator: str = None, value=None, key: str = 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). Supported operators are ==, =~, in, in~, >, >=, <, <=, between, and have the same behavior as they would in a KQL query.

  • 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.

  • key (str) – When filtering over custom dimensions, this key will be used as the name of the custom dimension.

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.WorkspaceSku(*, name, capacity_reservation_level: int = None, **kwargs)[source]

Bases: msrest.serialization.Model

The SKU (tier) of a 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.

Parameters

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

  • capacity_reservation_level (int) – The capacity reservation level for this workspace, when CapacityReservation sku is selected.

Variables

  • max_capacity_reservation_level (int) – The maximum capacity reservation level available for this workspace, when CapacityReservation sku is selected.

  • last_sku_update (str) – The last time when the sku was updated.

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of DataExport 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.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.LinkedStorageAccountsResourcePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of LinkedStorageAccountsResource 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.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.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.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.ClusterPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Cluster object

Bring async to Paging.

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

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.TablePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Table object

Bring async to Paging.

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

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

Bases: str, enum.Enum

An enumeration.

event_hub = 'EventHub'
storage_account = 'StorageAccount'
class azure.mgmt.loganalytics.models.DataSourceKind[source]

Bases: str, enum.Enum

An enumeration.

application_insights = 'ApplicationInsights'
azure_activity_log = 'AzureActivityLog'
azure_audit_log = 'AzureAuditLog'
change_tracking_content_location = 'ChangeTrackingContentLocation'
change_tracking_custom_path = 'ChangeTrackingCustomPath'
change_tracking_data_type_configuration = 'ChangeTrackingDataTypeConfiguration'
change_tracking_default_registry = 'ChangeTrackingDefaultRegistry'
change_tracking_linux_path = 'ChangeTrackingLinuxPath'
change_tracking_path = 'ChangeTrackingPath'
change_tracking_registry = 'ChangeTrackingRegistry'
change_tracking_services = 'ChangeTrackingServices'
custom_log = 'CustomLog'
custom_log_collection = 'CustomLogCollection'
dns_analytics = 'DnsAnalytics'
generic_data_source = 'GenericDataSource'
iis_logs = 'IISLogs'
import_computer_group = 'ImportComputerGroup'
itsm = 'Itsm'
linux_change_tracking_path = 'LinuxChangeTrackingPath'
linux_performance_collection = 'LinuxPerformanceCollection'
linux_performance_object = 'LinuxPerformanceObject'
linux_syslog = 'LinuxSyslog'
linux_syslog_collection = 'LinuxSyslogCollection'
network_monitoring = 'NetworkMonitoring'
office365 = 'Office365'
security_center_security_windows_baseline_configuration = 'SecurityCenterSecurityWindowsBaselineConfiguration'
security_event_collection_configuration = 'SecurityEventCollectionConfiguration'
security_insights_security_event_collection_configuration = 'SecurityInsightsSecurityEventCollectionConfiguration'
security_windows_baseline_configuration = 'SecurityWindowsBaselineConfiguration'
sql_data_classification = 'SqlDataClassification'
windows_event = 'WindowsEvent'
windows_performance_counter = 'WindowsPerformanceCounter'
windows_telemetry = 'WindowsTelemetry'
class azure.mgmt.loganalytics.models.LinkedServiceEntityStatus[source]

Bases: str, enum.Enum

An enumeration.

deleting = 'Deleting'
provisioning_account = 'ProvisioningAccount'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.loganalytics.models.DataSourceType[source]

Bases: str, enum.Enum

An enumeration.

alerts = 'Alerts'
azure_watson = 'AzureWatson'
custom_logs = 'CustomLogs'
query = 'Query'
class azure.mgmt.loganalytics.models.WorkspaceSkuNameEnum[source]

Bases: str, enum.Enum

An enumeration.

capacity_reservation = 'CapacityReservation'
free = 'Free'
per_gb2018 = 'PerGB2018'
per_node = 'PerNode'
premium = 'Premium'
standalone = 'Standalone'
standard = 'Standard'
class azure.mgmt.loganalytics.models.DataIngestionStatus[source]

Bases: str, enum.Enum

An enumeration.

approaching_quota = 'ApproachingQuota'

80% of daily cap quota reached.

force_off = 'ForceOff'

Ingestion stopped following service setting change.

force_on = 'ForceOn'

Ingestion started following service setting change.

over_quota = 'OverQuota'

Reached daily cap quota, ingestion stopped.

respect_quota = 'RespectQuota'

Ingestion enabled following daily cap quota reset, or subscription enablement.

subscription_suspended = 'SubscriptionSuspended'

Ingestion stopped following suspended subscription.

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

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
provisioning_account = 'ProvisioningAccount'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.loganalytics.models.PublicNetworkAccessType[source]

Bases: str, enum.Enum

An enumeration.

disabled = 'Disabled'

Disables public connectivity to Log Analytics through public DNS.

enabled = 'Enabled'

Enables connectivity to Log Analytics through public DNS.

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

Bases: str, enum.Enum

An enumeration.

canceled = 'Canceled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
provisioning_account = 'ProvisioningAccount'
succeeded = 'Succeeded'
updating = 'Updating'
class azure.mgmt.loganalytics.models.ClusterSkuNameEnum[source]

Bases: str, enum.Enum

An enumeration.

capacity_reservation = 'CapacityReservation'
class azure.mgmt.loganalytics.models.IdentityType[source]

Bases: str, enum.Enum

An enumeration.

none = 'None'
system_assigned = 'SystemAssigned'
class azure.mgmt.loganalytics.models.StorageInsightState[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

capacity_reservation = 'CapacityReservation'
free = 'Free'
per_gb2018 = 'PerGB2018'
per_node = 'PerNode'
premium = 'Premium'
standalone = 'Standalone'
standard = 'Standard'
class azure.mgmt.loganalytics.models.SearchSortEnum[source]

Bases: str, enum.Enum

An enumeration.

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

Bases: str, enum.Enum

An enumeration.

completed = 'completed'
pending = 'pending'