Package com.azure.resourcemanager.apimanagement.models

Interface ContentTypes

public interface ContentTypes
Resource collection API of ContentTypes.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<ContentTypeContract> 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. The name is case insensitive.
      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<ContentTypeContract> 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. The name is case insensitive.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<ContentTypeContract> 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. The name is case insensitive.
      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.

    • get

      ContentTypeContract 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. The name is case insensitive.
      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.

    • 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. The name is case insensitive.
      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.

    • 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. The name is case insensitive.
      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.

    • getById

      ContentTypeContract getById(String id)
      Gets the details of the developer portal's content type. Content types describe content items' properties, validation rules, and constraints.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ContentTypeContract> getByIdWithResponse(String id, 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:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      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:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, 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:
      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.
      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.

    • define

      ContentTypeContract.DefinitionStages.Blank define(String name)
      Begins definition for a new ContentTypeContract resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new ContentTypeContract definition.