ProductGroupImpl | @azure/arm-apimanagement

Class containing ProductGroup operations.

Hierarchy

ProductGroupImpl

Implements

ProductGroup

Index

Constructors

constructor

Methods

Constructors

constructor

new ProductGroupImpl(client: ApiManagementClientContext): ProductGroupImpl

- Defined in operations/productGroup.ts:31
Initialize a new instance of the class ProductGroup class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ProductGroupImpl

Methods

checkEntityExists

checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupCheckEntityExistsOptionalParams): Promise<ProductGroupCheckEntityExistsResponse>

Implementation of ProductGroup.checkEntityExists
- Defined in operations/productGroup.ts:148
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

createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupCreateOrUpdateOptionalParams): Promise<ProductGroupCreateOrUpdateResponse>

Implementation of ProductGroup.createOrUpdate
- Defined in operations/productGroup.ts:169
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

delete(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupDeleteOptionalParams): Promise<void>

Implementation of ProductGroup.delete
- Defined in operations/productGroup.ts:190
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

listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGroupListByProductOptionalParams): PagedAsyncIterableIterator<GroupContract>

Implementation of ProductGroup.listByProduct
- Defined in operations/productGroup.ts:48
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>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ProductGroupImpl

Methods

checkEntityExists

Parameters

resourceGroupName: string

serviceName: string

productId: string

groupId: string

Optional options: ProductGroupCheckEntityExistsOptionalParams

Returns Promise<ProductGroupCheckEntityExistsResponse>

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

productId: string

groupId: string

Optional options: ProductGroupCreateOrUpdateOptionalParams

Returns Promise<ProductGroupCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

productId: string

groupId: string

Optional options: ProductGroupDeleteOptionalParams

Returns Promise<void>

listByProduct

Parameters

resourceGroupName: string

serviceName: string

productId: string

Optional options: ProductGroupListByProductOptionalParams

Returns PagedAsyncIterableIterator<GroupContract>