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

Profiles - List By Resource Group

Lists资源组中的所有流量管理器配置文件。

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

URI 参数

名称 必需 类型 说明
resourceGroupName
path True

string

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

subscriptionId
path True

string

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

api-version
query True

string

客户端 API 版本。

响应

名称 类型 说明
200 OK

ProfileListResult

流量管理器配置文件的列表。

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 流

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

ListProfilesByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficmanagerprofiles?api-version=2022-04-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005",
      "name": "azuresdkfornetautoresttrafficmanager1005",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "azuresdkfornetautoresttrafficmanager1005",
          "fqdn": "azuresdkfornetautoresttrafficmanager1005.tmpreview.watmtest.azure-test.net",
          "ttl": 35
        },
        "monitorConfig": {
          "profileMonitorStatus": "Online",
          "protocol": "HTTP",
          "port": 80,
          "path": "/testpath.aspx",
          "intervalInSeconds": 30,
          "toleratedNumberOfFailures": 3,
          "timeoutInSeconds": 10
        },
        "endpoints": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005/externalEndpoints/My external endpoint",
            "name": "My external endpoint",
            "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
            "properties": {
              "endpointStatus": "Enabled",
              "endpointMonitorStatus": "CheckingEndpoint",
              "target": "foobar.contoso.com",
              "weight": 1,
              "priority": 1,
              "endpointLocation": "North Europe"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959",
      "name": "azuresdkfornetautoresttrafficmanager959",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "azuresdkfornetautoresttrafficmanager959",
          "fqdn": "azuresdkfornetautoresttrafficmanager959.tmpreview.watmtest.azure-test.net",
          "ttl": 35
        },
        "monitorConfig": {
          "profileMonitorStatus": "Online",
          "protocol": "HTTP",
          "port": 80,
          "path": "/testpath.aspx",
          "intervalInSeconds": 30,
          "toleratedNumberOfFailures": 3,
          "timeoutInSeconds": 10
        },
        "endpoints": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959/externalEndpoints/My external endpoint",
            "name": "My external endpoint",
            "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
            "properties": {
              "endpointStatus": "Enabled",
              "endpointMonitorStatus": "Online",
              "target": "foobar.contoso.com",
              "weight": 1,
              "priority": 1,
              "endpointLocation": "North Europe"
            }
          }
        ]
      }
    }
  ]
}

定义

名称 说明
AllowedEndpointRecordType

此配置文件的允许类型 DNS 记录类型。

AlwaysServe

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

CloudError

Azure 资源管理器返回的错误

CloudErrorBody

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

CustomHeaders

自定义标头列表。

DnsConfig

在流量管理器配置文件中包含 DNS 设置的类。

Endpoint

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

EndpointMonitorStatus

终结点的监视状态。

EndpointStatus

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

ExpectedStatusCodeRanges

预期状态代码范围的列表。

MonitorConfig

在流量管理器配置文件中包含终结点监视设置的类。

MonitorProtocol

用于探测终结点运行状况的协议 (HTTP、HTTPS 或 TCP) 。

Profile

表示流量管理器配置文件的类。

ProfileListResult

流量管理器列表对操作响应进行配置文件。

ProfileMonitorStatus

流量管理器配置文件的配置文件级监视状态。

ProfileStatus

流量管理器配置文件的状态。

Subnets

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

TrafficRoutingMethod

流量管理器配置文件的流量路由方法。

TrafficViewEnrollmentStatus

指示流量管理器配置文件的流量视图是“已启用”还是“已禁用”。 Null,表示“已禁用”。 启用此功能会增加流量管理配置文件的成本。

AllowedEndpointRecordType

此配置文件的允许类型 DNS 记录类型。

名称 类型 说明
Any

string

DomainName

string

IPv4Address

string

IPv6Address

string

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

标头值。

DnsConfig

在流量管理器配置文件中包含 DNS 设置的类。

名称 类型 说明
fqdn

string

