Backend interface
Интерфейс, представляющий серверную часть.
Методы
| create |
Создание или обновление серверного компонента. |
| delete(string, string, string, string, Backend |
Удаляет указанный серверный компонент. |
| get(string, string, string, Backend |
Возвращает сведения о серверной части, указанной ее идентификатором. |
| get |
Возвращает версию состояния сущности (Etag) серверной части, указанной ее идентификатором. |
| list |
Возвращает коллекцию серверных компонентов в указанном экземпляре службы. |
| reconnect(string, string, string, Backend |
Уведомляет шлюз Управление API о создании нового подключения к серверной части по истечении указанного времени ожидания. Если время ожидания не указано, используется время ожидания, равное 2 минутам. |
| update(string, string, string, string, Backend |
Обновления существующую серверную часть. |
Сведения о методе
createOrUpdate(string, string, string, BackendContract, BackendCreateOrUpdateOptionalParams)
Создание или обновление серверного компонента.
function createOrUpdate(resourceGroupName: string, serviceName: string, backendId: string, parameters: BackendContract, options?: BackendCreateOrUpdateOptionalParams): Promise<BackendCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- backendId
-
string
Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
- parameters
- BackendContract
Создайте параметры.
Параметры параметров.
Возвращаемое значение
Promise<BackendCreateOrUpdateResponse>
delete(string, string, string, string, BackendDeleteOptionalParams)
Удаляет указанный серверный компонент.
function delete(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, options?: BackendDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- backendId
-
string
Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- BackendDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, BackendGetOptionalParams)
Возвращает сведения о серверной части, указанной ее идентификатором.
function get(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetOptionalParams): Promise<BackendGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- backendId
-
string
Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- BackendGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<BackendGetResponse>
getEntityTag(string, string, string, BackendGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) серверной части, указанной ее идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendGetEntityTagOptionalParams): Promise<BackendGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- backendId
-
string
Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<BackendGetEntityTagHeaders>
listByService(string, string, BackendListByServiceOptionalParams)
Возвращает коллекцию серверных компонентов в указанном экземпляре службы.
function listByService(resourceGroupName: string, serviceName: string, options?: BackendListByServiceOptionalParams): PagedAsyncIterableIterator<BackendContract, BackendContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
Параметры параметров.
Возвращаемое значение
reconnect(string, string, string, BackendReconnectOptionalParams)
Уведомляет шлюз Управление API о создании нового подключения к серверной части по истечении указанного времени ожидания. Если время ожидания не указано, используется время ожидания, равное 2 минутам.
function reconnect(resourceGroupName: string, serviceName: string, backendId: string, options?: BackendReconnectOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- backendId
-
string
Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- BackendReconnectOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
update(string, string, string, string, BackendUpdateParameters, BackendUpdateOptionalParams)
Обновления существующую серверную часть.
function update(resourceGroupName: string, serviceName: string, backendId: string, ifMatch: string, parameters: BackendUpdateParameters, options?: BackendUpdateOptionalParams): Promise<BackendUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- backendId
-
string
Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- BackendUpdateParameters
Обновление параметров.
- options
- BackendUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<BackendUpdateResponse>