Frontend Endpoints - List By Front Door

服务:

Front Door Service

API 版本:

2021-06-01

列出 Front Door 中的所有前端终结点。

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

URI 参数

名称	在	必需	类型	说明
frontDoorName	path	True	string minLength: 5 maxLength: 64 pattern: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$	全局唯一的 Front Door 的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$	Azure 订阅中的资源组的名称。
subscriptionId	path	True	string	唯一标识 Azure 订阅Microsoft的订阅凭据。 订阅 ID 构成了每个服务调用的 URI 的一部分。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	FrontendEndpointsListResult	还行
Other Status Codes	ErrorResponse	Front Door 错误响应，描述作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List Frontend endpoints in a Front Door

示例请求

HTTP

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

Java

/**
 * Samples for FrontendEndpoints ListByFrontDoor.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/
     * FrontdoorFrontendEndpointList.json
     */
    /**
     * Sample code: List Frontend endpoints in a Front Door.
     * 
     * @param manager Entry point to FrontDoorManager.
     */
    public static void listFrontendEndpointsInAFrontDoor(com.azure.resourcemanager.frontdoor.FrontDoorManager manager) {
        manager.frontendEndpoints().listByFrontDoor("rg1", "frontDoor1", 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_list.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.list_by_front_door(
        resource_group_name="rg1",
        front_door_name="frontDoor1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointList.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/FrontdoorFrontendEndpointList.json
func ExampleFrontendEndpointsClient_NewListByFrontDoorPager() {
	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)
	}
	pager := clientFactory.NewFrontendEndpointsClient().NewListByFrontDoorPager("rg1", "frontDoor1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.FrontendEndpointsListResult = armfrontdoor.FrontendEndpointsListResult{
		// 	Value: []*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 Lists all of the frontend endpoints within a Front Door.
 *
 * @summary Lists all of the frontend endpoints within a Front Door.
 * x-ms-original-file: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointList.json
 */
async function listFrontendEndpointsInAFrontDoor() {
  const subscriptionId = process.env["FRONTDOOR_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["FRONTDOOR_RESOURCE_GROUP"] || "rg1";
  const frontDoorName = "frontDoor1";
  const credential = new DefaultAzureCredential();
  const client = new FrontDoorManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.frontendEndpoints.listByFrontDoor(
    resourceGroupName,
    frontDoorName,
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

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;

// Generated from example definition: specification/frontdoor/resource-manager/Microsoft.Network/stable/2021-06-01/examples/FrontdoorFrontendEndpointList.json
// this example is just showing the usage of "FrontendEndpoints_ListByFrontDoor" 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 FrontDoorResource created on azure
// for more information of creating FrontDoorResource, please refer to the document of FrontDoorResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string frontDoorName = "frontDoor1";
ResourceIdentifier frontDoorResourceId = FrontDoorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, frontDoorName);
FrontDoorResource frontDoor = client.GetFrontDoorResource(frontDoorResourceId);

// get the collection of this FrontendEndpointResource
FrontendEndpointCollection collection = frontDoor.GetFrontendEndpoints();

// invoke the operation and iterate over the result
await foreach (FrontendEndpointResource item in collection.GetAllAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:

200

{
  "value": [
    {
      "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"
        }
      }
    }
  ]
}

定义

名称	说明
CustomHttpsConfiguration	域的 Https 设置
CustomHttpsProvisioningState	FrontendEndpoint 的自定义 Https 预配状态。
CustomHttpsProvisioningSubstate	预配子状态显示自定义 HTTPS 启用/禁用过程的进度。
ErrorResponse	错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。
FrontDoorCertificateSource	定义 SSL 证书的源
FrontDoorCertificateType	定义用于安全连接到 frontendEndpoint 的证书的类型
FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。
FrontDoorTlsProtocolType	定义用于安全传送的 TLS 扩展协议
FrontendEndpoint	用于路由的前端终结点。
FrontendEndpointsListResult	列出前端终结点的请求的结果。 它包含前端终结点对象列表和 URL 链接，用于获取下一组结果。
MinimumTLSVersion	客户端建立与 Front Door 的 SSL 握手所需的最低 TLS 版本。
SessionAffinityEnabledState	是否允许在此主机上进行会话关联。 有效选项为“Enabled”或“Disabled”
Vault	包含 SSL 证书的 Key Vault
WebApplicationFirewallPolicyLink	为每个主机定义 Web 应用程序防火墙策略（如果适用）

CustomHttpsConfiguration

Object

域的 Https 设置

名称	类型	说明
certificateSource	FrontDoorCertificateSource	定义 SSL 证书的源
frontDoorCertificateSourceParameters.certificateType	FrontDoorCertificateType	定义用于安全连接到 frontendEndpoint 的证书的类型
keyVaultCertificateSourceParameters.secretName	string	表示完整证书 PFX 的 Key Vault 机密的名称
keyVaultCertificateSourceParameters.secretVersion	string	表示完整证书 PFX 的 Key Vault 机密的版本
keyVaultCertificateSourceParameters.vault	Vault	包含 SSL 证书的 Key Vault
minimumTlsVersion	MinimumTLSVersion	客户端建立与 Front Door 的 SSL 握手所需的最低 TLS 版本。
protocolType	FrontDoorTlsProtocolType	定义用于安全传送的 TLS 扩展协议

CustomHttpsProvisioningState

枚举

FrontendEndpoint 的自定义 Https 预配状态。

值	说明
Disabled
Disabling
Enabled
Enabling
Failed

CustomHttpsProvisioningSubstate

枚举

预配子状态显示自定义 HTTPS 启用/禁用过程的进度。

值	说明
CertificateDeleted
CertificateDeployed
DeletingCertificate
DeployingCertificate
DomainControlValidationRequestApproved
DomainControlValidationRequestRejected
DomainControlValidationRequestTimedOut
IssuingCertificate
PendingDomainControlValidationREquestApproval
SubmittingDomainControlValidationRequest

ErrorResponse

Object

错误响应指示 Front Door 服务无法处理传入请求。 错误消息中提供了原因。

名称	类型	说明
code	string	错误代码。
message	string	指示作失败的原因的错误消息。

FrontDoorCertificateSource

枚举

定义 SSL 证书的源

值	说明
AzureKeyVault
FrontDoor

FrontDoorCertificateType

枚举

定义用于安全连接到 frontendEndpoint 的证书的类型

值	说明
Dedicated

FrontDoorResourceState

枚举

Front Door 或 Front Door 子资源的资源状态。

值	说明
Creating
Deleting
Disabled
Disabling
Enabled
Enabling
Migrated
Migrating

FrontDoorTlsProtocolType

枚举

定义用于安全传送的 TLS 扩展协议

值	说明
ServerNameIndication

FrontendEndpoint

Object

用于路由的前端终结点。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.customHttpsConfiguration	CustomHttpsConfiguration	指定如何启用 HTTPS 的配置
properties.customHttpsProvisioningState	CustomHttpsProvisioningState	FrontendEndpoint 的自定义 Https 预配状态。
properties.customHttpsProvisioningSubstate	CustomHttpsProvisioningSubstate	预配子状态显示自定义 HTTPS 启用/禁用过程的进度。
properties.hostName	string	frontendEndpoint 的主机名。 必须是域名。
properties.resourceState	FrontDoorResourceState	Front Door 或 Front Door 子资源的资源状态。 资源状态。
properties.sessionAffinityEnabledState	SessionAffinityEnabledState	是否允许在此主机上进行会话关联。 有效选项为“Enabled”或“Disabled”
properties.sessionAffinityTtlSeconds	integer	闲置。 此字段将被忽略。 要以秒为单位用于会话相关性的 TTL（如果适用）。
properties.webApplicationFirewallPolicyLink	WebApplicationFirewallPolicyLink	为每个主机定义 Web 应用程序防火墙策略（如果适用）
type	string	资源类型。

FrontendEndpointsListResult

Object

列出前端终结点的请求的结果。 它包含前端终结点对象列表和 URL 链接，用于获取下一组结果。

名称	类型	说明
nextLink	string	用于获取下一组前端终结点（如果有）的 URL。
value	FrontendEndpoint[]	Front Door 中的前端终结点列表。

MinimumTLSVersion

枚举

客户端建立与 Front Door 的 SSL 握手所需的最低 TLS 版本。

值	说明
1.0
1.2

SessionAffinityEnabledState

枚举

是否允许在此主机上进行会话关联。 有效选项为“Enabled”或“Disabled”

值	说明
Disabled
Enabled

Vault

Object

包含 SSL 证书的 Key Vault

名称	类型	说明
id	string	资源 ID。

WebApplicationFirewallPolicyLink

Object

为每个主机定义 Web 应用程序防火墙策略（如果适用）

名称	类型	说明
id	string	资源 ID。