Interface Components


  • public interface Components
    Resource collection API of Components.
    • Method Detail

      • list

        com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponent> list()
        Gets a list of all Application Insights components within a subscription.
        Returns:
        a list of all Application Insights components within a subscription as paginated response with PagedIterable.
        Throws:
        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.
      • list

        com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponent> list​(com.azure.core.util.Context context)
        Gets a list of all Application Insights components within a subscription.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        a list of all Application Insights components within a subscription as paginated response with PagedIterable.
        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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponent> listByResourceGroup​(String resourceGroupName)
        Gets a list of Application Insights components within a resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        a list of Application Insights components within a resource group as paginated response with PagedIterable.
        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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponent> listByResourceGroup​(String resourceGroupName,
                                                                                                 com.azure.core.util.Context context)
        Gets a list of Application Insights components within a resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        context - The context to associate with this operation.
        Returns:
        a list of Application Insights components within a resource group as paginated response with PagedIterable.
        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.
      • deleteByResourceGroup

        void deleteByResourceGroup​(String resourceGroupName,
                                   String resourceName)
        Deletes an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        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.
      • deleteWithResponse

        com.azure.core.http.rest.Response<Void> deleteWithResponse​(String resourceGroupName,
                                                                   String resourceName,
                                                                   com.azure.core.util.Context context)
        Deletes an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        context - The context to associate with this operation.
        Returns:
        the 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.
      • getByResourceGroup

        ApplicationInsightsComponent getByResourceGroup​(String resourceGroupName,
                                                        String resourceName)
        Returns an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        Returns:
        an Application Insights component definition.
        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.
      • getByResourceGroupWithResponse

        com.azure.core.http.rest.Response<ApplicationInsightsComponent> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                                       String resourceName,
                                                                                                       com.azure.core.util.Context context)
        Returns an Application Insights component.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        context - The context to associate with this operation.
        Returns:
        an Application Insights component definition 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.
      • purge

        ComponentPurgeResponse purge​(String resourceGroupName,
                                     String resourceName,
                                     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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        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​(String resourceGroupName,
                                                                                    String resourceName,
                                                                                    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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        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.
      • getPurgeStatus

        ComponentPurgeStatusResponse getPurgeStatus​(String resourceGroupName,
                                                    String resourceName,
                                                    String purgeId)
        Get status for an ongoing purge operation.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        purgeId - In a purge status request, this is the Id of the operation the status of which is returned.
        Returns:
        status for an ongoing purge operation.
        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.
      • getPurgeStatusWithResponse

        com.azure.core.http.rest.Response<ComponentPurgeStatusResponse> getPurgeStatusWithResponse​(String resourceGroupName,
                                                                                                   String resourceName,
                                                                                                   String purgeId,
                                                                                                   com.azure.core.util.Context context)
        Get status for an ongoing purge operation.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        resourceName - The name of the Application Insights component resource.
        purgeId - In a purge status request, this is the Id of the operation the status of which is returned.
        context - The context to associate with this operation.
        Returns:
        status for an ongoing purge operation 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.
      • getById

        ApplicationInsightsComponent getById​(String id)
        Returns an Application Insights component.
        Parameters:
        id - the resource ID.
        Returns:
        an Application Insights component definition 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.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<ApplicationInsightsComponent> getByIdWithResponse​(String id,
                                                                                            com.azure.core.util.Context context)
        Returns an Application Insights component.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        an Application Insights component definition 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.
      • deleteById

        void deleteById​(String id)
        Deletes an Application Insights component.
        Parameters:
        id - the resource ID.
        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.
      • deleteByIdWithResponse

        com.azure.core.http.rest.Response<Void> deleteByIdWithResponse​(String id,
                                                                       com.azure.core.util.Context context)
        Deletes an Application Insights component.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the 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.