Package com.azure.resourcemanager.applicationinsights.models

Interface ApplicationInsightsComponent

  • public interface ApplicationInsightsComponent
    An immutable client-side representation of ApplicationInsightsComponent.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • kind

        String kind()
        Gets the kind property: 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.
        Returns:
        the kind value.

      • etag

        String etag()
        Gets the etag property: Resource etag.
        Returns:
        the etag value.

      • applicationId

        String applicationId()
        Gets the applicationId property: The unique ID of your application. This field mirrors the 'Name' field and cannot be changed.
        Returns:
        the applicationId value.

      • appId

        String appId()
        Gets the appId property: Application Insights Unique ID for your Application.
        Returns:
        the appId value.

      • namePropertiesName

        String namePropertiesName()
        Gets the namePropertiesName property: Application name.
        Returns:
        the namePropertiesName value.

      • applicationType

        ApplicationType applicationType()
        Gets the applicationType property: Type of application being monitored.
        Returns:
        the applicationType value.

      • flowType

        FlowType flowType()
        Gets the flowType property: 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.
        Returns:
        the flowType value.

      • requestSource

        RequestSource requestSource()
        Gets the requestSource property: Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.
        Returns:
        the requestSource value.

      • instrumentationKey

        String instrumentationKey()
        Gets the instrumentationKey property: 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.
        Returns:
        the instrumentationKey value.

      • creationDate

        OffsetDateTime creationDate()
        Gets the creationDate property: Creation Date for the Application Insights component, in ISO 8601 format.
        Returns:
        the creationDate value.

      • tenantId

        String tenantId()
        Gets the tenantId property: Azure Tenant Id.
        Returns:
        the tenantId value.

      • hockeyAppId

        String hockeyAppId()
        Gets the hockeyAppId property: The unique application ID created when a new application is added to HockeyApp, used for communications with HockeyApp.
        Returns:
        the hockeyAppId value.

      • hockeyAppToken

        String hockeyAppToken()
        Gets the hockeyAppToken property: Token used to authenticate communications with between Application Insights and HockeyApp.
        Returns:
        the hockeyAppToken value.

      • provisioningState

        String provisioningState()
        Gets the provisioningState property: 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.
        Returns:
        the provisioningState value.

      • samplingPercentage

        Double samplingPercentage()
        Gets the samplingPercentage property: Percentage of the data produced by the application being monitored that is being sampled for Application Insights telemetry.
        Returns:
        the samplingPercentage value.

      • connectionString

        String connectionString()
        Gets the connectionString property: Application Insights component connection string.
        Returns:
        the connectionString value.

      • retentionInDays

        Integer retentionInDays()
        Gets the retentionInDays property: Retention period in days.
        Returns:
        the retentionInDays value.

      • disableIpMasking

        Boolean disableIpMasking()
        Gets the disableIpMasking property: Disable IP masking.
        Returns:
        the disableIpMasking value.

      • immediatePurgeDataOn30Days

        Boolean immediatePurgeDataOn30Days()
        Gets the immediatePurgeDataOn30Days property: Purge data immediately after 30 days.
        Returns:
        the immediatePurgeDataOn30Days value.

      • workspaceResourceId

        String workspaceResourceId()
        Gets the workspaceResourceId property: 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.
        Returns:
        the workspaceResourceId value.

      • laMigrationDate

        OffsetDateTime laMigrationDate()
        Gets the laMigrationDate property: The date which the component got migrated to LA, in ISO 8601 format.
        Returns:
        the laMigrationDate value.

      • privateLinkScopedResources

        List<PrivateLinkScopedResource> privateLinkScopedResources()
        Gets the privateLinkScopedResources property: List of linked private link scope resources.
        Returns:
        the privateLinkScopedResources value.

      • publicNetworkAccessForIngestion

        PublicNetworkAccessType publicNetworkAccessForIngestion()
        Gets the publicNetworkAccessForIngestion property: The network access type for accessing Application Insights ingestion.
        Returns:
        the publicNetworkAccessForIngestion value.

      • publicNetworkAccessForQuery

        PublicNetworkAccessType publicNetworkAccessForQuery()
        Gets the publicNetworkAccessForQuery property: The network access type for accessing Application Insights query.
        Returns:
        the publicNetworkAccessForQuery value.

      • ingestionMode

        IngestionMode ingestionMode()
        Gets the ingestionMode property: Indicates the flow of the ingestion.
        Returns:
        the ingestionMode value.

      • disableLocalAuth

        Boolean disableLocalAuth()
        Gets the disableLocalAuth property: Disable Non-AAD based Auth.
        Returns:
        the disableLocalAuth value.

      • forceCustomerStorageForProfiler

        Boolean forceCustomerStorageForProfiler()
        Gets the forceCustomerStorageForProfiler property: Force users to create their own storage account for profiler and debugger.
        Returns:
        the forceCustomerStorageForProfiler value.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        ApplicationInsightsComponentInner innerModel()
        Gets the inner com.azure.resourcemanager.applicationinsights.fluent.models.ApplicationInsightsComponentInner object.
        Returns:
        the inner object.

      • refresh

        ApplicationInsightsComponent refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • purge

        ComponentPurgeResponse purge​(ComponentPurgeBody body)
        Purges data in an Application Insights component by a set of user-defined filters.

        In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

        Parameters:
        body - Describes the body of a request to purge data in a single table of an Application Insights component.
        Returns:
        response containing operationId for a specific purge action.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • purgeWithResponse

        com.azure.core.http.rest.Response<ComponentPurgeResponse> purgeWithResponse​(ComponentPurgeBody body,
                                                                            com.azure.core.util.Context context)
        Purges data in an Application Insights component by a set of user-defined filters.

        In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

        Parameters:
        body - Describes the body of a request to purge data in a single table of an Application Insights component.
        context - The context to associate with this operation.
        Returns:
        response containing operationId for a specific purge action along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.