Bagikan melalui


Routes - Get

Mendapatkan rute yang sudah ada dengan nama rute yang ditentukan di bawah langganan, grup sumber daya, profil, dan titik akhir AzureFrontDoor yang ditentukan.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpointName
path True

string

Nama titik akhir di bawah profil yang unik secara global.

profileName
path True

string

Nama profil Azure Front Door Standard atau Azure Front Door Premium yang unik dalam grup sumber daya.

resourceGroupName
path True

string

Nama grup Sumber Daya dalam langganan Azure.

Pola regex: ^[-\w\._\(\)]+$

routeName
path True

string

Nama aturan perutean.

subscriptionId
path True

string

ID Langganan Azure.

api-version
query True

string

Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2023-05-01.

Respons

Nama Jenis Deskripsi
200 OK

Route

OK

Other Status Codes

AfdErrorResponse

Respons kesalahan Azure Front Door yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama Deskripsi
user_impersonation meniru akun pengguna Anda

Contoh

Routes_Get

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
ActivatedResourceReference

Referensi ke sumber daya lain bersama dengan statusnya.

AFDEndpointProtocols

Protokol yang didukung untuk titik akhir pelanggan.

AfdErrorResponse

Respons kesalahan

AfdProvisioningState

Status provisi

afdQueryStringCachingBehavior

Menentukan bagaimana Frontdoor menyimpan permintaan yang menyertakan string kueri. Anda bisa mengabaikan string kueri apa pun saat penembolokan, mengabaikan string kueri tertentu, menyimpan cache setiap permintaan dengan URL unik, atau menyimpan string kueri tertentu.

AfdRouteCacheConfiguration

Pengaturan penembolokan untuk rute jenis penembolokan. Untuk menonaktifkan penembolokan, jangan sediakan objek cacheConfiguration.

CompressionSettings

pengaturan untuk pemadatan.

DeploymentStatus
EnabledState

Apakah akan mengaktifkan penggunaan aturan ini. Nilai yang diizinkan adalah 'Diaktifkan' atau 'Dinonaktifkan'

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

ErrorDetail

Detail kesalahan.

ForwardingProtocol

Protokol yang akan digunakan aturan ini saat meneruskan lalu lintas ke backend.

httpsRedirect

Apakah akan mengalihkan lalu lintas HTTP secara otomatis ke lalu lintas HTTPS. Perhatikan bahwa ini adalah cara mudah untuk menyiapkan aturan ini dan ini akan menjadi aturan pertama yang dijalankan.

IdentityType

Jenis identitas yang membuat/memodifikasi sumber daya

LinkToDefaultDomain

apakah rute ini akan ditautkan ke domain titik akhir default.

ResourceReference

Referensi ke sumber daya lain.

Route

Pemetaan nama Rute ramah ke Rute atau informasi terkait rahasia apa pun.

SystemData

Membaca hanya data sistem

ActivatedResourceReference

Referensi ke sumber daya lain bersama dengan statusnya.

Nama Jenis Deskripsi
id

string

ID Sumber Daya.

isActive

boolean

Apakah sumber daya aktif atau tidak aktif

AFDEndpointProtocols

Protokol yang didukung untuk titik akhir pelanggan.

Nama Jenis Deskripsi
Http

string

Https

string

AfdErrorResponse

Respons kesalahan

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

AfdProvisioningState

Status provisi

Nama Jenis Deskripsi
Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

afdQueryStringCachingBehavior

Menentukan bagaimana Frontdoor menyimpan permintaan yang menyertakan string kueri. Anda bisa mengabaikan string kueri apa pun saat penembolokan, mengabaikan string kueri tertentu, menyimpan cache setiap permintaan dengan URL unik, atau menyimpan string kueri tertentu.

Nama Jenis Deskripsi
IgnoreQueryString

string

IgnoreSpecifiedQueryStrings

string

IncludeSpecifiedQueryStrings

string

UseQueryString

string

AfdRouteCacheConfiguration

Pengaturan penembolokan untuk rute jenis penembolokan. Untuk menonaktifkan penembolokan, jangan sediakan objek cacheConfiguration.

Nama Jenis Deskripsi
compressionSettings

CompressionSettings

pengaturan pemadatan.

queryParameters

string

parameter kueri untuk disertakan atau dikecualikan (dipisahkan koma).

queryStringCachingBehavior

afdQueryStringCachingBehavior

Menentukan bagaimana Frontdoor menyimpan permintaan yang menyertakan string kueri. Anda bisa mengabaikan string kueri apa pun saat penembolokan, mengabaikan string kueri tertentu, menyimpan cache setiap permintaan dengan URL unik, atau menyimpan string kueri tertentu.

CompressionSettings

pengaturan untuk pemadatan.

Nama Jenis Deskripsi
contentTypesToCompress

string[]

Daftar tipe isi tempat pemadatan berlaku. Nilai harus berupa jenis MIME yang valid.

