Esta página se aplica à Apigee e à Apigee híbrida.
  
    Confira a documentação da 
    Apigee Edge.
  
  
      
  
Esta página é uma referência para cada recurso do Kubernetes compatível com o operador do Apigee para Kubernetes. A menos que seja indicado especificamente como "Opcional", todos os campos são obrigatórios.
APIProduct
| Campo | Descrição | 
|---|---|
apiVersion
Tipo:   | 
   apim.googleapis.com/v1
    | 
kind
Tipo:   | 
   APIProduct
    | 
metadata
 | 
   Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
    | 
spec
Tipo: APIProductSpec  | 
   spec define o estado desejado do APIProductSet.
    | 
APIProductSpec
| Campo | Descrição | 
|---|---|
name
Tipo:   | 
   O nome do produto de API. | 
approvalType
Tipo:   | 
   Flag que especifica como as chaves de API são aprovadas para acessar as APIs definidas pelo produto de API.
Se definida como manual, a chave do consumidor será gerada e retornada como pending.
Nesse caso, as chaves de API não vão funcionar até serem explicitamente aprovadas.
Se definido como   | 
description
Tipo:   | 
   Descrição do produto de API. | 
displayName
Tipo:   | 
   Nome exibido na UI ou no portal do desenvolvedor para desenvolvedores que se registram para acesso à API. | 
analytics
Tipo: Analytics  | 
   Define se as análises devem ser coletadas para operações associadas a este produto. | 
enforcementRefs
Tipo:   | 
   Matriz de recursos EnforcementRef a serem aplicados ao produto de API. | 
attributes
Tipo:   | 
   Matriz de atributos que pode ser usada para estender o perfil de produto da API padrão com metadados específicos do cliente. | 
EnforcementRef
| Campo | Descrição | 
|---|---|
name
Tipo:   | 
   O nome do recurso de destino. | 
kind
Tipo:   | 
   APIMExtensionPolicy
    | 
group
Tipo:   | 
   O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
    | 
namespace
Tipo:   | 
   (Opcional) O namespace do referenciador. Quando não especificado, o namespace local é inferido. | 
Atributo
| Campo | Descrição | 
|---|---|
name
   
   Tipo:   | 
      A chave do atributo. | 
value
   
   Tipo:   | 
      O valor do atributo. | 
APIOperationSet
| Campo | Descrição | 
|---|---|
apiVersion
Tipo:   | 
   apim.googleapis.com/v1
    | 
kind
Tipo:   | 
   APIOperationSet
    | 
metadata
 | 
   Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
    | 
spec
Tipo: APIOperationSetSpec  | 
   Define o estado desejado do APIOperationSet. | 
APIOperationSetSpec
| Campo | Descrição | 
|---|---|
quota
Tipo: Quota  | 
   Definição de cota. | 
restOperations
Tipo:   | 
   Matriz de definições de RESTOperation. | 
apiProductRefs
Tipo:   | 
   Matriz de recursos APIProductRef ou referências a produtos de API em que as RESTOperations devem ser aplicadas. | 
Cota
| Campo | Descrição | 
|---|---|
limit
Tipo:   | 
   Número de mensagens de solicitação permitidas por app pelo produto de API para o interval
      e o timeUnit especificados.
    | 
   
interval
Tipo:   | 
      Intervalo de tempo em que o número de mensagens de solicitação é calculado. | 
timeUnit
Tipo:   | 
      Unidade de tempo definida para o intervalo. Os valores válidos incluem minute, hour, day ou month.
       | 
   
RESTOperation
| Campo | Descrição | 
|---|---|
name
Tipo:   | 
   O nome da operação REST. | 
path
Tipo:   | 
   Em combinação com methods, path é o caminho HTTP a ser correspondido para uma cota e/ou para um produto de API.
    | 
  
methods
Tipo:   | 
   Em combinação com path, methods é a lista (como strings) de métodos HTTP aplicáveis para corresponder a uma cota e/ou a um produto de API.
    | 
APIProductRef
| Campo | Descrição | 
|---|---|
name
Tipo:   | 
   O nome do recurso de destino. | 
