Share via


Projects - Create

Create Cognitive Services Account's Project. Project is a sub-resource of an account which give AI developer it's individual container to work on.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/projects/{projectName}?api-version=2025-06-01

URI Parameters

Name In Required Type Description
accountName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

The name of Cognitive Services account.

projectName
path True

string

minLength: 2
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$

The name of Cognitive Services account's project.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string

minLength: 1

The ID of the target subscription.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
identity

Identity

Identity for the resource.

location

string

The geo-location where the resource lives

properties

ProjectProperties

Properties of Cognitive Services project.

tags

object

Resource tags.

Responses

Name Type Description
200 OK

Project

If resource is created successfully or already existed, the service should return 200 (OK).

201 Created

Project

If resource is created successfully, the service should return 201 (OK).

202 Accepted

Project

HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously.

Other Status Codes

ErrorResponse

Error response describing why the operation failed

Examples

Create Project
Create Project Min

Create Project

Sample request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1?api-version=2025-06-01

{
  "location": "West US",
  "properties": {
    "description": "Description of this project",
    "displayName": "p1"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1",
  "name": "testProject1",
  "type": "Microsoft.CognitiveServices/accounts/projects",
  "location": "West US",
  "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"",
  "properties": {
    "description": "Description of this project",
    "displayName": "p1",
    "provisioningState": "Succeeded",
    "endpoints": {
      "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/"
    },
    "isDefault": true
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1",
  "name": "testProject1",
  "type": "Microsoft.CognitiveServices/accounts/projects",
  "location": "West US",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "description": "Description of this project",
    "displayName": "p1",
    "provisioningState": "Succeeded",
    "endpoints": {
      "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/"
    },
    "isDefault": true
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1",
  "name": "testProject1",
  "type": "Microsoft.CognitiveServices/accounts/projects",
  "location": "West US",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "description": "Description of this project",
    "displayName": "p1",
    "provisioningState": "Succeeded",
    "endpoints": {
      "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/"
    },
    "isDefault": true
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Create Project Min

Sample request

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1?api-version=2025-06-01

{
  "location": "West US",
  "properties": {},
  "identity": {
    "type": "SystemAssigned"
  }
}

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1/projects/testProject1",
  "name": "testProject1",
  "type": "Microsoft.CognitiveServices/accounts/projects",
  "location": "West US",
  "etag": "W/\"datetime'2017-04-10T08%3A00%3A05.445595Z'\"",
  "properties": {
    "provisioningState": "Succeeded",
    "endpoints": {
      "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/"
    },
    "isDefault": true
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testProject1",
  "type": "Microsoft.CognitiveServices/accounts/projects",
  "location": "West US",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "provisioningState": "Succeeded",
    "endpoints": {
      "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/"
    },
    "isDefault": true
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/testCreate1",
  "name": "testProject1",
  "type": "Microsoft.CognitiveServices/accounts/projects",
  "location": "West US",
  "etag": "W/\"datetime'2017-04-10T07%3A57%3A48.4582781Z'\"",
  "properties": {
    "provisioningState": "Succeeded",
    "endpoints": {
      "OpenAI Language Model Instance API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Dall-E API": "https://sub-donmain-name.openai.azure.com/",
      "OpenAI Sora API": "https://sub-donmain-name.openai.azure.com/"
    },
    "isDefault": true
  },
  "identity": {
    "principalId": "b5cf119e-a5c2-42c7-802f-592e0efb169f",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  }
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Identity

Identity for the resource.

Project

Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.

ProjectProperties

Properties of Cognitive Services Project'.

ProvisioningState

Gets the status of the cognitive services account at the time the operation was called.

ResourceIdentityType

The identity type.

systemData

Metadata pertaining to creation and last modification of the resource.

UserAssignedIdentity

User-assigned managed identity.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

Identity

Identity for the resource.

Name Type Description
principalId

string

The principal ID of resource identity.

tenantId

string

The tenant ID of resource.

type

ResourceIdentityType

The identity type.

userAssignedIdentities

<string,  UserAssignedIdentity>

The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

Project

Cognitive Services project is an Azure resource representing the provisioned account's project, it's type, location and SKU.

Name Type Description
etag

string

Resource Etag.

id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identity for the resource.

location

string

The geo-location where the resource lives

name

string

The name of the resource

properties

ProjectProperties

Properties of Cognitive Services project.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

tags

object

Resource tags.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ProjectProperties

Properties of Cognitive Services Project'.

Name Type Description
description

string

The description of the Cognitive Services Project.

displayName

string

The display name of the Cognitive Services Project.

endpoints

object

The list of endpoint for this Cognitive Services Project.

isDefault

boolean

Indicates whether the project is the default project for the account.

provisioningState

ProvisioningState

Gets the status of the cognitive services project at the time the operation was called.

ProvisioningState

Gets the status of the cognitive services account at the time the operation was called.

Value Description
Accepted
Creating
Deleting
Moving
Failed
Succeeded
ResolvingDNS

ResourceIdentityType

The identity type.

Value Description
None
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.

UserAssignedIdentity

User-assigned managed identity.

Name Type Description
clientId

string

Client App Id associated with this identity.

principalId

string

Azure Active Directory principal ID associated with this Identity.