Routes - Get

Usługa:: Front Door Service

Wersja interfejsu API:: 2025-04-15

Pobiera istniejącą trasę z określoną nazwą trasy w ramach określonej subskrypcji, grupy zasobów, profilu i punktu końcowego usługi AzureFrontDoor.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpointName	path	True	string	Nazwa punktu końcowego w profilu, który jest unikatowy globalnie.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Nazwa usługi Azure Front Door Standard lub Azure Front Door Premium, która jest unikatowa w grupie zasobów.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
routeName	path	True	string	Nazwa reguły routingu.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Route	OK
Other Status Codes	ErrorResponse	Odpowiedź o błędzie usługi Azure Front Door opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Routes_Get

Przykładowe żądanie

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1/routes/route1?api-version=2025-04-15

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ActivatedResourceReference	Odwołanie do innego zasobu wraz ze stanem.
AFDEndpointProtocols	Obsługiwane protokoły dla punktu końcowego klienta.
AfdProvisioningState	Stan aprowizacji
afdQueryStringCachingBehavior	Definiuje sposób buforowania żądań frontdoor zawierających ciągi zapytania. Podczas buforowania można zignorować wszystkie ciągi zapytania, zignorować określone ciągi zapytania, buforować każde żądanie z unikatowym adresem URL lub buforować określone ciągi zapytań.
AfdRouteCacheConfiguration	Ustawienia buforowania dla trasy typu buforowania. Aby wyłączyć buforowanie, nie należy udostępniać obiektu cacheConfiguration.
CompressionSettings	ustawienia kompresji.
createdByType	Typ tożsamości, która utworzyła zasób.
DeploymentStatus
EnabledState	Czy włączyć korzystanie z tej reguły. Dozwolone wartości to "Włączone" lub "Wyłączone"
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
ForwardingProtocol	Protokół tej reguły będzie używany podczas przekazywania ruchu do zapleczy.
httpsRedirect	Czy automatycznie przekierowywać ruch HTTP do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób konfigurowania tej reguły i będzie to pierwsza reguła, która zostanie wykonana.
LinkToDefaultDomain	czy ta trasa zostanie połączona z domyślną domeną punktu końcowego.
ResourceReference	Odwołanie do innego zasobu.
Route	Przyjazne trasy mapowanie nazw na wszystkie trasy lub informacje powiązane z wpisem tajnym.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

ActivatedResourceReference

Objekt

Odwołanie do innego zasobu wraz ze stanem.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
isActive	boolean	Określa, czy zasób jest aktywny, czy nieaktywny

AFDEndpointProtocols

Wyliczanie

Obsługiwane protokoły dla punktu końcowego klienta.

Wartość	Opis
Http
Https

AfdProvisioningState

Wyliczanie

Stan aprowizacji

Wartość	Opis
Succeeded
Failed
Updating
Deleting
Creating

afdQueryStringCachingBehavior

Wyliczanie

Definiuje sposób buforowania żądań frontdoor zawierających ciągi zapytania. Podczas buforowania można zignorować wszystkie ciągi zapytania, zignorować określone ciągi zapytania, buforować każde żądanie z unikatowym adresem URL lub buforować określone ciągi zapytań.

Wartość	Opis
IgnoreQueryString
UseQueryString
IgnoreSpecifiedQueryStrings
IncludeSpecifiedQueryStrings

AfdRouteCacheConfiguration

Objekt

Ustawienia buforowania dla trasy typu buforowania. Aby wyłączyć buforowanie, nie należy udostępniać obiektu cacheConfiguration.

Nazwa	Typ	Opis
compressionSettings	CompressionSettings	ustawienia kompresji.
queryParameters	string	parametry zapytania do uwzględnienia lub wykluczenia (rozdzielone przecinkami).
queryStringCachingBehavior	afdQueryStringCachingBehavior	Definiuje sposób buforowania żądań frontdoor zawierających ciągi zapytania. Podczas buforowania można zignorować wszystkie ciągi zapytania, zignorować określone ciągi zapytania, buforować każde żądanie z unikatowym adresem URL lub buforować określone ciągi zapytań.

CompressionSettings

Objekt

ustawienia kompresji.

