Gateway Route Configs - Get

Servicio:: Azure Spring Apps

Versión de la API:: 2023-12-01

Obtenga las configuraciones de ruta de Spring Cloud Gateway.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
gatewayName	path	True	string pattern: ^[a-z][a-z0-9]*$	Nombre de Spring Cloud Gateway.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor desde la API de Azure Resource Manager o el portal.
routeConfigName	path	True	string	Nombre de la configuración de ruta de Spring Cloud Gateway.
serviceName	path	True	string pattern: ^[a-z][a-z0-9-]*[a-z0-9]$	Nombre del recurso de servicio.
subscriptionId	path	True	string	Obtiene el identificador de suscripción que identifica de forma única la suscripción de Microsoft Azure. El identificador de suscripción forma parte del URI de cada llamada de servicio.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	GatewayRouteConfigResource	Éxito. La respuesta describe las configuraciones de ruta de Spring Cloud Gateway correspondientes.
Other Status Codes	CloudError	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

GatewayRouteConfigs_Get

Solicitud de ejemplo

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


/**
 * Samples for GatewayRouteConfigs Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/
     * GatewayRouteConfigs_Get.json
     */
    /**
     * Sample code: GatewayRouteConfigs_Get.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void gatewayRouteConfigsGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.springServices().manager().serviceClient().getGatewayRouteConfigs().getWithResponse("myResourceGroup",
            "myservice", "default", "myRouteConfig", 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_get.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.get(
        resource_group_name="myResourceGroup",
        service_name="myservice",
        gateway_name="default",
        route_config_name="myRouteConfig",
    )
    print(response)


# x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_Get.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/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_Get.json
func ExampleGatewayRouteConfigsClient_Get() {
	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)
	}
	res, err := clientFactory.NewGatewayRouteConfigsClient().Get(ctx, "myResourceGroup", "myservice", "default", "myRouteConfig", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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 Get the Spring Cloud Gateway route configs.
 *
 * @summary Get the Spring Cloud Gateway route configs.
 * x-ms-original-file: specification/appplatform/resource-manager/Microsoft.AppPlatform/stable/2023-12-01/examples/GatewayRouteConfigs_Get.json
 */
