azure.mgmt.applicationinsights.v2018_05_01_preview.models module
- class azure.mgmt.applicationinsights.v2018_05_01_preview.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, public_network_access_for_ingestion: str | _models.PublicNetworkAccessType = 'Enabled', public_network_access_for_query: str | _models.PublicNetworkAccessType = 'Enabled', 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.
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.
public_network_access_for_ingestion (str or PublicNetworkAccessType) – The network access type for accessing Application Insights ingestion. Known values are: “Enabled” and “Disabled”.
public_network_access_for_query (str or PublicNetworkAccessType) – The network access type for accessing Application Insights query. Known values are: “Enabled” and “Disabled”.
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.
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.
public_network_access_for_ingestion (str or PublicNetworkAccessType) – The network access type for accessing Application Insights ingestion. Known values are: “Enabled” and “Disabled”.
public_network_access_for_query (str or PublicNetworkAccessType) – The network access type for accessing Application Insights query. Known values are: “Enabled” and “Disabled”.
ingestion_mode (str or IngestionMode) – Indicates the flow of the ingestion. Known values are: “ApplicationInsights”, “ApplicationInsightsWithDiagnosticSettings”, and “LogAnalytics”.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.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.v2018_05_01_preview.models.ApplicationInsightsComponentProactiveDetectionConfiguration(*, name: str | None = None, location: str | None = None, enabled: bool | None = None, send_emails_to_subscription_owners: bool | None = None, custom_emails: List[str] | None = None, rule_definitions: _models.ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions | None = None, **kwargs: Any)[source]
Bases:
Model
A ProactiveDetection configuration 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.
name_properties_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 (ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions # pylint: disable=line-too-long) – Static definitions of the ProactiveDetection configuration rule (same values for all components).
- Keyword Arguments:
name (str) – Azure resource name.
location (str) – Resource location.
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.
rule_definitions (ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions # pylint: disable=line-too-long) – Static definitions of the ProactiveDetection configuration rule (same values for all components).
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions(*, 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.v2018_05_01_preview.models.ApplicationType(*values)[source]
-
Type of application being monitored.
- OTHER = 'other'
- WEB = 'web'
- class azure.mgmt.applicationinsights.v2018_05_01_preview.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.v2018_05_01_preview.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.v2018_05_01_preview.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.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.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.v2018_05_01_preview.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.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.FlowType(*values)[source]
-
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.v2018_05_01_preview.models.HeaderField(*, header_field_name: str | None = None, header_field_value: str | None = None, **kwargs: Any)[source]
Bases:
Model
A header to add to the WebTest.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.IngestionMode(*values)[source]
-
Indicates the flow of the ingestion.
- APPLICATION_INSIGHTS = 'ApplicationInsights'
- APPLICATION_INSIGHTS_WITH_DIAGNOSTIC_SETTINGS = 'ApplicationInsightsWithDiagnosticSettings'
- LOG_ANALYTICS = 'LogAnalytics'
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.Operation(*, name: str | None = None, display: _models.OperationInfo | None = None, origin: str | None = None, properties: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]
Bases:
Model
Represents an operation returned by the GetOperations request.
- Variables:
name (str) – Name of the operation.
display (OperationInfo) – Display name of the operation.
origin (str) – Origin of the operation.
properties (JSON) – Properties of the operation.
- Keyword Arguments:
name (str) – Name of the operation.
display (OperationInfo) – Display name of the operation.
origin (str) – Origin of the operation.
properties (JSON) – Properties of the operation.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.OperationInfo(*, provider: str | None = None, resource: str | None = None, operation: str | None = None, description: str | None = None, **kwargs: Any)[source]
Bases:
Model
Information about an operation.
- Variables:
- Keyword Arguments:
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.OperationsListResult(*, value: List[_models.Operation] | None = None, next_link: str | None = None, **kwargs: Any)[source]
Bases:
Model
Result of the List Operations operation.
- Variables:
- Keyword Arguments:
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.PrivateLinkScopedResource(*, resource_id: str | None = None, scope_id: str | None = None, **kwargs: Any)[source]
Bases:
Model
The private link scope resource reference.
- Variables:
- Keyword Arguments:
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.PublicNetworkAccessType(*values)[source]
-
The network access type for operating on the Application Insights Component. By default it is Enabled.
- DISABLED = 'Disabled'
Disables public connectivity to Application Insights through public DNS.
- ENABLED = 'Enabled'
Enables connectivity to Application Insights through public DNS.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.PurgeState(*values)[source]
-
Status of the operation represented by the requested Id.
- COMPLETED = 'completed'
- PENDING = 'pending'
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.RequestSource(*values)[source]
-
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.v2018_05_01_preview.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.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTest(*, location: str, tags: Dict[str, str] | None = None, kind: str | _models.WebTestKind = 'ping', 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.WebTestKindEnum = 'ping', retry_enabled: bool | None = None, locations: List[_models.WebTestGeolocation] | None = None, configuration: _models.WebTestPropertiesConfiguration | None = None, request: _models.WebTestPropertiesRequest | None = None, validation_rules: _models.WebTestPropertiesValidationRules | None = None, **kwargs: Any)[source]
Bases:
WebtestsResource
An Application Insights WebTest 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.
kind (str or WebTestKind) – The kind of WebTest 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) – User defined description 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 WebTestKindEnum) – The kind of web test this is, valid choices are ping, multistep, basic, and standard. Known values are: “ping”, “multistep”, “basic”, and “standard”.
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.
request (WebTestPropertiesRequest) – The collection of request properties.
validation_rules (WebTestPropertiesValidationRules) – The collection of validation rule properties.
- Keyword Arguments:
location (str) – Resource location. Required.
kind (str or WebTestKind) – The kind of WebTest 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) – User defined description 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 WebTestKindEnum) – The kind of web test this is, valid choices are ping, multistep, basic, and standard. Known values are: “ping”, “multistep”, “basic”, and “standard”.
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.
request (WebTestPropertiesRequest) – The collection of request properties.
validation_rules (WebTestPropertiesValidationRules) – The collection of validation rule properties.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestGeolocation(*, location: str | None = None, **kwargs: Any)[source]
Bases:
Model
Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestKind(*values)[source]
-
The kind of WebTest that this web test watches. Choices are ping and multistep.
- MULTISTEP = 'multistep'
- PING = 'ping'
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestKindEnum(*values)[source]
-
The kind of web test this is, valid choices are ping, multistep, basic, and standard.
- BASIC = 'basic'
- MULTISTEP = 'multistep'
- PING = 'ping'
- STANDARD = 'standard'
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestListResult(*, value: List[_models.WebTest], next_link: str | None = None, **kwargs: Any)[source]
Bases:
Model
A list of 0 or more Application Insights WebTest definitions.
All required parameters must be populated in order to send to server.
- Variables:
- Keyword Arguments:
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestPropertiesConfiguration(*, web_test: str | None = None, **kwargs: Any)[source]
Bases:
Model
An XML configuration specification for a WebTest.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestPropertiesRequest(*, request_url: str | None = None, headers: List[_models.HeaderField] | None = None, http_verb: str | None = None, request_body: str | None = None, parse_dependent_requests: bool | None = None, follow_redirects: bool | None = None, **kwargs: Any)[source]
Bases:
Model
The collection of request properties.
- Variables:
request_url (str) – Url location to test.
headers (list[HeaderField]) – List of headers and their values to add to the WebTest call.
http_verb (str) – Http verb to use for this web test.
request_body (str) – Base64 encoded string body to send with this web test.
parse_dependent_requests (bool) – Parse Dependent request for this WebTest.
follow_redirects (bool) – Follow redirects for this web test.
- Keyword Arguments:
request_url (str) – Url location to test.
headers (list[HeaderField]) – List of headers and their values to add to the WebTest call.
http_verb (str) – Http verb to use for this web test.
request_body (str) – Base64 encoded string body to send with this web test.
parse_dependent_requests (bool) – Parse Dependent request for this WebTest.
follow_redirects (bool) – Follow redirects for this web test.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestPropertiesValidationRules(*, content_validation: _models.WebTestPropertiesValidationRulesContentValidation | None = None, ssl_check: bool | None = None, ssl_cert_remaining_lifetime_check: int | None = None, expected_http_status_code: int | None = None, ignore_https_status_code: bool | None = None, **kwargs: Any)[source]
Bases:
Model
The collection of validation rule properties.
- Variables:
content_validation (WebTestPropertiesValidationRulesContentValidation) – The collection of content validation properties.
ssl_check (bool) – Checks to see if the SSL cert is still valid.
ssl_cert_remaining_lifetime_check (int) – A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.
expected_http_status_code (int) – Validate that the WebTest returns the http status code provided.
ignore_https_status_code (bool) – When set, validation will ignore the status code.
- Keyword Arguments:
content_validation (WebTestPropertiesValidationRulesContentValidation) – The collection of content validation properties.
ssl_check (bool) – Checks to see if the SSL cert is still valid.
ssl_cert_remaining_lifetime_check (int) – A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true.
expected_http_status_code (int) – Validate that the WebTest returns the http status code provided.
ignore_https_status_code (bool) – When set, validation will ignore the status code.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.models.WebTestPropertiesValidationRulesContentValidation(*, content_match: str | None = None, ignore_case: bool | None = None, pass_if_text_found: bool | None = None, **kwargs: Any)[source]
Bases:
Model
The collection of content validation properties.
- Variables:
content_match (str) – Content to look for in the return of the WebTest. Must not be null or empty.
ignore_case (bool) – When set, this value makes the ContentMatch validation case insensitive.
pass_if_text_found (bool) – When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match.
- Keyword Arguments:
content_match (str) – Content to look for in the return of the WebTest. Must not be null or empty.
ignore_case (bool) – When set, this value makes the ContentMatch validation case insensitive.
pass_if_text_found (bool) – When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match.
- class azure.mgmt.applicationinsights.v2018_05_01_preview.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.