Megosztás a következőn keresztül:


Gateway Route Configs - Get

Kérje le a Spring Cloud Gateway útvonalkonfigurációit.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}?api-version=2023-12-01

URI-paraméterek

Name In Kötelező Típus Description
gatewayName
path True

string

pattern: ^[a-z][a-z0-9]*$

A Spring Cloud Gateway neve.

resourceGroupName
path True

string

Az erőforrást tartalmazó erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.

routeConfigName
path True

string

A Spring Cloud Gateway útvonalkonfigurációjának neve.

serviceName
path True

string

pattern: ^[a-z][a-z0-9-]*[a-z0-9]$

A szolgáltatáserőforrás neve.

subscriptionId
path True

string

Lekéri az előfizetés azonosítóját, amely egyedileg azonosítja a Microsoft Azure-előfizetést. Az előfizetés azonosítója minden szolgáltatáshíváshoz az URI részét képezi.

api-version
query True

string

minLength: 1

A művelethez használni kívánt API-verzió.

Válaszok

Name Típus Description
200 OK

GatewayRouteConfigResource

Siker. A válasz a Spring Cloud Gateway megfelelő útvonalkonfigurációit írja le.

Other Status Codes

CloudError

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

GatewayRouteConfigs_Get

Mintakérelem

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig?api-version=2023-12-01

Mintaválasz

