Gateway Route Configs - Create Or Update

Служба:: Azure Spring Apps

Версия API:: 2023-12-01

Создайте конфигурации маршрутов шлюза Spring Cloud по умолчанию или обновите существующие конфигурации маршрутов Шлюза Spring Cloud.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
gatewayName	path	True	string pattern: ^[a-z][a-z0-9]*$	Имя Spring Cloud Gateway.
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
routeConfigName	path	True	string	Имя конфигурации маршрута Spring Cloud Gateway.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Имя ресурса службы.
subscriptionId	path	True	string	Получает идентификатор подписки, однозначно определяющий подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Тип	Описание
properties	GatewayRouteConfigProperties	Настройка маршрута API для шлюза Spring Cloud

Ответы

Имя	Тип	Описание
200 OK	GatewayRouteConfigResource	Успех. В ответе описываются обновленные конфигурации маршрутов Шлюза Spring Cloud.
201 Created	GatewayRouteConfigResource	Созданный. Ответ описывает новые созданные конфигурации маршрутов Шлюза Spring Cloud и содержит заголовок Azure-AsyncOperation для запроса результата операции.
Other Status Codes	CloudError	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

GatewayRouteConfigs_CreateOrUpdate

Образец запроса

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


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

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

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

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

Пример ответа

Код состояния:: 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"
}

Код состояния:: 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"
}

Определения

Имя	Описание
CloudError	Ответ на ошибку службы.
CloudErrorBody	Ответ на ошибку службы.
createdByType	Тип удостоверения, создавшего ресурс.
GatewayApiRoute	Настройка маршрута API для шлюза Spring Cloud
GatewayProvisioningState	Состояние шлюза Spring Cloud.
GatewayRouteConfigOpenApiProperties	Свойства OpenAPI конфигурации маршрута Spring Cloud Gateway.
GatewayRouteConfigProperties	Настройка маршрута API для шлюза Spring Cloud
GatewayRouteConfigProtocol	Протокол перенаправленных приложений Azure Spring Apps.
GatewayRouteConfigResource	Ресурс конфигурации маршрута Шлюза Spring Cloud
lastModifiedByType	Тип удостоверения, который последний раз изменил ресурс.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

CloudError

Объект

Ответ на ошибку службы.

Имя	Тип	Описание
error	CloudErrorBody	Ответ на ошибку службы.

CloudErrorBody

Объект

Ответ на ошибку службы.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение, описывающее ошибку, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

GatewayApiRoute

Объект

Настройка маршрута API для шлюза Spring Cloud

Имя	Тип	Описание
description	string	Описание будет применено к методам в созданной документации OpenAPI.
filters	string[]	Чтобы изменить запрос перед отправкой его в целевую конечную точку или полученный ответ.
order	integer (int32)	Порядок обработки маршрутов.
predicates	string[]	Ряд условий для оценки маршрута для каждого запроса. Каждый предикат может оцениваться по заголовкам запросов и значениям параметров. Все предикаты, связанные с маршрутом, должны иметь значение true, чтобы маршрут соответствовал запросу.
ssoEnabled	boolean	Включите проверку единого входа.
tags	string[]	Теги классификации будут применяться к методам в созданной документации OpenAPI.
title	string	Заголовок будет применен к методам в созданной документации OpenAPI.
tokenRelay	boolean	Передача маркера удостоверения пользователя, прошедшего проверку подлинности, в службу приложений по умолчанию — false.
uri	string	Полный универсальный код ресурса (URI) переопределяет `appName`.

GatewayProvisioningState

Перечисление

Состояние шлюза Spring Cloud.

Значение	Описание
Creating
Updating
Succeeded
Failed
Deleting

GatewayRouteConfigOpenApiProperties

Объект

Свойства OpenAPI конфигурации маршрута Spring Cloud Gateway.

Имя	Тип	Описание
uri	string	URI спецификации OpenAPI.

GatewayRouteConfigProperties

Объект

Настройка маршрута API для шлюза Spring Cloud

Имя	Тип	Default value	Описание
appResourceId	string		Идентификатор ресурса приложения Azure Spring Apps, обязательный, если маршрут не определяет `uri`.
filters	string[]		Чтобы изменить запрос перед отправкой в целевую конечную точку или полученный ответ на уровне приложения.
openApi	GatewayRouteConfigOpenApiProperties		Свойства OpenAPI конфигурации маршрута Spring Cloud Gateway.
predicates	string[]		Ряд условий для оценки маршрута для каждого запроса на уровне приложения. Каждый предикат может оцениваться по заголовкам запросов и значениям параметров. Все предикаты, связанные с маршрутом, должны иметь значение true, чтобы маршрут соответствовал запросу.
protocol	GatewayRouteConfigProtocol	HTTP	Протокол перенаправленных приложений Azure Spring Apps.
provisioningState	GatewayProvisioningState		Состояние конфигурации маршрута Шлюза Spring Cloud.
routes	GatewayApiRoute[]		Массив маршрутов API, каждый маршрут содержит такие свойства, как `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.
ssoEnabled	boolean		Включите один Sign-On на уровне приложения.

GatewayRouteConfigProtocol

Перечисление

Протокол перенаправленных приложений Azure Spring Apps.

Значение	Описание
HTTP
HTTPS

GatewayRouteConfigResource

Объект

Ресурс конфигурации маршрута Шлюза Spring Cloud

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса.
name	string	Имя ресурса.
properties	GatewayRouteConfigProperties	Настройка маршрута API для шлюза Spring Cloud
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса.

lastModifiedByType

Перечисление

Тип удостоверения, который последний раз изменил ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

SystemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени изменения ресурса (UTC).
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	lastModifiedByType	Тип удостоверения, который последний раз изменил ресурс.

Поделиться через

Gateway Route Configs - Create Or Update

Параметры URI

Текст запроса

Ответы

Безопасность

azure_auth

Области

Примеры

GatewayRouteConfigs_CreateOrUpdate

Образец запроса

Пример ответа

Определения

CloudError

CloudErrorBody

createdByType

GatewayApiRoute

GatewayProvisioningState

GatewayRouteConfigOpenApiProperties

GatewayRouteConfigProperties

GatewayRouteConfigProtocol

GatewayRouteConfigResource

lastModifiedByType

SystemData