Microsoft.MachineLearningServices workspaces/endpoints/raiPolicies

  • Article

Bicep resource definition

The workspaces/endpoints/raiPolicies 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.MachineLearningServices/workspaces/endpoints/raiPolicies resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/endpoints/raiPolicies@2024-07-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    basePolicyName: 'string'
    completionBlocklists: [
      {
        blocking: bool
        blocklistName: 'string'
      }
    ]
    contentFilters: [
      {
        allowedContentLevel: 'string'
        blocking: bool
        enabled: bool
        name: 'string'
        source: 'string'
      }
    ]
    mode: 'string'
    promptBlocklists: [
      {
        blocking: bool
        blocklistName: 'string'
      }
    ]
    type: 'string'
  }
}

Property values

workspaces/endpoints/raiPolicies

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (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: endpoints
properties Azure OpenAI Content Filters properties. RaiPolicyProperties (required)

RaiPolicyProperties

Name Description Value
basePolicyName Name of the base Content Filters. string
completionBlocklists RaiBlocklistConfig[]
contentFilters RaiPolicyContentFilter[]
mode Content Filters mode. 'Blocking'
'Default'
'Deferred'
promptBlocklists RaiBlocklistConfig[]
type Content Filters policy type. 'SystemManaged'
'UserManaged'

RaiBlocklistConfig

Name Description Value
blocking If blocking would occur. bool
blocklistName Name of ContentFilter. string

RaiPolicyContentFilter

Name Description Value
allowedContentLevel Level at which content is filtered. 'High'
'Low'
'Medium'
blocking If blocking would occur. bool
enabled If the ContentFilter is enabled. bool
name Name of ContentFilter. string
source Content source to apply the Content Filters. 'Completion'
'Prompt'

ARM template resource definition

The workspaces/endpoints/raiPolicies 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.MachineLearningServices/workspaces/endpoints/raiPolicies resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/endpoints/raiPolicies",
  "apiVersion": "2024-07-01-preview",
  "name": "string",
  "properties": {
    "basePolicyName": "string",
    "completionBlocklists": [
      {
        "blocking": "bool",
        "blocklistName": "string"
      }
    ],
    "contentFilters": [
      {
        "allowedContentLevel": "string",
        "blocking": "bool",
        "enabled": "bool",
        "name": "string",
        "source": "string"
      }
    ],
    "mode": "string",
    "promptBlocklists": [
      {
        "blocking": "bool",
        "blocklistName": "string"
      }
    ],
    "type": "string"
  }
}

Property values

workspaces/endpoints/raiPolicies

Name Description Value
type The resource type 'Microsoft.MachineLearningServices/workspaces/endpoints/raiPolicies'
apiVersion The resource api version '2024-07-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Azure OpenAI Content Filters properties. RaiPolicyProperties (required)

RaiPolicyProperties

Name Description Value
basePolicyName Name of the base Content Filters. string
completionBlocklists RaiBlocklistConfig[]
contentFilters RaiPolicyContentFilter[]
mode Content Filters mode. 'Blocking'
'Default'
'Deferred'
promptBlocklists RaiBlocklistConfig[]
type Content Filters policy type. 'SystemManaged'
'UserManaged'

RaiBlocklistConfig

Name Description Value
blocking If blocking would occur. bool
blocklistName Name of ContentFilter. string

RaiPolicyContentFilter

Name Description Value
allowedContentLevel Level at which content is filtered. 'High'
'Low'
'Medium'
blocking If blocking would occur. bool
enabled If the ContentFilter is enabled. bool
name Name of ContentFilter. string
source Content source to apply the Content Filters. 'Completion'
'Prompt'

Terraform (AzAPI provider) resource definition

The workspaces/endpoints/raiPolicies 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.MachineLearningServices/workspaces/endpoints/raiPolicies resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/endpoints/raiPolicies@2024-07-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      basePolicyName = "string"
      completionBlocklists = [
        {
          blocking = bool
          blocklistName = "string"
        }
      ]
      contentFilters = [
        {
          allowedContentLevel = "string"
          blocking = bool
          enabled = bool
          name = "string"
          source = "string"
        }
      ]
      mode = "string"
      promptBlocklists = [
        {
          blocking = bool
          blocklistName = "string"
        }
      ]
      type = "string"
    }
  })
}

Property values

workspaces/endpoints/raiPolicies

Name Description Value
type The resource type "Microsoft.MachineLearningServices/workspaces/endpoints/raiPolicies@2024-07-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: endpoints
properties Azure OpenAI Content Filters properties. RaiPolicyProperties (required)

RaiPolicyProperties

Name Description Value
basePolicyName Name of the base Content Filters. string
completionBlocklists RaiBlocklistConfig[]
contentFilters RaiPolicyContentFilter[]
mode Content Filters mode. "Blocking"
"Default"
"Deferred"
promptBlocklists RaiBlocklistConfig[]
type Content Filters policy type. "SystemManaged"
"UserManaged"

RaiBlocklistConfig

Name Description Value
blocking If blocking would occur. bool
blocklistName Name of ContentFilter. string

RaiPolicyContentFilter

Name Description Value
allowedContentLevel Level at which content is filtered. "High"
"Low"
"Medium"
blocking If blocking would occur. bool
enabled If the ContentFilter is enabled. bool
name Name of ContentFilter. string
source Content source to apply the Content Filters. "Completion"
"Prompt"