Partager via

Microsoft.AppPlatform Spring/gateways/routeConfigs 2023-07-01-preview

  • Article

Définition de ressource Bicep

Le type de ressource Spring/gateways/routeConfigs peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.AppPlatform/Spring/gateways/routeConfigs, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.AppPlatform/Spring/gateways/routeConfigs@2023-07-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    appResourceId: 'string'
    filters: [
      'string'
    ]
    openApi: {
      uri: 'string'
    }
    predicates: [
      'string'
    ]
    protocol: 'string'
    routes: [
      {
        description: 'string'
        filters: [
          'string'
        ]
        order: int
        predicates: [
          'string'
        ]
        ssoEnabled: bool
        tags: [
          'string'
        ]
        title: 'string'
        tokenRelay: bool
        uri: 'string'
      }
    ]
    ssoEnabled: bool
  }
}

Valeurs de propriété

GatewayApiRoute

Nom Description Valeur
description Une description sera appliquée aux méthodes de la documentation OpenAPI générée. corde
Filtres Pour modifier la requête avant de l’envoyer au point de terminaison cible ou à la réponse reçue. string[]
commande Acheminer l’ordre de traitement. Int
Prédicats 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. string[]
ssoEnabled Activez la validation de l’authentification unique. Bool
étiquettes Les balises de classification sont appliquées aux méthodes de la documentation OpenAPI générée. string[]
titre Un titre sera appliqué aux méthodes de la documentation OpenAPI générée. corde
tokenRelay Transmettre le jeton d’identité de l’utilisateur actuellement authentifié au service d’application, la valeur par défaut est « false » Bool
URI Uri complet, remplace appName. corde

GatewayRouteConfigOpenApiProperties

Nom Description Valeur
URI URI de la spécification OpenAPI. corde

GatewayRouteConfigProperties

Nom Description Valeur
appResourceId ID de ressource de l’application Azure Spring Apps, obligatoire, sauf si l’itinéraire définit uri. corde
Filtres 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. string[]
openApi Propriétés OpenAPI de la configuration de l’itinéraire spring Cloud Gateway. GatewayRouteConfigOpenApiProperties
Prédicats 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. string[]
protocole Protocole des applications Azure Spring Apps routées. 'HTTP'
'HTTPS'
itinéraires Tableau d’itinéraires d’API, chaque route contient des propriétés telles que title, uri, ssoEnabled, predicates, filters. gatewayApiRoute[]
ssoEnabled Activez l'Sign-On unique au niveau de l’application. Bool

Microsoft.AppPlatform/Spring/gateways/routeConfigs

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : Spring/gateways
Propriétés Configuration de l’itinéraire d’API de la passerelle Spring Cloud GatewayRouteConfigProperties

Définition de ressource de modèle ARM

Le type de ressource Spring/gateways/routeConfigs peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.AppPlatform/Spring/gateways/routeConfigs, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.AppPlatform/Spring/gateways/routeConfigs",
  "apiVersion": "2023-07-01-preview",
  "name": "string",
  "properties": {
    "appResourceId": "string",
    "filters": [ "string" ],
    "openApi": {
      "uri": "string"
    },
    "predicates": [ "string" ],
    "protocol": "string",
    "routes": [
      {
        "description": "string",
        "filters": [ "string" ],
        "order": "int",
        "predicates": [ "string" ],
        "ssoEnabled": "bool",
        "tags": [ "string" ],
        "title": "string",
        "tokenRelay": "bool",
        "uri": "string"
      }
    ],
    "ssoEnabled": "bool"
  }
}

Valeurs de propriété

GatewayApiRoute

Nom Description Valeur
description Une description sera appliquée aux méthodes de la documentation OpenAPI générée. corde
Filtres Pour modifier la requête avant de l’envoyer au point de terminaison cible ou à la réponse reçue. string[]
commande Acheminer l’ordre de traitement. Int
Prédicats 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. string[]
ssoEnabled Activez la validation de l’authentification unique. Bool
étiquettes Les balises de classification sont appliquées aux méthodes de la documentation OpenAPI générée. string[]
titre Un titre sera appliqué aux méthodes de la documentation OpenAPI générée. corde
tokenRelay Transmettre le jeton d’identité de l’utilisateur actuellement authentifié au service d’application, la valeur par défaut est « false » Bool
URI Uri complet, remplace appName. corde

