FailoverGroups.yml

### YamlMime:TSType
name: FailoverGroups
uid: '@azure/arm-sql.FailoverGroups'
package: '@azure/arm-sql'
summary: Interface representing a FailoverGroups.
fullName: FailoverGroups
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      beginCreateOrUpdate(string, string, string, FailoverGroup,
      FailoverGroupsCreateOrUpdateOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginCreateOrUpdate'
    package: '@azure/arm-sql'
    summary: Creates or updates a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdate(resourceGroupName: string, serverName:
        string, failoverGroupName: string, parameters: FailoverGroup, options?:
        FailoverGroupsCreateOrUpdateOptionalParams):
        Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: parameters
          type: <xref uid="@azure/arm-sql.FailoverGroup" />
          description: The failover group parameters.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-sql.FailoverGroupsCreateOrUpdateOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.SimplePollerLike" />&lt;<xref
          uid="@azure/core-lro.OperationState" />&lt;<xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;, <xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;&gt;
  - name: >-
      beginCreateOrUpdateAndWait(string, string, string, FailoverGroup,
      FailoverGroupsCreateOrUpdateOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginCreateOrUpdateAndWait'
    package: '@azure/arm-sql'
    summary: Creates or updates a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateOrUpdateAndWait(resourceGroupName: string,
        serverName: string, failoverGroupName: string, parameters:
        FailoverGroup, options?: FailoverGroupsCreateOrUpdateOptionalParams):
        Promise<FailoverGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: parameters
          type: <xref uid="@azure/arm-sql.FailoverGroup" />
          description: The failover group parameters.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-sql.FailoverGroupsCreateOrUpdateOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-sql.FailoverGroup" />&gt;
  - name: beginDelete(string, string, string, FailoverGroupsDeleteOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginDelete'
    package: '@azure/arm-sql'
    summary: Deletes a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDelete(resourceGroupName: string, serverName: string,
        failoverGroupName: string, options?:
        FailoverGroupsDeleteOptionalParams):
        Promise<SimplePollerLike<OperationState<void>, void>>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsDeleteOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.SimplePollerLike" />&lt;<xref
          uid="@azure/core-lro.OperationState" />&lt;void&gt;, void&gt;&gt;
  - name: >-
      beginDeleteAndWait(string, string, string,
      FailoverGroupsDeleteOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginDeleteAndWait'
    package: '@azure/arm-sql'
    summary: Deletes a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginDeleteAndWait(resourceGroupName: string, serverName:
        string, failoverGroupName: string, options?:
        FailoverGroupsDeleteOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsDeleteOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: >-
      beginFailover(string, string, string,
      FailoverGroupsFailoverOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginFailover'
    package: '@azure/arm-sql'
    summary: Fails over from the current primary server to this server.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginFailover(resourceGroupName: string, serverName: string,
        failoverGroupName: string, options?:
        FailoverGroupsFailoverOptionalParams):
        Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsFailoverOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.SimplePollerLike" />&lt;<xref
          uid="@azure/core-lro.OperationState" />&lt;<xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;, <xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;&gt;
  - name: >-
      beginFailoverAndWait(string, string, string,
      FailoverGroupsFailoverOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginFailoverAndWait'
    package: '@azure/arm-sql'
    summary: Fails over from the current primary server to this server.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginFailoverAndWait(resourceGroupName: string, serverName:
        string, failoverGroupName: string, options?:
        FailoverGroupsFailoverOptionalParams): Promise<FailoverGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsFailoverOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-sql.FailoverGroup" />&gt;
  - name: >-
      beginForceFailoverAllowDataLoss(string, string, string,
      FailoverGroupsForceFailoverAllowDataLossOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginForceFailoverAllowDataLoss'
    package: '@azure/arm-sql'
    summary: >-
      Fails over from the current primary server to this server. This operation
      might result in data loss.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginForceFailoverAllowDataLoss(resourceGroupName: string,
        serverName: string, failoverGroupName: string, options?:
        FailoverGroupsForceFailoverAllowDataLossOptionalParams):
        Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-sql.FailoverGroupsForceFailoverAllowDataLossOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.SimplePollerLike" />&lt;<xref
          uid="@azure/core-lro.OperationState" />&lt;<xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;, <xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;&gt;
  - name: >-
      beginForceFailoverAllowDataLossAndWait(string, string, string,
      FailoverGroupsForceFailoverAllowDataLossOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginForceFailoverAllowDataLossAndWait'
    package: '@azure/arm-sql'
    summary: >-
      Fails over from the current primary server to this server. This operation
      might result in data loss.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginForceFailoverAllowDataLossAndWait(resourceGroupName:
        string, serverName: string, failoverGroupName: string, options?:
        FailoverGroupsForceFailoverAllowDataLossOptionalParams):
        Promise<FailoverGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: >-
            <xref
            uid="@azure/arm-sql.FailoverGroupsForceFailoverAllowDataLossOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-sql.FailoverGroup" />&gt;
  - name: >-
      beginUpdate(string, string, string, FailoverGroupUpdate,
      FailoverGroupsUpdateOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginUpdate'
    package: '@azure/arm-sql'
    summary: Updates a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdate(resourceGroupName: string, serverName: string,
        failoverGroupName: string, parameters: FailoverGroupUpdate, options?:
        FailoverGroupsUpdateOptionalParams):
        Promise<SimplePollerLike<OperationState<FailoverGroup>, FailoverGroup>>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: parameters
          type: <xref uid="@azure/arm-sql.FailoverGroupUpdate" />
          description: The failover group parameters.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsUpdateOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.SimplePollerLike" />&lt;<xref
          uid="@azure/core-lro.OperationState" />&lt;<xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;, <xref
          uid="@azure/arm-sql.FailoverGroup" />&gt;&gt;
  - name: >-
      beginUpdateAndWait(string, string, string, FailoverGroupUpdate,
      FailoverGroupsUpdateOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.beginUpdateAndWait'
    package: '@azure/arm-sql'
    summary: Updates a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginUpdateAndWait(resourceGroupName: string, serverName:
        string, failoverGroupName: string, parameters: FailoverGroupUpdate,
        options?: FailoverGroupsUpdateOptionalParams): Promise<FailoverGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: parameters
          type: <xref uid="@azure/arm-sql.FailoverGroupUpdate" />
          description: The failover group parameters.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsUpdateOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-sql.FailoverGroup" />&gt;
  - name: get(string, string, string, FailoverGroupsGetOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.get'
    package: '@azure/arm-sql'
    summary: Gets a failover group.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, serverName: string,
        failoverGroupName: string, options?: FailoverGroupsGetOptionalParams):
        Promise<FailoverGroup>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: failoverGroupName
          type: string
          description: The name of the failover group.
        - id: options
          type: <xref uid="@azure/arm-sql.FailoverGroupsGetOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;<xref uid="@azure/arm-sql.FailoverGroup" />&gt;
  - name: listByServer(string, string, FailoverGroupsListByServerOptionalParams)
    uid: '@azure/arm-sql.FailoverGroups.listByServer'
    package: '@azure/arm-sql'
    summary: Lists the failover groups in a server.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function listByServer(resourceGroupName: string, serverName: string,
        options?: FailoverGroupsListByServerOptionalParams):
        PagedAsyncIterableIterator<FailoverGroup, FailoverGroup[], PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: >-
            The name of the resource group that contains the resource. You can
            obtain
                                     this value from the Azure Resource Manager API or the portal.
        - id: serverName
          type: string
          description: The name of the server containing the failover group.
        - id: options
          type: >-
            <xref uid="@azure/arm-sql.FailoverGroupsListByServerOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-sql.FailoverGroup" />, <xref
          uid="@azure/arm-sql.FailoverGroup" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;