Package com.azure.resourcemanager.applicationinsights.models

Interface WorkbookTemplates

public interface WorkbookTemplates

Resource collection API of WorkbookTemplates.

Method Summary

Modifier and Type	Method	Description
WorkbookTemplate.DefinitionStages.Blank	define(String name)	Begins definition for a new WorkbookTemplate resource.
void	deleteById(String id)	Delete a workbook template.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete a workbook template.
void	deleteByResourceGroup(String resourceGroupName, String resourceName)	Delete a workbook template.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Delete a workbook template.
WorkbookTemplate	getById(String id)	Get a single workbook template by its resourceName.
com.azure.core.http.rest.Response<WorkbookTemplate>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get a single workbook template by its resourceName.
WorkbookTemplate	getByResourceGroup(String resourceGroupName, String resourceName)	Get a single workbook template by its resourceName.
com.azure.core.http.rest.Response<WorkbookTemplate>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, com.azure.core.util.Context context)	Get a single workbook template by its resourceName.
com.azure.core.http.rest.PagedIterable<WorkbookTemplate>	listByResourceGroup(String resourceGroupName)	Get all Workbook templates defined within a specified resource group.
com.azure.core.http.rest.PagedIterable<WorkbookTemplate>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Get all Workbook templates defined within a specified resource group.

Method Detail

listByResourceGroup

com.azure.core.http.rest.PagedIterable<WorkbookTemplate> listByResourceGroup(String resourceGroupName)

Get all Workbook templates defined within a specified resource group.

Parameters:

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

Returns:

all Workbook templates defined within a specified 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<WorkbookTemplate> listByResourceGroup(String resourceGroupName,
                                                                             com.azure.core.util.Context context)

Get all Workbook templates defined within a specified resource group.

Parameters:

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

context - The context to associate with this operation.

Returns:

all Workbook templates defined within a specified 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.

getByResourceGroup

WorkbookTemplate getByResourceGroup(String resourceGroupName,
                                    String resourceName)

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

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

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

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String resourceName)

Delete a workbook template.

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)

Delete a workbook template.

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.

getById

WorkbookTemplate getById(String id)

Get a single workbook template by its resourceName.

Parameters:

id - the resource ID.

Returns:

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

getByIdWithResponse

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

Get a single workbook template by its resourceName.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

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

deleteById

void deleteById(String id)

Delete a workbook template.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

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

Delete a workbook template.

Parameters:

id - the resource ID.

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.

define

WorkbookTemplate.DefinitionStages.Blank define(String name)

Begins definition for a new WorkbookTemplate resource.

Parameters:

name - resource name.

Returns:

the first stage of the new WorkbookTemplate definition.