com.azure.resourcemanager.applicationinsights.fluent.ComponentsClient Maven / Gradle / Ivy
Show all versions of azure-resourcemanager-applicationinsights Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.applicationinsights.fluent;
import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.resourcemanager.applicationinsights.fluent.models.ApplicationInsightsComponentInner;
import com.azure.resourcemanager.applicationinsights.fluent.models.ComponentPurgeResponseInner;
import com.azure.resourcemanager.applicationinsights.fluent.models.ComponentPurgeStatusResponseInner;
import com.azure.resourcemanager.applicationinsights.models.ComponentPurgeBody;
import com.azure.resourcemanager.applicationinsights.models.TagsResource;
/** An instance of this class provides access to all the operations defined in ComponentsClient. */
public interface ComponentsClient {
/**
* Gets a list of all Application Insights components within a subscription.
*
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a list of all Application Insights components within a subscription as paginated response with {@link
* PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable list();
/**
* Gets a list of all Application Insights components within a subscription.
*
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a list of all Application Insights components within a subscription as paginated response with {@link
* PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable list(Context context);
/**
* Gets a list of Application Insights components within a resource group.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a list of Application Insights components within a resource group as paginated response with {@link
* PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByResourceGroup(String resourceGroupName);
/**
* Gets a list of Application Insights components within a resource group.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a list of Application Insights components within a resource group as paginated response with {@link
* PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable listByResourceGroup(String resourceGroupName, Context context);
/**
* Deletes an Application Insights component.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
void delete(String resourceGroupName, String resourceName);
/**
* Deletes an Application Insights component.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response deleteWithResponse(String resourceGroupName, String resourceName, Context context);
/**
* Returns an Application Insights component.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an Application Insights component definition.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ApplicationInsightsComponentInner getByResourceGroup(String resourceGroupName, String resourceName);
/**
* Returns an Application Insights component.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an Application Insights component definition along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getByResourceGroupWithResponse(
String resourceGroupName, String resourceName, Context context);
/**
* Creates (or updates) an Application Insights component. Note: You cannot specify a different value for
* InstrumentationKey nor AppId in the Put operation.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param insightProperties Properties that need to be specified to create an Application Insights component.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an Application Insights component definition.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ApplicationInsightsComponentInner createOrUpdate(
String resourceGroupName, String resourceName, ApplicationInsightsComponentInner insightProperties);
/**
* Creates (or updates) an Application Insights component. Note: You cannot specify a different value for
* InstrumentationKey nor AppId in the Put operation.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param insightProperties Properties that need to be specified to create an Application Insights component.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an Application Insights component definition along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response createOrUpdateWithResponse(
String resourceGroupName,
String resourceName,
ApplicationInsightsComponentInner insightProperties,
Context context);
/**
* Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param componentTags Updated tag information to set into the component instance.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an Application Insights component definition.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ApplicationInsightsComponentInner updateTags(
String resourceGroupName, String resourceName, TagsResource componentTags);
/**
* Updates an existing component's tags. To update other fields use the CreateOrUpdate method.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param componentTags Updated tag information to set into the component instance.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an Application Insights component definition along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response updateTagsWithResponse(
String resourceGroupName, String resourceName, TagsResource componentTags, Context context);
/**
* Purges data in an Application Insights component by a set of user-defined filters.
*
* In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch
* the execution of purge requests by sending a single command whose predicate includes all user identities that
* require purging. Use the in operator to specify multiple identities. You should run the query prior to using for
* a purge request to verify that the results are expected.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param body Describes the body of a request to purge data in a single table of an Application Insights component.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return response containing operationId for a specific purge action.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ComponentPurgeResponseInner purge(String resourceGroupName, String resourceName, ComponentPurgeBody body);
/**
* Purges data in an Application Insights component by a set of user-defined filters.
*
*
In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch
* the execution of purge requests by sending a single command whose predicate includes all user identities that
* require purging. Use the in operator to specify multiple identities. You should run the query prior to using for
* a purge request to verify that the results are expected.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param body Describes the body of a request to purge data in a single table of an Application Insights component.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return response containing operationId for a specific purge action along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response purgeWithResponse(
String resourceGroupName, String resourceName, ComponentPurgeBody body, Context context);
/**
* Get status for an ongoing purge operation.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param purgeId In a purge status request, this is the Id of the operation the status of which is returned.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return status for an ongoing purge operation.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ComponentPurgeStatusResponseInner getPurgeStatus(String resourceGroupName, String resourceName, String purgeId);
/**
* Get status for an ongoing purge operation.
*
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param resourceName The name of the Application Insights component resource.
* @param purgeId In a purge status request, this is the Id of the operation the status of which is returned.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return status for an ongoing purge operation along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response getPurgeStatusWithResponse(
String resourceGroupName, String resourceName, String purgeId, Context context);
}