WorkspacesClient Interface

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

public interface WorkspacesClient

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

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Create or update a workspace.
abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Create or update a workspace.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName)

Deletes a workspace resource.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String workspaceName, Boolean force, Context context)

Deletes a workspace resource.
abstract SyncPoller<PollResult<Void>,Void> beginFailback(String resourceGroupName, String workspaceName)

Deactivates failover for the specified workspace.
abstract SyncPoller<PollResult<Void>,Void> beginFailback(String resourceGroupName, String workspaceName, Context context)

Deactivates failover for the specified workspace.
abstract SyncPoller<PollResult<Void>,Void> beginFailover(String resourceGroupName, String location, String workspaceName)

Activates failover for the specified workspace.
abstract SyncPoller<PollResult<Void>,Void> beginFailover(String resourceGroupName, String location, String workspaceName, Context context)

Activates failover for the specified workspace.
abstract SyncPoller<PollResult<Void>,Void> beginReconcileNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName)

Reconcile network security perimeter configuration for Workspace resource.
abstract SyncPoller<PollResult<Void>,Void> beginReconcileNsp(String resourceGroupName, String workspaceName, String networkSecurityPerimeterConfigurationName, Context context)

Reconcile network security perimeter configuration for Workspace resource.
abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Create or update a workspace.
abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Create or update a workspace.
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 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 WorkspaceInner getByResourceGroup(String resourceGroupName, String workspaceName)

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

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

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

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

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

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

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

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

Gets a list of NSP configurations for specified workspace.
abstract PagedIterable<NetworkSecurityPerimeterConfigurationInner> 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.
abstract WorkspaceInner update(String resourceGroupName, String workspaceName, WorkspacePatch parameters)

Updates a workspace.
abstract Response<WorkspaceInner> updateWithResponse(String resourceGroupName, String workspaceName, WorkspacePatch parameters, Context context)

Updates a workspace.

Method Details

beginCreateOrUpdate

public abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Create or update a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
parameters - The parameters required to create or update a workspace.

Returns:

the SyncPoller<T,U> for polling of the top level Workspace resource container.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<WorkspaceInner>,WorkspaceInner> beginCreateOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Create or update a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
parameters - The parameters required to create or update a workspace.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of the top level Workspace resource container.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginFailback

public abstract SyncPoller<PollResult<Void>,Void> beginFailback(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginFailback

public abstract SyncPoller<PollResult<Void>,Void> beginFailback(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginFailover

public abstract SyncPoller<PollResult<Void>,Void> beginFailover(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginFailover

public abstract SyncPoller<PollResult<Void>,Void> beginFailover(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginReconcileNsp

public abstract SyncPoller<PollResult<Void>,Void> beginReconcileNsp(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginReconcileNsp

public abstract SyncPoller<PollResult<Void>,Void> beginReconcileNsp(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

createOrUpdate

public abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters)

Create or update a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
parameters - The parameters required to create or update a workspace.

Returns:

the top level Workspace resource container.

createOrUpdate

public abstract WorkspaceInner createOrUpdate(String resourceGroupName, String workspaceName, WorkspaceInner parameters, Context context)

Create or update a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
parameters - The parameters required to create or update a workspace.
context - The context to associate with this operation.

Returns:

the top level Workspace resource container.

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.

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.

getByResourceGroup

public abstract WorkspaceInner 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<WorkspaceInner> 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 NetworkSecurityPerimeterConfigurationInner 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<NetworkSecurityPerimeterConfigurationInner> 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<WorkspaceInner> list()

Gets the workspaces in a subscription.

Returns:

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

list

public abstract PagedIterable<WorkspaceInner> 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<WorkspaceInner> 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<WorkspaceInner> 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<NetworkSecurityPerimeterConfigurationInner> 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<NetworkSecurityPerimeterConfigurationInner> 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.

update

public abstract WorkspaceInner update(String resourceGroupName, String workspaceName, WorkspacePatch parameters)

Updates a workspace.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
workspaceName - The name of the workspace.
parameters - The parameters required to patch a workspace.

Returns:

the top level Workspace resource container.

updateWithResponse

public abstract Response<WorkspaceInner> updateWithResponse(String resourceGroupName, String workspaceName, WorkspacePatch parameters, Context context)

Updates a workspace.

Parameters:

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

Returns:

the top level Workspace resource container along with Response<T>.

Applies to