Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces/connections/raiPolicies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.MachineLearningServices/workspaces/connections/raiPolicies resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.MachineLearningServices/workspaces/connections/raiPolicies@2024-07-01-preview' = {
parent: resourceSymbolicName
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
Microsoft.MachineLearningServices/workspaces/connections/raiPolicies
| 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: workspaces/connections |
| properties | Azure OpenAI Content Filters properties. | RaiPolicyProperties (required) |
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' |
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' |
ARM template resource definition
The workspaces/connections/raiPolicies resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.MachineLearningServices/workspaces/connections/raiPolicies resource, add the following JSON to your template.
{
"type": "Microsoft.MachineLearningServices/workspaces/connections/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
Microsoft.MachineLearningServices/workspaces/connections/raiPolicies
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-01-preview' |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_.-]*$ (required) |
| properties | Azure OpenAI Content Filters properties. | RaiPolicyProperties (required) |
| type | The resource type | 'Microsoft.MachineLearningServices/workspaces/connections/raiPolicies' |
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' |
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' |
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/connections/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/connections/raiPolicies resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.MachineLearningServices/workspaces/connections/raiPolicies@2024-07-01-preview"
name = "string"
parent_id = "string"
body = {
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
Microsoft.MachineLearningServices/workspaces/connections/raiPolicies
| 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: workspaces/connections |
| properties | Azure OpenAI Content Filters properties. | RaiPolicyProperties (required) |
| type | The resource type | "Microsoft.MachineLearningServices/workspaces/connections/raiPolicies@2024-07-01-preview" |
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' |
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' |