Compartilhar via


Profiles - Update

Atualize um perfil do Gerenciador de Tráfego.

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

Parâmetros de URI

Nome Em Obrigató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. 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.

Corpo da solicitação

Nome Tipo Description
id

string

ID de recurso totalmente qualificada 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 (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 do 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 o Modo de Exibição de Tráfego está 'Habilitado' ou 'Desabilitado' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciamento de Tráfego.

tags

object

Marcas de recurso.

type

string

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

Respostas

Nome Tipo Description
200 OK

Profile

O perfil atualizado 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 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

Profile-PATCH-MonitorConfig

Solicitação de exemplo

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

{
  "properties": {
    "monitorConfig": {
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "timeoutInSeconds": 6,
      "toleratedNumberOfFailures": 4,
      "customHeaders": [
        {
          "name": "header-1",
          "value": "value-1"
        },
        {
          "name": "header-2",
          "value": "value-2"
        }
      ]
    }
  }
}

Resposta de exemplo

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

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

ProfileMonitorStatus

O status de monitoramento em nível de perfil 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 '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 o Modo de Exibição de Tráfego está 'Habilitado' ou 'Desabilitado' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciamento de Tráfego.

AllowedEndpointRecordType

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

Valor Description
Any
DomainName
IPv4Address
IPv6Address

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.

Valor Description
Disabled
Enabled

CloudError

Um erro retornado pelo Azure Resource Manager

Nome Tipo Description
error

CloudErrorBody

O conteúdo do erro.

CloudErrorBody

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

Nome Tipo Description
code

string

Código de 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 as 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 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 TTL (To-Live de Tempo de DNS) em segundos. Isso informa aos resolvedores DNS locais e clientes DNS quanto tempo para 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 qualificada 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 "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 mapeada 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 (int64)

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 (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 somente ao ponto de extremidade do tipo 'NestedEndpoints'.

properties.minChildEndpointsIPv6

integer (int64)

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 (int64)

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, 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 nenhum ponto 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 esse 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 totalmente qualificado ou o endereço IP 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 pontos de extremidade 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.

Nome 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 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ódigos de status esperados.

intervalInSeconds

integer (int64)

O intervalo de monitor para pontos de extremidade neste perfil. Esse é o intervalo no qual o Gerenciador de Tráfego verificará a integridade de cada ponto de extremidade neste 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 em nível de perfil 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 (int64)

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 neste perfil sejam respostas à verificação de integridade.

toleratedNumberOfFailures

integer (int64)

O número de verificações de integridade com falha consecutivas toleradas pelo Gerenciador de Tráfego 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 de extremidade.

Valor Description
HTTP
HTTPS
TCP

Profile

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

Nome Tipo Description
id

string

ID de recurso totalmente qualificada 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 (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 do 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 o Modo de Exibição de Tráfego está 'Habilitado' ou 'Desabilitado' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciamento de Tráfego.

tags

object

Marcas de recurso.

type

string

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

ProfileMonitorStatus

O status de monitoramento em nível de perfil 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 esse 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.

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.

Valor Description
Geographic
MultiValue
Performance
Priority
Subnet
Weighted

TrafficViewEnrollmentStatus

Indica se o Modo de Exibição de Tráfego está 'Habilitado' ou 'Desabilitado' para o perfil do Gerenciador de Tráfego. Nulo, indica 'Desabilitado'. Habilitar esse recurso aumentará o custo do perfil Gerenciamento de Tráfego.

Valor Description
Disabled
Enabled