kind
   
   Tipo:   | 
      APIProduct
       | 
   
group
   
   Tipo:   | 
      O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
       | 
   
namespace
Tipo:   | 
   (Opcional) O namespace do referenciador. Quando não especificado, o namespace local é inferido. | 
APIMExtensionPolicy
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1
       | 
   
kind
   
   Tipo:   | 
      APIMExtensionPolicy | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: APIMExtensionPolicySpec  | 
      Define o estado desejado de APIMExtensionPolicy. | 
APIMExtensionPolicySpec
| Campo | Descrição | 
|---|---|
apigeeEnv
       | 
      (Opcional) Ambiente da Apigee.
       Se não for informado, um novo ambiente será criado e anexado a todas as instâncias disponíveis. Se fornecido, esse ambiente precisa ser anexado a todas as instâncias disponíveis ao usar um balanceador de carga global externo.  | 
   
failOpen
   
   Tipo:   | 
      Especifica se é necessário abrir com falha quando o ambiente de execução da Apigee não está disponível.
      Se definido como true, as chamadas para o ambiente de execução da Apigee serão tratadas como bem-sucedidas, mesmo que o ambiente de execução esteja inacessível.
       | 
   
timeout
Tipo:   | 
   Especifica o período de tempo limite, em segundos ou milissegundos, antes de as chamadas para o ambiente de execução da Apigee falharem.
   Por exemplo, 10s
    | 
   
targetRef
   Tipo: ExtensionServerRef  | 
      Identifica o gateway do Google Kubernetes Engine em que a extensão precisa ser instalada. | 
location
   
   Tipo:   | 
      Identifica o Google Cloud local em que APIMExtensionPolicy é aplicada. | 
supportedEvents
   
   Tipo:   | 
      Especifica a lista de eventos do processador de extensão enviados ao Apigee. Isso inclui o seguinte:
      
  | 
   
ExtensionServerRef
| Campo | Descrição | 
|---|---|
name
   
   Tipo:   | 
      O nome do recurso de destino. | 
kind
   
   Tipo:   | 
      Especifica o kind do recurso de destino, por exemplo, Gateway ou Service.
       | 
   
group
   
   Tipo:   | 
      O APIGroup para o operador APIM da Apigee, que é apim.googleapis.com.
       | 
   
namespace
   
   Tipo:   | 
      (Opcional) O namespace do referenciador. Quando não especificado, o namespace local é inferido. | 
ApigeeGatewayPolicy
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      ApigeeGatewayPolicy | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: ApigeeGatewayPolicySpec  | 
      Define o estado desejado de ApigeeGatewayPolicy. | 
ApigeeGatewayPolicySpec
| Campo | Descrição | 
|---|---|
refTipo: ExtensionServerRef  | 
   Refere-se ao modelo do APIM criado para reger as políticas aplicadas ao Gateway do GKE. | 
targetRef
   Tipo: ExtensionServerRef  | 
      Refere-se à política de extensão do APIM que deve aplicar essa política específica do gateway. Refere-se indiretamente ao GKE Gateway. | 
serviceAccount
       | 
      (Opcional) Especifica a conta de serviço usada para gerar tokens de autenticação Google em um proxy do Apigee ProApigee. | 
ApimTemplate
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      ApimTemplate | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: ApimTemplateSpec  | 
      Define o estado desejado de ApimTemplate. | 
ApimTemplateSpec
| Campo | Descrição | 
|---|---|
templates
   Tipo:   | 
      Uma lista de recursos ApimTemplateFlow que especificam as políticas a serem executadas no fluxo de solicitação. | 
apimTemplateRule
      Tipo: ExtensionServerRef  | 
      Especifica a regra de modelo do APIM que deve ser usada para validar as políticas aplicadas. | 
ApimTemplateFlow
| Campo | Descrição | 
|---|---|
policies
   Tipo:   | 
      Uma lista de recursos ConditionalParameterReference que especificam a lista ordenada de políticas a serem executadas como parte do fluxo de solicitação. | 
condition
      Tipo:   | 
      Especifica as condições para executar este recurso. | 
