azure.mgmt.applicationinsights.models module

exception azure.mgmt.applicationinsights.models.ErrorResponseException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘ErrorResponse’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.mgmt.applicationinsights.models.ErrorResponse(code=None, message=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • code (str) – Error code.
  • message (str) – Error message indicating why the operation failed.
class azure.mgmt.applicationinsights.models.OperationDisplay(provider=None, resource=None, operation=None)[source]

Bases: msrest.serialization.Model

The object that represents the operation.

Parameters:
  • 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.models.Operation(name=None, display=None)[source]

Bases: msrest.serialization.Model

CDN REST API operation.

Parameters:
  • name (str) – Operation name: {provider}/{resource}/{operation}
  • display (OperationDisplay) – The object that represents the operation.
class azure.mgmt.applicationinsights.models.Resource(location, tags=None)[source]

Bases: msrest.serialization.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
Parameters:
  • location (str) – Resource location
  • tags (dict[str, str]) – Resource tags
class azure.mgmt.applicationinsights.models.TagsResource(tags=None)[source]

Bases: msrest.serialization.Model

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

Parameters:tags (dict[str, str]) – Resource tags
class azure.mgmt.applicationinsights.models.ApplicationInsightsComponent(location, kind, tags=None, application_type='web', flow_type='Bluefield', request_source='rest', hockey_app_id=None, sampling_percentage=None)[source]

Bases: azure.mgmt.applicationinsights.models.resource.Resource

An Application Insights component 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
  • 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.
  • 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_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.
Parameters:
  • location (str) – Resource location
  • 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.
  • application_type (str or ApplicationType) – Type of application being monitored. Possible values include: ‘web’, ‘other’. Default value: “web” .
  • 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. Possible values include: ‘Bluefield’. Default value: “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’. Possible values include: ‘rest’. Default value: “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.
class azure.mgmt.applicationinsights.models.WebTestGeolocation(location=None)[source]

Bases: msrest.serialization.Model

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

Parameters:location (str) – Location ID for the webtest to run from.
class azure.mgmt.applicationinsights.models.WebTestPropertiesConfiguration(web_test=None)[source]

Bases: msrest.serialization.Model

An XML configuration specification for a WebTest.

Parameters:web_test (str) – The XML specification of a WebTest to run against an application.
class azure.mgmt.applicationinsights.models.WebTest(location, synthetic_monitor_id, web_test_name, locations, tags=None, kind='ping', description=None, enabled=None, frequency=300, timeout=30, web_test_kind='ping', retry_enabled=None, configuration=None)[source]

Bases: azure.mgmt.applicationinsights.models.resource.Resource

An Application Insights web test 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
  • 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.
Parameters:
  • location (str) – Resource location
  • 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. Possible values include: ‘ping’, ‘multistep’. Default value: “ping” .
  • 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. Default value: 300 .
  • timeout (int) – Seconds until this WebTest will timeout and fail. Default value is 30. Default value: 30 .
  • web_test_kind (str or WebTestKind) – The kind of web test this is, valid choices are ping and multistep. Possible values include: ‘ping’, ‘multistep’. Default value: “ping” .
  • 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.models.ApplicationInsightsComponentExportRequest(record_types=None, destination_type=None, destination_address=None, is_enabled=None, notification_queue_enabled=None, notification_queue_uri=None, destination_storage_subscription_id=None, destination_storage_location_id=None, destination_account_id=None)[source]

Bases: msrest.serialization.Model

An Application Insights component Continuous Export configuration request definition.

Parameters:
  • 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.
class azure.mgmt.applicationinsights.models.ApplicationInsightsComponentExportConfiguration(record_types=None, notification_queue_enabled=None)[source]

Bases: msrest.serialization.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 Applciation Insights component. It is auto generated when the Continuous Export configuration is created.
  • instrumentation_key (str) – The instrumentation key of the Application Insights component.
  • 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.
  • 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.
Parameters:
  • 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.models.ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions(name=None, display_name=None, description=None, help_url=None, is_hidden=None, is_enabled_by_default=None, is_in_preview=None, supports_email_notifications=None)[source]

Bases: msrest.serialization.Model

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

Parameters:
  • 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 aditional 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.models.ApplicationInsightsComponentProactiveDetectionConfiguration(name=None, enabled=None, send_emails_to_subscription_owners=None, custom_emails=None, last_updated_time=None, rule_definitions=None)[source]

Bases: msrest.serialization.Model

Properties that define a ProactiveDetection configuration.

Parameters:
  • 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) – Static definitions of the ProactiveDetection configuration rule (same values for all components).
class azure.mgmt.applicationinsights.models.ApplicationInsightsComponentDataVolumeCap(cap=None, warning_threshold=None, stop_send_notification_when_hit_threshold=None, stop_send_notification_when_hit_cap=None)[source]

Bases: msrest.serialization.Model

An Application Insights component daily data volumne cap.

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

Parameters:
  • 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.
Variables:
  • reset_time (int) – Daily data volume cap UTC reset hour.
  • max_history_cap (float) – Maximum daily data volume cap that the user can set for this component.
class azure.mgmt.applicationinsights.models.ApplicationInsightsComponentBillingFeatures(data_volume_cap=None, current_billing_features=None)[source]

Bases: msrest.serialization.Model

An Application Insights component billing features.

Parameters:
  • data_volume_cap (ApplicationInsightsComponentDataVolumeCap) – An Application Insights component daily data volumne 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.models.ApplicationInsightsComponentQuotaStatus[source]

Bases: msrest.serialization.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.models.APIKeyRequest(name=None, linked_read_properties=None, linked_write_properties=None)[source]

Bases: msrest.serialization.Model

An Application Insights component API Key createion request definition.

Parameters:
  • 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.models.ApplicationInsightsComponentAPIKey(created_date=None, name=None, linked_read_properties=None, linked_write_properties=None)[source]

Bases: msrest.serialization.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 Applciation 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.
Parameters:
  • 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.models.OperationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

class azure.mgmt.applicationinsights.models.ApplicationInsightsComponentPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ApplicationInsightsComponent object

class azure.mgmt.applicationinsights.models.WebTestPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of WebTest object

class azure.mgmt.applicationinsights.models.ApplicationInsightsComponentAPIKeyPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ApplicationInsightsComponentAPIKey object

class azure.mgmt.applicationinsights.models.ApplicationType[source]

Bases: enum.Enum

An enumeration.

other = 'other'
web = 'web'
class azure.mgmt.applicationinsights.models.FlowType[source]

Bases: enum.Enum

An enumeration.

bluefield = 'Bluefield'
class azure.mgmt.applicationinsights.models.RequestSource[source]

Bases: enum.Enum

An enumeration.

rest = 'rest'
class azure.mgmt.applicationinsights.models.WebTestKind[source]

Bases: enum.Enum

An enumeration.

multistep = 'multistep'
ping = 'ping'