openapi-directory/api/azure.com/frontdoor.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure.","title":"FrontDoorManagementClient","version":"2018-08-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"frontdoor","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Network/checkFrontDoorNameAvailability":{"post":{"description":"Check the availability of a Front Door resource name.","operationId":"CheckFrontDoorNameAvailability","parameters":[{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"CheckNameAvailability":{"value":"2018-08-01"}}}],"requestBody":{"$ref":"#/components/requestBodies/CheckNameAvailabilityInput"},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityOutput"},"examples":{"CheckNameAvailability":{"$ref":"#/components/examples/CheckNameAvailability"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["CheckFrontDoorNameAvailability"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Network/checkFrontDoorNameAvailability":{"post":{"description":"Check the availability of a Front Door subdomain.","operationId":"CheckFrontDoorNameAvailabilityWithSubscription","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"CheckNameAvailabilityWithSubscription":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"CheckNameAvailabilityWithSubscription":{"value":"2018-08-01"}}}],"requestBody":{"$ref":"#/components/requestBodies/CheckNameAvailabilityInput"},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckNameAvailabilityOutput"},"examples":{"CheckNameAvailabilityWithSubscription":{"$ref":"#/components/examples/CheckNameAvailabilityWithSubscription"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["CheckFrontDoorNameAvailabilityWithSubscription"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoors":{"get":{"description":"Lists all of the Front Doors within an Azure subscription.","operationId":"FrontDoors_List","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all Front Doors":{"value":"subid"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Front Doors":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoorListResult"},"examples":{"List all Front Doors":{"$ref":"#/components/examples/List_all_Front_Doors"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/provider/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}":{"delete":{"description":"Deletes an existing frontend endpoint with the specified parameters.","operationId":"FrontendEndpoints_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete Backend Pool":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/frontendEndpointNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete Backend Pool":{"value":"2018-08-01"}}}],"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 Backend Pool was not found."},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true},"get":{"description":"Gets a Frontend endpoint with the specified name within the specified Front Door.","operationId":"FrontendEndpoints_Get","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Frontend Endpoint":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/frontendEndpointNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Frontend Endpoint":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontendEndpoint"},"examples":{"Get Frontend Endpoint":{"$ref":"#/components/examples/Get_Frontend_Endpoint"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]},"put":{"description":"Creates a new frontend endpoint with the specified host name within the specified Front Door.","operationId":"FrontendEndpoints_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Frontend Endpoint":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/frontendEndpointNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Frontend Endpoint":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontendEndpoint"}}},"description":"Frontend endpoint properties needed to create a new endpoint.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontendEndpoint"},"examples":{"Create or update specific Frontend Endpoint":{"$ref":"#/components/examples/Create_or_update_specific_Frontend_Endpoint"}}}}},"201":{"description":"Created. The request has been fulfilled and a new frontend endpoint has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontendEndpoint"},"examples":{"Create or update specific Frontend Endpoint":{"$ref":"#/components/examples/Create_or_update_specific_Frontend_Endpoint"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontendEndpoint"},"examples":{"Create or update specific Frontend Endpoint":{"$ref":"#/components/examples/Create_or_update_specific_Frontend_Endpoint"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/provider/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/disableHttps":{"post":{"description":"Disables a frontendEndpoint for HTTPS traffic","operationId":"FrontendEndpoints_DisableHttps","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"FrontendEndpoints_DisableHttps":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/frontendEndpointNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"FrontendEndpoints_DisableHttps":{"value":"2018-08-01"}}}],"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"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/provider/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/enableHttps":{"post":{"description":"Enables a frontendEndpoint for HTTPS traffic","operationId":"FrontendEndpoints_EnableHttps","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"FrontendEndpoints_EnableHttps":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/frontendEndpointNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"FrontendEndpoints_EnableHttps":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomHttpsConfiguration"}}},"description":"The configuration specifying how to enable HTTPS","required":true},"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"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors":{"get":{"description":"Lists all of the Front Doors within a resource group under a subscription.","operationId":"FrontDoors_ListByResourceGroup","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List Front Doors in a Resource Group":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List Front Doors in a Resource Group":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoorListResult"},"examples":{"List Front Doors in a Resource Group":{"$ref":"#/components/examples/List_Front_Doors_in_a_Resource_Group"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}":{"delete":{"description":"Deletes an existing Front Door with the specified parameters.","operationId":"FrontDoors_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete Front Door":{"value":"2018-08-01"}}}],"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"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true},"get":{"description":"Gets a Front Door with the specified Front Door name under the specified subscription and resource group.","operationId":"FrontDoors_Get","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Front Door":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoor"},"examples":{"Get Front Door":{"$ref":"#/components/examples/Get_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]},"put":{"description":"Creates a new Front Door with a Front Door name under the specified subscription and resource group.","operationId":"FrontDoors_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Front Door":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoor"}}},"description":"Front Door properties needed to create a new Front Door.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoor"},"examples":{"Create or update specific Front Door":{"$ref":"#/components/examples/Create_or_update_specific_Front_Door"}}}}},"201":{"description":"Created. The request has been fulfilled and a new Front Door has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoor"},"examples":{"Create or update specific Front Door":{"$ref":"#/components/examples/Create_or_update_specific_Front_Door"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontDoor"},"examples":{"Create or update specific Front Door":{"$ref":"#/components/examples/Create_or_update_specific_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/backendPools":{"get":{"description":"Lists all of the Backend Pools within a Front Door.","operationId":"BackendPools_ListByFrontDoor","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List Backend Pools in a Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List Backend Pools in a Front Door":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendPoolListResult"},"examples":{"List Backend Pools in a Front Door":{"$ref":"#/components/examples/List_Backend_Pools_in_a_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/backendPools/{backendPoolName}":{"delete":{"description":"Deletes an existing Backend Pool with the specified parameters.","operationId":"BackendPools_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete Backend Pool":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/backendPoolNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete Backend Pool":{"value":"2018-08-01"}}}],"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 Backend Pool was not found."},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true},"get":{"description":"Gets a Backend Pool with the specified Pool name within the specified Front Door.","operationId":"BackendPools_Get","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Backend Pool":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/backendPoolNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Backend Pool":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendPool"},"examples":{"Get Backend Pool":{"$ref":"#/components/examples/Get_Backend_Pool"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]},"put":{"description":"Creates a new Backend Pool with the specified Pool name within the specified Front Door.","operationId":"BackendPools_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Backend Pool":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/backendPoolNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Backend Pool":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendPool"}}},"description":"Backend Pool properties needed to create a new Pool.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendPool"},"examples":{"Create or update specific Backend Pool":{"$ref":"#/components/examples/Create_or_update_specific_Backend_Pool"}}}}},"201":{"description":"Created. The request has been fulfilled and a new BackendPool has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendPool"},"examples":{"Create or update specific Backend Pool":{"$ref":"#/components/examples/Create_or_update_specific_Backend_Pool"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackendPool"},"examples":{"Create or update specific Backend Pool":{"$ref":"#/components/examples/Create_or_update_specific_Backend_Pool"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints":{"get":{"description":"Lists all of the frontend endpoints within a Front Door.","operationId":"FrontendEndpoints_ListByFrontDoor","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List Frontend endpoints in a Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List Frontend endpoints in a Front Door":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FrontendEndpointsListResult"},"examples":{"List Frontend endpoints in a Front Door":{"$ref":"#/components/examples/List_Frontend_endpoints_in_a_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/healthProbeSettings":{"get":{"description":"Lists all of the HealthProbeSettings within a Front Door.","operationId":"HealthProbeSettings_ListByFrontDoor","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List HealthProbeSettings in a Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List HealthProbeSettings in a Front Door":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthProbeSettingsListResult"},"examples":{"List HealthProbeSettings in a Front Door":{"$ref":"#/components/examples/List_HealthProbeSettings_in_a_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/healthProbeSettings/{healthProbeSettingsName}":{"delete":{"description":"Deletes an existing HealthProbeSettings with the specified parameters.","operationId":"HealthProbeSettings_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete HealthProbeSettings":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/healthProbeSettingsNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete HealthProbeSettings":{"value":"2018-08-01"}}}],"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 HealthProbeSettings was not found."},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true},"get":{"description":"Gets a HealthProbeSettings with the specified Rule name within the specified Front Door.","operationId":"HealthProbeSettings_Get","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get HealthProbeSettings":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/healthProbeSettingsNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get HealthProbeSettings":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthProbeSettingsModel"},"examples":{"Get HealthProbeSettings":{"$ref":"#/components/examples/Get_HealthProbeSettings"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]},"put":{"description":"Creates a new HealthProbeSettings with the specified Rule name within the specified Front Door.","operationId":"HealthProbeSettings_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update specific HealthProbeSettings":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/healthProbeSettingsNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update specific HealthProbeSettings":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthProbeSettingsModel"}}},"description":"HealthProbeSettings properties needed to create a new Front Door.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthProbeSettingsModel"},"examples":{"Create or update specific HealthProbeSettings":{"$ref":"#/components/examples/Create_or_update_specific_HealthProbeSettings"}}}}},"201":{"description":"Created. The request has been fulfilled and a new HealthProbeSettings has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthProbeSettingsModel"},"examples":{"Create or update specific HealthProbeSettings":{"$ref":"#/components/examples/Create_or_update_specific_HealthProbeSettings"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthProbeSettingsModel"},"examples":{"Create or update specific HealthProbeSettings":{"$ref":"#/components/examples/Create_or_update_specific_HealthProbeSettings"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/loadBalancingSettings":{"get":{"description":"Lists all of the LoadBalancingSettings within a Front Door.","operationId":"LoadBalancingSettings_ListByFrontDoor","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List LoadBalancingSettings in a Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List LoadBalancingSettings in a Front Door":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadBalancingSettingsListResult"},"examples":{"List LoadBalancingSettings in a Front Door":{"$ref":"#/components/examples/List_LoadBalancingSettings_in_a_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/loadBalancingSettings/{loadBalancingSettingsName}":{"delete":{"description":"Deletes an existing LoadBalancingSettings with the specified parameters.","operationId":"LoadBalancingSettings_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete LoadBalancingSettings":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/loadBalancingSettingsNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete LoadBalancingSettings":{"value":"2018-08-01"}}}],"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 LoadBalancingSettings was not found."},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true},"get":{"description":"Gets a LoadBalancingSettings with the specified Rule name within the specified Front Door.","operationId":"LoadBalancingSettings_Get","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get LoadBalancingSettings":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/loadBalancingSettingsNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get LoadBalancingSettings":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadBalancingSettingsModel"},"examples":{"Get LoadBalancingSettings":{"$ref":"#/components/examples/Get_LoadBalancingSettings"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]},"put":{"description":"Creates a new LoadBalancingSettings with the specified Rule name within the specified Front Door.","operationId":"LoadBalancingSettings_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update specific LoadBalancingSettings":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/loadBalancingSettingsNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update specific LoadBalancingSettings":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadBalancingSettingsModel"}}},"description":"LoadBalancingSettings properties needed to create a new Front Door.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadBalancingSettingsModel"},"examples":{"Create or update specific LoadBalancingSettings":{"$ref":"#/components/examples/Create_or_update_specific_LoadBalancingSettings"}}}}},"201":{"description":"Created. The request has been fulfilled and a new LoadBalancingSettings has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadBalancingSettingsModel"},"examples":{"Create or update specific LoadBalancingSettings":{"$ref":"#/components/examples/Create_or_update_specific_LoadBalancingSettings"}}}}},"202":{"description":"Accepted. The request has been accepted for processing and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadBalancingSettingsModel"},"examples":{"Create or update specific LoadBalancingSettings":{"$ref":"#/components/examples/Create_or_update_specific_LoadBalancingSettings"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge":{"post":{"description":"Removes a content from Front Door.","operationId":"Endpoints_PurgeContent","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Purge content from Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Purge content from Front Door":{"value":"2018-08-01"}}}],"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},"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"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/routingRules":{"get":{"description":"Lists all of the Routing Rules within a Front Door.","operationId":"RoutingRules_ListByFrontDoor","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List Routing Rules in a Front Door":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List Routing Rules in a Front Door":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRuleListResult"},"examples":{"List Routing Rules in a Front Door":{"$ref":"#/components/examples/List_Routing_Rules_in_a_Front_Door"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/routingRules/{routingRuleName}":{"delete":{"description":"Deletes an existing Routing Rule with the specified parameters.","operationId":"RoutingRules_Delete","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete Routing Rule":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/routingRuleNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete Routing Rule":{"value":"2018-08-01"}}}],"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 Routing Rule was not found."},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true},"get":{"description":"Gets a Routing Rule with the specified Rule name within the specified Front Door.","operationId":"RoutingRules_Get","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get Routing Rule":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/routingRuleNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get Routing Rule":{"value":"2018-08-01"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRule"},"examples":{"Get Routing Rule":{"$ref":"#/components/examples/Get_Routing_Rule"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]},"put":{"description":"Creates a new Routing Rule with the specified Rule name within the specified Front Door.","operationId":"RoutingRules_CreateOrUpdate","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Routing Rule":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"$ref":"#/components/parameters/routingRuleNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update specific Routing Rule":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRule"}}},"description":"Routing Rule properties needed to create a new Front Door.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRule"},"examples":{"Create or update specific Routing Rule":{"$ref":"#/components/examples/Create_or_update_specific_Routing_Rule"}}}}},"201":{"description":"Created. The request has been fulfilled and a new RoutingRule has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRule"},"examples":{"Create or update specific Routing Rule":{"$ref":"#/components/examples/Create_or_update_specific_Routing_Rule"}}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRule"},"examples":{"Create or update specific Routing Rule":{"$ref":"#/components/examples/Create_or_update_specific_Routing_Rule"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain":{"post":{"description":"Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.","operationId":"FrontDoors_ValidateCustomDomain","parameters":[{"description":"The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"FrontDoor_ValidateCustomDomain":{"value":"subid"}}},{"$ref":"#/components/parameters/resourceGroupNameParameter"},{"$ref":"#/components/parameters/frontDoorNameParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"FrontDoor_ValidateCustomDomain":{"value":"2018-08-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateCustomDomainInput"}}},"description":"Custom domain to be validated.","required":true},"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateCustomDomainOutput"},"examples":{"FrontDoor_ValidateCustomDomain":{"$ref":"#/components/examples/FrontDoor_ValidateCustomDomain"}}}}},"default":{"description":"Front Door error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["FrontDoors"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"CheckNameAvailability":{"value":{"message":"Name not available","nameAvailability":"Unavailable","reason":"Name is already in use"}},"CheckNameAvailabilityWithSubscription":{"value":{"message":"Name not available","nameAvailability":"Unavailable","reason":"Name is already in use"}},"List_all_Front_Doors":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1","location":"westus","name":"frontDoor1","properties":{"backendPools":[{"id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1","name":"backendPool1","properties":{"backends":[{"address":"w3.contoso.com","enabledState":"Enabled","httpPort":80,"httpsPort":443,"priority":2,"weight":1},{"address":"contoso.com.website-us-west-2.othercloud.net","enabledState":"Enabled","httpPort":80,"httpsPort":443,"priority":1,"weight":2},{"address":"contoso1