Freigeben über


Routes - Get

Ruft eine vorhandene Route mit dem angegebenen Routennamen unter dem angegebenen Abonnement, der angegebenen Ressourcengruppe, dem angegebenen Profil und dem angegebenen AzureFrontDoor-Endpunkt ab.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName}/routes/{routeName}?api-version=2023-05-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpointName
path True

string

Name des Endpunkts unter dem Profil, der global eindeutig ist.

profileName
path True

string

Name des Azure Front Door Standard- oder Azure Front Door Premium-Profils, das innerhalb der Ressourcengruppe eindeutig ist.

resourceGroupName
path True

string

Name der Ressourcengruppe innerhalb des Azure-Abonnements.

RegEx-Muster: ^[-\w\._\(\)]+$

routeName
path True

string

Name der Routingregel.

subscriptionId
path True

string

Die Azure-Abonnement-ID.

api-version
query True

string

Version der API, die mit der Clientanforderung verwendet werden soll. Aktuelle Version ist 2023-05-01.

Antworten

Name Typ Beschreibung
200 OK

Route

OK

Other Status Codes

AfdErrorResponse

Azure Front Door-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Routes_Get

Beispielanforderung

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2023-05-01

Beispiel für eine Antwort

{
  "name": "route1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdendpoints/endpoint1/routes/route1",
  "type": "Microsoft.Cdn/profiles/afdendpoints/routes",
  "properties": {
    "customDomains": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1"
      }
    ],
    "originGroup": {
      "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1"
    },
    "originPath": null,
    "ruleSets": [
      {
        "id": "/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/ruleSets/ruleSet1"
      }
    ],
    "supportedProtocols": [
      "Https",
      "Http"
    ],
    "patternsToMatch": [
      "/*"
    ],
    "cacheConfiguration": {
      "compressionSettings": {
        "contentTypesToCompress": [
          "text/html",
          "application/octet-stream"
        ],
        "isCompressionEnabled": true
      },
      "queryStringCachingBehavior": "IgnoreQueryString",
      "queryParameters": null
    },
    "forwardingProtocol": "MatchRequest",
    "linkToDefaultDomain": "Enabled",
    "httpsRedirect": "Enabled",
    "enabledState": "Enabled",
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

Definitionen

Name Beschreibung
ActivatedResourceReference

Verweis auf eine andere Ressource zusammen mit ihrem Zustand.

AFDEndpointProtocols

Unterstützte Protokolle für den Endpunkt des Kunden.

AfdErrorResponse

Fehlerantwort

AfdProvisioningState

Bereitstellungsstatus

afdQueryStringCachingBehavior

Definiert, wie Frontdoor Anforderungen zwischenspeichert, die Abfragezeichenfolgen enthalten. Sie können alle Abfragezeichenfolgen beim Zwischenspeichern ignorieren, bestimmte Abfragezeichenfolgen ignorieren, jede Anforderung mit einer eindeutigen URL zwischenspeichern oder bestimmte Abfragezeichenfolgen zwischenspeichern.

AfdRouteCacheConfiguration

Zwischenspeicherungseinstellungen für eine Zwischenspeicherungsroute. Um die Zwischenspeicherung zu deaktivieren, geben Sie kein cacheConfiguration-Objekt an.

CompressionSettings

Einstellungen für die Komprimierung.

DeploymentStatus
EnabledState

Gibt an, ob die Verwendung dieser Regel aktiviert werden soll. Zulässige Werte sind "Enabled" oder "Disabled".

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

ErrorDetail

Die Fehlerdetails.

ForwardingProtocol

Das Protokoll, das diese Regel beim Weiterleiten von Datenverkehr an Back-Ends verwendet.

httpsRedirect

Gibt an, ob HTTP-Datenverkehr automatisch an HTTPS-Datenverkehr umgeleitet werden soll. Beachten Sie, dass dies eine einfache Möglichkeit zum Einrichten dieser Regel ist und dies die erste Regel ist, die ausgeführt wird.

