Compartir a través de


Profiles - Get

Obtiene un perfil de Traffic Manager.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
profileName
path True

string

Nombre del perfil de Traffic Manager.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

subscriptionId
path True

string

Obtiene las credenciales de suscripción que identifican de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.

api-version
query True

string

Versión de api de cliente.

Respuestas

Nombre Tipo Description
200 OK

Profile

Perfil de Traffic Manager.

Other Status Codes

CloudError

Respuesta predeterminada. Se deserializará según la definición de error.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

Profile-GET-WithEndpoints
Profile-GET-WithTrafficViewDisabled
Profile-GET-WithTrafficViewEnabled

Profile-GET-WithEndpoints

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880?api-version=2022-04-01

Respuesta de muestra

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880",
  "name": "azuresdkfornetautoresttrafficmanager3880",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager3880",
      "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 3,
      "timeoutInSeconds": 10
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/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"
        }
      }
    ]
  }
}

Profile-GET-WithTrafficViewDisabled

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880?api-version=2022-04-01

Respuesta de muestra

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880",
  "name": "azuresdkfornetautoresttrafficmanager3880",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager3880",
      "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 3,
      "timeoutInSeconds": 10
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/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"
        }
      }
    ],
    "trafficViewEnrollmentStatus": "Disabled"
  }
}

Profile-GET-WithTrafficViewEnabled

Solicitud de ejemplo

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficmanagerprofiles/azuresdkfornetautoresttrafficmanager3880?api-version=2022-04-01

Respuesta de muestra

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880",
  "name": "azuresdkfornetautoresttrafficmanager3880",
  "type": "Microsoft.Network/trafficManagerProfiles",
  "location": "global",
  "tags": {},
  "properties": {
    "profileStatus": "Enabled",
    "trafficRoutingMethod": "Performance",
    "dnsConfig": {
      "relativeName": "azuresdkfornetautoresttrafficmanager3880",
      "fqdn": "azuresdkfornetautoresttrafficmanager3880.tmpreview.watmtest.azure-test.net",
      "ttl": 35
    },
    "monitorConfig": {
      "profileMonitorStatus": "CheckingEndpoints",
      "protocol": "HTTP",
      "port": 80,
      "path": "/testpath.aspx",
      "intervalInSeconds": 30,
      "toleratedNumberOfFailures": 3,
      "timeoutInSeconds": 10
    },
    "endpoints": [
      {
        "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager1323/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3880/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"
        }
      }
    ],
    "trafficViewEnrollmentStatus": "Enabled"
  }
}

Definiciones

Nombre Description
AllowedEndpointRecordType

Tipo permitido Tipos de registro DNS para este perfil.

AlwaysServe

Si Always Serve está habilitado, el sondeo para el estado del punto de conexión se deshabilitará y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.

CloudError

Error devuelto por Azure Resource Manager

CloudErrorBody

El contenido de un error devuelto por Azure Resource Manager

CustomHeaders

Lista de encabezados personalizados.

DnsConfig

Clase que contiene la configuración de DNS en un perfil de Traffic Manager.

Endpoint

Clase que representa un punto de conexión de Traffic Manager.

EndpointMonitorStatus

Estado de supervisión del punto de conexión.

EndpointStatus

Estado del punto de conexión. Si el punto de conexión es Habilitado, se sondea para el estado del punto de conexión y se incluye en el método de enrutamiento del tráfico.

ExpectedStatusCodeRanges

Lista de intervalos de código de estado esperados.

MonitorConfig

Clase que contiene la configuración de supervisión de puntos de conexión en un perfil de Traffic Manager.

MonitorProtocol

Protocolo (HTTP, HTTPS o TCP) que se usa para sondear el estado del punto de conexión.

Profile

Clase que representa un perfil de Traffic Manager.

ProfileMonitorStatus

Estado de supervisión de nivel de perfil del perfil de Traffic Manager.

ProfileStatus

Estado del perfil de Traffic Manager.

Subnets

La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.

TrafficRoutingMethod

Método de enrutamiento de tráfico del perfil de Traffic Manager.

TrafficViewEnrollmentStatus

Indica si Traffic View es "Habilitado" o "Deshabilitado" para el perfil de Traffic Manager. Null, indica "Disabled". La habilitación de esta característica aumentará el costo del perfil de Administración del tráfico.

AllowedEndpointRecordType

Tipo permitido Tipos de registro DNS para este perfil.

