Cette page a été traduite par l'API Cloud Translation.

Documentation de référence de l'opérateur Apigee APIM pour les ressources Kubernetes

Cette page s'applique à Apigee, mais pas à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Cette page est une référence pour chaque ressource Kubernetes compatible avec l'opérateur APIM Apigee pour Kubernetes (version Preview). Sauf indication contraire, tous les champs sont obligatoires.

APIProduct

Champ	Description
`apiVersion` Type : `string`	`apim.googleapis.com/v1alpha1`
`kind` Type : `string`	`APIProduct`
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: APIProductSpec	`spec` définit l'état souhaité de l'APIProductSet.

APIProductSpec

Champ	Description
`name` Type : `string`	Nom du produit d'API.
`approvalType` Type : `string`	Indicateur qui spécifie comment les clés API sont approuvées pour accéder aux API définies par le produit d'API. Si cette option est définie sur `manual`, la clé de consommateur est générée et renvoyée sous la forme `pending`. Dans ce cas, les clés API ne fonctionneront pas tant qu'elles ne seront pas explicitement approuvées. Si la valeur est `auto`, la clé client est générée et renvoyée sous la forme `approved`. Elle peut être utilisée immédiatement.
`description` Type : `string`	Description du produit API.
`displayName` Type : `string`	Nom affiché dans l'UI ou le portail des développeurs pour les développeurs qui s'inscrivent pour accéder à l'API.
`analytics` Type: Analytics	Indique si des données analytiques doivent être collectées pour les opérations associées à ce produit.
`enforcementRefs` Type : `Array`	Tableau de ressources EnforcementRef à appliquer au produit d'API.
`attributes` Type : `Array`	Tableau d'attributs permettant d'étendre le profil du produit d'API par défaut avec des métadonnées spécifiques au client.

EnforcementRef

Champ	Description
`name` Type : `string`	Nom de la ressource cible.
`kind` Type : `string`	`APIMExtensionPolicy`
`group` Type : `string`	Le APIGroup pour l'opérateur APIM Apigee, qui est `apim.googleapis.com`.
`namespace` Type : `string`	(Facultatif) Espace de noms du référent. S'il n'est pas spécifié, l'espace de noms local est inféré.

Attribut

Champ	Description
`name` Type : `string`	Clé de l'attribut.
`value` Type : `string`	Valeur de l'attribut.

APIOperationSet

Champ	Description
`apiVersion` Type : `string`	`apim.googleapis.com/v1alpha1`
`kind` Type : `string`	`APIOperationSet`
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: APIOperationSetSpec	Définit l'état souhaité de l'APIOperationSet.

APIOperationSetSpec

Champ	Description
`quota` Type: Quota	Définition du quota.
`restOperations` Type : `Array`	Tableau de définitions RESTOperation.
`apiProductRefs` Type : `Array`	Tableau de ressources APIProductRef ou de références aux produits d'API pour lesquels les RESTOperations doivent s'appliquer.

Quota

Champ	Description
`limit` Type : `integer`	Nombre de messages de requête autorisés par application par le produit d'API pour les `interval` et `timeUnit` spécifiés.
`interval` Type : `integer`	Intervalle de temps sur lequel le nombre de messages de requête est calculé.
`timeUnit` Type : `string`	Unité de temps définie pour l'intervalle. Les valeurs valides sont `minute`, `hour`, `day` ou `month`.

RESTOperation

Champ	Description
`name` Type : `string`	Nom de l'opération REST.
`path` Type : `string`	En association avec `methods`, `path` est le chemin HTTP à faire correspondre pour un quota et/ou un produit d'API.
`methods` Type : `array`	En association avec `path`, `methods` est la liste (sous la forme `strings`) des méthodes HTTP applicables à faire correspondre pour un quota et/ou un produit d'API.

APIProductRef

Champ	Description
`name` Type : `string`	Nom de la ressource cible.
`kind` Type : `string`	`APIProduct`
`group` Type : `string`	Le APIGroup pour l'opérateur APIM Apigee, qui est `apim.googleapis.com`.
`namespace` Type : `string`	(Facultatif) Espace de noms du référent. S'il n'est pas spécifié, l'espace de noms local est inféré.

APIMExtensionPolicy

Champ	Description
`apiVersion` Type : `string`	`apim.googleapis.com/v1alpha1`
`kind` Type : `string`	APIMExtensionPolicy
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: APIMExtensionPolicySpec	Définit l'état souhaité de APIMExtensionPolicy.

APIMExtensionPolicySpec

