azure-native.cognitiveservices.RaiPolicy
Explore with Pulumi AI
Cognitive Services RaiPolicy. Azure REST API version: 2023-10-01-preview.
Other available API versions: 2024-04-01-preview, 2024-06-01-preview, 2024-10-01.
Example Usage
PutRaiPolicy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var raiPolicy = new AzureNative.CognitiveServices.RaiPolicy("raiPolicy", new()
{
AccountName = "accountName",
Properties = new AzureNative.CognitiveServices.Inputs.RaiPolicyPropertiesArgs
{
BasePolicyName = "Microsoft.Default",
ContentFilters = new[]
{
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.High,
Blocking = false,
Enabled = false,
Name = "hate",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.Medium,
Blocking = true,
Enabled = true,
Name = "hate",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.High,
Blocking = true,
Enabled = true,
Name = "sexual",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.Medium,
Blocking = true,
Enabled = true,
Name = "sexual",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.High,
Blocking = true,
Enabled = true,
Name = "selfharm",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.Medium,
Blocking = true,
Enabled = true,
Name = "selfharm",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.Medium,
Blocking = true,
Enabled = true,
Name = "violence",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = AzureNative.CognitiveServices.AllowedContentLevel.Medium,
Blocking = true,
Enabled = true,
Name = "violence",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "jailbreak",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "protected_material_text",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "protected_material_code",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Completion,
},
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
Blocking = true,
Enabled = true,
Name = "profanity",
Source = AzureNative.CognitiveServices.RaiPolicyContentSource.Prompt,
},
},
Mode = AzureNative.CognitiveServices.RaiPolicyMode.Deferred,
},
RaiPolicyName = "raiPolicyName",
ResourceGroupName = "resourceGroupName",
});
});
package main
import (
cognitiveservices "github.com/pulumi/pulumi-azure-native-sdk/cognitiveservices/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cognitiveservices.NewRaiPolicy(ctx, "raiPolicy", &cognitiveservices.RaiPolicyArgs{
AccountName: pulumi.String("accountName"),
Properties: &cognitiveservices.RaiPolicyPropertiesArgs{
BasePolicyName: pulumi.String("Microsoft.Default"),
ContentFilters: cognitiveservices.RaiPolicyContentFilterArray{
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelHigh),
Blocking: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Name: pulumi.String("hate"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelMedium),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("hate"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelHigh),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("sexual"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelMedium),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("sexual"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelHigh),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("selfharm"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelMedium),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("selfharm"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelMedium),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("violence"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String(cognitiveservices.AllowedContentLevelMedium),
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("violence"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("jailbreak"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("protected_material_text"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("protected_material_code"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourceCompletion),
},
&cognitiveservices.RaiPolicyContentFilterArgs{
Blocking: pulumi.Bool(true),
Enabled: pulumi.Bool(true),
Name: pulumi.String("profanity"),
Source: pulumi.String(cognitiveservices.RaiPolicyContentSourcePrompt),
},
},
Mode: pulumi.String(cognitiveservices.RaiPolicyModeDeferred),
},
RaiPolicyName: pulumi.String("raiPolicyName"),
ResourceGroupName: pulumi.String("resourceGroupName"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.cognitiveservices.RaiPolicy;
import com.pulumi.azurenative.cognitiveservices.RaiPolicyArgs;
import com.pulumi.azurenative.cognitiveservices.inputs.RaiPolicyPropertiesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var raiPolicy = new RaiPolicy("raiPolicy", RaiPolicyArgs.builder()
.accountName("accountName")
.properties(RaiPolicyPropertiesArgs.builder()
.basePolicyName("Microsoft.Default")
.contentFilters(
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("High")
.blocking(false)
.enabled(false)
.name("hate")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("Medium")
.blocking(true)
.enabled(true)
.name("hate")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("High")
.blocking(true)
.enabled(true)
.name("sexual")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("Medium")
.blocking(true)
.enabled(true)
.name("sexual")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("High")
.blocking(true)
.enabled(true)
.name("selfharm")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("Medium")
.blocking(true)
.enabled(true)
.name("selfharm")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("Medium")
.blocking(true)
.enabled(true)
.name("violence")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("Medium")
.blocking(true)
.enabled(true)
.name("violence")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("jailbreak")
.source("Prompt")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("protected_material_text")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("protected_material_code")
.source("Completion")
.build(),
RaiPolicyContentFilterArgs.builder()
.blocking(true)
.enabled(true)
.name("profanity")
.source("Prompt")
.build())
.mode("Deferred")
.build())
.raiPolicyName("raiPolicyName")
.resourceGroupName("resourceGroupName")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
rai_policy = azure_native.cognitiveservices.RaiPolicy("raiPolicy",
account_name="accountName",
properties={
"base_policy_name": "Microsoft.Default",
"content_filters": [
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.HIGH,
"blocking": False,
"enabled": False,
"name": "hate",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.PROMPT,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.MEDIUM,
"blocking": True,
"enabled": True,
"name": "hate",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.COMPLETION,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.HIGH,
"blocking": True,
"enabled": True,
"name": "sexual",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.PROMPT,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.MEDIUM,
"blocking": True,
"enabled": True,
"name": "sexual",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.COMPLETION,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.HIGH,
"blocking": True,
"enabled": True,
"name": "selfharm",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.PROMPT,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.MEDIUM,
"blocking": True,
"enabled": True,
"name": "selfharm",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.COMPLETION,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.MEDIUM,
"blocking": True,
"enabled": True,
"name": "violence",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.PROMPT,
},
{
"allowed_content_level": azure_native.cognitiveservices.AllowedContentLevel.MEDIUM,
"blocking": True,
"enabled": True,
"name": "violence",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.COMPLETION,
},
{
"blocking": True,
"enabled": True,
"name": "jailbreak",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.PROMPT,
},
{
"blocking": True,
"enabled": True,
"name": "protected_material_text",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.COMPLETION,
},
{
"blocking": True,
"enabled": True,
"name": "protected_material_code",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.COMPLETION,
},
{
"blocking": True,
"enabled": True,
"name": "profanity",
"source": azure_native.cognitiveservices.RaiPolicyContentSource.PROMPT,
},
],
"mode": azure_native.cognitiveservices.RaiPolicyMode.DEFERRED,
},
rai_policy_name="raiPolicyName",
resource_group_name="resourceGroupName")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const raiPolicy = new azure_native.cognitiveservices.RaiPolicy("raiPolicy", {
accountName: "accountName",
properties: {
basePolicyName: "Microsoft.Default",
contentFilters: [
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.High,
blocking: false,
enabled: false,
name: "hate",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Prompt,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.Medium,
blocking: true,
enabled: true,
name: "hate",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Completion,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.High,
blocking: true,
enabled: true,
name: "sexual",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Prompt,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.Medium,
blocking: true,
enabled: true,
name: "sexual",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Completion,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.High,
blocking: true,
enabled: true,
name: "selfharm",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Prompt,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.Medium,
blocking: true,
enabled: true,
name: "selfharm",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Completion,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.Medium,
blocking: true,
enabled: true,
name: "violence",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Prompt,
},
{
allowedContentLevel: azure_native.cognitiveservices.AllowedContentLevel.Medium,
blocking: true,
enabled: true,
name: "violence",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Completion,
},
{
blocking: true,
enabled: true,
name: "jailbreak",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Prompt,
},
{
blocking: true,
enabled: true,
name: "protected_material_text",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Completion,
},
{
blocking: true,
enabled: true,
name: "protected_material_code",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Completion,
},
{
blocking: true,
enabled: true,
name: "profanity",
source: azure_native.cognitiveservices.RaiPolicyContentSource.Prompt,
},
],
mode: azure_native.cognitiveservices.RaiPolicyMode.Deferred,
},
raiPolicyName: "raiPolicyName",
resourceGroupName: "resourceGroupName",
});
resources:
raiPolicy:
type: azure-native:cognitiveservices:RaiPolicy
properties:
accountName: accountName
properties:
basePolicyName: Microsoft.Default
contentFilters:
- allowedContentLevel: High
blocking: false
enabled: false
name: hate
source: Prompt
- allowedContentLevel: Medium
blocking: true
enabled: true
name: hate
source: Completion
- allowedContentLevel: High
blocking: true
enabled: true
name: sexual
source: Prompt
- allowedContentLevel: Medium
blocking: true
enabled: true
name: sexual
source: Completion
- allowedContentLevel: High
blocking: true
enabled: true
name: selfharm
source: Prompt
- allowedContentLevel: Medium
blocking: true
enabled: true
name: selfharm
source: Completion
- allowedContentLevel: Medium
blocking: true
enabled: true
name: violence
source: Prompt
- allowedContentLevel: Medium
blocking: true
enabled: true
name: violence
source: Completion
- blocking: true
enabled: true
name: jailbreak
source: Prompt
- blocking: true
enabled: true
name: protected_material_text
source: Completion
- blocking: true
enabled: true
name: protected_material_code
source: Completion
- blocking: true
enabled: true
name: profanity
source: Prompt
mode: Deferred
raiPolicyName: raiPolicyName
resourceGroupName: resourceGroupName
Create RaiPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RaiPolicy(name: string, args: RaiPolicyArgs, opts?: CustomResourceOptions);
@overload
def RaiPolicy(resource_name: str,
args: RaiPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RaiPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
properties: Optional[RaiPolicyPropertiesArgs] = None,
rai_policy_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewRaiPolicy(ctx *Context, name string, args RaiPolicyArgs, opts ...ResourceOption) (*RaiPolicy, error)
public RaiPolicy(string name, RaiPolicyArgs args, CustomResourceOptions? opts = null)
public RaiPolicy(String name, RaiPolicyArgs args)
public RaiPolicy(String name, RaiPolicyArgs args, CustomResourceOptions options)
type: azure-native:cognitiveservices:RaiPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RaiPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RaiPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RaiPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RaiPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RaiPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var raiPolicyResource = new AzureNative.CognitiveServices.RaiPolicy("raiPolicyResource", new()
{
AccountName = "string",
ResourceGroupName = "string",
Properties = new AzureNative.CognitiveServices.Inputs.RaiPolicyPropertiesArgs
{
BasePolicyName = "string",
CompletionBlocklists = new[]
{
new AzureNative.CognitiveServices.Inputs.RaiBlocklistConfigArgs
{
Blocking = false,
BlocklistName = "string",
},
},
ContentFilters = new[]
{
new AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterArgs
{
AllowedContentLevel = "string",
Blocking = false,
Enabled = false,
Name = "string",
Source = "string",
},
},
Mode = "string",
PromptBlocklists = new[]
{
new AzureNative.CognitiveServices.Inputs.RaiBlocklistConfigArgs
{
Blocking = false,
BlocklistName = "string",
},
},
},
RaiPolicyName = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := cognitiveservices.NewRaiPolicy(ctx, "raiPolicyResource", &cognitiveservices.RaiPolicyArgs{
AccountName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Properties: &cognitiveservices.RaiPolicyPropertiesArgs{
BasePolicyName: pulumi.String("string"),
CompletionBlocklists: cognitiveservices.RaiBlocklistConfigArray{
&cognitiveservices.RaiBlocklistConfigArgs{
Blocking: pulumi.Bool(false),
BlocklistName: pulumi.String("string"),
},
},
ContentFilters: cognitiveservices.RaiPolicyContentFilterArray{
&cognitiveservices.RaiPolicyContentFilterArgs{
AllowedContentLevel: pulumi.String("string"),
Blocking: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
Name: pulumi.String("string"),
Source: pulumi.String("string"),
},
},
Mode: pulumi.String("string"),
PromptBlocklists: cognitiveservices.RaiBlocklistConfigArray{
&cognitiveservices.RaiBlocklistConfigArgs{
Blocking: pulumi.Bool(false),
BlocklistName: pulumi.String("string"),
},
},
},
RaiPolicyName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var raiPolicyResource = new RaiPolicy("raiPolicyResource", RaiPolicyArgs.builder()
.accountName("string")
.resourceGroupName("string")
.properties(RaiPolicyPropertiesArgs.builder()
.basePolicyName("string")
.completionBlocklists(RaiBlocklistConfigArgs.builder()
.blocking(false)
.blocklistName("string")
.build())
.contentFilters(RaiPolicyContentFilterArgs.builder()
.allowedContentLevel("string")
.blocking(false)
.enabled(false)
.name("string")
.source("string")
.build())
.mode("string")
.promptBlocklists(RaiBlocklistConfigArgs.builder()
.blocking(false)
.blocklistName("string")
.build())
.build())
.raiPolicyName("string")
.tags(Map.of("string", "string"))
.build());
rai_policy_resource = azure_native.cognitiveservices.RaiPolicy("raiPolicyResource",
account_name="string",
resource_group_name="string",
properties={
"base_policy_name": "string",
"completion_blocklists": [{
"blocking": False,
"blocklist_name": "string",
}],
"content_filters": [{
"allowed_content_level": "string",
"blocking": False,
"enabled": False,
"name": "string",
"source": "string",
}],
"mode": "string",
"prompt_blocklists": [{
"blocking": False,
"blocklist_name": "string",
}],
},
rai_policy_name="string",
tags={
"string": "string",
})
const raiPolicyResource = new azure_native.cognitiveservices.RaiPolicy("raiPolicyResource", {
accountName: "string",
resourceGroupName: "string",
properties: {
basePolicyName: "string",
completionBlocklists: [{
blocking: false,
blocklistName: "string",
}],
contentFilters: [{
allowedContentLevel: "string",
blocking: false,
enabled: false,
name: "string",
source: "string",
}],
mode: "string",
promptBlocklists: [{
blocking: false,
blocklistName: "string",
}],
},
raiPolicyName: "string",
tags: {
string: "string",
},
});
type: azure-native:cognitiveservices:RaiPolicy
properties:
accountName: string
properties:
basePolicyName: string
completionBlocklists:
- blocking: false
blocklistName: string
contentFilters:
- allowedContentLevel: string
blocking: false
enabled: false
name: string
source: string
mode: string
promptBlocklists:
- blocking: false
blocklistName: string
raiPolicyName: string
resourceGroupName: string
tags:
string: string
RaiPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RaiPolicy resource accepts the following input properties:
- Account
Name string - The name of Cognitive Services account.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Properties
Pulumi.
Azure Native. Cognitive Services. Inputs. Rai Policy Properties - Properties of Cognitive Services RaiPolicy.
- Rai
Policy stringName - The name of the RaiPolicy associated with the Cognitive Services Account
- Dictionary<string, string>
- Resource tags.
- Account
Name string - The name of Cognitive Services account.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Properties
Rai
Policy Properties Args - Properties of Cognitive Services RaiPolicy.
- Rai
Policy stringName - The name of the RaiPolicy associated with the Cognitive Services Account
- map[string]string
- Resource tags.
- account
Name String - The name of Cognitive Services account.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- properties
Rai
Policy Properties - Properties of Cognitive Services RaiPolicy.
- rai
Policy StringName - The name of the RaiPolicy associated with the Cognitive Services Account
- Map<String,String>
- Resource tags.
- account
Name string - The name of Cognitive Services account.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- properties
Rai
Policy Properties - Properties of Cognitive Services RaiPolicy.
- rai
Policy stringName - The name of the RaiPolicy associated with the Cognitive Services Account
- {[key: string]: string}
- Resource tags.
- account_
name str - The name of Cognitive Services account.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- properties
Rai
Policy Properties Args - Properties of Cognitive Services RaiPolicy.
- rai_
policy_ strname - The name of the RaiPolicy associated with the Cognitive Services Account
- Mapping[str, str]
- Resource tags.
- account
Name String - The name of Cognitive Services account.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- properties Property Map
- Properties of Cognitive Services RaiPolicy.
- rai
Policy StringName - The name of the RaiPolicy associated with the Cognitive Services Account
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the RaiPolicy resource produces the following output properties:
- Etag string
- Resource Etag.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Cognitive Services. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Etag string
- Resource Etag.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag String
- Resource Etag.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag string
- Resource Etag.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag str
- Resource Etag.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- etag String
- Resource Etag.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
AllowedContentLevel, AllowedContentLevelArgs
- Low
- Low
- Medium
- Medium
- High
- High
- Allowed
Content Level Low - Low
- Allowed
Content Level Medium - Medium
- Allowed
Content Level High - High
- Low
- Low
- Medium
- Medium
- High
- High
- Low
- Low
- Medium
- Medium
- High
- High
- LOW
- Low
- MEDIUM
- Medium
- HIGH
- High
- "Low"
- Low
- "Medium"
- Medium
- "High"
- High
RaiBlocklistConfig, RaiBlocklistConfigArgs
- Blocking bool
- If blocking would occur.
- Blocklist
Name string - Name of ContentFilter.
- Blocking bool
- If blocking would occur.
- Blocklist
Name string - Name of ContentFilter.
- blocking Boolean
- If blocking would occur.
- blocklist
Name String - Name of ContentFilter.
- blocking boolean
- If blocking would occur.
- blocklist
Name string - Name of ContentFilter.
- blocking bool
- If blocking would occur.
- blocklist_
name str - Name of ContentFilter.
- blocking Boolean
- If blocking would occur.
- blocklist
Name String - Name of ContentFilter.
RaiBlocklistConfigResponse, RaiBlocklistConfigResponseArgs
- Blocking bool
- If blocking would occur.
- Blocklist
Name string - Name of ContentFilter.
- Blocking bool
- If blocking would occur.
- Blocklist
Name string - Name of ContentFilter.
- blocking Boolean
- If blocking would occur.
- blocklist
Name String - Name of ContentFilter.
- blocking boolean
- If blocking would occur.
- blocklist
Name string - Name of ContentFilter.
- blocking bool
- If blocking would occur.
- blocklist_
name str - Name of ContentFilter.
- blocking Boolean
- If blocking would occur.
- blocklist
Name String - Name of ContentFilter.
RaiPolicyContentFilter, RaiPolicyContentFilterArgs
- Allowed
Content string | Pulumi.Level Azure Native. Cognitive Services. Allowed Content Level - Level at which content is filtered.
- Blocking bool
- If blocking would occur.
- Enabled bool
- If the ContentFilter is enabled.
- Name string
- Name of ContentFilter.
- Source
string | Pulumi.
Azure Native. Cognitive Services. Rai Policy Content Source - Content source to apply the Content Filters.
- Allowed
Content string | AllowedLevel Content Level - Level at which content is filtered.
- Blocking bool
- If blocking would occur.
- Enabled bool
- If the ContentFilter is enabled.
- Name string
- Name of ContentFilter.
- Source
string | Rai
Policy Content Source - Content source to apply the Content Filters.
- allowed
Content String | AllowedLevel Content Level - Level at which content is filtered.
- blocking Boolean
- If blocking would occur.
- enabled Boolean
- If the ContentFilter is enabled.
- name String
- Name of ContentFilter.
- source
String | Rai
Policy Content Source - Content source to apply the Content Filters.
- allowed
Content string | AllowedLevel Content Level - Level at which content is filtered.
- blocking boolean
- If blocking would occur.
- enabled boolean
- If the ContentFilter is enabled.
- name string
- Name of ContentFilter.
- source
string | Rai
Policy Content Source - Content source to apply the Content Filters.
- allowed_
content_ str | Allowedlevel Content Level - Level at which content is filtered.
- blocking bool
- If blocking would occur.
- enabled bool
- If the ContentFilter is enabled.
- name str
- Name of ContentFilter.
- source
str | Rai
Policy Content Source - Content source to apply the Content Filters.
- allowed
Content String | "Low" | "Medium" | "High"Level - Level at which content is filtered.
- blocking Boolean
- If blocking would occur.
- enabled Boolean
- If the ContentFilter is enabled.
- name String
- Name of ContentFilter.
- source String | "Prompt" | "Completion"
- Content source to apply the Content Filters.
RaiPolicyContentFilterResponse, RaiPolicyContentFilterResponseArgs
- Allowed
Content stringLevel - Level at which content is filtered.
- Blocking bool
- If blocking would occur.
- Enabled bool
- If the ContentFilter is enabled.
- Name string
- Name of ContentFilter.
- Source string
- Content source to apply the Content Filters.
- Allowed
Content stringLevel - Level at which content is filtered.
- Blocking bool
- If blocking would occur.
- Enabled bool
- If the ContentFilter is enabled.
- Name string
- Name of ContentFilter.
- Source string
- Content source to apply the Content Filters.
- allowed
Content StringLevel - Level at which content is filtered.
- blocking Boolean
- If blocking would occur.
- enabled Boolean
- If the ContentFilter is enabled.
- name String
- Name of ContentFilter.
- source String
- Content source to apply the Content Filters.
- allowed
Content stringLevel - Level at which content is filtered.
- blocking boolean
- If blocking would occur.
- enabled boolean
- If the ContentFilter is enabled.
- name string
- Name of ContentFilter.
- source string
- Content source to apply the Content Filters.
- allowed_
content_ strlevel - Level at which content is filtered.
- blocking bool
- If blocking would occur.
- enabled bool
- If the ContentFilter is enabled.
- name str
- Name of ContentFilter.
- source str
- Content source to apply the Content Filters.
- allowed
Content StringLevel - Level at which content is filtered.
- blocking Boolean
- If blocking would occur.
- enabled Boolean
- If the ContentFilter is enabled.
- name String
- Name of ContentFilter.
- source String
- Content source to apply the Content Filters.
RaiPolicyContentSource, RaiPolicyContentSourceArgs
- Prompt
- Prompt
- Completion
- Completion
- Rai
Policy Content Source Prompt - Prompt
- Rai
Policy Content Source Completion - Completion
- Prompt
- Prompt
- Completion
- Completion
- Prompt
- Prompt
- Completion
- Completion
- PROMPT
- Prompt
- COMPLETION
- Completion
- "Prompt"
- Prompt
- "Completion"
- Completion
RaiPolicyMode, RaiPolicyModeArgs
- Default
- Default
- Deferred
- Deferred
- Blocking
- Blocking
- Rai
Policy Mode Default - Default
- Rai
Policy Mode Deferred - Deferred
- Rai
Policy Mode Blocking - Blocking
- Default
- Default
- Deferred
- Deferred
- Blocking
- Blocking
- Default
- Default
- Deferred
- Deferred
- Blocking
- Blocking
- DEFAULT
- Default
- DEFERRED
- Deferred
- BLOCKING
- Blocking
- "Default"
- Default
- "Deferred"
- Deferred
- "Blocking"
- Blocking
RaiPolicyProperties, RaiPolicyPropertiesArgs
- Base
Policy stringName - Name of the base Content Filters.
- Completion
Blocklists List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Blocklist Config> - The list of blocklists for completion.
- Content
Filters List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Policy Content Filter> - The list of Content Filters.
- Mode
string | Pulumi.
Azure Native. Cognitive Services. Rai Policy Mode - Content Filters mode.
- Prompt
Blocklists List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Blocklist Config> - The list of blocklists for prompt.
- Base
Policy stringName - Name of the base Content Filters.
- Completion
Blocklists []RaiBlocklist Config - The list of blocklists for completion.
- Content
Filters []RaiPolicy Content Filter - The list of Content Filters.
- Mode
string | Rai
Policy Mode - Content Filters mode.
- Prompt
Blocklists []RaiBlocklist Config - The list of blocklists for prompt.
- base
Policy StringName - Name of the base Content Filters.
- completion
Blocklists List<RaiBlocklist Config> - The list of blocklists for completion.
- content
Filters List<RaiPolicy Content Filter> - The list of Content Filters.
- mode
String | Rai
Policy Mode - Content Filters mode.
- prompt
Blocklists List<RaiBlocklist Config> - The list of blocklists for prompt.
- base
Policy stringName - Name of the base Content Filters.
- completion
Blocklists RaiBlocklist Config[] - The list of blocklists for completion.
- content
Filters RaiPolicy Content Filter[] - The list of Content Filters.
- mode
string | Rai
Policy Mode - Content Filters mode.
- prompt
Blocklists RaiBlocklist Config[] - The list of blocklists for prompt.
- base_
policy_ strname - Name of the base Content Filters.
- completion_
blocklists Sequence[RaiBlocklist Config] - The list of blocklists for completion.
- content_
filters Sequence[RaiPolicy Content Filter] - The list of Content Filters.
- mode
str | Rai
Policy Mode - Content Filters mode.
- prompt_
blocklists Sequence[RaiBlocklist Config] - The list of blocklists for prompt.
- base
Policy StringName - Name of the base Content Filters.
- completion
Blocklists List<Property Map> - The list of blocklists for completion.
- content
Filters List<Property Map> - The list of Content Filters.
- mode String | "Default" | "Deferred" | "Blocking"
- Content Filters mode.
- prompt
Blocklists List<Property Map> - The list of blocklists for prompt.
RaiPolicyPropertiesResponse, RaiPolicyPropertiesResponseArgs
- Policy
Type string - Content Filters policy type.
- Base
Policy stringName - Name of the base Content Filters.
- Completion
Blocklists List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Blocklist Config Response> - The list of blocklists for completion.
- Content
Filters List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Policy Content Filter Response> - The list of Content Filters.
- Mode string
- Content Filters mode.
- Prompt
Blocklists List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Blocklist Config Response> - The list of blocklists for prompt.
- Policy
Type string - Content Filters policy type.
- Base
Policy stringName - Name of the base Content Filters.
- Completion
Blocklists []RaiBlocklist Config Response - The list of blocklists for completion.
- Content
Filters []RaiPolicy Content Filter Response - The list of Content Filters.
- Mode string
- Content Filters mode.
- Prompt
Blocklists []RaiBlocklist Config Response - The list of blocklists for prompt.
- policy
Type String - Content Filters policy type.
- base
Policy StringName - Name of the base Content Filters.
- completion
Blocklists List<RaiBlocklist Config Response> - The list of blocklists for completion.
- content
Filters List<RaiPolicy Content Filter Response> - The list of Content Filters.
- mode String
- Content Filters mode.
- prompt
Blocklists List<RaiBlocklist Config Response> - The list of blocklists for prompt.
- policy
Type string - Content Filters policy type.
- base
Policy stringName - Name of the base Content Filters.
- completion
Blocklists RaiBlocklist Config Response[] - The list of blocklists for completion.
- content
Filters RaiPolicy Content Filter Response[] - The list of Content Filters.
- mode string
- Content Filters mode.
- prompt
Blocklists RaiBlocklist Config Response[] - The list of blocklists for prompt.
- policy_
type str - Content Filters policy type.
- base_
policy_ strname - Name of the base Content Filters.
- completion_
blocklists Sequence[RaiBlocklist Config Response] - The list of blocklists for completion.
- content_
filters Sequence[RaiPolicy Content Filter Response] - The list of Content Filters.
- mode str
- Content Filters mode.
- prompt_
blocklists Sequence[RaiBlocklist Config Response] - The list of blocklists for prompt.
- policy
Type String - Content Filters policy type.
- base
Policy StringName - Name of the base Content Filters.
- completion
Blocklists List<Property Map> - The list of blocklists for completion.
- content
Filters List<Property Map> - The list of Content Filters.
- mode String
- Content Filters mode.
- prompt
Blocklists List<Property Map> - The list of blocklists for prompt.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cognitiveservices:RaiPolicy raiPolicyName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/raiPolicies/{raiPolicyName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0