Workspaces Interface

Package:
com.azure.resourcemanager.loganalytics.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-loganalytics:2.2.0

public interface Workspaces

Resource collection API of Workspaces.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new Workspace resource.
abstract void delete(String resourceGroupName, String workspaceName)

Deletes a workspace resource.
abstract void delete(String resourceGroupName, String workspaceName, Boolean force, Context context)

Deletes a workspace resource.
abstract void deleteById(String id)

Deletes a workspace resource.
abstract void deleteByIdWithResponse(String id, Boolean force, Context context)

Deletes a workspace resource.
abstract void failback(String resourceGroupName, String workspaceName)

Deactivates failover for the specified workspace.
abstract void failback(String resourceGroupName, String workspaceName, Context context)

Deactivates failover for the specified workspace.
abstract void failover(String resourceGroupName, String location, String workspaceName)

Activates failover for the specified workspace.
abstract void failover(String resourceGroupName, String location, String workspaceName, Context context)

Activates failover for the specified workspace.
abstract Workspace getById(String id)

Gets a workspace instance.
abstract Response<Workspace> getByIdWithResponse(String id, Context context)

Gets a workspace instance.
abstract Workspace getByResourceGroup(String resourceGroupName, String workspaceName)

Gets a workspace instance.
abstract Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Gets a workspace instance.
abstract NetworkSecurityPerimeterConfiguration getNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName)

Gets a network security perimeter configuration.
abstract Response<NetworkSecurityPerimeterConfiguration> getNspWithResponse(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName, Context context)

Gets a network security perimeter configuration.
abstract PagedIterable<Workspace> list()

Gets the workspaces in a subscription.
abstract PagedIterable<Workspace> list(Context context)

Gets the workspaces in a subscription.
abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)

Gets workspaces in a resource group.
abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName, Context context)

Gets workspaces in a resource group.
abstract PagedIterable<NetworkSecurityPerimeterConfiguration> listNsp(String resourceGroupName, String workspaceName)

Gets a list of NSP configurations for specified workspace.
abstract PagedIterable<NetworkSecurityPerimeterConfiguration> listNsp(String resourceGroupName, String workspaceName, Context context)

Gets a list of NSP configurations for specified workspace.
abstract void reconcileNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName)

Reconcile network security perimeter configuration for Workspace resource.
abstract void reconcileNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName, Context context)

Reconcile network security perimeter configuration for Workspace resource.

Method Details

define

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

Begins definition for a new Workspace resource.

Parameters:

name - resource name.

Returns:

the first stage of the new Workspace definition.

delete

public abstract void delete(String resourceGroupName, String workspaceName)

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

Parameters:

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

delete

public abstract void delete(String resourceGroupName, String workspaceName, Boolean force, Context context)

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
force - Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Boolean force, Context context)

Deletes a workspace resource. To recover the workspace, create it again with the same name, in the same subscription, resource group and location. The name is kept for 14 days and cannot be used for another workspace. To remove the workspace completely and release the name, use the force flag.

Parameters:

id - the resource ID.
force - Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.
context - The context to associate with this operation.

failback

public abstract void failback(String resourceGroupName, String workspaceName)

Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

Parameters:

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

failback

public abstract void failback(String resourceGroupName, String workspaceName, Context context)

Deactivates failover for the specified workspace. The failback operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
context - The context to associate with this operation.

failover

public abstract void failover(String resourceGroupName, String location, String workspaceName)

Activates failover for the specified workspace. The specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

Parameters:

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

failover

public abstract void failover(String resourceGroupName, String location, String workspaceName, Context context)

Activates failover for the specified workspace. The specified replication location must match the location of the enabled replication for this workspace. The failover operation is asynchronous and can take up to 30 minutes to complete. The status of the operation can be checked using the operationId returned in the response.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
location - The location name.
workspaceName - The name of the workspace.
context - The context to associate with this operation.

getById

public abstract Workspace getById(String id)

Gets a workspace instance.

Parameters:

id - the resource ID.

Returns:

a workspace instance along with Response<T>.

getByIdWithResponse

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

Gets a workspace instance.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a workspace instance along with Response<T>.

getByResourceGroup

public abstract Workspace getByResourceGroup(String resourceGroupName, String workspaceName)

Gets a workspace instance.

Parameters:

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

Returns:

a workspace instance.

getByResourceGroupWithResponse

public abstract Response<Workspace> getByResourceGroupWithResponse(String resourceGroupName, String workspaceName, Context context)

Gets a workspace instance.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
context - The context to associate with this operation.

Returns:

a workspace instance along with Response<T>.

getNsp

public abstract NetworkSecurityPerimeterConfiguration getNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName)

Gets a network security perimeter configuration.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
networkSecurityPerimeterConfigurationName - The name for a network security perimeter configuration.

Returns:

a network security perimeter configuration.

getNspWithResponse

public abstract Response<NetworkSecurityPerimeterConfiguration> getNspWithResponse(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName, Context context)

Gets a network security perimeter configuration.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
networkSecurityPerimeterConfigurationName - The name for a network security perimeter configuration.
context - The context to associate with this operation.

Returns:

a network security perimeter configuration along with Response<T>.

list

public abstract PagedIterable<Workspace> list()

Gets the workspaces in a subscription.

Returns:

the workspaces in a subscription as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<Workspace> list(Context context)

Gets the workspaces in a subscription.

Parameters:

context - The context to associate with this operation.

Returns:

the workspaces in a subscription as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<Workspace> listByResourceGroup(String resourceGroupName)

Gets workspaces in a resource group.

Parameters:

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

Returns:

workspaces in a resource group as paginated response with PagedIterable<T>.

listByResourceGroup

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

Gets workspaces in 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:

workspaces in a resource group as paginated response with PagedIterable<T>.

listNsp

public abstract PagedIterable<NetworkSecurityPerimeterConfiguration> listNsp(String resourceGroupName, String workspaceName)

Gets a list of NSP configurations for specified workspace.

Parameters:

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

Returns:

a list of NSP configurations for specified workspace as paginated response with PagedIterable<T>.

listNsp

public abstract PagedIterable<NetworkSecurityPerimeterConfiguration> listNsp(String resourceGroupName, String workspaceName, Context context)

Gets a list of NSP configurations for specified workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
context - The context to associate with this operation.

Returns:

a list of NSP configurations for specified workspace as paginated response with PagedIterable<T>.

reconcileNsp

public abstract void reconcileNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName)

Reconcile network security perimeter configuration for Workspace resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
networkSecurityPerimeterConfigurationName - The name for a network security perimeter configuration.

reconcileNsp

public abstract void reconcileNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName, Context context)

Reconcile network security perimeter configuration for Workspace resource.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
networkSecurityPerimeterConfigurationName - The name for a network security perimeter configuration.
context - The context to associate with this operation.

Applies to