{ "swagger": "2.0", "info": { "title": "AIGatewayClient", "version": "2026-11-01", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "AIGatewayOperations" }, { "name": "Operations" }, { "name": "AiGatewayNameAvailabilityOperations" }, { "name": "AiGatewayTelemetryExporterResources" }, { "name": "AiGatewayAliasResources" }, { "name": "AiGatewayResources" }, { "name": "AiGatewayPrivateEndpointConnections" }, { "name": "AiGatewayPrivateLinkResources" }, { "name": "AiGatewayWorkspaceResources" }, { "name": "AiGatewayModelProviderResources" }, { "name": "AiGatewayModelResources" }, { "name": "AiGatewayToolServerResources" }, { "name": "AiGatewayApiKeyResources" } ], "paths": { "/providers/Microsoft.ApiManagement/operations": { "get": { "operationId": "Operations_List", "tags": [ "AIGatewayOperations", "Operations" ], "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/OperationListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List AI Gateway operations": { "$ref": "./examples/AIGatewayListOperations.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/aigateways": { "get": { "operationId": "AiGatewayResources_ListBySubscription", "tags": [ "AiGatewayResources" ], "description": "List AiGatewayResource resources by subscription ID", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List AI Gateways by subscription": { "$ref": "./examples/AiGatewayListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/checkNameAvailability": { "post": { "operationId": "AiGatewayNameAvailabilityOperations_CheckNameAvailability", "tags": [ "AiGatewayNameAvailabilityOperations" ], "description": "Checks whether an AI Gateway name is valid and available in a location.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/LocationParameter" }, { "name": "body", "in": "body", "description": "The CheckAvailability request", "required": true, "schema": { "$ref": "#/definitions/AiGatewayCheckNameAvailabilityRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AiGatewayCheckNameAvailabilityResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check an AI Gateway name in a location": { "$ref": "./examples/AiGatewayCheckNameAvailability.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways": { "get": { "operationId": "AiGatewayResources_ListByResourceGroup", "tags": [ "AiGatewayResources" ], "description": "List AiGatewayResource resources by resource group", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List AI Gateways by resource group": { "$ref": "./examples/AiGatewayListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}": { "get": { "operationId": "AiGatewayResources_Get", "tags": [ "AiGatewayResources" ], "description": "Get a AiGatewayResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an AI Gateway": { "$ref": "./examples/AiGatewayGet.json" } } }, "put": { "operationId": "AiGatewayResources_CreateOrUpdate", "tags": [ "AiGatewayResources" ], "description": "Create a AiGatewayResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayResource" } }, "201": { "description": "Resource 'AiGatewayResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayResource" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create an AI Gateway": { "$ref": "./examples/AiGatewayCreate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "#/definitions/AiGatewayResource" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "AiGatewayResources_Update", "tags": [ "AiGatewayResources" ], "description": "Update a AiGatewayResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayResource" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update AI Gateway tags and SKU": { "$ref": "./examples/AiGatewayUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/AiGatewayResource" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AiGatewayResources_Delete", "tags": [ "AiGatewayResources" ], "description": "Delete a AiGatewayResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an AI Gateway": { "$ref": "./examples/AiGatewayDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/apiKeys": { "get": { "operationId": "AiGatewayApiKeyResources_ListByAiGateway", "tags": [ "AiGatewayApiKeyResources" ], "description": "List AiGatewayApiKeyResource resources by AiGatewayResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayApiKeyResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List AI Gateway API keys": { "$ref": "./examples/AiGatewayApiKeyList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/apiKeys/{apiKeyName}": { "get": { "operationId": "AiGatewayApiKeyResources_Get", "tags": [ "AiGatewayApiKeyResources" ], "description": "Get a AiGatewayApiKeyResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayApiKeyResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an AI Gateway API key": { "$ref": "./examples/AiGatewayApiKeyGet.json" } } }, "put": { "operationId": "AiGatewayApiKeyResources_CreateOrUpdate", "tags": [ "AiGatewayApiKeyResources" ], "description": "Create a AiGatewayApiKeyResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "If-Match", "in": "header", "description": "ETag of the resource. Required for an update.", "required": false, "type": "string", "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow creating a new resource, but prevent updating an existing resource.", "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayApiKeyResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayApiKeyResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayApiKeyResource" } }, "201": { "description": "Resource 'AiGatewayApiKeyResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayApiKeyResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create an AI Gateway API key": { "$ref": "./examples/AiGatewayApiKeyCreate.json" } } }, "patch": { "operationId": "AiGatewayApiKeyResources_Update", "tags": [ "AiGatewayApiKeyResources" ], "description": "Update a AiGatewayApiKeyResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayApiKeyUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayApiKeyResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an AI Gateway API key": { "$ref": "./examples/AiGatewayApiKeyUpdate.json" } } }, "delete": { "operationId": "AiGatewayApiKeyResources_Delete", "tags": [ "AiGatewayApiKeyResources" ], "description": "Delete a AiGatewayApiKeyResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an AI Gateway API key": { "$ref": "./examples/AiGatewayApiKeyDelete.json" } } }, "head": { "operationId": "AiGatewayApiKeyResources_CheckExistence", "tags": [ "AiGatewayApiKeyResources" ], "description": "Check for the existence of a AiGatewayApiKeyResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway ApiKey exists": { "$ref": "./examples/AiGatewayApiKeyCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/apiKeys/{apiKeyName}/listSecrets": { "post": { "operationId": "AiGatewayApiKeyResources_ListSecrets", "tags": [ "AiGatewayApiKeyResources" ], "description": "Returns primary and secondary key values.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayApiKeyValues" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List AI Gateway API key secrets": { "$ref": "./examples/AiGatewayApiKeyListSecrets.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/apiKeys/{apiKeyName}/regeneratePrimaryKey": { "post": { "operationId": "AiGatewayApiKeyResources_RegeneratePrimaryKey", "tags": [ "AiGatewayApiKeyResources" ], "description": "Regenerates the primary API key value.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "204": { "description": "Operation completed successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Regenerate the primary AI Gateway API key": { "$ref": "./examples/AiGatewayApiKeyRegeneratePrimaryKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/apiKeys/{apiKeyName}/regenerateSecondaryKey": { "post": { "operationId": "AiGatewayApiKeyResources_RegenerateSecondaryKey", "tags": [ "AiGatewayApiKeyResources" ], "description": "Regenerates the secondary API key value.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "apiKeyName", "in": "path", "description": "The name of the AiGatewayApiKeyResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "204": { "description": "Operation completed successfully." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Regenerate the secondary AI Gateway API key": { "$ref": "./examples/AiGatewayApiKeyRegenerateSecondaryKey.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/privateEndpointConnections": { "get": { "operationId": "AiGatewayPrivateEndpointConnections_ListByAiGateway", "tags": [ "AiGatewayPrivateEndpointConnections" ], "description": "List AiGatewayResource PrivateEndpointConnections", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayPrivateEndpointConnectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private endpoint connections for an AI Gateway": { "$ref": "./examples/AiGatewayPrivateEndpointConnectionList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/privateEndpointConnections/{privateEndpointConnectionName}": { "get": { "operationId": "AiGatewayPrivateEndpointConnections_Get", "tags": [ "AiGatewayPrivateEndpointConnections" ], "description": "Get a AiGatewayResource PrivateEndpointConnection", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a private endpoint connection for an AI Gateway": { "$ref": "./examples/AiGatewayPrivateEndpointConnectionGet.json" } } }, "put": { "operationId": "AiGatewayPrivateEndpointConnections_CreateOrUpdate", "tags": [ "AiGatewayPrivateEndpointConnections" ], "description": "Approves or rejects a private endpoint connection. While the decision is applied, `properties.provisioningState` is `Updating`, a service-defined value of the extensible provisioning state.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } } ], "responses": { "200": { "description": "Resource 'AiGatewayPrivateEndpointConnection' update operation succeeded", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "201": { "description": "Resource 'AiGatewayPrivateEndpointConnection' create operation succeeded", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Approve or reject a private endpoint connection for an AI Gateway": { "$ref": "./examples/AiGatewayPrivateEndpointConnectionCreateOrUpdate.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation", "final-state-schema": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "AiGatewayPrivateEndpointConnections_Delete", "tags": [ "AiGatewayPrivateEndpointConnections" ], "description": "Deletes a private endpoint connection. Until the connection is removed, `properties.provisioningState` is `Deleting`.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/parameters/PrivateEndpointConnectionName" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a private endpoint connection for an AI Gateway": { "$ref": "./examples/AiGatewayPrivateEndpointConnectionDelete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/privateLinkResources": { "get": { "operationId": "AiGatewayPrivateLinkResources_ListByAiGateway", "tags": [ "AiGatewayPrivateLinkResources" ], "description": "List AiGatewayResource PrivateLinks", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayPrivateLinkResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private link resources for an AI Gateway": { "$ref": "./examples/AiGatewayPrivateLinkResourceList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/privateLinkResources/{privateLinkResourceName}": { "get": { "operationId": "AiGatewayPrivateLinkResources_Get", "tags": [ "AiGatewayPrivateLinkResources" ], "description": "Get a AiGatewayResource PrivateLink", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "privateLinkResourceName", "in": "path", "description": "The name of the private link associated with the Azure resource.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[a-zA-Z][a-zA-Z0-9]*$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a private link resource for an AI Gateway": { "$ref": "./examples/AiGatewayPrivateLinkResourceGet.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces": { "get": { "operationId": "AiGatewayWorkspaceResources_ListByAiGateway", "tags": [ "AiGatewayWorkspaceResources" ], "description": "List AiGatewayWorkspaceResource resources by AiGatewayResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayWorkspaceResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List AI Gateway workspaces": { "$ref": "./examples/AiGatewayWorkspaceList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}": { "get": { "operationId": "AiGatewayWorkspaceResources_Get", "tags": [ "AiGatewayWorkspaceResources" ], "description": "Get a AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayWorkspaceResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an AI Gateway workspace": { "$ref": "./examples/AiGatewayWorkspaceGet.json" } } }, "patch": { "operationId": "AiGatewayWorkspaceResources_Update", "tags": [ "AiGatewayWorkspaceResources" ], "description": "Update a AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayWorkspaceUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayWorkspaceResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an AI Gateway workspace": { "$ref": "./examples/AiGatewayWorkspaceUpdate.json" } } }, "head": { "operationId": "AiGatewayWorkspaceResources_CheckExistence", "tags": [ "AiGatewayWorkspaceResources" ], "description": "Check for the existence of a AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway Workspace exists": { "$ref": "./examples/AiGatewayWorkspaceCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/aliases": { "get": { "operationId": "AiGatewayAliasResources_ListByWorkspace", "tags": [ "AiGatewayAliasResources" ], "description": "List AiGatewayAliasResource resources by AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayAliasResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List aliases in the default workspace": { "$ref": "./examples/AiGatewayAliasList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/aliases/{aliasId}": { "get": { "operationId": "AiGatewayAliasResources_Get", "tags": [ "AiGatewayAliasResources" ], "description": "Get a AiGatewayAliasResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "aliasId", "in": "path", "description": "The name of the AiGatewayAliasResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayAliasResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an AI Gateway Alias": { "$ref": "./examples/AiGatewayAliasGet.json" } } }, "put": { "operationId": "AiGatewayAliasResources_CreateOrUpdate", "tags": [ "AiGatewayAliasResources" ], "description": "Create a AiGatewayAliasResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "aliasId", "in": "path", "description": "The name of the AiGatewayAliasResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$" }, { "name": "If-Match", "in": "header", "description": "ETag of the resource. Required for an update.", "required": false, "type": "string", "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow creating a new resource, but prevent updating an existing resource.", "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayAliasResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayAliasResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayAliasResource" } }, "201": { "description": "Resource 'AiGatewayAliasResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayAliasResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create an AI Gateway alias with automatic model selection and failover": { "$ref": "./examples/AiGatewayAliasCreateAutoModelSelection.json" }, "Create or update an AI Gateway Alias": { "$ref": "./examples/AiGatewayAliasCreate.json" } } }, "patch": { "operationId": "AiGatewayAliasResources_Update", "tags": [ "AiGatewayAliasResources" ], "description": "Update a AiGatewayAliasResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "aliasId", "in": "path", "description": "The name of the AiGatewayAliasResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayAliasUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayAliasResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an AI Gateway Alias": { "$ref": "./examples/AiGatewayAliasUpdate.json" } } }, "delete": { "operationId": "AiGatewayAliasResources_Delete", "tags": [ "AiGatewayAliasResources" ], "description": "Delete a AiGatewayAliasResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "aliasId", "in": "path", "description": "The name of the AiGatewayAliasResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an AI Gateway Alias": { "$ref": "./examples/AiGatewayAliasDelete.json" } } }, "head": { "operationId": "AiGatewayAliasResources_CheckExistence", "tags": [ "AiGatewayAliasResources" ], "description": "Check for the existence of a AiGatewayAliasResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "aliasId", "in": "path", "description": "The name of the AiGatewayAliasResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway Alias exists": { "$ref": "./examples/AiGatewayAliasCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/modelProviders": { "get": { "operationId": "AiGatewayModelProviderResources_ListByWorkspace", "tags": [ "AiGatewayModelProviderResources" ], "description": "List AiGatewayModelProviderResource resources by AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelProviderResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List model providers": { "$ref": "./examples/AiGatewayModelProviderList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/modelProviders/{modelProviderName}": { "get": { "operationId": "AiGatewayModelProviderResources_Get", "tags": [ "AiGatewayModelProviderResources" ], "description": "Get a AiGatewayModelProviderResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelProviderResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a model provider": { "$ref": "./examples/AiGatewayModelProviderGet.json" } } }, "put": { "operationId": "AiGatewayModelProviderResources_CreateOrUpdate", "tags": [ "AiGatewayModelProviderResources" ], "description": "Create a AiGatewayModelProviderResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "If-Match", "in": "header", "description": "ETag of the resource. Required for an update.", "required": false, "type": "string", "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow creating a new resource, but prevent updating an existing resource.", "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayModelProviderResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayModelProviderResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayModelProviderResource" } }, "201": { "description": "Resource 'AiGatewayModelProviderResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayModelProviderResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a Foundry model provider": { "$ref": "./examples/AiGatewayModelProviderCreate.json" }, "Create a custom model provider with API key authentication": { "$ref": "./examples/AiGatewayModelProviderCreateCustom.json" } } }, "patch": { "operationId": "AiGatewayModelProviderResources_Update", "tags": [ "AiGatewayModelProviderResources" ], "description": "Update a AiGatewayModelProviderResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayModelProviderUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelProviderResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a model provider": { "$ref": "./examples/AiGatewayModelProviderUpdate.json" } } }, "delete": { "operationId": "AiGatewayModelProviderResources_Delete", "tags": [ "AiGatewayModelProviderResources" ], "description": "Delete a AiGatewayModelProviderResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a model provider": { "$ref": "./examples/AiGatewayModelProviderDelete.json" } } }, "head": { "operationId": "AiGatewayModelProviderResources_CheckExistence", "tags": [ "AiGatewayModelProviderResources" ], "description": "Check for the existence of a AiGatewayModelProviderResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway ModelProvider exists": { "$ref": "./examples/AiGatewayModelProviderCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/modelProviders/{modelProviderName}/listSecrets": { "post": { "operationId": "AiGatewayModelProviderResources_ListSecrets", "tags": [ "AiGatewayModelProviderResources" ], "description": "Returns the stored model-provider authentication configuration, including secret values.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelProviderSecrets" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List model provider secrets": { "$ref": "./examples/AiGatewayModelProviderListSecrets.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/modelProviders/{modelProviderName}/models": { "get": { "operationId": "AiGatewayModelResources_ListByModelProvider", "tags": [ "AiGatewayModelResources" ], "description": "List AiGatewayModelResource resources by AiGatewayModelProviderResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List models by provider": { "$ref": "./examples/AiGatewayModelList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/modelProviders/{modelProviderName}/models/{modelName}": { "get": { "operationId": "AiGatewayModelResources_Get", "tags": [ "AiGatewayModelResources" ], "description": "Get a AiGatewayModelResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "modelName", "in": "path", "description": "The name of the AiGatewayModelResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an AI Gateway model": { "$ref": "./examples/AiGatewayModelGet.json" } } }, "put": { "operationId": "AiGatewayModelResources_CreateOrUpdate", "tags": [ "AiGatewayModelResources" ], "description": "Create a AiGatewayModelResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "modelName", "in": "path", "description": "The name of the AiGatewayModelResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" }, { "name": "If-Match", "in": "header", "description": "ETag of the resource. Required for an update.", "required": false, "type": "string", "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow creating a new resource, but prevent updating an existing resource.", "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayModelResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayModelResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayModelResource" } }, "201": { "description": "Resource 'AiGatewayModelResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayModelResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create an AI Gateway model": { "$ref": "./examples/AiGatewayModelCreate.json" } } }, "patch": { "operationId": "AiGatewayModelResources_Update", "tags": [ "AiGatewayModelResources" ], "description": "Update a AiGatewayModelResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "modelName", "in": "path", "description": "The name of the AiGatewayModelResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayModelUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an AI Gateway model": { "$ref": "./examples/AiGatewayModelUpdate.json" } } }, "delete": { "operationId": "AiGatewayModelResources_Delete", "tags": [ "AiGatewayModelResources" ], "description": "Delete a AiGatewayModelResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "modelName", "in": "path", "description": "The name of the AiGatewayModelResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an AI Gateway model": { "$ref": "./examples/AiGatewayModelDelete.json" } } }, "head": { "operationId": "AiGatewayModelResources_CheckExistence", "tags": [ "AiGatewayModelResources" ], "description": "Check for the existence of a AiGatewayModelResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "modelProviderName", "in": "path", "description": "The name of the AiGatewayModelProviderResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "modelName", "in": "path", "description": "The name of the AiGatewayModelResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway Model exists": { "$ref": "./examples/AiGatewayModelCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/models": { "get": { "operationId": "AiGatewayWorkspaceModelOperations_ListByWorkspace", "description": "Lists models from every model provider in an AI Gateway workspace.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "AI Gateway resource name.", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "Workspace resource name.", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayModelResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List all models in a workspace": { "$ref": "./examples/AiGatewayWorkspaceModelsList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/telemetryExporters": { "get": { "operationId": "AiGatewayTelemetryExporterResources_ListByWorkspace", "tags": [ "AiGatewayTelemetryExporterResources" ], "description": "List AiGatewayTelemetryExporterResource resources by AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List telemetryExporters in the default workspace": { "$ref": "./examples/AiGatewayTelemetryExporterList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/telemetryExporters/{telemetryExporterName}": { "get": { "operationId": "AiGatewayTelemetryExporterResources_Get", "tags": [ "AiGatewayTelemetryExporterResources" ], "description": "Get a AiGatewayTelemetryExporterResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "telemetryExporterName", "in": "path", "description": "The name of the AiGatewayTelemetryExporterResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get an AI Gateway TelemetryExporter": { "$ref": "./examples/AiGatewayTelemetryExporterGet.json" } } }, "put": { "operationId": "AiGatewayTelemetryExporterResources_CreateOrUpdate", "tags": [ "AiGatewayTelemetryExporterResources" ], "description": "Create a AiGatewayTelemetryExporterResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "telemetryExporterName", "in": "path", "description": "The name of the AiGatewayTelemetryExporterResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" }, { "name": "If-Match", "in": "header", "description": "ETag of the resource. Required for an update.", "required": false, "type": "string", "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow creating a new resource, but prevent updating an existing resource.", "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayTelemetryExporterResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterResource" } }, "201": { "description": "Resource 'AiGatewayTelemetryExporterResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create an Application Insights telemetry exporter": { "$ref": "./examples/AiGatewayTelemetryExporterCreateApplicationInsights.json" }, "Create an OpenTelemetry exporter with header authentication": { "$ref": "./examples/AiGatewayTelemetryExporterCreateWithHeaders.json" }, "Create or update an AI Gateway TelemetryExporter": { "$ref": "./examples/AiGatewayTelemetryExporterCreate.json" } } }, "patch": { "operationId": "AiGatewayTelemetryExporterResources_Update", "tags": [ "AiGatewayTelemetryExporterResources" ], "description": "Update a AiGatewayTelemetryExporterResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "telemetryExporterName", "in": "path", "description": "The name of the AiGatewayTelemetryExporterResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayTelemetryExporterResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update an AI Gateway TelemetryExporter": { "$ref": "./examples/AiGatewayTelemetryExporterUpdate.json" } } }, "delete": { "operationId": "AiGatewayTelemetryExporterResources_Delete", "tags": [ "AiGatewayTelemetryExporterResources" ], "description": "Delete a AiGatewayTelemetryExporterResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "telemetryExporterName", "in": "path", "description": "The name of the AiGatewayTelemetryExporterResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete an AI Gateway TelemetryExporter": { "$ref": "./examples/AiGatewayTelemetryExporterDelete.json" } } }, "head": { "operationId": "AiGatewayTelemetryExporterResources_CheckExistence", "tags": [ "AiGatewayTelemetryExporterResources" ], "description": "Check for the existence of a AiGatewayTelemetryExporterResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "telemetryExporterName", "in": "path", "description": "The name of the AiGatewayTelemetryExporterResource", "required": true, "type": "string", "pattern": "^[a-zA-Z0-9_-]+$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway TelemetryExporter exists": { "$ref": "./examples/AiGatewayTelemetryExporterCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/toolServers": { "get": { "operationId": "AiGatewayToolServerResources_ListByWorkspace", "tags": [ "AiGatewayToolServerResources" ], "description": "List AiGatewayToolServerResource resources by AiGatewayWorkspaceResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayToolServerResourceListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List tool servers": { "$ref": "./examples/AiGatewayToolServerList.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/toolServers/{toolServerName}": { "get": { "operationId": "AiGatewayToolServerResources_Get", "tags": [ "AiGatewayToolServerResources" ], "description": "Get a AiGatewayToolServerResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayToolServerResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a tool server": { "$ref": "./examples/AiGatewayToolServerGet.json" }, "Get a tool server with OAuth connection status": { "$ref": "./examples/AiGatewayToolServerGetWithOAuth.json" } } }, "put": { "operationId": "AiGatewayToolServerResources_CreateOrUpdate", "tags": [ "AiGatewayToolServerResources" ], "description": "Create a AiGatewayToolServerResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "If-Match", "in": "header", "description": "ETag of the resource. Required for an update.", "required": false, "type": "string", "x-ms-client-name": "ifMatch" }, { "name": "If-None-Match", "in": "header", "description": "Set to '*' to allow creating a new resource, but prevent updating an existing resource.", "required": false, "type": "string", "x-ms-client-name": "ifNoneMatch" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayToolServerResource" } } ], "responses": { "200": { "description": "Resource 'AiGatewayToolServerResource' update operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayToolServerResource" } }, "201": { "description": "Resource 'AiGatewayToolServerResource' create operation succeeded", "schema": { "$ref": "#/definitions/AiGatewayToolServerResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a connector tool server": { "$ref": "./examples/AiGatewayToolServerCreateConnector.json" }, "Create an MCP tool server": { "$ref": "./examples/AiGatewayToolServerCreate.json" }, "Create an OpenAPI tool server with inline and URL document sources": { "$ref": "./examples/AiGatewayToolServerCreateOpenApi.json" } } }, "patch": { "operationId": "AiGatewayToolServerResources_Update", "tags": [ "AiGatewayToolServerResources" ], "description": "Update a AiGatewayToolServerResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/AiGatewayToolServerUpdateParameters" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayToolServerResource" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a tool server": { "$ref": "./examples/AiGatewayToolServerUpdate.json" } } }, "delete": { "operationId": "AiGatewayToolServerResources_Delete", "tags": [ "AiGatewayToolServerResources" ], "description": "Delete a AiGatewayToolServerResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "$ref": "#/parameters/If-Match" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a tool server": { "$ref": "./examples/AiGatewayToolServerDelete.json" } } }, "head": { "operationId": "AiGatewayToolServerResources_CheckExistence", "tags": [ "AiGatewayToolServerResources" ], "description": "Check for the existence of a AiGatewayToolServerResource", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "A successful existence check, with no response body.", "headers": { "ETag": { "type": "string", "description": "Entity tag of the resource." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Check whether an AI Gateway ToolServer exists": { "$ref": "./examples/AiGatewayToolServerCheckExistence.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/toolServers/{toolServerName}/getOauth2LoginLinks": { "post": { "operationId": "AiGatewayToolServerResources_GetOauth2LoginLinks", "tags": [ "AiGatewayToolServerResources" ], "description": "Gets links to complete OAuth consent for a tool server endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" }, { "name": "body", "in": "body", "description": "The content of the action request", "required": true, "schema": { "$ref": "#/definitions/AiGatewayToolServerLoginLinksRequest" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayToolServerOauth2LoginLinks" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get OAuth consent links for a tool server endpoint": { "$ref": "./examples/AiGatewayToolServerGetOauth2LoginLinks.json" } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/aigateways/{aiGatewayName}/workspaces/{workspaceName}/toolServers/{toolServerName}/listSecrets": { "post": { "operationId": "AiGatewayToolServerResources_ListSecrets", "tags": [ "AiGatewayToolServerResources" ], "description": "Lists secret values configured on tool server endpoints.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "aiGatewayName", "in": "path", "description": "The name of the AiGatewayResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, { "name": "workspaceName", "in": "path", "description": "The name of the AiGatewayWorkspaceResource", "required": true, "type": "string", "pattern": "^default$" }, { "name": "toolServerName", "in": "path", "description": "The name of the AiGatewayToolServerResource", "required": true, "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,61}[a-z0-9]$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/AiGatewayToolServerSecrets" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List tool server secrets": { "$ref": "./examples/AiGatewayToolServerListSecrets.json" } } } } }, "definitions": { "AiGatewayAgentHook": { "type": "object", "description": "External hook settings; omitted fields inherit policy-level settings.", "properties": { "mode": { "$ref": "#/definitions/AiGatewayFailureMode", "description": "Failure mode when the hook call fails." }, "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Hook destination URL." }, "authentication": { "$ref": "#/definitions/AiGatewayAgentHookAuthentication", "description": "Hook authentication settings." }, "headers": { "type": "array", "description": "Literal, non-secret HTTP headers, returned by read operations.", "items": { "$ref": "#/definitions/AiGatewayNameValuePair" }, "x-ms-identifiers": [ "name" ] } } }, "AiGatewayAgentHookAuthentication": { "type": "object", "description": "Outbound authentication settings for an external agent hook.", "properties": { "managedIdentity": { "$ref": "#/definitions/AiGatewayManagedIdentityAuthentication", "description": "Managed identity configuration for the hook endpoint." }, "headers": { "type": "array", "description": "Secret HTTP headers injected when calling the hook endpoint.", "items": { "$ref": "#/definitions/AiGatewaySecretHeader" }, "x-ms-identifiers": [] } } }, "AiGatewayAgentHookAuthenticationUpdate": { "type": "object", "description": "Outbound authentication settings to update on an external agent hook.", "properties": { "managedIdentity": { "$ref": "#/definitions/AiGatewayManagedIdentityAuthentication", "description": "Managed identity configuration for the hook endpoint." }, "headers": { "type": "array", "description": "Secret HTTP headers injected when calling the hook endpoint.", "items": { "$ref": "#/definitions/AiGatewaySecretHeaderUpdate" }, "x-ms-identifiers": [] } } }, "AiGatewayAgentHookUpdate": { "type": "object", "description": "External hook settings to update.", "properties": { "mode": { "$ref": "#/definitions/AiGatewayFailureMode", "description": "Failure mode when the hook call fails." }, "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Hook destination URL." }, "authentication": { "$ref": "#/definitions/AiGatewayAgentHookAuthenticationUpdate", "description": "Hook authentication settings." }, "headers": { "type": "array", "description": "Literal, non-secret HTTP headers.", "items": { "$ref": "#/definitions/AiGatewayNameValuePairUpdate" }, "x-ms-identifiers": [] } } }, "AiGatewayAgentHooks": { "type": "object", "description": "Lifecycle hooks supported on models and tool servers.", "properties": { "preToolCall": { "$ref": "#/definitions/AiGatewayAgentHook", "description": "Hook invoked before calling a tool." }, "postToolCall": { "$ref": "#/definitions/AiGatewayAgentHook", "description": "Hook invoked after calling a tool." }, "preModelCall": { "$ref": "#/definitions/AiGatewayAgentHook", "description": "Hook invoked before calling a model." }, "postModelCall": { "$ref": "#/definitions/AiGatewayAgentHook", "description": "Hook invoked after calling a model." } } }, "AiGatewayAgentHooksUpdate": { "type": "object", "description": "Lifecycle hook settings to update.", "properties": { "preToolCall": { "$ref": "#/definitions/AiGatewayAgentHookUpdate", "description": "Hook invoked before calling a tool." }, "postToolCall": { "$ref": "#/definitions/AiGatewayAgentHookUpdate", "description": "Hook invoked after calling a tool." }, "preModelCall": { "$ref": "#/definitions/AiGatewayAgentHookUpdate", "description": "Hook invoked before calling a model." }, "postModelCall": { "$ref": "#/definitions/AiGatewayAgentHookUpdate", "description": "Hook invoked after calling a model." } } }, "AiGatewayAliasFailureRule": { "type": "object", "description": "An ordered failure rule for an AI Gateway alias.", "properties": { "when": { "type": "string", "description": "Boolean @cel(...) expression evaluated against the current routing failure." }, "retryAttempts": { "type": "integer", "format": "int32", "description": "Maximum additional attempts on the same backend; defaults to zero.", "minimum": 0 }, "excludeFor": { "type": "string", "description": "Optional ISO 8601 duration or duration-valued @cel(...) expression for excluding the failed backend." } }, "required": [ "when" ] }, "AiGatewayAliasFailureRuleUpdate": { "type": "object", "description": "An ordered failure rule to update on an AI Gateway alias.", "properties": { "when": { "type": "string", "description": "Boolean @cel(...) expression evaluated against the current routing failure." }, "retryAttempts": { "type": "integer", "format": "int32", "description": "Maximum additional attempts on the same backend; defaults to zero.", "minimum": 0 }, "excludeFor": { "type": "string", "description": "Optional ISO 8601 duration or duration-valued @cel(...) expression for excluding the failed backend." } } }, "AiGatewayAliasProperties": { "type": "object", "description": "Properties of a stable client-facing model alias.", "properties": { "aliasName": { "type": "string", "description": "Client-facing routing name sent in the request model field." }, "description": { "type": "string", "description": "Description of the alias.", "maxLength": 1024 }, "backendModels": { "type": "array", "description": "Ordered target models used for routing.", "minItems": 1, "maxItems": 30, "items": { "$ref": "#/definitions/AiGatewayAliasTarget" }, "x-ms-identifiers": [ "resourceId" ] }, "selectionOrder": { "type": "array", "description": "Ordered routing stages.", "items": { "$ref": "#/definitions/AiGatewayAliasSelectionStage" } }, "sessionBackendPreference": { "$ref": "#/definitions/AiGatewaySessionBackendPreference", "description": "Stateless backend preference using an existing caller session key." }, "autoModelSelection": { "$ref": "#/definitions/AiGatewayModelSelection", "description": "Automatic model selection settings used with the autoModelSelection stage." }, "failures": { "type": "array", "description": "Ordered failure rules; only the first matching rule is applied.", "items": { "$ref": "#/definitions/AiGatewayAliasFailureRule" }, "x-ms-identifiers": [] }, "maxRetryAttempts": { "type": "integer", "format": "int32", "description": "Maximum additional backend attempts after the first request.", "minimum": 0 }, "supportedEndpoints": { "type": "array", "description": "Native endpoints common to every target model; translated endpoints are excluded.", "items": { "type": "string" }, "readOnly": true }, "gatewayEndpoints": { "type": "array", "description": "Invocation endpoints, when endpoint metadata is enabled for this gateway.", "items": { "$ref": "#/definitions/AiGatewayEndpoint" }, "readOnly": true, "x-ms-identifiers": [ "url" ] }, "policies": { "type": "array", "description": "Inline policies applied to requests routed through the alias.", "items": { "$ref": "#/definitions/AiGatewayPolicy" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } }, "required": [ "backendModels" ] }, "AiGatewayAliasResource": { "type": "object", "description": "A stable client-facing model identity backed by an ordered pool of models.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayAliasProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayAliasResourceListResult": { "type": "object", "description": "The response of a AiGatewayAliasResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayAliasResource items on this page", "items": { "$ref": "#/definitions/AiGatewayAliasResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayAliasSelectionStage": { "type": "string", "description": "Routing stage in an AI Gateway alias selection order.", "enum": [ "priority", "autoModelSelection", "sessionBackendPreference" ], "x-ms-enum": { "name": "AiGatewayAliasSelectionStage", "modelAsString": true, "values": [ { "name": "Priority", "value": "priority", "description": "Deterministic priority and weight routing stage." }, { "name": "AutoModelSelection", "value": "autoModelSelection", "description": "Automatic model selection stage." }, { "name": "SessionBackendPreference", "value": "sessionBackendPreference", "description": "Stateless session backend preference stage." } ] } }, "AiGatewayAliasTarget": { "type": "object", "description": "A model targeted by an AI Gateway alias.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "Azure resource identifier of the target model in the default workspace.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/aigateways/workspaces/modelProviders/models" }, { "type": "Microsoft.ApiManagement/service/workspaces/modelProviders/models" } ] } }, "selectorModelName": { "type": "string", "description": "Unversioned canonical model name grouping equivalent serving deployments.", "minLength": 1 }, "when": { "type": "string", "description": "Optional Boolean CEL expression wrapped in @cel(...) controlling eligibility for new backend selections." }, "priority": { "type": "integer", "format": "int32", "description": "Routing priority. Lower values are preferred; the effective default is zero.", "minimum": 0, "maximum": 100 }, "weight": { "type": "integer", "format": "int32", "description": "Relative selection weight within a priority group. The effective default is one.", "minimum": 1, "maximum": 100 } }, "required": [ "resourceId" ] }, "AiGatewayAliasTargetUpdate": { "type": "object", "description": "A model target to update on an AI Gateway alias.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "Azure resource identifier of the target model in the default workspace.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/aigateways/workspaces/modelProviders/models" }, { "type": "Microsoft.ApiManagement/service/workspaces/modelProviders/models" } ] } }, "selectorModelName": { "type": "string", "description": "Unversioned canonical model name grouping equivalent serving deployments.", "minLength": 1 }, "when": { "type": "string", "description": "Optional Boolean CEL expression wrapped in @cel(...) controlling eligibility for new backend selections." }, "priority": { "type": "integer", "format": "int32", "description": "Routing priority. Lower values are preferred; the effective default is zero.", "minimum": 0, "maximum": 100 }, "weight": { "type": "integer", "format": "int32", "description": "Relative selection weight within a priority group. The effective default is one.", "minimum": 1, "maximum": 100 } } }, "AiGatewayAliasUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway alias.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayAliasUpdateProperties", "description": "Alias properties to update." } } }, "AiGatewayAliasUpdateProperties": { "type": "object", "description": "Properties to update on an AI Gateway alias.", "properties": { "aliasName": { "type": "string", "description": "Client-facing routing name sent in the request model field." }, "description": { "type": "string", "description": "Description of the alias.", "maxLength": 1024 }, "backendModels": { "type": "array", "description": "Ordered target models used for routing.", "minItems": 1, "maxItems": 30, "items": { "$ref": "#/definitions/AiGatewayAliasTargetUpdate" }, "x-ms-identifiers": [] }, "selectionOrder": { "type": "array", "description": "Ordered routing stages.", "items": { "$ref": "#/definitions/AiGatewayAliasSelectionStage" } }, "sessionBackendPreference": { "$ref": "#/definitions/AiGatewaySessionBackendPreferenceUpdate", "description": "Stateless backend preference using an existing caller session key." }, "autoModelSelection": { "$ref": "#/definitions/AiGatewayModelSelectionUpdate", "description": "Automatic model selection settings used with the autoModelSelection stage." }, "failures": { "type": "array", "description": "Ordered failure rules; only the first matching rule is applied.", "items": { "$ref": "#/definitions/AiGatewayAliasFailureRuleUpdate" }, "x-ms-identifiers": [] }, "maxRetryAttempts": { "type": "integer", "format": "int32", "description": "Maximum additional backend attempts after the first request.", "minimum": 0 }, "policies": { "type": "array", "description": "Inline policies applied to requests routed through the alias.", "items": { "$ref": "#/definitions/AiGatewayPolicyUpdate" }, "x-ms-identifiers": [] } } }, "AiGatewayAllowedRequestOverride": { "type": "string", "description": "Per-request behavior allowed for automatic model selection.", "enum": [ "model", "objective", "filterModelsForToolCompatibility" ], "x-ms-enum": { "name": "AiGatewayAllowedRequestOverride", "modelAsString": true, "values": [ { "name": "Model", "value": "model", "description": "Allow narrowing the configured selector model pool." }, { "name": "Objective", "value": "objective", "description": "Allow overriding the selection objective." }, { "name": "FilterModelsForToolCompatibility", "value": "filterModelsForToolCompatibility", "description": "Enable chat function-tool compatibility filtering without granting either override." } ] } }, "AiGatewayApiKeyProperties": { "type": "object", "description": "Properties of an AI Gateway API key.", "properties": { "displayName": { "type": "string", "description": "Display name of the key." }, "state": { "type": "string", "description": "Subscription state." }, "createdDate": { "type": "string", "format": "date-time", "description": "Creation time.", "readOnly": true }, "expirationDate": { "type": "string", "format": "date-time", "description": "Optional expiration time." }, "primaryKey": { "type": "string", "format": "password", "description": "Primary key value. Omitted from ordinary read responses.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "secondaryKey": { "type": "string", "format": "password", "description": "Secondary key value. Omitted from ordinary read responses.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } } }, "AiGatewayApiKeyResource": { "type": "object", "description": "An AI Gateway API key resource.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayApiKeyProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayApiKeyResourceListResult": { "type": "object", "description": "The response of a AiGatewayApiKeyResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayApiKeyResource items on this page", "items": { "$ref": "#/definitions/AiGatewayApiKeyResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayApiKeyUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway API key.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayApiKeyUpdateProperties", "description": "API key properties to update." } } }, "AiGatewayApiKeyUpdateProperties": { "type": "object", "description": "Properties for updating an AI Gateway API key.", "properties": { "displayName": { "type": "string", "description": "Display name of the key." }, "state": { "type": "string", "description": "Subscription state." }, "expirationDate": { "type": "string", "format": "date-time", "description": "Optional expiration time." }, "primaryKey": { "type": "string", "format": "password", "description": "Replacement primary key value.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "secondaryKey": { "type": "string", "format": "password", "description": "Replacement secondary key value.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true } } }, "AiGatewayApiKeyValues": { "type": "object", "description": "Primary and secondary API key values.", "properties": { "primaryKey": { "type": "string", "format": "password", "description": "Primary API key value.", "x-ms-secret": true }, "secondaryKey": { "type": "string", "format": "password", "description": "Secondary API key value.", "x-ms-secret": true } }, "required": [ "primaryKey", "secondaryKey" ] }, "AiGatewayApplicationInsightsConfiguration": { "type": "object", "description": "Application Insights export destination.", "properties": { "connectionString": { "type": "string", "format": "password", "description": "Application Insights connection string. Required when creating this exporter kind.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "resourceId": { "type": "string", "format": "arm-id", "description": "Azure resource identifier of the Application Insights component.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Insights/components" } ] } } } }, "AiGatewayBackend": { "type": "object", "description": "Backend networking configuration of an AI Gateway.", "properties": { "subnet": { "$ref": "#/definitions/AiGatewaySubnet", "description": "Subnet through which the AI Gateway reaches backends." } } }, "AiGatewayBackendUpdate": { "type": "object", "description": "Backend networking configuration to update on an AI Gateway.", "properties": { "subnet": { "$ref": "#/definitions/AiGatewaySubnetUpdate", "description": "Subnet through which the AI Gateway reaches backends. Omit it to keep the current subnet, or set it to null to remove it." } } }, "AiGatewayCheckNameAvailabilityRequest": { "type": "object", "description": "Parameters for checking an AI Gateway name in a location.", "properties": { "name": { "type": "string", "description": "Name to validate and check for availability.", "minLength": 3, "maxLength": 24, "pattern": "^[a-z0-9][a-z0-9-]{1,22}[a-z0-9]$" }, "type": { "type": "string", "description": "Resource type to check.", "enum": [ "Microsoft.ApiManagement/aigateways" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "name", "type" ] }, "AiGatewayCheckNameAvailabilityResponse": { "type": "object", "description": "Availability of an AI Gateway name in a location.", "properties": { "nameAvailable": { "type": "boolean", "description": "Whether the name is valid and available." }, "reason": { "$ref": "#/definitions/AiGatewayNameAvailabilityReason", "description": "Reason for the availability result." }, "message": { "type": "string", "description": "Additional information about the availability result." } }, "required": [ "nameAvailable" ] }, "AiGatewayContentSafetySeverity": { "type": "string", "description": "Severity threshold used by a content safety policy.", "enum": [ "Low", "Medium", "High", "None" ], "x-ms-enum": { "name": "AiGatewayContentSafetySeverity", "modelAsString": true, "values": [ { "name": "Low", "value": "Low", "description": "Low severity." }, { "name": "Medium", "value": "Medium", "description": "Medium severity." }, { "name": "High", "value": "High", "description": "High severity." }, { "name": "None", "value": "None", "description": "Do not filter this category." } ] } }, "AiGatewayCostLimitOverride": { "type": "object", "description": "An ordered cost-budget override; exactly one selector must be specified.", "properties": { "claims": { "type": "array", "description": "Authenticated token claims that must all match; claim names are case-sensitive.", "items": { "$ref": "#/definitions/AiGatewayNameValuePair" }, "x-ms-identifiers": [ "name" ] }, "apiKeyResourceId": { "type": "string", "format": "arm-id", "description": "Azure resource identifier of the API key selecting this override.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/aigateways/apiKeys" }, { "type": "Microsoft.ApiManagement/service/apiKeys" } ] } }, "amount": { "type": "number", "format": "decimal", "description": "Override budget in US dollars." } }, "required": [ "amount" ] }, "AiGatewayCostLimitOverrideUpdate": { "type": "object", "description": "An ordered cost-budget override to update.", "properties": { "claims": { "type": "array", "description": "Authenticated token claims that must all match; claim names are case-sensitive.", "items": { "$ref": "#/definitions/AiGatewayNameValuePairUpdate" }, "x-ms-identifiers": [] }, "apiKeyResourceId": { "type": "string", "format": "arm-id", "description": "Azure resource identifier of the API key selecting this override.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/aigateways/apiKeys" }, { "type": "Microsoft.ApiManagement/service/apiKeys" } ] } }, "amount": { "type": "number", "format": "decimal", "description": "Override budget in US dollars." } } }, "AiGatewayCounterDimension": { "type": "string", "description": "Public request dimension used to partition a policy counter.", "enum": [ "identity", "ipAddress" ], "x-ms-enum": { "name": "AiGatewayCounterDimension", "modelAsString": true, "values": [ { "name": "Identity", "value": "identity", "description": "Authenticated request identity." }, { "name": "IpAddress", "value": "ipAddress", "description": "Request source IP address." } ] } }, "AiGatewayCustomProviderConfiguration": { "type": "object", "description": "Custom model provider configuration.", "properties": { "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Provider base endpoint." } }, "required": [ "endpoint" ] }, "AiGatewayCustomProviderConfigurationUpdate": { "type": "object", "description": "Custom model provider settings to update.", "properties": { "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Provider base endpoint." } } }, "AiGatewayDestinationEndpoint": { "type": "object", "description": "An outbound service destination URL.", "properties": { "url": { "type": "string", "format": "uri", "description": "Destination HTTPS or HTTP URL." } }, "required": [ "url" ] }, "AiGatewayDestinationEndpointUpdate": { "type": "object", "description": "An outbound service destination URL to update.", "properties": { "url": { "type": "string", "format": "uri", "description": "Destination HTTPS or HTTP URL." } } }, "AiGatewayEndpoint": { "type": "object", "description": "A client-facing endpoint for invoking an AI Gateway resource.", "properties": { "url": { "type": "string", "format": "uri", "description": "Complete HTTPS invocation URL.", "readOnly": true }, "baseUrl": { "type": "string", "format": "uri", "description": "HTTPS base URL for SDKs that construct operation paths, when metadata is enabled.", "readOnly": true }, "api": { "type": "string", "description": "API identifier relative to the provider prefix, when metadata is enabled.", "readOnly": true } }, "required": [ "url" ] }, "AiGatewayFailureMode": { "type": "string", "description": "Resilience failure mode for an outbound endpoint or hook.", "enum": [ "failOpen", "failClosed" ], "x-ms-enum": { "name": "AiGatewayFailureMode", "modelAsString": true, "values": [ { "name": "FailOpen", "value": "failOpen", "description": "Continue processing when the endpoint or hook fails." }, { "name": "FailClosed", "value": "failClosed", "description": "Fail the request when the endpoint or hook fails." } ] } }, "AiGatewayFallbackTarget": { "type": "object", "description": "A fallback target for a model policy.", "properties": { "modelId": { "type": "string", "format": "arm-id", "description": "Resource identifier of a model in the same workspace.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/aigateways/workspaces/modelProviders/models" }, { "type": "Microsoft.ApiManagement/service/workspaces/modelProviders/models" } ] } } }, "required": [ "modelId" ] }, "AiGatewayFallbackTargetUpdate": { "type": "object", "description": "A fallback target to update on a model policy.", "properties": { "modelId": { "type": "string", "format": "arm-id", "description": "Resource identifier of a model in the same workspace.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.ApiManagement/aigateways/workspaces/modelProviders/models" }, { "type": "Microsoft.ApiManagement/service/workspaces/modelProviders/models" } ] } } } }, "AiGatewayFoundryProviderConfiguration": { "type": "object", "description": "Foundry model provider configuration.", "properties": { "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Foundry endpoint." }, "resourceIds": { "type": "array", "description": "Cognitive Services account resource identifiers available to this provider.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CognitiveServices/accounts" } ] } } } }, "required": [ "resourceIds" ] }, "AiGatewayFoundryProviderConfigurationUpdate": { "type": "object", "description": "Foundry model provider settings to update.", "properties": { "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Foundry endpoint." }, "resourceIds": { "type": "array", "description": "Cognitive Services account resource identifiers available to this provider.", "items": { "type": "string", "format": "arm-id", "description": "A type definition that refers the id to an Azure Resource Manager resource.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CognitiveServices/accounts" } ] } } } } }, "AiGatewayFrontend": { "type": "object", "description": "Frontend configuration of an AI Gateway.", "properties": { "defaultHostname": { "type": "string", "description": "Default hostname used to invoke the AI Gateway.", "readOnly": true } } }, "AiGatewayGitHubAppAuthentication": { "type": "object", "description": "GitHub App credentials for a GitHub model provider.", "properties": { "appId": { "type": "string", "description": "GitHub App identifier." }, "installationId": { "type": "string", "description": "GitHub App installation identifier." }, "privateKey": { "type": "string", "format": "password", "description": "GitHub App private key. Omitted from ordinary read responses.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true } } }, "AiGatewayIpFilterAction": { "type": "string", "description": "Action performed by an IP filtering policy.", "enum": [ "Allow", "Deny" ], "x-ms-enum": { "name": "AiGatewayIpFilterAction", "modelAsString": true, "values": [ { "name": "Allow", "value": "Allow", "description": "Allow matching addresses." }, { "name": "Deny", "value": "Deny", "description": "Deny matching addresses." } ] } }, "AiGatewayManagedIdentityAuthentication": { "type": "object", "description": "Managed identity settings for an outbound connection.", "properties": { "resource": { "type": "string", "description": "Target Entra resource or audience URI requested for managed identity authentication." }, "clientId": { "type": "string", "description": "Client ID of a user-assigned managed identity; omit for system-assigned identity." } } }, "AiGatewayMcpUrlConfiguration": { "type": "object", "description": "MCP endpoint configuration.", "properties": { "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Backend MCP server endpoint." }, "transport": { "$ref": "#/definitions/AiGatewayToolServerMcpTransport", "description": "MCP transport." } }, "required": [ "endpoint" ] }, "AiGatewayMcpUrlConfigurationUpdate": { "type": "object", "description": "MCP endpoint settings to update.", "properties": { "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Backend MCP server endpoint." }, "transport": { "$ref": "#/definitions/AiGatewayToolServerMcpTransport", "description": "MCP transport." } } }, "AiGatewayModelDeployment": { "type": "object", "description": "Deployment details for an AI Gateway model.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "ARM resource identifier of the provider deployment.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CognitiveServices/accounts/deployments" } ] } }, "modelName": { "type": "string", "description": "Provider-side model name." }, "modelVersion": { "type": "string", "description": "Provider-side model version." } }, "required": [ "modelName" ] }, "AiGatewayModelDeploymentUpdate": { "type": "object", "description": "Deployment details to update on an AI Gateway model.", "properties": { "resourceId": { "type": "string", "format": "arm-id", "description": "ARM resource identifier of the provider deployment.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.CognitiveServices/accounts/deployments" } ] } }, "modelName": { "type": "string", "description": "Provider-side model name." }, "modelVersion": { "type": "string", "description": "Provider-side model version." } } }, "AiGatewayModelEndpoint": { "type": "object", "description": "Maps a canonical AI Gateway API identifier to a relative backend path served by the model provider.", "properties": { "api": { "type": "string", "description": "Canonical AI Gateway API identifier (for example, v1/chat/completions, v1/responses, v1/messages, or v1/embeddings)." }, "path": { "type": "string", "description": "Backend path relative to the model provider's base endpoint, starting with '/'." } }, "required": [ "api", "path" ] }, "AiGatewayModelEndpointUpdate": { "type": "object", "description": "A model endpoint mapping to update.", "properties": { "api": { "type": "string", "description": "Canonical AI Gateway API identifier (for example, v1/chat/completions, v1/responses, v1/messages, or v1/embeddings)." }, "path": { "type": "string", "description": "Backend path relative to the model provider's base endpoint, starting with '/'." } } }, "AiGatewayModelProperties": { "type": "object", "description": "Properties of an AI Gateway model.", "properties": { "displayName": { "type": "string", "description": "Display name of the model." }, "description": { "type": "string", "description": "Description of the model." }, "providerKind": { "$ref": "#/definitions/AiGatewayModelProviderKind", "description": "Parent model provider type.", "readOnly": true }, "deployment": { "$ref": "#/definitions/AiGatewayModelDeployment", "description": "Provider deployment details." }, "endpoints": { "type": "array", "description": "API-to-backend-path mappings served by this model.", "items": { "$ref": "#/definitions/AiGatewayModelEndpoint" }, "x-ms-identifiers": [ "api" ] }, "supportedEndpoints": { "type": "array", "description": "Runtime endpoints supported by this model.", "items": { "type": "string" } }, "policies": { "type": "array", "description": "Inline policies applied to this model.", "items": { "$ref": "#/definitions/AiGatewayPolicy" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } }, "required": [ "displayName", "deployment" ] }, "AiGatewayModelProviderAuthentication": { "type": "object", "description": "Outbound authentication configuration for a model provider.", "properties": { "githubApp": { "$ref": "#/definitions/AiGatewayGitHubAppAuthentication", "description": "GitHub App credentials when modelProviderType is GitHub." }, "managedIdentity": { "$ref": "#/definitions/AiGatewayManagedIdentityAuthentication", "description": "Managed identity configuration when modelProviderType is Foundry." }, "headers": { "type": "array", "description": "Secret HTTP headers injected when calling the model provider.", "items": { "$ref": "#/definitions/AiGatewaySecretHeader" }, "x-ms-identifiers": [] } } }, "AiGatewayModelProviderAuthenticationUpdate": { "type": "object", "description": "Outbound authentication configuration to update on a model provider.", "properties": { "githubApp": { "$ref": "#/definitions/AiGatewayGitHubAppAuthentication", "description": "GitHub App credentials when modelProviderType is GitHub." }, "managedIdentity": { "$ref": "#/definitions/AiGatewayManagedIdentityAuthentication", "description": "Managed identity configuration when modelProviderType is Foundry." }, "headers": { "type": "array", "description": "Secret HTTP headers injected when calling the model provider.", "items": { "$ref": "#/definitions/AiGatewaySecretHeaderUpdate" }, "x-ms-identifiers": [] } } }, "AiGatewayModelProviderKind": { "type": "string", "description": "The type of an AI model provider.", "enum": [ "Foundry", "Custom", "GitHub" ], "x-ms-enum": { "name": "AiGatewayModelProviderKind", "modelAsString": true, "values": [ { "name": "Foundry", "value": "Foundry", "description": "Azure AI Foundry provider." }, { "name": "Custom", "value": "Custom", "description": "Custom model provider." }, { "name": "GitHub", "value": "GitHub", "description": "GitHub model provider." } ] } }, "AiGatewayModelProviderProperties": { "type": "object", "description": "Properties of an AI Gateway model provider.", "properties": { "modelProviderType": { "$ref": "#/definitions/AiGatewayModelProviderKind", "description": "Model provider type. This value cannot be changed after creation.", "x-ms-mutability": [ "read", "create" ] }, "displayName": { "type": "string", "description": "Display name of the model provider." }, "description": { "type": "string", "description": "Description of the model provider." }, "foundry": { "$ref": "#/definitions/AiGatewayFoundryProviderConfiguration", "description": "Foundry configuration. Required when modelProviderType is Foundry." }, "custom": { "$ref": "#/definitions/AiGatewayCustomProviderConfiguration", "description": "Custom provider configuration. Required when modelProviderType is Custom." }, "authentication": { "$ref": "#/definitions/AiGatewayModelProviderAuthentication", "description": "Outbound authentication configuration." }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } }, "required": [ "modelProviderType", "displayName" ] }, "AiGatewayModelProviderResource": { "type": "object", "description": "An AI Gateway model provider resource.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayModelProviderProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayModelProviderResourceListResult": { "type": "object", "description": "The response of a AiGatewayModelProviderResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayModelProviderResource items on this page", "items": { "$ref": "#/definitions/AiGatewayModelProviderResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayModelProviderSecretAuthentication": { "type": "object", "description": "Authentication settings returned by the model-provider secret retrieval action.", "properties": { "githubApp": { "$ref": "#/definitions/AiGatewayModelProviderSecretGitHubAppAuthentication", "description": "GitHub App credentials when modelProviderType is GitHub." }, "managedIdentity": { "$ref": "#/definitions/AiGatewayManagedIdentityAuthentication", "description": "Managed identity configuration when modelProviderType is Foundry." }, "headers": { "type": "array", "description": "Secret HTTP headers injected when calling the model provider.", "items": { "$ref": "#/definitions/AiGatewaySecretHeaderValue" }, "x-ms-identifiers": [] } } }, "AiGatewayModelProviderSecretGitHubAppAuthentication": { "type": "object", "description": "GitHub App credentials returned by the model-provider secret retrieval action.", "properties": { "appId": { "type": "string", "description": "GitHub App identifier." }, "installationId": { "type": "string", "description": "GitHub App installation identifier." }, "privateKey": { "type": "string", "format": "password", "description": "GitHub App private key.", "x-ms-secret": true } } }, "AiGatewayModelProviderSecrets": { "type": "object", "description": "Secret values configured on a model provider.", "properties": { "authentication": { "$ref": "#/definitions/AiGatewayModelProviderSecretAuthentication", "description": "Outbound authentication configuration including secret values." } } }, "AiGatewayModelProviderUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway model provider.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayModelProviderUpdateProperties", "description": "Model provider properties to update." } } }, "AiGatewayModelProviderUpdateProperties": { "type": "object", "description": "Properties for updating an AI Gateway model provider.", "properties": { "displayName": { "type": "string", "description": "Display name of the model provider." }, "description": { "type": "string", "description": "Description of the model provider." }, "foundry": { "$ref": "#/definitions/AiGatewayFoundryProviderConfigurationUpdate", "description": "Foundry configuration." }, "custom": { "$ref": "#/definitions/AiGatewayCustomProviderConfigurationUpdate", "description": "Custom provider configuration." }, "authentication": { "$ref": "#/definitions/AiGatewayModelProviderAuthenticationUpdate", "description": "Outbound authentication configuration." } } }, "AiGatewayModelResource": { "type": "object", "description": "An AI Gateway model resource.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayModelProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayModelResourceListResult": { "type": "object", "description": "The response of a AiGatewayModelResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayModelResource items on this page", "items": { "$ref": "#/definitions/AiGatewayModelResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayModelSelection": { "type": "object", "description": "Automatic model selection configuration for an AI Gateway alias.", "properties": { "objective": { "$ref": "#/definitions/AiGatewayModelSelectionObjective", "description": "Configured quality/cost objective." }, "allowedRequestOverrides": { "type": "array", "description": "Allowed per-request behaviors. Omitting the property or sending an empty array denies overrides and disables function-tool compatibility filtering.", "items": { "$ref": "#/definitions/AiGatewayAllowedRequestOverride" } } }, "required": [ "objective" ] }, "AiGatewayModelSelectionObjective": { "type": "string", "description": "Quality and cost objective for automatic model selection.", "enum": [ "Balanced", "Cost", "Quality" ], "x-ms-enum": { "name": "AiGatewayModelSelectionObjective", "modelAsString": true, "values": [ { "name": "Balanced", "value": "Balanced", "description": "Balance quality and cost." }, { "name": "Cost", "value": "Cost", "description": "Prefer lower cost." }, { "name": "Quality", "value": "Quality", "description": "Prefer higher quality." } ] } }, "AiGatewayModelSelectionUpdate": { "type": "object", "description": "Automatic model selection configuration to update.", "properties": { "objective": { "$ref": "#/definitions/AiGatewayModelSelectionObjective", "description": "Configured quality/cost objective." }, "allowedRequestOverrides": { "type": "array", "description": "Allowed per-request behaviors. Omitting the property or sending an empty array denies overrides and disables function-tool compatibility filtering.", "items": { "$ref": "#/definitions/AiGatewayAllowedRequestOverride" } } } }, "AiGatewayModelUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway model.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayModelUpdateProperties", "description": "Model properties to update." } } }, "AiGatewayModelUpdateProperties": { "type": "object", "description": "Properties for updating an AI Gateway model.", "properties": { "displayName": { "type": "string", "description": "Display name of the model." }, "description": { "type": "string", "description": "Description of the model." }, "deployment": { "$ref": "#/definitions/AiGatewayModelDeploymentUpdate", "description": "Provider deployment details." }, "endpoints": { "type": "array", "description": "API-to-backend-path mappings served by this model.", "items": { "$ref": "#/definitions/AiGatewayModelEndpointUpdate" }, "x-ms-identifiers": [] }, "policies": { "type": "array", "description": "Inline policies applied to this model.", "items": { "$ref": "#/definitions/AiGatewayPolicyUpdate" }, "x-ms-identifiers": [] }, "supportedEndpoints": { "type": "array", "description": "Runtime endpoints supported by this model.", "items": { "type": "string" } } } }, "AiGatewayNameAvailabilityReason": { "type": "string", "description": "Result of name validation and availability checking.", "enum": [ "Invalid", "AlreadyExists" ], "x-ms-enum": { "name": "AiGatewayNameAvailabilityReason", "modelAsString": true, "values": [ { "name": "Invalid", "value": "Invalid", "description": "The name does not satisfy gateway naming requirements." }, { "name": "AlreadyExists", "value": "AlreadyExists", "description": "A gateway with this name already exists in the location." } ] } }, "AiGatewayNameValuePair": { "type": "object", "description": "A name/value pair entry.", "properties": { "name": { "type": "string", "description": "Entry name." }, "value": { "type": "string", "description": "Entry value." } }, "required": [ "name", "value" ] }, "AiGatewayNameValuePairUpdate": { "type": "object", "description": "A name/value pair entry to update.", "properties": { "name": { "type": "string", "description": "Entry name." }, "value": { "type": "string", "description": "Entry value." } } }, "AiGatewayOpenApiConfiguration": { "type": "object", "description": "OpenAPI-backed MCP endpoint configuration.", "properties": { "specSource": { "$ref": "#/definitions/AiGatewayOpenApiSpecSource", "description": "OpenAPI document source." } }, "required": [ "specSource" ] }, "AiGatewayOpenApiConfigurationUpdate": { "type": "object", "description": "OpenAPI-backed MCP endpoint settings to update.", "properties": { "specSource": { "$ref": "#/definitions/AiGatewayOpenApiSpecSourceUpdate", "description": "OpenAPI document source." } } }, "AiGatewayOpenApiSpecSource": { "type": "object", "description": "Source of an OpenAPI document.", "properties": { "type": { "$ref": "#/definitions/AiGatewayToolServerOpenApiSourceType", "description": "Source type." }, "contentBase64": { "type": "string", "format": "password", "description": "Base64-encoded OpenAPI document. Required when type is inline.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "url": { "type": "string", "format": "uri", "description": "URL of the OpenAPI document. Required when type is url." } }, "required": [ "type" ] }, "AiGatewayOpenApiSpecSourceUpdate": { "type": "object", "description": "OpenAPI document source settings to update.", "properties": { "type": { "$ref": "#/definitions/AiGatewayToolServerOpenApiSourceType", "description": "Source type." }, "contentBase64": { "type": "string", "format": "password", "description": "Base64-encoded OpenAPI document.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "url": { "type": "string", "format": "uri", "description": "URL of the OpenAPI document." } } }, "AiGatewayOpenTelemetryConfiguration": { "type": "object", "description": "OpenTelemetry export signal destinations.", "properties": { "metricsEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Full OTLP metrics endpoint URL, used without appending a signal path." }, "logsEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Full OTLP logs endpoint URL, used without appending a signal path." }, "tracesEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Full OTLP traces endpoint URL, used without appending a signal path." } } }, "AiGatewayOpenTelemetryConfigurationUpdate": { "type": "object", "description": "OpenTelemetry export signal destinations to update.", "properties": { "metricsEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Full OTLP metrics endpoint URL, used without appending a signal path." }, "logsEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Full OTLP logs endpoint URL, used without appending a signal path." }, "tracesEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Full OTLP traces endpoint URL, used without appending a signal path." } } }, "AiGatewayPolicy": { "type": "object", "description": "An inline policy. Supported policy types and scopes depend on the parent resource.", "properties": { "type": { "$ref": "#/definitions/AiGatewayPolicyType", "description": "Policy type." }, "scope": { "$ref": "#/definitions/AiGatewayPolicyScope", "description": "Policy scope. Workspace counter policies use workspace; other policies use resource. Agent hooks require an explicit resource scope." }, "id": { "type": "string", "description": "Stable identifier, required for costLimit and agentHooks policies." }, "count": { "type": "integer", "format": "int32", "description": "Token or request count allowed during a tokenLimit or requestRateLimit period.", "minimum": 1 }, "period": { "$ref": "#/definitions/AiGatewayPolicyPeriod", "description": "Counter period. Token limits support minute/hour/day; request rate limits support minute/hour/day or whole-second ISO 8601 durations (e.g., PT37S); cost limits support hour/day/week/month/year." }, "counterKey": { "type": "array", "description": "Unique public dimensions used to partition a token, cost, or request counter.", "items": { "$ref": "#/definitions/AiGatewayCounterDimension" } }, "amount": { "type": "number", "format": "decimal", "description": "Cost budget in US dollars." }, "overrides": { "type": "array", "description": "Ordered cost-budget overrides; supported only for counterKey [identity]. The first match wins.", "items": { "$ref": "#/definitions/AiGatewayCostLimitOverride" }, "x-ms-identifiers": [] }, "preInvocation": { "type": "boolean", "description": "Whether to check tool requests for threats." }, "postInvocation": { "type": "boolean", "description": "Whether to check tool responses for threats." }, "mode": { "$ref": "#/definitions/AiGatewayFailureMode", "description": "Default failure mode for agent hooks." }, "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "Default destination URL for agent hooks." }, "authentication": { "$ref": "#/definitions/AiGatewayAgentHookAuthentication", "description": "Default outbound authentication for agent hooks." }, "headers": { "type": "array", "description": "Literal non-secret default HTTP headers for agent hooks.", "items": { "$ref": "#/definitions/AiGatewayNameValuePair" }, "x-ms-identifiers": [ "name" ] }, "hooks": { "$ref": "#/definitions/AiGatewayAgentHooks", "description": "Lifecycle hooks; requires agent-hook authoring to be enabled on the gateway." }, "hateSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Hate-content severity threshold." }, "violenceSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Violence-content severity threshold." }, "sexualSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Sexual-content severity threshold." }, "selfHarmSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Self-harm-content severity threshold." }, "threshold": { "type": "integer", "format": "int32", "description": "Consecutive failure count that opens a fallback circuit." }, "tripDurationSeconds": { "type": "integer", "format": "int32", "description": "Duration for which the fallback circuit remains open." }, "fallbackTargets": { "type": "array", "description": "Ordered fallback model targets.", "items": { "$ref": "#/definitions/AiGatewayFallbackTarget" }, "x-ms-identifiers": [ "modelId" ] }, "action": { "$ref": "#/definitions/AiGatewayIpFilterAction", "description": "IP filtering action." }, "cidrRanges": { "type": "array", "description": "CIDR ranges to allow or deny.", "items": { "type": "string" } }, "allowedOrigins": { "type": "array", "description": "Origins allowed by a CORS policy.", "items": { "type": "string" } }, "allowedMethods": { "type": "array", "description": "HTTP methods allowed by a CORS policy.", "items": { "type": "string" } }, "allowedHeaders": { "type": "array", "description": "HTTP headers allowed by a CORS policy.", "items": { "type": "string" } }, "exposeHeaders": { "type": "array", "description": "Response headers exposed to the browser.", "items": { "type": "string" } }, "allowCredentials": { "type": "boolean", "description": "Whether browsers may send credentials." }, "terminateUnmatchedRequest": { "type": "boolean", "description": "Whether unmatched CORS requests are terminated." }, "preflightResultMaxAge": { "type": "integer", "format": "int32", "description": "Browser preflight cache duration in seconds." } }, "required": [ "type" ] }, "AiGatewayPolicyPeriod": { "type": "string", "description": "Counter period. Token limits support minute/hour/day; request rate limits support minute/hour/day or whole-second ISO 8601 durations (e.g., PT37S); cost limits support hour/day/week/month/year.", "enum": [ "minute", "hour", "day", "week", "month", "year" ], "x-ms-enum": { "name": "AiGatewayPolicyPeriod", "modelAsString": true, "values": [ { "name": "Minute", "value": "minute", "description": "One minute." }, { "name": "Hour", "value": "hour", "description": "One hour." }, { "name": "Day", "value": "day", "description": "One day." }, { "name": "Week", "value": "week", "description": "One week, for cost limits only." }, { "name": "Month", "value": "month", "description": "One month, for cost limits only." }, { "name": "Year", "value": "year", "description": "One year, for cost limits only." } ] } }, "AiGatewayPolicyScope": { "type": "string", "description": "Aggregation scope of an inline policy.", "enum": [ "resource", "workspace" ], "x-ms-enum": { "name": "AiGatewayPolicyScope", "modelAsString": true, "values": [ { "name": "Resource", "value": "resource", "description": "Apply the policy to its resource." }, { "name": "Workspace", "value": "workspace", "description": "Aggregate counters across the workspace. Supported for workspace counter policies only." } ] } }, "AiGatewayPolicyType": { "type": "string", "description": "The type of an inline AI Gateway policy.", "enum": [ "tokenLimit", "contentSafety", "fallback", "ipFilter", "requestRateLimit", "cors", "costLimit", "toolThreatProtection", "agentHooks" ], "x-ms-enum": { "name": "AiGatewayPolicyType", "modelAsString": true, "values": [ { "name": "TokenLimit", "value": "tokenLimit", "description": "Limit consumed tokens." }, { "name": "ContentSafety", "value": "contentSafety", "description": "Filter unsafe content." }, { "name": "Fallback", "value": "fallback", "description": "Route to fallback models after failures." }, { "name": "IpFilter", "value": "ipFilter", "description": "Filter clients by IP address." }, { "name": "RequestRateLimit", "value": "requestRateLimit", "description": "Limit requests over time." }, { "name": "Cors", "value": "cors", "description": "Configure cross-origin resource sharing." }, { "name": "CostLimit", "value": "costLimit", "description": "Limit cumulative spending in US dollars." }, { "name": "ToolThreatProtection", "value": "toolThreatProtection", "description": "Check tool requests and responses for threats." }, { "name": "AgentHooks", "value": "agentHooks", "description": "Invoke external pre-tool-call and post-tool-call hooks when authoring is enabled." } ] } }, "AiGatewayPolicyUpdate": { "type": "object", "description": "An inline policy to update on an AI Gateway model or tool server.", "properties": { "type": { "$ref": "#/definitions/AiGatewayPolicyType", "description": "Policy type." }, "scope": { "$ref": "#/definitions/AiGatewayPolicyScope", "description": "Aggregation scope supported by the policy and its parent resource." }, "id": { "type": "string", "description": "Stable identifier for costLimit or agentHooks." }, "count": { "type": "integer", "format": "int32", "description": "Token or request count allowed during a tokenLimit or requestRateLimit period.", "minimum": 1 }, "period": { "$ref": "#/definitions/AiGatewayPolicyPeriod", "description": "Counter period. Token limits support minute/hour/day; request rate limits support minute/hour/day or whole-second ISO 8601 durations (e.g., PT37S); cost limits support hour/day/week/month/year." }, "counterKey": { "type": "array", "description": "Public dimensions used to partition a token, cost, or request counter.", "items": { "$ref": "#/definitions/AiGatewayCounterDimension" } }, "amount": { "type": "number", "format": "decimal", "description": "Cost budget in US dollars." }, "overrides": { "type": "array", "description": "Ordered cost-budget overrides.", "items": { "$ref": "#/definitions/AiGatewayCostLimitOverrideUpdate" }, "x-ms-identifiers": [] }, "preInvocation": { "type": "boolean", "description": "Whether to check tool requests for threats." }, "postInvocation": { "type": "boolean", "description": "Whether to check tool responses for threats." }, "mode": { "$ref": "#/definitions/AiGatewayFailureMode", "description": "Default failure mode for agent hooks." }, "endpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpointUpdate", "description": "Default destination URL for agent hooks." }, "authentication": { "$ref": "#/definitions/AiGatewayAgentHookAuthenticationUpdate", "description": "Default outbound authentication for agent hooks." }, "headers": { "type": "array", "description": "Literal non-secret default HTTP headers for agent hooks.", "items": { "$ref": "#/definitions/AiGatewayNameValuePairUpdate" }, "x-ms-identifiers": [] }, "hooks": { "$ref": "#/definitions/AiGatewayAgentHooksUpdate", "description": "Lifecycle hooks to update." }, "hateSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Hate-content severity threshold." }, "violenceSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Violence-content severity threshold." }, "sexualSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Sexual-content severity threshold." }, "selfHarmSeverity": { "$ref": "#/definitions/AiGatewayContentSafetySeverity", "description": "Self-harm-content severity threshold." }, "threshold": { "type": "integer", "format": "int32", "description": "Consecutive failure count that opens a fallback circuit." }, "tripDurationSeconds": { "type": "integer", "format": "int32", "description": "Duration for which the fallback circuit remains open." }, "fallbackTargets": { "type": "array", "description": "Ordered fallback model targets.", "items": { "$ref": "#/definitions/AiGatewayFallbackTargetUpdate" }, "x-ms-identifiers": [] }, "action": { "$ref": "#/definitions/AiGatewayIpFilterAction", "description": "IP filtering action." }, "cidrRanges": { "type": "array", "description": "CIDR ranges to allow or deny.", "items": { "type": "string" } }, "allowedOrigins": { "type": "array", "description": "Origins allowed by a CORS policy.", "items": { "type": "string" } }, "allowedMethods": { "type": "array", "description": "HTTP methods allowed by a CORS policy.", "items": { "type": "string" } }, "allowedHeaders": { "type": "array", "description": "HTTP headers allowed by a CORS policy.", "items": { "type": "string" } }, "exposeHeaders": { "type": "array", "description": "Response headers exposed to the browser.", "items": { "type": "string" } }, "allowCredentials": { "type": "boolean", "description": "Whether browsers may send credentials." }, "terminateUnmatchedRequest": { "type": "boolean", "description": "Whether unmatched CORS requests are terminated." }, "preflightResultMaxAge": { "type": "integer", "format": "int32", "description": "Browser preflight cache duration in seconds." } } }, "AiGatewayPrivateEndpointConnectionListResult": { "type": "object", "description": "The response of a AiGatewayPrivateEndpointConnection list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayPrivateEndpointConnection items on this page", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayPrivateLinkResourceListResult": { "type": "object", "description": "The response of a AiGatewayPrivateLinkResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayPrivateLinkResource items on this page", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateLinkResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayProperties": { "type": "object", "description": "Properties of an AI Gateway.", "properties": { "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true }, "frontend": { "$ref": "#/definitions/AiGatewayFrontend", "description": "Frontend configuration of the AI Gateway.", "readOnly": true }, "backend": { "$ref": "#/definitions/AiGatewayBackend", "description": "Backend networking configuration.", "x-ms-mutability": [ "read", "update", "create" ] }, "publicNetworkAccess": { "$ref": "#/definitions/AiGatewayPublicNetworkAccess", "description": "Whether public network access is allowed for the AI Gateway." }, "privateEndpointConnections": { "type": "array", "description": "Private endpoint connections associated with the AI Gateway.", "items": { "$ref": "../../../../../../common-types/resource-management/v6/privatelinks.json#/definitions/PrivateEndpointConnection" }, "readOnly": true, "x-ms-identifiers": [ "id" ] } } }, "AiGatewayProvisioningState": { "type": "string", "description": "Provisioning state of an AI Gateway resource.", "enum": [ "Succeeded", "Failed", "Canceled" ], "x-ms-enum": { "name": "AiGatewayProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "The resource is ready." }, { "name": "Failed", "value": "Failed", "description": "The resource operation failed." }, { "name": "Canceled", "value": "Canceled", "description": "The resource operation was canceled." } ] }, "readOnly": true }, "AiGatewayPublicNetworkAccess": { "type": "string", "description": "Public network access state for an AI Gateway.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "AiGatewayPublicNetworkAccess", "modelAsString": true, "values": [ { "name": "Enabled", "value": "Enabled", "description": "Public network access is enabled." }, { "name": "Disabled", "value": "Disabled", "description": "Public network access is disabled." } ] } }, "AiGatewayResource": { "type": "object", "description": "An AI Gateway resource.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayProperties", "description": "The resource-specific properties for this resource." }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "sku": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/Sku", "description": "The SKU (Stock Keeping Unit) assigned to this resource." }, "eTag": { "type": "string", "description": "If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.", "readOnly": true } }, "required": [ "properties" ], "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/TrackedResource" } ] }, "AiGatewayResourceExistsResponse": { "type": "object", "description": "A successful existence check, with no response body." }, "AiGatewayResourceListResult": { "type": "object", "description": "The response of a AiGatewayResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayResource items on this page", "items": { "$ref": "#/definitions/AiGatewayResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewaySecretHeader": { "type": "object", "description": "A secret HTTP header injected into an outbound request.", "properties": { "name": { "type": "string", "description": "HTTP header name." }, "value": { "type": "string", "format": "password", "description": "Secret HTTP header value. Omitted from ordinary read responses.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true } }, "required": [ "name" ] }, "AiGatewaySecretHeaderUpdate": { "type": "object", "description": "A secret HTTP header to update.", "properties": { "name": { "type": "string", "description": "HTTP header name." }, "value": { "type": "string", "format": "password", "description": "Secret HTTP header value.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true } } }, "AiGatewaySecretHeaderValue": { "type": "object", "description": "A secret HTTP header returned by a secret-retrieval action.", "properties": { "name": { "type": "string", "description": "HTTP header name." }, "value": { "type": "string", "format": "password", "description": "Secret HTTP header value.", "x-ms-secret": true } }, "required": [ "name" ] }, "AiGatewaySessionBackendPreference": { "type": "object", "description": "Stateless backend preference using an existing caller session key.", "properties": { "key": { "type": "string", "description": "CEL expression returning the caller session key." } }, "required": [ "key" ] }, "AiGatewaySessionBackendPreferenceUpdate": { "type": "object", "description": "Stateless backend preference settings to update.", "properties": { "key": { "type": "string", "description": "CEL expression returning the caller session key." } } }, "AiGatewaySkuUpdate": { "type": "object", "description": "SKU fields to update on an AI Gateway.", "properties": { "name": { "type": "string", "description": "The name of the SKU. Ex - P3. It is typically a letter+number code" }, "tier": { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/SkuTier", "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." }, "size": { "type": "string", "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code." }, "family": { "type": "string", "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." }, "capacity": { "type": "integer", "format": "int32", "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." } } }, "AiGatewaySubnet": { "type": "object", "description": "Subnet used by an AI Gateway.", "properties": { "id": { "$ref": "#/definitions/AiGatewaySubnetResourceId", "description": "Resource identifier of the subnet. The subnet must be delegated to Microsoft.App/environments and be in the same region as the AI Gateway." } }, "required": [ "id" ] }, "AiGatewaySubnetResourceId": { "type": "string", "format": "arm-id", "description": "Resource identifier of a virtual network subnet.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Network/virtualNetworks/subnets" } ] } }, "AiGatewaySubnetUpdate": { "type": "object", "description": "Subnet fields to update on an AI Gateway.", "properties": { "id": { "$ref": "#/definitions/AiGatewaySubnetResourceId", "description": "Resource identifier of the subnet. The subnet must be delegated to Microsoft.App/environments and be in the same region as the AI Gateway." } } }, "AiGatewayTelemetryAttributeMapping": { "type": "object", "description": "A claim mapping to azure.ai_gateway.identity.claims.{claim}.", "properties": { "source": { "$ref": "#/definitions/AiGatewayTelemetryAttributeSource", "description": "Claim source. Source claim names must be unique across mappings." }, "signals": { "type": "array", "description": "Distinct signals to enrich. Omit to select all configured signals.", "minItems": 1, "items": { "$ref": "#/definitions/AiGatewayTelemetrySignal" } } }, "required": [ "source" ] }, "AiGatewayTelemetryAttributeMappingUpdate": { "type": "object", "description": "A claim mapping to update.", "properties": { "source": { "$ref": "#/definitions/AiGatewayTelemetryAttributeSourceUpdate", "description": "Claim source." }, "signals": { "type": "array", "description": "Distinct signals to enrich.", "minItems": 1, "items": { "$ref": "#/definitions/AiGatewayTelemetrySignal" } } } }, "AiGatewayTelemetryAttributeSource": { "type": "object", "description": "A request JWT claim observed for telemetry only, not authentication or billing.", "properties": { "kind": { "type": "string", "description": "Source kind. Only claims is currently supported.", "enum": [ "claims" ], "x-ms-enum": { "modelAsString": false } }, "value": { "type": "string", "description": "Nonempty, case-sensitive claim name.", "minLength": 1 } }, "required": [ "kind", "value" ] }, "AiGatewayTelemetryAttributeSourceUpdate": { "type": "object", "description": "A claim source to update.", "properties": { "kind": { "type": "string", "description": "Source kind. Only claims is currently supported.", "enum": [ "claims" ], "x-ms-enum": { "modelAsString": false } }, "value": { "type": "string", "description": "Nonempty, case-sensitive claim name.", "minLength": 1 } } }, "AiGatewayTelemetryAuthentication": { "type": "object", "description": "Outbound authentication settings for an OpenTelemetry exporter.", "properties": { "managedIdentity": { "$ref": "#/definitions/AiGatewayTelemetryManagedIdentity", "description": "Managed identity authentication for export requests." }, "headers": { "type": "array", "description": "Secret HTTP headers sent with export requests.", "items": { "$ref": "#/definitions/AiGatewaySecretHeader" }, "x-ms-identifiers": [] } } }, "AiGatewayTelemetryAuthenticationUpdate": { "type": "object", "description": "Outbound authentication settings to update on an OpenTelemetry exporter.", "properties": { "managedIdentity": { "$ref": "#/definitions/AiGatewayTelemetryManagedIdentity", "description": "Managed identity authentication for export requests." }, "headers": { "type": "array", "description": "Secret HTTP headers sent with export requests.", "items": { "$ref": "#/definitions/AiGatewaySecretHeaderUpdate" }, "x-ms-identifiers": [] } } }, "AiGatewayTelemetryConfiguration": { "type": "object", "description": "Optional telemetry enrichment on a native AI Gateway OpenTelemetry exporter.", "properties": { "attributes": { "type": "array", "description": "Observed-claim mappings; an empty array removes existing mappings.", "items": { "$ref": "#/definitions/AiGatewayTelemetryAttributeMapping" }, "x-ms-identifiers": [ "source/value" ] } } }, "AiGatewayTelemetryConfigurationUpdate": { "type": "object", "description": "Telemetry enrichment settings to update.", "properties": { "attributes": { "type": "array", "description": "Observed-claim mappings; an empty array removes existing mappings.", "items": { "$ref": "#/definitions/AiGatewayTelemetryAttributeMappingUpdate" }, "x-ms-identifiers": [] } } }, "AiGatewayTelemetryExporterKind": { "type": "string", "description": "Destination kind for gateway telemetry.", "enum": [ "ApplicationInsights", "OpenTelemetry" ], "x-ms-enum": { "name": "AiGatewayTelemetryExporterKind", "modelAsString": true, "values": [ { "name": "ApplicationInsights", "value": "ApplicationInsights", "description": "Export to Application Insights." }, { "name": "OpenTelemetry", "value": "OpenTelemetry", "description": "Export over OTLP HTTP/protobuf." } ] } }, "AiGatewayTelemetryExporterProperties": { "type": "object", "description": "Properties of an AI Gateway telemetry exporter.", "properties": { "telemetryExporterType": { "$ref": "#/definitions/AiGatewayTelemetryExporterKind", "description": "Exporter type, which cannot change after creation.", "x-ms-mutability": [ "read", "create" ] }, "payloadCapture": { "type": "boolean", "description": "Capture prompts, completions, and tool input/output; no built-in PII redaction is applied.", "default": false }, "applicationInsights": { "$ref": "#/definitions/AiGatewayApplicationInsightsConfiguration", "description": "Configuration required for the ApplicationInsights exporter type." }, "openTelemetry": { "$ref": "#/definitions/AiGatewayOpenTelemetryConfiguration", "description": "Configuration required for the OpenTelemetry exporter type. At least one signal endpoint is required." }, "authentication": { "$ref": "#/definitions/AiGatewayTelemetryAuthentication", "description": "Outbound authentication for OpenTelemetry export requests." }, "telemetry": { "$ref": "#/definitions/AiGatewayTelemetryConfiguration", "description": "Optional observed-claim mappings, supported on native AI Gateway OpenTelemetry exporters." }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } }, "required": [ "telemetryExporterType" ] }, "AiGatewayTelemetryExporterResource": { "type": "object", "description": "A telemetry export destination in the default AI Gateway workspace.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayTelemetryExporterProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayTelemetryExporterResourceListResult": { "type": "object", "description": "The response of a AiGatewayTelemetryExporterResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayTelemetryExporterResource items on this page", "items": { "$ref": "#/definitions/AiGatewayTelemetryExporterResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayTelemetryExporterUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway telemetry exporter.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayTelemetryExporterUpdateProperties", "description": "Exporter properties to update." } } }, "AiGatewayTelemetryExporterUpdateProperties": { "type": "object", "description": "Properties to update on an AI Gateway telemetry exporter.", "properties": { "payloadCapture": { "type": "boolean", "description": "Capture prompts, completions, and tool input/output." }, "applicationInsights": { "$ref": "#/definitions/AiGatewayApplicationInsightsConfiguration", "description": "Application Insights configuration." }, "openTelemetry": { "$ref": "#/definitions/AiGatewayOpenTelemetryConfigurationUpdate", "description": "OpenTelemetry configuration." }, "authentication": { "$ref": "#/definitions/AiGatewayTelemetryAuthenticationUpdate", "description": "Outbound authentication for OpenTelemetry export requests." }, "telemetry": { "$ref": "#/definitions/AiGatewayTelemetryConfigurationUpdate", "description": "Observed-claim mappings to update." } } }, "AiGatewayTelemetryManagedIdentity": { "type": "object", "description": "Managed identity used to authenticate telemetry export requests.", "properties": { "resource": { "type": "string", "description": "Token audience requested for the managed identity." }, "clientId": { "type": "string", "description": "User-assigned managed identity client ID; omit for the system-assigned identity." } } }, "AiGatewayTelemetrySignal": { "type": "string", "description": "Telemetry signal receiving a claim attribute.", "enum": [ "logs", "traces", "metrics" ], "x-ms-enum": { "name": "AiGatewayTelemetrySignal", "modelAsString": true, "values": [ { "name": "Logs", "value": "logs", "description": "Log records." }, { "name": "Traces", "value": "traces", "description": "Trace spans." }, { "name": "Metrics", "value": "metrics", "description": "Token-usage and token-cost metrics." } ] } }, "AiGatewayToolServerAccessState": { "type": "string", "description": "Tool server access state.", "enum": [ "active", "blocked" ], "x-ms-enum": { "name": "AiGatewayToolServerAccessState", "modelAsString": true, "values": [ { "name": "Active", "value": "active", "description": "Tool server is available." }, { "name": "Blocked", "value": "blocked", "description": "Tool server is blocked." } ] } }, "AiGatewayToolServerAuthentication": { "type": "object", "description": "Outbound authentication for a tool server endpoint.", "properties": { "headers": { "type": "array", "description": "Static headers injected when calling the endpoint.", "items": { "$ref": "#/definitions/AiGatewaySecretHeader" }, "x-ms-identifiers": [] }, "oauth2": { "$ref": "#/definitions/AiGatewayToolServerOauth2Authentication", "description": "OAuth 2.0 configuration." }, "managedIdentity": { "$ref": "#/definitions/AiGatewayToolServerManagedIdentityAuthentication", "description": "Managed identity configuration." } } }, "AiGatewayToolServerAuthenticationUpdate": { "type": "object", "description": "Tool server authentication settings to update.", "properties": { "headers": { "type": "array", "description": "Static headers injected when calling the endpoint.", "items": { "$ref": "#/definitions/AiGatewaySecretHeaderUpdate" }, "x-ms-identifiers": [] }, "oauth2": { "$ref": "#/definitions/AiGatewayToolServerOauth2Authentication", "description": "OAuth 2.0 configuration." }, "managedIdentity": { "$ref": "#/definitions/AiGatewayToolServerManagedIdentityAuthentication", "description": "Managed identity configuration." } } }, "AiGatewayToolServerEndpoint": { "type": "object", "description": "A tool server endpoint.", "properties": { "id": { "type": "string", "description": "Stable endpoint identifier. Up to 64 alphanumeric characters or hyphens, starting and ending with an alphanumeric character. Generated when omitted." }, "namespace": { "type": "string", "description": "Optional namespace used to prefix tool names." }, "kind": { "$ref": "#/definitions/AiGatewayToolServerEndpointSourceKind", "description": "Endpoint type." }, "mcp": { "$ref": "#/definitions/AiGatewayMcpUrlConfiguration", "description": "Backend MCP configuration. Required when kind is mcp." }, "openApi": { "$ref": "#/definitions/AiGatewayOpenApiConfiguration", "description": "OpenAPI configuration. Required when kind is openApi." }, "authentication": { "$ref": "#/definitions/AiGatewayToolServerAuthentication", "description": "Backend authentication configuration." }, "tools": { "type": "array", "description": "Upstream tool names or glob patterns to expose.", "items": { "type": "string" } }, "mode": { "type": "string", "description": "Failure mode when the endpoint fails. Defaults to failOpen.", "default": "failOpen", "enum": [ "failOpen", "failClosed" ], "x-ms-enum": { "name": "AiGatewayFailureMode", "modelAsString": true, "values": [ { "name": "FailOpen", "value": "failOpen", "description": "Continue processing when the endpoint or hook fails." }, { "name": "FailClosed", "value": "failClosed", "description": "Fail the request when the endpoint or hook fails." } ] } } }, "required": [ "kind" ] }, "AiGatewayToolServerEndpointSourceKind": { "type": "string", "description": "Endpoint source kind.", "enum": [ "mcp", "openApi" ], "x-ms-enum": { "name": "AiGatewayToolServerEndpointSourceKind", "modelAsString": true, "values": [ { "name": "Mcp", "value": "mcp", "description": "MCP server endpoint." }, { "name": "OpenApi", "value": "openApi", "description": "OpenAPI document endpoint." } ] } }, "AiGatewayToolServerEndpointUpdate": { "type": "object", "description": "A tool server endpoint to update.", "properties": { "id": { "type": "string", "description": "Stable endpoint identifier." }, "namespace": { "type": "string", "description": "Optional namespace used to prefix tool names." }, "kind": { "$ref": "#/definitions/AiGatewayToolServerEndpointSourceKind", "description": "Endpoint type." }, "mcp": { "$ref": "#/definitions/AiGatewayMcpUrlConfigurationUpdate", "description": "Backend MCP configuration." }, "openApi": { "$ref": "#/definitions/AiGatewayOpenApiConfigurationUpdate", "description": "OpenAPI configuration." }, "authentication": { "$ref": "#/definitions/AiGatewayToolServerAuthenticationUpdate", "description": "Backend authentication configuration." }, "tools": { "type": "array", "description": "Upstream tool names or glob patterns to expose.", "items": { "type": "string" } }, "mode": { "$ref": "#/definitions/AiGatewayFailureMode", "description": "Failure mode when the endpoint fails." } } }, "AiGatewayToolServerFederation": { "type": "object", "description": "Customer-owned federation application identity for a tool server endpoint.", "properties": { "applicationId": { "type": "string", "description": "Application (client) ID of the customer-owned federation application." }, "appCredential": { "$ref": "#/definitions/AiGatewayToolServerFederationAppCredential", "description": "Credential used to authenticate the federation application." } } }, "AiGatewayToolServerFederationAppCredential": { "type": "object", "description": "Credential used to authenticate a tool server endpoint federation application.", "properties": { "type": { "$ref": "#/definitions/AiGatewayToolServerFederationAppCredentialType", "description": "Federation application credential type." }, "clientId": { "type": "string", "description": "Client ID of a user-assigned managed identity available to this AI Gateway." } }, "required": [ "type" ] }, "AiGatewayToolServerFederationAppCredentialType": { "type": "string", "description": "Supported federation application credential types for a tool server endpoint.", "enum": [ "userAssignedManagedIdentity" ], "x-ms-enum": { "name": "AiGatewayToolServerFederationAppCredentialType", "modelAsString": true, "values": [ { "name": "UserAssignedManagedIdentity", "value": "userAssignedManagedIdentity", "description": "A user-assigned managed identity assigned to the AI Gateway." } ] } }, "AiGatewayToolServerLoginLinksRequest": { "type": "object", "description": "Parameters for getting OAuth consent links for a tool server endpoint.", "properties": { "endpointId": { "type": "string", "description": "Identifier of the endpoint configured on the tool server." } }, "required": [ "endpointId" ] }, "AiGatewayToolServerManagedIdentityAuthentication": { "type": "object", "description": "Managed identity authentication for a tool server endpoint.", "properties": { "resource": { "type": "string", "description": "Token audience for managed identity authentication." }, "clientId": { "type": "string", "description": "Client ID of a user-assigned managed identity." } } }, "AiGatewayToolServerMcpTransport": { "type": "string", "description": "MCP transport protocol.", "enum": [ "streamableHttp" ], "x-ms-enum": { "name": "AiGatewayToolServerMcpTransport", "modelAsString": true, "values": [ { "name": "StreamableHttp", "value": "streamableHttp", "description": "Streamable HTTP transport." } ] } }, "AiGatewayToolServerOauth2Authentication": { "type": "object", "description": "OAuth 2.0 authentication for a tool server endpoint.", "properties": { "issuer": { "type": "string", "format": "uri", "description": "Expected OAuth authorization-server issuer for remote MCP discovery." }, "authorizationEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "OAuth authorization endpoint." }, "tokenEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "OAuth token endpoint." }, "clientId": { "type": "string", "description": "OAuth client identifier." }, "clientSecret": { "type": "string", "format": "password", "description": "OAuth client secret.", "x-ms-mutability": [ "update", "create" ], "x-ms-secret": true }, "scopes": { "type": "array", "description": "OAuth scopes to request.", "items": { "type": "string" } }, "grantType": { "$ref": "#/definitions/AiGatewayToolServerOauth2GrantType", "description": "OAuth grant type." }, "tokenExchange": { "$ref": "#/definitions/AiGatewayToolServerTokenExchange", "description": "Chained token-exchange configuration." }, "authorizationParameters": { "type": "array", "description": "Additional authorization endpoint parameters.", "items": { "$ref": "#/definitions/AiGatewayToolServerOauth2Parameter" }, "x-ms-identifiers": [ "name" ] }, "tokenParameters": { "type": "array", "description": "Additional token endpoint parameters.", "items": { "$ref": "#/definitions/AiGatewayToolServerOauth2Parameter" }, "x-ms-identifiers": [ "name" ] }, "status": { "type": "string", "description": "Current OAuth connection status.", "readOnly": true }, "loginLink": { "type": "string", "format": "uri", "description": "Login link used to complete interactive authorization.", "readOnly": true }, "statusUpdatedUtc": { "type": "string", "format": "date-time", "description": "UTC timestamp of the last OAuth connection-status transition.", "readOnly": true } } }, "AiGatewayToolServerOauth2GrantType": { "type": "string", "description": "OAuth 2.0 grant type.", "enum": [ "clientCredentials", "authorizationCode" ], "x-ms-enum": { "name": "AiGatewayToolServerOauth2GrantType", "modelAsString": true, "values": [ { "name": "ClientCredentials", "value": "clientCredentials", "description": "Client credentials grant." }, { "name": "AuthorizationCode", "value": "authorizationCode", "description": "Authorization code grant." } ] } }, "AiGatewayToolServerOauth2LoginLinks": { "type": "object", "description": "Links for completing OAuth consent for a tool-server endpoint.", "properties": { "loginLink": { "type": "string", "format": "password", "description": "Gateway URL to open to begin consent; includes an expiring signed capability.", "x-ms-secret": true }, "redirectUri": { "type": "string", "format": "uri", "description": "Gateway callback URI to register with the identity provider." }, "expiresUtc": { "type": "string", "format": "date-time", "description": "UTC expiry of the signed start capability." } }, "required": [ "expiresUtc" ] }, "AiGatewayToolServerOauth2Parameter": { "type": "object", "description": "An additional parameter sent to an OAuth 2.0 endpoint.", "properties": { "name": { "type": "string", "description": "OAuth parameter name." }, "value": { "type": "string", "description": "OAuth parameter value." } }, "required": [ "name", "value" ] }, "AiGatewayToolServerOpenApiSourceType": { "type": "string", "description": "OpenAPI document source type.", "enum": [ "inline", "url" ], "x-ms-enum": { "name": "AiGatewayToolServerOpenApiSourceType", "modelAsString": true, "values": [ { "name": "Inline", "value": "inline", "description": "Inline OpenAPI document." }, { "name": "Url", "value": "url", "description": "OpenAPI document fetched from a URL." } ] } }, "AiGatewayToolServerProperties": { "type": "object", "description": "Properties of an AI Gateway tool server.", "properties": { "displayName": { "type": "string", "description": "Display name of the tool server." }, "description": { "type": "string", "description": "Description of the tool server." }, "accessState": { "$ref": "#/definitions/AiGatewayToolServerAccessState", "description": "Whether the tool server is available to callers." }, "toolServerType": { "$ref": "#/definitions/AiGatewayToolServerType", "description": "Tool server type." }, "versions": { "type": "array", "description": "Runtime API versions exposed by this tool server.", "items": { "type": "string" } }, "allowList": { "type": "array", "description": "Tool names or patterns explicitly allowed.", "items": { "type": "string" } }, "blockList": { "type": "array", "description": "Tool names or patterns explicitly blocked.", "items": { "type": "string" } }, "endpoints": { "type": "array", "description": "Endpoint configurations exposed by this tool server.", "items": { "$ref": "#/definitions/AiGatewayToolServerEndpoint" }, "x-ms-identifiers": [ "id" ] }, "policies": { "type": "array", "description": "Inline policies applied to this tool server.", "items": { "$ref": "#/definitions/AiGatewayPolicy" }, "x-ms-identifiers": [] }, "path": { "type": "string", "description": "Runtime path for the tool server." }, "subscriptionRequired": { "type": "boolean", "description": "Whether a subscription is required to invoke the tool server." }, "gatewayEndpoints": { "type": "array", "description": "Read-only invocation URLs, with optional SDK metadata when endpoint enrichment is enabled.", "items": { "$ref": "#/definitions/AiGatewayEndpoint" }, "readOnly": true, "x-ms-identifiers": [ "url" ] }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } }, "required": [ "toolServerType" ] }, "AiGatewayToolServerResource": { "type": "object", "description": "An AI Gateway tool server resource.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayToolServerProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayToolServerResourceListResult": { "type": "object", "description": "The response of a AiGatewayToolServerResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayToolServerResource items on this page", "items": { "$ref": "#/definitions/AiGatewayToolServerResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayToolServerSecret": { "type": "object", "description": "Secret value configured on one tool server endpoint.", "properties": { "id": { "type": "string", "description": "Stable endpoint identifier." }, "authentication": { "$ref": "#/definitions/AiGatewayToolServerSecretAuthentication", "description": "Endpoint authentication including secret values." }, "openApi": { "$ref": "#/definitions/AiGatewayToolServerSecretOpenApiConfiguration", "description": "OpenAPI configuration including inline content." } }, "required": [ "id" ] }, "AiGatewayToolServerSecretAuthentication": { "type": "object", "description": "Endpoint authentication returned by the secret retrieval action.", "properties": { "managedIdentity": { "$ref": "#/definitions/AiGatewayToolServerManagedIdentityAuthentication", "description": "Managed identity configuration." }, "headers": { "type": "array", "description": "Static headers injected when calling the endpoint.", "items": { "$ref": "#/definitions/AiGatewaySecretHeaderValue" }, "x-ms-identifiers": [] }, "oauth2": { "$ref": "#/definitions/AiGatewayToolServerSecretOauth2Authentication", "description": "OAuth 2.0 configuration." } } }, "AiGatewayToolServerSecretOauth2Authentication": { "type": "object", "description": "OAuth settings returned by the secret retrieval action.", "properties": { "issuer": { "type": "string", "format": "uri", "description": "Expected OAuth authorization-server issuer for remote MCP discovery." }, "authorizationEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "OAuth authorization endpoint." }, "tokenEndpoint": { "$ref": "#/definitions/AiGatewayDestinationEndpoint", "description": "OAuth token endpoint." }, "clientId": { "type": "string", "description": "OAuth client identifier." }, "scopes": { "type": "array", "description": "OAuth scopes to request.", "items": { "type": "string" } }, "grantType": { "$ref": "#/definitions/AiGatewayToolServerOauth2GrantType", "description": "OAuth grant type." }, "tokenExchange": { "$ref": "#/definitions/AiGatewayToolServerTokenExchange", "description": "Chained token-exchange configuration." }, "authorizationParameters": { "type": "array", "description": "Additional authorization endpoint parameters.", "items": { "$ref": "#/definitions/AiGatewayToolServerOauth2Parameter" }, "x-ms-identifiers": [ "name" ] }, "tokenParameters": { "type": "array", "description": "Additional token endpoint parameters.", "items": { "$ref": "#/definitions/AiGatewayToolServerOauth2Parameter" }, "x-ms-identifiers": [ "name" ] }, "status": { "type": "string", "description": "Current OAuth connection status.", "readOnly": true }, "loginLink": { "type": "string", "format": "uri", "description": "Login link used to complete interactive authorization.", "readOnly": true }, "statusUpdatedUtc": { "type": "string", "format": "date-time", "description": "UTC timestamp of the last OAuth connection-status transition.", "readOnly": true }, "clientSecret": { "type": "string", "format": "password", "description": "OAuth client secret.", "x-ms-secret": true } } }, "AiGatewayToolServerSecretOpenApiConfiguration": { "type": "object", "description": "OpenAPI settings returned by the secret retrieval action.", "properties": { "specSource": { "$ref": "#/definitions/AiGatewayToolServerSecretOpenApiSpecSource", "description": "OpenAPI document source." } }, "required": [ "specSource" ] }, "AiGatewayToolServerSecretOpenApiSpecSource": { "type": "object", "description": "OpenAPI document source returned by the secret retrieval action.", "properties": { "type": { "$ref": "#/definitions/AiGatewayToolServerOpenApiSourceType", "description": "Source type." }, "url": { "type": "string", "format": "uri", "description": "URL of the OpenAPI document. Required when type is url." }, "contentBase64": { "type": "string", "format": "password", "description": "Base64-encoded OpenAPI document. Required when type is inline.", "x-ms-secret": true } }, "required": [ "type" ] }, "AiGatewayToolServerSecrets": { "type": "object", "description": "Secret values configured on tool server endpoints.", "properties": { "endpoints": { "type": "array", "description": "Endpoint secret values.", "items": { "$ref": "#/definitions/AiGatewayToolServerSecret" }, "x-ms-identifiers": [ "id" ] } }, "required": [ "endpoints" ] }, "AiGatewayToolServerTokenExchange": { "type": "object", "description": "Chained token-exchange configuration for a tool server endpoint.", "properties": { "profile": { "$ref": "#/definitions/AiGatewayToolServerTokenExchangeProfile", "description": "Token-exchange profile." }, "federatedClientApplication": { "$ref": "#/definitions/AiGatewayToolServerFederation", "description": "Customer-owned federated client application identity." }, "scopes": { "type": "array", "description": "Delegated scopes requested from the target tool server resource.", "items": { "type": "string" } } }, "required": [ "profile" ] }, "AiGatewayToolServerTokenExchangeProfile": { "type": "string", "description": "Supported token-exchange profiles for a tool server endpoint.", "enum": [ "entraOnBehalfOf" ], "x-ms-enum": { "name": "AiGatewayToolServerTokenExchangeProfile", "modelAsString": true, "values": [ { "name": "EntraOnBehalfOf", "value": "entraOnBehalfOf", "description": "Microsoft Entra chained on-behalf-of token exchange." } ] } }, "AiGatewayToolServerType": { "type": "string", "description": "How a tool server is exposed.", "enum": [ "mcp", "openApi", "connector" ], "x-ms-enum": { "name": "AiGatewayToolServerType", "modelAsString": true, "values": [ { "name": "Mcp", "value": "mcp", "description": "Federates one or more MCP servers." }, { "name": "OpenApi", "value": "openApi", "description": "Exposes tools generated from OpenAPI documents." }, { "name": "Connector", "value": "connector", "description": "Exposes a connector-backed tool server." } ] } }, "AiGatewayToolServerUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway tool server.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayToolServerUpdateProperties", "description": "Tool server properties to update." } } }, "AiGatewayToolServerUpdateProperties": { "type": "object", "description": "Properties for updating an AI Gateway tool server.", "properties": { "displayName": { "type": "string", "description": "Display name of the tool server." }, "description": { "type": "string", "description": "Description of the tool server." }, "accessState": { "$ref": "#/definitions/AiGatewayToolServerAccessState", "description": "Whether the tool server is available to callers." }, "toolServerType": { "$ref": "#/definitions/AiGatewayToolServerType", "description": "Tool server type." }, "versions": { "type": "array", "description": "Runtime API versions exposed by this tool server.", "items": { "type": "string" } }, "allowList": { "type": "array", "description": "Tool names or patterns explicitly allowed.", "items": { "type": "string" } }, "blockList": { "type": "array", "description": "Tool names or patterns explicitly blocked.", "items": { "type": "string" } }, "endpoints": { "type": "array", "description": "Endpoint configurations exposed by this tool server.", "items": { "$ref": "#/definitions/AiGatewayToolServerEndpointUpdate" }, "x-ms-identifiers": [] }, "policies": { "type": "array", "description": "Inline policies applied to this tool server.", "items": { "$ref": "#/definitions/AiGatewayPolicyUpdate" }, "x-ms-identifiers": [] }, "path": { "type": "string", "description": "Runtime path for the tool server." }, "subscriptionRequired": { "type": "boolean", "description": "Whether a subscription is required to invoke the tool server." } } }, "AiGatewayUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } }, "identity": { "$ref": "../../../../../../common-types/resource-management/v6/managedidentity.json#/definitions/ManagedServiceIdentity", "description": "The managed service identities assigned to this resource." }, "sku": { "$ref": "#/definitions/AiGatewaySkuUpdate", "description": "The SKU (Stock Keeping Unit) assigned to this resource." }, "properties": { "$ref": "#/definitions/AiGatewayUpdateProperties", "description": "AI Gateway properties to update." } } }, "AiGatewayUpdateProperties": { "type": "object", "description": "Properties for updating an AI Gateway.", "properties": { "publicNetworkAccess": { "$ref": "#/definitions/AiGatewayPublicNetworkAccess", "description": "Whether public network access is allowed for the AI Gateway." }, "backend": { "$ref": "#/definitions/AiGatewayBackendUpdate", "description": "Backend networking configuration." } } }, "AiGatewayWorkspaceProperties": { "type": "object", "description": "Properties of an AI Gateway workspace.", "properties": { "displayName": { "type": "string", "description": "Display name of the workspace.", "readOnly": true }, "description": { "type": "string", "description": "Description of the workspace.", "readOnly": true }, "policies": { "type": "array", "description": "Inline governance policies for the default workspace.", "items": { "$ref": "#/definitions/AiGatewayPolicy" }, "x-ms-identifiers": [] }, "provisioningState": { "$ref": "#/definitions/AiGatewayProvisioningState", "description": "Provisioning state of the resource.", "readOnly": true } }, "required": [ "displayName", "description" ] }, "AiGatewayWorkspaceResource": { "type": "object", "description": "An AI Gateway workspace resource.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayWorkspaceProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v6/types.json#/definitions/ProxyResource" } ] }, "AiGatewayWorkspaceResourceListResult": { "type": "object", "description": "The response of a AiGatewayWorkspaceResource list operation.", "properties": { "value": { "type": "array", "description": "The AiGatewayWorkspaceResource items on this page", "items": { "$ref": "#/definitions/AiGatewayWorkspaceResource" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "AiGatewayWorkspaceUpdateParameters": { "type": "object", "description": "Parameters for updating an AI Gateway workspace.", "properties": { "properties": { "$ref": "#/definitions/AiGatewayWorkspaceUpdateProperties", "description": "Workspace properties to update." } } }, "AiGatewayWorkspaceUpdateProperties": { "type": "object", "description": "Properties for updating an AI Gateway workspace.", "properties": { "policies": { "type": "array", "description": "Inline governance policies to replace on the default workspace.", "items": { "$ref": "#/definitions/AiGatewayPolicyUpdate" }, "x-ms-identifiers": [] } } } }, "parameters": { "If-Match": { "name": "If-Match", "in": "header", "description": "The If-Match header that makes a request conditional.", "required": true, "type": "string", "x-ms-parameter-location": "method", "x-ms-client-name": "ifMatch" } } }