ProductWiki interface
代表 ProductWiki 的介面。
方法
create |
為產品建立新的Wiki,或更新現有的Wiki。 |
delete(string, string, string, string, Product |
從產品中刪除指定的Wiki。 |
get(string, string, string, Product |
取得其標識碼所指定產品Wiki的詳細數據。 |
get |
取得其標識碼所指定產品的Wiki實體狀態 (Etag) 版本。 |
update(string, string, string, string, Wiki |
針對其標識碼所指定的產品,更新Wiki的詳細數據。 |
方法詳細資料
createOrUpdate(string, string, string, WikiContract, ProductWikiCreateOrUpdateOptionalParams)
為產品建立新的Wiki,或更新現有的Wiki。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: WikiContract, options?: ProductWikiCreateOrUpdateOptionalParams): Promise<ProductWikiCreateOrUpdateResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- parameters
- WikiContract
建立參數。
選項參數。
傳回
Promise<ProductWikiCreateOrUpdateResponse>
delete(string, string, string, string, ProductWikiDeleteOptionalParams)
從產品中刪除指定的Wiki。
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductWikiDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態,或應為 * 進行無條件更新。
- options
- ProductWikiDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, ProductWikiGetOptionalParams)
取得其標識碼所指定產品Wiki的詳細數據。
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetOptionalParams): Promise<ProductWikiGetResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- options
- ProductWikiGetOptionalParams
選項參數。
傳回
Promise<ProductWikiGetResponse>
getEntityTag(string, string, string, ProductWikiGetEntityTagOptionalParams)
取得其標識碼所指定產品的Wiki實體狀態 (Etag) 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductWikiGetEntityTagOptionalParams): Promise<ProductWikiGetEntityTagHeaders>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<ProductWikiGetEntityTagHeaders>
update(string, string, string, string, WikiUpdateContract, ProductWikiUpdateOptionalParams)
針對其標識碼所指定的產品,更新Wiki的詳細數據。
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: WikiUpdateContract, options?: ProductWikiUpdateOptionalParams): Promise<ProductWikiUpdateResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態,或應為 * 進行無條件更新。
- parameters
- WikiUpdateContract
Wiki 更新參數。
- options
- ProductWikiUpdateOptionalParams
選項參數。
傳回
Promise<ProductWikiUpdateResponse>