Profiles - Update
Atualizar 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 |
---|---|---|---|---|
profile
|
path | True |
string |
O nome do perfil do Gerenciador de Tráfego. |
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
subscription
|
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. |
Corpo da solicitação
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 |
A lista de tipos de registro de ponto de extremidade permitidos. |
|
properties.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 |
As configurações de monitoramento de ponto de extremidade do perfil do Gerenciador de Tráfego. |
|
properties.profileStatus |
O status do perfil do Gerenciador de Tráfego. |
|
properties.trafficRoutingMethod |
O método de roteamento de tráfego do perfil do Gerenciador de Tráfego. |
|
properties.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. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
O perfil atualizado do Gerenciador de Tráfego. |
|
Other Status Codes |
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
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 |
---|---|
Allowed |
Os tipos de registro DNS de tipo permitidos para esse perfil. |
Always |
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. |
Cloud |
Um erro retornado pelo Resource Manager do Azure |
Cloud |
O conteúdo de um erro retornado pelo Resource Manager do Azure |
Custom |
Lista de cabeçalhos personalizados. |
Dns |
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. |
Endpoint |
O status de monitoramento do ponto de extremidade. |
Endpoint |
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. |
Expected |
Lista de intervalos de código de status esperados. |
Monitor |
Classe que contém configurações de monitoramento de ponto de extremidade em um perfil do Gerenciador de Tráfego. |
Monitor |
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. |
Profile |
O status de monitoramento no nível do perfil do Gerenciador de Tráfego. |
Profile |
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. |
Traffic |
O método de roteamento de tráfego do perfil do Gerenciador de Tráfego. |
Traffic |
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 de Gerenciamento de 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 pelo Resource Manager do Azure
Nome | Tipo | Description |
---|---|---|
error |
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 |
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 este 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 |
A TTL (vida útil) do DNS, em segundos. Isso informa aos resolvedores de DNS locais e aos 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.
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 |
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 |
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 |
O status de monitoramento do ponto de extremidade. |
|
properties.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 dos 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 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 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 "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 nas respostas de DNS para direcionar tráfego para esse ponto de extremidade. |
properties.targetResourceId |
string |
O URI de Recurso do Azure do 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. Por exemplo, 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 |
Lista de cabeçalhos personalizados. |
|
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 no qual 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 |
O status de monitoramento no nível do perfil do Gerenciador de Tráfego. |
|
protocol |
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 consecutivas toleradas pelo Gerenciador de Tráfego antes de declarar um ponto de extremidade nesse perfil Degradado após a próxima marcar de integridade com falha. |
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 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 |
A lista de tipos de registro de ponto de extremidade permitidos. |
|
properties.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 |
As configurações de monitoramento de ponto de extremidade do perfil do Gerenciador de Tráfego. |
|
properties.profileStatus |
O status do perfil do Gerenciador de Tráfego. |
|
properties.trafficRoutingMethod |
O método de roteamento de tráfego do perfil do Gerenciador de Tráfego. |
|
properties.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 de Gerenciamento de Tráfego. |
|
tags |
object |
Marcas de recurso. |
type |
string |
Tipo do recurso. Por exemplo, Microsoft.Network/trafficManagerProfiles. |
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 "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.
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 de Gerenciamento de Tráfego.
Nome | Tipo | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |