MigrationConfigs.yml

### YamlMime:TSType
name: MigrationConfigs
uid: '@azure/arm-servicebus.MigrationConfigs'
package: '@azure/arm-servicebus'
summary: Interface representing a MigrationConfigs.
fullName: MigrationConfigs
remarks: ''
isDeprecated: false
type: interface
methods:
  - name: >-
      beginCreateAndStartMigration(string, string, string,
      MigrationConfigProperties,
      MigrationConfigsCreateAndStartMigrationOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.beginCreateAndStartMigration'
    package: '@azure/arm-servicebus'
    summary: >-
      Creates Migration configuration and starts migration of entities from
      Standard to Premium namespace
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateAndStartMigration(resourceGroupName: string,
        namespaceName: string, configName: string, parameters:
        MigrationConfigProperties, options?:
        MigrationConfigsCreateAndStartMigrationOptionalParams):
        Promise<PollerLike<PollOperationState<MigrationConfigProperties>,
        MigrationConfigProperties>>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: configName
          type: string
          description: The configuration name. Should always be "$default".
        - id: parameters
          type: <xref uid="@azure/arm-servicebus.MigrationConfigProperties" />
          description: Parameters required to create Migration Configuration
        - id: options
          type: >-
            <xref
            uid="@azure/arm-servicebus.MigrationConfigsCreateAndStartMigrationOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/core-lro.PollerLike" />&lt;<xref
          uid="@azure/core-lro.PollOperationState" />&lt;<xref
          uid="@azure/arm-servicebus.MigrationConfigProperties" />&gt;, <xref
          uid="@azure/arm-servicebus.MigrationConfigProperties" />&gt;&gt;
  - name: >-
      beginCreateAndStartMigrationAndWait(string, string, string,
      MigrationConfigProperties,
      MigrationConfigsCreateAndStartMigrationOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.beginCreateAndStartMigrationAndWait'
    package: '@azure/arm-servicebus'
    summary: >-
      Creates Migration configuration and starts migration of entities from
      Standard to Premium namespace
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function beginCreateAndStartMigrationAndWait(resourceGroupName: string,
        namespaceName: string, configName: string, parameters:
        MigrationConfigProperties, options?:
        MigrationConfigsCreateAndStartMigrationOptionalParams):
        Promise<MigrationConfigProperties>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: configName
          type: string
          description: The configuration name. Should always be "$default".
        - id: parameters
          type: <xref uid="@azure/arm-servicebus.MigrationConfigProperties" />
          description: Parameters required to create Migration Configuration
        - id: options
          type: >-
            <xref
            uid="@azure/arm-servicebus.MigrationConfigsCreateAndStartMigrationOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/arm-servicebus.MigrationConfigProperties"
          />&gt;
  - name: >-
      completeMigration(string, string, string,
      MigrationConfigsCompleteMigrationOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.completeMigration'
    package: '@azure/arm-servicebus'
    summary: >-
      This operation Completes Migration of entities by pointing the connection
      strings to Premium

      namespace and any entities created after the operation will be under
      Premium Namespace.

      CompleteMigration operation will fail when entity migration is
      in-progress.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function completeMigration(resourceGroupName: string, namespaceName:
        string, configName: string, options?:
        MigrationConfigsCompleteMigrationOptionalParams): Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: configName
          type: string
          description: The configuration name. Should always be "$default".
        - id: options
          type: >-
            <xref
            uid="@azure/arm-servicebus.MigrationConfigsCompleteMigrationOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: delete(string, string, string, MigrationConfigsDeleteOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.delete'
    package: '@azure/arm-servicebus'
    summary: Deletes a MigrationConfiguration
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function delete(resourceGroupName: string, namespaceName: string,
        configName: string, options?: MigrationConfigsDeleteOptionalParams):
        Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: configName
          type: string
          description: The configuration name. Should always be "$default".
        - id: options
          type: >-
            <xref
            uid="@azure/arm-servicebus.MigrationConfigsDeleteOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;
  - name: get(string, string, string, MigrationConfigsGetOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.get'
    package: '@azure/arm-servicebus'
    summary: Retrieves Migration Config
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function get(resourceGroupName: string, namespaceName: string,
        configName: string, options?: MigrationConfigsGetOptionalParams):
        Promise<MigrationConfigProperties>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: configName
          type: string
          description: The configuration name. Should always be "$default".
        - id: options
          type: >-
            <xref uid="@azure/arm-servicebus.MigrationConfigsGetOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/arm-servicebus.MigrationConfigProperties"
          />&gt;
  - name: list(string, string, MigrationConfigsListOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.list'
    package: '@azure/arm-servicebus'
    summary: Gets all migrationConfigurations
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function list(resourceGroupName: string, namespaceName: string,
        options?: MigrationConfigsListOptionalParams):
        PagedAsyncIterableIterator<MigrationConfigProperties,
        MigrationConfigProperties[], PageSettings>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: options
          type: >-
            <xref uid="@azure/arm-servicebus.MigrationConfigsListOptionalParams"
            />
          description: The options parameters.
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-paging.PagedAsyncIterableIterator" />&lt;<xref
          uid="@azure/arm-servicebus.MigrationConfigProperties" />, <xref
          uid="@azure/arm-servicebus.MigrationConfigProperties" />[], <xref
          uid="@azure/core-paging.PageSettings" />&gt;
  - name: revert(string, string, string, MigrationConfigsRevertOptionalParams)
    uid: '@azure/arm-servicebus.MigrationConfigs.revert'
    package: '@azure/arm-servicebus'
    summary: This operation reverts Migration
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        function revert(resourceGroupName: string, namespaceName: string,
        configName: string, options?: MigrationConfigsRevertOptionalParams):
        Promise<void>
      parameters:
        - id: resourceGroupName
          type: string
          description: Name of the Resource group within the Azure subscription.
        - id: namespaceName
          type: string
          description: The namespace name
        - id: configName
          type: string
          description: The configuration name. Should always be "$default".
        - id: options
          type: >-
            <xref
            uid="@azure/arm-servicebus.MigrationConfigsRevertOptionalParams" />
          description: The options parameters.
      return:
        description: ''
        type: Promise&lt;void&gt;