Champ	Description
`apigeeEnv`	(Facultatif) Environnement Apigee. Si cette valeur n'est pas fournie, un nouvel environnement est créé et associé à toutes les instances disponibles. Le cas échéant, cet environnement doit être associé à toutes les instances disponibles lorsque vous utilisez un équilibreur de charge global externe.
`failOpen` Type : `boolean`	Indique si le mode fail open doit être activé ou non lorsque l'environnement d'exécution Apigee est inaccessible. Si elle est définie sur `true`, les appels à l'environnement d'exécution Apigee seront considérés comme réussis, même si l'environnement d'exécution est inaccessible.
`timeout` Type : `string`	Indique le délai avant expiration avant que les appels au runtime Apigee échouent, en secondes ou en millisecondes. Par exemple, `10s`.
`targetRef` Type: ExtensionServerRef	Identifie la passerelle Google Kubernetes Engine dans laquelle l'extension doit être installée.
`location` Type : `string`	Identifie l'emplacement Google Cloud où APIMExtensionPolicy est appliqué.

ExtensionServerRef

Champ	Description
`name` Type : `string`	Nom de la ressource cible.
`kind` Type : `string`	Spécifie le `kind` de la ressource cible, par exemple `Gateway` ou `Service`.
`group` Type : `string`	Le APIGroup pour l'opérateur APIM Apigee, qui est `apim.googleapis.com`.
`namespace` Type : `string`	(Facultatif) Espace de noms du référent. S'il n'est pas spécifié, l'espace de noms local est inféré.

ApigeeGatewayPolicy

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1alpha1
`kind` Type : `string`	ApigeeGatewayPolicy
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: ApigeeGatewayPolicySpec	Définit l'état souhaité d'ApigeeGatewayPolicy.

ApigeeGatewayPolicySpec

Champ	Description
`ref` Type: ExtensionServerRef	Fait référence au modèle APIM créé pour régir les règles appliquées à la passerelle GKE.
`targetRef` Type: ExtensionServerRef	Fait référence à la règle d'extension APIM qui doit appliquer cette règle de passerelle spécifique. Fait indirectement référence à GKE Gateway.
`serviceAccount`	(Facultatif) Spécifie le compte de service utilisé pour générer des jetons d'autorisation Google dans un proxy Apigee Pro.

ApimTemplate

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1alpha1
`kind` Type : `string`	ApimTemplate
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: ApimTemplateSpec	Définit l'état souhaité d'ApimTemplate.

ApimTemplateSpec

Champ	Description
`templates` Type : `list`	Liste des ressources ApimTemplateFlow qui spécifient les règles à exécuter dans le flux de requêtes.
`apimTemplateRule` Type: ExtensionServerRef	Spécifie la règle de modèle APIM à utiliser pour valider les règles appliquées.

ApimTemplateFlow

Champ	Description
`policies` Type: `list` ConditionalParameterReference	Liste de ressources ConditionalParameterReference qui spécifient la liste ordonnée des stratégies à exécuter dans le cadre du flux de requêtes.
`condition` Type : `string`	Spécifie les conditions d'exécution de cette ressource.

ConditionalParameterReference

Champ	Description
`condition` `Type: string`	Spécifie les conditions d'exécution de cette ressource.

ApimTemplateRule

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1alpha1
`kind` Type : `string`	ApimTemplateRule
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: ApimTemplateRuleSpec	Définit l'état souhaité de ApimTemplateRule.

ApimTemplateRuleSpec

Champ	Description
`requiredList`	Liste des règles (sous forme de `strings`) qui doivent être présentes dans ApimTemplate.
`denyList`	Liste des règles (sous forme de `strings`) qui ne doivent pas figurer dans ApimTemplate.
`allowList`	Liste des règles (sous forme de `strings`) qui peuvent être présentes dans ApimTemplate, mais qui ne sont pas obligatoires.
`override` Type : `boolean`	Force les mises à jour de la règle du modèle APIM en cas d'existence de modèles APIM utilisant la règle. Les valeurs valides sont `true` ou `false`.

JavaScript

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1alpha1
`kind` Type : `string`	JavaScript
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: JavascriptBean	Définit l'état souhaité de la règle JavaScript.

JavascriptBean

Champ	Description
`mode` Type : `array`	Tableau de `strings` qui spécifie `ProxyRequest` ou `ProxyResponse`. Détermine si la règle est associée au flux de requête ou au flux de réponse.
`source` Type : `string`	Code JavaScript intégré.
`timeLimit` Type : `integer`	Spécifie le délai avant expiration de l'exécution du code JavaScript.

