Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProductGroup

Package version

Interface representing a ProductGroup.

Hierarchy

  • ProductGroup

Implemented by

Index

Methods

Methods

checkEntityExists

  • Checks that Group 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.

    • groupId: string

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

    • Optional options: ProductGroupCheckEntityExistsOptionalParams

      The options parameters.

    Returns Promise<ProductGroupCheckEntityExistsResponse>

createOrUpdate

  • Adds the association between the specified developer group with 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.

    • groupId: string

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

    • Optional options: ProductGroupCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<ProductGroupCreateOrUpdateResponse>

delete

  • Deletes the association between the specified group and 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.

    • groupId: string

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

    • Optional options: ProductGroupDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

listByProduct

  • Lists the collection of developer groups associated with 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.

    • Optional options: ProductGroupListByProductOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<GroupContract>

Generated using TypeDoc