{
  "properties": {
    "provisioningState": "Succeeded",
    "appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
    "openApi": {
      "uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"
    },
    "protocol": "HTTPS",
    "routes": [
      {
        "title": "myApp route config",
        "ssoEnabled": true,
        "predicates": [
          "Path=/api5/customer/**"
        ],
        "filters": [
          "StripPrefix=2",
          "RateLimit=1,1s"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig",
  "name": "myRouteConfig"
}

Definíciók

Name Description
CloudError

Hibaválasz a szolgáltatástól.

CloudErrorBody

Hibaválasz a szolgáltatástól.

createdByType

Az erőforrást létrehozó identitás típusa.

GatewayApiRoute

A Spring Cloud Gateway API-útvonalkonfigurációja

GatewayProvisioningState

A Spring Cloud Gateway állapota.

GatewayRouteConfigOpenApiProperties

A Spring Cloud Gateway útvonalkonfigurációjának OpenAPI-tulajdonságai.

GatewayRouteConfigProperties

A Spring Cloud Gateway API-útvonalkonfigurációja

GatewayRouteConfigProtocol

Az irányított Azure Spring Apps-alkalmazások protokollja.

GatewayRouteConfigResource

Spring Cloud Gateway útvonalkonfigurációs erőforrás

lastModifiedByType

Az erőforrást legutóbb módosító identitás típusa.

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

CloudError

Hibaválasz a szolgáltatástól.

Name Típus Description
error

CloudErrorBody

Hibaválasz a szolgáltatástól.

CloudErrorBody

Hibaválasz a szolgáltatástól.

Name Típus Description
code

string

A hiba azonosítója. A kódok invariánsak, és programozott módon használhatók.

details

CloudErrorBody[]

A hiba további részleteinek listája.

message

string

A hibát leíró üzenet, amely alkalmas a felhasználói felületen való megjelenítésre.

target

string

Az adott hiba célja. Például a tulajdonság neve hibás.

createdByType

Az erőforrást létrehozó identitás típusa.

Érték Description
Application
Key
ManagedIdentity
User

GatewayApiRoute

A Spring Cloud Gateway API-útvonalkonfigurációja

Name Típus Description
description

string

A rendszer egy leírást alkalmaz a metódusokra a létrehozott OpenAPI-dokumentációban.

filters

string[]

Ha módosítani szeretné a kérést, mielőtt elküldené a célvégpontnak vagy a kapott válasznak.

order

integer (int32)

Útvonalfeldolgozási sorrend.

predicates

string[]

Számos feltétel az egyes kérések útvonalának kiértékeléséhez. Minden predikátum kiértékelhető kérelemfejlécek és paraméterértékek alapján. Az útvonalhoz társított összes predikátumnak igaznak kell lennie ahhoz, hogy az útvonal megfeleltethető legyen a kérésnek.

ssoEnabled

boolean

Engedélyezze az egyszeri bejelentkezés érvényesítését.

tags

string[]

A rendszer a létrehozott OpenAPI-dokumentációban szereplő metódusokra alkalmazza a besorolási címkéket.

title

string

A rendszer egy címet alkalmaz a metódusokra a létrehozott OpenAPI-dokumentációban.

tokenRelay

boolean

Adja át a jelenleg hitelesített felhasználó identitásjogkivonatát az Application Service-nek, alapértelmezés szerint "false" (hamis)

uri

string

Teljes uri, felülbírálja appName.

GatewayProvisioningState

A Spring Cloud Gateway állapota.

Érték Description
Creating
Deleting
Failed
Succeeded
Updating

GatewayRouteConfigOpenApiProperties

A Spring Cloud Gateway útvonalkonfigurációjának OpenAPI-tulajdonságai.

Name Típus Description
uri

string

Az OpenAPI specifikáció URI-ja.

GatewayRouteConfigProperties

A Spring Cloud Gateway API-útvonalkonfigurációja

Name Típus Alapértelmezett érték Description
appResourceId

string

Az Azure Spring Apps alkalmazás erőforrás-azonosítója kötelező, kivéve, ha az útvonal urihatároz meg.

filters

string[]

A kérés módosítása a célvégpontra való küldés előtt, vagy a kapott válasz alkalmazásszinten.

openApi

GatewayRouteConfigOpenApiProperties

A Spring Cloud Gateway útvonalkonfigurációjának OpenAPI-tulajdonságai.

predicates

string[]

Számos feltétel az egyes kérések útvonalának alkalmazásszinten történő kiértékeléséhez. Minden predikátum kiértékelhető kérelemfejlécek és paraméterértékek alapján. Az útvonalhoz társított összes predikátumnak igaznak kell lennie ahhoz, hogy az útvonal megfeleltethető legyen a kérésnek.

protocol

GatewayRouteConfigProtocol

HTTP

Az irányított Azure Spring Apps-alkalmazások protokollja.

provisioningState

GatewayProvisioningState

A Spring Cloud Gateway útvonalkonfigurációjának állapota.

routes

GatewayApiRoute[]

Az API-útvonalak tömbje minden útvonal olyan tulajdonságokat tartalmaz, mint a title, uri, ssoEnabled, predicates, filters.

ssoEnabled

boolean

Egyetlen Sign-On engedélyezése alkalmazásszinten.

GatewayRouteConfigProtocol

Az irányított Azure Spring Apps-alkalmazások protokollja.

Érték Description
HTTP
HTTPS

GatewayRouteConfigResource

Spring Cloud Gateway útvonalkonfigurációs erőforrás

Name Típus Description
id

string

Az erőforrás teljes erőforrás-azonosítója.

name

string

Az erőforrás neve.

properties

GatewayRouteConfigProperties

A Spring Cloud Gateway API-útvonalkonfigurációja

systemData

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

type

string

Az erőforrás típusa.

lastModifiedByType

Az erőforrást legutóbb módosító identitás típusa.

Érték Description
Application
Key
ManagedIdentity
User

SystemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string (date-time)

Az erőforrás-létrehozás időbélyege (UTC).

createdBy

string

Az erőforrást létrehozó identitás.

createdByType

createdByType

Az erőforrást létrehozó identitás típusa.

lastModifiedAt

string (date-time)

Az erőforrás-módosítás időbélyege (UTC).

lastModifiedBy

string

Az erőforrást legutóbb módosító identitás.

lastModifiedByType

lastModifiedByType

Az erőforrást legutóbb módosító identitás típusa.