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 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
- 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 要求標頭回應的目前實體狀態，否則應該為 * 進行無條件更新。
- parameters
- BackendUpdateParameters
更新參數。
- options
- BackendUpdateOptionalParams
選項參數。
傳回
Promise<BackendUpdateResponse>