Freigeben über

Profiles - List By Subscription

  • Referenz
Dienst:
Traffic Manager
API-Version:
2022-04-01

Listet alle Traffic Manager-Profile innerhalb eines Abonnements auf.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
 path True

string

Ruft Abonnementanmeldeinformationen ab, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version
 query True

string

Client-API-Version.

Antworten

Name Typ Beschreibung
200 OK

ProfileListResult

Die Liste der Traffic Manager-Profile.
Other Status Codes

CloudError

Standardantwort. Sie wird gemäß der Fehlerdefinition deserialisiert.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

ListBySubscription

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
{
  "value": [
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/azsmnet1719/providers/Microsoft.Network/trafficManagerProfiles/azsmnet5183",
      "name": "azsmnet5183",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "azsmnet4696",
          "fqdn": "azsmnet4696.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/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440",
      "name": "azuresdkfornetautoresttrafficmanager3440",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "azuresdkfornetautoresttrafficmanager3440",
          "fqdn": "azuresdkfornetautoresttrafficmanager3440.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/azuresdkfornetautoresttrafficmanager5168/providers/Microsoft.Network/trafficManagerProfiles/azuresdkfornetautoresttrafficmanager3440/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"
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819",
      "name": "onesdk8819",
      "type": "Microsoft.Network/trafficManagerProfiles",
      "location": "global",
      "tags": {},
      "properties": {
        "profileStatus": "Enabled",
        "trafficRoutingMethod": "Performance",
        "dnsConfig": {
          "relativeName": "onesdk7242",
          "fqdn": "onesdk7242.tmpreview.watmtest.azure-test.net",
          "ttl": 51
        },
        "monitorConfig": {
          "profileMonitorStatus": "Online",
          "protocol": "HTTPS",
          "port": 111,
          "path": "/testparent.asp",
          "intervalInSeconds": 30,
          "toleratedNumberOfFailures": 3,
          "timeoutInSeconds": 10
        },
        "endpoints": [
          {
            "id": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk8819/nestedEndpoints/MyNestedEndpoint",
            "name": "MyNestedEndpoint",
            "type": "Microsoft.Network/trafficManagerProfiles/nestedEndpoints",
            "properties": {
              "endpointStatus": "Enabled",
              "endpointMonitorStatus": "Stopped",
              "targetResourceId": "/subscriptions/{subscription-id}/resourceGroups/onesdk9785/providers/Microsoft.Network/trafficManagerProfiles/onesdk1792",
              "target": "onesdk4285.tmpreview.watmtest.azure-test.net",
              "weight": 1,
              "priority": 1,
              "endpointLocation": "West Europe",
              "minChildEndpoints": 1
            }
          }
        ]
      }
    }
  ]
}

Definitionen

Name Beschreibung
AllowedEndpointRecordType

Die zulässigen DNS-Eintragstypen für dieses Profil.
AlwaysServe

Wenn Always Serve aktiviert ist, wird die Ermittlung der Endpunktintegrität deaktiviert, und Endpunkte werden in die Datenverkehrsroutingmethode einbezogen.
CloudError

Ein Fehler, der vom Azure Resource Manager zurückgegeben wird
CloudErrorBody

Der Inhalt eines Fehlers, der vom Azure Resource Manager zurückgegeben wird
CustomHeaders

Liste der benutzerdefinierten Kopfzeilen.
DnsConfig

Klasse, die DNS-Einstellungen in einem Traffic Manager-Profil enthält.
Endpoint

Klasse, die einen Traffic Manager-Endpunkt darstellt.
EndpointMonitorStatus

Der Überwachungsstatus des Endpunkts.
EndpointStatus

Der Status des Endpunkts. Wenn der Endpunkt aktiviert ist, wird er auf die Endpunktintegrität untersucht und in der Datenverkehrsroutingmethode enthalten.
ExpectedStatusCodeRanges

Liste der erwarteten Statuscodebereiche.
MonitorConfig

Klasse, die Endpunktüberwachungseinstellungen in einem Traffic Manager-Profil enthält.
MonitorProtocol

Das Protokoll (HTTP, HTTPS oder TCP), das zum Überprüfen der Endpunktintegrität verwendet wird.
Profile

