Sdílet prostřednictvím


Profiles - Get

Získá profil Traffic Manageru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
profileName
path True

string

Název profilu Traffic Manageru.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

subscriptionId
path True

string

Získá přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.

api-version
query True

string

Verze rozhraní API klienta.

Odpovědi

Name Typ Description
200 OK

Profile

Profil Traffic Manageru.

Other Status Codes

CloudError

Výchozí odpověď. Bude deserializován podle definice chyby.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Profile-GET-WithEndpoints

Ukázkový požadavek

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

Ukázková odpověď

{
  "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

Ukázkový požadavek

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

Ukázková odpověď

{
  "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

Ukázkový požadavek

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

Ukázková odpověď

{
  "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"
  }
}

Definice

Name Description
AllowedEndpointRecordType

Povolený typ záznamů DNS pro tento profil.

AlwaysServe

Pokud je služba Always Serve povolená, bude zjišťování stavu koncového bodu zakázané a koncové body budou zahrnuty do metody směrování provozu.

CloudError

Chyba vrácená Azure Resource Managerem

CloudErrorBody

Obsah chyby vrácené Azure Resource Managerem

CustomHeaders

Seznam vlastních hlaviček

DnsConfig

Třída obsahující nastavení DNS v profilu Traffic Manageru

Endpoint

Třída představující koncový bod Traffic Manageru

EndpointMonitorStatus

Stav monitorování koncového bodu.

EndpointStatus

Stav koncového bodu. Pokud je koncový bod povolený, probírá se stav koncového bodu a je součástí metody směrování provozu.

ExpectedStatusCodeRanges

Seznam očekávaných rozsahů stavových kódů

MonitorConfig

Třída obsahující nastavení monitorování koncových bodů v profilu Traffic Manageru

MonitorProtocol

Protokol (HTTP, HTTPS nebo TCP) použitý k testování stavu koncového bodu.

Profile

Třída představující profil Traffic Manageru

ProfileMonitorStatus

Stav monitorování na úrovni profilu služby Traffic Manager.

ProfileStatus

Stav profilu Traffic Manageru

Subnets

Seznam podsítí, IP adres a rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Podsíť. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrýval.

TrafficRoutingMethod

Metoda směrování provozu profilu Traffic Manageru.

TrafficViewEnrollmentStatus

Určuje, jestli je zobrazení provozu pro profil Traffic Manageru povoleno nebo Zakázáno. Null, označuje Zakázáno. Povolením této funkce se zvýší náklady na profil Správy provozu.

AllowedEndpointRecordType

Povolený typ záznamů DNS pro tento profil.

Hodnota Description
Any
DomainName
IPv4Address
IPv6Address

AlwaysServe

Pokud je služba Always Serve povolená, bude zjišťování stavu koncového bodu zakázané a koncové body budou zahrnuty do metody směrování provozu.

Hodnota Description
Disabled
Enabled

CloudError

Chyba vrácená Azure Resource Managerem

Name Typ Description
error

CloudErrorBody

Obsah chyby.

CloudErrorBody

Obsah chyby vrácené Azure Resource Managerem

Name Typ Description
code

string

Kód chyby

details

CloudErrorBody[]

Podrobnosti o chybě

message

string

Zpráva o chybě

target

string

Cíl chyby

CustomHeaders

Seznam vlastních hlaviček

Name Typ Description
name

string

Název záhlaví

value

string

Hodnota záhlaví.

DnsConfig

Třída obsahující nastavení DNS v profilu Traffic Manageru

Name Typ Description
fqdn

string

Plně kvalifikovaný název domény (FQDN) profilu Traffic Manageru. Vytvoří se zřetězení relativního názvu s doménou DNS, kterou používá Azure Traffic Manager.

relativeName

string

Relativní název DNS zadaný tímto profilem Traffic Manageru. Tato hodnota se zkombinuje s názvem domény DNS, který používá Azure Traffic Manager k vytvoření plně kvalifikovaného názvu domény (FQDN) profilu.

ttl

integer (int64)

Hodnota TTL (Time-To-Live DNS) v sekundách. To informuje místní překladače DNS a klienty DNS, jak dlouho ukládat odpovědi DNS poskytnuté tímto profilem Traffic Manageru.

Endpoint

Třída představující koncový bod Traffic Manageru

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

Název prostředku

properties.alwaysServe

AlwaysServe

Pokud je služba Always Serve povolená, bude zjišťování stavu koncového bodu zakázané a koncové body budou zahrnuty do metody směrování provozu.

properties.customHeaders

CustomHeaders[]

Seznam vlastních hlaviček

properties.endpointLocation

string

Určuje umístění externích nebo vnořených koncových bodů při použití metody směrování provozu Výkon.

properties.endpointMonitorStatus

EndpointMonitorStatus

Stav monitorování koncového bodu.

properties.endpointStatus

EndpointStatus

Stav koncového bodu. Pokud je koncový bod povolený, probírá se stav koncového bodu a je součástí metody směrování provozu.

properties.geoMapping

string[]

Seznam zemí nebo oblastí mapovaných na tento koncový bod při použití metody směrování provozu "Geografická" Úplný seznam přijatých hodnot najdete v dokumentaci ke službě Traffic Manager Geographic.

properties.minChildEndpoints

integer (int64)

Minimální počet koncových bodů, které musí být k dispozici v podřízeného profilu, aby byl nadřazený profil považován za dostupný. Platí pouze pro koncový bod typu NestedEndpoints.

properties.minChildEndpointsIPv4

integer (int64)

Minimální počet koncových bodů IPv4 (typ záznamu DNS A), které musí být k dispozici v podřízeného profilu, aby byl nadřazený profil považován za dostupný. Platí pouze pro koncový bod typu NestedEndpoints.

properties.minChildEndpointsIPv6

integer (int64)

Minimální počet koncových bodů IPv6 (typ záznamu DNS AAAA), které musí být k dispozici v podřízeného profilu, aby byl nadřazený profil považován za dostupný. Platí pouze pro koncový bod typu NestedEndpoints.

properties.priority

integer (int64)

Priorita tohoto koncového bodu při použití metody směrování provozu Priority Možné hodnoty jsou od 1 do 1000, nižší hodnoty představují vyšší prioritu. Jedná se o volitelný parametr. Pokud je zadaný, musí být zadán ve všech koncových bodech a žádné dva koncové body nemůžou sdílet stejnou hodnotu priority.

properties.subnets

Subnets[]

Seznam podsítí, IP adres a rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Podsíť. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrýval.

properties.target

string

Plně kvalifikovaný název DNS nebo IP adresa koncového bodu. Traffic Manager vrátí tuto hodnotu v odpovědích DNS pro směrování provozu do tohoto koncového bodu.

properties.targetResourceId

string

Identifikátor URI prostředku Azure koncového bodu. Neplatí pro koncové body typu ExternalEndpoints.

properties.weight

integer (int64)

Váha tohoto koncového bodu při použití metody směrování provozu váženého provozu. Možné hodnoty jsou od 1 do 1000.

type

string

Typ prostředku. Např. Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Stav monitorování koncového bodu.

Hodnota Description
CheckingEndpoint
Degraded
Disabled
Inactive
Online
Stopped
Unmonitored

EndpointStatus

Stav koncového bodu. Pokud je koncový bod povolený, probírá se stav koncového bodu a je součástí metody směrování provozu.

Hodnota Description
Disabled
Enabled

ExpectedStatusCodeRanges

Seznam očekávaných rozsahů stavových kódů

Name Typ Description
max

integer

Maximální stavový kód.

min

integer

Minimální stavový kód.

MonitorConfig

Třída obsahující nastavení monitorování koncových bodů v profilu Traffic Manageru

Name Typ Description
customHeaders

CustomHeaders[]

Seznam vlastních hlaviček

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Seznam očekávaných rozsahů stavových kódů

intervalInSeconds

integer (int64)

Interval monitorování pro koncové body v tomto profilu. Toto je interval, ve kterém Traffic Manager zkontroluje stav každého koncového bodu v tomto profilu.

path

string

Cesta vzhledem k názvu domény koncového bodu, která se používá k sondování stavu koncového bodu.

port

integer (int64)

Port TCP použitý k sondování stavu koncového bodu.

profileMonitorStatus

ProfileMonitorStatus

Stav monitorování na úrovni profilu služby Traffic Manager.

protocol

MonitorProtocol

Protokol (HTTP, HTTPS nebo TCP) použitý k testování stavu koncového bodu.

timeoutInSeconds

integer (int64)

Časový limit monitorování pro koncové body v tomto profilu To je čas, kdy Traffic Manager umožňuje koncovým bodům v tomto profilu reagovat na kontrolu stavu.

toleratedNumberOfFailures

integer (int64)

Počet po sobě jdoucích neúspěšných kontrol stavu, že Traffic Manager toleruje před deklarováním koncového bodu v tomto profilu degradovaný po další neúspěšné kontrole stavu.

MonitorProtocol

Protokol (HTTP, HTTPS nebo TCP) použitý k testování stavu koncového bodu.

Hodnota Description
HTTP
HTTPS
TCP

Profile

Třída představující profil Traffic Manageru

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

location

string

Oblast Azure, ve které se prostředek nachází

name

string

Název prostředku

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

Seznam povolených typů záznamů koncových bodů

properties.dnsConfig

DnsConfig

Nastavení DNS profilu Traffic Manageru.

properties.endpoints

Endpoint[]

Seznam koncových bodů v profilu Traffic Manageru

properties.maxReturn

integer (int64)

Maximální počet koncových bodů, které se mají vrátit pro typ směrování MultiValue.

properties.monitorConfig

MonitorConfig

Nastavení monitorování koncového bodu profilu Traffic Manageru.

properties.profileStatus

ProfileStatus

Stav profilu Traffic Manageru

properties.trafficRoutingMethod

TrafficRoutingMethod

Metoda směrování provozu profilu Traffic Manageru.

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Určuje, jestli je zobrazení provozu pro profil Traffic Manageru povoleno nebo Zakázáno. Null, označuje Zakázáno. Povolením této funkce se zvýší náklady na profil Správy provozu.

tags

object

Značky prostředků

type

string

Typ prostředku. Např. Microsoft.Network/trafficManagerProfiles.

ProfileMonitorStatus

Stav monitorování na úrovni profilu služby Traffic Manager.

Hodnota Description
CheckingEndpoints
Degraded
Disabled
Inactive
Online

ProfileStatus

Stav profilu Traffic Manageru

Hodnota Description
Disabled
Enabled

Subnets

Seznam podsítí, IP adres a rozsahů adres mapovaných na tento koncový bod při použití metody směrování provozu Podsíť. Prázdný seznam bude odpovídat všem rozsahům, které ostatní koncové body nepokrýval.

Name Typ Description
first

string

První adresa v podsíti.

last

string

Poslední adresa v podsíti

scope

integer

Velikost bloku (počet počátečních bitů v masce podsítě)

TrafficRoutingMethod

Metoda směrování provozu profilu Traffic Manageru.

Hodnota Description
Geographic
MultiValue
Performance
Priority
Subnet
Weighted

TrafficViewEnrollmentStatus

Určuje, jestli je zobrazení provozu pro profil Traffic Manageru povoleno nebo Zakázáno. Null, označuje Zakázáno. Povolením této funkce se zvýší náklady na profil Správy provozu.

Hodnota Description
Disabled
Enabled