Package com.azure.resourcemanager.apimanagement.fluent

Interface ContentTypesClient

public interface ContentTypesClient

An instance of this class provides access to all the operations defined in ContentTypesClient.

Method Summary

Modifier and Type	Method	Description
ContentTypeContractInner	createOrUpdate(String resourceGroupName, String serviceName, String contentTypeId)	Creates or updates the developer portal's content type.
ContentTypesCreateOrUpdateResponse	createOrUpdateWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String ifMatch, com.azure.core.util.Context context)	Creates or updates the developer portal's content type.
void	delete(String resourceGroupName, String serviceName, String contentTypeId, String ifMatch)	Removes the specified developer portal's content type.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String contentTypeId, String ifMatch, com.azure.core.util.Context context)	Removes the specified developer portal's content type.
ContentTypeContractInner	get(String resourceGroupName, String serviceName, String contentTypeId)	Gets the details of the developer portal's content type.
ContentTypesGetResponse	getWithResponse(String resourceGroupName, String serviceName, String contentTypeId, com.azure.core.util.Context context)	Gets the details of the developer portal's content type.
com.azure.core.http.rest.PagedIterable<ContentTypeContractInner>	listByService(String resourceGroupName, String serviceName)	Lists the developer portal's content types.
com.azure.core.http.rest.PagedIterable<ContentTypeContractInner>	listByService(String resourceGroupName, String serviceName, com.azure.core.util.Context context)	Lists the developer portal's content types.

Method Detail

listByService

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

Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

Returns:

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

Lists the developer portal's content types. Content types describe content items' properties, validation rules, and constraints.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

context - The context to associate with this operation.

Returns:

paged list of content types 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.

get

ContentTypeContractInner get(String resourceGroupName,
                             String serviceName,
                             String contentTypeId)

Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type identifier.

Returns:

the details of the developer portal's content type.

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

ContentTypesGetResponse getWithResponse(String resourceGroupName,
                                        String serviceName,
                                        String contentTypeId,
                                        com.azure.core.util.Context context)

Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.

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:

the details of the developer portal's content type.

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

ContentTypeContractInner createOrUpdate(String resourceGroupName,
                                        String serviceName,
                                        String contentTypeId)

Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type 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

ContentTypesCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName,
                                                              String serviceName,
                                                              String contentTypeId,
                                                              String ifMatch,
                                                              com.azure.core.util.Context context)

Creates or updates the developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Custom content types' identifiers need to start with the `c-` prefix. Built-in content types can't be modified.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type 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 ifMatch)

Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

Removes the specified developer portal's content type. Content types describe content items' properties, validation rules, and constraints. Built-in content types (with identifiers starting with the `c-` prefix) can't be removed.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

contentTypeId - Content type 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.