Package com.azure.resourcemanager.appplatform.fluent

Interface ApiPortalsClient

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

  • Method Details

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ApiPortalResourceInner>> getWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName)
      Get the API portal and its properties.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      the API portal and its properties along with Response on successful completion of Mono.
      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.

    • getAsync

      Mono<ApiPortalResourceInner> getAsync(String resourceGroupName, String serviceName, String apiPortalName)
      Get the API portal and its properties.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      the API portal and its properties on successful completion of Mono.
      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

      ApiPortalResourceInner get(String resourceGroupName, String serviceName, String apiPortalName)
      Get the API portal and its properties.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      the API portal and its properties.
      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<ApiPortalResourceInner> getWithResponse(String resourceGroupName, String serviceName, String apiPortalName, com.azure.core.util.Context context)
      Get the API portal and its properties.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      context - The context to associate with this operation.
      Returns:
      the API portal and its properties 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.

    • createOrUpdateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      Returns:
      aPI portal resource along with Response on successful completion of Mono.
      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.

    • beginCreateOrUpdateAsync

      com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<ApiPortalResourceInner>,ApiPortalResourceInner> beginCreateOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      Returns:
      the PollerFlux for polling of aPI portal resource.
      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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiPortalResourceInner>,ApiPortalResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      Returns:
      the SyncPoller for polling of aPI portal resource.
      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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiPortalResourceInner>,ApiPortalResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource, com.azure.core.util.Context context)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of aPI portal resource.
      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.

    • createOrUpdateAsync

      Mono<ApiPortalResourceInner> createOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      Returns:
      aPI portal resource on successful completion of Mono.
      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

      ApiPortalResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      Returns:
      aPI portal resource.
      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

      ApiPortalResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, ApiPortalResourceInner apiPortalResource, com.azure.core.util.Context context)
      Create the default API portal or update the existing API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      apiPortalResource - The API portal for the create or update operation.
      context - The context to associate with this operation.
      Returns:
      aPI portal resource.
      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.

    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      the Response on successful completion of Mono.
      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.

    • beginDeleteAsync

      com.azure.core.util.polling.PollerFlux<com.azure.core.management.polling.PollResult<Void>,Void> beginDeleteAsync(String resourceGroupName, String serviceName, String apiPortalName)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      the PollerFlux for polling of long-running operation.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String apiPortalName)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String serviceName, String apiPortalName, com.azure.core.util.Context context)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running operation.
      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.

    • deleteAsync

      Mono<Void> deleteAsync(String resourceGroupName, String serviceName, String apiPortalName)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      Returns:
      A Mono that completes when a successful response is received.
      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 apiPortalName)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      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 apiPortalName, com.azure.core.util.Context context)
      Delete the default API portal.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      context - The context to associate with this operation.
      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.

    • listAsync

      com.azure.core.http.rest.PagedFlux<ApiPortalResourceInner> listAsync(String resourceGroupName, String serviceName)
      Handles requests to list all resources in a Service.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      Returns:
      object that includes an array of API portal resources and a possible link for next set as paginated response with PagedFlux.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<ApiPortalResourceInner> list(String resourceGroupName, String serviceName)
      Handles requests to list all resources in a Service.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      Returns:
      object that includes an array of API portal resources and a possible link for next set 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.

    • list

      com.azure.core.http.rest.PagedIterable<ApiPortalResourceInner> list(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Handles requests to list all resources in a Service.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      context - The context to associate with this operation.
      Returns:
      object that includes an array of API portal resources and a possible link for next set 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.

    • validateDomainWithResponseAsync

      Mono<com.azure.core.http.rest.Response<CustomDomainValidateResult>> validateDomainWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)
      Check the domains are valid as well as not in use.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      validatePayload - Custom domain payload to be validated.
      Returns:
      validation result for custom domain along with Response on successful completion of Mono.
      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.

    • validateDomainAsync

      Mono<CustomDomainValidateResult> validateDomainAsync(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)
      Check the domains are valid as well as not in use.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      validatePayload - Custom domain payload to be validated.
      Returns:
      validation result for custom domain on successful completion of Mono.
      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.

    • validateDomain

      CustomDomainValidateResult validateDomain(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload)
      Check the domains are valid as well as not in use.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      validatePayload - Custom domain payload to be validated.
      Returns:
      validation result for custom domain.
      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.

    • validateDomainWithResponse

      com.azure.core.http.rest.Response<CustomDomainValidateResult> validateDomainWithResponse(String resourceGroupName, String serviceName, String apiPortalName, CustomDomainValidatePayload validatePayload, com.azure.core.util.Context context)
      Check the domains are valid as well as not in use.
      Parameters:
      resourceGroupName - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      serviceName - The name of the Service resource.
      apiPortalName - The name of API portal.
      validatePayload - Custom domain payload to be validated.
      context - The context to associate with this operation.
      Returns:
      validation result for custom domain 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.