Package com.azure.resourcemanager.applicationinsights.models

Interface MyWorkbooks

public interface MyWorkbooks

Resource collection API of MyWorkbooks.

Method Summary

Modifier and Type	Method	Description
MyWorkbook.DefinitionStages.Blank	define(String name)	Begins definition for a new MyWorkbook resource.
void	deleteById(String id)	Delete a private workbook.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a private workbook.
void	deleteByResourceGroup(String resourceGroupName, String resourceName)	Delete a private workbook.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Delete a private workbook.
MyWorkbook	getById(String id)	Get a single private workbook by its resourceName.
com.azure.core.http.rest.Response<MyWorkbook>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a single private workbook by its resourceName.
MyWorkbook	getByResourceGroup(String resourceGroupName, String resourceName)	Get a single private workbook by its resourceName.
com.azure.core.http.rest.Response<MyWorkbook>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Get a single private workbook by its resourceName.
com.azure.core.http.rest.PagedIterable<MyWorkbook>	list(CategoryType category)	Get all private workbooks defined within a specified subscription and category.
com.azure.core.http.rest.PagedIterable<MyWorkbook>	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.
com.azure.core.http.rest.PagedIterable<MyWorkbook>	listByResourceGroup(String resourceGroupName, CategoryType category)	Get all private workbooks defined within a specified resource group and category.
com.azure.core.http.rest.PagedIterable<MyWorkbook>	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.

Method Detail

listByResourceGroup

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

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

deleteByResourceGroup

void deleteByResourceGroup(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.

getById

MyWorkbook getById(String id)

Get a single private workbook by its resourceName.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<MyWorkbook> getByIdWithResponse(String id,
                                                                  com.azure.core.util.Context context)

Get a single private workbook by its resourceName.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Delete a private workbook.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               com.azure.core.util.Context context)

Delete a private workbook.

Parameters:

id - the resource ID.

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.

define

MyWorkbook.DefinitionStages.Blank define(String name)

Begins definition for a new MyWorkbook resource.

Parameters:

name - resource name.

Returns:

the first stage of the new MyWorkbook definition.