Partilhar via

Profiles - List By Resource Group

  • Referência
Serviço:
Traffic Manager
Versão da API:
2022-04-01

Listas todos os perfis do Gestor de Tráfego num grupo de recursos.

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId
 path True

string

Obtém credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version
 query True

string

Versão da API do Cliente.

Respostas

Name Tipo Description
200 OK

ProfileListResult

A lista de perfis do Gestor de Tráfego.
Other Status Codes

CloudError

Resposta predefinida. Será desserializada de acordo com a Definição de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

ListProfilesByResourceGroup

Pedido de amostra

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

Resposta da amostra

Código de estado:
200 
{
  "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"
            }
          }
        ]
      }
    }
  ]
}

Definições

Name Description
AllowedEndpointRecordType

Os tipos de registo DNS de tipo permitido para este perfil.
AlwaysServe

Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.
CloudError

Um erro devolvido pela Resource Manager do Azure
CloudErrorBody

O conteúdo de um erro devolvido pelo Azure Resource Manager
CustomHeaders

Lista de cabeçalhos personalizados.
DnsConfig

Classe que contém definições de DNS num perfil do Gestor de Tráfego.
Endpoint

Classe que representa um ponto final do Gestor de Tráfego.
EndpointMonitorStatus

O estado de monitorização do ponto final.
EndpointStatus

O estado do ponto final. Se o ponto final estiver Ativado, é sondado para o estado de funcionamento do ponto final e está incluído no método de encaminhamento de tráfego.
ExpectedStatusCodeRanges

Lista de intervalos de código de estado esperados.
MonitorConfig

Classe que contém definições de monitorização de pontos finais num perfil do Gestor de Tráfego.
MonitorProtocol

O protocolo (HTTP, HTTPS ou TCP) utilizado para sondar o estado de funcionamento do ponto final.
Profile

Classe que representa um perfil do Gestor de Tráfego.
ProfileListResult

A resposta da operação de perfis do Gestor de Tráfego da lista.
ProfileMonitorStatus

O estado de monitorização ao nível do perfil do Gestor de Tráfego.
ProfileStatus

O estado do perfil do Gestor de Tráfego.
Subnets

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.
TrafficRoutingMethod

O método de encaminhamento de tráfego do perfil do Gestor de Tráfego.
TrafficViewEnrollmentStatus

Indica se a Vista de Tráfego está "Ativada" ou "Desativada" para o perfil do Gestor de Tráfego. Nulo, indica "Desativado". Ativar esta funcionalidade irá aumentar o custo do perfil De Gestão de Tráfego.

AllowedEndpointRecordType

Os tipos de registo DNS de tipo permitido para este perfil.

Name Tipo Description
Any

string

DomainName

string

IPv4Address

string

IPv6Address

string

AlwaysServe

Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.

Name Tipo Description
Disabled

string

Enabled

string

CloudError

Um erro devolvido pela Resource Manager do Azure

Name Tipo Description
error

CloudErrorBody

O conteúdo do erro.

CloudErrorBody

O conteúdo de um erro devolvido pelo Azure Resource Manager

Name Tipo Description
code

string

Código de erro
details

CloudErrorBody[]

Detalhes do erro
message

string

Mensagem de erro
target

string

Destino do erro

CustomHeaders

Lista de cabeçalhos personalizados.

Name Tipo Description
name

string

Nome do cabeçalho.
value

string

Valor do cabeçalho.

DnsConfig

Classe que contém definições de DNS num perfil do Gestor de Tráfego.

Name Tipo Description
fqdn

string

O nome de domínio completamente qualificado (FQDN) do perfil do Gestor de Tráfego. Isto é formado a partir da concatenação do RelativeName com o domínio DNS utilizado pelo Gestor de Tráfego do Azure.
relativeName

string

O nome DNS relativo fornecido por este perfil do Gestor de Tráfego. Este valor é combinado com o nome de domínio DNS utilizado pelo Gestor de Tráfego do Azure para formar o nome de domínio completamente qualificado (FQDN) do perfil.
ttl

integer

O DNS Time-To-Live (TTL), em segundos. Esta ação informa os clientes DNS e DNS locais quanto tempo deve colocar em cache as respostas DNS fornecidas por este perfil do Gestor de Tráfego.

Endpoint

Classe que representa um ponto final do Gestor de Tráfego.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name

string

O nome do recurso
properties.alwaysServe

AlwaysServe

Se o Serviço Always estiver ativado, a pesquisa do estado de funcionamento do ponto final será desativada e os pontos finais serão incluídos no método de encaminhamento de tráfego.
properties.customHeaders

CustomHeaders[]

Lista de cabeçalhos personalizados.
properties.endpointLocation

string

Especifica a localização dos pontos finais externos ou aninhados ao utilizar o método de encaminhamento de tráfego "Desempenho".
properties.endpointMonitorStatus

EndpointMonitorStatus

O estado de monitorização do ponto final.
properties.endpointStatus

EndpointStatus

O estado do ponto final. Se o ponto final estiver Ativado, é sondado para o estado de funcionamento do ponto final e está incluído no método de encaminhamento de tráfego.
properties.geoMapping

string[]

A lista de países/regiões mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Geográfico". Consulte a documentação do Traffic Manager Geographic para obter uma lista completa dos valores aceites.
properties.minChildEndpoints

integer

O número mínimo de pontos finais que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.minChildEndpointsIPv4

integer

O número mínimo de pontos finais IPv4 (tipo de registo DNS A) que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.minChildEndpointsIPv6

integer

O número mínimo de pontos finais IPv6 (tipo de registo DNS AAAA) que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".
properties.priority

integer

