azure.mgmt.applicationinsights.v2020_02_02.models module

class azure.mgmt.applicationinsights.v2020_02_02.models.ApplicationInsightsComponent(*, location: str, kind: str, tags: Dict[str, str] | None = None, etag: 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 | None = None, disable_ip_masking: bool | None = None, immediate_purge_data_on30_days: bool | None = None, workspace_resource_id: str | 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 = 'LogAnalytics', disable_local_auth: bool | None = None, force_customer_storage_for_profiler: bool | None = None, **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.
etag (str) – Resource etag.
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.
name_properties_name (str) – Application name.
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.
workspace_resource_id (str) – Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property.
la_migration_date (datetime) – The date which the component got migrated to LA, in ISO 8601 format.
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”.
disable_local_auth (bool) – Disable Non-AAD based Auth.
force_customer_storage_for_profiler (bool) – Force users to create their own storage account for profiler and debugger.

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.
etag (str) – Resource etag.
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.
workspace_resource_id (str) – Resource Id of the log analytics workspace which the data will be ingested to. This property is required to create an application with this API version. Applications from older versions will not have this property.
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”.
disable_local_auth (bool) – Disable Non-AAD based Auth.
force_customer_storage_for_profiler (bool) – Force users to create their own storage account for profiler and debugger.

class azure.mgmt.applicationinsights.v2020_02_02.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.v2020_02_02.models.ApplicationType(*values)[source]

Bases: str, Enum

Type of application being monitored.

OTHER = 'other'

WEB = 'web'

class azure.mgmt.applicationinsights.v2020_02_02.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.v2020_02_02.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.v2020_02_02.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.v2020_02_02.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.v2020_02_02.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.v2020_02_02.models.ErrorResponseComponents(*, error: _models.ErrorResponseComponentsError | None = None, **kwargs: Any)[source]

Bases: Model

ErrorResponseComponents.

Variables:: error (ErrorResponseComponentsError) – Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.
Keyword Arguments:: error (ErrorResponseComponentsError) – 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.v2020_02_02.models.ErrorResponseComponentsError(**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 are only populated by the server, and will be ignored when sending a request.

Variables:

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

class azure.mgmt.applicationinsights.v2020_02_02.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.v2020_02_02.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.v2020_02_02.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.v2020_02_02.models.PublicNetworkAccessType(*values)[source]

Bases: str, Enum

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

Bases: str, Enum

Status of the operation represented by the requested Id.

COMPLETED = 'completed'

PENDING = 'pending'

class azure.mgmt.applicationinsights.v2020_02_02.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.v2020_02_02.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.