Interface FrontDoors


public interface FrontDoors
Resource collection API of FrontDoors.
  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<FrontDoor> list()
      Lists all of the Front Doors within an Azure subscription.
      Returns:
      result of the request to list Front Doors as paginated response with PagedIterable.
      Throws:
      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<FrontDoor> list(com.azure.core.util.Context context)
      Lists all of the Front Doors within an Azure subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      result of the request to list Front Doors 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<FrontDoor> listByResourceGroup(String resourceGroupName)
      Lists all of the Front Doors within a resource group under a subscription.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      Returns:
      result of the request to list Front Doors 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.
    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<FrontDoor> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Lists all of the Front Doors within a resource group under a subscription.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      context - The context to associate with this operation.
      Returns:
      result of the request to list Front Doors 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.
    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<FrontDoor> getByResourceGroupWithResponse(String resourceGroupName, String frontDoorName, com.azure.core.util.Context context)
      Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      frontDoorName - Name of the Front Door which is globally unique.
      context - The context to associate with this operation.
      Returns:
      a Front Door with the specified Front Door name under the specified subscription and resource group 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.
    • getByResourceGroup

      FrontDoor getByResourceGroup(String resourceGroupName, String frontDoorName)
      Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      frontDoorName - Name of the Front Door which is globally unique.
      Returns:
      a Front Door with the specified Front Door name under the specified subscription and resource group.
      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.
    • deleteByResourceGroup

      void deleteByResourceGroup(String resourceGroupName, String frontDoorName)
      Deletes an existing Front Door with the specified parameters.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      frontDoorName - Name of the Front Door which is globally unique.
      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 frontDoorName, com.azure.core.util.Context context)
      Deletes an existing Front Door with the specified parameters.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      frontDoorName - Name of the Front Door which is globally unique.
      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.
    • validateCustomDomainWithResponse

      com.azure.core.http.rest.Response<ValidateCustomDomainOutput> validateCustomDomainWithResponse(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties, com.azure.core.util.Context context)
      Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      frontDoorName - Name of the Front Door which is globally unique.
      customDomainProperties - Custom domain to be validated.
      context - The context to associate with this operation.
      Returns:
      output of custom domain validation 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.
    • validateCustomDomain

      ValidateCustomDomainOutput validateCustomDomain(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties)
      Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
      Parameters:
      resourceGroupName - Name of the Resource group within the Azure subscription.
      frontDoorName - Name of the Front Door which is globally unique.
      customDomainProperties - Custom domain to be validated.
      Returns:
      output of custom domain validation.
      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

      FrontDoor getById(String id)
      Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
      Parameters:
      id - the resource ID.
      Returns:
      a Front Door with the specified Front Door name under the specified subscription and resource group 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.
    • getByIdWithResponse

      com.azure.core.http.rest.Response<FrontDoor> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      a Front Door with the specified Front Door name under the specified subscription and resource group 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.
    • deleteById

      void deleteById(String id)
      Deletes an existing Front Door with the specified parameters.
      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

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes an existing Front Door with the specified parameters.
      Parameters:
      id - the resource ID.
      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.
    • define

      Begins definition for a new FrontDoor resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new FrontDoor definition.