azure.mgmt.applicationinsights.v2015_05_01.models module

class azure.mgmt.applicationinsights.v2015_05_01.models.APIKeyRequest(*, name: str | None = None, linked_read_properties: List[str] | None = None, linked_write_properties: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

An Application Insights component API Key creation request definition.

Variables:

name (str) – The name of the API Key.
linked_read_properties (list[str]) – The read access rights of this API Key.
linked_write_properties (list[str]) – The write access rights of this API Key.

Keyword Arguments:

name (str) – The name of the API Key.
linked_read_properties (list[str]) – The read access rights of this API Key.
linked_write_properties (list[str]) – The write access rights of this API Key.

class azure.mgmt.applicationinsights.v2015_05_01.models.Annotation(*, annotation_name: str | None = None, category: str | None = None, event_time: datetime | None = None, id: str | None = None, properties: str | None = None, related_annotation: str = 'null', **kwargs: Any)[source]

Bases: Model

Annotation associated with an application insights resource.

Variables:

annotation_name (str) – Name of annotation.
category (str) – Category of annotation, free form.
event_time (datetime) – Time when event occurred.
id (str) – Unique Id for annotation.
properties (str) – Serialized JSON object for detailed properties.
related_annotation (str) – Related parent annotation if any.

Keyword Arguments:

annotation_name (str) – Name of annotation.
category (str) – Category of annotation, free form.
event_time (datetime) – Time when event occurred.
id (str) – Unique Id for annotation.
properties (str) – Serialized JSON object for detailed properties.
related_annotation (str) – Related parent annotation if any.

class azure.mgmt.applicationinsights.v2015_05_01.models.AnnotationError(*, code: str | None = None, message: str | None = None, innererror: _models.InnerError | None = None, **kwargs: Any)[source]

Bases: Model

Error associated with trying to create annotation with Id that already exist.

Variables:

code (str) – Error detail code and explanation.
message (str) – Error message.
innererror (InnerError) – Inner error.

Keyword Arguments:

code (str) – Error detail code and explanation.
message (str) – Error message.
innererror (InnerError) – Inner error.

class azure.mgmt.applicationinsights.v2015_05_01.models.AnnotationsListResult(**kwargs: Any)[source]

Bases: Model

Annotations list result.

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

Variables:: value (list[Annotation]) – An array of annotations.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponent(*, location: str, kind: str, tags: Dict[str, str] | None = None, application_type: str | _models.ApplicationType = 'web', flow_type: str | _models.FlowType = 'Bluefield', request_source: str | _models.RequestSource = 'rest', hockey_app_id: str | None = None, sampling_percentage: float | None = None, retention_in_days: int = 90, disable_ip_masking: bool | None = None, immediate_purge_data_on30_days: bool | None = None, ingestion_mode: str | _models.IngestionMode = 'ApplicationInsights', **kwargs: Any)[source]

Bases: ComponentsResource

An Application Insights component 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 server.

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
kind (str) – The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone. Required.
application_id (str) – The unique ID of your application. This field mirrors the ‘Name’ field and cannot be changed.
app_id (str) – Application Insights Unique ID for your Application.
application_type (str or ApplicationType) – Type of application being monitored. Known values are: “web” and “other”.
flow_type (str or FlowType) – Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API. “Bluefield”
request_source (str or RequestSource) – Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’. “rest”
instrumentation_key (str) – Application Insights Instrumentation key. A read-only value that applications can use to identify the destination for all telemetry sent to Azure Application Insights. This value will be supplied upon construction of each new Application Insights component.
creation_date (datetime) – Creation Date for the Application Insights component, in ISO 8601 format.
tenant_id (str) – Azure Tenant Id.
hockey_app_id (str) – The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
hockey_app_token (str) – Token used to authenticate communications with between Application Insights and HockeyApp.
provisioning_state (str) – Current state of this component: 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.
sampling_percentage (float) – Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
connection_string (str) – Application Insights component connection string.
retention_in_days (int) – Retention period in days.
disable_ip_masking (bool) – Disable IP masking.
immediate_purge_data_on30_days (bool) – Purge data immediately after 30 days.
private_link_scoped_resources (list[PrivateLinkScopedResource]) – List of linked private link scope resources.
ingestion_mode (str or IngestionMode) – Indicates the flow of the ingestion. Known values are: “ApplicationInsights”, “ApplicationInsightsWithDiagnosticSettings”, and “LogAnalytics”.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
kind (str) – The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: web, ios, other, store, java, phone. Required.
application_type (str or ApplicationType) – Type of application being monitored. Known values are: “web” and “other”.
flow_type (str or FlowType) – Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API. “Bluefield”
request_source (str or RequestSource) – Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’. “rest”
hockey_app_id (str) – The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
sampling_percentage (float) – Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
retention_in_days (int) – Retention period in days.
disable_ip_masking (bool) – Disable IP masking.
immediate_purge_data_on30_days (bool) – Purge data immediately after 30 days.
ingestion_mode (str or IngestionMode) – Indicates the flow of the ingestion. Known values are: “ApplicationInsights”, “ApplicationInsightsWithDiagnosticSettings”, and “LogAnalytics”.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentAPIKey(*, created_date: str | None = None, name: str | None = None, linked_read_properties: List[str] | None = None, linked_write_properties: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

Properties that define an API key of an Application Insights Component.

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

Variables:

id (str) – The unique ID of the API key inside an Application Insights component. It is auto generated when the API key is created.
api_key (str) – The API key value. It will be only return once when the API Key was created.
created_date (str) – The create date of this API key.
name (str) – The name of the API key.
linked_read_properties (list[str]) – The read access rights of this API Key.
linked_write_properties (list[str]) – The write access rights of this API Key.

Keyword Arguments:

created_date (str) – The create date of this API key.
name (str) – The name of the API key.
linked_read_properties (list[str]) – The read access rights of this API Key.
linked_write_properties (list[str]) – The write access rights of this API Key.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentAPIKeyListResult(*, value: List[_models.ApplicationInsightsComponentAPIKey], **kwargs: Any)[source]

Bases: Model

Describes the list of API Keys of an Application Insights Component.

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

Variables:: value (list[ApplicationInsightsComponentAPIKey]) – List of API Key definitions. Required.
Keyword Arguments:: value (list[ApplicationInsightsComponentAPIKey]) – List of API Key definitions. Required.

Bases: Model

Properties that define an Analytics item that is associated to an Application Insights component.

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

Variables:

id (str) – Internally assigned unique id of the item definition.
name (str) – The user-defined name of the item.
content (str) – The content of this item.
version (str) – This instance’s version of the data model. This can change as new features are added.
scope (str or ItemScope) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “shared” and “user”.
type (str or ItemType) – Enum indicating the type of the Analytics item. Known values are: “none”, “query”, “recent”, and “function”.
time_created (str) – Date and time in UTC when this item was created.
time_modified (str) – Date and time in UTC of the last modification that was made to this item.
properties (ApplicationInsightsComponentAnalyticsItemProperties) – A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.

Keyword Arguments:

id (str) – Internally assigned unique id of the item definition.
name (str) – The user-defined name of the item.
content (str) – The content of this item.
scope (str or ItemScope) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “shared” and “user”.
type (str or ItemType) – Enum indicating the type of the Analytics item. Known values are: “none”, “query”, “recent”, and “function”.
properties (ApplicationInsightsComponentAnalyticsItemProperties) – A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentAnalyticsItemProperties(*, function_alias: str | None = None, **kwargs: Any)[source]

Bases: Model

A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.

Variables:: function_alias (str) – A function alias, used when the type of the item is Function.
Keyword Arguments:: function_alias (str) – A function alias, used when the type of the item is Function.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentAvailableFeatures(**kwargs: Any)[source]

Bases: Model

An Application Insights component available features.

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

Variables:: result (list[ApplicationInsightsComponentFeature]) – A list of Application Insights component feature.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentBillingFeatures(*, data_volume_cap: _models.ApplicationInsightsComponentDataVolumeCap | None = None, current_billing_features: List[str] | None = None, **kwargs: Any)[source]

Bases: Model

An Application Insights component billing features.

Variables:

data_volume_cap (ApplicationInsightsComponentDataVolumeCap) – An Application Insights component daily data volume cap.
current_billing_features (list[str]) – Current enabled pricing plan. When the component is in the Enterprise plan, this will list both ‘Basic’ and ‘Application Insights Enterprise’.

Keyword Arguments:

data_volume_cap (ApplicationInsightsComponentDataVolumeCap) – An Application Insights component daily data volume cap.
current_billing_features (list[str]) – Current enabled pricing plan. When the component is in the Enterprise plan, this will list both ‘Basic’ and ‘Application Insights Enterprise’.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentDataVolumeCap(*, cap: float | None = None, warning_threshold: int | None = None, stop_send_notification_when_hit_threshold: bool | None = None, stop_send_notification_when_hit_cap: bool | None = None, **kwargs: Any)[source]

Bases: Model

An Application Insights component daily data volume cap.

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

Variables:

cap (float) – Daily data volume cap in GB.
reset_time (int) – Daily data volume cap UTC reset hour.
warning_threshold (int) – Reserved, not used for now.
stop_send_notification_when_hit_threshold (bool) – Reserved, not used for now.
stop_send_notification_when_hit_cap (bool) – Do not send a notification email when the daily data volume cap is met.
max_history_cap (float) – Maximum daily data volume cap that the user can set for this component.

Keyword Arguments:

cap (float) – Daily data volume cap in GB.
warning_threshold (int) – Reserved, not used for now.
stop_send_notification_when_hit_threshold (bool) – Reserved, not used for now.
stop_send_notification_when_hit_cap (bool) – Do not send a notification email when the daily data volume cap is met.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentExportConfiguration(*, record_types: str | None = None, notification_queue_enabled: str | None = None, **kwargs: Any)[source]

Bases: Model

Properties that define a Continuous Export configuration.

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

Variables:

export_id (str) – The unique ID of the export configuration inside an Application Insights component. It is auto generated when the Continuous Export configuration is created.
instrumentation_key (str) – The instrumentation key of the Application Insights component.
record_types (str) – This comma separated list of document types that will be exported. The possible values include ‘Requests’, ‘Event’, ‘Exceptions’, ‘Metrics’, ‘PageViews’, ‘PageViewPerformance’, ‘Rdd’, ‘PerformanceCounters’, ‘Availability’, ‘Messages’.
application_name (str) – The name of the Application Insights component.
subscription_id (str) – The subscription of the Application Insights component.
resource_group (str) – The resource group of the Application Insights component.
destination_storage_subscription_id (str) – The destination storage account subscription ID.
destination_storage_location_id (str) – The destination account location ID.
destination_account_id (str) – The name of destination account.
destination_type (str) – The destination type.
is_user_enabled (str) – This will be ‘true’ if the Continuous Export configuration is enabled, otherwise it will be ‘false’.
last_user_update (str) – Last time the Continuous Export configuration was updated.
notification_queue_enabled (str) – Deprecated.
export_status (str) – This indicates current Continuous Export configuration status. The possible values are ‘Preparing’, ‘Success’, ‘Failure’.
last_success_time (str) – The last time data was successfully delivered to the destination storage container for this Continuous Export configuration.
last_gap_time (str) – The last time the Continuous Export configuration started failing.
permanent_error_reason (str) – This is the reason the Continuous Export configuration started failing. It can be ‘AzureStorageNotFound’ or ‘AzureStorageAccessDenied’.
storage_name (str) – The name of the destination storage account.
container_name (str) – The name of the destination storage container.

Keyword Arguments:

record_types (str) – This comma separated list of document types that will be exported. The possible values include ‘Requests’, ‘Event’, ‘Exceptions’, ‘Metrics’, ‘PageViews’, ‘PageViewPerformance’, ‘Rdd’, ‘PerformanceCounters’, ‘Availability’, ‘Messages’.
notification_queue_enabled (str) – Deprecated.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentExportRequest(*, record_types: str | None = None, destination_type: str | None = None, destination_address: str | None = None, is_enabled: str | None = None, notification_queue_enabled: str | None = None, notification_queue_uri: str | None = None, destination_storage_subscription_id: str | None = None, destination_storage_location_id: str | None = None, destination_account_id: str | None = None, **kwargs: Any)[source]

Bases: Model

An Application Insights component Continuous Export configuration request definition.

Variables:

record_types (str) – The document types to be exported, as comma separated values. Allowed values include ‘Requests’, ‘Event’, ‘Exceptions’, ‘Metrics’, ‘PageViews’, ‘PageViewPerformance’, ‘Rdd’, ‘PerformanceCounters’, ‘Availability’, ‘Messages’.
destination_type (str) – The Continuous Export destination type. This has to be ‘Blob’.
destination_address (str) – The SAS URL for the destination storage container. It must grant write permission.
is_enabled (str) – Set to ‘true’ to create a Continuous Export configuration as enabled, otherwise set it to ‘false’.
notification_queue_enabled (str) – Deprecated.
notification_queue_uri (str) – Deprecated.
destination_storage_subscription_id (str) – The subscription ID of the destination storage container.
destination_storage_location_id (str) – The location ID of the destination storage container.
destination_account_id (str) – The name of destination storage account.

Keyword Arguments:

record_types (str) – The document types to be exported, as comma separated values. Allowed values include ‘Requests’, ‘Event’, ‘Exceptions’, ‘Metrics’, ‘PageViews’, ‘PageViewPerformance’, ‘Rdd’, ‘PerformanceCounters’, ‘Availability’, ‘Messages’.
destination_type (str) – The Continuous Export destination type. This has to be ‘Blob’.
destination_address (str) – The SAS URL for the destination storage container. It must grant write permission.
is_enabled (str) – Set to ‘true’ to create a Continuous Export configuration as enabled, otherwise set it to ‘false’.
notification_queue_enabled (str) – Deprecated.
notification_queue_uri (str) – Deprecated.
destination_storage_subscription_id (str) – The subscription ID of the destination storage container.
destination_storage_location_id (str) – The location ID of the destination storage container.
destination_account_id (str) – The name of destination storage account.

Bases: Model

Properties that define a favorite that is associated to an Application Insights component.

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

Variables:

name (str) – The user-defined name of the favorite.
config (str) – Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON.
version (str) – This instance’s version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.
favorite_id (str) – Internally assigned unique id of the favorite definition.
favorite_type (str or FavoriteType) – Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “shared” and “user”.
source_type (str) – The source of the favorite definition.
time_modified (str) – Date and time in UTC of the last modification that was made to this favorite definition.
tags (list[str]) – A list of 0 or more tags that are associated with this favorite definition.
category (str) – Favorite category, as defined by the user at creation time.
is_generated_from_template (bool) – Flag denoting wether or not this favorite was generated from a template.
user_id (str) – Unique user id of the specific user that owns this favorite.

Keyword Arguments:

name (str) – The user-defined name of the favorite.
config (str) – Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON.
version (str) – This instance’s version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.
favorite_type (str or FavoriteType) – Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “shared” and “user”.
source_type (str) – The source of the favorite definition.
tags (list[str]) – A list of 0 or more tags that are associated with this favorite definition.
category (str) – Favorite category, as defined by the user at creation time.
is_generated_from_template (bool) – Flag denoting wether or not this favorite was generated from a template.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentFeature(**kwargs: Any)[source]

Bases: Model

An Application Insights component daily data volume cap status.

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

Variables:

feature_name (str) – The pricing feature name.
meter_id (str) – The meter id used for the feature.
meter_rate_frequency (str) – The meter rate for the feature’s meter.
resouce_id (str) – Reserved, not used now.
is_hidden (bool) – Reserved, not used now.
capabilities (list[ApplicationInsightsComponentFeatureCapability]) – A list of Application Insights component feature capability.
title (str) – Display name of the feature.
is_main_feature (bool) – Whether can apply addon feature on to it.
supported_addon_features (str) – The add on features on main feature.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentFeatureCapabilities(**kwargs: Any)[source]

Bases: Model

An Application Insights component feature capabilities.

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

Variables:

support_export_data (bool) – Whether allow to use continuous export feature.
burst_throttle_policy (str) – Reserved, not used now.
metadata_class (str) – Reserved, not used now.
live_stream_metrics (bool) – Reserved, not used now.
application_map (bool) – Reserved, not used now.
work_item_integration (bool) – Whether allow to use work item integration feature.
power_bi_integration (bool) – Reserved, not used now.
open_schema (bool) – Reserved, not used now.
proactive_detection (bool) – Reserved, not used now.
analytics_integration (bool) – Reserved, not used now.
multiple_step_web_test (bool) – Whether allow to use multiple steps web test feature.
api_access_level (str) – Reserved, not used now.
tracking_type (str) – The application insights component used tracking type.
daily_cap (float) – Daily data volume cap in GB.
daily_cap_reset_time (float) – Daily data volume cap UTC reset hour.
throttle_rate (float) – Reserved, not used now.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentFeatureCapability(**kwargs: Any)[source]

Bases: Model

An Application Insights component feature capability.

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

Variables:

name (str) – The name of the capability.
description (str) – The description of the capability.
value (str) – The value of the capability.
unit (str) – The unit of the capability.
meter_id (str) – The meter used for the capability.
meter_rate_frequency (str) – The meter rate of the meter.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentListResult(*, value: List[_models.ApplicationInsightsComponent], next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Describes the list of Application Insights Resources.

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

Variables:

value (list[ApplicationInsightsComponent]) – List of Application Insights component definitions. Required.
next_link (str) – The URI to get the next set of Application Insights component definitions if too many components where returned in the result set.

Keyword Arguments:

value (list[ApplicationInsightsComponent]) – List of Application Insights component definitions. Required.
next_link (str) – The URI to get the next set of Application Insights component definitions if too many components where returned in the result set.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentProactiveDetectionConfiguration(*, name: str | None = None, enabled: bool | None = None, send_emails_to_subscription_owners: bool | None = None, custom_emails: List[str] | None = None, last_updated_time: str | None = None, rule_definitions: _models.ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions | None = None, **kwargs: Any)[source]

Bases: Model

Properties that define a ProactiveDetection configuration.

Variables:

name (str) – The rule name.
enabled (bool) – A flag that indicates whether this rule is enabled by the user.
send_emails_to_subscription_owners (bool) – A flag that indicated whether notifications on this rule should be sent to subscription owners.
custom_emails (list[str]) – Custom email addresses for this rule notifications.
last_updated_time (str) – The last time this rule was updated.
rule_definitions (ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions # pylint: disable=line-too-long) – Static definitions of the ProactiveDetection configuration rule (same values for all components).

Keyword Arguments:

name (str) – The rule name.
enabled (bool) – A flag that indicates whether this rule is enabled by the user.
send_emails_to_subscription_owners (bool) – A flag that indicated whether notifications on this rule should be sent to subscription owners.
custom_emails (list[str]) – Custom email addresses for this rule notifications.
last_updated_time (str) – The last time this rule was updated.
rule_definitions (ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions # pylint: disable=line-too-long) – Static definitions of the ProactiveDetection configuration rule (same values for all components).

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions(*, name: str | None = None, display_name: str | None = None, description: str | None = None, help_url: str | None = None, is_hidden: bool | None = None, is_enabled_by_default: bool | None = None, is_in_preview: bool | None = None, supports_email_notifications: bool | None = None, **kwargs: Any)[source]

Bases: Model

Static definitions of the ProactiveDetection configuration rule (same values for all components).

Variables:

name (str) – The rule name.
display_name (str) – The rule name as it is displayed in UI.
description (str) – The rule description.
help_url (str) – URL which displays additional info about the proactive detection rule.
is_hidden (bool) – A flag indicating whether the rule is hidden (from the UI).
is_enabled_by_default (bool) – A flag indicating whether the rule is enabled by default.
is_in_preview (bool) – A flag indicating whether the rule is in preview.
supports_email_notifications (bool) – A flag indicating whether email notifications are supported for detections for this rule.

Keyword Arguments:

name (str) – The rule name.
display_name (str) – The rule name as it is displayed in UI.
description (str) – The rule description.
help_url (str) – URL which displays additional info about the proactive detection rule.
is_hidden (bool) – A flag indicating whether the rule is hidden (from the UI).
is_enabled_by_default (bool) – A flag indicating whether the rule is enabled by default.
is_in_preview (bool) – A flag indicating whether the rule is in preview.
supports_email_notifications (bool) – A flag indicating whether email notifications are supported for detections for this rule.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentQuotaStatus(**kwargs: Any)[source]

Bases: Model

An Application Insights component daily data volume cap status.

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

Variables:

app_id (str) – The Application ID for the Application Insights component.
should_be_throttled (bool) – The daily data volume cap is met, and data ingestion will be stopped.
expiration_time (str) – Date and time when the daily data volume cap will be reset, and data ingestion will resume.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsComponentWebTestLocation(**kwargs: Any)[source]

Bases: Model

Properties that define a web test location available to an Application Insights Component.

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

Variables:

display_name (str) – The display name of the web test location.
tag (str) – Internally defined geographic location tag.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationInsightsWebTestLocationsListResult(*, value: List[_models.ApplicationInsightsComponentWebTestLocation], **kwargs: Any)[source]

Bases: Model

Describes the list of web test locations available to an Application Insights Component.

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

Variables:: value (list[ApplicationInsightsComponentWebTestLocation]) – List of web test locations. Required.
Keyword Arguments:: value (list[ApplicationInsightsComponentWebTestLocation]) – List of web test locations. Required.

class azure.mgmt.applicationinsights.v2015_05_01.models.ApplicationType(*values)[source]

Bases: str, Enum

Type of application being monitored.

OTHER = 'other'

WEB = 'web'

class azure.mgmt.applicationinsights.v2015_05_01.models.CategoryType(*values)[source]

Bases: str, Enum

CategoryType.

PERFORMANCE = 'performance'

RETENTION = 'retention'

TSG = 'TSG'

WORKBOOK = 'workbook'

class azure.mgmt.applicationinsights.v2015_05_01.models.ComponentPurgeBody(*, table: str, filters: List[_models.ComponentPurgeBodyFilters], **kwargs: Any)[source]

Bases: Model

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

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

Variables:

table (str) – Table from which to purge data. Required.
filters (list[ComponentPurgeBodyFilters]) – The set of columns and filters (queries) to run over them to purge the resulting data. Required.

Keyword Arguments:

table (str) – Table from which to purge data. Required.
filters (list[ComponentPurgeBodyFilters]) – The set of columns and filters (queries) to run over them to purge the resulting data. Required.

class azure.mgmt.applicationinsights.v2015_05_01.models.ComponentPurgeBodyFilters(*, column: str | None = None, operator: str | None = None, value: Any | None = None, key: str | None = None, **kwargs: Any)[source]

Bases: 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.applicationinsights.v2015_05_01.models.ComponentPurgeResponse(*, operation_id: str, **kwargs: Any)[source]

Bases: Model

Response containing operationId for a specific purge action.

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

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

class azure.mgmt.applicationinsights.v2015_05_01.models.ComponentPurgeStatusResponse(*, status: str | _models.PurgeState, **kwargs: Any)[source]

Bases: Model

Response containing status for a specific purge operation.

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

Variables:: status (str or PurgeState) – Status of the operation represented by the requested Id. Required. Known values are: “pending” and “completed”.
Keyword Arguments:: status (str or PurgeState) – Status of the operation represented by the requested Id. Required. Known values are: “pending” and “completed”.

class azure.mgmt.applicationinsights.v2015_05_01.models.ComponentsResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: 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 server.

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.applicationinsights.v2015_05_01.models.ErrorFieldContract(*, code: str | None = None, message: str | None = None, target: str | None = None, **kwargs: Any)[source]

Bases: Model

Error Field contract.

Variables:

code (str) – Property level error code.
message (str) – Human-readable representation of property-level error.
target (str) – Property name.

Keyword Arguments:

code (str) – Property level error code.
message (str) – Human-readable representation of property-level error.
target (str) – Property name.

class azure.mgmt.applicationinsights.v2015_05_01.models.ErrorResponse(*, code: str | None = None, message: str | None = None, **kwargs: Any)[source]

Bases: Model

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

Variables:

code (str) – Error code.
message (str) – Error message indicating why the operation failed.

Keyword Arguments:

code (str) – Error code.
message (str) – Error message indicating why the operation failed.

class azure.mgmt.applicationinsights.v2015_05_01.models.FavoriteSourceType(*values)[source]

Bases: str, Enum

FavoriteSourceType.

EVENTS = 'events'

FUNNEL = 'funnel'

IMPACT = 'impact'

NOTEBOOK = 'notebook'

RETENTION = 'retention'

SEGMENTATION = 'segmentation'

SESSIONS = 'sessions'

USERFLOWS = 'userflows'

class azure.mgmt.applicationinsights.v2015_05_01.models.FavoriteType(*values)[source]

Bases: str, Enum

Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.

SHARED = 'shared'

USER = 'user'

class azure.mgmt.applicationinsights.v2015_05_01.models.FlowType(*values)[source]

Bases: str, Enum

Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to ‘Bluefield’ when creating/updating a component via the REST API.

BLUEFIELD = 'Bluefield'

class azure.mgmt.applicationinsights.v2015_05_01.models.IngestionMode(*values)[source]

Bases: str, Enum

Indicates the flow of the ingestion.

APPLICATION_INSIGHTS = 'ApplicationInsights'

APPLICATION_INSIGHTS_WITH_DIAGNOSTIC_SETTINGS = 'ApplicationInsightsWithDiagnosticSettings'

LOG_ANALYTICS = 'LogAnalytics'

class azure.mgmt.applicationinsights.v2015_05_01.models.InnerError(*, diagnosticcontext: str | None = None, time: datetime | None = None, **kwargs: Any)[source]

Bases: Model

Inner error.

Variables:

diagnosticcontext (str) – Provides correlation for request.
time (datetime) – Request time.

Keyword Arguments:

diagnosticcontext (str) – Provides correlation for request.
time (datetime) – Request time.

class azure.mgmt.applicationinsights.v2015_05_01.models.ItemScope(*values)[source]

Bases: str, Enum

Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.

SHARED = 'shared'

USER = 'user'

class azure.mgmt.applicationinsights.v2015_05_01.models.ItemScopePath(*values)[source]

Bases: str, Enum

ItemScopePath.

ANALYTICS_ITEMS = 'analyticsItems'

MYANALYTICS_ITEMS = 'myanalyticsItems'

class azure.mgmt.applicationinsights.v2015_05_01.models.ItemType(*values)[source]

Bases: str, Enum

Enum indicating the type of the Analytics item.

FUNCTION = 'function'

NONE = 'none'

QUERY = 'query'

RECENT = 'recent'

class azure.mgmt.applicationinsights.v2015_05_01.models.ItemTypeParameter(*values)[source]

Bases: str, Enum

ItemTypeParameter.

FOLDER = 'folder'

FUNCTION = 'function'

NONE = 'none'

QUERY = 'query'

RECENT = 'recent'

class azure.mgmt.applicationinsights.v2015_05_01.models.LinkProperties(*, source_id: str | None = None, target_id: str | None = None, category: str | None = None, **kwargs: Any)[source]

Bases: Model

Contains a sourceId and workbook resource id to link two resources.

Variables:

source_id (str) – The source Azure resource id.
target_id (str) – The workbook Azure resource id.
category (str) – The category of workbook.

Keyword Arguments:

source_id (str) – The source Azure resource id.
target_id (str) – The workbook Azure resource id.
category (str) – The category of workbook.

Bases: MyWorkbookResource

An Application Insights private workbook definition.

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

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
kind (str or SharedTypeKind) – The kind of workbook. Choices are user and shared. Known values are: “user” and “shared”.
display_name (str) – The user-defined name of the private workbook.
serialized_data (str) – Configuration of this particular private workbook. Configuration data is a string containing valid JSON.
version (str) – This instance’s version of the data model. This can change as new features are added that can be marked private workbook.
time_modified (str) – Date and time in UTC of the last modification that was made to this private workbook definition.
category (str) – Workbook category, as defined by the user at creation time.
tags_properties_tags (list[str]) – A list of 0 or more tags that are associated with this private workbook definition.
user_id (str) – Unique user id of the specific user that owns this private workbook.
source_id (str) – Optional resourceId for a source resource.

Keyword Arguments:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
kind (str or SharedTypeKind) – The kind of workbook. Choices are user and shared. Known values are: “user” and “shared”.
display_name (str) – The user-defined name of the private workbook.
serialized_data (str) – Configuration of this particular private workbook. Configuration data is a string containing valid JSON.
version (str) – This instance’s version of the data model. This can change as new features are added that can be marked private workbook.
category (str) – Workbook category, as defined by the user at creation time.
tags_properties_tags (list[str]) – A list of 0 or more tags that are associated with this private workbook definition.
source_id (str) – Optional resourceId for a source resource.

class azure.mgmt.applicationinsights.v2015_05_01.models.MyWorkbookError(*, code: str | None = None, message: str | None = None, details: List[_models.ErrorFieldContract] | None = None, **kwargs: Any)[source]

Bases: Model

Error message body that will indicate why the operation failed.

Variables:

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

Keyword Arguments:

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

Bases: Model

An azure resource object.

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.applicationinsights.v2015_05_01.models.MyWorkbooksListResult(**kwargs: Any)[source]

Bases: Model

Workbook list result.

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

Variables:: value (list[MyWorkbook]) – An array of private workbooks.

class azure.mgmt.applicationinsights.v2015_05_01.models.Operation(*, name: str | None = None, display: _models.OperationDisplay | None = None, **kwargs: Any)[source]

Bases: Model

CDN REST API operation.

Variables:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

Keyword Arguments:

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.applicationinsights.v2015_05_01.models.OperationDisplay(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, **kwargs: Any)[source]

Bases: Model

The object that represents the operation.

Variables:

provider (str) – Service provider: Microsoft.Cdn.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.

Keyword Arguments:

provider (str) – Service provider: Microsoft.Cdn.
resource (str) – Resource on which the operation is performed: Profile, endpoint, etc.
operation (str) – Operation type: Read, write, delete, etc.

class azure.mgmt.applicationinsights.v2015_05_01.models.OperationListResult(*, value: List[_models.Operation] | None = None, next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

Result of the request to list CDN operations. It contains a list of operations and a URL link to get the next set of results.

Variables:

value (list[Operation]) – List of CDN operations supported by the CDN resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

Keyword Arguments:

value (list[Operation]) – List of CDN operations supported by the CDN resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.applicationinsights.v2015_05_01.models.PrivateLinkScopedResource(*, resource_id: str | None = None, scope_id: str | None = None, **kwargs: Any)[source]

Bases: Model

The private link scope resource reference.

Variables:

resource_id (str) – The full resource Id of the private link scope resource.
scope_id (str) – The private link scope unique Identifier.

Keyword Arguments:

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.applicationinsights.v2015_05_01.models.PurgeState(*values)[source]

Bases: str, Enum

Status of the operation represented by the requested Id.

COMPLETED = 'completed'

PENDING = 'pending'

class azure.mgmt.applicationinsights.v2015_05_01.models.RequestSource(*values)[source]

Bases: str, Enum

Describes what tool created this Application Insights component. Customers using this API should set this to the default ‘rest’.

REST = 'rest'

class azure.mgmt.applicationinsights.v2015_05_01.models.SharedTypeKind(*values)[source]

Bases: str, Enum

The kind of workbook. Choices are user and shared.

SHARED = 'shared'

USER = 'user'

class azure.mgmt.applicationinsights.v2015_05_01.models.TagsResource(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

A container holding only the Tags for a resource, allowing the user to update the tags on a WebTest instance.

Variables:: tags (dict[str, str]) – Resource tags.
Keyword Arguments:: tags (dict[str, str]) – Resource tags.

class azure.mgmt.applicationinsights.v2015_05_01.models.WebTest(*, location: str, tags: Dict[str, str] | None = None, kind: str | _models.WebTestKind | None = None, synthetic_monitor_id: str | None = None, web_test_name: str | None = None, description: str | None = None, enabled: bool | None = None, frequency: int = 300, timeout: int = 30, web_test_kind: str | _models.WebTestKind | None = None, retry_enabled: bool | None = None, locations: List[_models.WebTestGeolocation] | None = None, configuration: _models.WebTestPropertiesConfiguration | None = None, **kwargs: Any)[source]

Bases: WebtestsResource

An Application Insights web test 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 server.

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
kind (str or WebTestKind) – The kind of web test that this web test watches. Choices are ping and multistep. Known values are: “ping” and “multistep”.
synthetic_monitor_id (str) – Unique ID of this WebTest. This is typically the same value as the Name field.
web_test_name (str) – User defined name if this WebTest.
description (str) – Purpose/user defined descriptive test for this WebTest.
enabled (bool) – Is the test actively being monitored.
frequency (int) – Interval in seconds between test runs for this WebTest. Default value is 300.
timeout (int) – Seconds until this WebTest will timeout and fail. Default value is 30.
web_test_kind (str or WebTestKind) – The kind of web test this is, valid choices are ping and multistep. Known values are: “ping” and “multistep”.
retry_enabled (bool) – Allow for retries should this WebTest fail.
locations (list[WebTestGeolocation]) – A list of where to physically run the tests from to give global coverage for accessibility of your application.
configuration (WebTestPropertiesConfiguration) – An XML configuration specification for a WebTest.
provisioning_state (str) – Current state of this component, 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:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.
kind (str or WebTestKind) – The kind of web test that this web test watches. Choices are ping and multistep. Known values are: “ping” and “multistep”.
synthetic_monitor_id (str) – Unique ID of this WebTest. This is typically the same value as the Name field.
web_test_name (str) – User defined name if this WebTest.
description (str) – Purpose/user defined descriptive test for this WebTest.
enabled (bool) – Is the test actively being monitored.
frequency (int) – Interval in seconds between test runs for this WebTest. Default value is 300.
timeout (int) – Seconds until this WebTest will timeout and fail. Default value is 30.
web_test_kind (str or WebTestKind) – The kind of web test this is, valid choices are ping and multistep. Known values are: “ping” and “multistep”.
retry_enabled (bool) – Allow for retries should this WebTest fail.
locations (list[WebTestGeolocation]) – A list of where to physically run the tests from to give global coverage for accessibility of your application.
configuration (WebTestPropertiesConfiguration) – An XML configuration specification for a WebTest.

class azure.mgmt.applicationinsights.v2015_05_01.models.WebTestGeolocation(*, location: str | None = None, **kwargs: Any)[source]

Bases: Model

Geo-physical location to run a web test from. You must specify one or more locations for the test to run from.

Variables:: location (str) – Location ID for the webtest to run from.
Keyword Arguments:: location (str) – Location ID for the webtest to run from.

class azure.mgmt.applicationinsights.v2015_05_01.models.WebTestKind(*values)[source]

Bases: str, Enum

The kind of web test that this web test watches. Choices are ping and multistep.

MULTISTEP = 'multistep'

PING = 'ping'

class azure.mgmt.applicationinsights.v2015_05_01.models.WebTestListResult(*, value: List[_models.WebTest], next_link: str | None = None, **kwargs: Any)[source]

Bases: Model

A list of 0 or more Application Insights web test definitions.

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

Variables:

value (list[WebTest]) – Set of Application Insights web test definitions. Required.
next_link (str) – The link to get the next part of the returned list of web tests, should the return set be too large for a single request. May be null.

Keyword Arguments:

value (list[WebTest]) – Set of Application Insights web test definitions. Required.
next_link (str) – The link to get the next part of the returned list of web tests, should the return set be too large for a single request. May be null.

class azure.mgmt.applicationinsights.v2015_05_01.models.WebTestPropertiesConfiguration(*, web_test: str | None = None, **kwargs: Any)[source]

Bases: Model

An XML configuration specification for a WebTest.

Variables:: web_test (str) – The XML specification of a WebTest to run against an application.
Keyword Arguments:: web_test (str) – The XML specification of a WebTest to run against an application.

class azure.mgmt.applicationinsights.v2015_05_01.models.WebtestsResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: 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 server.

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

location (str) – Resource location. Required.
tags (dict[str, str]) – Resource tags.

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkItemConfiguration(*, connector_id: str | None = None, config_display_name: str | None = None, is_default: bool | None = None, id: str | None = None, config_properties: str | None = None, **kwargs: Any)[source]

Bases: Model

Work item configuration associated with an application insights resource.

Variables:

connector_id (str) – Connector identifier where work item is created.
config_display_name (str) – Configuration friendly name.
is_default (bool) – Boolean value indicating whether configuration is default.
id (str) – Unique Id for work item.
config_properties (str) – Serialized JSON object for detailed properties.

Keyword Arguments:

connector_id (str) – Connector identifier where work item is created.
config_display_name (str) – Configuration friendly name.
is_default (bool) – Boolean value indicating whether configuration is default.
id (str) – Unique Id for work item.
config_properties (str) – Serialized JSON object for detailed properties.

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkItemConfigurationError(*, code: str | None = None, message: str | None = None, innererror: _models.InnerError | None = None, **kwargs: Any)[source]

Bases: Model

Error associated with trying to get work item configuration or configurations.

Variables:

code (str) – Error detail code and explanation.
message (str) – Error message.
innererror (InnerError) – Inner error.

Keyword Arguments:

code (str) – Error detail code and explanation.
message (str) – Error message.
innererror (InnerError) – Inner error.

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkItemConfigurationsListResult(**kwargs: Any)[source]

Bases: Model

Work item configuration list result.

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

Variables:: value (list[WorkItemConfiguration]) – An array of work item configurations.

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkItemCreateConfiguration(*, connector_id: str | None = None, connector_data_configuration: str | None = None, validate_only: bool | None = None, work_item_properties: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

Work item configuration creation payload.

Variables:

connector_id (str) – Unique connector id.
connector_data_configuration (str) – Serialized JSON object for detailed properties.
validate_only (bool) – Boolean indicating validate only.
work_item_properties (dict[str, str]) – Custom work item properties.

Keyword Arguments:

connector_id (str) – Unique connector id.
connector_data_configuration (str) – Serialized JSON object for detailed properties.
validate_only (bool) – Boolean indicating validate only.
work_item_properties (dict[str, str]) – Custom work item properties.

Bases: WorkbookResource

An Application Insights workbook definition.

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

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
kind (str or SharedTypeKind) – The kind of workbook. Choices are user and shared. Known values are: “user” and “shared”.
name_properties_name (str) – The user-defined name of the workbook.
serialized_data (str) – Configuration of this particular workbook. Configuration data is a string containing valid JSON.
version (str) – This instance’s version of the data model. This can change as new features are added that can be marked workbook.
workbook_id (str) – Internally assigned unique id of the workbook definition.
shared_type_kind (str or SharedTypeKind) – Enum indicating if this workbook definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “user” and “shared”.
time_modified (str) – Date and time in UTC of the last modification that was made to this workbook definition.
category (str) – Workbook category, as defined by the user at creation time.
tags_properties_tags (list[str]) – A list of 0 or more tags that are associated with this workbook definition.
user_id (str) – Unique user id of the specific user that owns this workbook.
source_resource_id (str) – Optional resourceId for a source resource.

Keyword Arguments:

location (str) – Resource location.
tags (dict[str, str]) – Resource tags.
kind (str or SharedTypeKind) – The kind of workbook. Choices are user and shared. Known values are: “user” and “shared”.
name_properties_name (str) – The user-defined name of the workbook.
serialized_data (str) – Configuration of this particular workbook. Configuration data is a string containing valid JSON.
version (str) – This instance’s version of the data model. This can change as new features are added that can be marked workbook.
workbook_id (str) – Internally assigned unique id of the workbook definition.
shared_type_kind (str or SharedTypeKind) – Enum indicating if this workbook definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “user” and “shared”.
category (str) – Workbook category, as defined by the user at creation time.
tags_properties_tags (list[str]) – A list of 0 or more tags that are associated with this workbook definition.
user_id (str) – Unique user id of the specific user that owns this workbook.
source_resource_id (str) – Optional resourceId for a source resource.

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkbookError(*, code: str | None = None, message: str | None = None, details: List[_models.ErrorFieldContract] | None = None, **kwargs: Any)[source]

Bases: Model

Error message body that will indicate why the operation failed.

Variables:

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

Keyword Arguments:

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkbookResource(*, location: str | None = None, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: Model

An azure resource object.

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

Variables:

id (str) – Azure resource Id.
name (str) – Azure resource name.
type (str) – Azure resource type.
location (str) – Resource location.
tags (dict[str, str]) – Resource tags.

Keyword Arguments:

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

class azure.mgmt.applicationinsights.v2015_05_01.models.WorkbooksListResult(**kwargs: Any)[source]

Bases: Model

Workbook list result.

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

Variables:: value (list[Workbook]) – An array of workbooks.