ConditionalParameterReference
| Campo | Descrição | 
|---|---|
condition
      
           | 
      Especifica as condições para executar este recurso. | 
ApimTemplateRule
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      ApimTemplateRule | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: ApimTemplateRuleSpec  | 
      Define o estado desejado de ApimTemplateRule. | 
ApimTemplateRuleSpec
| Campo | Descrição | 
|---|---|
requiredList
       | 
      A lista de políticas (como strings) que devem estar presentes no ApimTemplate.
       | 
   
denyList
       | 
      A lista de políticas (como strings) que não devem estar presentes no ApimTemplate.
       | 
   
allowList
       | 
      A lista de políticas (como strings) que podem estar presentes no ApimTemplate, mas não são obrigatórias.
       | 
   
override
      
         Tipo:   | 
      Substitui as atualizações da regra de modelo do APIM caso existam modelos do APIM que usam a regra.
      Os valores válidos são true ou false.
       | 
   
AssignMessage (injeção de tokenGoogle )
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      AssignMessage | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: AssignMessageBean  | 
      Define o estado desejado da política AssignMessage. | 
AssignMessageBean
| Campo | Descrição | 
|---|---|
setActions
   
   Tipo:   | 
      Matriz de objetos SetActionsBean. Substitui os valores das propriedades atuais na solicitação ou resposta,
      conforme especificado pelo elemento AssignTo.
   Se os cabeçalhos ou parâmetros já estiverem presentes na mensagem original, o   | 
   
AssignTo
   Tipo: AssignToBean  | 
      Especifica em que mensagem a política AssignMessage funciona. As opções incluem a solicitação, a resposta ou uma nova mensagem personalizada. | 
SetActionsBean
| Campo | Descrição | 
|---|---|
Authentication
   Tipo: AuthenticationBean  | 
      Gera tokens Google OAuth 2.0 ou OpenID Connect para fazer chamadas autenticadas para serviços Google ou personalizados em execução em determinados produtos Google Cloud , como funções do Cloud Run e o Cloud Run. | 
AuthenticationBean
| Campo | Descrição | 
|---|---|
GoogleAccessToken
   Tipo: GoogleAccessTokenBean  | 
      Gera tokens do Google OAuth 2.0 para fazer chamadas autenticadas aos serviços do Google. | 
GoogleIDToken
   Tipo: GoogleIDTokenBean  | 
      Configuração para gerar um token do OpenID Connect e autenticar a solicitação de destino. | 
headerName
   
   Tipo:   | 
      Por padrão, quando uma configuração de autenticação está presente, a Apigee gera
      um token do portador e o injeta no cabeçalho de autorização da mensagem enviada ao sistema de destino.
      O elemento headerName permite especificar o nome de um cabeçalho diferente
         para armazenar o token do portador.
       | 
   
GoogleAccessTokenBean
| Campo | Descrição | 
|---|---|
scopes
   
   Tipo:   | 
      Matriz de strings que especifica um escopo válido de API do Google. Para mais informações, consulte Escopos do OAuth 2.0 para APIs do Google.
       | 
   
LifetimeInSeconds
   
   Tipo:   | 
      Especifica a duração do token de acesso em segundos. | 
GoogleIDTokenBean
| Campo | Descrição | 
|---|---|
Audience
   Tipo: AudienceBean  | 
      O público-alvo do token de autenticação gerado, como a API ou a conta de serviço a que o token concede acesso. | 
IncludeEmail
   
   Tipo:   | 
      Se definido como true, o token de autenticação gerado vai conter as declarações email e email_verified da conta de serviço.
       | 
   
AudienceBean
| Campo | Descrição | 
|---|---|
useTargetHost
      
      Tipo:   | 
         Se o valor de Audience estiver vazio ou a variável ref não for resolvida como um valor válido e useTargetUrl for true, o URL de destino (excluindo qualquer parâmetro de consulta) será usado como público-alvo.
             | 
         
useTargetUrl
         
         Tipo:   | 
            Por padrão, useTargetUrl é false.
             | 
         
