Storage.StorageAccountsFailover 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.
A failover request can be triggered for a storage account in the event a primary endpoint becomes unavailable for any reason. The failover occurs from the storage account's primary cluster to the secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover and the account is converted to LRS. In the case of a Planned Failover, the primary and secondary clusters are swapped after failover and the account remains geo-replicated. Failover should continue to be used in the event of availability issues as Planned failover is only available while the primary and secondary endpoints are available. The primary use case of a Planned Failover is disaster recovery testing drills. This type of failover is invoked by setting FailoverType parameter to 'Planned'. Learn more about the failover options here- https://learn.microsoft.com/en-us/azure/storage/common/storage-disaster-recovery-guidance
public System.Threading.Tasks.Task StorageAccountsFailover (string subscriptionId, string resourceGroupName, string accountName, string failoverType, Func<System.Net.Http.HttpResponseMessage,System.Threading.Tasks.Task> onOk, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IEventListener eventListener, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync sender);member this.StorageAccountsFailover : string * string * string * string * Func<System.Net.Http.HttpResponseMessage, System.Threading.Tasks.Task> * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IEventListener * Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync -> System.Threading.Tasks.TaskPublic Function StorageAccountsFailover (subscriptionId As String, resourceGroupName As String, accountName As String, failoverType As String, onOk As Func(Of HttpResponseMessage, Task), eventListener As IEventListener, sender As ISendAsync) As TaskParameters
- subscriptionId
- String
The ID of the target subscription.
- resourceGroupName
- String
The name of the resource group within the user's subscription. The name is case insensitive.
- accountName
- 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.
- failoverType
- String
The parameter is set to 'Planned' to indicate whether a Planned failover is requested.
- onOk
- Func<HttpResponseMessage,Task>
a delegate that is called when the remote service returns 200 (OK).
- eventListener
- IEventListener
an IEventListener instance that will receive events.
- sender
- ISendAsync
an instance of an Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.ISendAsync pipeline to use to make the request.
Returns
A Task that will be complete when handling of the response is completed.