Package com.azure.resourcemanager.applicationinsights.fluent

Interface WorkbookTemplatesClient

public interface WorkbookTemplatesClient

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

Method Summary

Modifier and Type	Method	Description
WorkbookTemplateInner	createOrUpdate(String resourceGroupName, String resourceName, WorkbookTemplateInner workbookTemplateProperties)	Create a new workbook template.
com.azure.core.http.rest.Response<WorkbookTemplateInner>	createOrUpdateWithResponse(String resourceGroupName, String resourceName, WorkbookTemplateInner workbookTemplateProperties, com.azure.core.util.Context context)	Create a new workbook template.
void	delete(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.
WorkbookTemplateInner	getByResourceGroup(String resourceGroupName, String resourceName)	Get a single workbook template by its resourceName.
com.azure.core.http.rest.Response<WorkbookTemplateInner>	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<WorkbookTemplateInner>	listByResourceGroup(String resourceGroupName)	Get all Workbook templates defined within a specified resource group.
com.azure.core.http.rest.PagedIterable<WorkbookTemplateInner>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	Get all Workbook templates defined within a specified resource group.
WorkbookTemplateInner	update(String resourceGroupName, String resourceName)	Updates a workbook template that has already been added.
com.azure.core.http.rest.Response<WorkbookTemplateInner>	updateWithResponse(String resourceGroupName, String resourceName, WorkbookTemplateUpdateParameters workbookTemplateUpdateParameters, com.azure.core.util.Context context)	Updates a workbook template that has already been added.

Method Detail

listByResourceGroup

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

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

delete

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

createOrUpdate

WorkbookTemplateInner createOrUpdate(String resourceGroupName,
                                     String resourceName,
                                     WorkbookTemplateInner workbookTemplateProperties)

Create a new workbook template.

Parameters:

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

resourceName - The name of the Application Insights component resource.

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

Returns:

an Application Insights workbook template definition.

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.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<WorkbookTemplateInner> createOrUpdateWithResponse(String resourceGroupName,
                                                                                    String resourceName,
                                                                                    WorkbookTemplateInner workbookTemplateProperties,
                                                                                    com.azure.core.util.Context context)

Create a new workbook template.

Parameters:

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

resourceName - The name of the Application Insights component resource.

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

context - The context to associate with this operation.

Returns:

an Application Insights workbook template definition 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.

update

WorkbookTemplateInner update(String resourceGroupName,
                             String resourceName)

Updates a workbook template 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 template definition.

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.

updateWithResponse

com.azure.core.http.rest.Response<WorkbookTemplateInner> updateWithResponse(String resourceGroupName,
                                                                            String resourceName,
                                                                            WorkbookTemplateUpdateParameters workbookTemplateUpdateParameters,
                                                                            com.azure.core.util.Context context)

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

workbookTemplateUpdateParameters - Properties that need to be specified to patch a workbook template.

context - The context to associate with this operation.

Returns:

an Application Insights workbook template definition 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.