Package com.azure.resourcemanager.frontdoor.models

Interface FrontDoor

public interface FrontDoor
An immutable client-side representation of FrontDoor.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • resourceState

      FrontDoorResourceState resourceState()
      Gets the resourceState property: Resource status of the Front Door or Front Door SubResource.

      Resource status of the Front Door.

      Returns:
      the resourceState value.

    • provisioningState

      String provisioningState()
      Gets the provisioningState property: Provisioning state of the Front Door.
      Returns:
      the provisioningState value.

    • cname

      String cname()
      Gets the cname property: The host that each frontendEndpoint must CNAME to.
      Returns:
      the cname value.

    • frontdoorId

      String frontdoorId()
      Gets the frontdoorId property: The Id of the frontdoor.
      Returns:
      the frontdoorId value.

    • rulesEngines

      List<RulesEngine> rulesEngines()
      Gets the rulesEngines property: Rules Engine Configurations available to routing rules.
      Returns:
      the rulesEngines value.

    • friendlyName

      String friendlyName()
      Gets the friendlyName property: A friendly name for the frontDoor.
      Returns:
      the friendlyName value.

    • routingRules

      List<RoutingRule> routingRules()
      Gets the routingRules property: Routing rules associated with this Front Door.
      Returns:
      the routingRules value.

    • loadBalancingSettings

      List<LoadBalancingSettingsModel> loadBalancingSettings()
      Gets the loadBalancingSettings property: Load balancing settings associated with this Front Door instance.
      Returns:
      the loadBalancingSettings value.

    • healthProbeSettings

      List<HealthProbeSettingsModel> healthProbeSettings()
      Gets the healthProbeSettings property: Health probe settings associated with this Front Door instance.
      Returns:
      the healthProbeSettings value.

    • backendPools

      List<BackendPool> backendPools()
      Gets the backendPools property: Backend pools available to routing rules.
      Returns:
      the backendPools value.

    • frontendEndpoints

      List<FrontendEndpoint> frontendEndpoints()
      Gets the frontendEndpoints property: Frontend endpoints available to routing rules.
      Returns:
      the frontendEndpoints value.

    • backendPoolsSettings

      BackendPoolsSettings backendPoolsSettings()
      Gets the backendPoolsSettings property: Settings for all backendPools.
      Returns:
      the backendPoolsSettings value.

    • enabledState

      FrontDoorEnabledState enabledState()
      Gets the enabledState property: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'.
      Returns:
      the enabledState value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      FrontDoorInner innerModel()
      Gets the inner com.azure.resourcemanager.frontdoor.fluent.models.FrontDoorInner object.
      Returns:
      the inner object.

    • update

      FrontDoor.Update update()
      Begins update for the FrontDoor resource.
      Returns:
      the stage of resource update.

    • refresh

      FrontDoor refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      FrontDoor refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • validateCustomDomainWithResponse

      com.azure.core.http.rest.Response<ValidateCustomDomainOutput> validateCustomDomainWithResponse(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:
      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(ValidateCustomDomainInput customDomainProperties)
      Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
      Parameters:
      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.