Compartilhar via


Profiles - List By Resource Group

Listas todos os perfis do Gerenciador de Tráfego em um grupo de recursos.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

Obtém as credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True

string

Versão da API do cliente.

Respostas

Nome Tipo Description
200 OK

ProfileListResult

A lista de perfis do Gerenciador de Tráfego.

Other Status Codes

CloudError

Resposta padrão. Ele será desserializado de acordo com a definição de erro.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ListProfilesByResourceGroup

Solicitação de exemplo

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

Resposta de exemplo

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

Nome Description
AllowedEndpointRecordType

Os tipos de registro DNS de tipo permitidos para esse perfil.

AlwaysServe

Se o Always Serve estiver habilitado, a investigação da integridade do ponto de extremidade será desabilitada e os pontos de extremidade serão incluídos no método de roteamento de tráfego.

CloudError

Um erro retornado pela Resource Manager do Azure

CloudErrorBody

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

CustomHeaders

Lista de cabeçalhos personalizados.

DnsConfig

Classe que contém configurações de DNS em um perfil do Gerenciador de Tráfego.

Endpoint

Classe que representa um ponto de extremidade do Gerenciador de Tráfego.

EndpointMonitorStatus

O status de monitoramento do ponto de extremidade.

EndpointStatus

O status do ponto de extremidade. Se o ponto de extremidade estiver Habilitado, sua integridade é analisada e ele é incluído no método de roteamento de tráfego.

ExpectedStatusCodeRanges

Lista de intervalos de código de status esperados.

MonitorConfig

Classe que contém configurações de monitoramento de ponto de extremidade em um perfil do Gerenciador de Tráfego.

MonitorProtocol

O protocolo (HTTP, HTTPS ou TCP) usado para investigar a integridade do ponto de extremidade.

Profile

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

ProfileListResult

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

ProfileMonitorStatus

O status de monitoramento no nível do perfil do Gerenciador de Tráfego.

ProfileStatus

O status do perfil do Gerenciador de Tráfego.

Subnets

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para esse ponto de extremidade ao usar o método de roteamento de tráfego 'Subnet'. Uma lista vazia corresponderá a todos os intervalos não cobertos por outros pontos de extremidade.

TrafficRoutingMethod

O método de roteamento de tráfego do perfil do Gerenciador de Tráfego.

TrafficViewEnrollmentStatus

Indica se a Exibição de Tráfego está "Habilitada" ou "Desabilitada" para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciar Tráfego.

AllowedEndpointRecordType

Os tipos de registro DNS de tipo permitidos para esse perfil.

Nome Tipo Description
Any

string

DomainName

string

IPv4Address

string

IPv6Address

string

AlwaysServe

Se o Always Serve estiver habilitado, a investigação da integridade do ponto de extremidade será desabilitada e os pontos de extremidade serão incluídos no método de roteamento de tráfego.

Nome Tipo Description
Disabled

string

Enabled

string

CloudError

Um erro retornado pela Resource Manager do Azure

Nome Tipo Description
error

CloudErrorBody

O conteúdo do erro.

CloudErrorBody

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

Nome Tipo Description
code

string

Código do erro

details

CloudErrorBody[]

Detalhes do erro

message

string

Mensagem de erro

target

string

Destino de erro

CustomHeaders

Lista de cabeçalhos personalizados.

Nome Tipo Description
name

string

Nome do cabeçalho.

value

string

Valor do cabeçalho.

DnsConfig

Classe que contém configurações de DNS em um perfil do Gerenciador de Tráfego.

Nome Tipo Description
fqdn

string

O FQDN (nome de domínio totalmente qualificado) do perfil do Gerenciador de Tráfego. Isso é formado a partir da concatenação do RelativeName com o domínio DNS usado pelo Gerenciador de Tráfego do Azure.

relativeName

string

O nome DNS relativo fornecido por esse perfil do Gerenciador de Tráfego. Esse valor é combinado ao nome de domínio DNS usado pelo Gerenciador de Tráfego do Azure para formar o nome de domínio totalmente qualificado (FQDN) do perfil.

