Package com.azure.resourcemanager.apimanagement.models

Interface PortalConfigs

public interface PortalConfigs
Resource collection API of PortalConfigs.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<PortalConfigContract> listByService(String resourceGroupName, String serviceName)
      Lists the developer portal configurations.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      Returns:
      the collection of the developer portal configurations 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<PortalConfigContract> listByService(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Lists the developer portal configurations.
      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:
      the collection of the developer portal configurations 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.

    • getEntityTagWithResponse

      PortalConfigsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String portalConfigId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the developer portal configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalConfigId - Portal configuration identifier.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the developer portal configuration.
      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 portalConfigId)
      Gets the entity state (Etag) version of the developer portal configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalConfigId - Portal configuration 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<PortalConfigContract> getWithResponse(String resourceGroupName, String serviceName, String portalConfigId, com.azure.core.util.Context context)
      Get the developer portal configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalConfigId - Portal configuration identifier.
      context - The context to associate with this operation.
      Returns:
      the developer portal configuration.
      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

      PortalConfigContract get(String resourceGroupName, String serviceName, String portalConfigId)
      Get the developer portal configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      portalConfigId - Portal configuration identifier.
      Returns:
      the developer portal configuration.
      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

      PortalConfigContract getById(String id)
      Get the developer portal configuration.
      Parameters:
      id - the resource ID.
      Returns:
      the developer portal configuration.
      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<PortalConfigContract> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Get the developer portal configuration.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the developer portal configuration.
      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

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