Frontend Endpoints - Get

Referencia

Servicio:: Front Door Service

Versión de la API:: 2021-06-01

Obtiene un punto de conexión de front-end con el nombre especificado en Front Door especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
frontDoorName	path	True	string minLength: 5 maxLength: 64 pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$	Nombre de Front Door que es único globalmente.
frontendEndpointName	path	True	string minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Nombre del punto de conexión de front-end que es único dentro de Front Door.
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Nombre del grupo de recursos dentro de la suscripción de Azure.
subscriptionId	path	True	string	Credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string	Versión de la API de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	FrontendEndpoint	De acuerdo
Other Status Codes	ErrorResponse	Respuesta de error de Front Door que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Get Frontend Endpoint

Solicitud de ejemplo

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


/**
 * 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

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

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

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

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

Respuesta de muestra

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"
    }
  }
}

Definiciones

Nombre	Description
CustomHttpsConfiguration	Configuración de Https para un dominio
CustomHttpsProvisioningState	Estado de aprovisionamiento de Https personalizado del frontendEndpoint.
CustomHttpsProvisioningSubstate	El subestado de aprovisionamiento muestra el progreso de la habilitación o deshabilitación del proceso https personalizado paso a paso.
ErrorResponse	La respuesta de error indica que el servicio Front Door no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.
FrontDoorCertificateSource	Define el origen del certificado SSL.
FrontDoorCertificateType	Define el tipo del certificado usado para las conexiones seguras a un frontendEndpoint.
FrontDoorResourceState	Estado del recurso de Front Door o SubResource de Front Door.
FrontDoorTlsProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.
FrontendEndpoint	Un punto de conexión de front-end que se usa para el enrutamiento.
MinimumTLSVersion	La versión mínima de TLS necesaria de los clientes para establecer un protocolo de enlace SSL con Front Door.
SessionAffinityEnabledState	Si se permite la afinidad de sesión en este host. Las opciones válidas son "Habilitado" o "Deshabilitado".
Vault	Key Vault que contiene el certificado SSL
WebApplicationFirewallPolicyLink	Define la directiva de firewall de aplicaciones web para cada host (si procede)

CustomHttpsConfiguration

Object

Configuración de Https para un dominio

Nombre	Tipo	Description
certificateSource	FrontDoorCertificateSource	Define el origen del certificado SSL.
frontDoorCertificateSourceParameters.certificateType	FrontDoorCertificateType	Define el tipo del certificado usado para las conexiones seguras a un frontendEndpoint.
keyVaultCertificateSourceParameters.secretName	string	Nombre del secreto de Key Vault que representa el certificado completo PFX.
keyVaultCertificateSourceParameters.secretVersion	string	Versión del secreto de Key Vault que representa el certificado COMPLETO PFX
keyVaultCertificateSourceParameters.vault	Vault	Key Vault que contiene el certificado SSL
minimumTlsVersion	MinimumTLSVersion	La versión mínima de TLS necesaria de los clientes para establecer un protocolo de enlace SSL con Front Door.
protocolType	FrontDoorTlsProtocolType	Define el protocolo de extensión TLS que se usa para la entrega segura.

CustomHttpsProvisioningState

Enumeración

Estado de aprovisionamiento de Https personalizado del frontendEndpoint.

Valor	Description
Disabled
Disabling
Enabled
Enabling
Failed

CustomHttpsProvisioningSubstate

Enumeración

El subestado de aprovisionamiento muestra el progreso de la habilitación o deshabilitación del proceso https personalizado paso a paso.

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

ErrorResponse

Object

La respuesta de error indica que el servicio Front Door no puede procesar la solicitud entrante. El motivo se proporciona en el mensaje de error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

FrontDoorCertificateSource

Enumeración

Define el origen del certificado SSL.

Valor	Description
AzureKeyVault
FrontDoor

FrontDoorCertificateType

Enumeración

Define el tipo del certificado usado para las conexiones seguras a un frontendEndpoint.

Valor	Description
Dedicated

FrontDoorResourceState

Enumeración

Estado del recurso de Front Door o SubResource de Front Door.

Valor	Description
Creating
Deleting
Disabled
Disabling
Enabled
Enabling
Migrated
Migrating

FrontDoorTlsProtocolType

Enumeración

Define el protocolo de extensión TLS que se usa para la entrega segura.

Valor	Description
ServerNameIndication

FrontendEndpoint

Object

Un punto de conexión de front-end que se usa para el enrutamiento.

Nombre	Tipo	Description
id	string	Identificador de recurso.
name	string	Nombre del recurso.
properties.customHttpsConfiguration	CustomHttpsConfiguration	Configuración que especifica cómo habilitar HTTPS
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Estado de aprovisionamiento de Https personalizado del frontendEndpoint.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	El subestado de aprovisionamiento muestra el progreso de la habilitación o deshabilitación del proceso https personalizado paso a paso.
properties.hostName	string	Nombre de host del frontendEndpoint. Debe ser un nombre de dominio.
properties.resourceState	FrontDoorResourceState	Estado del recurso de Front Door o SubResource de Front Door. Estado del recurso.
properties.sessionAffinityEnabledState	SessionAffinityEnabledState	Si se permite la afinidad de sesión en este host. Las opciones válidas son "Habilitado" o "Deshabilitado".
properties.sessionAffinityTtlSeconds	integer	NO USADO. Este campo se omitirá. TTL que se usará en segundos para la afinidad de sesión, si procede.
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink	Define la directiva de firewall de aplicaciones web para cada host (si procede)
type	string	Tipo de recurso.

MinimumTLSVersion

Enumeración

La versión mínima de TLS necesaria de los clientes para establecer un protocolo de enlace SSL con Front Door.

Valor	Description
1.0
1.2

SessionAffinityEnabledState

Enumeración

Si se permite la afinidad de sesión en este host. Las opciones válidas son "Habilitado" o "Deshabilitado".

Valor	Description
Disabled
Enabled

Vault

Object

Key Vault que contiene el certificado SSL

Nombre	Tipo	Description
id	string	Identificador de recurso.

WebApplicationFirewallPolicyLink

Object

Define la directiva de firewall de aplicaciones web para cada host (si procede)

Nombre	Tipo	Description
id	string	Identificador de recurso.