你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Frontend Endpoints - List By Front Door

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

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

URI 参数

名称 必需 类型 说明
frontDoorName
path True

string

全局唯一的 Front Door 的名称。

正则表达式模式: ^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$

resourceGroupName
path True

string

Azure 订阅中资源组的名称。

正则表达式模式: ^[a-zA-Z0-9_\-\(\)\.]*[^\.]$

subscriptionId
path True

string

可以唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

FrontendEndpointsListResult

没问题。 请求已成功。

Other Status Codes

ErrorResponse

描述操作失败原因的 Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

List Frontend endpoints in a Front Door

示例请求

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

示例响应

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

域的 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

string

Disabling

string

Enabled

string

Enabling

string

Failed

string

CustomHttpsProvisioningSubstate

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

名称 类型 说明
CertificateDeleted

string

CertificateDeployed

string

DeletingCertificate

string

DeployingCertificate

string

DomainControlValidationRequestApproved

string

DomainControlValidationRequestRejected

string

DomainControlValidationRequestTimedOut

string

IssuingCertificate

string

PendingDomainControlValidationREquestApproval

string

SubmittingDomainControlValidationRequest

string

ErrorResponse

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

名称 类型 说明
code

string

错误代码。

message

string

指示操作失败原因的错误消息。

FrontDoorCertificateSource

定义 SSL 证书的源

名称 类型 说明
AzureKeyVault

string

FrontDoor

string

FrontDoorCertificateType

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

名称 类型 说明
Dedicated

string

FrontDoorResourceState

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

名称 类型 说明
Creating

string

Deleting

string

Disabled

string

Disabling

string

Enabled

string

Enabling

string

FrontDoorTlsProtocolType

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

名称 类型 说明
ServerNameIndication

string

FrontendEndpoint

用于路由的前端终结点。

名称 类型 说明
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

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

名称 类型 说明
nextLink

string

用于获取下一组前端终结点的 URL(如果有)。

value

FrontendEndpoint[]

Front Door 中的前端终结点列表。

MinimumTLSVersion

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

名称 类型 说明
1.0

string

1.2

string

SessionAffinityEnabledState

是否允许此主机上的会话相关性。 有效选项为“Enabled”或“Disabled”

名称 类型 说明
Disabled

string

Enabled

string

Vault

包含 SSL 证书的 Key Vault

名称 类型 说明
id

string

资源 ID。

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

名称 类型 说明
id

string

资源 ID。