Поделиться через


Endpoints - Create Or Update

Создание или обновление конечной точки диспетчера трафика.

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

Параметры URI

Имя В Обязательно Тип Описание
endpointName
path True

string

Имя создаваемой или обновляемой конечной точки диспетчера трафика.

endpointType
path True

EndpointType

Тип создаваемой или обновляемой конечной точки диспетчера трафика.

profileName
path True

string

Имя профиля диспетчера трафика.

resourceGroupName
path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

subscriptionId
path True

string

Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.

api-version
query True

string

Версия API клиента.

Текст запроса

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

Имя ресурса.

properties.alwaysServe

AlwaysServe

Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.

properties.customHeaders

CustomHeaders[]

Список настраиваемых заголовков.

properties.endpointLocation

string

Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика "Производительность".

properties.endpointMonitorStatus

EndpointMonitorStatus

Состояние мониторинга конечной точки.

properties.endpointStatus

EndpointStatus

Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.

properties.geoMapping

string[]

Список стран или регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Географический". Полный список допустимых значений см. в географической документации по диспетчеру трафика.

properties.minChildEndpoints

integer

Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.

properties.minChildEndpointsIPv4

integer

Минимальное количество конечных точек IPv4 (запись DNS типа A), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.

properties.minChildEndpointsIPv6

integer

Минимальное число конечных точек IPv6 (тип записи DNS AAAA), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.

properties.priority

integer

Приоритет этой конечной точки при использовании метода маршрутизации трафика Priority. Возможные значения — от 1 до 1000, более низкие — более высокий приоритет. Этот параметр является необязательным. Если он указывается, то должен указываться во всех конечных точках, и никакие две конечные точки не могут иметь одинаковый приоритет.

properties.subnets

Subnets[]

Список подсетей, IP-адресов и диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охваченным другими конечными точками.

properties.target

string

Полное DNS-имя или IP-адрес конечной точки. Диспетчер трафика возвращает это значение в DNS-ответы для направления трафика в эту конечную точку.

properties.targetResourceId

string

URI ресурса Azure конечной точки. Неприменимо к конечным точкам типа ExternalEndpoints.

properties.weight

integer

Вес этой конечной точки при использовании метода маршрутизации трафика "взвешеный". Возможные значения: от 1 до 1000.

type

string

Тип ресурса. Ex- Microsoft.Network/trafficManagerProfiles.

Ответы

Имя Тип Описание
200 OK

Endpoint

Созданная или обновленная конечная точка.

201 Created

Endpoint

Созданная или обновленная конечная точка.

Other Status Codes

CloudError

Ответ по умолчанию. Он будет десериализован в определении Ошибки.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

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

Endpoint-PUT-External-WithAlwaysServe

Образец запроса

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

Пример ответа

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

Образец запроса

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"
      }
    ]
  }
}

Пример ответа

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

Образец запроса

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"
    ]
  }
}

Пример ответа

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

Образец запроса

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

Пример ответа

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

Образец запроса

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"
      }
    ]
  }
}

Пример ответа

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

Определения

Имя Описание
AlwaysServe

Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.

CloudError

Ошибка, возвращенная Resource Manager Azure

CloudErrorBody

Содержимое ошибки, возвращаемой Resource Manager Azure

CustomHeaders

Список настраиваемых заголовков.

Endpoint

Класс, представляющий конечную точку диспетчера трафика.

EndpointMonitorStatus

Состояние мониторинга конечной точки.

EndpointStatus

Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.

EndpointType

Тип создаваемой или обновляемой конечной точки диспетчера трафика.

Subnets

Список подсетей, IP-адресов и диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охваченным другими конечными точками.

AlwaysServe

Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.

Значение Описание
Disabled
Enabled

CloudError

Ошибка, возвращенная Resource Manager Azure

Имя Тип Описание
error

CloudErrorBody

Содержимое ошибки.

CloudErrorBody

Содержимое ошибки, возвращаемой Resource Manager Azure

Имя Тип Описание
code

string

Код ошибки

details

CloudErrorBody[]

Сведения об ошибке

message

string

Сообщение об ошибке

target

string

Целевой объект ошибки

CustomHeaders

Список настраиваемых заголовков.

Имя Тип Описание
name

string

Имя заголовка.

value

string

Значение заголовка.

Endpoint

Класс, представляющий конечную точку диспетчера трафика.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

Имя ресурса.

properties.alwaysServe

AlwaysServe

Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.

properties.customHeaders

CustomHeaders[]

Список настраиваемых заголовков.

properties.endpointLocation

string

Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика "Производительность".

properties.endpointMonitorStatus

EndpointMonitorStatus

Состояние мониторинга конечной точки.

properties.endpointStatus

EndpointStatus

Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.

properties.geoMapping

string[]

Список стран или регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Географический". Полный список допустимых значений см. в географической документации по диспетчеру трафика.

properties.minChildEndpoints

integer

Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.

properties.minChildEndpointsIPv4

integer

Минимальное количество конечных точек IPv4 (запись DNS типа A), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.

properties.minChildEndpointsIPv6

integer

Минимальное число конечных точек IPv6 (тип записи DNS AAAA), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.

properties.priority

integer

Приоритет этой конечной точки при использовании метода маршрутизации трафика Priority. Возможные значения — от 1 до 1000, более низкие — более высокий приоритет. Этот параметр является необязательным. Если он указывается, то должен указываться во всех конечных точках, и никакие две конечные точки не могут иметь одинаковый приоритет.

properties.subnets

Subnets[]

Список подсетей, IP-адресов и диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охваченным другими конечными точками.

properties.target

string

Полное DNS-имя или IP-адрес конечной точки. Диспетчер трафика возвращает это значение в DNS-ответы для направления трафика в эту конечную точку.

properties.targetResourceId

string

URI ресурса Azure конечной точки. Неприменимо к конечным точкам типа ExternalEndpoints.

properties.weight

integer

Вес этой конечной точки при использовании метода маршрутизации трафика "взвешеный". Возможные значения: от 1 до 1000.

type

string

Тип ресурса. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Состояние мониторинга конечной точки.

Значение Описание
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.

Значение Описание
Disabled
Enabled

EndpointType

Тип создаваемой или обновляемой конечной точки диспетчера трафика.

Значение Описание
AzureEndpoints
ExternalEndpoints
NestedEndpoints

Subnets

Список подсетей, IP-адресов и диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охваченным другими конечными точками.

Имя Тип Описание
first

string

Первый адрес в подсети.

last

string

Последний адрес в подсети.

scope

integer

Размер блока (количество исходных битов в маске подсети).