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 管理服务实例中必须是唯一的。
选项参数。