ttl

integer

O TTL (tempo de vida útil) do DNS em segundos. Isso informa aos resolvedores DNS locais e clientes DNS quanto tempo armazenar em cache as respostas DNS fornecidas por esse perfil do Gerenciador de Tráfego.

Endpoint

Classe que representa um ponto de extremidade do Gerenciador de Tráfego.

Nome Tipo Description
id

string

ID de recurso totalmente 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 Always Serve estiver habilitado, a investigação da integridade do ponto de extremidade será desabilitada e os pontos de extremidade serão incluídos no método de roteamento de tráfego.

properties.customHeaders

CustomHeaders[]

Lista de cabeçalhos personalizados.

properties.endpointLocation

string

Especifica o local dos pontos de extremidade externos ou aninhados ao usar o método de roteamento de tráfego 'Performance'.

properties.endpointMonitorStatus

EndpointMonitorStatus

O status de monitoramento do ponto de extremidade.

properties.endpointStatus

EndpointStatus

O status do ponto de extremidade. Se o ponto de extremidade estiver Habilitado, sua integridade é analisada e ele é incluído no método de roteamento de tráfego.

properties.geoMapping

string[]

A lista de países/regiões mapeadas para esse ponto de extremidade ao usar o método de roteamento de tráfego 'Geográfico'. Consulte a documentação geográfica do Gerenciador de Tráfego para obter uma lista completa de valores aceitos.

properties.minChildEndpoints

integer

O número mínimo de pontos de extremidade que devem estar disponíveis no perfil filho para que o perfil pai seja considerado disponível. Aplicável somente ao ponto de extremidade do tipo 'NestedEndpoints'.

properties.minChildEndpointsIPv4

integer

O número mínimo de pontos de extremidade IPv4 (tipo de registro DNS A) que devem estar disponíveis no perfil filho para que o perfil pai seja considerado disponível. Aplicável somente ao ponto de extremidade do tipo 'NestedEndpoints'.

properties.minChildEndpointsIPv6

integer

O número mínimo de pontos de extremidade AAAA (tipo de registro DNS) IPv6 que devem estar disponíveis no perfil filho para que o perfil pai seja considerado disponível. Aplicável somente ao ponto de extremidade do tipo 'NestedEndpoints'.

properties.priority

integer

A prioridade desse ponto de extremidade ao usar o método de roteamento de tráfego 'Priority'. Os valores possíveis são de 1 a 1000, os valores mais baixos representam prioridade mais alta. Esse é um parâmetro opcional. Se especificado, ele deve ser especificado em todos os pontos de extremidade e dois pontos de extremidade não podem compartilhar o mesmo valor de prioridade.

properties.subnets

Subnets[]

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para esse ponto de extremidade ao usar o método de roteamento de tráfego 'Subnet'. Uma lista vazia corresponderá a todos os intervalos não cobertos por outros pontos de extremidade.

properties.target

string

O nome DNS totalmente qualificado ou o endereço IP do ponto de extremidade. O Gerenciador de Tráfego retorna esse valor nas respostas de DNS para direcionar tráfego para esse ponto de extremidade.

properties.targetResourceId

string

O URI do Recurso do Azure do ponto de extremidade. Não aplicável a pontos de extremidade do tipo 'ExternalEndpoints'.

properties.weight

integer

O peso desse ponto de extremidade ao usar o método de roteamento de tráfego 'Ponderado'. Os valores possíveis são de 1 a 1000.

type

string

Tipo do recurso. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

O status de monitoramento do ponto de extremidade.

Nome Tipo Description
CheckingEndpoint

string

Degraded

string

Disabled

string

Inactive

string

Online

string

Stopped

string

Unmonitored

string

EndpointStatus

O status do ponto de extremidade. Se o ponto de extremidade estiver Habilitado, sua integridade é analisada e ele é incluído no método de roteamento de tráfego.

Nome Tipo Description
Disabled

string

Enabled

string

ExpectedStatusCodeRanges

Lista de intervalos de código de status esperados.

Nome Tipo Description
max

