ProductApiLink interface
Interface representing a ProductApiLink.
Methods
| create |
Adds an API to the specified product via link. |
| delete(string, string, string, string, Product |
Deletes the specified API from the specified product. |
| get(string, string, string, string, Product |
Gets the API link for the product. |
| list |
Lists a collection of the API links associated with a product. |
Method Details
createOrUpdate(string, string, string, string, ProductApiLinkContract, ProductApiLinkCreateOrUpdateOptionalParams)
Adds an API to the specified product via link.
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiLinkId: string, parameters: ProductApiLinkContract, options?: ProductApiLinkCreateOrUpdateOptionalParams): Promise<ProductApiLinkContract>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.
- apiLinkId
-
string
Product-API link identifier. Must be unique in the current API Management service instance.
- parameters
- ProductApiLinkContract
Create or update parameters.
The options parameters.
Returns
Promise<ProductApiLinkContract>
delete(string, string, string, string, ProductApiLinkDeleteOptionalParams)
Deletes the specified API from the specified product.
function delete(resourceGroupName: string, serviceName: string, productId: string, apiLinkId: string, options?: ProductApiLinkDeleteOptionalParams): 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.
- apiLinkId
-
string
Product-API link identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ProductApiLinkGetOptionalParams)
Gets the API link for the product.
function get(resourceGroupName: string, serviceName: string, productId: string, apiLinkId: string, options?: ProductApiLinkGetOptionalParams): Promise<ProductApiLinkGetResponse>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.
- apiLinkId
-
string
Product-API link identifier. Must be unique in the current API Management service instance.
- options
- ProductApiLinkGetOptionalParams
The options parameters.
Returns
Promise<ProductApiLinkGetResponse>
listByProduct(string, string, string, ProductApiLinkListByProductOptionalParams)
Lists a collection of the API links associated with a product.
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiLinkListByProductOptionalParams): PagedAsyncIterableIterator<ProductApiLinkContract, ProductApiLinkContract[], 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.