Condividi tramite


Profiles - Get

Ottiene un profilo di Gestione traffico.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
profileName
path True

string

Nome del profilo di Gestione traffico.

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

Ottiene le credenziali di sottoscrizione che consentono di identificare in modo univoco la sottoscrizione Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True

string

Versione api client.

Risposte

Nome Tipo Descrizione
200 OK

Profile

Profilo di Gestione traffico.

Other Status Codes

CloudError

Risposta predefinita. Verrà deserializzato in base alla definizione errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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

Profile-GET-WithEndpoints

Esempio di richiesta

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

Risposta di esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
AllowedEndpointRecordType

Tipi di record DNS consentiti per questo profilo.

AlwaysServe

Se Always Serve è abilitato, la verifica dell'integrità degli endpoint verrà disabilitata e gli endpoint verranno inclusi nel metodo di routing del traffico.

CloudError

Errore restituito dal Resource Manager di Azure

CloudErrorBody

Contenuto di un errore restituito dal Resource Manager di Azure

CustomHeaders

Elenco di intestazioni personalizzate.

DnsConfig

Classe contenente le impostazioni DNS in un profilo di Gestione traffico.

Endpoint

Classe che rappresenta un endpoint di Gestione traffico.

EndpointMonitorStatus

Stato di monitoraggio dell'endpoint.

EndpointStatus

Stato dell'endpoint. Se l'endpoint è impostato su Enabled, viene sottoposto a probe per verificarne l'integrità e incluso nel metodo di routing del traffico.

ExpectedStatusCodeRanges

Elenco degli intervalli di codice di stato previsti.

MonitorConfig

Classe contenente le impostazioni di monitoraggio degli endpoint in un profilo di Gestione traffico.

MonitorProtocol

Protocollo (HTTP, HTTPS o TCP) usato per eseguire il probe per l'integrità degli endpoint.

Profile

Classe che rappresenta un profilo di Gestione traffico.

ProfileMonitorStatus

Stato di monitoraggio a livello di profilo del profilo di Gestione traffico.

ProfileStatus

Stato del profilo di Gestione traffico.

Subnets

Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponde a tutti gli intervalli non coperti da altri endpoint.

TrafficRoutingMethod

Metodo di routing del traffico del profilo di Gestione traffico.

TrafficViewEnrollmentStatus

Indica se la visualizzazione traffico è "Abilitata" o "Disabilitata" per il profilo di Gestione traffico. Null, indica "Disabilitato". L'abilitazione di questa funzionalità aumenterà il costo del profilo Gestione traffico.

AllowedEndpointRecordType

Tipi di record DNS consentiti per questo profilo.

Nome Tipo Descrizione
Any

string

DomainName

string

IPv4Address

string

IPv6Address

string

AlwaysServe

Se Always Serve è abilitato, la verifica dell'integrità degli endpoint verrà disabilitata e gli endpoint verranno inclusi nel metodo di routing del traffico.

Nome Tipo Descrizione
Disabled

string

Enabled

string

CloudError

Errore restituito dal Resource Manager di Azure

Nome Tipo Descrizione
error

CloudErrorBody

Contenuto dell'errore.

CloudErrorBody

Contenuto di un errore restituito dal Resource Manager di Azure

Nome Tipo Descrizione
code

string

Codice di errore

details

CloudErrorBody[]

Dettagli errore

message

string

Messaggio di errore

target

string

Destinazione errore

CustomHeaders

Elenco di intestazioni personalizzate.

Nome Tipo Descrizione
name

string

Nome intestazione.

value

string

Valore dell'intestazione.

DnsConfig

Classe contenente le impostazioni DNS in un profilo di Gestione traffico.

Nome Tipo Descrizione
fqdn

string

Nome di dominio completo (FQDN) del profilo di Gestione traffico. Viene formato dalla concatenazione di RelativeName con il dominio DNS usato da Gestione traffico di Azure.

relativeName

string

Nome DNS relativo fornito da questo profilo di Gestione traffico. Questo valore viene combinato con il nome del dominio DNS utilizzato da Gestione traffico di Azure per formare il nome di dominio completo del profilo.

ttl

integer

