Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProductApi

Package version

Interface representing a ProductApi.

Hierarchy

  • ProductApi

Implemented by

Index

Methods

Methods

checkEntityExists

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: ProductApiCheckEntityExistsOptionalParams

      The options parameters.

    Returns Promise<ProductApiCheckEntityExistsResponse>

createOrUpdate

  • Adds an API to the specified product.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: ProductApiCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<ProductApiCreateOrUpdateResponse>

delete

  • Deletes the specified API from the specified product.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • 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.

    • Optional options: ProductApiDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

listByProduct

  • Lists a collection of the APIs associated with a product.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • serviceName: string

      The name of the API Management service.

    • productId: string

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

    • Optional options: ProductApiListByProductOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<ApiContract>

Generated using TypeDoc