Frontend Endpoints - Get

Service:

Front Door Service

API Version:

2021-06-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=2021-06-01

URI Parameters

Name	In	Required	Type	Description
frontDoorName	path	True	string minLength: 5 maxLength: 64 pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$	Name of the Front Door which is globally unique.
frontendEndpointName	path	True	string minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Name of the Frontend endpoint which is unique within the Front Door.
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Name of the Resource group within the Azure subscription.
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
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=2021-06-01

Java

/**
 * Samples for FrontendEndpoints Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/
     * FrontdoorFrontendEndpointGet.json
     */
    /**
     * Sample code: Get Frontend Endpoint.
     * 
     * @param manager Entry point to FrontDoorManager.
     */
    public static void getFrontendEndpoint(com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        manager.frontendEndpoints().getWithResponse("rg1", "frontDoor1", "frontendEndpoint1",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.frontdoor import FrontDoorManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-frontdoor
# USAGE
    python frontdoor_frontend_endpoint_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = FrontDoorManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.frontend_endpoints.get(
        resource_group_name="rg1",
        front_door_name="frontDoor1",
        frontend_endpoint_name="frontendEndpoint1",
    )
    print(response)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armfrontdoor_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/frontdoor/armfrontdoor"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b54ffc9278eff071455b1dbb4ad2e772afce885d/specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointGet.json
func ExampleFrontendEndpointsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armfrontdoor.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewFrontendEndpointsClient().Get(ctx, "rg1", "frontDoor1", "frontendEndpoint1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.FrontendEndpoint = armfrontdoor.FrontendEndpoint{
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1"),
	// 	Name: to.Ptr("frontendEndpoint1"),
	// 	Properties: &armfrontdoor.FrontendEndpointProperties{
	// 		HostName: to.Ptr("www.contoso.com"),
	// 		SessionAffinityEnabledState: to.Ptr(armfrontdoor.SessionAffinityEnabledStateEnabled),
	// 		SessionAffinityTTLSeconds: to.Ptr[int32](60),
	// 		WebApplicationFirewallPolicyLink: &armfrontdoor.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLink{
	// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { FrontDoorManagementClient } = require("@azure/arm-frontdoor");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets a Frontend endpoint with the specified name within the specified Front Door.
 *
 * @summary Gets a Frontend endpoint with the specified name within the specified Front Door.
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointGet.json
 */
async function getFrontendEndpoint() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "rg1";
  const frontDoorName = "frontDoor1";
  const frontendEndpointName = "frontendEndpoint1";
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const result = await client.frontendEndpoints.get(
    resourceGroupName,
    frontDoorName,
    frontendEndpointName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.FrontDoor.Models;
using Azure.ResourceManager.FrontDoor;

// Generated from example definition: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointGet.json
// this example is just showing the usage of "FrontendEndpoints_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FrontendEndpointResource created on azure
// for more information of creating FrontendEndpointResource, please refer to the document of FrontendEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string frontDoorName = "frontDoor1";
string frontendEndpointName = "frontendEndpoint1";
ResourceIdentifier frontendEndpointResourceId = FrontendEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, frontDoorName, frontendEndpointName);
FrontendEndpointResource frontendEndpoint = client.GetFrontendEndpointResource(frontendEndpointResourceId);

// invoke the operation
FrontendEndpointResource result = await frontendEndpoint.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FrontendEndpointData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Object

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

Enumeration

Provisioning status of Custom Https of the frontendEndpoint.

Value	Description
Enabling
Enabled
Disabling
Disabled
Failed

CustomHttpsProvisioningSubstate

Enumeration

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

Value	Description
SubmittingDomainControlValidationRequest
PendingDomainControlValidationREquestApproval
DomainControlValidationRequestApproved
DomainControlValidationRequestRejected
DomainControlValidationRequestTimedOut
IssuingCertificate
DeployingCertificate
CertificateDeployed
DeletingCertificate
CertificateDeleted

ErrorResponse

Object

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

Enumeration

Defines the source of the SSL certificate

Value	Description
AzureKeyVault
FrontDoor

FrontDoorCertificateType

Enumeration

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

Value	Description
Dedicated

FrontDoorResourceState

Enumeration

Resource status of the Front Door or Front Door SubResource.

Value	Description
Creating
Enabling
Enabled
Disabling
Disabled
Deleting
Migrating
Migrated

FrontDoorTlsProtocolType

Enumeration

Defines the TLS extension protocol that is used for secure delivery

Value	Description
ServerNameIndication

FrontendEndpoint

Object

A frontend endpoint used for routing.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.customHttpsConfiguration	CustomHttpsConfiguration	The configuration specifying how to enable HTTPS
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Provisioning status of Custom Https of the frontendEndpoint.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.
properties.hostName	string	The host name of the frontendEndpoint. Must be a domain name.
properties.resourceState	FrontDoorResourceState	Resource status of the Front Door or Front Door SubResource. Resource status.
properties.sessionAffinityEnabledState	SessionAffinityEnabledState	Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'
properties.sessionAffinityTtlSeconds	integer	UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink	Defines the Web Application Firewall policy for each host (if applicable)
type	string	Resource type.

MinimumTLSVersion

Enumeration

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

Value	Description
1.0
1.2

SessionAffinityEnabledState

Enumeration

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'

Value	Description
Enabled
Disabled

Vault

Object

The Key Vault containing the SSL certificate

Name	Type	Description
id	string	Resource ID.

WebApplicationFirewallPolicyLink

Object

Defines the Web Application Firewall policy for each host (if applicable)

Name	Type	Description
id	string	Resource ID.