Skip to content

Commit 2037eea

Browse files
update links and add some guides (#392)
* update links * update examples --------- Co-authored-by: vtomar <vtomar@microsoft.com>
1 parent ba9236c commit 2037eea

6 files changed

Lines changed: 458 additions & 113 deletions

File tree

samples/microsoft/infrastructure-setup/01-connections/apim-and-modelgateway-integration-guide.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,19 @@
1919

2020
The **Bring Your Own AI Gateway** feature in Foundry enables organizations to connect and use AI models hosted behind their enterprise gateways directly within the Foundry platform. This capability allows you to maintain control over your model endpoints while leveraging the power of Foundry's agent capabilities.
2121

22+
### 🎯 Connection Type Selection
23+
24+
**Choose the right connection type for your gateway:**
25+
26+
| Gateway Type | Connection Type | When to Use | Setup Guide |
27+
|--------------|-----------------|-------------|-------------|
28+
| **🏢 Azure API Management** | APIM Connection | If you are using Azure API Management service directly as your gateway | [APIM Setup](./apim/) |
29+
| **🌐 Other Gateways** | ModelGateway Connection | If you are using any other gateway (self-hosted, third-party, or custom solutions) | [ModelGateway Setup](./model-gateway/) |
30+
31+
> **💡 Quick Decision**:
32+
> - **Azure API Management service** → Use **APIM Connection**
33+
> - **Everything else** (Kong, MuleSoft, custom gateways, etc.) → Use **ModelGateway Connection**
34+
2235
### 💡 Key Benefits
2336

2437
| Benefit | Description |
@@ -278,8 +291,8 @@ Unified connections for various AI model providers through self-hosted or third-
278291
### Step 2️⃣: Create Your Gateway Connection
279292

280293
📚 **Detailed Instructions**:
281-
- **APIM Connections**: [APIM Connection Setup Guide](./apim/README.md) - Complete walkthrough for Azure API Management
282-
- **ModelGateway Connections**: [ModelGateway Setup Guide](./model-gateway/README.md) - Step-by-step for self-hosted/third-party gateways
294+
- **APIM Connections**: [APIM Setup Guide](./apim/apim-setup-guide-for-agents.md) - Complete walkthrough for Azure API Management
295+
- **ModelGateway Connections**: [ModelGateway Setup Guide](./model-gateway/modelgateway-setup-guide-for-agents.md) - Step-by-step for self-hosted/third-party gateways
283296

284297
1. **📋 Choose the appropriate template**:
285298
```bash
@@ -327,16 +340,22 @@ Unified connections for various AI model providers through self-hosted or third-
327340

328341
## 📚 Resources & Links
329342

330-
### 🔧 Setup Guides
343+
### 🏢 APIM Connections
331344

332345
| Resource | Description | Link |
333346
|----------|-------------|------|
334-
| **🏢 Azure API Management Setup Guide** | Complete guide for importing AI Foundry and Azure OpenAI resources, adding list/get deployment endpoints, and verification | [APIM Setup Guide](./apim-setup-guide.md) |
347+
| **🏢 Azure API Management Setup Guide** | Complete guide for importing AI Foundry and Azure OpenAI resources, adding list/get deployment endpoints, and verification | [APIM Setup Guide](./apim/apim-setup-guide-for-agents.md) |
348+
| **🔗 APIM Connection Configuration** | Detailed JSON schema, examples, and configuration options for APIM connections | [APIM Connection Objects](./apim/APIM-Connection-Objects.md) |
349+
| **📋 How to Create APIM Connections** | Step-by-step instructions for creating Azure API Management gateway connections | [APIM Connection Setup README](./apim/README.md) |
350+
| **🔒 Private Network APIM Setup** | Bicep template for secure private network APIM gateway setup with Agents BYO VNet | [Private APIM Setup](https://github.com/azure-ai-foundry/foundry-samples/tree/main/samples/microsoft/infrastructure-setup/16-private-network-standard-agent-apim-setup-preview) |
335351
| **📖 Azure API Management GenAI Gateway** | Official Microsoft documentation on Azure API Management GenAI gateway capabilities and features | [GenAI Gateway Capabilities](https://learn.microsoft.com/en-in/azure/api-management/genai-gateway-capabilities) |
336352
| **🔗 Azure AI Foundry API in APIM** | Official Microsoft documentation on integrating Azure AI Foundry APIs with Azure API Management | [Azure AI Foundry API](https://learn.microsoft.com/en-in/azure/api-management/azure-ai-foundry-api) |
337353
| **🔗 Azure OpenAI API from Specification** | Official Microsoft documentation on importing Azure OpenAI APIs into Azure API Management from specification | [Azure OpenAI API Import](https://learn.microsoft.com/en-in/azure/api-management/azure-openai-api-from-specification) |
338-
| **🔒 Private Network APIM Setup** | Bicep template for secure private network APIM gateway setup with Agents BYO VNet | [Private APIM Setup](https://github.com/azure-ai-foundry/foundry-samples/tree/main/samples/microsoft/infrastructure-setup/16-private-network-standard-agent-apim-setup-preview) |
339-
| **�🔗 APIM Connection Configuration** | Detailed JSON schema, examples, and configuration options for APIM connections | [APIM Connection Objects](./apim/APIM-Connection-Objects.md) |
354+
355+
### 🌉 ModelGateway Connections
356+
357+
| Resource | Description | Link |
358+
|----------|-------------|------|
359+
| **🌉 ModelGateway Setup Guide** | Complete guide for configuring self-hosted and third-party gateways for Foundry Agents integration | [ModelGateway Setup Guide](./model-gateway/modelgateway-setup-guide-for-agents.md) |
340360
| **🔗 ModelGateway Connection Configuration** | Detailed JSON schema, examples, and configuration options for ModelGateway connections | [ModelGateway Connection Objects](./model-gateway/ModelGateway-Connection-Objects.md) |
341-
| **📋 How to Create APIM Connections** | Step-by-step instructions for creating Azure API Management gateway connections | [APIM Connection Setup README](./apim/README.md) |
342361
| **📋 How to Create ModelGateway Connections** | Step-by-step instructions for creating ModelGateway connections for self-hosted/third-party gateways | [ModelGateway Setup README](./model-gateway/README.md) |

samples/microsoft/infrastructure-setup/01-connections/apim/APIM-Connection-Objects.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -141,29 +141,23 @@ We support exactly **2 deployment API formats** for model discovery through APIM
141141
{
142142
"value": [
143143
{
144-
"id": "/subscriptions/.../deployments/gpt-4-deployment",
145-
"name": "gpt-4-deployment",
146-
"type": "Microsoft.CognitiveServices/accounts/deployments",
144+
"name": "gpt-4o-deployment",
147145
"properties": {
148146
"model": {
149147
"format": "OpenAI",
150-
"name": "gpt-4",
151-
"version": "0613"
152-
},
153-
"provisioningState": "Succeeded"
148+
"name": "gpt-4o",
149+
"version": "2024-11-20"
150+
}
154151
}
155152
},
156153
{
157-
"id": "/subscriptions/.../deployments/gpt-35-turbo-deployment",
158-
"name": "gpt-35-turbo-deployment",
159-
"type": "Microsoft.CognitiveServices/accounts/deployments",
154+
"name": "gpt-5-deployment",
160155
"properties": {
161156
"model": {
162157
"format": "OpenAI",
163-
"name": "gpt-35-turbo",
164-
"version": "0613"
165-
},
166-
"provisioningState": "Succeeded"
158+
"name": "gpt-5",
159+
"version": ""
160+
}
167161
}
168162
}
169163
]
@@ -173,16 +167,13 @@ We support exactly **2 deployment API formats** for model discovery through APIM
173167
*Get Deployment by Name Response (`getModelEndpoint`):`*
174168
```json
175169
{
176-
"id": "/subscriptions/.../deployments/gpt-4-deployment",
177-
"name": "gpt-4-deployment",
178-
"type": "Microsoft.CognitiveServices/accounts/deployments",
170+
"name": "gpt-4o-deployment",
179171
"properties": {
180172
"model": {
181173
"format": "OpenAI",
182-
"name": "gpt-4",
183-
"version": "0613"
184-
},
185-
"provisioningState": "Succeeded"
174+
"name": "gpt-4o",
175+
"version": "2024-11-20"
176+
}
186177
}
187178
}
188179
```
@@ -191,7 +182,6 @@ We support exactly **2 deployment API formats** for model discovery through APIM
191182
- Follows Azure ARM resource structure
192183
- Separate deployment `name` and model details in `properties.model`
193184
- Includes model `name`, `version`, and `format`
194-
- Provides deployment provisioning state
195185

196186
**2. OpenAI Format Responses (`deploymentProvider: "OpenAI"`):**
197187

@@ -200,13 +190,13 @@ We support exactly **2 deployment API formats** for model discovery through APIM
200190
{
201191
"data": [
202192
{
203-
"id": "gpt-4",
193+
"id": "gpt-4o",
204194
"object": "model",
205195
"created": 1687882411,
206196
"owned_by": "openai"
207197
},
208198
{
209-
"id": "gpt-3.5-turbo",
199+
"id": "gpt-5",
210200
"object": "model",
211201
"created": 1677610602,
212202
"owned_by": "openai"
@@ -218,7 +208,7 @@ We support exactly **2 deployment API formats** for model discovery through APIM
218208
*Get Model by Name Response (`getModelEndpoint`):`*
219209
```json
220210
{
221-
"id": "gpt-4",
211+
"id": "gpt-4o",
222212
"object": "model",
223213
"created": 1687882411,
224214
"owned_by": "openai"
@@ -237,12 +227,22 @@ Static discovery uses a predefined `models` array in metadata. Models are define
237227
{
238228
"models": [
239229
{
240-
"name": "deployment-name",
230+
"name": "gpt-4o-deployment",
231+
"properties": {
232+
"model": {
233+
"name": "gpt-4o",
234+
"version": "2024-11-20",
235+
"format": "OpenAI"
236+
}
237+
}
238+
},
239+
{
240+
"name": "gpt-5-deployment",
241241
"properties": {
242242
"model": {
243-
"name": "model-name",
244-
"version": "model-version",
245-
"format": "provider-format"
243+
"name": "gpt-5",
244+
"version": "",
245+
"format": "OpenAI"
246246
}
247247
}
248248
}
@@ -420,21 +420,21 @@ Predefined static list of models without dynamic discovery.
420420
"metadata": {
421421
"models": [
422422
{
423-
"name": "gpt-4-deployment",
423+
"name": "gpt-4o-deployment",
424424
"properties": {
425425
"model": {
426-
"name": "gpt-4",
427-
"version": "0613",
426+
"name": "gpt-4o",
427+
"version": "2024-11-20",
428428
"format": "OpenAI"
429429
}
430430
}
431431
},
432432
{
433-
"name": "gpt-35-turbo-deployment",
433+
"name": "gpt-5-deployment",
434434
"properties": {
435435
"model": {
436-
"name": "gpt-35-turbo",
437-
"version": "0613",
436+
"name": "gpt-5",
437+
"version": "",
438438
"format": "OpenAI"
439439
}
440440
}

samples/microsoft/infrastructure-setup/01-connections/apim/apim-setup-guide-for-agents.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,4 +232,11 @@ Determine if your chat completions URL includes the deployment name in the path:
232232
- `"true"`: `/deployments/gpt-4/chat/completions`
233233
- `"false"`: `/chat/completions?deployment=gpt-4`
234234

235-
> **📝 Note**: These values will be used when creating your APIM connection in Foundry using the Bicep templates.
235+
> **📝 Note**: These values will be used when creating your APIM connection in Foundry using the Bicep templates.
236+
237+
---
238+
239+
## 📚 Additional Resources
240+
241+
- **🔗 [APIM Connection Objects Documentation](APIM-Connection-Objects.md)** - Read up on more configurations available for APIM connections
242+
- **📖 [APIM README](README.md)** - Next steps for deploying your APIM connections

0 commit comments

Comments
 (0)