Package com.azure.resourcemanager.apimanagement.models

Interface PortalRevisions

public interface PortalRevisions

Resource collection API of PortalRevisions.

Method Summary

Modifier and Type	Method	Description
PortalRevisionContract.DefinitionStages.Blank	define(String name)	Begins definition for a new PortalRevisionContract resource.
PortalRevisionContract	get(String resourceGroupName, String serviceName, String portalRevisionId)	Gets the developer portal's revision specified by its identifier.
PortalRevisionContract	getById(String id)	Gets the developer portal's revision specified by its identifier.
com.azure.core.http.rest.Response<PortalRevisionContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the developer portal's revision specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String portalRevisionId)	Gets the developer portal revision specified by its identifier.
PortalRevisionsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String portalRevisionId, com.azure.core.util.Context context)	Gets the developer portal revision specified by its identifier.
com.azure.core.http.rest.Response<PortalRevisionContract>	getWithResponse(String resourceGroupName, String serviceName, String portalRevisionId, com.azure.core.util.Context context)	Gets the developer portal's revision specified by its identifier.
com.azure.core.http.rest.PagedIterable<PortalRevisionContract>	listByService(String resourceGroupName, String serviceName)	Lists developer portal's revisions.
com.azure.core.http.rest.PagedIterable<PortalRevisionContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, com.azure.core.util.Context context)	Lists developer portal's revisions.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<PortalRevisionContract> listByService(String resourceGroupName,
                                                                             String serviceName)

Lists developer portal's revisions.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

paged list of portal revisions 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.

listByService

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

Lists developer portal's revisions.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

filter - | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------|

|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq, ne | |.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged list of portal revisions 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.

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName,
                  String portalRevisionId)

Gets the developer portal revision specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.

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.

getEntityTagWithResponse

PortalRevisionsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                             String serviceName,
                                                             String portalRevisionId,
                                                             com.azure.core.util.Context context)

Gets the developer portal revision specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the developer portal revision specified by its identifier.

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.

get

PortalRevisionContract get(String resourceGroupName,
                           String serviceName,
                           String portalRevisionId)

Gets the developer portal's revision specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.

Returns:

the developer portal's revision specified by its identifier.

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.

getWithResponse

com.azure.core.http.rest.Response<PortalRevisionContract> getWithResponse(String resourceGroupName,
                                                                          String serviceName,
                                                                          String portalRevisionId,
                                                                          com.azure.core.util.Context context)

Gets the developer portal's revision specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

portalRevisionId - Portal revision identifier. Must be unique in the current API Management service instance.

context - The context to associate with this operation.

Returns:

the developer portal's revision specified by its identifier.

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.

getById

PortalRevisionContract getById(String id)

Gets the developer portal's revision specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the developer portal's revision specified by its identifier.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<PortalRevisionContract> getByIdWithResponse(String id,
                                                                              com.azure.core.util.Context context)

Gets the developer portal's revision specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the developer portal's revision specified by its identifier.

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.

define

PortalRevisionContract.DefinitionStages.Blank define(String name)

Begins definition for a new PortalRevisionContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PortalRevisionContract definition.