ProductApi interface
Interface representing a ProductApi.
Methods
| check |
Checks that API entity specified by identifier is associated with the Product entity. |
| create |
Adds an API to the specified product. |
| delete(string, string, string, string, Product |
Deletes the specified API from the specified product. |
| list |
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.
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.
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.
The options parameters.