Profiles - Update
Обновление профиля диспетчера трафика.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}?api-version=2022-04-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
profile
|
path | True |
string |
Имя профиля диспетчера трафика. |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
subscription
|
path | True |
string |
Возвращает учетные данные подписки, которые уникально идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы. |
api-version
|
query | True |
string |
Версия API клиента. |
Текст запроса
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} |
location |
string |
Регион Azure, в котором находится ресурс |
name |
string |
Имя ресурса. |
properties.allowedEndpointRecordTypes |
Список разрешенных типов записей конечной точки. |
|
properties.dnsConfig |
Параметры DNS профиля диспетчера трафика. |
|
properties.endpoints |
Endpoint[] |
Список конечных точек в профиле диспетчера трафика. |
properties.maxReturn |
integer |
Максимальное количество конечных точек, возвращаемых для типа маршрутизации MultiValue. |
properties.monitorConfig |
Параметры мониторинга конечной точки профиля диспетчера трафика. |
|
properties.profileStatus |
Состояние профиля диспетчера трафика. |
|
properties.trafficRoutingMethod |
Метод маршрутизации трафика профиля диспетчера трафика. |
|
properties.trafficViewEnrollmentStatus |
Указывает, является ли представление трафика включенным или отключенным для профиля диспетчера трафика. Null, означает "Отключено". Включение этой функции приведет к увеличению стоимости профиля управления трафиком. |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. Например, Microsoft.Network/trafficManagerProfiles. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Обновленный профиль диспетчера трафика. |
|
Other Status Codes |
Ответ по умолчанию. Он будет десериализоваться согласно определению Error. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Profile-PATCH-MonitorConfig
Образец запроса
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"
}
]
}
}
}
Пример ответа
{
"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"
}
}
]
}
}
Определения
Имя | Описание |
---|---|
Allowed |
Допустимые типы записей DNS для этого профиля. |
Always |
Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика. |
Cloud |
Ошибка, возвращенная Resource Manager Azure |
Cloud |
Содержимое ошибки, возвращаемой Resource Manager Azure |
Custom |
Список настраиваемых заголовков. |
Dns |
Класс, содержащий параметры DNS в профиле диспетчера трафика. |
Endpoint |
Класс, представляющий конечную точку диспетчера трафика. |
Endpoint |
Состояние мониторинга конечной точки. |
Endpoint |
Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика. |
Expected |
Список ожидаемых диапазонов кодов состояния. |
Monitor |
Класс, содержащий параметры мониторинга конечных точек в профиле диспетчера трафика. |
Monitor |
Протокол (HTTP, HTTPS или TCP), используемый для проверки работоспособности конечной точки. |
Profile |
Класс, представляющий профиль диспетчера трафика. |
Profile |
Состояние мониторинга на уровне профиля диспетчера трафика. |
Profile |
Состояние профиля диспетчера трафика. |
Subnets |
Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками. |
Traffic |
Метод маршрутизации трафика профиля диспетчера трафика. |
Traffic |
Указывает, является ли представление трафика включенным или отключенным для профиля диспетчера трафика. Null, означает "Отключено". Включение этой функции приведет к увеличению стоимости профиля управления трафиком. |
AllowedEndpointRecordType
Допустимые типы записей DNS для этого профиля.
Имя | Тип | Описание |
---|---|---|
Any |
string |
|
DomainName |
string |
|
IPv4Address |
string |
|
IPv6Address |
string |
AlwaysServe
Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика.
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |
CloudError
Ошибка, возвращенная Resource Manager Azure
Имя | Тип | Описание |
---|---|---|
error |
Содержимое ошибки. |
CloudErrorBody
Содержимое ошибки, возвращаемой Resource Manager Azure
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки |
details |
Сведения об ошибке |
|
message |
string |
Сообщение об ошибке |
target |
string |
Целевой объект ошибки |
CustomHeaders
Список настраиваемых заголовков.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя заголовка. |
value |
string |
Значение заголовка. |
DnsConfig
Класс, содержащий параметры DNS в профиле диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
fqdn |
string |
Полное доменное имя (FQDN) профиля диспетчера трафика. Он формируется из объединения RelativeName с доменом DNS, используемым диспетчером трафика Azure. |
relativeName |
string |
Относительное DNS-имя, предоставленное этим профилем диспетчера трафика. Это значение объединяется с DNS-именем домена, с помощью которого диспетчер трафика Azure формирует полное доменное имя профиля. |
ttl |
integer |
Срок жизни DNS (TTL), в секундах. Это сообщает локальным сопоставителям DNS и DNS-клиентам, как долго кэшировать ответы DNS, предоставляемые этим профилем диспетчера трафика. |
Endpoint
Класс, представляющий конечную точку диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} |
name |
string |
Имя ресурса. |
properties.alwaysServe |
Если включен параметр Always Serve, проверка работоспособности конечной точки будет отключена, а конечные точки будут включены в метод маршрутизации трафика. |
|
properties.customHeaders |
Список настраиваемых заголовков. |
|
properties.endpointLocation |
string |
Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика "Производительность". |
properties.endpointMonitorStatus |
Состояние мониторинга конечной точки. |
|
properties.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 |
Приоритет этой конечной точки при использовании метода маршрутизации трафика "Приоритет". Возможные значения — от 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 |
Тип ресурса. Например, Microsoft.Network/trafficManagerProfiles. |
EndpointMonitorStatus
Состояние мониторинга конечной точки.
Имя | Тип | Описание |
---|---|---|
CheckingEndpoint |
string |
|
Degraded |
string |
|
Disabled |
string |
|
Inactive |
string |
|
Online |
string |
|
Stopped |
string |
|
Unmonitored |
string |
EndpointStatus
Состояние конечной точки. Если конечная точка включена, то она проверяется на работоспособность и включается в метод маршрутизации трафика.
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |
ExpectedStatusCodeRanges
Список ожидаемых диапазонов кодов состояния.
Имя | Тип | Описание |
---|---|---|
max |
integer |
Максимальный код состояния. |
min |
integer |
Минимальный код состояния. |
MonitorConfig
Класс, содержащий параметры мониторинга конечных точек в профиле диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
customHeaders |
Список настраиваемых заголовков. |
|
expectedStatusCodeRanges |
Список ожидаемых диапазонов кодов состояния. |
|
intervalInSeconds |
integer |
Интервал монитора для конечных точек в этом профиле. Это интервал, через который диспетчер трафика будет проверка работоспособность каждой конечной точки в этом профиле. |
path |
string |
Путь относительно имени домена конечной точки, используемого для проверки работоспособности конечной точки. |
port |
integer |
TCP-порт, используемый для проверки работоспособности конечной точки. |
profileMonitorStatus |
Состояние мониторинга на уровне профиля диспетчера трафика. |
|
protocol |
Протокол (HTTP, HTTPS или TCP), используемый для проверки работоспособности конечной точки. |
|
timeoutInSeconds |
integer |
Время ожидания монитора для конечных точек в этом профиле. Это время, когда диспетчер трафика разрешает конечным точкам в этом профиле реагировать на проверка работоспособности. |
toleratedNumberOfFailures |
integer |
Количество последовательных проверка работоспособности, допускаемых диспетчером трафика перед объявлением конечной точки в этом профиле пониженной после следующего сбоя работоспособности проверка. |
MonitorProtocol
Протокол (HTTP, HTTPS или TCP), используемый для проверки работоспособности конечной точки.
Имя | Тип | Описание |
---|---|---|
HTTP |
string |
|
HTTPS |
string |
|
TCP |
string |
Profile
Класс, представляющий профиль диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса для ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} |
location |
string |
Регион Azure, в котором находится ресурс |
name |
string |
Имя ресурса. |
properties.allowedEndpointRecordTypes |
Список разрешенных типов записей конечной точки. |
|
properties.dnsConfig |
Параметры DNS профиля диспетчера трафика. |
|
properties.endpoints |
Endpoint[] |
Список конечных точек в профиле диспетчера трафика. |
properties.maxReturn |
integer |
Максимальное количество конечных точек, возвращаемых для типа маршрутизации MultiValue. |
properties.monitorConfig |
Параметры мониторинга конечной точки профиля диспетчера трафика. |
|
properties.profileStatus |
Состояние профиля диспетчера трафика. |
|
properties.trafficRoutingMethod |
Метод маршрутизации трафика профиля диспетчера трафика. |
|
properties.trafficViewEnrollmentStatus |
Указывает, является ли представление трафика включенным или отключенным для профиля диспетчера трафика. Null, означает "Отключено". Включение этой функции приведет к увеличению стоимости профиля управления трафиком. |
|
tags |
object |
Теги ресурсов. |
type |
string |
Тип ресурса. Например, Microsoft.Network/trafficManagerProfiles. |
ProfileMonitorStatus
Состояние мониторинга на уровне профиля диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
CheckingEndpoints |
string |
|
Degraded |
string |
|
Disabled |
string |
|
Inactive |
string |
|
Online |
string |
ProfileStatus
Состояние профиля диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |
Subnets
Список подсетей, IP-адресов и (или) диапазонов адресов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика "Подсеть". Пустой список будет соответствовать всем диапазонам, не охватываемым другими конечными точками.
Имя | Тип | Описание |
---|---|---|
first |
string |
Первый адрес в подсети. |
last |
string |
Последний адрес в подсети. |
scope |
integer |
Размер блока (количество битов в начале в маске подсети). |
TrafficRoutingMethod
Метод маршрутизации трафика профиля диспетчера трафика.
Имя | Тип | Описание |
---|---|---|
Geographic |
string |
|
MultiValue |
string |
|
Performance |
string |
|
Priority |
string |
|
Subnet |
string |
|
Weighted |
string |
TrafficViewEnrollmentStatus
Указывает, является ли представление трафика включенным или отключенным для профиля диспетчера трафика. Null, означает "Отключено". Включение этой функции приведет к увеличению стоимости профиля управления трафиком.
Имя | Тип | Описание |
---|---|---|
Disabled |
string |
|
Enabled |
string |