你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
GatewayApi interface
表示 GatewayApi 的接口。
方法
| 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”
选项参数。