AssignToBean
| Campo | Descrição | 
|---|---|
createNew
   
   Tipo:   | 
      Determina se a política cria uma nova mensagem ao atribuir valores. Se definida como true, a política vai criar uma nova mensagem.
       | 
   
type
   
   Tipo:   | 
      Especifica o tipo da nova mensagem, quando CreateNew é definido como true true.
      Os valores válidos são request ou response.
       | 
   
JavaScript
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      JavaScript | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: JavascriptBean  | 
      Define o estado desejado da política de JavaScript. | 
JavascriptBean
| Campo | Descrição | 
|---|---|
mode
   
   Tipo:   | 
      Matriz de strings que especifica ProxyRequest ou ProxyResponse. Determina se a política está
      anexada ao fluxo de solicitação ou de resposta.
       | 
   
source
   
   Tipo:   | 
      Código JavaScript inline. | 
timeLimit
   
   Tipo:   | 
      Especifica o tempo limite para a execução do código JavaScript. | 
KVM
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      KVM | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
    | 
      Define o estado desejado da política de KVM. | 
KeyValueMapOperationsBean
| Campo | Descrição | 
|---|---|
MapName
   
   Tipo:   | 
      Permite que a política identifique qual KVM usar dinamicamente, no ambiente de execução. Para mais informações, consulte Elemento MapName. | 
expiryTimeInSecs
   
   Tipo:   | 
      Especifica a duração em segundos após a Apigee atualizar o valor em cache do KVM especificado. Para mais informações, consulte Elemento ExpiryTimeInSecs. | 
initialEntries
   
   Tipo:   | 
      Valores de semente para KVMs, que são preenchidas no KVM quando ele é inicializado. Para mais informações, consulte Elemento InitialEntries. | 
delete
   
   Tipo:   | 
      Exclui o par de chave-valor especificado da KVM. Para mais informações, consulte Excluir elemento. | 
get
   
   Tipo:   | 
      Recupera o valor de uma chave da KVM. Para mais informações, consulte Elemento Get. | 
OASValidation
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      OASValidation | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: OASValidationBean  | 
      Define o estado desejado da política OASValidation. | 
status
   Tipo: ApimResourceStatus  | 
      Mostra o status da política OASValidation. | 
OASValidationBean
| Campo | Descrição | 
|---|---|
openApiSpec
   
   Tipo:   | 
      Especifica a especificação OpenAPI em yaml a ser validada. Como este é um fragmento
         yaml de várias linhas, use o delimitador "|". | 
   
source
   
   Tipo:   | 
      Um de message, request ou response. Quando definido como request,
         ele avalia as solicitações recebidas de apps clientes. Quando definido como response, ele
         avalia as respostas dos servidores de destino. Quando definido como message, ele avalia automaticamente a solicitação
         ou a resposta, dependendo se a política está anexada ao fluxo de solicitação ou de resposta. | 
   
options
   
   Tipo:   | 
      Consulte OASValidationOptions/td> | 
OASValidationOptions
| Campo | Descrição | 
|---|---|
validateMessageBody
   
   Tipo:   | 
      Especifica se a política deve validar o corpo da mensagem com o esquema de corpo da solicitação da operação na especificação OpenAPI. Defina como true para validar o conteúdo do corpo da mensagem. Defina como false para validar apenas que o corpo da mensagem existe. | 
   
allowUnspecifiedParameters
   
   Tipo:   | 
      Consulte StrictOptions. | 
StrictOptions
| Campo | Descrição | 
|---|---|
header
   
   Tipo:   | 
      Para permitir que os parâmetros de cabeçalho sejam especificados na solicitação que não esteja definida na especificação OpenAPI, defina esse parâmetro como true.
         Caso contrário, defina esse parâmetro como false para que a execução da política falhe. | 
   
query
   
   Tipo:   | 
      Para permitir que os parâmetros de consulta sejam especificados na solicitação que não estão definidos na especificação OpenAPI, defina esse parâmetro como true. Caso contrário, defina esse parâmetro como false
         para que a execução da política falhe. | 
   
