Interface MyWorkbooksClient


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

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<MyWorkbookInner> listByResourceGroup(String resourceGroupName, CategoryType category)
      Get all private workbooks defined within a specified resource group and category.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      category - Category of workbook to return.
      Returns:
      all private workbooks defined within a specified resource group and category as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - 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<MyWorkbookInner> listByResourceGroup(String resourceGroupName, CategoryType category, List<String> tags, String sourceId, Boolean canFetchContent, com.azure.core.util.Context context)
      Get all private workbooks defined within a specified resource group and category.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      category - Category of workbook to return.
      tags - Tags presents on each workbook returned.
      sourceId - Azure Resource Id that will fetch all linked workbooks.
      canFetchContent - Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
      context - The context to associate with this operation.
      Returns:
      all private workbooks defined within a specified resource group and category as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - 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<MyWorkbookInner> list(CategoryType category)
      Get all private workbooks defined within a specified subscription and category.
      Parameters:
      category - Category of workbook to return.
      Returns:
      all private workbooks defined within a specified subscription and category as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - 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<MyWorkbookInner> list(CategoryType category, List<String> tags, Boolean canFetchContent, com.azure.core.util.Context context)
      Get all private workbooks defined within a specified subscription and category.
      Parameters:
      category - Category of workbook to return.
      tags - Tags presents on each workbook returned.
      canFetchContent - Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
      context - The context to associate with this operation.
      Returns:
      all private workbooks defined within a specified subscription and category as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • getByResourceGroup

      MyWorkbookInner getByResourceGroup(String resourceGroupName, String resourceName)
      Get a single private workbook by its resourceName.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      Returns:
      a single private workbook by its resourceName.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - 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<MyWorkbookInner> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)
      Get a single private workbook by its resourceName.
      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:
      a single private workbook by its resourceName along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - 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)
      Delete a private workbook.
      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.
      ErrorDefinitionException - 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)
      Delete a private workbook.
      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.
      ErrorDefinitionException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • createOrUpdate

      MyWorkbookInner createOrUpdate(String resourceGroupName, String resourceName, MyWorkbookInner workbookProperties)
      Create a new private workbook.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      workbookProperties - Properties that need to be specified to create a new private workbook.
      Returns:
      an Application Insights private workbook definition.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - 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<MyWorkbookInner> createOrUpdateWithResponse(String resourceGroupName, String resourceName, MyWorkbookInner workbookProperties, String sourceId, com.azure.core.util.Context context)
      Create a new private workbook.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      workbookProperties - Properties that need to be specified to create a new private workbook.
      sourceId - Azure Resource Id that will fetch all linked workbooks.
      context - The context to associate with this operation.
      Returns:
      an Application Insights private workbook definition along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • update

      MyWorkbookInner update(String resourceGroupName, String resourceName, MyWorkbookInner workbookProperties)
      Updates a private workbook that has already been added.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      workbookProperties - Properties that need to be specified to create a new private workbook.
      Returns:
      an Application Insights private workbook definition.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.
    • updateWithResponse

      com.azure.core.http.rest.Response<MyWorkbookInner> updateWithResponse(String resourceGroupName, String resourceName, MyWorkbookInner workbookProperties, String sourceId, com.azure.core.util.Context context)
      Updates a private workbook that has already been added.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      resourceName - The name of the Application Insights component resource.
      workbookProperties - Properties that need to be specified to create a new private workbook.
      sourceId - Azure Resource Id that will fetch all linked workbooks.
      context - The context to associate with this operation.
      Returns:
      an Application Insights private workbook definition along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      ErrorDefinitionException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.