Package com.azure.resourcemanager.applicationinsights.fluent

Interface FavoritesClient

public interface FavoritesClient

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

Method Summary

Modifier and Type	Method	Description
ApplicationInsightsComponentFavoriteInner	add(String resourceGroupName, String resourceName, String favoriteId, ApplicationInsightsComponentFavoriteInner favoriteProperties)	Adds a new favorites to an Application Insights component.
com.azure.core.http.rest.Response<ApplicationInsightsComponentFavoriteInner>	addWithResponse(String resourceGroupName, String resourceName, String favoriteId, ApplicationInsightsComponentFavoriteInner favoriteProperties, com.azure.core.util.Context context)	Adds a new favorites to an Application Insights component.
void	delete(String resourceGroupName, String resourceName, String favoriteId)	Remove a favorite that is associated to an Application Insights component.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String resourceName, String favoriteId, com.azure.core.util.Context context)	Remove a favorite that is associated to an Application Insights component.
ApplicationInsightsComponentFavoriteInner	get(String resourceGroupName, String resourceName, String favoriteId)	Get a single favorite by its FavoriteId, defined within an Application Insights component.
com.azure.core.http.rest.Response<ApplicationInsightsComponentFavoriteInner>	getWithResponse(String resourceGroupName, String resourceName, String favoriteId, com.azure.core.util.Context context)	Get a single favorite by its FavoriteId, defined within an Application Insights component.
List<ApplicationInsightsComponentFavoriteInner>	list(String resourceGroupName, String resourceName)	Gets a list of favorites defined within an Application Insights component.
com.azure.core.http.rest.Response<List<ApplicationInsightsComponentFavoriteInner>>	listWithResponse(String resourceGroupName, String resourceName, FavoriteType favoriteType, FavoriteSourceType sourceType, Boolean canFetchContent, List<String> tags, com.azure.core.util.Context context)	Gets a list of favorites defined within an Application Insights component.
ApplicationInsightsComponentFavoriteInner	update(String resourceGroupName, String resourceName, String favoriteId, ApplicationInsightsComponentFavoriteInner favoriteProperties)	Updates a favorite that has already been added to an Application Insights component.
com.azure.core.http.rest.Response<ApplicationInsightsComponentFavoriteInner>	updateWithResponse(String resourceGroupName, String resourceName, String favoriteId, ApplicationInsightsComponentFavoriteInner favoriteProperties, com.azure.core.util.Context context)	Updates a favorite that has already been added to an Application Insights component.

Method Detail

list

List<ApplicationInsightsComponentFavoriteInner> list(String resourceGroupName,
                                                     String resourceName)

Gets a list of favorites defined within an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

Returns:

a list of favorites defined within an Application Insights component.

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.

listWithResponse

com.azure.core.http.rest.Response<List<ApplicationInsightsComponentFavoriteInner>> listWithResponse(String resourceGroupName,
                                                                                                    String resourceName,
                                                                                                    FavoriteType favoriteType,
                                                                                                    FavoriteSourceType sourceType,
                                                                                                    Boolean canFetchContent,
                                                                                                    List<String> tags,
                                                                                                    com.azure.core.util.Context context)

Gets a list of favorites defined within an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteType - The type of favorite. Value can be either shared or user.

sourceType - Source type of favorite to return. When left out, the source type defaults to 'other' (not present in this enum).

canFetchContent - Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites.

tags - Tags that must be present on each favorite returned.

context - The context to associate with this operation.

Returns:

a list of favorites defined within an Application Insights component 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.

get

ApplicationInsightsComponentFavoriteInner get(String resourceGroupName,
                                              String resourceName,
                                              String favoriteId)

Get a single favorite by its FavoriteId, defined within an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

Returns:

a single favorite by its FavoriteId, defined within an Application Insights component.

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.

getWithResponse

com.azure.core.http.rest.Response<ApplicationInsightsComponentFavoriteInner> getWithResponse(String resourceGroupName,
                                                                                             String resourceName,
                                                                                             String favoriteId,
                                                                                             com.azure.core.util.Context context)

Get a single favorite by its FavoriteId, defined within an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

context - The context to associate with this operation.

Returns:

a single favorite by its FavoriteId, defined within an Application Insights component 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.

add

ApplicationInsightsComponentFavoriteInner add(String resourceGroupName,
                                              String resourceName,
                                              String favoriteId,
                                              ApplicationInsightsComponentFavoriteInner favoriteProperties)

Adds a new favorites to an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

favoriteProperties - Properties that need to be specified to create a new favorite and add it to an Application Insights component.

Returns:

properties that define a favorite that is associated to an Application Insights component.

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.

addWithResponse

com.azure.core.http.rest.Response<ApplicationInsightsComponentFavoriteInner> addWithResponse(String resourceGroupName,
                                                                                             String resourceName,
                                                                                             String favoriteId,
                                                                                             ApplicationInsightsComponentFavoriteInner favoriteProperties,
                                                                                             com.azure.core.util.Context context)

Adds a new favorites to an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

favoriteProperties - Properties that need to be specified to create a new favorite and add it to an Application Insights component.

context - The context to associate with this operation.

Returns:

properties that define a favorite that is associated to an Application Insights component 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

ApplicationInsightsComponentFavoriteInner update(String resourceGroupName,
                                                 String resourceName,
                                                 String favoriteId,
                                                 ApplicationInsightsComponentFavoriteInner favoriteProperties)

Updates a favorite that has already been added to an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

favoriteProperties - Properties that need to be specified to update the existing favorite.

Returns:

properties that define a favorite that is associated to an Application Insights component.

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<ApplicationInsightsComponentFavoriteInner> updateWithResponse(String resourceGroupName,
                                                                                                String resourceName,
                                                                                                String favoriteId,
                                                                                                ApplicationInsightsComponentFavoriteInner favoriteProperties,
                                                                                                com.azure.core.util.Context context)

Updates a favorite that has already been added to an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

favoriteProperties - Properties that need to be specified to update the existing favorite.

context - The context to associate with this operation.

Returns:

properties that define a favorite that is associated to an Application Insights component 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,
            String favoriteId)

Remove a favorite that is associated to an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

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,
                                                           String favoriteId,
                                                           com.azure.core.util.Context context)

Remove a favorite that is associated to an Application Insights component.

Parameters:

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

resourceName - The name of the Application Insights component resource.

favoriteId - The Id of a specific favorite defined in the Application Insights component.

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.