Component
core/gateway/azure-api-management
The AI gateway of Azure API Management, a hosted service: a caller sends its model requests to an API on an API Management instance, which forwards them to the model API behind it. Nothing runs in the Release and the compiler never calls Azure. It publishes the API's address and the model a caller asks for, which the gateway forwards unchecked. On terraform its Recipe adds the API, its backend and its policy to an instance that already exists, and is the one that can carry controls: reach for it where the instance exists and the Release is to configure the API. On helm and compose its Recipes reference an API that already exists and carry no Feature: reach for those where the API is configured outside the Release. On terraform it realizes core/semantic-caching, core/period-budget, core/prompt-injection-shield and core/retry-policy in the API's policy, and halts core/audit-logging by name. Not realized: core/response-validation, core/target-selection, core/data-masking, core/concurrency-limit and core/fallback-chain. A caller presents its own subscription key; the one credential the gateway holds is the optional provider_key, written as a reference to a Key Vault secret. What the gateway does with a request is Microsoft's documented behaviour and no build observes it. It carries no model.aggrega.ai/api label, so an agent's model socket does not take it.
출처
- 콘텐츠 다이제스트
- sha256:9b57a813e0a17aeb85dd2bf16c049099a481eb135c41c8283efd3bd1ba78ab9a
- 게시일
- 2026-11-10T10:11:41Z
- 서명 ID
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
서명
- 공식application/vnd.dev.sigstore.bundle.v0.3+json
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
sha256:aba359c7ff0006843e2266a3230daa2bc4777513ae0277a80a8849f6d252e1bb
이 버전의 참조
oci://hub.aggrega.ai/component/core/gateway/azure-api-management:1.0.0개발자 매개변수
개발자가 Aggregate에서 설정하는 값입니다.
BaseComponents#/schemas/BaseComponentParameter 확장
| 이름 | 타입 | 기본값 | 필수 | 설명 |
|---|---|---|---|---|
| model | string (min 1) | — | 예 | The model a caller asks the gateway for, written as the model API behind it expects it: a deployment name on Azure OpenAI, or the provider's own model name, such as gpt-4o-mini. Published as model; the gateway forwards it without checking it. |
운영자 사이징
운영자가 환경별로 조정하는 인프라 사이징입니다.
| 이름 | 타입 | 기본값 | 필수 | 설명 |
|---|---|---|---|---|
| api_management_name | string (min 1, max 50) | — | 예 | The name of the API Management instance the API is served on. The terraform Recipe reads this instance and never creates it; the helm and compose Recipes compose the address from it. |
| api_path | string (min 1, max 400) | — | 예 | The path the API is served under at the gateway, unique within the instance, such as models or teams/chat. The terraform Recipe creates the API at it and names the API, its backend and its named value after it, with each slash as a hyphen; the helm and compose Recipes reference the API already served there. |
| gateway_url | string | — | 아니요 | The scheme and host the instance's gateway answers on, with no path, such as https://api.contoso.com for an instance reached under its own domain. Unset, the address is https://<api_management_name>.azure-api.net, the host Azure gives the instance. |
| resource_group_name | string (min 1) | — | 아니요 | The resource group the API Management instance sits in. Read by the terraform Recipe only, which halts the build when it is unset. |
| backend_url | string | — | 아니요 | The base address of the model API the gateway forwards to, with no trailing slash: the gateway appends /chat/completions. For Azure OpenAI, https://<resource>.openai.azure.com/openai/v1. Read by the terraform Recipe only, which halts the build when it is unset. |
| backend_authentication | string (managed_identity | provider_key | none) | — | 아니요 | How the gateway authenticates to the model API. managed_identity: a token for https://cognitiveservices.azure.com obtained with the instance's system-assigned identity and sent as a bearer token, which Azure OpenAI and other Microsoft Foundry models accept once that identity holds a role on them; the gateway does not check where it sends the token, so choose it only for such a backend. provider_key: the key held in the Key Vault secret provider_key names, sent in the header infra.provider_key_header names. none: nothing is added, for a model API that takes no credential. Read by the terraform Recipe only, which halts the build when it is unset. |
| provider_key_header | string | api-key | 아니요 | The header the key provider_key names is sent in. api-key, the default, is the header Azure OpenAI reads; a model API taking a bearer token reads Authorization. Read by the terraform Recipe only, while infra.backend_authentication is provider_key. |
| subscription_required | boolean | true | 아니요 | Whether the API refuses a request that presents no API Management subscription key. Off, anyone holding the address can send model requests through the gateway. Written by the terraform Recipe only. |
| content_safety_backend_id | string | — | 아니요 | The id of the API Management backend for the instance's Azure AI Content Safety resource, at https://<name>.cognitiveservices.azure.com, which the instance reaches with its managed identity holding the Cognitive Services User role there. Read by the terraform Recipe only, which halts the build when core/prompt-injection-shield is attached and it is unset; the backend is configured on the instance outside the Release. |
| cache_serves_vector_search | boolean | false | 아니요 | Affirms that the external cache the API Management instance uses is a Redis cache serving the vector search of the Redis query engine, RediSearch, which Azure's semantic cache looks prompts up with. The cache is configured on the instance outside the Release and the compiler never reads it, so it asks rather than checks. Read by the terraform Recipe only, which halts the build when core/semantic-caching is attached and this is left unaffirmed; with no such attachment it changes nothing rendered. |
출력 계약
이 컴포넌트가 uses 토폴로지를 통해 소비자에게 게시하는 값입니다.
| 이름 | 타입 | 기본값 | 필수 | 설명 |
|---|---|---|---|---|
| endpoint | string | — | 예 | The address of the API, <gateway_url>/<api_path>, with gateway_url defaulting to https://<api_management_name>.azure-api.net. A client of the OpenAI chat completions API uses it as its base address and presents its subscription key in the Ocp-Apim-Subscription-Key header. |
| model | string | — | 예 | The model a caller asks for, carried through from values.model. |
uses 소켓
이 컴포넌트가 연결에 사용하는 의존성 소켓입니다. 소켓을 통해 배선되는 모든 연결의 대상은 해당 소켓의 레이블 셀렉터를 충족해야 하며, 각 연결은 소켓이 선언한 슬롯에 첨부를 전달할 수 있습니다. 필수 슬롯은 Aggregate 또는 Release가 해당 소켓을 통해 배선하는 각 연결이 채워야 합니다.
선언된 uses 소켓이 없습니다.
첨부 슬롯
Feature가 이 컴포넌트에 첨부되는 이름 있는 바인딩 지점입니다. 슬롯의 셀렉터는 어떤 Feature가 슬롯을 채울 수 있는지를 제한하고, 슬롯의 inject 목록은 Feature의 자료를 어떻게 전달할 수 있는지를 지정합니다. 필수 슬롯은 인스턴스의 첨부 또는 그 위 범위의 첨부를 통해 모든 인스턴스에서 바인딩되어야 하며, 민감 슬롯은 비밀 자료를 처리하도록 선언됩니다. Feature는 어떤 슬롯도 선언하지 않은 이름으로 첨부될 수도 있습니다.
| 슬롯 | 셀렉터 | 필수 | 주입 | 민감 | 설명 |
|---|---|---|---|---|---|
| provider_key | feature.aggrega.ai/kind=secret | 아니요 | env | 예 | Optional key the gateway presents to the model API behind it, read only by the terraform Recipe and only while infra.backend_authentication is provider_key. The key itself stays in Azure Key Vault: the attachment delivers the identifier of the Key Vault secret holding it, https://<vault>.vault.azure.net/secrets/<name>, as core/secret-value bound to terraform/variable-secret does, and the Recipe writes that identifier into a secret named value the instance reads with its managed identity, which needs read access to that secret. The build halts on a delivered value that is not such an identifier, so a key written in place of one never reaches a rendered file. The secret holds the header's whole value, as the header named by infra.provider_key_header carries it: for a bearer token, Bearer followed by the key. |
자체 주입 허용 목록
선언된 자체 주입 파이프가 없습니다.
관계
게시된 다른 엔터티와 주고받는 타입 지정 에지입니다. 게시된 대상이 없는 참조는 링크가 아닌 끊어진 에지로 표시됩니다.
사용함
- $ref스키마 확장 (values)
BaseComponents#/schemas/BaseComponentParameter
사용됨
적용 대상
적용 대상
적용 대상
적용 대상
적용 대상
적용 대상
적용 대상
적용 대상
구현
구현
구현