async function gatewayRouteConfigsGet() {
  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 credential = new DefaultAzureCredential();
  const client = new AppPlatformManagementClient(credential, subscriptionId);
  const result = await client.gatewayRouteConfigs.get(
    resourceGroupName,
    serviceName,
    gatewayName,
    routeConfigName,
  );
  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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
CloudError	Respuesta de error del servicio.
CloudErrorBody	Respuesta de error del servicio.
createdByType	Tipo de identidad que creó el recurso.
GatewayApiRoute	Configuración de ruta de API de Spring Cloud Gateway
GatewayProvisioningState	Estado de Spring Cloud Gateway.
GatewayRouteConfigOpenApiProperties	Propiedades de OpenAPI de la configuración de ruta de Spring Cloud Gateway.
GatewayRouteConfigProperties	Configuración de ruta de API de Spring Cloud Gateway
GatewayRouteConfigProtocol	Protocolo de aplicaciones de Azure Spring Apps enrutadas.
GatewayRouteConfigResource	Recurso de configuración de rutas de Spring Cloud Gateway
lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.
SystemData	Metadatos relativos a la creación y última modificación del recurso.

CloudError

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
error	CloudErrorBody	Respuesta de error del servicio.

CloudErrorBody

Object

Respuesta de error del servicio.

Nombre	Tipo	Description
code	string	Identificador del error. Los códigos son invariables y están diseñados para consumirse mediante programación.
details	CloudErrorBody[]	Lista de detalles adicionales sobre el error.
message	string	Mensaje que describe el error, diseñado para ser adecuado para mostrarse en una interfaz de usuario.
target	string	Destino del error concreto. Por ejemplo, el nombre de la propiedad en error.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

GatewayApiRoute

Object

Configuración de ruta de API de Spring Cloud Gateway

Nombre	Tipo	Description
description	string	Una descripción se aplicará a los métodos de la documentación de OpenAPI generada.
filters	string[]	Para modificar la solicitud antes de enviarlo al punto de conexión de destino o la respuesta recibida.
order	integer (int32)	Orden de procesamiento de rutas.
predicates	string[]	Varias condiciones para evaluar una ruta para cada solicitud. Cada predicado se puede evaluar con los encabezados de solicitud y los valores de parámetro. Todos los predicados asociados a una ruta deben evaluarse como true para que la ruta coincida con la solicitud.
ssoEnabled	boolean	Habilite la validación de sso.
tags	string[]	Las etiquetas de clasificación se aplicarán a los métodos de la documentación de OpenAPI generada.
title	string	Un título se aplicará a los métodos de la documentación de OpenAPI generada.
tokenRelay	boolean	Pasar el token de identidad del usuario autenticado actualmente al servicio de aplicación, el valor predeterminado es "false"
uri	string	El URI completo invalidará `appName`.

GatewayProvisioningState

Enumeración

Estado de Spring Cloud Gateway.

Valor	Description
Creating
Deleting
Failed
Succeeded
Updating

GatewayRouteConfigOpenApiProperties

Object

Propiedades de OpenAPI de la configuración de ruta de Spring Cloud Gateway.

Nombre	Tipo	Description
uri	string	Identificador URI de la especificación openAPI.

GatewayRouteConfigProperties

Object

Configuración de ruta de API de Spring Cloud Gateway

Nombre	Tipo	Valor predeterminado	Description
appResourceId	string		Identificador de recurso de la aplicación Azure Spring Apps, necesario a menos que la ruta defina `uri`.
filters	string[]		Para modificar la solicitud antes de enviarlo al punto de conexión de destino o la respuesta recibida en el nivel de aplicación.
openApi	GatewayRouteConfigOpenApiProperties		Propiedades de OpenAPI de la configuración de ruta de Spring Cloud Gateway.
predicates	string[]		Número de condiciones para evaluar una ruta para cada solicitud en el nivel de aplicación. Cada predicado se puede evaluar con los encabezados de solicitud y los valores de parámetro. Todos los predicados asociados a una ruta deben evaluarse como true para que la ruta coincida con la solicitud.
protocol	GatewayRouteConfigProtocol	HTTP	Protocolo de aplicaciones de Azure Spring Apps enrutadas.
provisioningState	GatewayProvisioningState		Estado de la configuración de ruta de Spring Cloud Gateway.
routes	GatewayApiRoute[]		Matriz de rutas de API, cada ruta contiene propiedades como `title`, `uri`, `ssoEnabled`, `predicates`, `filters`.
ssoEnabled	boolean		Habilite single Sign-On en el nivel de aplicación.

GatewayRouteConfigProtocol

Enumeración

Protocolo de aplicaciones de Azure Spring Apps enrutadas.

Valor	Description
HTTP
HTTPS

GatewayRouteConfigResource

Object

Recurso de configuración de rutas de Spring Cloud Gateway

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso.
name	string	Nombre del recurso.
properties	GatewayRouteConfigProperties	Configuración de ruta de API de Spring Cloud Gateway
systemData	SystemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo del recurso.

lastModifiedByType

Enumeración

Tipo de identidad que modificó por última vez el recurso.

Valor	Description
Application
Key
ManagedIdentity
User

SystemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de modificación de recursos (UTC).
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	lastModifiedByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Gateway Route Configs - Get

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

GatewayRouteConfigs_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorBody

createdByType

GatewayApiRoute

GatewayProvisioningState

GatewayRouteConfigOpenApiProperties

GatewayRouteConfigProperties

GatewayRouteConfigProtocol

GatewayRouteConfigResource

lastModifiedByType

SystemData