Share via

Microsoft.CognitiveServices accounts/raiBlocklists

Bicep resource definition

The accounts/raiBlocklists 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/raiBlocklists resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.CognitiveServices/accounts/raiBlocklists@2025-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.CognitiveServices/accounts/raiBlocklists

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: accounts
properties Properties of Cognitive Services RaiBlocklist. RaiBlocklistProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

RaiBlocklistProperties

Name Description Value
description Description of the block list. string

RaiBlocklistTags

Name Description Value

Usage Examples

Bicep Samples

A basic example of deploying Cognitive Services Accounts Responsible AI Blocklists.

param resourceName string = 'acctest0001'
param location string = 'westus'

resource account 'Microsoft.CognitiveServices/accounts@2024-10-01' = {
  name: '${resourceName}-ca'
  location: location
  kind: 'OpenAI'
  properties: {
    allowedFqdnList: []
    apiProperties: {}
    customSubDomainName: ''
    disableLocalAuth: false
    dynamicThrottlingEnabled: false
    publicNetworkAccess: 'Enabled'
    restrictOutboundNetworkAccess: false
  }
  sku: {
    name: 'S0'
  }
}

resource raiBlocklist 'Microsoft.CognitiveServices/accounts/raiBlocklists@2024-10-01' = {
  parent: account
  name: '${resourceName}-crb'
  properties: {
    description: 'Acceptance test data new azurerm resource'
  }
}

ARM template resource definition

The accounts/raiBlocklists 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/raiBlocklists resource, add the following JSON to your template.

{
  "type": "Microsoft.CognitiveServices/accounts/raiBlocklists",
  "apiVersion": "2025-10-01-preview",
  "name": "string",
  "properties": {
    "description": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.CognitiveServices/accounts/raiBlocklists

Name Description Value
apiVersion The api version '2025-10-01-preview'
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
properties Properties of Cognitive Services RaiBlocklist. RaiBlocklistProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.CognitiveServices/accounts/raiBlocklists'

RaiBlocklistProperties

Name Description Value
description Description of the block list. string

RaiBlocklistTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CognitiveServices/accounts/raiBlocklists@2025-10-01-preview"
  name = "string"
  parent_id = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      description = "string"
    }
  }
}

Property Values

Microsoft.CognitiveServices/accounts/raiBlocklists

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: accounts
properties Properties of Cognitive Services RaiBlocklist. RaiBlocklistProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.CognitiveServices/accounts/raiBlocklists@2025-10-01-preview"

RaiBlocklistProperties

Name Description Value
description Description of the block list. string

RaiBlocklistTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Cognitive Services Accounts Responsible AI Blocklists.

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

provider "azapi" {
  skip_provider_registration = false
}

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

variable "location" {
  type    = string
  default = "westus"
}

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@2024-10-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}-ca"
  location  = var.location
  body = {
    kind = "OpenAI"
    properties = {
      allowedFqdnList               = []
      apiProperties                 = {}
      customSubDomainName           = ""
      disableLocalAuth              = false
      dynamicThrottlingEnabled      = false
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = false
    }
    sku = {
      name = "S0"
    }
  }
}

resource "azapi_resource" "raiBlocklist" {
  type      = "Microsoft.CognitiveServices/accounts/raiBlocklists@2024-10-01"
  parent_id = azapi_resource.account.id
  name      = "${var.resource_name}-crb"
  body = {
    properties = {
      description = "Acceptance test data new azurerm resource"
    }
  }
}
  • Last updated on