Klasse, die ein Traffic Manager-Profil darstellt.
ProfileListResult

Die Antwort auf den Datenverkehrs-Manager-Profilvorgang.
ProfileMonitorStatus

Der Überwachungsstatus auf Profilebene des Traffic Manager-Profils.
ProfileStatus

Der Status des Traffic Manager-Profils.
Subnets

Die Liste der Subnetze, IP-Adressen und/oder Adressbereiche, die diesem Endpunkt bei Verwendung der Routingmethode "Subnetz" zugeordnet sind. Eine leere Liste entspricht allen Bereichen, die nicht von anderen Endpunkten abgedeckt werden.
TrafficRoutingMethod

Die Datenverkehrsroutingmethode des Traffic Manager-Profils.
TrafficViewEnrollmentStatus

Gibt an, ob die Datenverkehrsansicht für das Datenverkehrs-Manager-Profil "Aktiviert" oder "Deaktiviert" ist. Null, gibt 'Disabled' an. Durch aktivieren dieses Feature werden die Kosten des Profils "Datenverkehrsverwaltung" erhöht.

AllowedEndpointRecordType

Enumeration

Die zulässigen DNS-Eintragstypen für dieses Profil.

Wert Beschreibung
Any
DomainName
IPv4Address
IPv6Address

AlwaysServe

Enumeration

Wenn Always Serve aktiviert ist, wird die Ermittlung der Endpunktintegrität deaktiviert, und Endpunkte werden in die Datenverkehrsroutingmethode einbezogen.

Wert Beschreibung
Disabled
Enabled

CloudError

Objekt

Ein Fehler, der vom Azure Resource Manager zurückgegeben wird

Name Typ Beschreibung
error

CloudErrorBody

Der Inhalt des Fehlers.

CloudErrorBody

Objekt

Der Inhalt eines Fehlers, der vom Azure Resource Manager zurückgegeben wird

Name Typ Beschreibung
code

string

Fehlercode
details

CloudErrorBody[]

Fehlerdetails
message

string

Fehlermeldung
target

string

Fehlerziel

CustomHeaders

Objekt

Liste der benutzerdefinierten Kopfzeilen.

Name Typ Beschreibung
name

string

Kopfzeilenname.
value

string

Headerwert.

DnsConfig

Objekt

Klasse, die DNS-Einstellungen in einem Traffic Manager-Profil enthält.

Name Typ Beschreibung
fqdn

string

Der vollqualifizierte Domänenname (FQDN) des Traffic Manager-Profils. Dies wird aus der Verkettung des RelativeName mit der DNS-Domäne gebildet, die von Azure Traffic Manager verwendet wird.
relativeName

string

Der relative DNS-Name, der von diesem Traffic Manager-Profil bereitgestellt wird. Dieser Wert wird mit dem DNS-Domänennamen kombiniert, der von Azure Traffic Manager verwendet wird, um den vollqualifizierten Domänennamen (Fully Qualified Domain Name, FQDN) des Profils zu bilden.
ttl

integer (int64)

Die DNS-Zeit-To-Live (TTL) in Sekunden. Dadurch werden die lokalen DNS-Resolver und DNS-Clients darüber informiert, wie lange dns-Antworten von diesem Traffic Manager-Profil zwischengespeichert werden sollen.

Endpoint

Objekt

Klasse, die einen Traffic Manager-Endpunkt darstellt.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
name

string

Der Name der Ressource
properties.alwaysServe

AlwaysServe

Wenn Always Serve aktiviert ist, wird die Ermittlung der Endpunktintegrität deaktiviert, und Endpunkte werden in die Datenverkehrsroutingmethode einbezogen.
properties.customHeaders

CustomHeaders[]

Liste der benutzerdefinierten Kopfzeilen.
properties.endpointLocation

string

Gibt den Speicherort der externen oder geschachtelten Endpunkte an, wenn die Datenverkehrsroutingmethode "Performance" verwendet wird.
properties.endpointMonitorStatus

EndpointMonitorStatus

Der Überwachungsstatus des Endpunkts.
properties.endpointStatus

EndpointStatus

Der Status des Endpunkts. Wenn der Endpunkt aktiviert ist, wird er auf die Endpunktintegrität untersucht und in der Datenverkehrsroutingmethode enthalten.
properties.geoMapping