Il time-to-live (TTL) DNS, in secondi. In questo modo vengono informati i resolver DNS locali e i client DNS per quanto tempo memorizzare nella cache le risposte DNS fornite da questo profilo di Gestione traffico.

Endpoint

Classe che rappresenta un endpoint di Gestione traffico.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

name

string

nome della risorsa.

properties.alwaysServe

AlwaysServe

Se Always Serve è abilitato, la verifica dell'integrità degli endpoint verrà disabilitata e gli endpoint verranno inclusi nel metodo di routing del traffico.

properties.customHeaders

CustomHeaders[]

Elenco di intestazioni personalizzate.

properties.endpointLocation

string

Specifica il percorso degli endpoint esterni o annidati quando si usa il metodo di routing del traffico "Prestazioni".

properties.endpointMonitorStatus

EndpointMonitorStatus

Stato di monitoraggio dell'endpoint.

properties.endpointStatus

EndpointStatus

Stato dell'endpoint. Se l'endpoint è impostato su Enabled, viene sottoposto a probe per verificarne l'integrità e incluso nel metodo di routing del traffico.

properties.geoMapping

string[]

Elenco di paesi/aree mappate a questo endpoint quando si usa il metodo di routing del traffico 'Geografico'. Per un elenco completo di valori accettati, consultare la documentazione geografica di Gestione traffico.

properties.minChildEndpoints

integer

Numero minimo di endpoint che devono essere disponibili nel profilo figlio affinché il profilo padre sia considerato disponibile. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.

properties.minChildEndpointsIPv4

integer

Numero minimo di endpoint IPv4 (tipo di record DNS A) che devono essere disponibili nel profilo figlio per poter considerare disponibile il profilo padre. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.

properties.minChildEndpointsIPv6

integer

Numero minimo di endpoint IPv6 (tipo di record DNS AAAA) che devono essere disponibili nel profilo figlio per poter considerare disponibile il profilo padre. Applicabile solo all'endpoint di tipo 'NestedEndpoints'.

properties.priority

integer

Priorità di questo endpoint quando si usa il metodo di routing del traffico "Priority". I valori possibili sono compresi tra 1 e 1000, i valori inferiori rappresentano una priorità superiore. Questo parametro è facoltativo. Se specificato, deve esserlo per tutti gli endpoint e due endpoint non possono condividere lo stesso valore di priorità.

properties.subnets

Subnets[]

Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponde a tutti gli intervalli non coperti da altri endpoint.

properties.target

string

Nome DNS completo o indirizzo IP dell'endpoint. Gestione traffico restituisce questo valore nelle risposte DNS per indirizzare il traffico a questo endpoint.

properties.targetResourceId

string

URI risorsa di Azure dell'endpoint. Non applicabile agli endpoint di tipo 'ExternalEndpoints'.

properties.weight

integer

Peso di questo endpoint quando si usa il metodo di routing del traffico "Ponderato". I valori possibili sono compresi tra 1 e 1000.

type

string

Tipo di risorsa. Ex- Microsoft.Network/trafficManagerProfiles.

EndpointMonitorStatus

Stato di monitoraggio dell'endpoint.

Nome Tipo Descrizione
CheckingEndpoint

string

Degraded

string

Disabled

string

Inactive

string

Online

string

Stopped

string

Unmonitored

string

EndpointStatus

Stato dell'endpoint. Se l'endpoint è impostato su Enabled, viene sottoposto a probe per verificarne l'integrità e incluso nel metodo di routing del traffico.

Nome Tipo Descrizione
Disabled

string

Enabled

string

ExpectedStatusCodeRanges

Elenco degli intervalli di codice di stato previsti.

Nome Tipo Descrizione
max

integer

Numero massimo di codice di stato.

min

integer

Codice di stato minimo.

MonitorConfig

Classe contenente le impostazioni di monitoraggio degli endpoint in un profilo di Gestione traffico.

Nome Tipo Descrizione
customHeaders

CustomHeaders[]

Elenco di intestazioni personalizzate.

expectedStatusCodeRanges

ExpectedStatusCodeRanges[]

Elenco degli intervalli di codice di stato previsti.

intervalInSeconds

integer

