Share via

Product interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Product.

Methods

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)

Creates or Updates a product.
delete(string, string, string, string, ProductDeleteOptionalParams)

Delete product.
get(string, string, string, ProductGetOptionalParams)

Gets the details of the product specified by its identifier.
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the product specified by its identifier.
listByService(string, string, ProductListByServiceOptionalParams)

Lists a collection of products in the specified service instance.
listByTags(string, string, ProductListByTagsOptionalParams)

Lists a collection of products associated with tags.
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)

Update existing product details.

Method Details

createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)

Creates or Updates a product.

function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>

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.

parameters
ProductContract

Create or update parameters.

options
ProductCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ProductCreateOrUpdateResponse>

delete(string, string, string, string, ProductDeleteOptionalParams)

Delete product.

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

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
ProductDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ProductGetOptionalParams)

Gets the details of the product specified by its identifier.

function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>

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
ProductGetOptionalParams

The options parameters.

Returns

Promise<ProductGetResponse>

getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the product specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>

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
ProductGetEntityTagOptionalParams

The options parameters.

Returns

Promise<ProductGetEntityTagHeaders>

listByService(string, string, ProductListByServiceOptionalParams)

Lists a collection of products in the specified service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
ProductListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>

listByTags(string, string, ProductListByTagsOptionalParams)

Lists a collection of products associated with tags.

function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
ProductListByTagsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)

Update existing product details.

function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>

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.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters
ProductUpdateParameters

Update parameters.

options
ProductUpdateOptionalParams

The options parameters.

Returns

Promise<ProductUpdateResponse>