StorageAccountResource.FailoverAsync 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.
Overloads
| FailoverAsync(WaitUntil, CancellationToken) |
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
|
| FailoverAsync(WaitUntil, Nullable<StorageAccountFailoverType>, CancellationToken) |
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
|
FailoverAsync(WaitUntil, CancellationToken)
- Source:
- StorageAccountResource.cs
- Source:
- StorageAccountResource.cs
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
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover
- Operation Id: StorageAccounts_Failover
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> FailoverAsync (Azure.WaitUntil waitUntil, System.Threading.CancellationToken cancellationToken);abstract member FailoverAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.FailoverAsync : Azure.WaitUntil * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>Public Overridable Function FailoverAsync (waitUntil As WaitUntil, cancellationToken As CancellationToken) As Task(Of 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.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
FailoverAsync(WaitUntil, Nullable<StorageAccountFailoverType>, CancellationToken)
- Source:
- StorageAccountResource.cs
- Source:
- StorageAccountResource.cs
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
- Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover
- Operation Id: StorageAccounts_Failover
- Default Api Version: 2023-05-01
- Resource: StorageAccountResource
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation> FailoverAsync (Azure.WaitUntil waitUntil, Azure.ResourceManager.Storage.Models.StorageAccountFailoverType? failoverType = default, System.Threading.CancellationToken cancellationToken = default);abstract member FailoverAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.Storage.Models.StorageAccountFailoverType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>
override this.FailoverAsync : Azure.WaitUntil * Nullable<Azure.ResourceManager.Storage.Models.StorageAccountFailoverType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation>Public Overridable Function FailoverAsync (waitUntil As WaitUntil, Optional failoverType As Nullable(Of StorageAccountFailoverType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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.
- failoverType
- Nullable<StorageAccountFailoverType>
The parameter is set to 'Planned' to indicate whether a Planned failover is requested.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
Applies to
Azure SDK for .NET