ProductImpl | @azure/arm-apimanagement

Class containing Product operations.

Hierarchy

ProductImpl

Implements

Product

Index

Constructors

constructor

Methods

Constructors

constructor

new ProductImpl(client: ApiManagementClientContext): ProductImpl

- Defined in operations/product.ts:41
Initialize a new instance of the class Product class.

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

Methods

createOrUpdate

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

Implementation of Product.createOrUpdate
- Defined in operations/product.ts:256
Creates or Updates 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.
- parameters: ProductContract
  
  Create or update parameters.
- Optional options: ProductCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ProductCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): Promise<void>

Implementation of Product.delete
- Defined in operations/product.ts:309
Delete 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.
- 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.
- Optional options: ProductDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

Implementation of Product.get
- Defined in operations/product.ts:236
Gets the details of the product specified by its identifier.

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: ProductGetOptionalParams
  
  The options parameters.
Returns Promise<ProductGetResponse>

getEntityTag

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

Implementation of Product.getEntityTag
- Defined in operations/product.ts:217
Gets the entity state (Etag) version of the product specified by its identifier.

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: ProductGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ProductGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract>

Implementation of Product.listByService
- Defined in operations/product.ts:57
Lists a collection of products in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ProductListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ProductContract>

listByTags

listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract>

Implementation of Product.listByTags
- Defined in operations/product.ts:128
Lists a collection of products associated with tags.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ProductListByTagsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagResourceContract>

update

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

Implementation of Product.update
- Defined in operations/product.ts:279
Update existing product details.

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.
- 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.
- Optional options: ProductUpdateOptionalParams
  
  The options parameters.
Returns Promise<ProductUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ProductImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

productId: string

parameters: ProductContract

Optional options: ProductCreateOrUpdateOptionalParams

Returns Promise<ProductCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

productId: string

ifMatch: string

Optional options: ProductDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

productId: string

Optional options: ProductGetOptionalParams

Returns Promise<ProductGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

productId: string

Optional options: ProductGetEntityTagOptionalParams

Returns Promise<ProductGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: ProductListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ProductContract>

listByTags

Parameters

resourceGroupName: string

serviceName: string

Optional options: ProductListByTagsOptionalParams

Returns PagedAsyncIterableIterator<TagResourceContract>

update

Parameters

resourceGroupName: string

serviceName: string

productId: string

ifMatch: string

parameters: ProductUpdateParameters

Optional options: ProductUpdateOptionalParams

Returns Promise<ProductUpdateResponse>