SpikeArrest

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1alpha1
`kind` Type : `string`	SpikeArrest
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: SpikeArrestBean	Définit l'état souhaité de la règle SpikeArrest.

SpikeArrestBean

Champ	Description
`mode` Type : `array`	Tableau de `strings` qui spécifie `ProxyRequest` ou `ProxyResponse`. Détermine si la règle est associée au flux de requête ou au flux de réponse.
`peakMessageRate` Type: peakMessageRate	Spécifie le taux des messages pour SpikeArrest.
`useEffectiveCount` Type : `boolean`	Si la valeur est `true`true, SpikeArrest est distribué dans une région, et le décompte des requêtes est synchronisé entre les processeurs de messages (MP) Apigee d'une même région. Si la valeur est `false`, SpikeArrest utilise un algorithme token bucket localement. Pour en savoir plus, consultez UseEffectiveCount.

peakMessageRate

Champ	Description
`ref` Type : `string`	Variable faisant référence à la valeur `rate`.
`value` Type : `string`	Valeur `rate` réelle si aucune référence n'est disponible.

AssignMessage (injection de jetonGoogle )

Champ	Description
`apiVersion` Type : `string`	apim.googleapis.com/v1alpha1
`kind` Type : `string`	AssignMessage
`metadata` Type: Kubernetes meta/v1.ObjectMeta	Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs disponibles dans `metadata`.
`spec` Type: AssignMessageBean	Définit l'état souhaité de la stratégie AssignMessage.

AssignMessageBean

Champ	Description
`setActions` Type : `array`	Tableau d'objets `SetActionsBean`. Remplace les valeurs des propriétés existantes dans la requête ou la réponse, comme spécifié par l'élément `AssignTo`. Si les en-têtes ou les paramètres sont déjà présents dans le message d'origine, `setActions` écrase les valeurs. Sinon, `setActions` ajoute des en-têtes ou des paramètres comme spécifié.
`AssignTo` Type: AssignToBean	Indique le message sur lequel la stratégie AssignMessage fonctionne. Les options incluent la requête, la réponse ou un nouveau message personnalisé.

SetActionsBean

Champ	Description
`Authentication` Type: AuthenticationBean	Génère des jetons Google OAuth 2.0 ou OpenID Connect pour effectuer des appels authentifiés aux services Google ou aux services personnalisés exécutés sur certains Google Cloud produits, tels que les fonctions Cloud Run et Cloud Run.

AuthenticationBean

Champ	Description
`GoogleAccessToken` Type: GoogleAccessTokenBean	Génère des jetons Google OAuth 2.0 pour effectuer des appels authentifiés aux services Google.
`GoogleIDToken` Type: GoogleIDTokenBean	Configuration permettant de générer un jeton OpenID Connect pour authentifier la requête cible.
`headerName` Type : `string`	Par défaut, lorsqu'une configuration d'authentification est présente, Apigee génère un jeton d'authentification et l'injecte dans l'en-tête "Authorization" du message envoyé au système cible. L'élément `headerName` vous permet de spécifier le nom d'un autre en-tête pour contenir le jeton de support.

GoogleAccessTokenBean

Champ	Description
`scopes` Type : `array`	Tableau d'`strings` qui spécifie un champ d'application d'API Google valide. Pour en savoir plus, consultez la section Champs d'application OAuth 2.0 pour les API Google.
`LifetimeInSeconds` Type : `integer`	Spécifie la durée de vie du jeton d'accès en secondes.

GoogleIDTokenBean

Champ	Description
`Audience` Type: AudienceBean	Audience du jeton d'authentification généré, comme l'API ou le compte de service auquel le jeton accorde l'accès.
`IncludeEmail` Type : `boolean`	Si ce champ est défini sur `true`, le jeton d'authentification généré contient les revendications du compte de service `email` et `email_verified`.

AudienceBean

Champ	Description
`useTargetHost` Type : `string`	Si la valeur de `Audience` est vide ou si la variable `ref` ne correspond pas à une valeur valide et que `useTargetUrl` est `true`, l'URL de la cible (sans les paramètres de requête) est utilisée comme audience.
`useTargetUrl` Type : `boolean`	La valeur par défaut de `useTargetUrl` est `false`.

AssignToBean

Champ	Description
`createNew` Type : `boolean`	Détermine si la règle crée un message lors de l'attribution de valeurs. S'il est défini sur `true`, la règle crée un message.
`type` Type : `string`	Spécifie le type du nouveau message, lorsque `CreateNew` est défini sur `true` true. Les valeurs valides sont request (requête) ou response (réponse).