Partilhar via


Profiles - Get

Obtém um perfil do Gerenciador de Tráfego.

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

Parâmetros do URI

Name Em Necessário Tipo Description
profileName
path True

string

O nome do perfil do Gerenciador de Tráfego.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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

subscriptionId
path True

string

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

api-version
query True

string

Versão da API do cliente.

Respostas

Name Tipo Description
200 OK

Profile

O perfil do Gestor 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

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

Profile-GET-WithEndpoints
Profile-GET-WithTrafficViewDisabled
Profile-GET-WithTrafficViewEnabled

Profile-GET-WithEndpoints

Pedido de amostra

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

Resposta da amostra

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880",
  "name": "azuresdkfornetautoresttrafficmanager3880",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager3880",
      "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 3,
      "timeoutInSeconds": 10
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/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"
        }
      }
    ]
  }
}

Profile-GET-WithTrafficViewDisabled

Pedido de amostra

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

Resposta da amostra

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880",
  "name": "azuresdkfornetautoresttrafficmanager3880",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager3880",
      "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 3,
      "timeoutInSeconds": 10
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/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"
        }
      }
    ],
    "trafficViewEnrollmentStatus": "Disabled"
  }
}

Profile-GET-WithTrafficViewEnabled

Pedido de amostra

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

Resposta da amostra

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880",
  "name": "azuresdkfornetautoresttrafficmanager3880",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager3880",
      "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 3,
      "timeoutInSeconds": 10
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/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"
        }
      }
    ],
    "trafficViewEnrollmentStatus": "Enabled"
  }
}

Definições

Name Description
AllowedEndpointRecordType

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

AlwaysServe

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

CloudError

Um erro retornado pelo Azure Resource Manager

CloudErrorBody

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

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, ele será investigado quanto à integridade do ponto de extremidade e será incluído no método de roteamento de tráfego.

ExpectedStatusCodeRanges

Lista de intervalos de códigos de status esperados.

MonitorConfig

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

MonitorProtocol

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

Profile

Classe que representa um perfil do Traffic Manager.

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 este ponto de extremidade ao usar o método de roteamento de tráfego 'Sub-rede'. 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 Visualização de Tráfego é 'Habilitada' ou 'Desabilitada' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desativado'. Ativar esse recurso aumentará o custo do perfil de gerenciamento de tráfego.

AllowedEndpointRecordType

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

Valor Description
Any
DomainName
IPv4Address
IPv6Address

AlwaysServe

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

Valor Description
Disabled
Enabled

CloudError

Um erro retornado pelo Azure Resource Manager

Name Tipo Description
error

CloudErrorBody

O conteúdo do erro.

CloudErrorBody

O conteúdo de um erro retornado 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

Alvo de 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 configurações de DNS em um perfil do Gerenciador de Tráfego.

Name Tipo Description
fqdn

string

O nome de domínio totalmente qualificado (FQDN) 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 este perfil do Gestor de Tráfego. Esse valor é combinado com o nome de domínio DNS usado pelo Gerenciador de Tráfego do Azure para formar o FQDN (nome de domínio totalmente qualificado) do perfil.

ttl

integer (int64)

O DNS Time-To-Live (TTL), em segundos. Isso informa aos resolvedores de DNS locais e clientes DNS por 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.

Name Tipo Description
id

string

ID do 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 sondagem da integridade do endpoint 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 'Desempenho'.

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, ele será investigado quanto à integridade do ponto de extremidade e será incluído no método de roteamento de tráfego.

properties.geoMapping

string[]

A lista de países/regiões mapeados para este ponto final ao usar o método de roteamento de tráfego 'Geográfico'. Consulte a documentação geográfica do Traffic Manager para obter uma lista completa dos valores aceites.

properties.minChildEndpoints

integer (int64)

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

properties.minChildEndpointsIPv4

integer (int64)

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

properties.minChildEndpointsIPv6

integer (int64)

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

properties.priority

integer (int64)

A prioridade deste ponto de extremidade ao usar o método de roteamento de tráfego 'Priority'. Os valores possíveis são de 1 a 1000, valores mais baixos representam maior prioridade. Este é um parâmetro opcional. Se especificado, ele deve ser especificado em todos os pontos de extremidade, e nenhum dois pontos de extremidade pode 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 este ponto de extremidade ao usar o método de roteamento de tráfego 'Sub-rede'. Uma lista vazia corresponderá a todos os intervalos não cobertos por outros pontos de extremidade.

properties.target

string

O nome DNS ou endereço IP totalmente qualificado do ponto de extremidade. O Gerenciador de Tráfego retorna esse valor em respostas DNS para direcionar o 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 parâmetros do tipo 'ExternalEndpoints'.

properties.weight

integer (int64)

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

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

EndpointMonitorStatus

O status de monitoramento do ponto de extremidade.

Valor Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

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

Valor Description
Disabled
Enabled

ExpectedStatusCodeRanges

Lista de intervalos de códigos de status esperados.

Name Tipo Description
max

integer

Código de status máximo.

min

integer

Código de status mínimo.

MonitorConfig

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

Name Tipo Description
customHeaders

CustomHeaders[]

Lista de cabeçalhos personalizados.

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Lista de intervalos de códigos de status esperados.

intervalInSeconds

integer (int64)

O intervalo de monitor para pontos de extremidade neste perfil. Este é o intervalo no qual o Gerenciador de Tráfego verificará 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 (int64)

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 final.

timeoutInSeconds

integer (int64)

O tempo limite do monitor para pontos de extremidade neste perfil. Este é o tempo que o Traffic Manager permite que os pontos de extremidade neste perfil respondam à verificação de integridade.

toleratedNumberOfFailures

integer (int64)

O número de verificações de integridade com falha consecutivas que o Gerenciador de Tráfego tolera antes de declarar um ponto de extremidade neste perfil Degradado após a próxima verificação de integridade com falha.

MonitorProtocol

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

Valor Description
HTTP
HTTPS
TCP

Profile

Classe que representa um perfil do Traffic Manager.

Name Tipo Description
id

string

ID do recurso totalmente 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 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 (int64)

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 Visualização de Tráfego é 'Habilitada' ou 'Desabilitada' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desativado'. Ativar esse recurso aumentará o custo do perfil de gerenciamento de tráfego.

tags

object

Tags de recursos.

type

string

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

ProfileMonitorStatus

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

Valor Description
CheckingEndpoints
Degraded
Disabled
Inactive
Online

ProfileStatus

O status do perfil do Gerenciador de Tráfego.

Valor Description
Disabled
Enabled

Subnets

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

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

Valor Description
Geographic
MultiValue
Performance
Priority
Subnet
Weighted

TrafficViewEnrollmentStatus

Indica se a Visualização de Tráfego é 'Habilitada' ou 'Desabilitada' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desativado'. Ativar esse recurso aumentará o custo do perfil de gerenciamento de tráfego.

Valor Description
Disabled
Enabled