Valor Description
Any
DomainName
IPv4Address
IPv6Address

AlwaysServe

Si Always Serve está habilitado, el sondeo para el estado del punto de conexión se deshabilitará y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.

Valor Description
Disabled
Enabled

CloudError

Error devuelto por Azure Resource Manager

Nombre Tipo Description
error

CloudErrorBody

Contenido del error.

CloudErrorBody

El contenido de un error devuelto por Azure Resource Manager

Nombre Tipo Description
code

string

Código de error

details

CloudErrorBody[]

Detalles del error

message

string

Mensaje de error

target

string

Destino de error

CustomHeaders

Lista de encabezados personalizados.

Nombre Tipo Description
name

string

Nombre del encabezado.

value

string

Valor de encabezado.

DnsConfig

Clase que contiene la configuración de DNS en un perfil de Traffic Manager.

Nombre Tipo Description
fqdn

string

Nombre de dominio completo (FQDN) del perfil de Traffic Manager. Esto se forma a partir de la concatenación de RelativeName con el dominio DNS que usa Azure Traffic Manager.

relativeName

string

Nombre DNS relativo proporcionado por este perfil de Traffic Manager. Este valor se combina con el nombre de dominio DNS que usa Azure Traffic Manager para formar el nombre de dominio completo (FQDN) del perfil.

ttl

integer (int64)

Tiempo dns:To-Live (TTL), en segundos. Esto informa a los solucionadores DNS locales y a los clientes DNS cuánto tiempo se almacenan en caché las respuestas DNS proporcionadas por este perfil de Traffic Manager.

Endpoint

Clase que representa un punto de conexión de Traffic Manager.

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

Nombre del recurso

properties.alwaysServe

AlwaysServe

Si Always Serve está habilitado, el sondeo para el estado del punto de conexión se deshabilitará y los puntos de conexión se incluirán en el método de enrutamiento del tráfico.

properties.customHeaders

CustomHeaders[]

Lista de encabezados personalizados.

properties.endpointLocation

string

Especifica la ubicación de los puntos de conexión externos o anidados cuando se usa el método de enrutamiento de tráfico "Rendimiento".

properties.endpointMonitorStatus

EndpointMonitorStatus

Estado de supervisión del punto de conexión.

properties.endpointStatus

EndpointStatus

Estado del punto de conexión. Si el punto de conexión es Habilitado, se sondea para el estado del punto de conexión y se incluye en el método de enrutamiento del tráfico.

properties.geoMapping

string[]

La lista de países o regiones asignados a este punto de conexión al usar el método de enrutamiento de tráfico "Geográfico". Consulte la documentación geográfica de Traffic Manager para obtener una lista completa de los valores aceptados.

properties.minChildEndpoints

integer (int64)

Número mínimo de puntos de conexión que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión del tipo "NestedEndpoints".

properties.minChildEndpointsIPv4

integer (int64)

Número mínimo de puntos de conexión IPv4 (tipo de registro DNS A) que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión del tipo "NestedEndpoints".

properties.minChildEndpointsIPv6

integer (int64)

Número mínimo de puntos de conexión IPv6 (AAAA de tipo de registro DNS) que deben estar disponibles en el perfil secundario para que el perfil primario se considere disponible. Solo se aplica al punto de conexión del tipo "NestedEndpoints".

properties.priority

integer (int64)

Prioridad de este punto de conexión cuando se usa el método de enrutamiento de tráfico "Prioridad". Los valores posibles son de 1 a 1000, los valores inferiores representan una prioridad más alta. Se trata de un parámetro opcional. Si se especifica, se debe especificar en todos los puntos de conexión y no se pueden compartir los dos puntos de conexión con el mismo valor de prioridad.

properties.subnets

Subnets[]

La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.

properties.target

string

Nombre DNS completo o dirección IP del punto de conexión. Traffic Manager devuelve este valor en las respuestas DNS para dirigir el tráfico a este punto de conexión.

properties.targetResourceId

string

Identificador URI del recurso de Azure del punto de conexión. No es aplicable a los puntos de conexión de tipo "ExternalEndpoints".

properties.weight

integer (int64)

Peso de este punto de conexión al usar el método de enrutamiento de tráfico "Ponderado". Los valores posibles son de 1 a 1000.

type

string

Tipo del recurso. Por ejemplo, Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Estado de supervisión del punto de conexión.

