Package com.azure.resourcemanager.apimanagement.models

Interface ContentItems

public interface ContentItems

Resource collection API of ContentItems.

Method Summary

Modifier and Type	Method	Description
ContentItemContract	createOrUpdate(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)	Creates a new developer portal's content item specified by the provided content type.
com.azure.core.http.rest.Response<ContentItemContract>	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, String ifMatch, com.azure.core.util.Context context)	Creates a new developer portal's content item specified by the provided content type.
void	delete(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, String ifMatch)	Removes the specified developer portal's content item.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, String ifMatch, com.azure.core.util.Context context)	Removes the specified developer portal's content item.
ContentItemContract	get(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)	Returns the developer portal's content item specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId)	Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.
ContentItemsGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, com.azure.core.util.Context context)	Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.
com.azure.core.http.rest.Response<ContentItemContract>	getWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String contentItemId, com.azure.core.util.Context context)	Returns the developer portal's content item specified by its identifier.
com.azure.core.http.rest.PagedIterable<ContentItemContract>	listByService(String resourceGroupName, String serviceName, String contentTypeId)	Lists developer portal's content items specified by the provided content type.
com.azure.core.http.rest.PagedIterable<ContentItemContract>	listByService(String resourceGroupName, String serviceName, String contentTypeId, com.azure.core.util.Context context)	Lists developer portal's content items specified by the provided content type.

Method Detail

listByService

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

Lists developer portal's content items specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

Returns:

paged list of content items 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<ContentItemContract> listByService(String resourceGroupName,
                                                                          String serviceName,
                                                                          String contentTypeId,
                                                                          com.azure.core.util.Context context)

Lists developer portal's content items specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

context - The context to associate with this operation.

Returns:

paged list of content items 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 contentTypeId,
                  String contentItemId)

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item 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.

getEntityTagWithResponse

ContentItemsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                          String serviceName,
                                                          String contentTypeId,
                                                          String contentItemId,
                                                          com.azure.core.util.Context context)

Returns the entity state (ETag) version of the developer portal's content item specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

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.

get

ContentItemContract get(String resourceGroupName,
                        String serviceName,
                        String contentTypeId,
                        String contentItemId)

Returns the developer portal's content item specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

Returns:

content type contract 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.

getWithResponse

com.azure.core.http.rest.Response<ContentItemContract> getWithResponse(String resourceGroupName,
                                                                       String serviceName,
                                                                       String contentTypeId,
                                                                       String contentItemId,
                                                                       com.azure.core.util.Context context)

Returns the developer portal's content item specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

context - The context to associate with this operation.

Returns:

content type contract 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.

createOrUpdate

ContentItemContract createOrUpdate(String resourceGroupName,
                                   String serviceName,
                                   String contentTypeId,
                                   String contentItemId)

Creates a new developer portal's content item specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

Returns:

content type contract 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<ContentItemContract> createOrUpdateWithResponse(String resourceGroupName,
                                                                                  String serviceName,
                                                                                  String contentTypeId,
                                                                                  String contentItemId,
                                                                                  String ifMatch,
                                                                                  com.azure.core.util.Context context)

Creates a new developer portal's content item specified by the provided content type.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.

context - The context to associate with this operation.

Returns:

content type contract 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.

delete

void delete(String resourceGroupName,
            String serviceName,
            String contentTypeId,
            String contentItemId,
            String ifMatch)

Removes the specified developer portal's content item.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

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.

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 contentTypeId,
                                                           String contentItemId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Removes the specified developer portal's content item.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

contentItemId - Content item identifier.

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.

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.