Gateway Route Configs - Create Or Update

Service:

Azure Spring Apps

Version d'API:

2023-12-01

Créez les configurations d’itinéraire Spring Cloud Gateway par défaut ou mettez à jour les configurations d’itinéraire Spring Cloud Gateway existantes.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayName	path	True	string pattern: ^[a-z][a-z0-9]*$	Nom de Spring Cloud Gateway.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
routeConfigName	path	True	string	Nom de la configuration de l’itinéraire spring Cloud Gateway.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Nom de la ressource de service.
subscriptionId	path	True	string	Obtient l’ID d’abonnement qui identifie de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI de chaque appel de service.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties	GatewayRouteConfigProperties	Configuration de l’itinéraire d’API de la passerelle Spring Cloud

Réponses

Nom	Type	Description
200 OK	GatewayRouteConfigResource	Succès. La réponse décrit les configurations de routage Spring Cloud Gateway mises à jour.
201 Created	GatewayRouteConfigResource	Créé. La réponse décrit les nouvelles configurations de routage Spring Cloud Gateway créées et contient un en-tête Azure-AsyncOperation pour interroger le résultat de l’opération.
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

GatewayRouteConfigs_CreateOrUpdate

Exemple de requête

HTTP

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

Java

import com.azure.resourcemanager.appplatform.fluent.models.GatewayRouteConfigResourceInner;
import com.azure.resourcemanager.appplatform.models.GatewayApiRoute;
import com.azure.resourcemanager.appplatform.models.GatewayRouteConfigOpenApiProperties;
import com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProperties;
import com.azure.resourcemanager.appplatform.models.GatewayRouteConfigProtocol;
import java.util.Arrays;

/**
 * Samples for GatewayRouteConfigs CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * GatewayRouteConfigs_CreateOrUpdate.json
     */
    /**
     * Sample code: GatewayRouteConfigs_CreateOrUpdate.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void gatewayRouteConfigsCreateOrUpdate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getGatewayRouteConfigs().createOrUpdate("myResourceGroup",
            "myservice", "default", "myRouteConfig",
            new GatewayRouteConfigResourceInner().withProperties(new GatewayRouteConfigProperties().withAppResourceId(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp")
                .withOpenApi(new GatewayRouteConfigOpenApiProperties().withUri(
                    "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"))
                .withProtocol(GatewayRouteConfigProtocol.HTTPS)
                .withRoutes(Arrays.asList(new GatewayApiRoute().withTitle("myApp route config").withSsoEnabled(true)
                    .withPredicates(Arrays.asList("Path=/api5/customer/**"))
                    .withFilters(Arrays.asList("StripPrefix=2", "RateLimit=1,1s"))))),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.appplatform import AppPlatformManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-appplatform
# USAGE
    python gateway_route_configs_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AppPlatformManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.gateway_route_configs.begin_create_or_update(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        gateway_name="default",
        route_config_name="myRouteConfig",
        gateway_route_config_resource={
            "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": [
                    {
                        "filters": ["StripPrefix=2", "RateLimit=1,1s"],
                        "predicates": ["Path=/api5/customer/**"],
                        "ssoEnabled": True,
                        "title": "myApp route config",
                    }
                ],
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappplatform_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appplatform/armappplatform/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/685aad3f33d355c1d9c89d493ee9398865367bd8/specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_CreateOrUpdate.json
func ExampleGatewayRouteConfigsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappplatform.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewGatewayRouteConfigsClient().BeginCreateOrUpdate(ctx, "myResourceGroup", "myservice", "default", "myRouteConfig", armappplatform.GatewayRouteConfigResource{
		Properties: &armappplatform.GatewayRouteConfigProperties{
			AppResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
			OpenAPI: &armappplatform.GatewayRouteConfigOpenAPIProperties{
				URI: to.Ptr("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
			},
			Routes: []*armappplatform.GatewayAPIRoute{
				{
					Filters: []*string{
						to.Ptr("StripPrefix=2"),
						to.Ptr("RateLimit=1,1s")},
					Predicates: []*string{
						to.Ptr("Path=/api5/customer/**")},
					SsoEnabled: to.Ptr(true),
					Title:      to.Ptr("myApp route config"),
				}},
			Protocol: to.Ptr(armappplatform.GatewayRouteConfigProtocolHTTPS),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GatewayRouteConfigResource = armappplatform.GatewayRouteConfigResource{
	// 	Name: to.Ptr("myRouteConfig"),
	// 	Type: to.Ptr("Microsoft.AppPlatform/Spring/gateways/routeConfigs"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/gateways/default/routeConfigs/myRouteConfig"),
	// 	SystemData: &armappplatform.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:16:03.944Z"); return t}()),
	// 		CreatedBy: to.Ptr("sample-user"),
	// 		CreatedByType: to.Ptr(armappplatform.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-08-11T03:17:03.944Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("sample-user"),
	// 		LastModifiedByType: to.Ptr(armappplatform.LastModifiedByTypeUser),
	// 	},
	// 	Properties: &armappplatform.GatewayRouteConfigProperties{
	// 		AppResourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myApp"),
	// 		OpenAPI: &armappplatform.GatewayRouteConfigOpenAPIProperties{
	// 			URI: to.Ptr("https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json"),
	// 		},
	// 		ProvisioningState: to.Ptr(armappplatform.GatewayProvisioningStateSucceeded),
	// 		Routes: []*armappplatform.GatewayAPIRoute{
	// 			{
	// 				Filters: []*string{
	// 					to.Ptr("StripPrefix=2"),
	// 					to.Ptr("RateLimit=1,1s")},
	// 					Predicates: []*string{
	// 						to.Ptr("Path=/api5/customer/**")},
	// 						SsoEnabled: to.Ptr(true),
	// 						Title: to.Ptr("myApp route config"),
	// 				}},
	// 				Protocol: to.Ptr(armappplatform.GatewayRouteConfigProtocolHTTPS),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AppPlatformManagementClient } = require("@azure/arm-appplatform");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.
 *
 * @summary Create the default Spring Cloud Gateway route configs or update the existing Spring Cloud Gateway route configs.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_CreateOrUpdate.json
 */