cookie
   
   Tipo:   | 
      Para permitir que parâmetros de cookie sejam especificados em uma solicitação não definida na especificação OpenAPI,
         configure esse parâmetro como true. Caso contrário, defina esse parâmetro como false para que a execução da política falhe. | 
   
ApimResourceStatus
| Campo | Descrição | 
|---|---|
currentState
   
   Tipo:   | 
      Mostra o estado atual do recurso:
        
  | 
   
errorMessage
   
   Tipo:   | 
      Mensagem de erro relacionada a um dos estados de falha do campo currentState. | 
   
operationResult
   
   Tipo:   | 
      Uma string de resposta de uma das operações de longa duração relacionadas à criação, atualização ou exclusão de recursos. | 
ServiceCallout
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      ServiceCallout | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: ServiceCalloutBean  | 
      Define o estado desejado da política ServiceCallout. | 
status
   Tipo: ApimResourceStatus  | 
      Mostra o status da política ServiceCallout. | 
ServiceCalloutBean
| Campo | Descrição | 
|---|---|
httpTargetConnection
   
   Tipo:   | 
      Fornece detalhes de transporte, como propriedades URL, TLS/SSL e HTTP. | 
request
   Tipo: CalloutRequest  | 
      Especifica a variável que contém a mensagem de solicitação enviada do proxy de API para o outro serviço. | 
Response
   Tipo:   | 
      Especifica a variável que contém a mensagem de resposta retornada ao proxy de API do serviço externo. | 
HttpTargetConnection
| Campo | Descrição | 
|---|---|
url
   
   Tipo:   | 
      O URL do serviço de destino. | 
properties
   
   Tipo:   | 
      Propriedades de transporte HTTP para o serviço de back-end. Para mais informações, consulte Referência de propriedades do endpoint. | 
timeout
   
   Tipo:   | 
      O tempo limite em milissegundos para a chamada de serviço. Para mais informações, consulte timeout. | 
CalloutRequest
| Campo | Descrição | 
|---|---|
url
   
   Tipo:   | 
      O URL do serviço de destino. | 
properties
   
   Tipo:   | 
      Propriedades de transporte HTTP para o serviço de back-end. Para mais informações, consulte Referência de propriedades do endpoint. | 
SpikeArrest
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      SpikeArrest | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: SpikeArrestBean  | 
      Define o estado desejado da política SpikeArrest. | 
SpikeArrestBean
| Campo | Descrição | 
|---|---|
mode
   
   Tipo:   | 
      Matriz de strings que especifica ProxyRequest ou ProxyResponse. Determina se a política está
      anexada ao fluxo de solicitação ou de resposta.
       | 
   
peakMessageRate
   Tipo: peakMessageRate  | 
      Especifica a taxa de mensagens para a Detenção de pico. | 
useEffectiveCount
   
   Tipo:   | 
      Se definida como truetrue, a SpikeArrest será distribuída em uma região, com
      contagens de solicitações sincronizadas entre os processadores de mensagens (MPs) da Apigee em uma região.
   Se definida como   | 
   
peakMessageRate
| Campo | Descrição | 
|---|---|
ref
   
   Tipo:   | 
      Variável que faz referência ao valor rate.
       | 
   
value
   
   Tipo:   | 
      Valor rate real se uma referência não estiver disponível.
       | 
   
GenerateJWT
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      GenerateJWT | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: GenerateJWTBean  | 
      Define o estado desejado da política GenerateJWT. | 
status
   Tipo: ApimResourceStatus  | 
      Mostra o status da política GenerateJWT. | 
GenerateJWTBean
| Campo | Descrição | 
|---|---|
subject
   Tipo: PropertyBean  | 
      Identifica o principal que é o assunto do JWT. Para mais informações, consulte Elemento de assunto. | 
issuer
   Tipo: PropertyBean  | 
      Identifica o principal que emitiu o JWT. Para mais informações, consulte Elemento do emissor. | 
audience
   Tipo: VarArrayBean  | 
      Identifica os destinatários para quem o JWT é destinado. Para mais informações, consulte Elemento de público-alvo. | 
