你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
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 请求标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 *。
- 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 请求标头响应中的当前实体状态匹配，或者对于无条件更新，ETag 应为 *。
- parameters
- ProductUpdateParameters
更新参数。
- options
- ProductUpdateOptionalParams
选项参数。
返回
Promise<ProductUpdateResponse>