Package com.azure.resourcemanager.applicationinsights.fluent

Interface WorkbooksClient

public interface WorkbooksClient

An instance of this class provides access to all the operations defined in WorkbooksClient.

Method Summary

Modifier and Type	Method	Description
WorkbookInner	createOrUpdate(String resourceGroupName, String resourceName, WorkbookInner workbookProperties)	Create a new workbook.
com.azure.core.http.rest.Response<WorkbookInner>	createOrUpdateWithResponse(String resourceGroupName, String resourceName, WorkbookInner workbookProperties, String sourceId, com.azure.core.util.Context context)	Create a new workbook.
void	delete(String resourceGroupName, String resourceName)	Delete a workbook.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Delete a workbook.
WorkbookInner	getByResourceGroup(String resourceGroupName, String resourceName)	Get a single workbook by its resourceName.
com.azure.core.http.rest.Response<WorkbookInner>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Boolean canFetchContent, com.azure.core.util.Context context)	Get a single workbook by its resourceName.
com.azure.core.http.rest.PagedIterable<WorkbookInner>	list(CategoryType category)	Get all Workbooks defined within a specified subscription and category.
com.azure.core.http.rest.PagedIterable<WorkbookInner>	list(CategoryType category, List<String> tags, Boolean canFetchContent, com.azure.core.util.Context context)	Get all Workbooks defined within a specified subscription and category.
com.azure.core.http.rest.PagedIterable<WorkbookInner>	listByResourceGroup(String resourceGroupName, CategoryType category)	Get all Workbooks defined within a specified resource group and category.
com.azure.core.http.rest.PagedIterable<WorkbookInner>	listByResourceGroup(String resourceGroupName, CategoryType category, List<String> tags, String sourceId, Boolean canFetchContent, com.azure.core.util.Context context)	Get all Workbooks defined within a specified resource group and category.
WorkbookInner	revisionGet(String resourceGroupName, String resourceName, String revisionId)	Get a single workbook revision defined by its revisionId.
com.azure.core.http.rest.Response<WorkbookInner>	revisionGetWithResponse(String resourceGroupName, String resourceName, String revisionId, com.azure.core.util.Context context)	Get a single workbook revision defined by its revisionId.
com.azure.core.http.rest.PagedIterable<WorkbookInner>	revisionsList(String resourceGroupName, String resourceName)	Get the revisions for the workbook defined by its resourceName.
com.azure.core.http.rest.PagedIterable<WorkbookInner>	revisionsList(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Get the revisions for the workbook defined by its resourceName.
WorkbookInner	update(String resourceGroupName, String resourceName)	Updates a workbook that has already been added.
com.azure.core.http.rest.Response<WorkbookInner>	updateWithResponse(String resourceGroupName, String resourceName, String sourceId, WorkbookUpdateParameters workbookUpdateParameters, com.azure.core.util.Context context)	Updates a workbook that has already been added.

Method Detail

list

com.azure.core.http.rest.PagedIterable<WorkbookInner> list(CategoryType category)

Get all Workbooks defined within a specified subscription and category.

Parameters:

category - Category of workbook to return.

Returns:

all Workbooks defined within a specified subscription and category as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - 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<WorkbookInner> list(CategoryType category,
                                                           List<String> tags,
                                                           Boolean canFetchContent,
                                                           com.azure.core.util.Context context)

Get all 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 Workbooks defined within a specified subscription and category as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - 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<WorkbookInner> listByResourceGroup(String resourceGroupName,
                                                                          CategoryType category)

Get all 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 Workbooks defined within a specified resource group and category as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - 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<WorkbookInner> listByResourceGroup(String resourceGroupName,
                                                                          CategoryType category,
                                                                          List<String> tags,
                                                                          String sourceId,
                                                                          Boolean canFetchContent,
                                                                          com.azure.core.util.Context context)

Get all 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 Workbooks defined within a specified resource group and category as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getByResourceGroup

WorkbookInner getByResourceGroup(String resourceGroupName,
                                 String resourceName)

Get a single 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 workbook by its resourceName.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - 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<WorkbookInner> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                String resourceName,
                                                                                Boolean canFetchContent,
                                                                                com.azure.core.util.Context context)

Get a single 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.

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:

a single workbook by its resourceName along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

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

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

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

WorkbookInner createOrUpdate(String resourceGroupName,
                             String resourceName,
                             WorkbookInner workbookProperties)

Create a new 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 workbook.

Returns:

an Application Insights workbook definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - 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<WorkbookInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                            String resourceName,
                                                                            WorkbookInner workbookProperties,
                                                                            String sourceId,
                                                                            com.azure.core.util.Context context)

Create a new 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 workbook.

sourceId - Azure Resource Id that will fetch all linked workbooks.

context - The context to associate with this operation.

Returns:

an Application Insights workbook definition along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

WorkbookInner update(String resourceGroupName,
                     String resourceName)

Updates a 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.

Returns:

an Application Insights workbook definition.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - 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<WorkbookInner> updateWithResponse(String resourceGroupName,
                                                                    String resourceName,
                                                                    String sourceId,
                                                                    WorkbookUpdateParameters workbookUpdateParameters,
                                                                    com.azure.core.util.Context context)

Updates a 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.

sourceId - Azure Resource Id that will fetch all linked workbooks.

workbookUpdateParameters - Properties that need to be specified to create a new workbook.

context - The context to associate with this operation.

Returns:

an Application Insights workbook definition along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

revisionsList

com.azure.core.http.rest.PagedIterable<WorkbookInner> revisionsList(String resourceGroupName,
                                                                    String resourceName)

Get the revisions for the workbook defined 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:

the revisions for the workbook defined by its resourceName as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

revisionsList

com.azure.core.http.rest.PagedIterable<WorkbookInner> revisionsList(String resourceGroupName,
                                                                    String resourceName,
                                                                    com.azure.core.util.Context context)

Get the revisions for the workbook defined 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:

the revisions for the workbook defined by its resourceName as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

revisionGet

WorkbookInner revisionGet(String resourceGroupName,
                          String resourceName,
                          String revisionId)

Get a single workbook revision defined by its revisionId.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the Application Insights component resource.

revisionId - The id of the workbook's revision.

Returns:

a single workbook revision defined by its revisionId.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

revisionGetWithResponse

com.azure.core.http.rest.Response<WorkbookInner> revisionGetWithResponse(String resourceGroupName,
                                                                         String resourceName,
                                                                         String revisionId,
                                                                         com.azure.core.util.Context context)

Get a single workbook revision defined by its revisionId.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

resourceName - The name of the Application Insights component resource.

revisionId - The id of the workbook's revision.

context - The context to associate with this operation.

Returns:

a single workbook revision defined by its revisionId along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

WorkbookErrorDefinitionException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.