SqlExtensions.GetInstanceFailoverGroup Method

Definition

Gets a failover group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/locations/{locationName}/instanceFailoverGroups/{failoverGroupName}
  • Operation Id: InstanceFailoverGroups_Get
  • Default Api Version: 2022-05-01-preview
  • Resource: InstanceFailoverGroupResource
public static Azure.Response<Azure.ResourceManager.Sql.InstanceFailoverGroupResource> GetInstanceFailoverGroup (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, Azure.Core.AzureLocation locationName, string failoverGroupName, System.Threading.CancellationToken cancellationToken = default);
static member GetInstanceFailoverGroup : Azure.ResourceManager.Resources.ResourceGroupResource * Azure.Core.AzureLocation * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sql.InstanceFailoverGroupResource>
<Extension()>
Public Function GetInstanceFailoverGroup (resourceGroupResource As ResourceGroupResource, locationName As AzureLocation, failoverGroupName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of InstanceFailoverGroupResource)

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

locationName
AzureLocation

The name of the region where the resource is located.

failoverGroupName
String

The name of the failover group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or failoverGroupName is null.

failoverGroupName is an empty string, and was expected to be non-empty.

Applies to