async function gatewayRouteConfigsCreateOrUpdate() {
  const subscriptionId =
    process.env["APPPLATFORM_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APPPLATFORM_RESOURCE_GROUP"] || "myResourceGroup";
  const serviceName = "myservice";
  const gatewayName = "default";
  const routeConfigName = "myRouteConfig";
  const gatewayRouteConfigResource = {
    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",
      },
      routes: [
        {
          filters: ["StripPrefix=2", "RateLimit=1,1s"],
          predicates: ["Path=/api5/customer/**"],
          ssoEnabled: true,
          title: "myApp route config",
        },
      ],
      protocol: "HTTPS",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.gatewayRouteConfigs.beginCreateOrUpdateAndWait(
    resourceGroupName,
    serviceName,
    gatewayName,
    routeConfigName,
    gatewayRouteConfigResource,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

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

Code d’état:

201

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

Définitions

Nom	Description
CloudError	Réponse d’erreur du service.
CloudErrorBody	Réponse d’erreur du service.
createdByType	Type d’identité qui a créé la ressource.
GatewayApiRoute	Configuration de l’itinéraire d’API de la passerelle Spring Cloud
GatewayProvisioningState	État de la passerelle Spring Cloud.
GatewayRouteConfigOpenApiProperties	Propriétés OpenAPI de la configuration de l’itinéraire spring Cloud Gateway.
GatewayRouteConfigProperties	Configuration de l’itinéraire d’API de la passerelle Spring Cloud
GatewayRouteConfigProtocol	Protocole des applications Azure Spring Apps routées.
GatewayRouteConfigResource	Ressource de configuration de l’itinéraire spring Cloud Gateway
lastModifiedByType	Type d’identité qui a modifié la ressource pour la dernière fois.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

CloudError

Objet

Réponse d’erreur du service.

Nom	Type	Description
error	CloudErrorBody	Réponse d’erreur du service.

CloudErrorBody

Objet

Réponse d’erreur du service.

Nom	Type	Description
code	string	Identificateur de l’erreur. Les codes sont invariants et sont destinés à être consommés par programme.
details	CloudErrorBody[]	Liste des détails supplémentaires sur l’erreur.
message	string	Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.
target	string	Cible de l’erreur particulière. Par exemple, le nom de la propriété en erreur.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

GatewayApiRoute

Objet

Configuration de l’itinéraire d’API de la passerelle Spring Cloud

Nom	Type	Description
description	string	Une description sera appliquée aux méthodes de la documentation OpenAPI générée.
filters	string[]	Pour modifier la requête avant de l’envoyer au point de terminaison cible ou à la réponse reçue.
order	integer (int32)	Acheminer l’ordre de traitement.
predicates	string[]	Nombre de conditions permettant d’évaluer un itinéraire pour chaque requête. Chaque prédicat peut être évalué par rapport aux en-têtes de requête et aux valeurs de paramètre. Tous les prédicats associés à un itinéraire doivent évaluer la valeur true pour que l’itinéraire soit mis en correspondance avec la requête.
ssoEnabled	boolean	Activez la validation de l’authentification unique.
tags	string[]	Les balises de classification sont appliquées aux méthodes de la documentation OpenAPI générée.
title	string	Un titre sera appliqué aux méthodes de la documentation OpenAPI générée.
tokenRelay	boolean	Transmettre le jeton d’identité de l’utilisateur actuellement authentifié au service d’application, la valeur par défaut est « false »
uri	string	Uri complet, remplace appName.

GatewayProvisioningState

Énumération

État de la passerelle Spring Cloud.

Valeur	Description
Creating
Updating
Succeeded
Failed
Deleting

GatewayRouteConfigOpenApiProperties

Objet

Propriétés OpenAPI de la configuration de l’itinéraire spring Cloud Gateway.

Nom	Type	Description
uri	string	URI de la spécification OpenAPI.

GatewayRouteConfigProperties

Objet

Configuration de l’itinéraire d’API de la passerelle Spring Cloud

Nom	Type	Valeur par défaut	Description
appResourceId	string		ID de ressource de l’application Azure Spring Apps, obligatoire, sauf si l’itinéraire définit uri.
filters	string[]		Pour modifier la requête avant de l’envoyer au point de terminaison cible ou la réponse reçue au niveau de l’application.
openApi	GatewayRouteConfigOpenApiProperties		Propriétés OpenAPI de la configuration de l’itinéraire spring Cloud Gateway.
predicates	string[]		Nombre de conditions permettant d’évaluer un itinéraire pour chaque requête au niveau de l’application. Chaque prédicat peut être évalué par rapport aux en-têtes de requête et aux valeurs de paramètre. Tous les prédicats associés à un itinéraire doivent évaluer la valeur true pour que l’itinéraire soit mis en correspondance avec la requête.
protocol	GatewayRouteConfigProtocol	HTTP	Protocole des applications Azure Spring Apps routées.
provisioningState	GatewayProvisioningState		État de la configuration de l’itinéraire spring Cloud Gateway.
routes	GatewayApiRoute[]		Tableau d’itinéraires d’API, chaque route contient des propriétés telles que title, uri, ssoEnabled, predicates, filters.
ssoEnabled	boolean		Activez l'Sign-On unique au niveau de l’application.

GatewayRouteConfigProtocol

Énumération

Protocole des applications Azure Spring Apps routées.

Valeur	Description
HTTP
HTTPS

GatewayRouteConfigResource

Objet

Ressource de configuration de l’itinéraire spring Cloud Gateway

Nom	Type	Description
id	string	ID de ressource complet pour la ressource.
name	string	Nom de la ressource.
properties	GatewayRouteConfigProperties	Configuration de l’itinéraire d’API de la passerelle Spring Cloud
systemData	SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de la ressource.

lastModifiedByType

Énumération

Type d’identité qui a modifié la ressource pour la dernière fois.

Valeur	Description
User
Application
ManagedIdentity
Key

SystemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la modification de ressource (UTC).
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	lastModifiedByType	Type d’identité qui a modifié la ressource pour la dernière fois.