Package com.azure.resourcemanager.apimanagement.fluent

Interface PortalConfigsClient

public interface PortalConfigsClient
An instance of this class provides access to all the operations defined in PortalConfigsClient.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<PortalConfigContractInner> 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<PortalConfigContractInner> 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

      PortalConfigsGetResponse 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

      PortalConfigContractInner 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.

    • updateWithResponse

      com.azure.core.http.rest.Response<PortalConfigContractInner> updateWithResponse(String resourceGroupName, String serviceName, String portalConfigId, String ifMatch, PortalConfigContractInner parameters, com.azure.core.util.Context context)
      Update 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.
      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.
      parameters - Update the developer portal configuration.
      context - The context to associate with this operation.
      Returns:
      the developer portal configuration contract along with 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.

    • update

      PortalConfigContractInner update(String resourceGroupName, String serviceName, String portalConfigId, String ifMatch, PortalConfigContractInner parameters)
      Update 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.
      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.
      parameters - Update the developer portal configuration.
      Returns:
      the developer portal configuration contract.
      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<PortalConfigContractInner> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String portalConfigId, String ifMatch, PortalConfigContractInner parameters, com.azure.core.util.Context context)
      Create or update 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.
      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.
      parameters - Update the developer portal configuration.
      context - The context to associate with this operation.
      Returns:
      the developer portal configuration contract along with 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.

    • createOrUpdate

      PortalConfigContractInner createOrUpdate(String resourceGroupName, String serviceName, String portalConfigId, String ifMatch, PortalConfigContractInner parameters)
      Create or update 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.
      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.
      parameters - Update the developer portal configuration.
      Returns:
      the developer portal configuration contract.
      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.