azure.mgmt.loganalytics.models module¶
-
class
azure.mgmt.loganalytics.models.
AssociatedWorkspace
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The list of Log Analytics workspaces associated with the cluster.
Variables are only populated by the server, and will be ignored when sending a request.
-
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 an 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
etag (str) – Resource Etag.
-
class
azure.mgmt.loganalytics.models.
AzureResourceProperties
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
An Azure resource QueryPack-Query object.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.loganalytics.models.
BillingType
(value)[source]¶ -
Configures whether billing will be only on the cluster or each workspace will be billed by its proportional use. This does not change the overall billing, only how it will be distributed. Default value is ‘Cluster’
-
CLUSTER
= 'Cluster'¶
-
WORKSPACES
= 'Workspaces'¶
-
-
class
azure.mgmt.loganalytics.models.
Capacity
(value)[source]¶ -
The capacity value
-
FIVE_HUNDRED
= 500¶
-
FIVE_THOUSAND
= 5000¶
-
TEN_HUNDRED
= 1000¶
-
TWO_THOUSAND
= 2000¶
-
-
class
azure.mgmt.loganalytics.models.
CapacityReservationLevel
(value)[source]¶ -
The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected.
-
FIVE_HUNDRED
= 500¶
-
FIVE_THOUSAND
= 5000¶
-
FOUR_HUNDRED
= 400¶
-
ONE_HUNDRED
= 100¶
-
TEN_HUNDRED
= 1000¶
-
THREE_HUNDRED
= 300¶
-
TWO_HUNDRED
= 200¶
-
TWO_THOUSAND
= 2000¶
-
-
class
azure.mgmt.loganalytics.models.
CapacityReservationProperties
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The Capacity Reservation properties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
last_sku_update (str) – The last time Sku was updated.
min_capacity (long) – Minimum CapacityReservation value in GB.
-
class
azure.mgmt.loganalytics.models.
Cluster
(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[azure.mgmt.loganalytics.models._models_py3.Identity] = None, sku: Optional[azure.mgmt.loganalytics.models._models_py3.ClusterSku] = None, is_double_encryption_enabled: Optional[bool] = None, is_availability_zones_enabled: Optional[bool] = None, billing_type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.BillingType]] = None, key_vault_properties: Optional[azure.mgmt.loganalytics.models._models_py3.KeyVaultProperties] = None, associated_workspaces: Optional[List[azure.mgmt.loganalytics.models._models_py3.AssociatedWorkspace]] = None, capacity_reservation_properties: Optional[azure.mgmt.loganalytics.models._models_py3.CapacityReservationProperties] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
location (str) – Required. The geo-location where the resource lives.
identity (Identity) – The identity of the resource.
sku (ClusterSku) – The sku properties.
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”.
is_double_encryption_enabled (bool) – Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is ‘true’.
is_availability_zones_enabled (bool) – Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is ‘true’ if region supports Availability Zones.
billing_type (str or BillingType) – The cluster’s billing type. Possible values include: “Cluster”, “Workspaces”.
key_vault_properties (KeyVaultProperties) – The associated key properties.
last_modified_date (str) – The last time the cluster was updated.
created_date (str) – The cluster creation time.
associated_workspaces (list[AssociatedWorkspace]) – The list of Log Analytics workspaces associated with the cluster.
capacity_reservation_properties (CapacityReservationProperties) – Additional properties for capacity reservation.
- Keyword Arguments
location (str) – Required. The geo-location where the resource lives.
identity (Identity) – The identity of the resource.
sku (ClusterSku) – The sku properties.
is_double_encryption_enabled (bool) – Configures whether cluster will use double encryption. This Property can not be modified after cluster creation. Default value is ‘true’.
is_availability_zones_enabled (bool) – Sets whether the cluster will support availability zones. This can be set as true only in regions where Azure Data Explorer support Availability Zones. This Property can not be modified after cluster creation. Default value is ‘true’ if region supports Availability Zones.
billing_type (str or BillingType) – The cluster’s billing type. Possible values include: “Cluster”, “Workspaces”.
key_vault_properties (KeyVaultProperties) – The associated key properties.
associated_workspaces (list[AssociatedWorkspace]) – The list of Log Analytics workspaces associated with the cluster.
capacity_reservation_properties (CapacityReservationProperties) – Additional properties for capacity reservation.
-
class
azure.mgmt.loganalytics.models.
ClusterEntityStatus
(value)[source]¶ -
The provisioning state of the cluster.
-
CANCELED
= 'Canceled'¶
-
CREATING
= 'Creating'¶
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
PROVISIONING_ACCOUNT
= 'ProvisioningAccount'¶
-
SUCCEEDED
= 'Succeeded'¶
-
UPDATING
= 'Updating'¶
-
-
class
azure.mgmt.loganalytics.models.
ClusterListResult
(*, next_link: Optional[str] = None, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.Cluster]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list clusters operation response.
-
class
azure.mgmt.loganalytics.models.
ClusterPatch
(*, identity: Optional[azure.mgmt.loganalytics.models._models_py3.Identity] = None, sku: Optional[azure.mgmt.loganalytics.models._models_py3.ClusterSku] = None, tags: Optional[Dict[str, str]] = None, key_vault_properties: Optional[azure.mgmt.loganalytics.models._models_py3.KeyVaultProperties] = None, billing_type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.BillingType]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The top level Log Analytics cluster resource container.
- Variables
identity (Identity) – The identity of the resource.
sku (ClusterSku) – The sku properties.
key_vault_properties (KeyVaultProperties) – The associated key properties.
billing_type (str or BillingType) – The cluster’s billing type. Possible values include: “Cluster”, “Workspaces”.
- Keyword Arguments
identity (Identity) – The identity of the resource.
sku (ClusterSku) – The sku properties.
key_vault_properties (KeyVaultProperties) – The associated key properties.
billing_type (str or BillingType) – The cluster’s billing type. Possible values include: “Cluster”, “Workspaces”.
-
class
azure.mgmt.loganalytics.models.
ClusterSku
(*, capacity: Optional[Union[int, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.Capacity]] = None, name: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.ClusterSkuNameEnum]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The cluster sku definition.
- Variables
capacity (int or Capacity) – The capacity value. Possible values include: 500, 1000, 2000, 5000.
name (str or ClusterSkuNameEnum) – The name of the SKU. Possible values include: “CapacityReservation”.
- Keyword Arguments
capacity (int or Capacity) – The capacity value. Possible values include: 500, 1000, 2000, 5000.
name (str or ClusterSkuNameEnum) – The name of the SKU. Possible values include: “CapacityReservation”.
-
class
azure.mgmt.loganalytics.models.
ClusterSkuNameEnum
(value)[source]¶ -
The name of the SKU.
-
CAPACITY_RESERVATION
= 'CapacityReservation'¶
-
-
class
azure.mgmt.loganalytics.models.
Column
(*, name: Optional[str] = None, type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.ColumnTypeEnum]] = None, data_type_hint: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.ColumnDataTypeHintEnum]] = None, display_name: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Table column.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Column name.
type (str or ColumnTypeEnum) – Column data type. Possible values include: “string”, “int”, “long”, “real”, “boolean”, “dateTime”, “guid”, “dynamic”.
data_type_hint (str or ColumnDataTypeHintEnum) – Column data type logical hint. Possible values include: “uri”, “guid”, “armPath”, “ip”.
display_name (str) – Column display name.
description (str) – Column description.
is_default_display (bool) – Is displayed by default.
is_hidden (bool) – Is column hidden.
- Keyword Arguments
name (str) – Column name.
type (str or ColumnTypeEnum) – Column data type. Possible values include: “string”, “int”, “long”, “real”, “boolean”, “dateTime”, “guid”, “dynamic”.
data_type_hint (str or ColumnDataTypeHintEnum) – Column data type logical hint. Possible values include: “uri”, “guid”, “armPath”, “ip”.
display_name (str) – Column display name.
description (str) – Column description.
-
class
azure.mgmt.loganalytics.models.
ColumnDataTypeHintEnum
(value)[source]¶ -
Column data type logical hint.
-
ARM_PATH
= 'armPath'¶ An Azure Resource Model (ARM) path: /subscriptions/{…}/resourceGroups/{…}/providers/Microsoft.{…}/{…}/{…}/{…}…
-
GUID
= 'guid'¶ A standard 128-bit GUID following the standard shape, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
-
IP
= 'ip'¶ y:y:y:y:y:y.
- Type
A standard V4/V6 ip address following the standard shape, x.x.x.x/y
- Type
y
-
URI
= 'uri'¶ A string that matches the pattern of a URI, for example, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment.
-
-
class
azure.mgmt.loganalytics.models.
ColumnTypeEnum
(value)[source]¶ -
Column data type.
-
BOOLEAN
= 'boolean'¶
-
DATE_TIME
= 'dateTime'¶
-
DYNAMIC
= 'dynamic'¶
-
GUID
= 'guid'¶
-
INT
= 'int'¶
-
LONG
= 'long'¶
-
REAL
= 'real'¶
-
STRING
= 'string'¶
-
-
class
azure.mgmt.loganalytics.models.
CoreSummary
(*, number_of_documents: int, status: Optional[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.
-
class
azure.mgmt.loganalytics.models.
CreatedByType
(value)[source]¶ -
The type of identity that created the resource.
-
APPLICATION
= 'Application'¶
-
KEY
= 'Key'¶
-
MANAGED_IDENTITY
= 'ManagedIdentity'¶
-
USER
= 'User'¶
-
-
class
azure.mgmt.loganalytics.models.
DataExport
(*, data_export_id: Optional[str] = None, table_names: Optional[List[str]] = None, enable: Optional[bool] = None, created_date: Optional[str] = None, last_modified_date: Optional[str] = None, resource_id: Optional[str] = None, event_hub_name: Optional[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.
- 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
data_export_id (str) – The data export rule ID.
table_names (list[str]) – An array of tables to export, for example: [“Heartbeat, SecurityEvent”].
created_date (str) – The latest data export rule modification time.
last_modified_date (str) – Date and time when the export was last modified.
resource_id (str) – The destination resource ID. This can be copied from the Properties entry of the destination resource in Azure.
type_properties_destination_type (str or Type) – The type of the destination resource. Possible values include: “StorageAccount”, “EventHub”.
event_hub_name (str) – Optional. Allows to define an Event Hub name. Not applicable when destination is Storage Account.
- Keyword Arguments
data_export_id (str) – The data export rule ID.
table_names (list[str]) – An array of tables to export, for example: [“Heartbeat, SecurityEvent”].
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.
resource_id (str) – 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.
-
class
azure.mgmt.loganalytics.models.
DataExportListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.DataExport]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Result of the request to list data exports.
- Variables
value (list[DataExport]) – List of data export instances within a workspace..
- Keyword Arguments
value (list[DataExport]) – List of data export instances within a workspace..
-
class
azure.mgmt.loganalytics.models.
DataIngestionStatus
(value)[source]¶ -
The status of data ingestion for this workspace.
-
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.
DataSource
(*, properties: Any, kind: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceKind], etag: Optional[str] = None, tags: Optional[Dict[str, str]] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
properties (any) – 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. The kind of the DataSource. 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”.
- Keyword Arguments
properties (any) – 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. The kind of the DataSource. 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.
DataSourceFilter
(*, kind: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.DataSourceKind]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
DataSource filter. Right now, only filter by kind is supported.
- Variables
kind (str or DataSourceKind) – The kind of the DataSource. 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”.
- Keyword Arguments
kind (str or DataSourceKind) – The kind of the DataSource. 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.
DataSourceKind
(value)[source]¶ -
The kind of the DataSource.
-
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.
DataSourceListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.DataSource]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list data source by workspace operation response.
- Variables
value (list[DataSource]) – A list of datasources.
next_link (str) – The link (url) to the next page of datasources.
- Keyword Arguments
value (list[DataSource]) – A list of datasources.
next_link (str) – The link (url) to the next page of datasources.
-
class
azure.mgmt.loganalytics.models.
DataSourceType
(value)[source]¶ -
Linked storage accounts type.
-
ALERTS
= 'Alerts'¶
-
AZURE_WATSON
= 'AzureWatson'¶
-
CUSTOM_LOGS
= 'CustomLogs'¶
-
QUERY
= 'Query'¶
-
-
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.
-
class
azure.mgmt.loganalytics.models.
ErrorDetail
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
The error detail.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.
-
class
azure.mgmt.loganalytics.models.
ErrorResponse
(*, error: Optional[azure.mgmt.loganalytics.models._models_py3.ErrorDetail] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
- Variables
error (ErrorDetail) – The error object.
- Keyword Arguments
error (ErrorDetail) – The error object.
-
class
azure.mgmt.loganalytics.models.
Identity
(*, type: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.IdentityType], user_assigned_identities: Optional[Dict[str, azure.mgmt.loganalytics.models._models_py3.UserIdentityProperties]] = None, **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.
type (str or IdentityType) – Required. Type of managed service identity. Possible values include: “user”, “application”, “managedIdentity”, “key”, “SystemAssigned”, “UserAssigned”, “None”.
user_assigned_identities (dict[str, UserIdentityProperties]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.
- Keyword Arguments
type (str or IdentityType) – Required. Type of managed service identity. Possible values include: “user”, “application”, “managedIdentity”, “key”, “SystemAssigned”, “UserAssigned”, “None”.
user_assigned_identities (dict[str, UserIdentityProperties]) – The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.
-
class
azure.mgmt.loganalytics.models.
IdentityType
(value)[source]¶ -
The type of identity that creates/modifies resources
-
APPLICATION
= 'application'¶
-
KEY
= 'key'¶
-
MANAGED_IDENTITY
= 'managedIdentity'¶
-
NONE
= 'None'¶
-
SYSTEM_ASSIGNED
= 'SystemAssigned'¶
-
USER
= 'user'¶
-
USER_ASSIGNED
= 'UserAssigned'¶
-
-
class
azure.mgmt.loganalytics.models.
IntelligencePack
(*, name: Optional[str] = None, enabled: Optional[bool] = None, display_name: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Intelligence Pack containing a string name and boolean indicating if it’s enabled.
- Variables
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
KeyVaultProperties
(*, key_vault_uri: Optional[str] = None, key_name: Optional[str] = None, key_version: Optional[str] = None, key_rsa_size: Optional[int] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The key vault properties.
- Variables
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.
key_rsa_size (int) – Selected key minimum required size.
- Keyword Arguments
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.
key_rsa_size (int) – Selected key minimum required size.
-
class
azure.mgmt.loganalytics.models.
LinkedService
(*, tags: Optional[Dict[str, str]] = None, resource_id: Optional[str] = None, write_access_resource_id: Optional[str] = None, provisioning_state: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.LinkedServiceEntityStatus]] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
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”.
- Keyword Arguments
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”.
-
class
azure.mgmt.loganalytics.models.
LinkedServiceEntityStatus
(value)[source]¶ -
The provisioning state of the linked service.
-
DELETING
= 'Deleting'¶
-
PROVISIONING_ACCOUNT
= 'ProvisioningAccount'¶
-
SUCCEEDED
= 'Succeeded'¶
-
UPDATING
= 'Updating'¶
-
-
class
azure.mgmt.loganalytics.models.
LinkedServiceListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.LinkedService]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list linked service operation response.
- Variables
value (list[LinkedService]) – The list of linked service instances.
- Keyword Arguments
value (list[LinkedService]) – The list of linked service instances.
-
class
azure.mgmt.loganalytics.models.
LinkedStorageAccountsListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.LinkedStorageAccountsResource]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list linked storage accounts service operation response.
- Variables
value (list[LinkedStorageAccountsResource]) – A list of linked storage accounts instances.
- Keyword Arguments
value (list[LinkedStorageAccountsResource]) – A list of linked storage accounts instances.
-
class
azure.mgmt.loganalytics.models.
LinkedStorageAccountsResource
(*, storage_account_ids: Optional[List[str]] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
data_source_type (str or DataSourceType) – Linked storage accounts type. Possible values include: “CustomLogs”, “AzureWatson”, “Query”, “Alerts”.
storage_account_ids (list[str]) – Linked storage accounts resources ids.
- Keyword Arguments
storage_account_ids (list[str]) – Linked storage accounts resources ids.
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPack
(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.loganalytics.models._models_py3.QueryPacksResource
An Log Analytics QueryPack definition.
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
name (str) – Azure resource name.
location (str) – Required. Resource location.
query_pack_id (str) – The unique ID of your application. This field cannot be changed.
time_created (datetime) – Creation Date for the Log Analytics QueryPack, in ISO 8601 format.
time_modified (datetime) – Last modified date of the Log Analytics QueryPack, in ISO 8601 format.
provisioning_state (str) – Current state of this QueryPack: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Succeeded, Deploying, Canceled, and Failed.
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPackListResult
(*, value: List[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPack], next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the list of Log Analytics QueryPack resources.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[LogAnalyticsQueryPack]) – Required. List of Log Analytics QueryPack definitions.
next_link (str) – The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPacks where returned in the result set.
- Keyword Arguments
value (list[LogAnalyticsQueryPack]) – Required. List of Log Analytics QueryPack definitions.
next_link (str) – The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPacks where returned in the result set.
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPackQuery
(*, display_name: Optional[str] = None, description: Optional[str] = None, body: Optional[str] = None, related: Optional[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQueryPropertiesRelated] = None, tags: Optional[Dict[str, List[str]]] = None, properties: Optional[Any] = None, **kwargs)[source]¶ Bases:
azure.mgmt.loganalytics.models._models_py3.AzureResourceProperties
A Log Analytics QueryPack-Query definition.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Azure resource name.
system_data (SystemData) – Read only system data.
id_properties_id (str) – The unique ID of your application. This field cannot be changed.
display_name (str) – Unique display name for your query within the Query Pack.
time_created (datetime) – Creation Date for the Log Analytics Query, in ISO 8601 format.
time_modified (datetime) – Last modified date of the Log Analytics Query, in ISO 8601 format.
author (str) – Object Id of user creating the query.
description (str) – Description of the query.
body (str) – Body of the query.
related (LogAnalyticsQueryPackQueryPropertiesRelated) – The related metadata items for the function.
tags (dict[str, list[str]]) – A set of tags. Tags associated with the query.
properties (any) – Additional properties that can be set for the query.
- Keyword Arguments
display_name (str) – Unique display name for your query within the Query Pack.
description (str) – Description of the query.
body (str) – Body of the query.
related (LogAnalyticsQueryPackQueryPropertiesRelated) – The related metadata items for the function.
tags (dict[str, list[str]]) – A set of tags. Tags associated with the query.
properties (any) – Additional properties that can be set for the query.
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPackQueryListResult
(*, value: List[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuery], next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the list of Log Analytics QueryPack-Query resources.
All required parameters must be populated in order to send to Azure.
- Variables
value (list[LogAnalyticsQueryPackQuery]) – Required. List of Log Analytics QueryPack Query definitions.
next_link (str) – The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPack-Queries where returned in the result set.
- Keyword Arguments
value (list[LogAnalyticsQueryPackQuery]) – Required. List of Log Analytics QueryPack Query definitions.
next_link (str) – The URI to get the next set of Log Analytics QueryPack definitions if too many QueryPack-Queries where returned in the result set.
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPackQueryPropertiesRelated
(*, categories: Optional[List[str]] = None, resource_types: Optional[List[str]] = None, solutions: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The related metadata items for the function.
- Variables
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPackQuerySearchProperties
(*, related: Optional[azure.mgmt.loganalytics.models._models_py3.LogAnalyticsQueryPackQuerySearchPropertiesRelated] = None, tags: Optional[Dict[str, List[str]]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Properties that define an Log Analytics QueryPack-Query search properties.
- Variables
related (LogAnalyticsQueryPackQuerySearchPropertiesRelated) – The related metadata items for the function.
tags (dict[str, list[str]]) – A set of tags. Tags associated with the query.
- Keyword Arguments
related (LogAnalyticsQueryPackQuerySearchPropertiesRelated) – The related metadata items for the function.
tags (dict[str, list[str]]) – A set of tags. Tags associated with the query.
-
class
azure.mgmt.loganalytics.models.
LogAnalyticsQueryPackQuerySearchPropertiesRelated
(*, categories: Optional[List[str]] = None, resource_types: Optional[List[str]] = None, solutions: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The related metadata items for the function.
- Variables
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
ManagementGroup
(*, server_count: Optional[int] = None, is_gateway: Optional[bool] = None, name: Optional[str] = None, id: Optional[str] = None, created: Optional[datetime.datetime] = None, data_received: Optional[datetime.datetime] = None, version: Optional[str] = None, sku: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A management group that is connected to a workspace.
- Variables
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.
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.
- Keyword Arguments
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: Optional[str] = None, localized_value: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The name of a metric.
-
class
azure.mgmt.loganalytics.models.
Operation
(*, name: Optional[str] = None, display: Optional[azure.mgmt.loganalytics.models._models_py3.OperationDisplay] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Supported operation of OperationalInsights resource provider.
- Variables
name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – Display metadata associated with the operation.
- Keyword Arguments
name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – Display metadata associated with the operation.
-
class
azure.mgmt.loganalytics.models.
OperationDisplay
(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Display metadata associated with the operation.
- Variables
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
OperationListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.Operation]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Result of the request to list solution operations.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.loganalytics.models.
OperationStatus
(*, id: Optional[str] = None, name: Optional[str] = None, start_time: Optional[str] = None, end_time: Optional[str] = None, status: Optional[str] = None, error: Optional[azure.mgmt.loganalytics.models._models_py3.ErrorResponse] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The status of operation.
- Variables
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
PrivateLinkScopedResource
(*, resource_id: Optional[str] = None, scope_id: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The private link scope resource reference.
-
class
azure.mgmt.loganalytics.models.
ProvisioningStateEnum
(value)[source]¶ -
Table’s current provisioning state. If set to ‘updating’, indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded.
-
IN_PROGRESS
= 'InProgress'¶ Table schema is stable and without changes, table data is being updated.
-
SUCCEEDED
= 'Succeeded'¶ Table state is stable and without changes, table is unlocked and open for new updates.
-
UPDATING
= 'Updating'¶ Table schema is still being built and updated, table is currently locked for any changes till the procedure is done.
-
-
class
azure.mgmt.loganalytics.models.
ProxyResource
(**kwargs)[source]¶ Bases:
azure.mgmt.loganalytics.models._models_py3.Resource
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.
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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
-
class
azure.mgmt.loganalytics.models.
PublicNetworkAccessType
(value)[source]¶ -
The network access type for operating on the Log Analytics Workspace. By default it is Enabled
-
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.
PurgeState
(value)[source]¶ -
Status of the operation represented by the requested Id.
-
COMPLETED
= 'completed'¶
-
PENDING
= 'pending'¶
-
-
class
azure.mgmt.loganalytics.models.
QueryPacksResource
(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An azure resource object.
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
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
Resource
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Common fields that are returned in the response for all Azure Resource Manager resources.
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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
-
class
azure.mgmt.loganalytics.models.
RestoredLogs
(*, start_restore_time: Optional[datetime.datetime] = None, end_restore_time: Optional[datetime.datetime] = None, source_table: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Restore parameters.
- Variables
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
ResultStatistics
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
Search job execution statistics.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.loganalytics.models.
SavedSearch
(*, category: str, display_name: str, query: str, etag: Optional[str] = None, function_alias: Optional[str] = None, function_parameters: Optional[str] = None, version: Optional[int] = None, tags: Optional[List[azure.mgmt.loganalytics.models._models_py3.Tag]] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
etag (str) – The ETag of the saved search. To override an existing saved search, use “*” or specify the current Etag.
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]) – A set of tags. The tags attached to the saved search.
- Keyword Arguments
etag (str) – The ETag of the saved search. To override an existing saved search, use “*” or specify the current Etag.
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]) – A set of tags. The tags attached to the saved search.
-
class
azure.mgmt.loganalytics.models.
SavedSearchesListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.SavedSearch]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The saved search list operation response.
- Variables
value (list[SavedSearch]) – The array of result values.
- Keyword Arguments
value (list[SavedSearch]) – The array of result values.
-
class
azure.mgmt.loganalytics.models.
Schema
(*, name: Optional[str] = None, display_name: Optional[str] = None, description: Optional[str] = None, columns: Optional[List[azure.mgmt.loganalytics.models._models_py3.Column]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Table’s schema.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
name (str) – Table name.
display_name (str) – Table display name.
description (str) – Table description.
standard_columns (list[Column]) – A list of table standard columns.
source (str or SourceEnum) – Table’s creator. Possible values include: “microsoft”, “customer”.
table_type (str or TableTypeEnum) – Table’s creator. Possible values include: “Microsoft”, “CustomLog”, “RestoredLogs”, “SearchResults”.
table_sub_type (str or TableSubTypeEnum) – The subtype describes what APIs can be used to interact with the table, and what features are available against it. Possible values include: “Any”, “Classic”, “DataCollectionRuleBased”.
solutions (list[str]) – List of solutions the table is affiliated with.
search_results (SearchResults) – Parameters of the search job that initiated this table.
restored_logs (RestoredLogs) – Parameters of the restore operation that initiated this table.
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
SearchGetSchemaResponse
(*, metadata: Optional[azure.mgmt.loganalytics.models._models_py3.SearchMetadata] = None, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.SearchSchemaValue]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The get schema operation response.
- Variables
metadata (SearchMetadata) – The metadata from search results.
value (list[SearchSchemaValue]) – The array of result values.
- Keyword Arguments
metadata (SearchMetadata) – The metadata from search results.
value (list[SearchSchemaValue]) – The array of result values.
-
class
azure.mgmt.loganalytics.models.
SearchMetadata
(*, search_id: Optional[str] = None, result_type: Optional[str] = None, total: Optional[int] = None, top: Optional[int] = None, id: Optional[str] = None, core_summaries: Optional[List[azure.mgmt.loganalytics.models._models_py3.CoreSummary]] = None, status: Optional[str] = None, start_time: Optional[datetime.datetime] = None, last_updated: Optional[datetime.datetime] = None, e_tag: Optional[str] = None, sort: Optional[List[azure.mgmt.loganalytics.models._models_py3.SearchSort]] = None, request_time: Optional[int] = None, aggregated_value_field: Optional[str] = None, aggregated_grouping_fields: Optional[str] = None, sum: Optional[int] = None, max: Optional[int] = None, schema: Optional[azure.mgmt.loganalytics.models._models_py3.SearchMetadataSchema] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Metadata for search results.
- Variables
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.
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.
- Keyword Arguments
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: Optional[str] = None, version: Optional[int] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Schema metadata for search.
-
class
azure.mgmt.loganalytics.models.
SearchResults
(*, query: Optional[str] = None, description: Optional[str] = None, limit: Optional[int] = None, start_search_time: Optional[datetime.datetime] = None, end_search_time: Optional[datetime.datetime] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Parameters of the search job that initiated this table.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
query (str) – Search job query.
description (str) – Search job Description.
limit (int) – Limit the search job to return up to specified number of rows.
start_search_time (datetime) – The timestamp to start the search from (UTC).
end_search_time (datetime) – The timestamp to end the search by (UTC).
source_table (str) – The table used in the search job.
- Keyword Arguments
query (str) – Search job query.
description (str) – Search job Description.
limit (int) – Limit the search job to return up to specified number of rows.
start_search_time (datetime) – The timestamp to start the search from (UTC).
end_search_time (datetime) – The timestamp to end the search by (UTC).
-
class
azure.mgmt.loganalytics.models.
SearchSchemaValue
(*, indexed: bool, stored: bool, facet: bool, name: Optional[str] = None, display_name: Optional[str] = None, type: Optional[str] = None, owner_type: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Value object for schema results.
All required parameters must be populated in order to send to Azure.
- Variables
name (str) – The name of the schema.
display_name (str) – The display name of the schema.
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.
- Keyword Arguments
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: Optional[str] = None, order: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.SearchSortEnum]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The sort parameters for search.
- Variables
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”.
- Keyword Arguments
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.
SearchSortEnum
(value)[source]¶ -
The sort order of the search.
-
ASC
= 'asc'¶
-
DESC
= 'desc'¶
-
Bases:
msrest.serialization.Model
The shared keys for a workspace.
-
class
azure.mgmt.loganalytics.models.
SkuNameEnum
(value)[source]¶ -
The name of the Service Tier.
-
CAPACITY_RESERVATION
= 'CapacityReservation'¶
-
FREE
= 'Free'¶
-
PER_GB2018
= 'PerGB2018'¶
-
PER_NODE
= 'PerNode'¶
-
PREMIUM
= 'Premium'¶
-
STANDALONE
= 'Standalone'¶
-
STANDARD
= 'Standard'¶
-
-
class
azure.mgmt.loganalytics.models.
SourceEnum
(value)[source]¶ -
Table’s creator.
-
CUSTOMER
= 'customer'¶ Tables created by the owner of the Workspace, and only found in this Workspace.
-
MICROSOFT
= 'microsoft'¶ Tables provisioned by the system, as collected via Diagnostic Settings, the Agents, or any other standard data collection means.
-
-
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.
-
class
azure.mgmt.loganalytics.models.
StorageInsight
(*, e_tag: Optional[str] = None, tags: Optional[Dict[str, str]] = None, containers: Optional[List[str]] = None, tables: Optional[List[str]] = None, storage_account: Optional[azure.mgmt.loganalytics.models._models_py3.StorageAccount] = 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.
- 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
e_tag (str) – The ETag of the storage insight.
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) – The storage account connection details.
status (StorageInsightStatus) – The status of the storage insight.
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
StorageInsightListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.StorageInsight]] = None, odata_next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list storage insights operation response.
- Variables
value (list[StorageInsight]) – A list of storage insight items.
odata_next_link (str) – The link (url) to the next page of results.
- Keyword Arguments
value (list[StorageInsight]) – A list of storage insight items.
odata_next_link (str) – The link (url) to the next page of results.
-
class
azure.mgmt.loganalytics.models.
StorageInsightState
(value)[source]¶ -
The state of the storage insight connection to the workspace
-
ERROR
= 'ERROR'¶
-
OK
= 'OK'¶
-
-
class
azure.mgmt.loganalytics.models.
StorageInsightStatus
(*, state: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.StorageInsightState], description: Optional[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.
- Variables
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.
- Keyword Arguments
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.
SystemData
(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.IdentityType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.IdentityType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Read only system data.
- Variables
created_by (str) – An identifier for the identity that created the resource.
created_by_type (str or IdentityType) – The type of identity that created the resource. Possible values include: “user”, “application”, “managedIdentity”, “key”, “SystemAssigned”, “UserAssigned”, “None”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – An identifier for the identity that last modified the resource.
last_modified_by_type (str or IdentityType) – The type of identity that last modified the resource. Possible values include: “user”, “application”, “managedIdentity”, “key”, “SystemAssigned”, “UserAssigned”, “None”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- Keyword Arguments
created_by (str) – An identifier for the identity that created the resource.
created_by_type (str or IdentityType) – The type of identity that created the resource. Possible values include: “user”, “application”, “managedIdentity”, “key”, “SystemAssigned”, “UserAssigned”, “None”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – An identifier for the identity that last modified the resource.
last_modified_by_type (str or IdentityType) – The type of identity that last modified the resource. Possible values include: “user”, “application”, “managedIdentity”, “key”, “SystemAssigned”, “UserAssigned”, “None”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
-
class
azure.mgmt.loganalytics.models.
SystemDataAutoGenerated
(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Metadata pertaining to creation and last modification of the resource.
- Variables
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- Keyword Arguments
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
-
class
azure.mgmt.loganalytics.models.
Table
(*, retention_in_days: Optional[int] = None, total_retention_in_days: Optional[int] = None, search_results: Optional[azure.mgmt.loganalytics.models._models_py3.SearchResults] = None, restored_logs: Optional[azure.mgmt.loganalytics.models._models_py3.RestoredLogs] = None, result_statistics: Optional[azure.mgmt.loganalytics.models._models_py3.ResultStatistics] = None, plan: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.TablePlanEnum]] = None, schema: Optional[azure.mgmt.loganalytics.models._models_py3.Schema] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemDataAutoGenerated) – Metadata pertaining to creation and last modification of the resource.
retention_in_days (int) – The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
total_retention_in_days (int) – The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.
archive_retention_in_days (int) – The table data archive retention in days. Calculated as (totalRetentionInDays-retentionInDays).
search_results (SearchResults) – Parameters of the search job that initiated this table.
restored_logs (RestoredLogs) – Parameters of the restore operation that initiated this table.
result_statistics (ResultStatistics) – Search job execution statistics.
plan (str or TablePlanEnum) – Instruct the system how to handle and charge the logs ingested to this table. Possible values include: “Basic”, “Analytics”.
last_plan_modified_date (str) – The timestamp that table plan was last modified (UTC).
schema (Schema) – Table schema.
provisioning_state (str or ProvisioningStateEnum) – Table’s current provisioning state. If set to ‘updating’, indicates a resource lock due to ongoing operation, forbidding any update to the table until the ongoing operation is concluded. Possible values include: “Updating”, “InProgress”, “Succeeded”.
- Keyword Arguments
retention_in_days (int) – The table retention in days, between 4 and 730. Setting this property to -1 will default to the workspace retention.
total_retention_in_days (int) – The table total retention in days, between 4 and 2555. Setting this property to -1 will default to table retention.
search_results (SearchResults) – Parameters of the search job that initiated this table.
restored_logs (RestoredLogs) – Parameters of the restore operation that initiated this table.
result_statistics (ResultStatistics) – Search job execution statistics.
plan (str or TablePlanEnum) – Instruct the system how to handle and charge the logs ingested to this table. Possible values include: “Basic”, “Analytics”.
schema (Schema) – Table schema.
-
class
azure.mgmt.loganalytics.models.
TablePlanEnum
(value)[source]¶ -
Instruct the system how to handle and charge the logs ingested to this table.
-
ANALYTICS
= 'Analytics'¶ Logs that allow monitoring and analytics.
-
BASIC
= 'Basic'¶ Logs that are adjusted to support high volume low value verbose logs.
-
-
class
azure.mgmt.loganalytics.models.
TableSubTypeEnum
(value)[source]¶ -
The subtype describes what APIs can be used to interact with the table, and what features are available against it.
-
ANY
= 'Any'¶ The default subtype with which built-in tables are created.
-
CLASSIC
= 'Classic'¶ Indicates a table created through the Data Collector API or with the custom logs feature of the MMA agent, or any table against which Custom Fields were created.
-
DATA_COLLECTION_RULE_BASED
= 'DataCollectionRuleBased'¶ A table eligible to have data sent into it via any of the means supported by Data Collection Rules: the Data Collection Endpoint API, ingestion-time transformations, or any other mechanism provided by Data Collection Rules.
-
-
class
azure.mgmt.loganalytics.models.
TableTypeEnum
(value)[source]¶ -
Table’s creator.
-
CUSTOM_LOG
= 'CustomLog'¶ Custom log table.
-
MICROSOFT
= 'Microsoft'¶ Standard data collected by Azure Monitor.
-
RESTORED_LOGS
= 'RestoredLogs'¶ Restored data.
-
SEARCH_RESULTS
= 'SearchResults'¶ Data collected by a search job.
-
-
class
azure.mgmt.loganalytics.models.
TablesListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.Table]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list tables operation response.
-
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.
-
class
azure.mgmt.loganalytics.models.
TagsResource
(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A container holding only the Tags for a resource, allowing the user to update the tags on a QueryPack instance.
-
class
azure.mgmt.loganalytics.models.
TrackedResource
(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.loganalytics.models._models_py3.Resource
The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.
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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
location (str) – Required. The geo-location where the resource lives.
- Keyword Arguments
-
class
azure.mgmt.loganalytics.models.
Type
(value)[source]¶ -
The type of the destination resource
-
EVENT_HUB
= 'EventHub'¶
-
STORAGE_ACCOUNT
= 'StorageAccount'¶
-
-
class
azure.mgmt.loganalytics.models.
UsageMetric
(*, name: Optional[azure.mgmt.loganalytics.models._models_py3.MetricName] = None, unit: Optional[str] = None, current_value: Optional[float] = None, limit: Optional[float] = None, next_reset_time: Optional[datetime.datetime] = None, quota_period: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A metric describing the usage of a resource.
- Variables
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.
- Keyword Arguments
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.
UserIdentityProperties
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
User assigned identity properties.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.loganalytics.models.
Workspace
(*, location: str, tags: Optional[Dict[str, str]] = None, e_tag: Optional[str] = None, sku: Optional[azure.mgmt.loganalytics.models._models_py3.WorkspaceSku] = None, retention_in_days: Optional[int] = None, workspace_capping: Optional[azure.mgmt.loganalytics.models._models_py3.WorkspaceCapping] = None, public_network_access_for_ingestion: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.PublicNetworkAccessType]] = 'Enabled', public_network_access_for_query: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.PublicNetworkAccessType]] = 'Enabled', force_cmk_for_query: Optional[bool] = None, features: Optional[azure.mgmt.loganalytics.models._models_py3.WorkspaceFeatures] = None, default_data_collection_rule_resource_id: Optional[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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
location (str) – Required. The geo-location where the resource lives.
system_data (SystemDataAutoGenerated) – Metadata pertaining to creation and last modification of the resource.
e_tag (str) – The ETag of the workspace.
provisioning_state (str or WorkspaceEntityStatus) – The provisioning state of the workspace. Possible values include: “Creating”, “Succeeded”, “Failed”, “Canceled”, “Deleting”, “ProvisioningAccount”, “Updating”.
customer_id (str) – This is a read-only property. Represents the ID associated with the workspace.
sku (WorkspaceSku) – The SKU of the workspace.
retention_in_days (int) – The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
workspace_capping (WorkspaceCapping) – The daily volume cap for ingestion.
created_date (str) – Workspace creation date.
modified_date (str) – Workspace modification date.
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”.
force_cmk_for_query (bool) – Indicates whether customer managed storage is mandatory for query management.
private_link_scoped_resources (list[PrivateLinkScopedResource]) – List of linked private link scope resources.
features (WorkspaceFeatures) – Workspace features.
default_data_collection_rule_resource_id (str) – The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- Keyword Arguments
location (str) – Required. The geo-location where the resource lives.
e_tag (str) – The ETag of the workspace.
sku (WorkspaceSku) – The SKU of the workspace.
retention_in_days (int) – The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
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”.
force_cmk_for_query (bool) – Indicates whether customer managed storage is mandatory for query management.
features (WorkspaceFeatures) – Workspace features.
default_data_collection_rule_resource_id (str) – The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
-
class
azure.mgmt.loganalytics.models.
WorkspaceCapping
(*, daily_quota_gb: Optional[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.
- Variables
daily_quota_gb (float) – The workspace daily quota for ingestion.
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”.
- Keyword Arguments
daily_quota_gb (float) – The workspace daily quota for ingestion.
-
class
azure.mgmt.loganalytics.models.
WorkspaceEntityStatus
(value)[source]¶ -
The provisioning state of the workspace.
-
CANCELED
= 'Canceled'¶
-
CREATING
= 'Creating'¶
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
PROVISIONING_ACCOUNT
= 'ProvisioningAccount'¶
-
SUCCEEDED
= 'Succeeded'¶
-
UPDATING
= 'Updating'¶
-
-
class
azure.mgmt.loganalytics.models.
WorkspaceFeatures
(*, additional_properties: Optional[Dict[str, Any]] = None, enable_data_export: Optional[bool] = None, immediate_purge_data_on30_days: Optional[bool] = None, enable_log_access_using_only_resource_permissions: Optional[bool] = None, cluster_resource_id: Optional[str] = None, disable_local_auth: Optional[bool] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Workspace features.
- Variables
additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
enable_data_export (bool) – Flag that indicate if data should be exported.
immediate_purge_data_on30_days (bool) – Flag that describes if we want to remove the data after 30 days.
enable_log_access_using_only_resource_permissions (bool) – Flag that indicate which permission to use - resource or workspace or both.
cluster_resource_id (str) – Dedicated LA cluster resourceId that is linked to the workspaces.
disable_local_auth (bool) – Disable Non-AAD based Auth.
- Keyword Arguments
additional_properties (dict[str, any]) – Unmatched properties from the message are deserialized to this collection.
enable_data_export (bool) – Flag that indicate if data should be exported.
immediate_purge_data_on30_days (bool) – Flag that describes if we want to remove the data after 30 days.
enable_log_access_using_only_resource_permissions (bool) – Flag that indicate which permission to use - resource or workspace or both.
cluster_resource_id (str) – Dedicated LA cluster resourceId that is linked to the workspaces.
disable_local_auth (bool) – Disable Non-AAD based Auth.
-
class
azure.mgmt.loganalytics.models.
WorkspaceListManagementGroupsResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.ManagementGroup]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list workspace management groups operation response.
- Variables
value (list[ManagementGroup]) – Gets or sets a list of management groups attached to the workspace.
- Keyword Arguments
value (list[ManagementGroup]) – Gets or sets a list of management groups attached to the workspace.
-
class
azure.mgmt.loganalytics.models.
WorkspaceListResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.Workspace]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list workspaces operation response.
-
class
azure.mgmt.loganalytics.models.
WorkspaceListUsagesResult
(*, value: Optional[List[azure.mgmt.loganalytics.models._models_py3.UsageMetric]] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The list workspace usages operation response.
- Variables
value (list[UsageMetric]) – Gets or sets a list of usage metrics for a workspace.
- Keyword Arguments
value (list[UsageMetric]) – Gets or sets a list of usage metrics for a workspace.
-
class
azure.mgmt.loganalytics.models.
WorkspacePatch
(*, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.loganalytics.models._models_py3.WorkspaceSku] = None, retention_in_days: Optional[int] = None, workspace_capping: Optional[azure.mgmt.loganalytics.models._models_py3.WorkspaceCapping] = None, public_network_access_for_ingestion: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.PublicNetworkAccessType]] = 'Enabled', public_network_access_for_query: Optional[Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.PublicNetworkAccessType]] = 'Enabled', force_cmk_for_query: Optional[bool] = None, features: Optional[azure.mgmt.loganalytics.models._models_py3.WorkspaceFeatures] = None, default_data_collection_rule_resource_id: Optional[str] = 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. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
etag (str) – Resource Etag.
tags (dict[str, str]) – A set of tags. Resource tags. Optional.
provisioning_state (str or WorkspaceEntityStatus) – The provisioning state of the workspace. Possible values include: “Creating”, “Succeeded”, “Failed”, “Canceled”, “Deleting”, “ProvisioningAccount”, “Updating”.
customer_id (str) – This is a read-only property. Represents the ID associated with the workspace.
sku (WorkspaceSku) – The SKU of the workspace.
retention_in_days (int) – The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
workspace_capping (WorkspaceCapping) – The daily volume cap for ingestion.
created_date (str) – Workspace creation date.
modified_date (str) – Workspace modification date.
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”.
force_cmk_for_query (bool) – Indicates whether customer managed storage is mandatory for query management.
private_link_scoped_resources (list[PrivateLinkScopedResource]) – List of linked private link scope resources.
features (WorkspaceFeatures) – Workspace features.
default_data_collection_rule_resource_id (str) – The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
- Keyword Arguments
tags (dict[str, str]) – A set of tags. Resource tags. Optional.
sku (WorkspaceSku) – The SKU of the workspace.
retention_in_days (int) – The workspace data retention in days. Allowed values are per pricing plan. See pricing tiers documentation for details.
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”.
force_cmk_for_query (bool) – Indicates whether customer managed storage is mandatory for query management.
features (WorkspaceFeatures) – Workspace features.
default_data_collection_rule_resource_id (str) – The resource ID of the default Data Collection Rule to use for this workspace. Expected format is - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dcrName}.
-
class
azure.mgmt.loganalytics.models.
WorkspacePurgeBody
(*, table: str, filters: List[azure.mgmt.loganalytics.models._models_py3.WorkspacePurgeBodyFilters], **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.
- Variables
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.
- Keyword Arguments
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: Optional[str] = None, operator: Optional[str] = None, value: Optional[Any] = None, key: Optional[str] = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
User-defined filters to return data which will be purged from the table.
- Variables
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 (any) – 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.
- Keyword Arguments
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 (any) – 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.
-
class
azure.mgmt.loganalytics.models.
WorkspacePurgeStatusResponse
(*, status: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.PurgeState], **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.
- Variables
status (str or PurgeState) – Required. Status of the operation represented by the requested Id. Possible values include: “pending”, “completed”.
- Keyword Arguments
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: Union[str, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.WorkspaceSkuNameEnum], capacity_reservation_level: Optional[Union[int, azure.mgmt.loganalytics.models._log_analytics_management_client_enums.CapacityReservationLevel]] = 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.
- Variables
name (str or WorkspaceSkuNameEnum) – Required. The name of the SKU. Possible values include: “Free”, “Standard”, “Premium”, “PerNode”, “PerGB2018”, “Standalone”, “CapacityReservation”, “LACluster”.
capacity_reservation_level (int or CapacityReservationLevel) – The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. Possible values include: 100, 200, 300, 400, 500, 1000, 2000, 5000.
last_sku_update (str) – The last time when the sku was updated.
- Keyword Arguments
name (str or WorkspaceSkuNameEnum) – Required. The name of the SKU. Possible values include: “Free”, “Standard”, “Premium”, “PerNode”, “PerGB2018”, “Standalone”, “CapacityReservation”, “LACluster”.
capacity_reservation_level (int or CapacityReservationLevel) – The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. Possible values include: 100, 200, 300, 400, 500, 1000, 2000, 5000.
-
class
azure.mgmt.loganalytics.models.
WorkspaceSkuNameEnum
(value)[source]¶ -
The name of the SKU.
-
CAPACITY_RESERVATION
= 'CapacityReservation'¶
-
FREE
= 'Free'¶
-
LA_CLUSTER
= 'LACluster'¶
-
PER_GB2018
= 'PerGB2018'¶
-
PER_NODE
= 'PerNode'¶
-
PREMIUM
= 'Premium'¶
-
STANDALONE
= 'Standalone'¶
-
STANDARD
= 'Standard'¶
-