id
   Tipo: PropertyBean  | 
      Especifica um identificador exclusivo para o JWT. Para mais informações, consulte Elemento de ID. | 
expiresIn
   Tipo: PropertyBean  | 
      Especifica o tempo de expiração do JWT. Para mais informações, consulte Elemento ExpiresIn. | 
notBefore
   Tipo: PropertyBean  | 
      Identifica o momento antes do qual o JWT não pode ser aceito para processamento. Para mais informações, consulte o elemento NotBefore. | 
additionalClaims
   Tipo: AdditionalClaimsBean  | 
      Especifica outras declarações a serem incluídas no JWT. Para mais informações, consulte o elemento AdditionalClaims. | 
compress
   
   Tipo:   | 
      Especifica se é necessário compactar o payload do JWT. Para mais informações, consulte Compactar elemento. | 
PropertyBean
| Campo | Descrição | 
|---|---|
value
   
   Tipo:   | 
      O valor literal da propriedade. | 
ref
   
   Tipo:   | 
      Uma referência a uma variável que contém o valor da propriedade. | 
VarArrayBean
| Campo | Descrição | 
|---|---|
values
   
   Tipo:   | 
      Uma matriz de valores de string literal. | 
ref
   
   Tipo:   | 
      Uma referência a uma variável que contém a matriz de valores. | 
AdditionalClaimsBean
| Campo | Descrição | 
|---|---|
claims
   
   Tipo:   | 
      Um mapa de nomes de declaração para valores de declaração. | 
ref
   
   Tipo:   | 
      Uma referência a uma variável que contém o mapa de declarações. | 
OAuthV2
| Campo | Descrição | 
|---|---|
apiVersion
   
   Tipo:   | 
      apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      OAuthV2 | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
   Tipo: OAuthV2Bean  | 
      Define o estado desejado da política OAuthV2. | 
status
   Tipo: ApimResourceStatus  | 
      Mostra o status da política OAuthV2. | 
OAuthV2Bean
| Campo | Descrição | 
|---|---|
operation
   
   Tipo:   | 
      A operação OAuthV2 a ser realizada. Os valores válidos são:
        
  | 
   
configRef
   
   Tipo:   | 
      (Opcional) Referência a um nome de recurso personalizado OAuthV2Config que contém configurações reutilizáveis do OAuthV2. | 
   
scope
   
   Tipo:   | 
      O escopo do token de acesso. Para mais informações, consulte Elemento de escopo. | 
generateResponse
   Tipo: GenerateResponse  | 
      Configura a geração de respostas. Para mais informações, consulte Elemento GenerateResponse. | 
generateErrorResponse
   Tipo: GenerateErrorResponse  | 
      Configura a geração de respostas de erro. Para mais informações, consulte Elemento GenerateErrorResponse. | 
expiresIn
   Tipo: PropertyExpiryBean  | 
      O prazo de validade do token de acesso. Para mais informações, consulte Elemento ExpiresIn. | 
refreshTokenExpiresIn
   Tipo: PropertyExpiryBean  | 
      O prazo de validade do token de atualização. Para mais informações, consulte Elemento RefreshTokenExpiresIn. | 
supportedGrantTypes
   
   Tipo:   | 
      Uma lista de tipos de concessão compatíveis. Para mais informações, consulte Elemento SupportedGrantTypes. | 
redirectURI
   
   Tipo:   | 
      O URI de redirecionamento usado no tipo de concessão de código de autorização. Para mais informações, consulte Elemento RedirectUri. | 
responseType
   
   Tipo:   | 
      O tipo de resposta para o tipo de concessão do código de autorização. Para mais informações, consulte Elemento ResponseType. | 
clientID
   
   Tipo:   | 
      O ID do cliente. Para mais informações, consulte Elemento ClientId. | 
state
   
   Tipo:   | 
      O parâmetro de estado para o tipo de concessão de código de autorização. Para mais informações, consulte Elemento de estado. | 
appEndUser
   
   Tipo:   | 
      O ID do usuário final. Para mais informações, consulte o elemento AppEndUser. | 
code
   
   Tipo:   | 
      O código de autorização. Para mais informações, consulte Elemento de código. | 