IdentityType

Der Identitätstyp, der Ressourcen erstellt/ändert

LinkToDefaultDomain

ob diese Route mit der Standardendpunktdomäne verknüpft wird.

ResourceReference

Verweis auf eine andere Ressource.

Route

Benutzerfreundliche Routennamen werden den routen- oder geheimnisbezogenen Informationen zugeordnet.

SystemData

Schreibgeschützte Systemdaten

ActivatedResourceReference

Verweis auf eine andere Ressource zusammen mit ihrem Zustand.

Name Typ Beschreibung
id

string

Ressourcen-ID

isActive

boolean

Gibt an, ob die Ressource aktiv oder inaktiv ist.

AFDEndpointProtocols

Unterstützte Protokolle für den Endpunkt des Kunden.

Name Typ Beschreibung
Http

string

Https

string

AfdErrorResponse

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.

AfdProvisioningState

Bereitstellungsstatus

Name Typ Beschreibung
Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

afdQueryStringCachingBehavior

Definiert, wie Frontdoor Anforderungen zwischenspeichert, die Abfragezeichenfolgen enthalten. Sie können alle Abfragezeichenfolgen beim Zwischenspeichern ignorieren, bestimmte Abfragezeichenfolgen ignorieren, jede Anforderung mit einer eindeutigen URL zwischenspeichern oder bestimmte Abfragezeichenfolgen zwischenspeichern.

Name Typ Beschreibung
IgnoreQueryString

string

IgnoreSpecifiedQueryStrings

string

IncludeSpecifiedQueryStrings

string

UseQueryString

string

AfdRouteCacheConfiguration

Zwischenspeicherungseinstellungen für eine Zwischenspeicherungsroute. Um die Zwischenspeicherung zu deaktivieren, geben Sie kein cacheConfiguration-Objekt an.

Name Typ Beschreibung
compressionSettings

CompressionSettings

Komprimierungseinstellungen.

queryParameters

string

Abfrageparameter, die eingeschlossen oder ausgeschlossen werden sollen (durch Trennzeichen getrennt).

queryStringCachingBehavior

afdQueryStringCachingBehavior

Definiert, wie Frontdoor Anforderungen zwischenspeichert, die Abfragezeichenfolgen enthalten. Sie können alle Abfragezeichenfolgen beim Zwischenspeichern ignorieren, bestimmte Abfragezeichenfolgen ignorieren, jede Anforderung mit einer eindeutigen URL zwischenspeichern oder bestimmte Abfragezeichenfolgen zwischenspeichern.

CompressionSettings

Einstellungen für die Komprimierung.

Name Typ Beschreibung
contentTypesToCompress

string[]

Liste der Inhaltstypen, für die die Komprimierung gilt. Der Wert sollte ein gültiger MIME-Typ sein.

isCompressionEnabled

boolean

Gibt an, ob die Inhaltskomprimierung in AzureFrontDoor aktiviert ist. Der Standardwert ist „false“. Wenn die Komprimierung aktiviert ist, werden Inhalte als komprimiert bereitgestellt, wenn der Benutzer eine komprimierte Version anfordert. Inhalte werden in AzureFrontDoor nicht komprimiert, wenn angeforderter Inhalt kleiner als 1 Byte oder größer als 1 MB ist.

DeploymentStatus

Name Typ Beschreibung
Failed

string

InProgress

string

NotStarted

string

Succeeded

string

EnabledState

Gibt an, ob die Verwendung dieser Regel aktiviert werden soll. Zulässige Werte sind "Enabled" oder "Disabled".

Name Typ Beschreibung
Disabled

string

Enabled

string

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name Typ Beschreibung
info

object

Zusätzliche Informationen.

type

string

Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Fehlerinformationen.

code

string

Der Fehlercode.

details

ErrorDetail[]

Die Fehlerdetails.

message

string

Die Fehlermeldung.

target

string

