Frontend Endpoints - Enable Https

Reference

Service:: Front Door Service

API Version:: 2019-05-01

Enables a frontendEndpoint for HTTPS traffic

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/enableHttps?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.

Request Body

Name	Required	Type	Description
certificateSource	True	FrontDoorCertificateSource	Defines the source of the SSL certificate
minimumTlsVersion	True	MinimumTLSVersion	The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
protocolType	True	FrontDoorTlsProtocolType	Defines the TLS extension protocol that is used for secure delivery
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

Responses

Name	Type	Description
200 OK		OK. The request has succeeded.
202 Accepted		Accepted and the operation will complete asynchronously.
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

FrontendEndpoints_EnableHttps

Sample Request

HTTP

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

{
  "certificateSource": "AzureKeyVault",
  "protocolType": "ServerNameIndication",
  "minimumTlsVersion": "1.0",
  "keyVaultCertificateSourceParameters": {
    "vault": {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1"
    },
    "secretName": "secret1",
    "secretVersion": "00000000-0000-0000-0000-000000000000"
  }
}

Sample Response

Status code:: 200

Status code:: 202

Definitions

Name	Description
CustomHttpsConfiguration	Https settings for a domain
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
FrontDoorTlsProtocolType	Defines the TLS extension protocol that is used for secure delivery
MinimumTLSVersion	The minimum TLS version required from the clients to establish an SSL handshake with Front Door.
Vault	The Key Vault containing the SSL certificate

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

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

FrontDoorTlsProtocolType

Defines the TLS extension protocol that is used for secure delivery

Name	Type	Description
ServerNameIndication	string

MinimumTLSVersion

The minimum TLS version required from the clients to establish an SSL handshake with Front Door.

Name	Type	Description
1.0	string
1.2	string

Vault

The Key Vault containing the SSL certificate

Name	Type	Description
id	string	Resource ID.