Package com.azure.resourcemanager.apimanagement.models

Interface ProductApis

public interface ProductApis

Resource collection API of ProductApis.

Method Summary

Modifier and Type	Method	Description
void	checkEntityExists(String resourceGroupName, String serviceName, String productId, String apiId)	Checks that API entity specified by identifier is associated with the Product entity.
com.azure.core.http.rest.Response<Void>	checkEntityExistsWithResponse(String resourceGroupName, String serviceName, String productId, String apiId, com.azure.core.util.Context context)	Checks that API entity specified by identifier is associated with the Product entity.
ApiContract	createOrUpdate(String resourceGroupName, String serviceName, String productId, String apiId)	Adds an API to the specified product.
com.azure.core.http.rest.Response<ApiContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String productId, String apiId, com.azure.core.util.Context context)	Adds an API to the specified product.
void	delete(String resourceGroupName, String serviceName, String productId, String apiId)	Deletes the specified API from the specified product.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String productId, String apiId, com.azure.core.util.Context context)	Deletes the specified API from the specified product.
com.azure.core.http.rest.PagedIterable<ApiContract>	listByProduct(String resourceGroupName, String serviceName, String productId)	Lists a collection of the APIs associated with a product.
com.azure.core.http.rest.PagedIterable<ApiContract>	listByProduct(String resourceGroupName, String serviceName, String productId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists a collection of the APIs associated with a product.

Method Detail

listByProduct

com.azure.core.http.rest.PagedIterable<ApiContract> listByProduct(String resourceGroupName,
                                                                  String serviceName,
                                                                  String productId)

Lists a collection of the APIs associated with a product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

Returns:

paged API list representation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

listByProduct

com.azure.core.http.rest.PagedIterable<ApiContract> listByProduct(String resourceGroupName,
                                                                  String serviceName,
                                                                  String productId,
                                                                  String filter,
                                                                  Integer top,
                                                                  Integer skip,
                                                                  com.azure.core.util.Context context)

Lists a collection of the APIs associated with a product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged API list representation as paginated response with PagedIterable.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkEntityExists

void checkEntityExists(String resourceGroupName,
                       String serviceName,
                       String productId,
                       String apiId)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

checkEntityExistsWithResponse

com.azure.core.http.rest.Response<Void> checkEntityExistsWithResponse(String resourceGroupName,
                                                                      String serviceName,
                                                                      String productId,
                                                                      String apiId,
                                                                      com.azure.core.util.Context context)

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

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdate

ApiContract createOrUpdate(String resourceGroupName,
                           String serviceName,
                           String productId,
                           String apiId)

Adds an API to the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

Returns:

aPI details.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createOrUpdateWithResponse

com.azure.core.http.rest.Response<ApiContract> createOrUpdateWithResponse(String resourceGroupName,
                                                                          String serviceName,
                                                                          String productId,
                                                                          String apiId,
                                                                          com.azure.core.util.Context context)

Adds an API to the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

context - The context to associate with this operation.

Returns:

aPI details along with Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

void delete(String resourceGroupName,
            String serviceName,
            String productId,
            String apiId)

Deletes the specified API from the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String productId,
                                                           String apiId,
                                                           com.azure.core.util.Context context)

Deletes the specified API from the specified product.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

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

context - The context to associate with this operation.

Returns:

the Response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.