Components Interface

Package:

com.azure.resourcemanager.applicationinsights.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-applicationinsights:1.1.0

public interface Components

Resource collection API of Components.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new ApplicationInsightsComponent resource.
abstract void	deleteById(String id) Deletes an Application Insights component.
abstract Response<Void>	deleteByIdWithResponse(String id, Context context) Deletes an Application Insights component.
abstract void	deleteByResourceGroup(String resourceGroupName, String resourceName) Deletes an Application Insights component.
abstract Response<Void>	deleteByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context) Deletes an Application Insights component.
abstract ApplicationInsightsComponent	getById(String id) Returns an Application Insights component.
abstract Response<ApplicationInsightsComponent>	getByIdWithResponse(String id, Context context) Returns an Application Insights component.
abstract ApplicationInsightsComponent	getByResourceGroup(String resourceGroupName, String resourceName) Returns an Application Insights component.
abstract Response<ApplicationInsightsComponent>	getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context) Returns an Application Insights component.
abstract ComponentPurgeStatusResponse	getPurgeStatus(String resourceGroupName, String resourceName, String purgeId) Get status for an ongoing purge operation.
abstract Response<ComponentPurgeStatusResponse>	getPurgeStatusWithResponse(String resourceGroupName, String resourceName, String purgeId, Context context) Get status for an ongoing purge operation.
abstract PagedIterable<ApplicationInsightsComponent>	list() Gets a list of all Application Insights components within a subscription.
abstract PagedIterable<ApplicationInsightsComponent>	list(Context context) Gets a list of all Application Insights components within a subscription.
abstract PagedIterable<ApplicationInsightsComponent>	listByResourceGroup(String resourceGroupName) Gets a list of Application Insights components within a resource group.
abstract PagedIterable<ApplicationInsightsComponent>	listByResourceGroup(String resourceGroupName, Context context) Gets a list of Application Insights components within a resource group.
abstract ComponentPurgeResponse	purge(String resourceGroupName, String resourceName, ComponentPurgeBody body) Purges data in an Application Insights component by a set of user-defined filters.
abstract Response<ComponentPurgeResponse>	purgeWithResponse(String resourceGroupName, String resourceName, ComponentPurgeBody body, Context context) Purges data in an Application Insights component by a set of user-defined filters.

Method Details

define

public abstract ApplicationInsightsComponent.DefinitionStages.Blank define(String name)

Begins definition for a new ApplicationInsightsComponent resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ApplicationInsightsComponent definition.

deleteById

public abstract void deleteById(String id)

Deletes an Application Insights component.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response<Void> deleteByIdWithResponse(String id, Context context)

Deletes an Application Insights component.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)

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

deleteByResourceGroupWithResponse

public abstract Response<Void> deleteByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

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

context - The context to associate with this operation.

Returns:

the Response<T>.

getById

public abstract ApplicationInsightsComponent getById(String id)

Returns an Application Insights component.

Parameters:

id - the resource ID.

Returns:

an Application Insights component definition along with Response<T>.

getByIdWithResponse

public abstract Response<ApplicationInsightsComponent> getByIdWithResponse(String id, Context context)

Returns an Application Insights component.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

an Application Insights component definition along with Response<T>.

getByResourceGroup

public abstract ApplicationInsightsComponent getByResourceGroup(String resourceGroupName, String resourceName)

Returns 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:

an Application Insights component definition.

getByResourceGroupWithResponse

public abstract Response<ApplicationInsightsComponent> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)

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

context - The context to associate with this operation.

Returns:

an Application Insights component definition along with Response<T>.

getPurgeStatus

public abstract ComponentPurgeStatusResponse getPurgeStatus(String resourceGroupName, String resourceName, String purgeId)

Get status for an ongoing purge operation.

Parameters:

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

resourceName - The name of the Application Insights component resource.

purgeId - In a purge status request, this is the Id of the operation the status of which is returned.

Returns:

status for an ongoing purge operation.

getPurgeStatusWithResponse

public abstract Response<ComponentPurgeStatusResponse> getPurgeStatusWithResponse(String resourceGroupName, String resourceName, String purgeId, Context context)

Get status for an ongoing purge operation.

Parameters:

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

resourceName - The name of the Application Insights component resource.

purgeId - In a purge status request, this is the Id of the operation the status of which is returned.

context - The context to associate with this operation.

Returns:

status for an ongoing purge operation along with Response<T>.

list

public abstract PagedIterable<ApplicationInsightsComponent> list()

Gets a list of all Application Insights components within a subscription.

Returns:

a list of all Application Insights components within a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ApplicationInsightsComponent> list(Context context)

Gets a list of all Application Insights components within a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

a list of all Application Insights components within a subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ApplicationInsightsComponent> listByResourceGroup(String resourceGroupName)

Gets a list of Application Insights components within a resource group.

Parameters:

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

Returns:

a list of Application Insights components within a resource group as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<ApplicationInsightsComponent> listByResourceGroup(String resourceGroupName, Context context)

Gets a list of Application Insights components within a resource group.

Parameters:

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

context - The context to associate with this operation.

Returns:

a list of Application Insights components within a resource group as paginated response with PagedIterable<T>.

purge

public abstract ComponentPurgeResponse 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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.

Parameters:

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

resourceName - The name of the Application Insights component resource.

body - Describes the body of a request to purge data in a single table of an Application Insights component.

Returns:

response containing operationId for a specific purge action.

purgeWithResponse

public abstract Response<ComponentPurgeResponse> purgeWithResponse(String resourceGroupName, String resourceName, ComponentPurgeBody body, 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. Note: this operation is intended for Classic resources, for workspace-based Application Insights resource please run purge operation (directly on the workspace)(https://docs.microsoft.com/en-us/rest/api/loganalytics/workspace-purge/purge) , scoped to specific resource id.

Parameters:

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

resourceName - The name of the Application Insights component resource.

body - Describes the body of a request to purge data in a single table of an Application Insights component.

context - The context to associate with this operation.

Returns:

response containing operationId for a specific purge action along with Response<T>.