Microsoft.CognitiveServices (preview:2025-10-01)

2025/11/03 • 3 updated methods

AgentApplications_List (updated)
Description :  Lists Agent Applications in the project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentApplications_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "authorizationPolicy": [
                  {
                    "#name": "type",
                    "Enum": {
                      "new": [
                        [
                          "Default",
                          "Standard AzureML RBAC"
                        ],
                        [
                          "OrganizationScope",
                          "Claim-based, requires membership in the tenant"
                        ],
                        [
                          "Channels",
                          "Channels-specific (AzureBotService) authorization"
                        ],
                        [
                          "Custom",
                          "Custom scheme defined by the application author"
                        ]
                      ],
                      "old": [
                        [
                          "Default",
                          "Standard AzureML RBAC"
                        ],
                        [
                          "OrganizationScope",
                          "Claim-based, requires membership in the tenant"
                        ],
                        [
                          "Microsoft365",
                          "Microsoft365-specific (AzureBotService) authorization"
                        ],
                        [
                          "Custom",
                          "Custom scheme defined by the application author"
                        ]
                      ]
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
count:
{
Description: Number of agent applications to be retrieved in a page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of agent applications to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: Continuation token for pagination. ,
Required: False ,
}
string ,
names:
{
Description: Names of agent applications to retrieve. ,
Required: False ,
}
array ,
searchText:
{
Description: Search text for filtering agent applications. ,
Required: False ,
}
string ,
orderBy:
{
Description: Field to order by. ,
Required: False ,
}
string ,
orderByAsc:
{
Description: Whether to order in ascending order. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link to the next page of Agent Application objects. If null, there are no additional pages. ,
Required: False ,
}
string ,
value:
{
Description: An array of objects of type Agent Application. ,
Required: False ,
}
[
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
baseUrl:
{
Description: The application's dedicated invocation endpoint. ,
Required: False ,
}
string ,
agents:
{
Description: The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application. ,
Required: False ,
}
[
{
agentId:
{
Description: Gets the agent's unique identifier within the organization (subscription). ,
Required: False ,
}
string ,
agentName:
{
Description: Gets the agent's name (unique within the project/app). ,
Required: False ,
}
string ,
}
,
]
,
agentIdentityBlueprint:
{
Description: The EntraId Agentic Blueprint of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
defaultInstanceIdentity:
{
Description: The (default) agent instance identity of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationPolicy:
{
Description: Gets or sets the authorization policy associated with this agentic application instance. ,
Required: False ,
}
{
type:
{
Description: Authorization scheme type. ,
Enum:
{
Default: Standard AzureML RBAC ,
OrganizationScope: Claim-based, requires membership in the tenant ,
Channels: Channels-specific (AzureBotService) authorization ,
Custom: Custom scheme defined by the application author ,
}
,
Required: True ,
}
enum ,
}
,
trafficRoutingPolicy:
{
Description: Gets or sets the traffic routing policy for the application's deployments. ,
Required: False ,
}
{
protocol:
{
Description: Methodology used to route traffic to the application's deployments. ,
Enum:
{
FixedRatio: Percentage based routing ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: Gets or sets the collection of traffic routing rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: The identifier of this traffic routing rule. ,
Required: False ,
}
string ,
description:
{
Description: A user-provided description for this traffic routing rule. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The unique identifier of the deployment to which traffic is routed by this rule. ,
Required: False ,
}
string ,
trafficPercentage:
{
Description: Gets or sets the percentage of traffic allocated to this instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the application. ,
Enum:
{
Succeeded: The application was successfully provisioned. ,
Failed: The application provisioning failed. ,
Canceled: The application provisioning was canceled. ,
Creating: The application is being created. ,
Updating: The application is being updated. ,
Deleting: The application is being deleted. ,
}
,
Required: False ,
}
enum ,
isEnabled:
{
Description: Enabledstate of the application. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentApplications_Get (updated)
Description :  Gets an Agent Application by name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentApplications_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authorizationPolicy": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Channels",
                      "Channels-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ],
                  "old": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Microsoft365",
                      "Microsoft365-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
name:
{
Description: Name for the Agent Application. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
baseUrl:
{
Description: The application's dedicated invocation endpoint. ,
Required: False ,
}
string ,
agents:
{
Description: The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application. ,
Required: False ,
}
[
{
agentId:
{
Description: Gets the agent's unique identifier within the organization (subscription). ,
Required: False ,
}
string ,
agentName:
{
Description: Gets the agent's name (unique within the project/app). ,
Required: False ,
}
string ,
}
,
]
,
agentIdentityBlueprint:
{
Description: The EntraId Agentic Blueprint of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
defaultInstanceIdentity:
{
Description: The (default) agent instance identity of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationPolicy:
{
Description: Gets or sets the authorization policy associated with this agentic application instance. ,
Required: False ,
}
{
type:
{
Description: Authorization scheme type. ,
Enum:
{
Default: Standard AzureML RBAC ,
OrganizationScope: Claim-based, requires membership in the tenant ,
Channels: Channels-specific (AzureBotService) authorization ,
Custom: Custom scheme defined by the application author ,
}
,
Required: True ,
}
enum ,
}
,
trafficRoutingPolicy:
{
Description: Gets or sets the traffic routing policy for the application's deployments. ,
Required: False ,
}
{
protocol:
{
Description: Methodology used to route traffic to the application's deployments. ,
Enum:
{
FixedRatio: Percentage based routing ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: Gets or sets the collection of traffic routing rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: The identifier of this traffic routing rule. ,
Required: False ,
}
string ,
description:
{
Description: A user-provided description for this traffic routing rule. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The unique identifier of the deployment to which traffic is routed by this rule. ,
Required: False ,
}
string ,
trafficPercentage:
{
Description: Gets or sets the percentage of traffic allocated to this instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the application. ,
Enum:
{
Succeeded: The application was successfully provisioned. ,
Failed: The application provisioning failed. ,
Canceled: The application provisioning was canceled. ,
Creating: The application is being created. ,
Updating: The application is being updated. ,
Deleting: The application is being deleted. ,
}
,
Required: False ,
}
enum ,
isEnabled:
{
Description: Enabledstate of the application. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AgentApplications_CreateOrUpdate (updated)
Description :  Creates or updates an Agent Application (asynchronous).
Reference :  Link ¶

⚶ Changes

{
  "#id": "AgentApplications_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "authorizationPolicy": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Channels",
                      "Channels-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ],
                  "old": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Microsoft365",
                      "Microsoft365-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "authorizationPolicy": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Channels",
                      "Channels-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ],
                  "old": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Microsoft365",
                      "Microsoft365-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "authorizationPolicy": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Channels",
                      "Channels-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ],
                  "old": [
                    [
                      "Default",
                      "Standard AzureML RBAC"
                    ],
                    [
                      "OrganizationScope",
                      "Claim-based, requires membership in the tenant"
                    ],
                    [
                      "Microsoft365",
                      "Microsoft365-specific (AzureBotService) authorization"
                    ],
                    [
                      "Custom",
                      "Custom scheme defined by the application author"
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}/applications/{name}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of Cognitive Services account. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of Cognitive Services account's project. ,
Required: True ,
}
string ,
name:
{
Description: Name for the Agent Application. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Description: Agent Application definition object. ,
Required: True ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
baseUrl:
{
Description: The application's dedicated invocation endpoint. ,
Required: False ,
}
string ,
agents:
{
Description: The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application. ,
Required: False ,
}
[
{
agentId:
{
Description: Gets the agent's unique identifier within the organization (subscription). ,
Required: False ,
}
string ,
agentName:
{
Description: Gets the agent's name (unique within the project/app). ,
Required: False ,
}
string ,
}
,
]
,
agentIdentityBlueprint:
{
Description: The EntraId Agentic Blueprint of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
defaultInstanceIdentity:
{
Description: The (default) agent instance identity of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationPolicy:
{
Description: Gets or sets the authorization policy associated with this agentic application instance. ,
Required: False ,
}
{
type:
{
Description: Authorization scheme type. ,
Enum:
{
Default: Standard AzureML RBAC ,
OrganizationScope: Claim-based, requires membership in the tenant ,
Channels: Channels-specific (AzureBotService) authorization ,
Custom: Custom scheme defined by the application author ,
}
,
Required: True ,
}
enum ,
}
,
trafficRoutingPolicy:
{
Description: Gets or sets the traffic routing policy for the application's deployments. ,
Required: False ,
}
{
protocol:
{
Description: Methodology used to route traffic to the application's deployments. ,
Enum:
{
FixedRatio: Percentage based routing ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: Gets or sets the collection of traffic routing rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: The identifier of this traffic routing rule. ,
Required: False ,
}
string ,
description:
{
Description: A user-provided description for this traffic routing rule. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The unique identifier of the deployment to which traffic is routed by this rule. ,
Required: False ,
}
string ,
trafficPercentage:
{
Description: Gets or sets the percentage of traffic allocated to this instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the application. ,
Enum:
{
Succeeded: The application was successfully provisioned. ,
Failed: The application provisioning failed. ,
Canceled: The application provisioning was canceled. ,
Creating: The application is being created. ,
Updating: The application is being updated. ,
Deleting: The application is being deleted. ,
}
,
Required: False ,
}
enum ,
isEnabled:
{
Description: Enabledstate of the application. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
baseUrl:
{
Description: The application's dedicated invocation endpoint. ,
Required: False ,
}
string ,
agents:
{
Description: The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application. ,
Required: False ,
}
[
{
agentId:
{
Description: Gets the agent's unique identifier within the organization (subscription). ,
Required: False ,
}
string ,
agentName:
{
Description: Gets the agent's name (unique within the project/app). ,
Required: False ,
}
string ,
}
,
]
,
agentIdentityBlueprint:
{
Description: The EntraId Agentic Blueprint of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
defaultInstanceIdentity:
{
Description: The (default) agent instance identity of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationPolicy:
{
Description: Gets or sets the authorization policy associated with this agentic application instance. ,
Required: False ,
}
{
type:
{
Description: Authorization scheme type. ,
Enum:
{
Default: Standard AzureML RBAC ,
OrganizationScope: Claim-based, requires membership in the tenant ,
Channels: Channels-specific (AzureBotService) authorization ,
Custom: Custom scheme defined by the application author ,
}
,
Required: True ,
}
enum ,
}
,
trafficRoutingPolicy:
{
Description: Gets or sets the traffic routing policy for the application's deployments. ,
Required: False ,
}
{
protocol:
{
Description: Methodology used to route traffic to the application's deployments. ,
Enum:
{
FixedRatio: Percentage based routing ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: Gets or sets the collection of traffic routing rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: The identifier of this traffic routing rule. ,
Required: False ,
}
string ,
description:
{
Description: A user-provided description for this traffic routing rule. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The unique identifier of the deployment to which traffic is routed by this rule. ,
Required: False ,
}
string ,
trafficPercentage:
{
Description: Gets or sets the percentage of traffic allocated to this instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the application. ,
Enum:
{
Succeeded: The application was successfully provisioned. ,
Failed: The application provisioning failed. ,
Canceled: The application provisioning was canceled. ,
Creating: The application is being created. ,
Updating: The application is being updated. ,
Deleting: The application is being deleted. ,
}
,
Required: False ,
}
enum ,
isEnabled:
{
Description: Enabledstate of the application. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-async-operation-timeout:
{
Description: Timeout for the client to use when polling the asynchronous operation. ,
}
string ,
azure-asyncoperation:
{
Description: URI to poll for asynchronous operation status. ,
}
string ,
}
,
$schema:
{
Description: Agent Application resource ,
}
{
properties:
{
Description: [Required] Additional attributes of the entity. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the application. ,
Required: False ,
}
string ,
baseUrl:
{
Description: The application's dedicated invocation endpoint. ,
Required: False ,
}
string ,
agents:
{
Description: The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application. ,
Required: False ,
}
[
{
agentId:
{
Description: Gets the agent's unique identifier within the organization (subscription). ,
Required: False ,
}
string ,
agentName:
{
Description: Gets the agent's name (unique within the project/app). ,
Required: False ,
}
string ,
}
,
]
,
agentIdentityBlueprint:
{
Description: The EntraId Agentic Blueprint of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
defaultInstanceIdentity:
{
Description: The (default) agent instance identity of the application. ,
Required: False ,
}
{
kind:
{
Description: Specifies the kind of Entra identity described by this object. ,
Enum:
{
AgentBlueprint: Represents a class identity, used for agentic applications. ,
AgentInstance: Represents an instance identity. ,
AgenticUser: Represents an agentic instance identity with user-like traits. ,
Managed: Represents a classic managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
type:
{
Description: Enumeration of identity types, from the perspective of management. ,
Enum:
{
System: Platform-managed identity. ,
User: User-managed identity. ,
None: No identity. ,
}
,
Required: True ,
}
enum ,
clientId:
{
Description: The client ID of the identity. ,
Required: True ,
}
string ,
principalId:
{
Description: The principal ID of the identity. ,
Required: True ,
}
string ,
tenantId:
{
Description: The tenant ID of the identity. ,
Required: True ,
}
string ,
subject:
{
Description: The subject of this identity assignment. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Represents the provisioning state of an identity resource. ,
Enum:
{
Creating: Identity is being created. ,
Updating: Identity is being updated. ,
Succeeded: Identity has been successfully provisioned. ,
Failed: Identity provisioning has failed. ,
Canceled: Identity provisioning has been canceled. ,
Deleting: Identity is being deleted. ,
}
,
Required: False ,
}
enum ,
}
,
authorizationPolicy:
{
Description: Gets or sets the authorization policy associated with this agentic application instance. ,
Required: False ,
}
{
type:
{
Description: Authorization scheme type. ,
Enum:
{
Default: Standard AzureML RBAC ,
OrganizationScope: Claim-based, requires membership in the tenant ,
Channels: Channels-specific (AzureBotService) authorization ,
Custom: Custom scheme defined by the application author ,
}
,
Required: True ,
}
enum ,
}
,
trafficRoutingPolicy:
{
Description: Gets or sets the traffic routing policy for the application's deployments. ,
Required: False ,
}
{
protocol:
{
Description: Methodology used to route traffic to the application's deployments. ,
Enum:
{
FixedRatio: Percentage based routing ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: Gets or sets the collection of traffic routing rules. ,
Required: False ,
}
[
{
ruleId:
{
Description: The identifier of this traffic routing rule. ,
Required: False ,
}
string ,
description:
{
Description: A user-provided description for this traffic routing rule. ,
Required: False ,
}
string ,
deploymentId:
{
Description: The unique identifier of the deployment to which traffic is routed by this rule. ,
Required: False ,
}
string ,
trafficPercentage:
{
Description: Gets or sets the percentage of traffic allocated to this instance. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the application. ,
Enum:
{
Succeeded: The application was successfully provisioned. ,
Failed: The application provisioning failed. ,
Canceled: The application provisioning was canceled. ,
Creating: The application is being created. ,
Updating: The application is being updated. ,
Deleting: The application is being deleted. ,
}
,
Required: False ,
}
enum ,
isEnabled:
{
Description: Enabledstate of the application. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}