Microsoft Azure FrontDoors API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector FrontDoors API
schemes:
- https
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.
          schema:
            $ref: '#/definitions/FrontDoorListResult'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/FrontDoorListResult'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/FrontDoor'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - description: Front Door properties needed to create a new Front Door.
        in: body
        name: frontDoorParameters
        required: true
        schema:
          $ref: '#/definitions/FrontDoor'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/FrontDoor'
        '201':
          description: Created. The request has been fulfilled and a new Front Door has been created.
          schema:
            $ref: '#/definitions/FrontDoor'
        '202':
          description: Accepted. The request has been accepted for processing and the operation will complete asynchronously.
          schema:
            $ref: '#/definitions/FrontDoor'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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
    delete:
      tags:
      - FrontDoors
      description: Deletes an existing Front Door with the specified parameters.
      operationId: microsoftAzureFrontdoorsDelete
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/FrontendEndpointsListResult'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - $ref: '#/parameters/frontendEndpointNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/FrontendEndpoint'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - name: contentFilePaths
        in: body
        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
        schema:
          $ref: '#/definitions/PurgeParameters'
      - $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.
          schema:
            $ref: '#/definitions/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
  ? /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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - $ref: '#/parameters/frontendEndpointNameParameter'
      - name: customHttpsConfiguration
        in: body
        description: The configuration specifying how to enable HTTPS
        required: true
        schema:
          $ref: '#/definitions/CustomHttpsConfiguration'
      - $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.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Frontendendpoints Frontendendpointname Enablehttps
  ? /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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - $ref: '#/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.
          schema:
            $ref: '#/definitions/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: '#/parameters/resourceGroupNameParameter'
      - $ref: '#/parameters/frontDoorNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - name: customDomainProperties
        in: body
        description: Custom domain to be validated.
        required: true
        schema:
          $ref: '#/definitions/ValidateCustomDomainInput'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ValidateCustomDomainOutput'
        default:
          description: Front Door error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Frontdoors Frontdoorname Validatecustomdomain
definitions:
  HealthProbeSettingsModel:
    properties:
      properties:
        description: Properties of the health probe settings
        x-ms-client-flatten: true
        $ref: '#/definitions/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
  FrontDoorListResult:
    description: Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.
    properties:
      value:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/FrontDoor'
        description: List of Front Doors within a resource group.
      nextLink:
        type: string
        description: URL to get the next set of Front Door objects if there are any.
  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: '#/definitions/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
  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
  BackendPool:
    properties:
      properties:
        description: Properties of the Front Door Backend Pool
        x-ms-client-flatten: true
        $ref: '#/definitions/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.
  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: '#/definitions/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.
  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: '#/definitions/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
  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
        exclusiveMaximum: false
        minimum: 1
        exclusiveMinimum: false
      httpsPort:
        description: The HTTPS TCP port number. Must be between 1 and 65535.
        type: integer
        maximum: 65535
        exclusiveMaximum: false
        minimum: 1
        exclusiveMinimum: false
      enabledState:
        description: Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: FrontDoorEnabledState
          modelAsString: true
      priority:
        description: Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.
        type: integer
        maximum: 5
        minimum: 1
      weight:
        description: Weight of this endpoint for load balancing purposes.
        type: integer
        maximum: 1000
        minimum: 1
      backendHostHeader:
        description: The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.
        type: string
  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
  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
  FrontDoorProperties:
    description: The JSON object that contains the properties required to create an endpoint.
    allOf:
    - $ref: '#/definitions/FrontDoorUpdateParameters'
    properties:
      resourceState:
        description: Resource status of the Front Door.
        $ref: '#/definitions/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.
  RoutingRule:
    properties:
      properties:
        description: Properties of the Front Door Routing Rule
        x-ms-client-flatten: true
        $ref: '#/definitions/RoutingRuleProperties'
      name:
        type: string
        description: Resource name.
      type:
        type: string
        readOnly: true
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: A routing rule represents a specification for traffic to treat and where to send it, along with health probe information.
  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
  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
  FrontDoorUpdateParameters:
    description: The properties needed to update a Front Door
    properties:
      friendlyName:
        description: A friendly name for the frontDoor
        type: string
      routingRules:
        description: Routing rules associated with this Front Door.
        type: array
        items:
          description: A routing rule
          $ref: '#/definitions/RoutingRule'
      loadBalancingSettings:
        description: Load balancing settings associated with this Front Door instance.
        type: array
        items:
          description: A load balancing settings
          $ref: '#/definitions/LoadBalancingSettingsModel'
      healthProbeSettings:
        description: Health probe settings associated with this Front Door instance.
        type: array
        items:
          description: A health probe settings
          $ref: '#/definitions/HealthProbeSettingsModel'
      backendPools:
        description: Backend pools available to routing rules.
        type: array
        items:
          description: A backend pool
          $ref: '#/definitions/BackendPool'
      frontendEndpoints:
        description: Frontend endpoints available to routing rules.
        type: array
        items:
          description: A frontend endpoint
          $ref: '#/definitions/FrontendEndpoint'
      enabledState:
        description: Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'
        enum:
        - Enabled
        - Disabled
        type: string
        x-ms-enum:
          name: FrontDoorEnabledState
          modelAsString: true
  FrontendEndpoint:
    properties:
      properties:
        description: Properties of the Frontend endpoint
        x-ms-client-flatten: true
        $ref: '#/definitions/FrontendEndpointProperties'
      name:
        type: string
        description: Resource name.
      type:
        type: string
        readOnly: true
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/SubResource
    description: A frontend endpoint used for routing.
  LoadBalancingSettingsProperties:
    description: The JSON object that contains the properties required to create load balancing settings
    allOf:
    - $ref: '#/definitions/LoadBalancingSettingsUpdateParameters'
    properties:
      resourceState:
        description: Resource status.
        $ref: '#/definitions/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.
  RoutingRuleProperties:
    description: The JSON object that contains the properties required to create a routing rule.
    allOf:
    - $ref: '#/definitions/RoutingRuleUpdateParameters'
    properties:
      resourceState:
        description: Resource status.
        $ref: '#/definitions/ResourceState'
  FrontendEndpointProperties:
    description: The JSON object that contains the properties required to create a frontend endpoint.
    allOf:
    - $ref: '#/definitions/FrontendEndpointUpdateParameters'
    properties:
      resourceState:
        description: Resource status.
        $ref: '#/definitions/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: '#/definitions/CustomHttpsConfiguration'
  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
  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: '#/definitions/KeyVaultCertificateSourceParameters'
      frontDoorCertificateSourceParameters:
        description: Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor)
        x-ms-client-flatten: true
        $ref: '#/definitions/FrontDoorCertificateSourceParameters'
  BackendPoolProperties:
    description: The JSON object that contains the properties required to create a routing rule.
    allOf:
    - $ref: '#/definitions/BackendPoolUpdateParameters'
    properties:
      resourceState:
        description: Resource status.
        $ref: '#/definitions/ResourceState'
  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
  HealthProbeSettingsProperties:
    description: The JSON object that contains the properties required to create a health probe settings.
    allOf:
    - $ref: '#/definitions/HealthProbeSettingsUpdateParameters'
    properties:
      resourceState:
        description: Resource status.
        $ref: '#/defini

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