Valor Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Estado del punto de conexión. Si el punto de conexión es Habilitado, se sondea para el estado del punto de conexión y se incluye en el método de enrutamiento del tráfico.

Valor Description
Disabled
Enabled

ExpectedStatusCodeRanges

Lista de intervalos de código de estado esperados.

Nombre Tipo Description
max

integer

Código de estado máximo.

min

integer

Código de estado mínimo.

MonitorConfig

Clase que contiene la configuración de supervisión de puntos de conexión en un perfil de Traffic Manager.

Nombre Tipo Description
customHeaders

CustomHeaders[]

Lista de encabezados personalizados.

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Lista de intervalos de código de estado esperados.

intervalInSeconds

integer (int64)

Intervalo de supervisión de los puntos de conexión de este perfil. Este es el intervalo en el que Traffic Manager comprobará el estado de cada punto de conexión de este perfil.

path

string

Ruta de acceso relativa al nombre de dominio del punto de conexión que se usa para sondear el estado del punto de conexión.

port

integer (int64)

Puerto TCP que se usa para sondear el estado del punto de conexión.

profileMonitorStatus

ProfileMonitorStatus

Estado de supervisión de nivel de perfil del perfil de Traffic Manager.

protocol

MonitorProtocol

Protocolo (HTTP, HTTPS o TCP) que se usa para sondear el estado del punto de conexión.

timeoutInSeconds

integer (int64)

Tiempo de espera de supervisión para los puntos de conexión de este perfil. Este es el momento en que Traffic Manager permite a los puntos de conexión de este perfil responder a la comprobación de estado.

toleratedNumberOfFailures

integer (int64)

Número de comprobaciones de estado con errores consecutivas que Traffic Manager tolera antes de declarar un punto de conexión en este perfil degradado después de la siguiente comprobación de estado con errores.

MonitorProtocol

Protocolo (HTTP, HTTPS o TCP) que se usa para sondear el estado del punto de conexión.

Valor Description
HTTP
HTTPS
TCP

Profile

Clase que representa un perfil de Traffic Manager.

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

location

string

Región de Azure donde reside el recurso

name

string

Nombre del recurso

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

Lista de tipos de registro de punto de conexión permitidos.

properties.dnsConfig

DnsConfig

Configuración dns del perfil de Traffic Manager.

properties.endpoints

Endpoint[]

Lista de puntos de conexión en el perfil de Traffic Manager.

properties.maxReturn

integer (int64)

Número máximo de puntos de conexión que se van a devolver para el tipo de enrutamiento MultiValue.

properties.monitorConfig

MonitorConfig

Configuración de supervisión de puntos de conexión del perfil de Traffic Manager.

properties.profileStatus

ProfileStatus

Estado del perfil de Traffic Manager.

properties.trafficRoutingMethod

TrafficRoutingMethod

Método de enrutamiento de tráfico del perfil de Traffic Manager.

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indica si Traffic View es "Habilitado" o "Deshabilitado" para el perfil de Traffic Manager. Null, indica "Disabled". La habilitación de esta característica aumentará el costo del perfil de Administración del tráfico.

tags

object

Etiquetas de recursos.

type

string

Tipo del recurso. Por ejemplo, Microsoft.Network/trafficManagerProfiles.

ProfileMonitorStatus

Estado de supervisión de nivel de perfil del perfil de Traffic Manager.

Valor Description
CheckingEndpoints
Degraded
Disabled
Inactive
Online

ProfileStatus

Estado del perfil de Traffic Manager.

Valor Description
Disabled
Enabled

Subnets

La lista de subredes, direcciones IP o intervalos de direcciones asignados a este punto de conexión cuando se usa el método de enrutamiento de tráfico "Subred". Una lista vacía coincidirá con todos los intervalos no cubiertos por otros puntos de conexión.

Nombre Tipo Description
first

string

Primera dirección de la subred.

last

string

Última dirección de la subred.

scope

integer

Tamaño de bloque (número de bits iniciales en la máscara de subred).

TrafficRoutingMethod

Método de enrutamiento de tráfico del perfil de Traffic Manager.

Valor Description
Geographic
MultiValue
Performance
Priority
Subnet
Weighted

TrafficViewEnrollmentStatus

Indica si Traffic View es "Habilitado" o "Deshabilitado" para el perfil de Traffic Manager. Null, indica "Disabled". La habilitación de esta característica aumentará el costo del perfil de Administración del tráfico.

Valor Description
Disabled
Enabled