GatewayRouteConfigOpenApiProperties

Nom Description Valeur
URI URI de la spécification OpenAPI. corde

GatewayRouteConfigProperties

Nom Description Valeur
appResourceId ID de ressource de l’application Azure Spring Apps, obligatoire, sauf si l’itinéraire définit uri. corde
Filtres 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. string[]
openApi Propriétés OpenAPI de la configuration de l’itinéraire spring Cloud Gateway. GatewayRouteConfigOpenApiProperties
Prédicats 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. string[]
protocole Protocole des applications Azure Spring Apps routées. 'HTTP'
'HTTPS'
itinéraires Tableau d’itinéraires d’API, chaque route contient des propriétés telles que title, uri, ssoEnabled, predicates, filters. gatewayApiRoute[]
ssoEnabled Activez l'Sign-On unique au niveau de l’application. Bool

Microsoft.AppPlatform/Spring/gateways/routeConfigs

Nom Description Valeur
apiVersion Version de l’API '2023-07-01-preview'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Configuration de l’itinéraire d’API de la passerelle Spring Cloud GatewayRouteConfigProperties
type Type de ressource 'Microsoft.AppPlatform/Spring/gateways/routeConfigs'

Exemples d’utilisation

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource Spring/gateways/routeConfigs peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.AppPlatform/Spring/gateways/routeConfigs, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/gateways/routeConfigs@2023-07-01-preview"
  name = "string"
  body = {
    properties = {
      appResourceId = "string"
      filters = [
        "string"
      ]
      openApi = {
        uri = "string"
      }
      predicates = [
        "string"
      ]
      protocol = "string"
      routes = [
        {
          description = "string"
          filters = [
            "string"
          ]
          order = int
          predicates = [
            "string"
          ]
          ssoEnabled = bool
          tags = [
            "string"
          ]
          title = "string"
          tokenRelay = bool
          uri = "string"
        }
      ]
      ssoEnabled = bool
    }
  }
}

Valeurs de propriété

GatewayApiRoute

Nom Description Valeur
description Une description sera appliquée aux méthodes de la documentation OpenAPI générée. corde
Filtres Pour modifier la requête avant de l’envoyer au point de terminaison cible ou à la réponse reçue. string[]
commande Acheminer l’ordre de traitement. Int
Prédicats 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. string[]
ssoEnabled Activez la validation de l’authentification unique. Bool
étiquettes Les balises de classification sont appliquées aux méthodes de la documentation OpenAPI générée. string[]
titre Un titre sera appliqué aux méthodes de la documentation OpenAPI générée. corde
tokenRelay Transmettre le jeton d’identité de l’utilisateur actuellement authentifié au service d’application, la valeur par défaut est « false » Bool
URI Uri complet, remplace appName. corde

GatewayRouteConfigOpenApiProperties

Nom Description Valeur
URI URI de la spécification OpenAPI. corde

GatewayRouteConfigProperties

Nom Description Valeur
appResourceId ID de ressource de l’application Azure Spring Apps, obligatoire, sauf si l’itinéraire définit uri. corde
Filtres 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. string[]
openApi Propriétés OpenAPI de la configuration de l’itinéraire spring Cloud Gateway. GatewayRouteConfigOpenApiProperties
Prédicats 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. string[]
protocole Protocole des applications Azure Spring Apps routées. 'HTTP'
'HTTPS'
itinéraires Tableau d’itinéraires d’API, chaque route contient des propriétés telles que title, uri, ssoEnabled, predicates, filters. gatewayApiRoute[]
ssoEnabled Activez l'Sign-On unique au niveau de l’application. Bool

Microsoft.AppPlatform/Spring/gateways/routeConfigs

Nom Description Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : Spring/gateways
Propriétés Configuration de l’itinéraire d’API de la passerelle Spring Cloud GatewayRouteConfigProperties
type Type de ressource « Microsoft.AppPlatform/Spring/gateways/routeConfigs@2023-07-01-preview »