Das Fehlerziel.

ForwardingProtocol

Das Protokoll, das diese Regel beim Weiterleiten von Datenverkehr an Back-Ends verwendet.

Name Typ Beschreibung
HttpOnly

string

HttpsOnly

string

MatchRequest

string

httpsRedirect

Gibt an, ob HTTP-Datenverkehr automatisch an HTTPS-Datenverkehr umgeleitet werden soll. Beachten Sie, dass dies eine einfache Möglichkeit zum Einrichten dieser Regel ist und dies die erste Regel ist, die ausgeführt wird.

Name Typ Beschreibung
Disabled

string

Enabled

string

IdentityType

Der Identitätstyp, der Ressourcen erstellt/ändert

Name Typ Beschreibung
application

string

key

string

managedIdentity

string

user

string

LinkToDefaultDomain

ob diese Route mit der Standardendpunktdomäne verknüpft wird.

Name Typ Beschreibung
Disabled

string

Enabled

string

ResourceReference

Verweis auf eine andere Ressource.

Name Typ Beschreibung
id

string

Ressourcen-ID

Route

Benutzerfreundliche Routennamen werden den routen- oder geheimnisbezogenen Informationen zugeordnet.

Name Typ Standardwert Beschreibung
id

string

Ressourcen-ID

name

string

Name der Ressource.

properties.cacheConfiguration

AfdRouteCacheConfiguration

Die Zwischenspeicherungskonfiguration für diese Route. Um die Zwischenspeicherung zu deaktivieren, geben Sie kein cacheConfiguration-Objekt an.

properties.customDomains

ActivatedResourceReference[]

Domänen, auf die von diesem Endpunkt verwiesen wird.

properties.deploymentStatus

DeploymentStatus

properties.enabledState

EnabledState

Gibt an, ob die Verwendung dieser Regel aktiviert werden soll. Zulässige Werte sind "Enabled" oder "Disabled".

properties.endpointName

string

Der Name des Endpunkts, der die Route enthält.

properties.forwardingProtocol

ForwardingProtocol

MatchRequest

Das Protokoll, das diese Regel beim Weiterleiten von Datenverkehr an Back-Ends verwendet.

properties.httpsRedirect

httpsRedirect

Disabled

Gibt an, ob HTTP-Datenverkehr automatisch an HTTPS-Datenverkehr umgeleitet werden soll. Beachten Sie, dass dies eine einfache Möglichkeit zum Einrichten dieser Regel ist und dies die erste Regel ist, die ausgeführt wird.

properties.linkToDefaultDomain

LinkToDefaultDomain

Disabled

ob diese Route mit der Standardendpunktdomäne verknüpft wird.

properties.originGroup

ResourceReference

Ein Verweis auf die Ursprungsgruppe.

properties.originPath

string

Ein Verzeichnispfad für den Ursprung, aus dem AzureFrontDoor Inhalte abrufen kann, z. B. contoso.cloudapp.net/originpath.

properties.patternsToMatch

string[]

Die Routenmuster der Regel.

properties.provisioningState

AfdProvisioningState

Bereitstellungsstatus

properties.ruleSets

ResourceReference[]

Regelsätze, auf die von diesem Endpunkt verwiesen wird.

properties.supportedProtocols

AFDEndpointProtocols[]

[ "Http", "Https" ]

Liste der unterstützten Protokolle für diese Route.

systemData

SystemData

Schreibgeschützte Systemdaten

type

string

Der Ressourcentyp.

SystemData

Schreibgeschützte Systemdaten

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC)

createdBy

string

Ein Bezeichner für die Identität, die die Ressource erstellt hat.

createdByType

IdentityType

Der Identitätstyp, der die Ressource erstellt hat

lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)

lastModifiedBy

string

Ein Bezeichner für die Identität, die die Ressource zuletzt geändert hat

lastModifiedByType

IdentityType

Der Identitätstyp, der die Ressource zuletzt geändert hat