Package com.azure.resourcemanager.appplatform.fluent

Interface ApiPortalCustomDomainsClient

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

  • Method Details

    • getWithResponseAsync

      Mono<com.azure.core.http.rest.Response<ApiPortalCustomDomainResourceInner>> getWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, String domainName)
      Get the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      Returns:
      the API portal 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.

    • getAsync

      Mono<ApiPortalCustomDomainResourceInner> getAsync(String resourceGroupName, String serviceName, String apiPortalName, String domainName)
      Get the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      Returns:
      the API portal 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.

    • get

      ApiPortalCustomDomainResourceInner get(String resourceGroupName, String serviceName, String apiPortalName, String domainName)
      Get the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      Returns:
      the API portal 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.

    • getWithResponse

      com.azure.core.http.rest.Response<ApiPortalCustomDomainResourceInner> getWithResponse(String resourceGroupName, String serviceName, String apiPortalName, String domainName, com.azure.core.util.Context context)
      Get the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      context - The context to associate with this operation.
      Returns:
      the API portal 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.

    • createOrUpdateWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> createOrUpdateWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      Returns:
      custom domain of the API portal 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<ApiPortalCustomDomainResourceInner>,ApiPortalCustomDomainResourceInner> beginCreateOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      Returns:
      the PollerFlux for polling of custom domain of the 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiPortalCustomDomainResourceInner>,ApiPortalCustomDomainResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      Returns:
      the SyncPoller for polling of custom domain of the 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiPortalCustomDomainResourceInner>,ApiPortalCustomDomainResourceInner> beginCreateOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource, com.azure.core.util.Context context)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of custom domain of the 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.

    • createOrUpdateAsync

      Mono<ApiPortalCustomDomainResourceInner> createOrUpdateAsync(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      Returns:
      custom domain of the API portal 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

      ApiPortalCustomDomainResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      Returns:
      custom domain of the 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.

    • createOrUpdate

      ApiPortalCustomDomainResourceInner createOrUpdate(String resourceGroupName, String serviceName, String apiPortalName, String domainName, ApiPortalCustomDomainResourceInner apiPortalCustomDomainResource, com.azure.core.util.Context context)
      Create or update the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      apiPortalCustomDomainResource - The API portal custom domain for the create or update operation.
      context - The context to associate with this operation.
      Returns:
      custom domain of the 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.

    • deleteWithResponseAsync

      Mono<com.azure.core.http.rest.Response<Flux<ByteBuffer>>> deleteWithResponseAsync(String resourceGroupName, String serviceName, String apiPortalName, String domainName)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      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, String domainName)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      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, String domainName)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      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, String domainName, com.azure.core.util.Context context)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      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, String domainName)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      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, String domainName)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal 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.

    • delete

      void delete(String resourceGroupName, String serviceName, String apiPortalName, String domainName, com.azure.core.util.Context context)
      Delete the API portal custom domain.
      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.
      domainName - The name of the API portal custom domain.
      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<ApiPortalCustomDomainResourceInner> listAsync(String resourceGroupName, String serviceName, String apiPortalName)
      Handle requests to list all API portal custom domains.
      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:
      object that includes an array of API portal custom domain 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<ApiPortalCustomDomainResourceInner> list(String resourceGroupName, String serviceName, String apiPortalName)
      Handle requests to list all API portal custom domains.
      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:
      object that includes an array of API portal custom domain 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<ApiPortalCustomDomainResourceInner> list(String resourceGroupName, String serviceName, String apiPortalName, com.azure.core.util.Context context)
      Handle requests to list all API portal custom domains.
      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:
      object that includes an array of API portal custom domain 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.