ProductApiImpl | @azure/arm-apimanagement

Class containing ProductApi operations.

Hierarchy

ProductApiImpl

Implements

ProductApi

Index

Constructors

constructor

Methods

Constructors

constructor

new ProductApiImpl(client: ApiManagementClientContext): ProductApiImpl

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

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

Methods

checkEntityExists

checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>

Implementation of ProductApi.checkEntityExists
- Defined in operations/productApi.ts:149
Checks that API 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.
- apiId: string
  
  API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Optional options: ProductApiCheckEntityExistsOptionalParams
  
  The options parameters.
Returns Promise<ProductApiCheckEntityExistsResponse>

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ProductApiCreateOrUpdateResponse>

Implementation of ProductApi.createOrUpdate
- Defined in operations/productApi.ts:171
Adds an API to 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.
- apiId: string
  
  API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Optional options: ProductApiCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ProductApiCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>

Implementation of ProductApi.delete
- Defined in operations/productApi.ts:193
Deletes the specified API from 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.
- apiId: string
  
  API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- Optional options: ProductApiDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

listByProduct

listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract>

Implementation of ProductApi.listByProduct
- Defined in operations/productApi.ts:48
Lists a collection of the APIs associated with 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.
- Optional options: ProductApiListByProductOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiContract>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ProductApiImpl

Methods

checkEntityExists

Parameters

resourceGroupName: string

serviceName: string

productId: string

apiId: string

Optional options: ProductApiCheckEntityExistsOptionalParams

Returns Promise<ProductApiCheckEntityExistsResponse>

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

productId: string

apiId: string

Optional options: ProductApiCreateOrUpdateOptionalParams

Returns Promise<ProductApiCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

productId: string

apiId: string

Optional options: ProductApiDeleteOptionalParams

Returns Promise<void>

listByProduct

Parameters

resourceGroupName: string

serviceName: string

productId: string

Optional options: ProductApiListByProductOptionalParams

Returns PagedAsyncIterableIterator<ApiContract>