Intervallo di monitoraggio per gli endpoint in questo profilo. Questo è l'intervallo in cui Gestione traffico verificherà l'integrità di ogni endpoint in questo profilo.

path

string

Percorso relativo al nome di dominio dell'endpoint usato per eseguire il probe per l'integrità dell'endpoint.

port

integer

Porta TCP usata per eseguire il probe per l'integrità degli endpoint.

profileMonitorStatus

ProfileMonitorStatus

Stato di monitoraggio a livello di profilo del profilo di Gestione traffico.

protocol

MonitorProtocol

Protocollo (HTTP, HTTPS o TCP) usato per eseguire il probe per l'integrità degli endpoint.

timeoutInSeconds

integer

Timeout di monitoraggio per gli endpoint in questo profilo. Questo è il momento in cui Gestione traffico consente agli endpoint in questo profilo di rispondere al controllo di integrità.

toleratedNumberOfFailures

integer

Numero di controlli di integrità consecutivi non riusciti che Gestione traffico tollera prima di dichiarare un endpoint in questo profilo Degradato dopo il successivo controllo di integrità non riuscito.

MonitorProtocol

Protocollo (HTTP, HTTPS o TCP) usato per eseguire il probe per l'integrità degli endpoint.

Nome Tipo Descrizione
HTTP

string

HTTPS

string

TCP

string

Profile

Classe che rappresenta un profilo di Gestione traffico.

Nome Tipo Descrizione
id

string

ID risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}

location

string

Area di Azure in cui si trova la risorsa

name

string

nome della risorsa.

properties.allowedEndpointRecordTypes

AllowedEndpointRecordType[]

Elenco dei tipi di record di endpoint consentiti.

properties.dnsConfig

DnsConfig

Impostazioni DNS del profilo di Gestione traffico.

properties.endpoints

Endpoint[]

Elenco degli endpoint nel profilo di Gestione traffico.

properties.maxReturn

integer

Numero massimo di endpoint da restituire per il tipo di routing MultiValue.

properties.monitorConfig

MonitorConfig

Impostazioni di monitoraggio dell'endpoint del profilo di Gestione traffico.

properties.profileStatus

ProfileStatus

Stato del profilo di Gestione traffico.

properties.trafficRoutingMethod

TrafficRoutingMethod

Metodo di routing del traffico del profilo di Gestione traffico.

properties.trafficViewEnrollmentStatus

TrafficViewEnrollmentStatus

Indica se la visualizzazione traffico è "Abilitata" o "Disabilitata" per il profilo di Gestione traffico. Null, indica "Disabilitato". L'abilitazione di questa funzionalità aumenterà il costo del profilo Gestione traffico.

tags

object

Tag di risorse.

type

string

Tipo di risorsa. Ex- Microsoft.Network/trafficManagerProfiles.

ProfileMonitorStatus

Stato di monitoraggio a livello di profilo del profilo di Gestione traffico.

Nome Tipo Descrizione
CheckingEndpoints

string

Degraded

string

Disabled

string

Inactive

string

Online

string

ProfileStatus

Stato del profilo di Gestione traffico.

Nome Tipo Descrizione
Disabled

string

Enabled

string

Subnets

Elenco di subnet, indirizzi IP e/o intervalli di indirizzi mappati a questo endpoint quando si usa il metodo di routing del traffico "Subnet". Un elenco vuoto corrisponde a tutti gli intervalli non coperti da altri endpoint.

Nome Tipo Descrizione
first

string

Primo indirizzo nella subnet.

last

string

Ultimo indirizzo nella subnet.

scope

integer

Dimensioni del blocco (numero di bit iniziali nella subnet mask).

TrafficRoutingMethod

Metodo di routing del traffico del profilo di Gestione traffico.

Nome Tipo Descrizione
Geographic

string

MultiValue

string

Performance

string

Priority

string

Subnet

string

Weighted

string

TrafficViewEnrollmentStatus

Indica se la visualizzazione traffico è "Abilitata" o "Disabilitata" per il profilo di Gestione traffico. Null, indica "Disabilitato". L'abilitazione di questa funzionalità aumenterà il costo del profilo Gestione traffico.

Nome Tipo Descrizione
Disabled

string

Enabled

string