Microsoft Azure FrontDoors API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Front Doors API
tags:
- name: FrontDoors
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoors:
    get:
      tags:
      - FrontDoors
      description: Lists all of the Front Doors within an Azure subscription.
      operationId: microsoftAzureFrontdoorsList
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontDoorListResult'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List all Front Doors:
          $ref: ./examples/FrontdoorListAll.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Frontdoors
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors:
    get:
      tags:
      - FrontDoors
      description: Lists all of the Front Doors within a resource group under a subscription.
      operationId: microsoftAzureFrontdoorsListbyresourcegroup
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontDoorListResult'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Front Doors in a Resource Group:
          $ref: ./examples/FrontdoorList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}:
    get:
      tags:
      - FrontDoors
      description: Gets a Front Door with the specified Front Door name under the specified subscription and resource group.
      operationId: microsoftAzureFrontdoorsGet
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontDoor'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Get Front Door:
          $ref: ./examples/FrontdoorGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname
    put:
      tags:
      - FrontDoors
      description: Creates a new Front Door with a Front Door name under the specified subscription and resource group.
      operationId: microsoftAzureFrontdoorsCreateorupdate
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontDoor'
        '201':
          description: Created. The request has been fulfilled and a new Front Door has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontDoor'
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontDoor'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Create or update specific Front Door:
          $ref: ./examples/FrontdoorCreate.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FrontDoor'
        description: Front Door properties needed to create a new Front Door.
        required: true
    delete:
      tags:
      - FrontDoors
      description: Deletes an existing Front Door with the specified parameters.
      operationId: microsoftAzureFrontdoorsDelete
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
        '204':
          description: No Content. The request has been accepted but the Front Door was not found.
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Delete Front Door:
          $ref: ./examples/FrontdoorDelete.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints
  : get:
      tags:
      - FrontDoors
      description: Lists all of the frontend endpoints within a Front Door.
      operationId: microsoftAzureFrontendendpointsListbyfrontdoor
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontendEndpointsListResult'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List Frontend endpoints in a Front Door:
          $ref: ./examples/FrontdoorFrontendEndpointList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Frontendendpoints
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}
  : get:
      tags:
      - FrontDoors
      description: Gets a Frontend endpoint with the specified name within the specified Front Door.
      operationId: microsoftAzureFrontendendpointsGet
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: '#/components/parameters/frontendEndpointNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrontendEndpoint'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Get Frontend Endpoint:
          $ref: ./examples/FrontdoorFrontendEndpointGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Frontendendpoints Frontendendpointname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge
  : post:
      tags:
      - FrontDoors
      description: Removes a content from Front Door.
      operationId: microsoftAzureEndpointsPurgecontent
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-examples:
        Purge content from Front Door:
          $ref: ./examples/FrontdoorPurgeContent.json
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Purge
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurgeParameters'
        description: The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/enableHttps
  : post:
      tags:
      - FrontDoors
      description: Enables a frontendEndpoint for HTTPS traffic
      operationId: microsoftAzureFrontendendpointsEnablehttps
      x-ms-examples:
        FrontendEndpoints_EnableHttps:
          $ref: ./examples/FrontdoorEnableHttps.json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: '#/components/parameters/frontendEndpointNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Frontendendpoints Frontendendpointname Enablehttps
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomHttpsConfiguration'
        description: The configuration specifying how to enable HTTPS
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/disableHttps
  : post:
      tags:
      - FrontDoors
      description: Disables a frontendEndpoint for HTTPS traffic
      operationId: microsoftAzureFrontendendpointsDisablehttps
      x-ms-examples:
        FrontendEndpoints_DisableHttps:
          $ref: ./examples/FrontdoorDisableHttps.json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: '#/components/parameters/frontendEndpointNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
        '202':
          description: Accepted and the operation will complete asynchronously.
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Frontendendpoints Frontendendpointname Disablehttps
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain
  : post:
      tags:
      - FrontDoors
      description: Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
      operationId: microsoftAzureFrontdoorsValidatecustomdomain
      x-ms-examples:
        FrontDoor_ValidateCustomDomain:
          $ref: ./examples/FrontdoorValidateCustomDomain.json
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/resourceGroupNameParameter'
      - $ref: '#/components/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateCustomDomainOutput'
        default:
          description: Front Door error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Validatecustomdomain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateCustomDomainInput'
        description: Custom domain to be validated.
        required: true
