Frontend Endpoints - Get

Referens

Tjänst:: Front Door Service

API-version:: 2021-06-01

Hämtar en klientdelsslutpunkt med det angivna namnet inom den angivna Front Door.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
frontDoorName	path	True	string minLength: 5 maxLength: 64 pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$	Namnet på Front Door som är globalt unikt.
frontendEndpointName	path	True	string minLength: 1 maxLength: 255 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Namnet på klientdelsslutpunkten som är unik i Front Door.
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Namnet på resursgruppen i Azure-prenumerationen.
subscriptionId	path	True	string	Autentiseringsuppgifterna för prenumerationen som unikt identifierar Microsoft Azure-prenumerationen. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.
api-version	query	True	string	Klient-API-version.

Svar

Name	Typ	Description
200 OK	FrontendEndpoint	OKEJ
Other Status Codes	ErrorResponse	Front Door-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get Frontend Endpoint

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
CustomHttpsConfiguration	Https-inställningar för en domän
CustomHttpsProvisioningState	Etableringsstatus för anpassade https för klientdelenEndpoint.
CustomHttpsProvisioningSubstate	Etableringsundertillstånd visar förloppet för den anpassade HTTPS-aktiverings-/inaktiveringsprocessen steg för steg.
ErrorResponse	Felsvaret anger att Front Door-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.
FrontDoorCertificateSource	Definierar källan för SSL-certifikatet
FrontDoorCertificateType	Definierar vilken typ av certifikat som används för säkra anslutningar till en klientdelSlutpunkt
FrontDoorResourceState	Resursstatus för Front Door eller Front Door SubResource.
FrontDoorTlsProtocolType	Definierar TLS-tilläggsprotokollet som används för säker leverans
FrontendEndpoint	En klientdelsslutpunkt som används för routning.
MinimumTLSVersion	Den lägsta TLS-version som krävs från klienterna för att upprätta en SSL-handskakning med Front Door.
SessionAffinityEnabledState	Om du vill tillåta sessionstillhörighet på den här värden. Giltiga alternativ är "Aktiverade" eller "Inaktiverade"
Vault	Nyckelvalvet som innehåller SSL-certifikatet
WebApplicationFirewallPolicyLink	Definierar brandväggsprincipen för webbprogram för varje värd (om tillämpligt)

CustomHttpsConfiguration

Objekt

Https-inställningar för en domän

Name	Typ	Description
certificateSource	FrontDoorCertificateSource	Definierar källan för SSL-certifikatet
frontDoorCertificateSourceParameters.certificateType	FrontDoorCertificateType	Definierar vilken typ av certifikat som används för säkra anslutningar till en klientdelSlutpunkt
keyVaultCertificateSourceParameters.secretName	string	Namnet på Key Vault-hemligheten som representerar det fullständiga certifikatet PFX
keyVaultCertificateSourceParameters.secretVersion	string	Versionen av Key Vault-hemligheten som representerar det fullständiga certifikatet PFX
keyVaultCertificateSourceParameters.vault	Vault	Nyckelvalvet som innehåller SSL-certifikatet
minimumTlsVersion	MinimumTLSVersion	Den lägsta TLS-version som krävs från klienterna för att upprätta en SSL-handskakning med Front Door.
protocolType	FrontDoorTlsProtocolType	Definierar TLS-tilläggsprotokollet som används för säker leverans

CustomHttpsProvisioningState

Uppräkning

Etableringsstatus för anpassade https för klientdelenEndpoint.

Värde	Description
Disabled
Disabling
Enabled
Enabling
Failed

CustomHttpsProvisioningSubstate

Uppräkning

Etableringsundertillstånd visar förloppet för den anpassade HTTPS-aktiverings-/inaktiveringsprocessen steg för steg.

Värde	Description
CertificateDeleted
CertificateDeployed
DeletingCertificate
DeployingCertificate
DomainControlValidationRequestApproved
DomainControlValidationRequestRejected
DomainControlValidationRequestTimedOut
IssuingCertificate
PendingDomainControlValidationREquestApproval
SubmittingDomainControlValidationRequest

ErrorResponse

Objekt

Felsvaret anger att Front Door-tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Name	Typ	Description
code	string	Felkod.
message	string	Felmeddelande som anger varför åtgärden misslyckades.

FrontDoorCertificateSource

Uppräkning

Definierar källan för SSL-certifikatet

Värde	Description
AzureKeyVault
FrontDoor

FrontDoorCertificateType

Uppräkning

Definierar vilken typ av certifikat som används för säkra anslutningar till en klientdelSlutpunkt

Värde	Description
Dedicated

FrontDoorResourceState

Uppräkning

Resursstatus för Front Door eller Front Door SubResource.

Värde	Description
Creating
Deleting
Disabled
Disabling
Enabled
Enabling
Migrated
Migrating

FrontDoorTlsProtocolType

Uppräkning

Definierar TLS-tilläggsprotokollet som används för säker leverans

Värde	Description
ServerNameIndication

FrontendEndpoint

Objekt

En klientdelsslutpunkt som används för routning.

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.customHttpsConfiguration	CustomHttpsConfiguration	Konfigurationen som anger hur HTTPS ska aktiveras
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	Etableringsstatus för anpassade https för klientdelenEndpoint.
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	Etableringsundertillstånd visar förloppet för den anpassade HTTPS-aktiverings-/inaktiveringsprocessen steg för steg.
properties.hostName	string	Värdnamnet för klientdelenEndpoint. Måste vara ett domännamn.
properties.resourceState	FrontDoorResourceState	Resursstatus för Front Door eller Front Door SubResource. Resursstatus.
properties.sessionAffinityEnabledState	SessionAffinityEnabledState	Om du vill tillåta sessionstillhörighet på den här värden. Giltiga alternativ är "Aktiverade" eller "Inaktiverade"
properties.sessionAffinityTtlSeconds	integer	OANVÄND. Det här fältet ignoreras. Den TTL som ska användas i sekunder för sessionstillhörighet, om tillämpligt.
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink	Definierar brandväggsprincipen för webbprogram för varje värd (om tillämpligt)
type	string	Resurstyp.

MinimumTLSVersion

Uppräkning

Den lägsta TLS-version som krävs från klienterna för att upprätta en SSL-handskakning med Front Door.

Värde	Description
1.0
1.2

SessionAffinityEnabledState

Uppräkning

Om du vill tillåta sessionstillhörighet på den här värden. Giltiga alternativ är "Aktiverade" eller "Inaktiverade"

Värde	Description
Disabled
Enabled

Vault

Objekt

Nyckelvalvet som innehåller SSL-certifikatet

Name	Typ	Description
id	string	Resurs-ID.

WebApplicationFirewallPolicyLink

Objekt

Definierar brandväggsprincipen för webbprogram för varje värd (om tillämpligt)

Name	Typ	Description
id	string	Resurs-ID.