Interface AnnotationsClient


public interface AnnotationsClient
An instance of this class provides access to all the operations defined in AnnotationsClient.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<AnnotationInner> list(String resourceGroupName, String resourceName, String start, String end)
      Gets the list of annotations for a component for given time range.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      start - The start time to query from for annotations, cannot be older than 90 days from current date.
      end - The end time to query for annotations.
      Returns:
      the list of annotations for a component for given time range as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      AnnotationErrorException - 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<AnnotationInner> list(String resourceGroupName, String resourceName, String start, String end, com.azure.core.util.Context context)
      Gets the list of annotations for a component for given time range.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      start - The start time to query from for annotations, cannot be older than 90 days from current date.
      end - The end time to query for annotations.
      context - The context to associate with this operation.
      Returns:
      the list of annotations for a component for given time range as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      AnnotationErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • create

      List<AnnotationInner> create(String resourceGroupName, String resourceName, AnnotationInner annotationProperties)
      Create an Annotation of 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.
      annotationProperties - Properties that need to be specified to create an annotation of a Application Insights component.
      Returns:
      array of Annotation.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      AnnotationErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createWithResponse

      com.azure.core.http.rest.Response<List<AnnotationInner>> createWithResponse(String resourceGroupName, String resourceName, AnnotationInner annotationProperties, com.azure.core.util.Context context)
      Create an Annotation of 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.
      annotationProperties - Properties that need to be specified to create an annotation of a Application Insights component.
      context - The context to associate with this operation.
      Returns:
      array of Annotation along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      AnnotationErrorException - 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, String annotationId)
      Delete an Annotation of 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.
      annotationId - The unique annotation ID. This is unique within a Application Insights component.
      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, String annotationId, com.azure.core.util.Context context)
      Delete an Annotation of 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.
      annotationId - The unique annotation ID. This is unique within a Application Insights component.
      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.
    • get

      List<AnnotationInner> get(String resourceGroupName, String resourceName, String annotationId)
      Get the annotation for given id.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      annotationId - The unique annotation ID. This is unique within a Application Insights component.
      Returns:
      the annotation for given id.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      AnnotationErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getWithResponse

      com.azure.core.http.rest.Response<List<AnnotationInner>> getWithResponse(String resourceGroupName, String resourceName, String annotationId, com.azure.core.util.Context context)
      Get the annotation for given id.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      annotationId - The unique annotation ID. This is unique within a Application Insights component.
      context - The context to associate with this operation.
      Returns:
      the annotation for given id along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      AnnotationErrorException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.