StorageAccountsOperations.StartFailoverAsync Method

Definition

Failover request can be triggered for a storage account in case of availability issues. The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover.

public virtual System.Threading.Tasks.Task<Azure.ResourceManager.Storage.StorageAccountsFailoverOperation> StartFailoverAsync (string resourceGroupName, string accountName, System.Threading.CancellationToken cancellationToken = default);
abstract member StartFailoverAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.Storage.StorageAccountsFailoverOperation>
override this.StartFailoverAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.Storage.StorageAccountsFailoverOperation>
Public Overridable Function StartFailoverAsync (resourceGroupName As String, accountName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StorageAccountsFailoverOperation)

Parameters

resourceGroupName
System.String

The name of the resource group within the user's subscription. The name is case insensitive.

accountName
System.String

The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.

cancellationToken
System.Threading.CancellationToken

The cancellation token to use.

Returns

System.Threading.Tasks.Task<StorageAccountsFailoverOperation>

Exceptions

System.ArgumentNullException

resourceGroupName or accountName is null.

Applies to