Package com.azure.resourcemanager.applicationinsights.fluent

Interface ComponentsClient

public interface ComponentsClient
An instance of this class provides access to all the operations defined in ComponentsClient.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ApplicationInsightsComponentInner> 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<ApplicationInsightsComponentInner> 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<ApplicationInsightsComponentInner> 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<ApplicationInsightsComponentInner> 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.

    • delete

      void delete(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

      ApplicationInsightsComponentInner 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<ApplicationInsightsComponentInner> 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.

    • createOrUpdate

      ApplicationInsightsComponentInner createOrUpdate(String resourceGroupName, String resourceName, ApplicationInsightsComponentInner insightProperties)
      Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      insightProperties - Properties that need to be specified to create an Application Insights component.
      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.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<ApplicationInsightsComponentInner> createOrUpdateWithResponse(String resourceGroupName, String resourceName, ApplicationInsightsComponentInner insightProperties, com.azure.core.util.Context context)
      Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      insightProperties - Properties that need to be specified to create an Application Insights component.
      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.

    • updateTags

      ApplicationInsightsComponentInner updateTags(String resourceGroupName, String resourceName, TagsResource componentTags)
      Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      componentTags - Updated tag information to set into the component instance.
      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.

    • updateTagsWithResponse

      com.azure.core.http.rest.Response<ApplicationInsightsComponentInner> updateTagsWithResponse(String resourceGroupName, String resourceName, TagsResource componentTags, com.azure.core.util.Context context)
      Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      componentTags - Updated tag information to set into the component instance.
      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

      ComponentPurgeResponseInner 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<ComponentPurgeResponseInner> 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

      ComponentPurgeStatusResponseInner 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<ComponentPurgeStatusResponseInner> 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.