CREATE API INTEGRATION¶

Para Amazon API Gateway¶

CREATE [ OR REPLACE ] API INTEGRATION [ IF NOT EXISTS ] <integration_name>
    API_PROVIDER = { aws_api_gateway | aws_private_api_gateway | aws_gov_api_gateway | aws_gov_private_api_gateway }
    API_AWS_ROLE_ARN = '<iam_role>'
    [ API_KEY = '<api_key>' ]
    API_ALLOWED_PREFIXES = ('<...>')
    [ API_BLOCKED_PREFIXES = ('<...>') ]
    ENABLED = { TRUE | FALSE }
    [ COMMENT = '<string_literal>' ]
    ;

Note que aws_api_gateway ou aws_private_api_gateway ou aws_gov_api_gateway ou aws_gov_private_api_gateway não deve estar entre aspas.

Para Azure API Management¶

CREATE [ OR REPLACE ] API INTEGRATION [ IF NOT EXISTS ] <integration_name>
    API_PROVIDER = azure_api_management
    AZURE_TENANT_ID = '<tenant_id>'
    AZURE_AD_APPLICATION_ID = '<azure_application_id>'
    [ API_KEY = '<api_key>' ]
    API_ALLOWED_PREFIXES = ( '<...>' )
    [ API_BLOCKED_PREFIXES = ( '<...>' ) ]
    ENABLED = { TRUE | FALSE }
    [ COMMENT = '<string_literal>' ]
    ;

Note que azure_api_management não deve estar entre aspas.

Para Google Cloud API Gateway¶

CREATE [ OR REPLACE ] API INTEGRATION [ IF NOT EXISTS ] <integration_name>
    API_PROVIDER = google_api_gateway
    GOOGLE_AUDIENCE = '<google_audience_claim>'
    API_ALLOWED_PREFIXES = ( '<...>' )
    [ API_BLOCKED_PREFIXES = ( '<...>' ) ]
    ENABLED = { TRUE | FALSE }
    [ COMMENT = '<string_literal>' ]
    ;

Note que google_api_gateway não deve estar entre aspas.

Para Amazon API Gateway¶

integration_name

Especifica o nome da integração de API. Este nome segue as regras para Identificadores de objetos. O nome deve ser único entre as integrações de API em sua conta.

provider_info

Especifica o tipo de serviço de proxy HTTPS. Os valores válidos são:

• aws_api_gateway: para Amazon API Gateway usando pontos de extremidade regionais.

• aws_private_api_gateway: para Amazon API Gateway usando pontos de extremidade privados.

• aws_gov_api_gateway: para Amazon API Gateway usando pontos de extremidade GovCloud do governo dos EUA.

• aws_gov_private_api_gateway: para Amazon API Gateway usando pontos de extremidade GovCloud do governo dos EUA que também são pontos de extremidade privados.

iam_role

Para Amazon AWS, este é o ARN (nome do recurso Amazon) de uma função da plataforma de nuvem.

api_key

A chave API (também chamada de «chave de assinatura»).

ENABLED = < TRUE | FALSE >

Especifica se esta integração de API está habilitada ou desabilitada. Se a integração de API estiver desativada, qualquer função externa que conte com ela não funcionará.

O valor não diferencia maiúsculas e minúsculas.

O padrão é TRUE.

API_ALLOWED_PREFIXES = (...)

Limita explicitamente as funções externas que utilizam a integração para referenciar um ou mais pontos de extremidade do servidor de proxy HTTPS (por exemplo, Amazon API Gateway) e recursos dentro desses proxies. Oferece suporte a uma lista de URLs separada por vírgulas, que são tratados como prefixos (para detalhes, consulte abaixo).

Cada URL em API_ALLOWED_PREFIXES = (...) é tratado como um prefixo. Por exemplo, se você especificar:

https://xyz.amazonaws.com/production/

isso significa que todos os recursos em

https://xyz.amazonaws.com/production/

são permitidos. Por exemplo, é permitido o seguinte:

