Products Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface Products

Resource collection API of Products.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new ProductContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String productId, String ifMatch) Delete product.
abstract void	deleteById(String id) Delete product.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Boolean deleteSubscriptions, Context context) Delete product.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String productId, String ifMatch, Boolean deleteSubscriptions, Context context) Delete product.
abstract ProductContract	get(String resourceGroupName, String serviceName, String productId) Gets the details of the product specified by its identifier.
abstract ProductContract	getById(String id) Gets the details of the product specified by its identifier.
abstract Response<ProductContract>	getByIdWithResponse(String id, Context context) Gets the details of the product specified by its identifier.
abstract void	getEntityTag(String resourceGroupName, String serviceName, String productId) Gets the entity state (Etag) version of the product specified by its identifier.
abstract ProductsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, Context context) Gets the entity state (Etag) version of the product specified by its identifier.
abstract Response<ProductContract>	getWithResponse(String resourceGroupName, String serviceName, String productId, Context context) Gets the details of the product specified by its identifier.
abstract PagedIterable<ProductContract>	listByService(String resourceGroupName, String serviceName) Lists a collection of products in the specified service instance.
abstract PagedIterable<ProductContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean expandGroups, String tags, Context context) Lists a collection of products in the specified service instance.
abstract PagedIterable<TagResourceContract>	listByTags(String resourceGroupName, String serviceName) Lists a collection of products associated with tags.
abstract PagedIterable<TagResourceContract>	listByTags(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean includeNotTaggedProducts, Context context) Lists a collection of products associated with tags.

Method Details

define

public abstract ProductContract.DefinitionStages.Blank define(String name)

Begins definition for a new ProductContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ProductContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String productId, String ifMatch)

Delete product.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

ifMatch - 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.

deleteById

public abstract void deleteById(String id)

Delete product.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Boolean deleteSubscriptions, Context context)

Delete product.

Parameters:

id - the resource ID.

ifMatch - 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.

deleteSubscriptions - Delete existing subscriptions associated with the product or not.

context - The context to associate with this operation.

Returns:

the Response<T>.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String productId, String ifMatch, Boolean deleteSubscriptions, Context context)

Delete product.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

ifMatch - 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.

deleteSubscriptions - Delete existing subscriptions associated with the product or not.

context - The context to associate with this operation.

Returns:

the Response<T>.

get

public abstract ProductContract get(String resourceGroupName, String serviceName, String productId)

Gets the details of the product specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

Returns:

the details of the product specified by its identifier.

getById

public abstract ProductContract getById(String id)

Gets the details of the product specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the product specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the product specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the product specified by its identifier.

getEntityTag

public abstract void getEntityTag(String resourceGroupName, String serviceName, String productId)

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

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

getEntityTagWithResponse

public abstract ProductsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String productId, Context context)

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

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

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

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String productId, Context context)

Gets the details of the product specified by its identifier.

Parameters:

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

serviceName - The name of the API Management service.

productId - Product identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the details of the product specified by its identifier.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName)

Lists a collection of products in the specified service instance.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

paged Products list representation as paginated response with PagedIterable<T>.

listByService

public abstract PagedIterable listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean expandGroups, String tags, Context context)

Lists a collection of products in the specified service instance.

Parameters:

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

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | |</br>| groups | expand | | |</br>.

top - Number of records to return.

skip - Number of records to skip.

expandGroups - When set to true, the response contains an array of groups that have visibility to the product. The default is false.

tags - Products which are part of a specific tag.

context - The context to associate with this operation.

Returns:

paged Products list representation as paginated response with PagedIterable<T>.

listByTags

public abstract PagedIterable listByTags(String resourceGroupName, String serviceName)

Lists a collection of products associated with tags.

Parameters:

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

serviceName - The name of the API Management service.

Returns:

paged Tag list representation as paginated response with PagedIterable<T>.

listByTags

public abstract PagedIterable listByTags(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean includeNotTaggedProducts, Context context)

Lists a collection of products associated with tags.

Parameters:

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

serviceName - The name of the API Management service.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| state | filter | eq | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

includeNotTaggedProducts - Include not tagged Products.

context - The context to associate with this operation.

Returns:

paged Tag list representation as paginated response with PagedIterable<T>.