Product interface
代表 Product 的介面。
方法
方法詳細資料
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
建立或更新產品。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- parameters
- ProductContract
建立或更新參數。
選項參數。
傳回
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
刪除產品。
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- options
- ProductDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, ProductGetOptionalParams)
取得其識別碼所指定產品的詳細數據。
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- options
- ProductGetOptionalParams
選項參數。
傳回
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
取得其標識碼所指定產品的實體狀態 （Etag） 版本。
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
列出指定服務實例中的產品集合。
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
選項參數。
傳回
listByTags(string, string, ProductListByTagsOptionalParams)
列出與標記相關聯的產品集合。
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- options
- ProductListByTagsOptionalParams
選項參數。
傳回
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
更新現有的產品詳細數據。
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- productId
-
string
產品標識碼。 目前 API 管理服務實例中必須是唯一的。
- ifMatch
-
string
實體的 ETag。 ETag 應符合 GET 要求的標頭回應中目前的實體狀態，或應為 * 進行無條件更新。
- parameters
- ProductUpdateParameters
更新參數。
- options
- ProductUpdateOptionalParams
選項參數。
傳回
Promise<ProductUpdateResponse>