components:
  schemas:
    LoadBalancingSettingsProperties:
      description: The JSON object that contains the properties required to create load balancing settings
      allOf:
      - $ref: '#/components/schemas/LoadBalancingSettingsUpdateParameters'
      properties:
        resourceState:
          description: Resource status.
          $ref: '#/components/schemas/ResourceState'
    KeyVaultCertificateSourceParameters:
      description: Parameters required for bring-your-own-certification via Key Vault
      type: object
      properties:
        vault:
          description: The Key Vault containing the SSL certificate
          type: object
          properties:
            id:
              type: string
              description: Resource ID.
        secretName:
          type: string
          description: The name of the Key Vault secret representing the full certificate PFX
        secretVersion:
          type: string
          description: The version of the Key Vault secret representing the full certificate PFX
    LoadBalancingSettingsModel:
      properties:
        properties:
          description: Properties of the load balancing settings
          x-ms-client-flatten: true
          $ref: '#/components/schemas/LoadBalancingSettingsProperties'
        name:
          type: string
          description: Resource name.
        type:
          type: string
          readOnly: true
          description: Resource type.
      allOf:
      - $ref: ./network.json#/definitions/SubResource
      description: Load balancing settings for a backend pool
    BackendPool:
      properties:
        properties:
          description: Properties of the Front Door Backend Pool
          x-ms-client-flatten: true
          $ref: '#/components/schemas/BackendPoolProperties'
        name:
          type: string
          description: Resource name.
        type:
          type: string
          readOnly: true
          description: Resource type.
      allOf:
      - $ref: ./network.json#/definitions/SubResource
      description: A backend pool is a collection of backends that can be routed to.
    PurgeParameters:
      type: object
      description: Parameters required for content purge.
      required:
      - contentPaths
      properties:
        contentPaths:
          description: The path to the content to be purged. Can describe a file path or a wild card directory.
          type: array
          items:
            type: string
    FrontDoorCertificateSourceParameters:
      description: Parameters required for enabling SSL with Front Door-managed certificates
      type: object
      properties:
        certificateType:
          description: Defines the type of the certificate used for secure connections to a frontendEndpoint
          enum:
          - Dedicated
          type: string
          x-ms-enum:
            name: FrontDoorCertificateType
            modelAsString: true
    FrontendEndpointProperties:
      description: The JSON object that contains the properties required to create a frontend endpoint.
      allOf:
      - $ref: '#/components/schemas/FrontendEndpointUpdateParameters'
      properties:
        resourceState:
          description: Resource status.
          $ref: '#/components/schemas/ResourceState'
        customHttpsProvisioningState:
          description: Provisioning status of Custom Https of the frontendEndpoint.
          readOnly: true
          enum:
          - Enabling
          - Enabled
          - Disabling
          - Disabled
          - Failed
          type: string
          x-ms-enum:
            name: CustomHttpsProvisioningState
            modelAsString: true
        customHttpsProvisioningSubstate:
          description: Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
          readOnly: true
          enum:
          - SubmittingDomainControlValidationRequest
          - PendingDomainControlValidationREquestApproval
          - DomainControlValidationRequestApproved
          - DomainControlValidationRequestRejected
          - DomainControlValidationRequestTimedOut
          - IssuingCertificate
          - DeployingCertificate
          - CertificateDeployed
          - DeletingCertificate
          - CertificateDeleted
          type: string
          x-ms-enum:
            name: CustomHttpsProvisioningSubstate
            modelAsString: true
        customHttpsConfiguration:
          description: The configuration specifying how to enable HTTPS
          readOnly: true
          $ref: '#/components/schemas/CustomHttpsConfiguration'
    HealthProbeSettingsProperties:
      description: The JSON object that contains the properties required to create a health probe settings.
      allOf:
      - $ref: '#/components/schemas/HealthProbeSettingsUpdateParameters'
      properties:
        resourceState:
          description: Resource status.
          $ref: '#/components/schemas/ResourceState'
    FrontendEndpointUpdateParameters:
      description: Frontend endpoint used in routing rule
      type: object
      properties:
        hostName:
          description: The host name of the frontendEndpoint. Must be a domain name.
          type: string
        sessionAffinityEnabledState:
          description: Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: SessionAffinityEnabledState
            modelAsString: true
        sessionAffinityTtlSeconds:
          description: UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
          type: integer
        webApplicationFirewallPolicyLink:
          description: Defines the Web Application Firewall policy for each host (if applicable)
          type: object
          properties:
            id:
              type: string
              description: Resource ID.
    FrontDoorProperties:
      description: The JSON object that contains the properties required to create an endpoint.
      allOf:
      - $ref: '#/components/schemas/FrontDoorUpdateParameters'
      properties:
        resourceState:
          description: Resource status of the Front Door.
          $ref: '#/components/schemas/ResourceState'
        provisioningState:
          readOnly: true
          type: string
          description: Provisioning state of the Front Door.
        cname:
          readOnly: true
          type: string
          description: The host that each frontendEndpoint must CNAME to.
    RoutingRuleProperties:
      description: The JSON object that contains the properties required to create a routing rule.
      allOf:
      - $ref: '#/components/schemas/RoutingRuleUpdateParameters'
      properties:
        resourceState:
          description: Resource status.
          $ref: '#/components/schemas/ResourceState'
    RoutingRuleUpdateParameters:
      description: Routing rules to apply to an endpoint
      type: object
      properties:
        frontendEndpoints:
          description: Frontend endpoints associated with this rule
          type: array
          items:
            description: A reference to a frontend endpoint
            $ref: ./network.json#/definitions/SubResource
        acceptedProtocols:
          description: Protocol schemes to match for this rule
          type: array
          items:
            type: string
            description: Accepted protocol schemes.
            enum:
            - Http
            - Https
            x-ms-enum:
              name: FrontDoorProtocol
              modelAsString: true
        patternsToMatch:
          description: The route patterns of the rule.
          type: array
          items:
            type: string
            description: A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path.
        customForwardingPath:
          description: A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.
          type: string
        forwardingProtocol:
          description: Protocol this rule will use when forwarding traffic to backends.
          type: string
          enum:
          - HttpOnly
          - HttpsOnly
          - MatchRequest
          x-ms-enum:
            name: FrontDoorForwardingProtocol
            modelAsString: true
        cacheConfiguration:
          description: The caching configuration associated with this rule.
          $ref: '#/components/schemas/CacheConfiguration'
        backendPool:
          description: A reference to the BackendPool which this rule routes to.
          $ref: ./network.json#/definitions/SubResource
        enabledState:
          description: Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: FrontDoorEnabledState
            modelAsString: true
    ResourceState:
      title: Resource status of the Front Door or Front Door SubResource.
      readOnly: true
      enum:
      - Creating
      - Enabling
      - Enabled
      - Disabling
      - Disabled
      - Deleting
      type: string
      x-ms-enum:
        name: FrontDoorResourceState
        modelAsString: true
    ValidateCustomDomainInput:
      description: Input of the custom domain to be validated for DNS mapping.
      type: object
      required:
      - hostName
      properties:
        hostName:
          description: The host name of the custom domain. Must be a domain name.
          type: string
    BackendPoolUpdateParameters:
      description: A collection of backends that can be routed to.
      type: object
      properties:
        backends:
          description: The set of backends for this pool
          type: array
          items:
            $ref: '#/components/schemas/Backend'
        loadBalancingSettings:
          description: Load balancing settings for a backend pool
          $ref: ./network.json#/definitions/SubResource
        healthProbeSettings:
          description: L7 health probe settings for a backend pool
          $ref: ./network.json#/definitions/SubResource
    CacheConfiguration:
      description: Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.
      type: object
      properties:
        queryParameterStripDirective:
          description: Treatment of URL query terms when forming the cache key.
          enum:
          - StripNone
          - StripAll
          type: string
          x-ms-enum:
            name: FrontDoorQuery
            modelAsString: true
        dynamicCompression:
          description: Whether to use dynamic compression for cached content
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: DynamicCompressionEnabled
            modelAsString: true
    CustomHttpsConfiguration:
      description: Https settings for a domain
      type: object
      properties:
        certificateSource:
          description: Defines the source of the SSL certificate
          enum:
          - AzureKeyVault
          - FrontDoor
          type: string
          x-ms-enum:
            name: FrontDoorCertificateSource
            modelAsString: true
        protocolType:
          description: Defines the TLS extension protocol that is used for secure delivery
          enum:
          - ServerNameIndication
          type: string
          x-ms-enum:
            name: FrontDoorTlsProtocolType
            modelAsString: true
        keyVaultCertificateSourceParameters:
          description: KeyVault certificate source parameters (if certificateSource=AzureKeyVault)
          x-ms-client-flatten: true
          $ref: '#/components/schemas/KeyVaultCertificateSourceParameters'
        frontDoorCertificateSourceParameters:
          description: Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor)
          x-ms-client-flatten: true
          $ref: '#/components/schemas/FrontDoorCertificateSourceParameters'
    HealthProbeSettingsUpdateParameters:
      description: L7 health probe settings for a backend pool
      type: object
      properties:
        path:
          description: The path to use for the health probe. Default is /
          type: string
        protocol:
          description: Protocol scheme to use for this probe
          type: string
          enum:
          - Http
          - Https
          x-ms-enum:
            name: FrontDoorProtocol
            modelAsString: true
        intervalInSeconds:
          description: The number of seconds between health probes.
          type: integer
    ValidateCustomDomainOutput:
      description: Output of custom domain validation.
      type: object
      properties:
        customDomainValidated:
          description: Indicates whether the custom domain is valid or not.
          readOnly: true
          type: boolean
        reason:
          description: The reason why the custom domain is not valid.
          readOnly: true
          type: string
        message:
          description: Error message describing why the custom domain is not valid.
          readOnly: true
          type: string
    HealthProbeSettingsModel:
      properties:
        properties:
          description: Properties of the health probe settings
          x-ms-client-flatten: true
          $ref: '#/components/schemas/HealthProbeSettingsProperties'
        name:
          type: string
          description: Resource name.
        type:
          type: string
          readOnly: true
          description: Resource type.
      allOf:
      - $ref: ./network.json#/definitions/SubResource
      description: Load balancing settings for a backend pool
    LoadBalancingSettingsUpdateParameters:
      description: Round-Robin load balancing settings for a backend pool
      type: object
      properties:
        sampleSize:
          description: The number of samples to consider for load balancing decisions
          type: integer
        successfulSamplesRequired:
          description: The number of samples within the sample period that must succeed
          type: integer
        additionalLatencyMilliseconds:
          description: The additional latency in milliseconds for probes to fall into the lowest latency bucket
          type: integer
    FrontendEndpointsListResult:
      description: Result of the request to list frontend endpoints. It contains a list of Frontend endpoint objects and a URL link to get the next set of results.
      properties:
        value:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/FrontendEndpoint'
          description: List of Frontend endpoints within a Front Door.
        nextLink:
          type: string
          description: URL to get the next set of frontend endpoints if there are any.
    ErrorResponse:
      description: Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
      type: object
      properties:
        code:
          description: Error code.
          readOnly: true
          type: string
        message:
          description: Error message indicating why the operation failed.
          readOnly: true
          type: string
    Backend:
      description: Backend address of a frontDoor load balancer.
      type: object
      properties:
        address:
          description: Location of the backend (IP address or FQDN)
          type: string
        httpPort:
          description: The HTTP TCP port number. Must be between 1 and 65535.
          type: integer
          maximum: 65535
          minimum: 1
        httpsPort:
          description: The HTTPS TCP port number. Must be between 1 and 65535.
          type: integer
          maximum: 65535
          minimum: 1
        enabledState:
          description: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'
          enum

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-frontdoors-api-openapi.yml