https://xyz.amazonaws.com/production/ml1

Para maximizar a segurança, você deve restringir os locais permitidos de maneira mais precisa e prática possível.

Para Azure API Management Service¶

integration_name

Especifica o nome da integração de API. Este nome segue as regras para Identificadores de objetos. O nome deve ser único entre as integrações de API em sua conta.

tenant_id

Especifica a ID de seu locatário do Office 365 ao qual pertencem todas as instâncias do Azure API Management. Uma integração de API pode autenticar apenas a um locatário, com isso os locais permitidos e bloqueados devem referir-se às instâncias do API Management que pertencem a este locatário.

Para encontrar sua ID de locatário, entre no portal Azure e clique em Azure Active Directory » Properties. A ID do locatário é exibida no campo Tenant ID.

azure_application_id

A “ID do aplicativo (cliente)” do aplicativo Azure AD (Active Directory) para seu serviço remoto. Se você seguiu as instruções em Criação de funções externas no Microsoft Azure, então este é o Azure Function App AD Application ID que você registrou na planilha naquelas instruções.

api_key

A chave API (também chamada de «chave de assinatura»).

ENABLED = < TRUE | FALSE >

Especifica se esta integração de API está habilitada ou desabilitada. Se a integração de API estiver desativada, qualquer função externa que conte com ela não funcionará.

O valor não diferencia maiúsculas e minúsculas.

O padrão é TRUE.

API_ALLOWED_PREFIXES = (...)

Limita explicitamente as funções externas que utilizam a integração para referenciar um ou mais pontos de extremidade do serviço de proxy HTTPS (por exemplo, serviços do Azure API Management) e recursos dentro desses proxies. Oferece suporte a uma lista de URLs separada por vírgulas, que são tratados como prefixos (para detalhes, consulte abaixo).

Cada URL em API_ALLOWED_PREFIXES = (...) é tratado como um prefixo. Por exemplo, se você especificar:

https://my-external-function-demo.azure-api.net/my-function-app-name

isso significa que todos os recursos em

https://my-external-function-demo.azure-api.net/my-function-app-name

são permitidos. Por exemplo, é permitido o seguinte:

https://my-external-function-demo.azure-api.net/my-function-app-name/my-http-trigger-function

Para maximizar a segurança, você deve restringir os locais permitidos de maneira mais precisa e prática possível.

Para Google Cloud API Gateway¶

integration_name

Especifica o nome da integração de API. Este nome segue as regras para Identificadores de objetos. O nome deve ser único entre as integrações de API em sua conta.

google_audience

Isto é usado como reivindicação da audiência ao gerar o JWT (JSON Web Token) para autenticar no Google API Gateway. Para obter mais informações sobre autenticação com o Google, consulte a documentação de autenticação da conta de serviço do Google.

ENABLED = < TRUE | FALSE >

Especifica se esta integração de API está habilitada ou desabilitada. Se a integração de API estiver desativada, qualquer função externa que conte com ela não funcionará.

O valor não diferencia maiúsculas e minúsculas.

O padrão é TRUE.

API_ALLOWED_PREFIXES = (...)

Limita explicitamente as funções externas que utilizam a integração para referenciar um ou mais pontos de extremidade do serviço de proxy HTTPS (por exemplo, Google Cloud API Gateways) e recursos dentro desses proxies. Oferece suporte a uma lista de URLs separada por vírgulas, que são tratados como prefixos (para detalhes, consulte abaixo).

Cada URL em API_ALLOWED_PREFIXES = (...) é tratado como um prefixo. Por exemplo, se você especificar:

https://my-external-function-demo.uc.gateway.dev/x

isso significa que todos os recursos em

https://my-external-function-demo.uc.gateway.dev/x

são permitidos. Por exemplo, é permitido o seguinte:

https://my-external-function-demo.uc.gateway.dev/x/y

Para maximizar a segurança, você deve restringir os locais permitidos de maneira mais precisa e prática possível.