Nazwa	Typ	Opis
contentTypesToCompress	string[]	Lista typów zawartości, dla których ma zastosowanie kompresja. Wartość powinna być prawidłowym typem MIME.
isCompressionEnabled	boolean	Wskazuje, czy kompresja zawartości jest włączona w usłudze AzureFrontDoor. Wartość domyślna to false. Jeśli kompresja jest włączona, zawartość będzie obsługiwana jako skompresowana, jeśli żądania użytkowników dotyczące skompresowanej wersji. Zawartość nie będzie kompresowana w usłudze AzureFrontDoor, gdy żądana zawartość jest mniejsza niż 1 bajt lub większa niż 1 MB.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
User
Application
ManagedIdentity
Key

DeploymentStatus

Wyliczanie

Wartość	Opis
NotStarted
InProgress
Succeeded
Failed

EnabledState

Wyliczanie

Czy włączyć korzystanie z tej reguły. Dozwolone wartości to "Włączone" lub "Wyłączone"

Wartość	Opis
Enabled
Disabled

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

ForwardingProtocol

Wyliczanie

Protokół tej reguły będzie używany podczas przekazywania ruchu do zapleczy.

Wartość	Opis
HttpOnly
HttpsOnly
MatchRequest

httpsRedirect

Wyliczanie

Czy automatycznie przekierowywać ruch HTTP do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób konfigurowania tej reguły i będzie to pierwsza reguła, która zostanie wykonana.

Wartość	Opis
Enabled
Disabled

LinkToDefaultDomain

Wyliczanie

czy ta trasa zostanie połączona z domyślną domeną punktu końcowego.

Wartość	Opis
Enabled
Disabled

ResourceReference

Objekt

Odwołanie do innego zasobu.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.

Route

Objekt

Przyjazne trasy mapowanie nazw na wszystkie trasy lub informacje powiązane z wpisem tajnym.

Nazwa	Typ	Domyślna wartość	Opis
id	string (arm-id)		W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string		Nazwa zasobu
properties.cacheConfiguration	AfdRouteCacheConfiguration		Konfiguracja buforowania dla tej trasy. Aby wyłączyć buforowanie, nie należy udostępniać obiektu cacheConfiguration.
properties.customDomains	ActivatedResourceReference[]		Domeny, do których odwołuje się ten punkt końcowy.
properties.deploymentStatus	DeploymentStatus
properties.enabledState	EnabledState		Czy włączyć korzystanie z tej reguły. Dozwolone wartości to "Włączone" lub "Wyłączone"
properties.endpointName	string		Nazwa punktu końcowego, który przechowuje trasę.
properties.forwardingProtocol	ForwardingProtocol	MatchRequest	Protokół tej reguły będzie używany podczas przekazywania ruchu do zapleczy.
properties.httpsRedirect	httpsRedirect	Disabled	Czy automatycznie przekierowywać ruch HTTP do ruchu HTTPS. Należy pamiętać, że jest to prosty sposób konfigurowania tej reguły i będzie to pierwsza reguła, która zostanie wykonana.
properties.linkToDefaultDomain	LinkToDefaultDomain	Disabled	czy ta trasa zostanie połączona z domyślną domeną punktu końcowego.
properties.originGroup	ResourceReference		Odwołanie do grupy pochodzenia.
properties.originPath	string		Ścieżka katalogu w lokalizacji początkowej, z którego może być używana usługa AzureFrontDoor do pobierania zawartości, np. contoso.cloudapp.net/originpath.
properties.patternsToMatch	string[]		Wzorce tras reguły.
properties.provisioningState	AfdProvisioningState		Stan aprowizacji
properties.ruleSets	ResourceReference[]		Zestawy reguł, do których odwołuje się ten punkt końcowy.
properties.supportedProtocols	AFDEndpointProtocols[]	[ "Http", "Https" ]	Lista obsługiwanych protokołów dla tej trasy.
systemData	systemData		Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.

Udostępnij za pośrednictwem

Routes - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Routes_Get

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ActivatedResourceReference

AFDEndpointProtocols

AfdProvisioningState

afdQueryStringCachingBehavior

AfdRouteCacheConfiguration

CompressionSettings

createdByType

DeploymentStatus

EnabledState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardingProtocol

httpsRedirect

LinkToDefaultDomain

ResourceReference

Route

systemData