完全限定的域名 (流量管理器配置文件的 FQDN) 。 这是由 RelativeName 与 Azure 流量管理器使用的 DNS 域串联构成的。

relativeName

string

此流量管理器配置文件提供的相对 DNS 名称。 将此值与 Azure 流量管理器使用的 DNS 域名相结合,可以构成配置文件的完全限定域名 (FQDN)。

ttl

integer

DNS 生存时间 (TTL) ,以秒为单位。 这会通知本地 DNS 解析者和 DNS 客户端缓存此流量管理器配置文件提供的 DNS 响应的时间。

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

ExpectedStatusCodeRanges

预期状态代码范围的列表。

名称 类型 说明
max

integer

最大状态代码。

min

integer

最小状态代码。

MonitorConfig

在流量管理器配置文件中包含终结点监视设置的类。

名称 类型 说明
customHeaders

CustomHeaders[]

自定义标头列表。

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

预期状态代码范围的列表。

intervalInSeconds

integer

此配置文件中终结点的监视间隔。 这是流量管理器检查此配置文件中每个终结点的运行状况的时间间隔。

path

string

相对于用于探测终结点运行状况的终结点域名的路径。

port

integer

用于探测终结点运行状况的 TCP 端口。

profileMonitorStatus

ProfileMonitorStatus

流量管理器配置文件的配置文件级监视状态。

protocol

MonitorProtocol

用于探测终结点运行状况的协议 (HTTP、HTTPS 或 TCP) 。

timeoutInSeconds

integer

此配置文件中终结点的监视器超时。 这是流量管理器允许此配置文件中的终结点响应运行状况检查的时间。

toleratedNumberOfFailures

integer

流量管理器在声明此配置文件中的终结点在下次失败的运行状况检查后降级之前,检查连续失败的运行状况数。

MonitorProtocol

用于探测终结点运行状况的协议 (HTTP、HTTPS 或 TCP) 。

名称 类型 说明
HTTP

string

HTTPS

string

TCP

string

Profile

表示流量管理器配置文件的类。

名称 类型 说明
id

string

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

location

string

资源所在的 Azure 区域

name

string

资源的名称

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

允许的终结点记录类型的列表。

properties.dnsConfig

DnsConfig

流量管理器配置文件的 DNS 设置。

properties.endpoints

Endpoint[]

流量管理器配置文件中的终结点列表。

properties.maxReturn

integer

要为 MultiValue 路由类型返回的最大终结点数。

properties.monitorConfig

MonitorConfig

流量管理器配置文件的终结点监视设置。

properties.profileStatus

ProfileStatus

流量管理器配置文件的状态。

properties.trafficRoutingMethod

TrafficRoutingMethod

流量管理器配置文件的流量路由方法。

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

指示流量管理器配置文件的流量视图是“已启用”还是“已禁用”。 Null,表示“已禁用”。 启用此功能会增加流量管理配置文件的成本。

tags

object

资源标记。

type

string

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

ProfileListResult

流量管理器列表对操作响应进行配置文件。

名称 类型 说明
value

Profile[]

获取流量管理器配置文件的列表。

ProfileMonitorStatus

流量管理器配置文件的配置文件级监视状态。

名称 类型 说明
CheckingEndpoints

string

Degraded

string

Disabled

string

Inactive

string

Online

string

ProfileStatus

流量管理器配置文件的状态。

名称 类型 说明
Disabled

string

Enabled

string

Subnets

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

名称 类型 说明
first

string

子网中的第一个地址。

last

string

子网中的最后一个地址。

scope

integer

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

TrafficRoutingMethod

流量管理器配置文件的流量路由方法。

名称 类型 说明
Geographic

string

MultiValue

string

Performance

string

Priority

string

Subnet

string

Weighted

string

TrafficViewEnrollmentStatus

指示流量管理器配置文件的流量视图是“已启用”还是“已禁用”。 Null,表示“已禁用”。 启用此功能会增加流量管理配置文件的成本。

名称 类型 说明
Disabled

string

Enabled

string