Partager via

Profiles - List By Resource Group

  • Référence
Service:
Traffic Manager
Version d'API:
2022-04-01

Répertorie tous les profils Traffic Manager au sein d’un groupe de ressources.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId
 path True

string

Obtient les informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version
 query True

string

Version de l’API cliente.

Réponses

Nom Type Description
200 OK

ProfileListResult

Liste des profils Traffic Manager.
Other Status Codes

CloudError

Réponse par défaut. Elle sera désérialisée conformément à la définition d’erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ListProfilesByResourceGroup

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005",
      "name": "azuresdkfornetautoresttrafficmanager1005",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "azuresdkfornetautoresttrafficmanager1005",
          "fqdn": "azuresdkfornetautoresttrafficmanager1005.tmpreview.watmtest.azure-test.net",
          "ttl": 35
        },
        "monitorConfig": {
          "profileMonitorStatus": "Online",
          "protocol": "HTTP",
          "port": 80,
          "path": "/testpath.aspx",
          "intervalInSeconds": 30,
          "toleratedNumberOfFailures": 3,
          "timeoutInSeconds": 10
        },
        "endpoints": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager1005/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"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959",
      "name": "azuresdkfornetautoresttrafficmanager959",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "azuresdkfornetautoresttrafficmanager959",
          "fqdn": "azuresdkfornetautoresttrafficmanager959.tmpreview.watmtest.azure-test.net",
          "ttl": 35
        },
        "monitorConfig": {
          "profileMonitorStatus": "Online",
          "protocol": "HTTP",
          "port": 80,
          "path": "/testpath.aspx",
          "intervalInSeconds": 30,
          "toleratedNumberOfFailures": 3,
          "timeoutInSeconds": 10
        },
        "endpoints": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/azuresdkfornetautoresttrafficmanager3640/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager959/externalEndpoints/My external endpoint",
            "name": "My external endpoint",
            "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints",
            "properties": {
              "endpointStatus": "Enabled",
              "endpointMonitorStatus": "Online",
              "target": "foobar.contoso.com",
              "weight": 1,
              "priority": 1,
              "endpointLocation": "North Europe"
            }
          }
        ]
      }
    }
  ]
}

Définitions

Nom Description
AllowedEndpointRecordType

Types d’enregistrements DNS de type autorisé pour ce profil.
AlwaysServe

Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.
CloudError

Erreur retournée par Azure Resource Manager
CloudErrorBody

Contenu d’une erreur retournée par Azure Resource Manager
CustomHeaders

Liste des en-têtes personnalisés.
DnsConfig

Classe contenant des paramètres DNS dans un profil Traffic Manager.
Endpoint

Classe représentant un point de terminaison Traffic Manager.
EndpointMonitorStatus

État de surveillance du point de terminaison.
EndpointStatus

État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.
ExpectedStatusCodeRanges

Liste des plages de code d’état attendues.
MonitorConfig

Classe contenant les paramètres de surveillance des points de terminaison dans un profil Traffic Manager.
MonitorProtocol

Protocole (HTTP, HTTPS ou TCP) utilisé pour détecter l’intégrité du point de terminaison.
Profile

Classe représentant un profil Traffic Manager.
ProfileListResult

Lister la réponse de l’opération de profils Traffic Manager.
ProfileMonitorStatus

État de surveillance au niveau du profil de Traffic Manager.
ProfileStatus

État du profil Traffic Manager.
Subnets

Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.
TrafficRoutingMethod

Méthode de routage du trafic du profil Traffic Manager.
TrafficViewEnrollmentStatus

Indique si l’affichage du trafic est « Activé » ou « Désactivé » pour le profil Traffic Manager. Null, indique « Disabled ». L’activation de cette fonctionnalité augmente le coût du profil Traffic Manage.

AllowedEndpointRecordType

Énumération

Types d’enregistrements DNS de type autorisé pour ce profil.

Valeur Description
Any
DomainName
IPv4Address
IPv6Address

AlwaysServe

Énumération

Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.

Valeur Description
Disabled
Enabled

CloudError

Object

Erreur retournée par Azure Resource Manager

Nom Type Description
error

CloudErrorBody

Contenu de l’erreur.

