Gateway Route Configs - Create Or Update

Service:

Azure Spring Apps

API-versie:

2023-12-01

Maak de standaardconfiguraties van de Spring Cloud Gateway-route of werk de bestaande Configuraties van de Spring Cloud Gateway-route bij.

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

URI-parameters

Name	In	Vereist	Type	Description
gatewayName	path	True	string pattern: ^[a-z][a-z0-9]*$	De naam van Spring Cloud Gateway.
resourceGroupName	path	True	string	De naam van de resourcegroep die de resource bevat. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
routeConfigName	path	True	string	De naam van de configuratie van de Spring Cloud Gateway-route.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	De naam van de serviceresource.
subscriptionId	path	True	string	Hiermee haalt u de abonnements-id op waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties	GatewayRouteConfigProperties	API-routeconfiguratie van de Spring Cloud Gateway

Antwoorden

Name	Type	Description
200 OK	GatewayRouteConfigResource	Succes. In het antwoord worden de bijgewerkte configuraties van de Spring Cloud Gateway-route beschreven.
201 Created	GatewayRouteConfigResource	Geschapen. In het antwoord worden de configuraties van de nieuwe Spring Cloud Gateway-route beschreven en bevat een Azure-AsyncOperation header om het bewerkingsresultaat op te vragen.
Other Status Codes	CloudError	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

GatewayRouteConfigs_CreateOrUpdate

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Definities

Name	Description
CloudError	Een foutreactie van de service.
CloudErrorBody	Een foutreactie van de service.
createdByType	Het type identiteit waarmee de resource is gemaakt.
GatewayApiRoute	API-routeconfiguratie van de Spring Cloud Gateway
GatewayProvisioningState	Status van de Spring Cloud-gateway.
GatewayRouteConfigOpenApiProperties	OpenAPI-eigenschappen van de routeconfiguratie van Spring Cloud Gateway.
GatewayRouteConfigProperties	API-routeconfiguratie van de Spring Cloud Gateway
GatewayRouteConfigProtocol	Protocol van gerouteerde Azure Spring Apps-toepassingen.
GatewayRouteConfigResource	Configuratieresource voor Spring Cloud Gateway-route
lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.
SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

CloudError

Object

Een foutreactie van de service.

Name	Type	Description
error	CloudErrorBody	Een foutreactie van de service.

CloudErrorBody

Object

Een foutreactie van de service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	CloudErrorBody[]	Een lijst met aanvullende informatie over de fout.
message	string	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target	string	Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

GatewayApiRoute

Object

API-routeconfiguratie van de Spring Cloud Gateway

Name	Type	Description
description	string	Een beschrijving wordt toegepast op methoden in de gegenereerde OpenAPI-documentatie.
filters	string[]	Als u de aanvraag wilt wijzigen voordat u deze verzendt naar het doeleindpunt of het ontvangen antwoord.
order	integer (int32)	Routeverwerkingsorder.
predicates	string[]	Een aantal voorwaarden om een route voor elke aanvraag te evalueren. Elk predicaat kan worden geëvalueerd op basis van aanvraagheaders en parameterwaarden. Alle predicaten die aan een route zijn gekoppeld, moeten waar zijn om de route te laten overeenkomen met de aanvraag.
ssoEnabled	boolean	Sso-validatie inschakelen.
tags	string[]	Classificatietags worden toegepast op methoden in de gegenereerde OpenAPI-documentatie.
title	string	Een titel wordt toegepast op methoden in de gegenereerde OpenAPI-documentatie.
tokenRelay	boolean	Pass currently-authenticated user's identity token token to application service, default is 'false'
uri	string	Volledige URI, overschrijft appName.

GatewayProvisioningState

Opsomming

Status van de Spring Cloud-gateway.

Waarde	Description
Creating
Updating
Succeeded
Failed
Deleting

GatewayRouteConfigOpenApiProperties

Object

OpenAPI-eigenschappen van de routeconfiguratie van Spring Cloud Gateway.

Name	Type	Description
uri	string	De URI van openAPI-specificatie.

GatewayRouteConfigProperties

Object

API-routeconfiguratie van de Spring Cloud Gateway

Name	Type	Default value	Description
appResourceId	string		De resource-id van de Azure Spring Apps-app, vereist, tenzij de route uridefinieert.
filters	string[]		Als u de aanvraag wilt wijzigen voordat u deze verzendt naar het doeleindpunt of het ontvangen antwoord op app-niveau.
openApi	GatewayRouteConfigOpenApiProperties		OpenAPI-eigenschappen van de routeconfiguratie van Spring Cloud Gateway.
predicates	string[]		Een aantal voorwaarden om een route te evalueren voor elke aanvraag op app-niveau. Elk predicaat kan worden geëvalueerd op basis van aanvraagheaders en parameterwaarden. Alle predicaten die aan een route zijn gekoppeld, moeten waar zijn om de route te laten overeenkomen met de aanvraag.
protocol	GatewayRouteConfigProtocol	HTTP	Protocol van gerouteerde Azure Spring Apps-toepassingen.
provisioningState	GatewayProvisioningState		Status van de configuratie van de Spring Cloud Gateway-route.
routes	GatewayApiRoute[]		Matrix van API-routes, elke route bevat eigenschappen zoals title, uri, ssoEnabled, predicates, filters.
ssoEnabled	boolean		Schakel single Sign-On in op app-niveau.

GatewayRouteConfigProtocol

Opsomming

Protocol van gerouteerde Azure Spring Apps-toepassingen.

Waarde	Description
HTTP
HTTPS

GatewayRouteConfigResource

Object

Configuratieresource voor Spring Cloud Gateway-route

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource.
name	string	De naam van de resource.
properties	GatewayRouteConfigProperties	API-routeconfiguratie van de Spring Cloud Gateway
systemData	SystemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	string	Het type resource.

lastModifiedByType

Opsomming

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

Waarde	Description
User
Application
ManagedIdentity
Key

SystemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van resourcewijziging (UTC).
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	lastModifiedByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.