integer

Código máximo status.

min

integer

Código de status mínimo.

MonitorConfig

Classe que contém configurações de monitoramento de ponto de extremidade em um perfil do Gerenciador de Tráfego.

Nome Tipo Description
customHeaders

CustomHeaders[]

Lista de cabeçalhos personalizados.

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Lista de intervalos de código de status esperados.

intervalInSeconds

integer

O intervalo de monitor para pontos de extremidade neste perfil. Esse é o intervalo em que o Gerenciador de Tráfego marcar a integridade de cada ponto de extremidade nesse perfil.

path

string

O caminho relativo ao nome de domínio do ponto de extremidade usado para investigar a integridade do ponto de extremidade.

port

integer

A porta TCP usada para investigar a integridade do ponto de extremidade.

profileMonitorStatus

ProfileMonitorStatus

O status de monitoramento no nível do perfil do Gerenciador de Tráfego.

protocol

MonitorProtocol

O protocolo (HTTP, HTTPS ou TCP) usado para investigar a integridade do ponto de extremidade.

timeoutInSeconds

integer

O tempo limite do monitor para pontos de extremidade neste perfil. Esse é o momento em que o Gerenciador de Tráfego permite que os pontos de extremidade nesse perfil atuem à marcar de integridade.

toleratedNumberOfFailures

integer

O número de marcar de integridade com falha consecutiva que o Gerenciador de Tráfego tolera antes de declarar um ponto de extremidade nesse perfil degradado após a próxima falha na marcar de integridade.

MonitorProtocol

O protocolo (HTTP, HTTPS ou TCP) usado para investigar a integridade do ponto de extremidade.

Nome Tipo Description
HTTP

string

HTTPS

string

TCP

string

Profile

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

Nome Tipo Description
id

string

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

location

string

A Região do Azure em que o recurso reside

name

string

O nome do recurso

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

A lista de tipos de registro de ponto de extremidade permitidos.

properties.dnsConfig

DnsConfig

As configurações de DNS do perfil do Gerenciador de Tráfego.

properties.endpoints

Endpoint[]

A lista de pontos de extremidade no perfil do Gerenciador de Tráfego.

properties.maxReturn

integer

Número máximo de pontos de extremidade a serem retornados para o tipo de roteamento MultiValue.

properties.monitorConfig

MonitorConfig

As configurações de monitoramento de ponto de extremidade do perfil do Gerenciador de Tráfego.

properties.profileStatus

ProfileStatus

O status do perfil do Gerenciador de Tráfego.

properties.trafficRoutingMethod

TrafficRoutingMethod

O método de roteamento de tráfego do perfil do Gerenciador de Tráfego.

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indica se a Exibição de Tráfego está "Habilitada" ou "Desabilitada" para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciar Tráfego.

tags

object

Marcas de recurso.

type

string

Tipo do recurso. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileListResult

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

Nome Tipo Description
value

Profile[]

Obtém a lista de perfis do Gerenciador de Tráfego.

ProfileMonitorStatus

O status de monitoramento no nível do perfil do Gerenciador de Tráfego.

Nome Tipo Description
CheckingEndpoints

string

Degraded

string

Disabled

string

Inactive

string

Online

string

ProfileStatus

O status do perfil do Gerenciador de Tráfego.

Nome Tipo Description
Disabled

string

Enabled

string

Subnets

A lista de sub-redes, endereços IP e/ou intervalos de endereços mapeados para esse ponto de extremidade ao usar o método de roteamento de tráfego 'Subnet'. Uma lista vazia corresponderá a todos os intervalos não cobertos por outros pontos de extremidade.

Nome 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 roteamento de tráfego do perfil do Gerenciador de Tráfego.

Nome Tipo Description
Geographic

string

MultiValue

string

Performance

string

Priority

string

Subnet

string

Weighted

string

TrafficViewEnrollmentStatus

Indica se a Exibição de Tráfego está "Habilitada" ou "Desabilitada" para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciar Tráfego.

Nome Tipo Description
Disabled

string

Enabled

string