isCompressionEnabled

boolean

Menunjukkan apakah pemadatan konten diaktifkan di AzureFrontDoor. Nilai defaultnya adalah salah. Jika pemadatan diaktifkan, konten akan disajikan sebagai dikompresi jika permintaan pengguna untuk versi terkompresi. Konten tidak akan dikompresi di AzureFrontDoor saat konten yang diminta lebih kecil dari 1 byte atau lebih besar dari 1 MB.

DeploymentStatus

Nama Jenis Deskripsi
Failed

string

InProgress

string

NotStarted

string

Succeeded

string

EnabledState

Apakah akan mengaktifkan penggunaan aturan ini. Nilai yang diizinkan adalah 'Diaktifkan' atau 'Dinonaktifkan'

Nama Jenis Deskripsi
Disabled

string

Enabled

string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama Jenis Deskripsi
info

object

Info tambahan.

type

string

Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Info tambahan kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Detail kesalahan.

message

string

Pesan kesalahan.

target

string

Target kesalahan.

ForwardingProtocol

Protokol yang akan digunakan aturan ini saat meneruskan lalu lintas ke backend.

Nama Jenis Deskripsi
HttpOnly

string

HttpsOnly

string

MatchRequest

string

httpsRedirect

Apakah akan mengalihkan lalu lintas HTTP secara otomatis ke lalu lintas HTTPS. Perhatikan bahwa ini adalah cara mudah untuk menyiapkan aturan ini dan ini akan menjadi aturan pertama yang dijalankan.

Nama Jenis Deskripsi
Disabled

string

Enabled

string

IdentityType

Jenis identitas yang membuat/memodifikasi sumber daya

Nama Jenis Deskripsi
application

string

key

string

managedIdentity

string

user

string

LinkToDefaultDomain

apakah rute ini akan ditautkan ke domain titik akhir default.

Nama Jenis Deskripsi
Disabled

string

Enabled

string

ResourceReference

Referensi ke sumber daya lain.

Nama Jenis Deskripsi
id

string

ID Sumber Daya.

Route

Pemetaan nama Rute ramah ke Rute atau informasi terkait rahasia apa pun.

Nama Jenis Nilai default Deskripsi
id

string

ID Sumber Daya.

name

string

Nama sumber daya.

properties.cacheConfiguration

AfdRouteCacheConfiguration

Konfigurasi penembolokan untuk rute ini. Untuk menonaktifkan penembolokan, jangan sediakan objek cacheConfiguration.

properties.customDomains

ActivatedResourceReference[]

Domain yang dirujuk oleh titik akhir ini.

properties.deploymentStatus

DeploymentStatus

properties.enabledState

EnabledState

Apakah akan mengaktifkan penggunaan aturan ini. Nilai yang diizinkan adalah 'Diaktifkan' atau 'Dinonaktifkan'

properties.endpointName

string

Nama titik akhir yang menyimpan rute.

properties.forwardingProtocol

ForwardingProtocol

MatchRequest

Protokol yang akan digunakan aturan ini saat meneruskan lalu lintas ke backend.

properties.httpsRedirect

httpsRedirect

Disabled

Apakah akan mengalihkan lalu lintas HTTP secara otomatis ke lalu lintas HTTPS. Perhatikan bahwa ini adalah cara mudah untuk menyiapkan aturan ini dan ini akan menjadi aturan pertama yang dijalankan.

properties.linkToDefaultDomain

LinkToDefaultDomain

Disabled

apakah rute ini akan ditautkan ke domain titik akhir default.

properties.originGroup

ResourceReference

Referensi ke grup asal.

properties.originPath

string

Jalur direktori pada asal yang dapat digunakan AzureFrontDoor untuk mengambil konten, misalnya contoso.cloudapp.net/originpath.

properties.patternsToMatch

string[]

Pola rute aturan.

properties.provisioningState

AfdProvisioningState

Status provisi

properties.ruleSets

ResourceReference[]

seperangkat aturan yang dirujuk oleh titik akhir ini.

properties.supportedProtocols

AFDEndpointProtocols[]

[ "Http", "Https" ]

Daftar protokol yang didukung untuk rute ini.

systemData

SystemData

Membaca hanya data sistem

type

string

Jenis sumber daya

SystemData

Membaca hanya data sistem

Nama Jenis Deskripsi
createdAt

string

Tanda waktu pembuatan sumber daya (UTC)

createdBy

string

Pengidentifikasi untuk identitas yang membuat sumber daya

createdByType

IdentityType

Jenis identitas yang membuat sumber daya

lastModifiedAt

string

Tanda waktu modifikasi terakhir sumber daya (UTC)

lastModifiedBy

string

Pengidentifikasi untuk identitas yang terakhir memodifikasi sumber daya

lastModifiedByType

IdentityType

Jenis identitas yang terakhir mengubah sumber daya