A prioridade deste ponto final ao utilizar o método de encaminhamento de tráfego "Prioridade". Os valores possíveis são de 1 a 1000, os valores mais baixos representam uma prioridade mais alta. Este é um parâmetro opcional. Se for especificado, tem de ser especificado em todos os pontos finais e nenhum dos dois pontos finais pode partilhar o mesmo valor de prioridade.
properties.subnets

Subnets[]

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.
properties.target

string

O nome DNS completamente qualificado ou o endereço IP do ponto final. O Gestor de Tráfego devolve este valor em respostas DNS para direcionar o tráfego para este ponto final.
properties.targetResourceId

string

O URI do Recurso do Azure do ponto final. Não aplicável aos pontos finais do tipo "ExternalEndpoints".
properties.weight

integer

O peso deste ponto final ao utilizar o método de encaminhamento de tráfego "Ponderado". Os valores possíveis são de 1 a 1000.
type

string

O tipo de recurso. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

O estado de monitorização do ponto final.

Name Tipo Description
CheckingEndpoint

string

Degraded

string

Disabled

string

Inactive

string

Online

string

Stopped

string

Unmonitored

string

EndpointStatus

O estado do ponto final. Se o ponto final estiver Ativado, é sondado para o estado de funcionamento do ponto final e está incluído no método de encaminhamento de tráfego.

Name Tipo Description
Disabled

string

Enabled

string

ExpectedStatusCodeRanges

Lista de intervalos de código de estado esperados.

Name Tipo Description
max

integer

Código de estado máximo.
min

integer

Código de estado mínimo.

MonitorConfig

Classe que contém definições de monitorização de pontos finais num perfil do Gestor de Tráfego.

Name Tipo Description
customHeaders

CustomHeaders[]

Lista de cabeçalhos personalizados.
expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Lista de intervalos de código de estado esperados.
intervalInSeconds

integer

O intervalo de monitorização para pontos finais neste perfil. Este é o intervalo em que o Gestor de Tráfego verificará o estado de funcionamento de cada ponto final neste perfil.
path

string

O caminho relativo ao nome de domínio do ponto final utilizado para sondar o estado de funcionamento do ponto final.
port

integer

A porta TCP utilizada para sondar o estado de funcionamento do ponto final.
profileMonitorStatus

ProfileMonitorStatus

O estado de monitorização ao nível do perfil do Gestor de Tráfego.
protocol

MonitorProtocol

O protocolo (HTTP, HTTPS ou TCP) utilizado para sondar o estado de funcionamento do ponto final.
timeoutInSeconds

integer

O tempo limite do monitor para pontos finais neste perfil. Esta é a hora em que o Gestor de Tráfego permite que os pontos finais neste perfil possam responder à verificação de estado de funcionamento.
toleratedNumberOfFailures

integer

O número de falhas consecutivas do estado de funcionamento verifica se o Gestor de Tráfego tolera antes de declarar um ponto final neste perfil Degradado após a verificação de estado de funcionamento falhada seguinte.

MonitorProtocol

O protocolo (HTTP, HTTPS ou TCP) utilizado para sondar o estado de funcionamento do ponto final.

Name Tipo Description
HTTP

string

HTTPS

string

TCP

string

Profile

Classe que representa um perfil do Gestor de Tráfego.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
location

string

A Região do Azure onde o recurso reside
name

string

O nome do recurso
properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

A lista de tipos de registo de pontos finais permitidos.
properties.dnsConfig

DnsConfig

As definições de DNS do perfil do Gestor de Tráfego.
properties.endpoints

Endpoint[]

A lista de pontos finais no perfil do Gestor de Tráfego.
properties.maxReturn

integer

Número máximo de pontos finais a devolver para o tipo de encaminhamento MultiValue.
properties.monitorConfig

MonitorConfig

As definições de monitorização do ponto final do perfil do Gestor de Tráfego.
properties.profileStatus

ProfileStatus

O estado do perfil do Gestor de Tráfego.
properties.trafficRoutingMethod

TrafficRoutingMethod

O método de encaminhamento de tráfego do perfil do Gestor de Tráfego.
properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indica se a Vista de Tráfego está "Ativada" ou "Desativada" para o perfil do Gestor de Tráfego. Nulo, indica "Desativado". Ativar esta funcionalidade irá aumentar o custo do perfil De Gestão de Tráfego.
tags

object

Etiquetas de recursos.
type

string

O tipo de recurso. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileListResult

A resposta da operação de perfis do Gestor de Tráfego da lista.

Name Tipo Description
value

Profile[]

Obtém a lista de perfis do Gestor de tráfego.

ProfileMonitorStatus

O estado de monitorização ao nível do perfil do Gestor de Tráfego.

Name Tipo Description
CheckingEndpoints

string

Degraded

string

Disabled

string

Inactive

string

Online

string

ProfileStatus

O estado do perfil do Gestor de Tráfego.

Name Tipo Description
Disabled

string

Enabled

string

Subnets

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Sub-rede". Uma lista vazia corresponderá a todos os intervalos não abrangidos por outros pontos finais.

Name Tipo Description
first

string

Primeiro endereço na sub-rede.
last

string

Último endereço na sub-rede.
scope

integer

Tamanho do bloco (número de bits à esquerda na máscara de sub-rede).

TrafficRoutingMethod

O método de encaminhamento de tráfego do perfil do Gestor de Tráfego.

Name Tipo Description
Geographic

string

MultiValue

string

Performance

string

Priority

string

Subnet

string

Weighted

string

TrafficViewEnrollmentStatus

Indica se a Vista de Tráfego está "Ativada" ou "Desativada" para o perfil do Gestor de Tráfego. Nulo, indica "Desativado". Ativar esta funcionalidade irá aumentar o custo do perfil De Gestão de Tráfego.

Name Tipo Description
Disabled

string

Enabled

string