string[]

Die Liste der Länder/Regionen, die diesem Endpunkt zugeordnet sind, wenn die Routingmethode "Geografischer Datenverkehr" verwendet wird. Eine vollständige Liste der akzeptierten Werte finden Sie in der Dokumentation "Traffic Manager Geographic".
properties.minChildEndpoints

integer (int64)

Die Mindestanzahl der Endpunkte, die im untergeordneten Profil verfügbar sein müssen, damit das übergeordnete Profil als verfügbar betrachtet werden kann. Gilt nur für den Endpunkt vom Typ 'NestedEndpoints'.
properties.minChildEndpointsIPv4

integer (int64)

Die Mindestanzahl der IPv4-Endpunkte (DNS-Eintragstyp A), die im untergeordneten Profil verfügbar sein müssen, damit das übergeordnete Profil als verfügbar betrachtet wird. Gilt nur für den Endpunkt vom Typ 'NestedEndpoints'.
properties.minChildEndpointsIPv6

integer (int64)

Die Mindestanzahl der IPv6-Endpunkte (DNS-Eintragstyp AAAA), die im untergeordneten Profil verfügbar sein müssen, damit das übergeordnete Profil als verfügbar betrachtet werden kann. Gilt nur für den Endpunkt vom Typ 'NestedEndpoints'.
properties.priority

integer (int64)

Die Priorität dieses Endpunkts bei Verwendung der Datenverkehrsroutingmethode "Priorität". Mögliche Werte liegen zwischen 1 und 1000, niedrigere Werte stellen eine höhere Priorität dar. Dies ist ein optionaler Parameter. Wenn angegeben, muss sie auf allen Endpunkten angegeben werden, und keine zwei Endpunkte können denselben Prioritätswert gemeinsam nutzen.
properties.subnets

Subnets[]

Die Liste der Subnetze, IP-Adressen und/oder Adressbereiche, die diesem Endpunkt bei Verwendung der Routingmethode "Subnetz" zugeordnet sind. Eine leere Liste entspricht allen Bereichen, die nicht von anderen Endpunkten abgedeckt werden.
properties.target

string

Der vollqualifizierte DNS-Name oder die IP-Adresse des Endpunkts. Der Datenverkehrs-Manager gibt diesen Wert in DNS-Antworten zurück, um den Datenverkehr an diesen Endpunkt zu leiten.
properties.targetResourceId

string

Der Azure-Ressourcen-URI des Endpunkts. Gilt nicht für Endpunkte vom Typ "ExternalEndpoints".
properties.weight

integer (int64)

Die Gewichtung dieses Endpunkts bei Verwendung der "Weighted"-Datenverkehrsroutingmethode. Mögliche Werte liegen zwischen 1 und 1000.
type

string

Der Typ der Ressource. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Enumeration

Der Überwachungsstatus des Endpunkts.

Wert Beschreibung
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Enumeration

Der Status des Endpunkts. Wenn der Endpunkt aktiviert ist, wird er auf die Endpunktintegrität untersucht und in der Datenverkehrsroutingmethode enthalten.

Wert Beschreibung
Disabled
Enabled

ExpectedStatusCodeRanges

Objekt

Liste der erwarteten Statuscodebereiche.

Name Typ Beschreibung
max

integer

Maximaler Statuscode.
min

integer

Min-Statuscode.

MonitorConfig

Objekt

Klasse, die Endpunktüberwachungseinstellungen in einem Traffic Manager-Profil enthält.

Name Typ Beschreibung
customHeaders

CustomHeaders[]

Liste der benutzerdefinierten Kopfzeilen.
expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Liste der erwarteten Statuscodebereiche.
intervalInSeconds

integer (int64)

Das Überwachungsintervall für Endpunkte in diesem Profil. Dies ist das Intervall, in dem der Datenverkehrs-Manager die Integrität jedes Endpunkts in diesem Profil überprüft.
path

string

Der Pfad relativ zum Endpunktdomänennamen, der zum Überprüfen der Endpunktintegrität verwendet wird.
port

integer (int64)

Der TCP-Port, der verwendet wird, um die Endpunktintegrität zu untersuchen.
profileMonitorStatus

