Partilhar via

Endpoints - Create Or Update

  • Referência
Service:
Traffic Manager
API Version:
2022-04-01

Criar ou atualizar um ponto final do Gestor de Tráfego.

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

Parâmetros do URI

Name Em Necessário Tipo Description
endpointName
 path True

string

O nome do ponto final do Gestor de Tráfego a criar ou atualizar.
endpointType
 path True

EndpointType

O tipo de ponto final do Gestor de Tráfego a ser criado ou atualizado.
profileName
 path True

string

O nome do perfil do Gestor de Tráfego.
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 de Cliente.

Corpo do Pedido

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.

Respostas

Name Tipo Description
200 OK

Endpoint

O Ponto Final criado ou atualizado.
201 Created

Endpoint

O Ponto Final criado ou atualizado.
Other Status Codes

CloudError

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Endpoint-PUT-External-WithAlwaysServe
Endpoint-PUT-External-WithCustomHeaders
Endpoint-PUT-External-WithGeoMapping
Endpoint-PUT-External-WithLocation
Endpoint-PUT-External-WithSubnetMapping

Endpoint-PUT-External-WithAlwaysServe

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01

{
  "name": "azsmnet7187",
  "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
  "properties": {
    "target": "foobar.contoso.com",
    "endpointStatus": "Enabled",
    "endpointLocation": "North Europe",
    "alwaysServe": "Enabled"
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe",
    "alwaysServe": "Enabled"
  }
}
Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe",
    "alwaysServe": "Enabled"
  }
}

Endpoint-PUT-External-WithCustomHeaders

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01

{
  "name": "azsmnet7187",
  "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
  "properties": {
    "target": "foobar.contoso.com",
    "endpointStatus": "Enabled",
    "endpointLocation": "North Europe",
    "customHeaders": [
      {
        "name": "header-1",
        "value": "value-1"
      },
      {
        "name": "header-2",
        "value": "value-2"
      }
    ]
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe",
    "customHeaders": [
      {
        "name": "header-1",
        "value": "value-1"
      },
      {
        "name": "header-2",
        "value": "value-2"
      }
    ]
  }
}
Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe",
    "customHeaders": [
      {
        "name": "header-1",
        "value": "value-1"
      },
      {
        "name": "header-2",
        "value": "value-2"
      }
    ]
  }
}

Endpoint-PUT-External-WithGeoMapping

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager8224/ExternalEndpoints/My%20external%20endpoint?api-version=2022-04-01

{
  "name": "My external endpoint",
  "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
  "properties": {
    "target": "foobar.contoso.com",
    "endpointStatus": "Enabled",
    "geoMapping": [
      "GEO-AS",
      "GEO-AF"
    ]
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/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,
    "geoMapping": [
      "GEO-AS",
      "GEO-AF"
    ]
  }
}
Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/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,
    "geoMapping": [
      "GEO-AS",
      "GEO-AF"
    ]
  }
}

Endpoint-PUT-External-WithLocation

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficmanagerprofiles/azsmnet6386/ExternalEndpoints/azsmnet7187?api-version=2022-04-01

{
  "name": "azsmnet7187",
  "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
  "properties": {
    "target": "foobar.contoso.com",
    "endpointStatus": "Enabled",
    "endpointLocation": "North Europe"
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe"
  }
}
Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "name": "azsmnet7187",
  "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
  "properties": {
    "endpointStatus": "Enabled",
    "endpointMonitorStatus": "CheckingEndpoint",
    "target": "foobar.contoso.com",
    "weight": 1,
    "priority": 1,
    "endpointLocation": "North Europe"
  }
}

Endpoint-PUT-External-WithSubnetMapping

Sample Request

PUT https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager8224/ExternalEndpoints/My%20external%20endpoint?api-version=2022-04-01

{
  "name": "My external endpoint",
  "type": "Microsoft.network/TrafficManagerProfiles/ExternalEndpoints",
  "properties": {
    "target": "foobar.contoso.com",
    "endpointStatus": "Enabled",
    "subnets": [
      {
        "first": "1.2.3.0",
        "scope": 24
      },
      {
        "first": "25.26.27.28",
        "last": "29.30.31.32"
      }
    ]
  }
}

Sample Response

Status code:
201 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/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,
    "subnets": [
      {
        "first": "1.2.3.0",
        "scope": 24
      },
      {
        "first": "25.26.27.28",
        "last": "29.30.31.32"
      }
    ]
  }
}
Status code:
200 
{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager2191/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager8224/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,
    "subnets": [
      {
        "first": "1.2.3.0",
        "scope": 24
      },
      {
        "first": "25.26.27.28",
        "last": "29.30.31.32"
      }
    ]
  }
}

Definições

Name Description
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.
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.
EndpointType

O tipo de ponto final do Gestor de Tráfego a ser criado ou atualizado.
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.

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.

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

EndpointType

O tipo de ponto final do Gestor de Tráfego a ser criado ou atualizado.

Name Tipo Description
AzureEndpoints

string

ExternalEndpoints

string

NestedEndpoints

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 principais na máscara de sub-rede).