userName
   
   Tipo:   | 
      O nome de usuário do tipo de concessão de senha. Para mais informações, consulte Elemento UserName. | 
password
   
   Tipo:   | 
      A senha para o tipo de concessão de senha. Para mais informações, consulte Elemento de senha. | 
grantType
   
   Tipo:   | 
      O tipo de concessão. Para mais informações, consulte Elemento GrantType. | 
refreshToken
   
   Tipo:   | 
      O token de atualização. Para mais informações, consulte Elemento RefreshToken. | 
accessToken
   
   Tipo:   | 
      O token de acesso. Para mais informações, consulte Elemento AccessToken. | 
cacheExpiryInSeconds
   Tipo: PropertyExpiryBean  | 
      O tempo de expiração do cache em segundos. Para mais informações, consulte Configurações de expiração do cache. | 
verifyAccessTokenPrefix
   
   Tipo:   | 
      (Opcional) Prefixo a ser usado ao verificar um token de acesso. | 
externalAuthorization
   
   Tipo:   | 
      Indica se um serviço de autorização externa deve ser usado. Para mais informações, consulte Elemento ExternalAuthorization. | 
reuseRefreshToken
   
   Tipo:   | 
      Especifica se é necessário reutilizar tokens de atualização. Para mais informações, consulte o elemento ReuseRefreshToken. | 
rfcCompliance
   
   Tipo:   | 
      Impõe a conformidade com a RFC. Para mais informações, consulte Elemento RFCCompliantRequestResponse. | 
enforceStrictCallbackURIEnforced
   
   Tipo:   | 
      (Opcional) Aplica a correspondência estrita de URI de callback. | 
customAttributes
   
   Tipo:   | 
      Atributos personalizados a serem adicionados ao token. Para mais informações, consulte Elemento de atributos. | 
externalAccessToken
   
   Tipo:   | 
      Um token de acesso externo. Para mais informações, consulte Elemento ExternalAccessToken. | 
externalRefreshToken
   
   Tipo:   | 
      Um token de atualização externo. Para mais informações, consulte o elemento ExternalRefreshToken. | 
storeToken
   
   Tipo:   | 
      Especifica se o token deve ser armazenado. Para mais informações, consulte Elemento StoreToken. | 
tokens
   
   Tipo:   | 
      Uma lista de tokens a serem invalidados. Para mais informações, consulte Elemento de tokens. | 
algorithm
   
   Tipo:   | 
      O algoritmo usado para assinar o JWT. Para mais informações, consulte Elemento de algoritmo. | 
secretKey
   Tipo: SecretKey  | 
      A chave secreta usada para assinar o JWT. Para mais informações, consulte Elemento SecretKey. | 
privateKey
   Tipo: PrivateKey  | 
      A chave privada usada para assinar o JWT. Para mais informações, consulte Elemento PrivateKey. | 
publicKey
   Tipo: PublicKey  | 
      A chave pública usada para verificar o JWT. Para mais informações, consulte Elemento PublicKey. | 
GenerateResponse
| Campo | Descrição | 
|---|---|
enabled
   
   Tipo:   | 
      Se for definida como true ou se o atributo "enabled" for omitido, a política vai gerar e retornar uma resposta. | 
   
format
   
   Tipo:   | 
      Uma destas opções: XML e FORM_PARAM. | 
   
GenerateErrorResponse
| Campo | Descrição | 
|---|---|
enabled
   
   Tipo:   | 
      Se for definida como true ou se o atributo "enabled" for omitido, a política vai gerar e retornar uma resposta. | 
   
format
   
   Tipo:   | 
      Uma destas opções: XML e FORM_PARAM. | 
   
realm
   Tipo: PropertyBean  | 
      O domínio a ser retornado no cabeçalho WWW-Authenticate. | 
   
PropertyExpiryBean
| Campo | Descrição | 
|---|---|
value
   
   Tipo:   | 
      O valor literal da expiração. | 
ref
   
   Tipo:   | 
      Uma referência a uma variável que contém o valor de expiração. | 
