ProductApi interface
代表 ProductApi 的介面。
方法
| check |
檢查識別碼所指定的 API 實體是否與 Product 實體相關聯。 |
| create |
將 API 新增至指定的產品。 |
| delete(string, string, string, string, Product |
從指定的產品中刪除指定的 API。 |
| list |
列出與產品相關聯的 API 集合。 |
方法詳細資料
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
檢查識別碼所指定的 API 實體是否與 Product 實體相關聯。
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品識別碼。 目前API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂識別碼。 目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
選項參數。
傳回
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
將 API 新增至指定的產品。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品識別碼。 目前API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂識別碼。 目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
選項參數。
傳回
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
從指定的產品中刪除指定的 API。
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品識別碼。 目前API 管理服務實例中必須是唯一的。
- apiId
-
string
API 修訂識別碼。 目前API 管理服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為尾碼，其中 n 是修訂編號。
- options
- ProductApiDeleteOptionalParams
選項參數。
傳回
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
列出與產品相關聯的 API 集合。
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品識別碼。 目前API 管理服務實例中必須是唯一的。
選項參數。