ApiRelease interface
表示 ApiRelease 的介面。
方法
| create |
建立 API 的新版本。 |
| delete(string, string, string, string, string, Api |
刪除 API 中指定的版本。 |
| get(string, string, string, string, Api |
傳回 API 版本的詳細資料。 |
| get |
傳回 API 版本的 etag。 |
| list |
列出 API 的所有版本。 在進行 API 修訂時，會建立 API 版本。 版本也可用來復原至先前的修訂。 結果會分頁，並可受到$top和$skip參數的限制。 |
| update(string, string, string, string, string, Api |
更新其識別碼所指定的 API 版本詳細資料。 |
方法詳細資料
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
建立 API 的新版本。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- releaseId
-
string
API 內的發行識別碼。 在目前API 管理服務實例中必須是唯一的。
- parameters
- ApiReleaseContract
建立參數。
選項參數。
傳回
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
刪除 API 中指定的版本。
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- releaseId
-
string
API 內的發行識別碼。 在目前API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
- options
- ApiReleaseDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
傳回 API 版本的詳細資料。
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- releaseId
-
string
API 內的發行識別碼。 在目前API 管理服務實例中必須是唯一的。
- options
- ApiReleaseGetOptionalParams
選項參數。
傳回
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
傳回 API 版本的 etag。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- releaseId
-
string
API 內的發行識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
列出 API 的所有版本。 在進行 API 修訂時，會建立 API 版本。 版本也可用來復原至先前的修訂。 結果會分頁，並可受到$top和$skip參數的限制。
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
更新其識別碼所指定的 API 版本詳細資料。
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- apiId
-
string
API 識別碼。 在目前API 管理服務實例中必須是唯一的。
- releaseId
-
string
API 內的發行識別碼。 在目前API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應該符合 GET 要求的標頭回應中目前的實體狀態，或者它應該是 * 進行無條件更新。
- parameters
- ApiReleaseContract
API 發行更新參數。
- options
- ApiReleaseUpdateOptionalParams
選項參數。
傳回
Promise<ApiReleaseUpdateResponse>