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

Endpoints - Update

更新流量管理器终结点。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/{endpointType}/{endpointName}?api-version=2022-04-01

URI 参数

名称 必需 类型 说明
endpointName
path True

string

要更新的流量管理器终结点的名称。

endpointType
path True

EndpointType

要更新的流量管理器终结点的类型。

profileName
path True

string

流量管理器配置文件的名称。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

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

api-version
query True

string

客户端 API 版本。

请求正文

名称 类型 说明
id

string

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

资源的名称

properties.alwaysServe

AlwaysServe

如果启用了 Always Serve,则将禁用终结点运行状况探测,终结点将包含在流量路由方法中。

properties.customHeaders

CustomHeaders[]

自定义标头列表。

properties.endpointLocation

string

指定使用“性能”流量路由方法时外部或嵌套终结点的位置。

properties.endpointMonitorStatus

EndpointMonitorStatus

终结点的监视状态。

properties.endpointStatus

EndpointStatus

终结点的状态。 如果终结点已启用,则会探测它的运行状况,并将它包含在流量路由方法中。

properties.geoMapping

string[]

使用“地理”流量路由方法时映射到此终结点的国家/地区列表。 有关接受值的完整列表,请参阅流量管理器地理文档。

properties.minChildEndpoints

integer

子配置文件中必须可用的最小终结点数,才能使父配置文件被视为可用。 仅适用于类型为“NestedEndpoints”的终结点。

properties.minChildEndpointsIPv4

integer

IPv4 (DNS 记录类型 A) 终结点的最小数目,这些终结点必须在子配置文件中可用,才能使父配置文件被视为可用。 仅适用于类型为“NestedEndpoints”的终结点。

properties.minChildEndpointsIPv6

integer

IPv6 (DNS 记录类型 AAAA) 终结点的最小数目,这些终结点必须在子配置文件中可用,才能使父配置文件被视为可用。 仅适用于类型为“NestedEndpoints”的终结点。

properties.priority

integer

使用“优先级”流量路由方法时此终结点的优先级。 可能的值为 1 到 1000,值越小表示优先级越高。 这是一个可选参数。 如果指定,则必须在所有终结点上指定,并且不能有两个终结点共用同一个优先级值。

properties.subnets

Subnets[]

使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。

properties.target

string

终结点的完全限定的 DNS 名称或 IP 地址。 流量管理器将在针对直接发往此终结点的流量所做的 DNS 响应中返回此值。

properties.targetResourceId

string

终结点 的 Azure 资源 URI。 不适用于类型为“ExternalEndpoints”的终结点。

properties.weight

integer

使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。

type

string

资源类型。 Ex- Microsoft.Network/trafficManagerProfiles。

响应

名称 类型 说明
200 OK

Endpoint

已更新的流量管理器终结点。

Other Status Codes

CloudError

默认响应。 它将根据错误定义进行反序列化。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Endpoint-PATCH-External-Target

示例请求

PATCH https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "target": "another.foobar.contoso.com"
  }
}

示例响应

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "another.foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe"
  }
}

定义

名称 说明
AlwaysServe

如果启用了 Always Serve,则将禁用终结点运行状况探测,终结点将包含在流量路由方法中。

CloudError

Azure 资源管理器返回的错误

CloudErrorBody

Azure 资源管理器返回的错误内容

CustomHeaders

自定义标头列表。

Endpoint

表示流量管理器终结点的类。

EndpointMonitorStatus

终结点的监视状态。

EndpointStatus

终结点的状态。 如果终结点已启用,则会探测它的运行状况,并将它包含在流量路由方法中。

EndpointType

要更新的流量管理器终结点的类型。

Subnets

使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。

AlwaysServe

如果启用了 Always Serve,则将禁用终结点运行状况探测,终结点将包含在流量路由方法中。

名称 类型 说明
Disabled

string

Enabled

string

CloudError

Azure 资源管理器返回的错误

名称 类型 说明
error

CloudErrorBody

错误的内容。

CloudErrorBody

Azure 资源管理器返回的错误内容

名称 类型 说明
code

string

错误代码

details

CloudErrorBody[]

错误详细信息

message

string

错误消息

target

string

错误目标

CustomHeaders

自定义标头列表。

名称 类型 说明
name

string

标头名称。

value

string

标头值。

Endpoint

表示流量管理器终结点的类。

名称 类型 说明
id

string

资源的完全限定资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

资源的名称

properties.alwaysServe

AlwaysServe

如果启用了 Always Serve,则将禁用终结点运行状况探测,终结点将包含在流量路由方法中。

properties.customHeaders

CustomHeaders[]

自定义标头列表。

properties.endpointLocation

string

指定使用“性能”流量路由方法时外部或嵌套终结点的位置。

properties.endpointMonitorStatus

EndpointMonitorStatus

终结点的监视状态。

properties.endpointStatus

EndpointStatus

终结点的状态。 如果终结点已启用,则会探测它的运行状况,并将它包含在流量路由方法中。

properties.geoMapping

string[]

使用“地理”流量路由方法时映射到此终结点的国家/地区列表。 有关接受值的完整列表,请参阅流量管理器地理文档。

properties.minChildEndpoints

integer

子配置文件中必须可用的最小终结点数,才能使父配置文件被视为可用。 仅适用于类型为“NestedEndpoints”的终结点。

properties.minChildEndpointsIPv4

integer

IPv4 (DNS 记录类型 A) 终结点的最小数目,这些终结点必须在子配置文件中可用,才能使父配置文件被视为可用。 仅适用于类型为“NestedEndpoints”的终结点。

properties.minChildEndpointsIPv6

integer

IPv6 (DNS 记录类型 AAAA) 终结点的最小数目,这些终结点必须在子配置文件中可用,才能使父配置文件被视为可用。 仅适用于类型为“NestedEndpoints”的终结点。

properties.priority

integer

使用“优先级”流量路由方法时此终结点的优先级。 可能的值为 1 到 1000,值越小表示优先级越高。 这是一个可选参数。 如果指定,则必须在所有终结点上指定,并且不能有两个终结点共用同一个优先级值。

properties.subnets

Subnets[]

使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。

properties.target

string

终结点的完全限定的 DNS 名称或 IP 地址。 流量管理器将在针对直接发往此终结点的流量所做的 DNS 响应中返回此值。

properties.targetResourceId

string

终结点 的 Azure 资源 URI。 不适用于类型为“ExternalEndpoints”的终结点。

properties.weight

integer

使用“加权”流量路由方法时此终结点的权重。 可能的值为 1 到 1000。

type

string

资源类型。 Ex- Microsoft.Network/trafficManagerProfiles。

EndpointMonitorStatus

终结点的监视状态。

名称 类型 说明
CheckingEndpoint

string

Degraded

string

Disabled

string

Inactive

string

Online

string

Stopped

string

Unmonitored

string

EndpointStatus

终结点的状态。 如果终结点已启用,则会探测它的运行状况,并将它包含在流量路由方法中。

名称 类型 说明
Disabled

string

Enabled

string

EndpointType

要更新的流量管理器终结点的类型。

名称 类型 说明
AzureEndpoints

string

ExternalEndpoints

string

NestedEndpoints

string

Subnets

使用“子网”流量路由方法时映射到此终结点的子网、IP 地址和/或地址范围的列表。 空列表将匹配其他终结点未涵盖的所有范围。

名称 类型 说明
first

string

子网中的第一个地址。

last

string

子网中的最后一个地址。

scope

integer

块大小 (子网掩码) 中的前导位数。