GatewayApi interface
Интерфейс, представляющий шлюзApi.
Методы
| create |
Добавляет API в указанный шлюз. |
| delete(string, string, string, string, Gateway |
Удаляет указанный API из указанного шлюза. |
| get |
Проверяет, связана ли сущность API, указанная идентификатором, с сущностью шлюза. |
| list |
Возвращает коллекцию API, связанных со шлюзом. |
Сведения о методе
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Добавляет API в указанный шлюз.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значения "managed"
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Удаляет указанный API из указанного шлюза.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значения "managed"
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
- options
- GatewayApiDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Проверяет, связана ли сущность API, указанная идентификатором, с сущностью шлюза.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значения "managed"
- apiId
-
string
Идентификатор API. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Возвращает коллекцию API, связанных со шлюзом.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- gatewayId
-
string
Идентификатор сущности шлюза. Должен быть уникальным в текущем экземпляре службы Управление API. Не должно иметь значения "managed"
Параметры параметров.