ProductGroup interface

Package:

@azure/arm-apimanagement

Interface representing a ProductGroup.

Methods

checkEntityExists(string, string, string, string, ProductGroupCheckEntityExistsOptionalParams)	Checks that Group entity specified by identifier is associated with the Product entity.
createOrUpdate(string, string, string, string, ProductGroupCreateOrUpdateOptionalParams)	Adds the association between the specified developer group with the specified product.
delete(string, string, string, string, ProductGroupDeleteOptionalParams)	Deletes the association between the specified group and product.
listByProduct(string, string, string, ProductGroupListByProductOptionalParams)	Lists the collection of developer groups associated with the specified product.

Method Details

checkEntityExists(string, string, string, string, ProductGroupCheckEntityExistsOptionalParams)

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

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

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.

groupId

string

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

options

ProductGroupCheckEntityExistsOptionalParams

The options parameters.

Returns

Promise<ProductGroupCheckEntityExistsResponse>

createOrUpdate(string, string, string, string, ProductGroupCreateOrUpdateOptionalParams)

Adds the association between the specified developer group with the specified product.

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

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.

groupId

string

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

options

ProductGroupCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<GroupContract>

delete(string, string, string, string, ProductGroupDeleteOptionalParams)

Deletes the association between the specified group and product.

function delete(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupDeleteOptionalParams): 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.

groupId

string

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

options

ProductGroupDeleteOptionalParams

The options parameters.

Returns

Promise<void>

listByProduct(string, string, string, ProductGroupListByProductOptionalParams)

Lists the collection of developer groups associated with the specified product.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGroupListByProductOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], 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.

options

ProductGroupListByProductOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>