CloudErrorBody

Object

Contenu d’une erreur retournée par Azure Resource Manager

Nom Type Description
code

string

Code d’erreur
details

CloudErrorBody[]

Détails de l’erreur
message

string

Message d'erreur
target

string

Cible d’erreur

CustomHeaders

Object

Liste des en-têtes personnalisés.

Nom Type Description
name

string

Nom de l’en-tête.
value

string

Valeur d’en-tête.

DnsConfig

Object

Classe contenant des paramètres DNS dans un profil Traffic Manager.

Nom Type Description
fqdn

string

Nom de domaine complet (FQDN) du profil Traffic Manager. Il s’agit de la concaténation du nom Relatif avec le domaine DNS utilisé par Azure Traffic Manager.
relativeName

string

Nom DNS relatif fourni par ce profil Traffic Manager. Cette valeur est combinée avec le nom de domaine DNS utilisé par Azure Traffic Manager pour former le nom de domaine complet (FQDN) du profil.
ttl

integer (int64)

Durée de vie DNS -To-Live (TTL), en secondes. Cela informe les résolveurs DNS locaux et les clients DNS pendant combien de temps mettre en cache les réponses DNS fournies par ce profil Traffic Manager.

Endpoint

Object

Classe représentant un point de terminaison Traffic Manager.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name

string

Nom de la ressource
properties.alwaysServe

AlwaysServe

Si Always Serve est activé, la détection de l’intégrité des points de terminaison est désactivée et les points de terminaison sont inclus dans la méthode de routage du trafic.
properties.customHeaders

CustomHeaders[]

Liste des en-têtes personnalisés.
properties.endpointLocation

string

Spécifie l’emplacement des points de terminaison externes ou imbriqués lors de l’utilisation de la méthode de routage du trafic « Performance ».
properties.endpointMonitorStatus

EndpointMonitorStatus

État de surveillance du point de terminaison.
properties.endpointStatus

EndpointStatus

État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.
properties.geoMapping

string[]

Liste des pays/régions mappés à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Géographique ». Consultez la documentation géographique de Traffic Manager pour obtenir la liste complète des valeurs acceptées.
properties.minChildEndpoints

integer (int64)

Nombre minimal de points de terminaison qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.minChildEndpointsIPv4

integer (int64)

Nombre minimal de points de terminaison IPv4 (type d’enregistrement DNS A) qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.minChildEndpointsIPv6

integer (int64)

Nombre minimal de points de terminaison IPv6 (type d’enregistrement DNS AAAA) qui doivent être disponibles dans le profil enfant afin que le profil parent soit considéré comme disponible. Applicable uniquement au point de terminaison de type « NestedEndpoints ».
properties.priority

integer (int64)

Priorité de ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Priorité ». Les valeurs possibles sont comprises entre 1 et 1 000, les valeurs inférieures représentent une priorité plus élevée. Il s’agit d’un paramètre facultatif. S’il est spécifié, il doit être spécifié sur tous les points de terminaison et aucun point de terminaison ne peut partager la même valeur de priorité.
properties.subnets

Subnets[]

Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.
properties.target

string

Nom DNS complet ou adresse IP du point de terminaison. Traffic Manager retourne cette valeur dans les réponses DNS pour diriger le trafic vers ce point de terminaison.
properties.targetResourceId

string

URI de ressource Azure du point de terminaison. Non applicable aux points de terminaison de type « ExternalEndpoints ».
properties.weight

integer (int64)

Poids de ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Weighted ». Les valeurs possibles sont comprises entre 1 et 1 000.
type

string

Type de la ressource. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Énumération

État de surveillance du point de terminaison.

Valeur Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Énumération

État du point de terminaison. Si le point de terminaison est activé, il est sondé pour l’intégrité du point de terminaison et est inclus dans la méthode de routage du trafic.

Valeur Description
Disabled
Enabled

ExpectedStatusCodeRanges

Object

Liste des plages de code d’état attendues.

Nom Type Description
max

integer

Code d’état maximal.
min

integer

Code d’état min.

MonitorConfig

Object

Classe contenant les paramètres de surveillance des points de terminaison dans un profil Traffic Manager.

