你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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
后端实体的标识符。 在当前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
后端实体的标识符。 在当前API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 *。
- 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
后端实体的标识符。 在当前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
后端实体的标识符。 在当前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
后端实体的标识符。 在当前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
后端实体的标识符。 在当前API 管理服务实例中必须是唯一的。
- ifMatch
-
string
实体的 ETag。 ETag 应与 GET 请求标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 *。
- parameters
- BackendUpdateParameters
更新参数。
- options
- BackendUpdateOptionalParams
选项参数。
返回
Promise<BackendUpdateResponse>