Gateway interface
Интерфейс, представляющий шлюз.
Методы
Сведения о методе
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Создает или обновляет шлюз для использования в экземпляре управления API.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- parameters
- GatewayContract
Сведения о шлюзе.
Параметры параметров.
Возвращаемое значение
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Удаляет конкретный шлюз.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- GatewayDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Возвращает маркер авторизации общего доступа для шлюза.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- parameters
- GatewayTokenRequestContract
Свойства контракта запроса маркера шлюза.
Параметры параметров.
Возвращаемое значение
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Возвращает сведения о шлюзе, заданном его идентификатором.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- options
- GatewayGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) шлюза, указанного его идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
Параметры параметров.
Возвращаемое значение
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Возвращает коллекцию шлюзов, зарегистрированных в экземпляре службы.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
Параметры параметров.
Возвращаемое значение
listKeys(string, string, string, GatewayListKeysOptionalParams)
Получает ключи шлюза.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- options
- GatewayListKeysOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Повторно создает указанный ключ шлюза, что делает недействительными все созданные с его помощью маркеры.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- parameters
- GatewayKeyRegenerationRequestContract
Свойства контракта запроса на повторное создание ключа шлюза.
Параметры параметров.
Возвращаемое значение
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Обновления сведения о шлюзе, указанные его идентификатором.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значение managed
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- parameters
- GatewayContract
Сведения о шлюзе.
- options
- GatewayUpdateOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<GatewayUpdateResponse>