Frontend Endpoints - Get

Reference

Service:: Front Door Service

API Version:: 2019-05-01

Gets a Frontend endpoint with the specified name within the specified Front Door.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}?api-version=2019-05-01

URI Parameters

Name	In	Required	Type	Description
frontDoorName	path	True	string	Name of the Front Door which is globally unique. Regex pattern: `^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$`
frontendEndpointName	path	True	string	Name of the Frontend endpoint which is unique within the Front Door. Regex pattern: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: `^[a-zA-Z0-9_\-\.]*[^\.]$`
subscriptionId	path	True	string	The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	FrontendEndpoint	OK. The request has succeeded.
Other Status Codes	ErrorResponse	Front Door error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get Frontend Endpoint

Sample Request

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1?api-version=2019-05-01

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1",
  "name": "frontendEndpoint1",
  "properties": {
    "hostName": "www.contoso.com",
    "sessionAffinityEnabledState": "Enabled",
    "sessionAffinityTtlSeconds": 60,
    "webApplicationFirewallPolicyLink": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"
    }
  }
}

Definitions

Name	Description
CustomHttpsConfiguration	Https settings for a domain
CustomHttpsProvisioningState	Provisioning status of Custom Https of the frontendEndpoint.
CustomHttpsProvisioningSubstate	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
ErrorResponse	Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.
FrontDoorCertificateSource	Defines the source of the SSL certificate
FrontDoorCertificateType	Defines the type of the certificate used for secure connections to a frontendEndpoint
FrontDoorResourceState	Resource status of the Front Door or Front Door SubResource.
FrontDoorTlsProtocolType	Defines the TLS extension protocol that is used for secure delivery
FrontendEndpoint	A frontend endpoint used for routing.
MinimumTLSVersion	The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
SessionAffinityEnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
Vault	The Key Vault containing the SSL certificate
WebApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for each host (if applicable)

CustomHttpsConfiguration

Https settings for a domain

Name	Type	Description
certificateSource	FrontDoorCertificateSource	Defines the source of the SSL certificate
frontDoorCertificateSourceParameters.certificateType	FrontDoorCertificateType	Defines the type of the certificate used for secure connections to a frontendEndpoint
keyVaultCertificateSourceParameters.secretName	string	The name of the Key Vault secret representing the full certificate PFX
keyVaultCertificateSourceParameters.secretVersion	string	The version of the Key Vault secret representing the full certificate PFX
keyVaultCertificateSourceParameters.vault	Vault	The Key Vault containing the SSL certificate
minimumTlsVersion	MinimumTLSVersion	The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
protocolType	FrontDoorTlsProtocolType	Defines the TLS extension protocol that is used for secure delivery

CustomHttpsProvisioningState

Provisioning status of Custom Https of the frontendEndpoint.

Name	Type	Description
Disabled	string
Disabling	string
Enabled	string
Enabling	string
Failed	string

CustomHttpsProvisioningSubstate

Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.

Name	Type	Description
CertificateDeleted	string
CertificateDeployed	string
DeletingCertificate	string
DeployingCertificate	string
DomainControlValidationRequestApproved	string
DomainControlValidationRequestRejected	string
DomainControlValidationRequestTimedOut	string
IssuingCertificate	string
PendingDomainControlValidationREquestApproval	string
SubmittingDomainControlValidationRequest	string

ErrorResponse

Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

FrontDoorCertificateSource

Defines the source of the SSL certificate

Name	Type	Description
AzureKeyVault	string
FrontDoor	string

FrontDoorCertificateType

Defines the type of the certificate used for secure connections to a frontendEndpoint

Name	Type	Description
Dedicated	string

FrontDoorResourceState

Resource status of the Front Door or Front Door SubResource.

Name	Type	Description
Creating	string
Deleting	string
Disabled	string
Disabling	string
Enabled	string
Enabling	string

FrontDoorTlsProtocolType

Defines the TLS extension protocol that is used for secure delivery

Name	Type	Description
ServerNameIndication	string