Nom Type Description
customHeaders

CustomHeaders[]

Liste des en-têtes personnalisés.
expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Liste des plages de code d’état attendues.
intervalInSeconds

integer (int64)

Intervalle de surveillance pour les points de terminaison de ce profil. Il s’agit de l’intervalle auquel Traffic Manager vérifie l’intégrité de chaque point de terminaison dans ce profil.
path

string

Chemin d’accès relatif au nom de domaine de point de terminaison utilisé pour détecter l’intégrité du point de terminaison.
port

integer (int64)

Port TCP utilisé pour effectuer une sonde pour l’intégrité du point de terminaison.
profileMonitorStatus

ProfileMonitorStatus

État de surveillance au niveau du profil de Traffic Manager.
protocol

MonitorProtocol

Protocole (HTTP, HTTPS ou TCP) utilisé pour détecter l’intégrité du point de terminaison.
timeoutInSeconds

integer (int64)

Délai d’expiration du moniteur pour les points de terminaison de ce profil. Il s’agit du moment où Traffic Manager autorise les points de terminaison de ce profil à répondre au contrôle d’intégrité.
toleratedNumberOfFailures

integer (int64)

Nombre de vérifications d’intégrité ayant échoué consécutives que Traffic Manager tolère avant de déclarer un point de terminaison dans ce profil détérioré après le prochain échec de contrôle d’intégrité.

MonitorProtocol

Énumération

Protocole (HTTP, HTTPS ou TCP) utilisé pour détecter l’intégrité du point de terminaison.

Valeur Description
HTTP
HTTPS
TCP

Profile

Object

Classe représentant un profil Traffic Manager.

Nom Type Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
location

string

Région Azure où réside la ressource
name

string

Nom de la ressource
properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

Liste des types d’enregistrements de point de terminaison autorisés.
properties.dnsConfig

DnsConfig

Paramètres DNS du profil Traffic Manager.
properties.endpoints

Endpoint[]

Liste des points de terminaison dans le profil Traffic Manager.
properties.maxReturn

integer (int64)

Nombre maximal de points de terminaison à retourner pour le type de routage MultiValue.
properties.monitorConfig

MonitorConfig

Paramètres de surveillance des points de terminaison du profil Traffic Manager.
properties.profileStatus

ProfileStatus

État du profil Traffic Manager.
properties.trafficRoutingMethod

TrafficRoutingMethod

Méthode de routage du trafic du profil Traffic Manager.
properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indique si l’affichage du trafic est « Activé » ou « Désactivé » pour le profil Traffic Manager. Null, indique « Disabled ». L’activation de cette fonctionnalité augmente le coût du profil Traffic Manage.
tags

object

Balises de ressource.
type

string

Type de la ressource. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileListResult

Object

Lister la réponse de l’opération de profils Traffic Manager.

Nom Type Description
value

Profile[]

Obtient la liste des profils Traffic Manager.

ProfileMonitorStatus

Énumération

État de surveillance au niveau du profil de Traffic Manager.

Valeur Description
CheckingEndpoints
Degraded
Disabled
Inactive
Online

ProfileStatus

Énumération

État du profil Traffic Manager.

Valeur Description
Disabled
Enabled

Subnets

Object

Liste des sous-réseaux, adresses IP et/ou plages d’adresses mappées à ce point de terminaison lors de l’utilisation de la méthode de routage du trafic « Subnet ». Une liste vide correspond à toutes les plages non couvertes par d’autres points de terminaison.

Nom Type Description
first

string

Première adresse dans le sous-réseau.
last

string

Dernière adresse dans le sous-réseau.
scope

integer

Taille de bloc (nombre de bits de début dans le masque de sous-réseau).

TrafficRoutingMethod

Énumération

Méthode de routage du trafic du profil Traffic Manager.

Valeur Description
Geographic
MultiValue
Performance
Priority
Subnet
Weighted

TrafficViewEnrollmentStatus

Énumération

Indique si l’affichage du trafic est « Activé » ou « Désactivé » pour le profil Traffic Manager. Null, indique « Disabled ». L’activation de cette fonctionnalité augmente le coût du profil Traffic Manage.

Valeur Description
Disabled
Enabled