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.
-
exception
azure.mgmt.applicationinsights.models.
AnnotationErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘AnnotationError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
exception
azure.mgmt.applicationinsights.models.
WorkItemConfigurationErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘WorkItemConfigurationError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
exception
azure.mgmt.applicationinsights.models.
WorkbookErrorException
(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationError
Server responsed with exception of type: ‘WorkbookError’.
- Parameters
deserialize – A deserializer
response – Server response to be deserialized.
-
class
azure.mgmt.applicationinsights.models.
ErrorResponse
(*, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.
-
class
azure.mgmt.applicationinsights.models.
OperationDisplay
(*, provider: str = None, resource: str = None, operation: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
The object that represents the operation.
-
class
azure.mgmt.applicationinsights.models.
Operation
(*, name: str = None, display=None, **kwargs)[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.
Annotation
(*, annotation_name: str = None, category: str = None, event_time=None, id: str = None, properties: str = None, related_annotation: str = 'null', **kwargs)[source]¶ Bases:
msrest.serialization.Model
Annotation associated with an application insights resource.
- Parameters
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. Default value: “null” .
-
class
azure.mgmt.applicationinsights.models.
InnerError
(*, diagnosticcontext: str = None, time=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Inner error.
- Parameters
diagnosticcontext (str) – Provides correlation for request
time (datetime) – Request time
-
class
azure.mgmt.applicationinsights.models.
AnnotationError
(*, code: str = None, message: str = None, innererror=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error associated with trying to create annotation with Id that already exist.
- Parameters
code (str) – Error detail code and explanation
message (str) – Error message
innererror (InnerError) –
-
class
azure.mgmt.applicationinsights.models.
APIKeyRequest
(*, name: str = None, linked_read_properties=None, linked_write_properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An Application Insights component API Key creation request definition.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentAPIKey
(*, created_date: str = None, name: str = None, linked_read_properties=None, linked_write_properties=None, **kwargs)[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
- Parameters
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentExportRequest
(*, record_types: str = None, destination_type: str = None, destination_address: str = None, is_enabled: str = None, notification_queue_enabled: str = None, notification_queue_uri: str = None, destination_storage_subscription_id: str = None, destination_storage_location_id: str = None, destination_account_id: str = None, **kwargs)[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: str = None, notification_queue_enabled: str = None, **kwargs)[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 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.
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.
ApplicationInsightsComponentDataVolumeCap
(*, cap: float = None, warning_threshold: int = None, stop_send_notification_when_hit_threshold: bool = None, stop_send_notification_when_hit_cap: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An Application Insights component daily data volume cap.
Variables are only populated by the server, and will be ignored when sending a request.
- Parameters
- Variables
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentBillingFeatures
(*, data_volume_cap=None, current_billing_features=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
An Application Insights component billing features.
- Parameters
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.models.
ApplicationInsightsComponentQuotaStatus
(**kwargs)[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.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentFeatureCapabilities
(**kwargs)[source]¶ Bases:
msrest.serialization.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.models.
ApplicationInsightsComponentFeatureCapability
(**kwargs)[source]¶ Bases:
msrest.serialization.Model
An Application Insights component feature capability.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentFeature
(**kwargs)[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
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.models.
ApplicationInsightsComponentAvailableFeatures
(**kwargs)[source]¶ Bases:
msrest.serialization.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.models.
ApplicationInsightsComponentProactiveDetectionConfigurationRuleDefinitions
(*, name: str = None, display_name: str = None, description: str = None, help_url: str = None, is_hidden: bool = None, is_enabled_by_default: bool = None, is_in_preview: bool = None, supports_email_notifications: bool = None, **kwargs)[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 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.models.
ApplicationInsightsComponentProactiveDetectionConfiguration
(*, name: str = None, enabled: bool = None, send_emails_to_subscription_owners: bool = None, custom_emails=None, last_updated_time: str = None, rule_definitions=None, **kwargs)[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.
ComponentsResource
(*, location: str, tags=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.
-
class
azure.mgmt.applicationinsights.models.
TagsResource
(*, tags=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 WebTest instance.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponent
(*, location: str, kind: str, tags=None, application_type='web', flow_type='Bluefield', request_source='rest', hockey_app_id: str = None, sampling_percentage: float = None, **kwargs)[source]¶ Bases:
azure.mgmt.applicationinsights.models.components_resource_py3.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 Azure.
- Variables
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) – Required. Resource location
kind (str) – Required. 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) – Required. 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.
ComponentPurgeBodyFilters
(*, column: str = None, operator: str = None, value=None, key: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
User-defined filters to return data which will be purged from the table.
- Parameters
column (str) – The column of the table over which the given query should run
operator (str) – A query operator to evaluate over the provided column and value(s).
value (object) – the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= ‘2017-09-01’) or array of values.
key (str) – When filtering over custom dimensions, this key will be used as the name of the custom dimension.
-
class
azure.mgmt.applicationinsights.models.
ComponentPurgeBody
(*, table: str, filters, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Describes the body of a purge request for an App Insights component.
All required parameters must be populated in order to send to Azure.
- Parameters
table (str) – Required. Table from which to purge data.
filters (list[ComponentPurgeBodyFilters]) – Required. The set of columns and filters (queries) to run over them to purge the resulting data.
-
class
azure.mgmt.applicationinsights.models.
ComponentPurgeResponse
(*, operation_id: str, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Response containing operationId for a specific purge action.
All required parameters must be populated in order to send to Azure.
- Parameters
operation_id (str) – Required. Id to use when querying for status for a particular purge operation.
-
class
azure.mgmt.applicationinsights.models.
ComponentPurgeStatusResponse
(*, status, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Response containing status for a specific purge operation.
All required parameters must be populated in order to send to Azure.
- Parameters
status (str or PurgeState) – Required. Status of the operation represented by the requested Id. Possible values include: ‘pending’, ‘completed’
-
class
azure.mgmt.applicationinsights.models.
WorkItemConfiguration
(*, connector_id: str = None, config_display_name: str = None, is_default: bool = None, id: str = None, config_properties: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Work item configuration associated with an application insights resource.
- Parameters
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.models.
WorkItemCreateConfiguration
(*, connector_id: str = None, connector_data_configuration: str = None, validate_only: bool = None, work_item_properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Work item configuration creation payload.
-
class
azure.mgmt.applicationinsights.models.
WorkItemConfigurationError
(*, code: str = None, message: str = None, innererror=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error associated with trying to get work item configuration or configurations.
- Parameters
code (str) – Error detail code and explanation
message (str) – Error message
innererror (InnerError) –
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentFavorite
(*, name: str = None, config: str = None, version: str = None, favorite_type=None, source_type: str = None, tags=None, category: str = None, is_generated_from_template: bool = None, **kwargs)[source]¶ Bases:
msrest.serialization.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.
- Parameters
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. Possible values include: ‘shared’, ‘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.
- Variables
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentWebTestLocation
(**kwargs)[source]¶ Bases:
msrest.serialization.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.
-
class
azure.mgmt.applicationinsights.models.
WebtestsResource
(*, location: str, tags=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.
-
class
azure.mgmt.applicationinsights.models.
WebTestGeolocation
(*, location: str = None, **kwargs)[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: str = None, **kwargs)[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: str, synthetic_monitor_id: str, web_test_name: str, locations, tags=None, kind='ping', description: str = None, enabled: bool = None, frequency: int = 300, timeout: int = 30, web_test_kind='ping', retry_enabled: bool = None, configuration=None, **kwargs)[source]¶ Bases:
azure.mgmt.applicationinsights.models.webtests_resource_py3.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 Azure.
- Variables
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) – Required. Resource location
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) – Required. Unique ID of this WebTest. This is typically the same value as the Name field.
web_test_name (str) – Required. 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) – Required. 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]) – Required. 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.
ApplicationInsightsComponentAnalyticsItemProperties
(*, function_alias: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.
- Parameters
function_alias (str) – A function alias, used when the type of the item is Function
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentAnalyticsItem
(*, id: str = None, name: str = None, content: str = None, scope=None, type=None, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.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.
- Parameters
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. Possible values include: ‘shared’, ‘user’
type (str or ItemType) – Enum indicating the type of the Analytics item. Possible values include: ‘query’, ‘function’, ‘folder’, ‘recent’
properties (ApplicationInsightsComponentAnalyticsItemProperties) –
- Variables
-
class
azure.mgmt.applicationinsights.models.
WorkbookResource
(*, location: str = None, tags=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.
-
class
azure.mgmt.applicationinsights.models.
Workbook
(*, workbook_name: str, serialized_data: str, workbook_id: str, category: str, user_id: str, location: str = None, tags=None, kind=None, version: str = None, shared_type_kind='shared', workbook_tags=None, source_resource_id: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.applicationinsights.models.workbook_resource_py3.WorkbookResource
An Application Insights workbook 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
- Parameters
location (str) – Resource location
kind (str or SharedTypeKind) – The kind of workbook. Choices are user and shared. Possible values include: ‘user’, ‘shared’
workbook_name (str) – Required. The user-defined name of the workbook.
serialized_data (str) – Required. 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) – Required. Internally assigned unique id of the workbook definition.
shared_type_kind (str or SharedTypeKind) – Required. 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. Possible values include: ‘user’, ‘shared’. Default value: “shared” .
category (str) – Required. Workbook category, as defined by the user at creation time.
workbook_tags (list[str]) – A list of 0 or more tags that are associated with this workbook definition
user_id (str) – Required. 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.models.
LinkProperties
(*, source_id: str = None, target_id: str = None, category: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Contains a sourceId and workbook resource id to link two resources.
-
class
azure.mgmt.applicationinsights.models.
ErrorFieldContract
(*, code: str = None, message: str = None, target: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error Field contract.
-
class
azure.mgmt.applicationinsights.models.
WorkbookError
(*, code: str = None, message: str = None, details=None, **kwargs)[source]¶ Bases:
msrest.serialization.Model
Error message body that will indicate why the operation failed.
- Parameters
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.models.
OperationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Operation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
AnnotationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Annotation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentAPIKeyPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ApplicationInsightsComponentAPIKey
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ApplicationInsightsComponent
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
WorkItemConfigurationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
WorkItemConfiguration
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
ApplicationInsightsComponentWebTestLocationPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
ApplicationInsightsComponentWebTestLocation
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
WebTestPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
WebTest
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
WorkbookPaged
(*args, **kwargs)[source]¶ Bases:
msrest.paging.Paged
A paging container for iterating over a list of
Workbook
objectBring async to Paging.
“async_command” is mandatory keyword argument for this mixin to work.
-
class
azure.mgmt.applicationinsights.models.
ApplicationType
[source]¶ -
An enumeration.
-
other
= 'other'¶
-
web
= 'web'¶
-
-
class
azure.mgmt.applicationinsights.models.
FlowType
[source]¶ -
An enumeration.
-
bluefield
= 'Bluefield'¶
-
-
class
azure.mgmt.applicationinsights.models.
PurgeState
[source]¶ -
An enumeration.
-
completed
= 'completed'¶
-
pending
= 'pending'¶
-
-
class
azure.mgmt.applicationinsights.models.
WebTestKind
[source]¶ -
An enumeration.
-
multistep
= 'multistep'¶
-
ping
= 'ping'¶
-
-
class
azure.mgmt.applicationinsights.models.
ItemType
[source]¶ -
An enumeration.
-
folder
= 'folder'¶
-
function
= 'function'¶
-
query
= 'query'¶
-
recent
= 'recent'¶
-
-
class
azure.mgmt.applicationinsights.models.
FavoriteSourceType
[source]¶ -
An enumeration.
-
events
= 'events'¶
-
funnel
= 'funnel'¶
-
impact
= 'impact'¶
-
notebook
= 'notebook'¶
-
retention
= 'retention'¶
-
segmentation
= 'segmentation'¶
-
sessions
= 'sessions'¶
-
userflows
= 'userflows'¶
-
-
class
azure.mgmt.applicationinsights.models.
ItemScopePath
[source]¶ -
An enumeration.
-
analytics_items
= 'analyticsItems'¶
-
myanalytics_items
= 'myanalyticsItems'¶
-