CustomAttribute
| Campo | Descrição | 
|---|---|
name
   
   Tipo:   | 
      O nome do atributo personalizado. | 
ref
   
   Tipo:   | 
      Uma referência a uma variável que contém o valor do atributo. | 
value
   
   Tipo:   | 
      O valor literal do atributo. | 
SecretKey
| Campo | Descrição | 
|---|---|
value
   Tipo: PropertyBean  | 
      Especifica a chave secreta usada para assinar o JWT. Para mais informações, consulte Elemento SecretKey. | 
PrivateKey
| Campo | Descrição | 
|---|---|
value
   Tipo: PropertyBean  | 
      Especifica a chave privada usada para assinar o JWT. Para mais informações, consulte Elemento PrivateKey. | 
PublicKey
| Campo | Descrição | 
|---|---|
value
   Tipo: PropertyBean  | 
      Especifica a chave pública usada para verificar o JWT. Para mais informações, consulte Elemento PublicKey. | 
Política ResponseCache
| Campo | Descrição | 
|---|---|
apiVersion
Tipo:   | 
   apim.googleapis.com/v1 | 
kind
   
   Tipo:   | 
      ResponseCache | 
metadata
    | 
      Consulte a documentação da API Kubernetes para saber mais sobre os campos disponíveis em metadata.
       | 
   
spec
Tipo: APIExtensionPolicySpec  | 
   Define o estado desejado de ResponseCache. | 
ResponseCacheBean
| Campo | Descrição | 
|---|---|
mode
   
   Tipo:   | 
      Especifica ProxyRequest ou ProxyResponse. Determina se a política está
      anexada ao fluxo de solicitação ou de resposta.
       | 
   
cacheExpiry
Tipo: cacheExpiry  | 
   Fornece o objeto cacheExpiry. | 
cacheKey
Tipo: cacheKey  | 
   Fornece o objeto cacheKey. | 
cacheLookupTimeOut
   Tipo:   | 
      Especifica o período de tempo limite de pesquisa de cache. | 
cacheResourceRef
   
   Tipo:   | 
      Especifica o identificador do recurso de cache usando uma referência de variável. | 
excludeErrorResponse
   
   Tipo:   | 
      Essa política pode armazenar em cache as respostas HTTP com qualquer código de status. Isso significa que as respostas de sucesso e
      erro podem ser armazenadas em cache, incluindo códigos de status 2xx e 3xx.
       | 
      
skipCacheLookupCondition
   
   Tipo:   | 
      Define uma expressão que, se for avaliada como true no ambiente de execução, especifica que a pesquisa de cache precisa ser ignorada e o cache precisa ser atualizado.
       | 
   
skipCachePopulationCondition
   
   Tipo:   | 
   Define uma expressão que, se for avaliada como true no ambiente de execução, especifica que a pesquisa de cache precisa ser ignorada e o cache precisa ser atualizado
   no ambiente de execução, especifica que uma gravação no cache precisa ser ignorada.
       | 
   
useAcceptHeader
   
   Tipo:   | 
      Defina como true para anexar valores dos cabeçalhos Accept da resposta à chave de cache da entrada de cache de resposta.
       | 
   
useResponseCacheHeaders
   
   Tipo:   | 
      Defina como true para que os cabeçalhos de resposta HTTP sejam considerados ao definir o "time to live" (TTL) da resposta no cache.
       | 
   
cacheExpiry
| Campo | Descrição | 
|---|---|
expiryDate
   
   Tipo:   | 
      Especifica a data em que uma entrada de cache expira. | 
timeOfDay
   
   Tipo:   | 
      Especifica a hora em que uma entrada de cache deve expirar. | 
timeoutInSeconds
   
   Tipo:   | 
      Especifica o número de segundos após o qual uma entrada de cache expira. | 
cacheKey
| Campo | Descrição | 
|---|---|
cacheKeyPrefix
   
   Tipo:   | 
      Especifica um valor para usar como prefixo da chave de cache. | 
fragments
   
   Tipo:   | 
      Especifica um valor a ser incluído na chave de cache para criar um namespace para solicitações correspondentes a respostas em cache. |