Share via

ProductApi interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a ProductApi.

Methods

checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)

Checks that API entity specified by identifier is associated with the Product entity.
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)

Adds an API to the specified product.
delete(string, string, string, string, ProductApiDeleteOptionalParams)

Deletes the specified API from the specified product.
listByProduct(string, string, string, ProductApiListByProductOptionalParams)

Lists a collection of the APIs associated with a product.

Method Details

checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)

Checks that API entity specified by identifier is associated with the Product entity.

function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
ProductApiCheckEntityExistsOptionalParams

The options parameters.

Returns

Promise<ProductApiCheckEntityExistsResponse>

createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)

Adds an API to the specified product.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
ProductApiCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApiContract>

delete(string, string, string, string, ProductApiDeleteOptionalParams)

Deletes the specified API from the specified product.

function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
ProductApiDeleteOptionalParams

The options parameters.

Returns

Promise<void>

listByProduct(string, string, string, ProductApiListByProductOptionalParams)

Lists a collection of the APIs associated with a product.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

productId

string

Product identifier. Must be unique in the current API Management service instance.

options
ProductApiListByProductOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>