Migrations interface
Интерфейс, представляющий миграцию.
Методы
| cancel(string, string, string, Migrations |
Отменяет активную миграцию. |
| check |
Проверяет, является ли предложенное имя миграции действительным и доступным. |
| create(string, string, string, Migration, Migrations |
Создает новую миграцию. |
| get(string, string, string, Migrations |
Получает информацию о миграции. |
| list |
Выводит список всех миграций целевого гибкого сервера. |
| update(string, string, string, Migration |
Обновляет существующую миграцию. Текст запроса может содержать одно ко многим из изменяемых свойств, присутствующих в определении миграции. Некоторые обновления свойств инициируют переходы состояния миграции. |
Сведения о методе
cancel(string, string, string, MigrationsCancelOptionalParams)
Отменяет активную миграцию.
function cancel(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsCancelOptionalParams): Promise<Migration>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не зависит от регистра.
- serverName
-
string
Имени сервера.
- migrationName
-
string
Название миграции.
- options
- MigrationsCancelOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<Migration>
checkNameAvailability(string, string, MigrationNameAvailability, MigrationsCheckNameAvailabilityOptionalParams)
Проверяет, является ли предложенное имя миграции действительным и доступным.
function checkNameAvailability(resourceGroupName: string, serverName: string, parameters: MigrationNameAvailability, options?: MigrationsCheckNameAvailabilityOptionalParams): Promise<MigrationNameAvailability>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не зависит от регистра.
- serverName
-
string
Имени сервера.
- parameters
- MigrationNameAvailability
Параметры, необходимые для проверки, является ли имя миграции действительным и доступным.
Параметры параметров.
Возвращаемое значение
Promise<MigrationNameAvailability>
create(string, string, string, Migration, MigrationsCreateOptionalParams)
Создает новую миграцию.
function create(resourceGroupName: string, serverName: string, migrationName: string, parameters: Migration, options?: MigrationsCreateOptionalParams): Promise<Migration>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не зависит от регистра.
- serverName
-
string
Имени сервера.
- migrationName
-
string
Название миграции.
- parameters
- Migration
Параметры, необходимые для создания миграции.
- options
- MigrationsCreateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<Migration>
get(string, string, string, MigrationsGetOptionalParams)
Получает информацию о миграции.
function get(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsGetOptionalParams): Promise<Migration>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не зависит от регистра.
- serverName
-
string
Имени сервера.
- migrationName
-
string
Название миграции.
- options
- MigrationsGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<Migration>
listByTargetServer(string, string, MigrationsListByTargetServerOptionalParams)
Выводит список всех миграций целевого гибкого сервера.
function listByTargetServer(resourceGroupName: string, serverName: string, options?: MigrationsListByTargetServerOptionalParams): PagedAsyncIterableIterator<Migration, Migration[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не зависит от регистра.
- serverName
-
string
Имени сервера.
Параметры параметров.
Возвращаемое значение
update(string, string, string, MigrationResourceForPatch, MigrationsUpdateOptionalParams)
Обновляет существующую миграцию. Текст запроса может содержать одно ко многим из изменяемых свойств, присутствующих в определении миграции. Некоторые обновления свойств инициируют переходы состояния миграции.
function update(resourceGroupName: string, serverName: string, migrationName: string, parameters: MigrationResourceForPatch, options?: MigrationsUpdateOptionalParams): Promise<Migration>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Имя не зависит от регистра.
- serverName
-
string
Имени сервера.
- migrationName
-
string
Название миграции.
- parameters
- MigrationResourceForPatch
Параметры, необходимые для обновления существующей миграции.
- options
- MigrationsUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<Migration>