Gateway Route Configs - Create Or Update
Erstellen Sie die Standardkonfigurationen für Spring Cloud Gateway-Routen, oder aktualisieren Sie die vorhandenen Spring Cloud Gateway-Routenkonfigurationen.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/gateways/{gatewayName}/routeConfigs/{routeConfigName}?api-version=2023-12-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
gateway
|
path | True |
string pattern: ^[a-z][a-z0-9]*$ |
Der Name des Spring Cloud Gateways. |
resource
|
path | True |
string |
Der Name der Ressourcengruppe, die die Ressource enthält. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen. |
route
|
path | True |
string |
Der Name der Konfiguration der Spring Cloud Gateway-Route. |
service
|
path | True |
string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$ |
Der Name der Dienstressource. |
subscription
|
path | True |
string |
Ruft die Abonnement-ID ab, die das Microsoft Azure-Abonnement eindeutig identifiziert. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf. |
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
properties |
API-Routenkonfiguration des Spring Cloud Gateways |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolg. Die Antwort beschreibt die aktualisierten Spring Cloud Gateway-Routenkonfigurationen. |
|
201 Created |
Erstellt. Die Antwort beschreibt die neuen erstellten Spring Cloud Gateway-Routenkonfigurationen und enthält einen Azure-AsyncOperation Header zum Abfragen des Vorgangsergebnisses. |
|
Other Status Codes |
Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist. |
Sicherheit
azure_auth
Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
user_impersonation | Identitätswechsel ihres Benutzerkontos |
Beispiele
GatewayRouteConfigs_CreateOrUpdate
Beispielanforderung
PUT 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
{
"properties": {
"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"
]
}
]
}
}
Beispiel für eine Antwort
{
"properties": {
"provisioningState": "Succeeded",
"appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
"protocol": "HTTPS",
"openApi": {
"uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"
},
"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"
}
{
"properties": {
"appResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp",
"protocol": "HTTPS",
"openApi": {
"uri": "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"
},
"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"
}
Definitionen
Name | Beschreibung |
---|---|
Cloud |
Eine Fehlerantwort des Diensts. |
Cloud |
Eine Fehlerantwort des Diensts. |
created |
Der Identitätstyp, der die Ressource erstellt hat. |
Gateway |
API-Routenkonfiguration des Spring Cloud Gateways |
Gateway |
Status des Spring Cloud Gateway. |
Gateway |
OpenAPI-Eigenschaften der Spring Cloud Gateway-Routenkonfiguration. |
Gateway |
API-Routenkonfiguration des Spring Cloud Gateways |
Gateway |
Protokoll der weitergeleiteten Azure Spring Apps-Anwendungen. |
Gateway |
Konfigurationsressource für Spring Cloud Gateway |
last |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |
System |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
CloudError
Eine Fehlerantwort des Diensts.
Name | Typ | Beschreibung |
---|---|---|
error |
Eine Fehlerantwort des Diensts. |
CloudErrorBody
Eine Fehlerantwort des Diensts.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden. |
details |
Eine Liste mit zusätzlichen Details zum Fehler. |
|
message |
string |
Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist. |
target |
string |
Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler. |
createdByType
Der Identitätstyp, der die Ressource erstellt hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
GatewayApiRoute
API-Routenkonfiguration des Spring Cloud Gateways
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Eine Beschreibung wird auf Methoden in der generierten OpenAPI-Dokumentation angewendet. |
filters |
string[] |
So ändern Sie die Anforderung vor dem Senden an den Zielendpunkt oder die empfangene Antwort. |
order |
integer (int32) |
Routenverarbeitungsreihenfolge. |
predicates |
string[] |
Eine Reihe von Bedingungen zum Auswerten einer Route für jede Anforderung. Jedes Prädikat kann anhand von Anforderungsheadern und Parameterwerten ausgewertet werden. Alle Prädikate, die einer Route zugeordnet sind, müssen als "true" ausgewertet werden, damit die Route mit der Anforderung abgeglichen wird. |
ssoEnabled |
boolean |
Aktivieren Sie die sso-Überprüfung. |
tags |
string[] |
Klassifizierungstags werden auf Methoden in der generierten OpenAPI-Dokumentation angewendet. |
title |
string |
Ein Titel wird auf Methoden in der generierten OpenAPI-Dokumentation angewendet. |
tokenRelay |
boolean |
Übergeben sie das Identitätstoken des aktuell authentifizierten Benutzers an den Anwendungsdienst. Der Standardwert ist "false". |
uri |
string |
Der vollständige URI überschreibt |
GatewayProvisioningState
Status des Spring Cloud Gateway.
Wert | Beschreibung |
---|---|
Creating | |
Deleting | |
Failed | |
Succeeded | |
Updating |
GatewayRouteConfigOpenApiProperties
OpenAPI-Eigenschaften der Spring Cloud Gateway-Routenkonfiguration.
Name | Typ | Beschreibung |
---|---|---|
uri |
string |
Der URI der OpenAPI-Spezifikation. |
GatewayRouteConfigProperties
API-Routenkonfiguration des Spring Cloud Gateways
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
appResourceId |
string |
Die Ressourcen-ID der Azure Spring Apps-App, erforderlich, es sei denn, die Route definiert |
|
filters |
string[] |
So ändern Sie die Anforderung vor dem Senden an den Zielendpunkt oder die empfangene Antwort auf App-Ebene. |
|
openApi |
OpenAPI-Eigenschaften der Spring Cloud Gateway-Routenkonfiguration. |
||
predicates |
string[] |
Eine Reihe von Bedingungen zum Auswerten einer Route für jede Anforderung auf App-Ebene. Jedes Prädikat kann anhand von Anforderungsheadern und Parameterwerten ausgewertet werden. Alle Prädikate, die einer Route zugeordnet sind, müssen als "true" ausgewertet werden, damit die Route mit der Anforderung abgeglichen wird. |
|
protocol | HTTP |
Protokoll der weitergeleiteten Azure Spring Apps-Anwendungen. |
|
provisioningState |
Status der Spring Cloud Gateway-Routenkonfiguration. |
||
routes |
Array von API-Routen, jede Route enthält Eigenschaften wie |
||
ssoEnabled |
boolean |
Aktivieren sie einzelne Sign-On auf App-Ebene. |
GatewayRouteConfigProtocol
Protokoll der weitergeleiteten Azure Spring Apps-Anwendungen.
Wert | Beschreibung |
---|---|
HTTP | |
HTTPS |
GatewayRouteConfigResource
Konfigurationsressource für Spring Cloud Gateway
Name | Typ | Beschreibung |
---|---|---|
id |
string |
Vollqualifizierte Ressourcen-ID für die Ressource. |
name |
string |
Der Name der Ressource. |
properties |
API-Routenkonfiguration des Spring Cloud Gateways |
|
systemData |
Metadaten zur Erstellung und letzten Änderung der Ressource. |
|
type |
string |
Der Typ der Ressource. |
lastModifiedByType
Der Identitätstyp, der die Ressource zuletzt geändert hat.
Wert | Beschreibung |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
SystemData
Metadaten zur Erstellung und letzten Änderung der Ressource.
Name | Typ | Beschreibung |
---|---|---|
createdAt |
string (date-time) |
Der Zeitstempel der Ressourcenerstellung (UTC). |
createdBy |
string |
Die Identität, die die Ressource erstellt hat. |
createdByType |
Der Identitätstyp, der die Ressource erstellt hat. |
|
lastModifiedAt |
string (date-time) |
Der Zeitstempel der Ressourcenänderung (UTC). |
lastModifiedBy |
string |
Die Identität, die die Ressource zuletzt geändert hat. |
lastModifiedByType |
Der Identitätstyp, der die Ressource zuletzt geändert hat. |