ProfileMonitorStatus

Der Überwachungsstatus auf Profilebene des Traffic Manager-Profils.
protocol

MonitorProtocol

Das Protokoll (HTTP, HTTPS oder TCP), das zum Überprüfen der Endpunktintegrität verwendet wird.
timeoutInSeconds

integer (int64)

Das Monitortimeout für Endpunkte in diesem Profil. Dies ist die Zeit, zu der Traffic Manager Endpunkte in diesem Profil erlaubt, auf die Integritätsprüfung zu reagieren.
toleratedNumberOfFailures

integer (int64)

Die Anzahl der aufeinanderfolgenden fehlerhaften Integritätsprüfung, die Traffic Manager toleriert, bevor ein Endpunkt in diesem Profil nach der nächsten fehlerhaften Integritätsprüfung deklariert wird.

MonitorProtocol

Enumeration

Das Protokoll (HTTP, HTTPS oder TCP), das zum Überprüfen der Endpunktintegrität verwendet wird.

Wert Beschreibung
HTTP
HTTPS
TCP

Profile

Objekt

Klasse, die ein Traffic Manager-Profil darstellt.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
location

string

Die Azure-Region, in der sich die Ressource befindet
name

string

Der Name der Ressource
properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

Die Liste der zulässigen Endpunktdatensatztypen.
properties.dnsConfig

DnsConfig

Die DNS-Einstellungen des Traffic Manager-Profils.
properties.endpoints

Endpoint[]

Die Liste der Endpunkte im Traffic Manager-Profil.
properties.maxReturn

integer (int64)

Maximale Anzahl von Endpunkten, die für den MultiValue-Routingtyp zurückgegeben werden sollen.
properties.monitorConfig

MonitorConfig

Die Endpunktüberwachungseinstellungen des Traffic Manager-Profils.
properties.profileStatus

ProfileStatus

Der Status des Traffic Manager-Profils.
properties.trafficRoutingMethod

TrafficRoutingMethod

Die Datenverkehrsroutingmethode des Traffic Manager-Profils.
properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Gibt an, ob die Datenverkehrsansicht für das Datenverkehrs-Manager-Profil "Aktiviert" oder "Deaktiviert" ist. Null, gibt 'Disabled' an. Durch aktivieren dieses Feature werden die Kosten des Profils "Datenverkehrsverwaltung" erhöht.
tags

object

Ressourcentags.
type

string

Der Typ der Ressource. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileListResult

Objekt

Die Antwort auf den Datenverkehrs-Manager-Profilvorgang.

Name Typ Beschreibung
value

Profile[]

Ruft die Liste der Traffic-Manager-Profile ab.

ProfileMonitorStatus

Enumeration

Der Überwachungsstatus auf Profilebene des Traffic Manager-Profils.

Wert Beschreibung
CheckingEndpoints
Degraded
Disabled
Inactive
Online

ProfileStatus

Enumeration

Der Status des Traffic Manager-Profils.

Wert Beschreibung
Disabled
Enabled

Subnets

Objekt

Die Liste der Subnetze, IP-Adressen und/oder Adressbereiche, die diesem Endpunkt bei Verwendung der Routingmethode "Subnetz" zugeordnet sind. Eine leere Liste entspricht allen Bereichen, die nicht von anderen Endpunkten abgedeckt werden.

Name Typ Beschreibung
first

string

Erste Adresse im Subnetz.
last

string

Letzte Adresse im Subnetz.
scope

integer

Blockgröße (Anzahl der führenden Bits in der Subnetzmaske).

TrafficRoutingMethod

Enumeration

Die Datenverkehrsroutingmethode des Traffic Manager-Profils.

Wert Beschreibung
Geographic
MultiValue
Performance
Priority
Subnet
Weighted

TrafficViewEnrollmentStatus

Enumeration

Gibt an, ob die Datenverkehrsansicht für das Datenverkehrs-Manager-Profil "Aktiviert" oder "Deaktiviert" ist. Null, gibt 'Disabled' an. Durch aktivieren dieses Feature werden die Kosten des Profils "Datenverkehrsverwaltung" erhöht.

Wert Beschreibung
Disabled
Enabled