Endpoints - Update

Служба:: Traffic Manager

Версия API:: 2022-04-01

Обновите конечную точку диспетчера трафика.

PATCH 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 minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Имя ресурса
properties.alwaysServe	AlwaysServe	Если включена функция Always Serve, проверка работоспособности конечных точек будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
properties.customHeaders	EndpointPropertiesCustomHeadersItem[]	Список настраиваемых заголовков.
properties.endpointLocation	string	Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика Performance.
properties.endpointMonitorStatus	EndpointMonitorStatus	Состояние мониторинга конечной точки.
properties.endpointStatus	EndpointStatus	Состояние конечной точки. Если конечная точка включена, она проверяется для работоспособности конечных точек и включается в метод маршрутизации трафика.
properties.geoMapping	string[]	Список стран или регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика Geograph. Обратитесь к географической документации по диспетчеру трафика, чтобы получить полный список принятых значений.
properties.minChildEndpoints	integer (int64)	Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv4	integer (int64)	Минимальное количество конечных точек IPv4 (тип записи DNS A), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv6	integer (int64)	Минимальное количество конечных точек IPv6 (тип записи DNS AAAA), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.priority	integer (int64)	Приоритет этой конечной точки при использовании метода маршрутизации трафика "Приоритет". Возможные значения : от 1 до 1000, более низкие значения представляют более высокий приоритет. Этот параметр является необязательным. Если он указан, он должен быть указан во всех конечных точках, и две конечные точки не могут совместно использовать одно и то же значение приоритета.
properties.subnets	EndpointPropertiesSubnetsItem[]	Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика Subnet. Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.
properties.target	string	Полное DNS-имя или IP-адрес конечной точки. Диспетчер трафика возвращает это значение в ответах DNS для направления трафика в эту конечную точку.
properties.targetResourceId	string	URI ресурса Azure конечной точки. Неприменимо к конечным точкам типа ExternalEndpoints.
properties.weight	integer (int64)	Вес этой конечной точки при использовании метода маршрутизации трафика в весовом весе. Возможные значения : от 1 до 1000.
type	string	Тип ресурса. Ex- Microsoft.Network/trafficManagerProfiles.

Ответы

Имя	Тип	Описание
200 OK	Endpoint	Операция Azure успешно завершена.
Other Status Codes	CloudError	Непредвиденное сообщение об ошибке.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

Endpoint-PATCH-External-Target

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

HTTP

PATCH 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",
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1421/providers/Microsoft.Network/trafficManagerProfiles/azsmnet6386/externalEndpoints/azsmnet7187",
  "properties": {
    "target": "another.foobar.contoso.com"
  }
}

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

Код состояния:: 200

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

Определения

Имя	Описание
AlwaysServe	Если включена функция Always Serve, проверка работоспособности конечных точек будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
CloudError	Ошибка, возвращаемая Azure Resource Manager
CloudErrorBody	Содержимое ошибки, возвращаемой Azure Resource Manager
Endpoint	Класс, представляющий конечную точку диспетчера трафика.
EndpointMonitorStatus	Состояние мониторинга конечной точки.
EndpointPropertiesCustomHeadersItem	Имя и значение пользовательского заголовка.
EndpointPropertiesSubnetsItem	Первый адрес подсети, область и/или последний адрес.
EndpointStatus	Состояние конечной точки. Если конечная точка включена, она проверяется для работоспособности конечных точек и включается в метод маршрутизации трафика.
EndpointType	Тип конечной точки диспетчера трафика.

AlwaysServe

Перечисление

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

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

CloudError

Объект

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

Имя	Тип	Описание
error	CloudErrorBody	Содержимое ошибки.

CloudErrorBody

Объект

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

Имя	Тип	Описание
code	string	Код ошибки
details	CloudErrorBody[]	Сведения об ошибке
message	string	Сообщение об ошибке
target	string	Целевой объект ошибки

Endpoint

Объект

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

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name	string	Имя ресурса
properties.alwaysServe	AlwaysServe	Если включена функция Always Serve, проверка работоспособности конечных точек будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
properties.customHeaders	EndpointPropertiesCustomHeadersItem[]	Список настраиваемых заголовков.
properties.endpointLocation	string	Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика Performance.
properties.endpointMonitorStatus	EndpointMonitorStatus	Состояние мониторинга конечной точки.
properties.endpointStatus	EndpointStatus	Состояние конечной точки. Если конечная точка включена, она проверяется для работоспособности конечных точек и включается в метод маршрутизации трафика.
properties.geoMapping	string[]	Список стран или регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика Geograph. Обратитесь к географической документации по диспетчеру трафика, чтобы получить полный список принятых значений.
properties.minChildEndpoints	integer (int64)	Минимальное количество конечных точек, которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv4	integer (int64)	Минимальное количество конечных точек IPv4 (тип записи DNS A), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.minChildEndpointsIPv6	integer (int64)	Минимальное количество конечных точек IPv6 (тип записи DNS AAAA), которые должны быть доступны в дочернем профиле, чтобы родительский профиль считался доступным. Применимо только к конечной точке типа NestedEndpoints.
properties.priority	integer (int64)	Приоритет этой конечной точки при использовании метода маршрутизации трафика "Приоритет". Возможные значения : от 1 до 1000, более низкие значения представляют более высокий приоритет. Этот параметр является необязательным. Если он указан, он должен быть указан во всех конечных точках, и две конечные точки не могут совместно использовать одно и то же значение приоритета.
properties.subnets	EndpointPropertiesSubnetsItem[]	Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика Subnet. Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.
properties.target	string	Полное DNS-имя или IP-адрес конечной точки. Диспетчер трафика возвращает это значение в ответах DNS для направления трафика в эту конечную точку.
properties.targetResourceId	string	URI ресурса Azure конечной точки. Неприменимо к конечным точкам типа ExternalEndpoints.
properties.weight	integer (int64)	Вес этой конечной точки при использовании метода маршрутизации трафика в весовом весе. Возможные значения : от 1 до 1000.
type	string	Тип ресурса. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Перечисление

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

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

EndpointPropertiesCustomHeadersItem

Объект

Имя и значение пользовательского заголовка.

Имя	Тип	Описание
name	string	Имя заголовка.
value	string	Значение заголовка.

EndpointPropertiesSubnetsItem

Объект

Первый адрес подсети, область и/или последний адрес.

Имя	Тип	Описание
first	string	Первый адрес в подсети.
last	string	Последний адрес в подсети.
scope	integer (int32)	Размер блока (число ведущих битов в маске подсети).

EndpointStatus

Перечисление

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

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

EndpointType

Перечисление

Тип конечной точки диспетчера трафика.

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