Microsoft.CognitiveServices accounts/deployments 2021-10-01

Bicep resource definition

The accounts/deployments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CognitiveServices/accounts/deployments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.CognitiveServices/accounts/deployments@2021-10-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    model: {
      format: 'string'
      name: 'string'
      version: 'string'
    }
    scaleSettings: {
      capacity: int
      scaleType: 'string'
    }
  }
}

Property Values

Microsoft.CognitiveServices/accounts/deployments

DeploymentModel

DeploymentProperties

DeploymentScaleSettings

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The accounts/deployments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CognitiveServices/accounts/deployments resource, add the following JSON to your template.

{
  "type": "Microsoft.CognitiveServices/accounts/deployments",
  "apiVersion": "2021-10-01",
  "name": "string",
  "properties": {
    "model": {
      "format": "string",
      "name": "string",
      "version": "string"
    },
    "scaleSettings": {
      "capacity": "int",
      "scaleType": "string"
    }
  }
}

Property Values

Microsoft.CognitiveServices/accounts/deployments

DeploymentModel

DeploymentProperties

DeploymentScaleSettings

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Basic Agent Setup API Keys	This set of templates demonstrates how to set up Azure AI Agent Service with the basic setup using API keys authetication for the AI Service/AOAI connection. Agents use multi-tenant search and storage resources fully managed by Microsoft. You won’t have visibility or control over these underlying Azure resources.
Basic Agent Setup Identity	This set of templates demonstrates how to set up Azure AI Agent Service with the basic setup using managed identity authetication for the AI Service/AOAI connection. Agents use multi-tenant search and storage resources fully managed by Microsoft. You won’t have visibility or control over these underlying Azure resources.
Deploy Secure AI Foundry with a managed virtual network	This template creates a secure Azure AI Foundry environment with robust network and identity security restrictions.
Network Secured Agent with User Managed Identity	This set of templates demonstrates how to set up Azure AI Agent Service with virtual network isolation using User Managed Identity authetication for the AI Service/AOAI connection and private network links to connect the agent to your secure data.
Standard Agent Setup	This set of templates demonstrates how to set up Azure AI Agent Service with the standard setup, meaning with managed identity authentication for project/hub connections and public internet access enabled. Agents use customer-owned, single-tenant search and storage resources. With this setup, you have full control and visibility over these resources, but you will incur costs based on your usage.

Terraform (AzAPI provider) resource definition

The accounts/deployments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.CognitiveServices/accounts/deployments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CognitiveServices/accounts/deployments@2021-10-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      model = {
        format = "string"
        name = "string"
        version = "string"
      }
      scaleSettings = {
        capacity = int
        scaleType = "string"
      }
    }
  }
}

Property Values

Microsoft.CognitiveServices/accounts/deployments

DeploymentModel

DeploymentProperties

DeploymentScaleSettings

Usage Examples

Terraform Samples

A basic example of deploying Cognitive Services Account Deployment.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0003"
}

variable "___location" {
  type    = string
  default = "eastus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  ___location = var.___location
}

resource "azapi_resource" "account" {
  type      = "Microsoft.CognitiveServices/accounts@2022-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  ___location  = var.___location

  body = {
    identity = {
      type                   = "None"
      userAssignedIdentities = null
    }
    kind = "OpenAI"
    properties = {
      disableLocalAuth              = false
      dynamicThrottlingEnabled      = false
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = false
    }
    sku = {
      name = "S0"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "deployment" {
  type      = "Microsoft.CognitiveServices/accounts/deployments@2023-05-01"
  name      = "testdep"
  parent_id = azapi_resource.account.id
  body = {
    properties = {
      model = {
        format = "OpenAI"
        name   = "text-embedding-ada-002"
      }
    }
  }
}