MockableOperationalInsightsResourceGroupResource.FailoverWorkspace Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/locations/{location}/workspaces/{workspaceName}/failover
- Operation Id: Workspaces_Failover
- Default Api Version: 2025-02-01
- Resource: OperationalInsightsWorkspaceResource
public virtual Azure.ResourceManager.ArmOperation FailoverWorkspace(Azure.WaitUntil waitUntil, Azure.Core.AzureLocation location, string workspaceName, System.Threading.CancellationToken cancellationToken = default);
abstract member FailoverWorkspace : Azure.WaitUntil * Azure.Core.AzureLocation * string * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
override this.FailoverWorkspace : Azure.WaitUntil * Azure.Core.AzureLocation * string * System.Threading.CancellationToken -> Azure.ResourceManager.ArmOperation
Public Overridable Function FailoverWorkspace (waitUntil As WaitUntil, location As AzureLocation, workspaceName As String, Optional cancellationToken As CancellationToken = Nothing) As ArmOperation
Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- location
- AzureLocation
The name of the Azure region.
- workspaceName
- String
The name of the workspace.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Exceptions
workspaceName
is an empty string, and was expected to be non-empty.
workspaceName
is null.