1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getRaiPolicy
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.cognitiveservices.getRaiPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

    Gets the specified Content Filters associated with the Azure OpenAI account.

    Uses Azure REST API version 2024-10-01.

    Other available API versions: 2023-10-01-preview, 2024-04-01-preview, 2024-06-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cognitiveservices [ApiVersion]. See the version guide for details.

    Using getRaiPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRaiPolicy(args: GetRaiPolicyArgs, opts?: InvokeOptions): Promise<GetRaiPolicyResult>
    function getRaiPolicyOutput(args: GetRaiPolicyOutputArgs, opts?: InvokeOptions): Output<GetRaiPolicyResult>
    def get_rai_policy(account_name: Optional[str] = None,
                       rai_policy_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRaiPolicyResult
    def get_rai_policy_output(account_name: Optional[pulumi.Input[str]] = None,
                       rai_policy_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRaiPolicyResult]
    func LookupRaiPolicy(ctx *Context, args *LookupRaiPolicyArgs, opts ...InvokeOption) (*LookupRaiPolicyResult, error)
    func LookupRaiPolicyOutput(ctx *Context, args *LookupRaiPolicyOutputArgs, opts ...InvokeOption) LookupRaiPolicyResultOutput

    > Note: This function is named LookupRaiPolicy in the Go SDK.

    public static class GetRaiPolicy 
    {
        public static Task<GetRaiPolicyResult> InvokeAsync(GetRaiPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetRaiPolicyResult> Invoke(GetRaiPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRaiPolicyResult> getRaiPolicy(GetRaiPolicyArgs args, InvokeOptions options)
    public static Output<GetRaiPolicyResult> getRaiPolicy(GetRaiPolicyArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:cognitiveservices:getRaiPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The name of Cognitive Services account.
    RaiPolicyName string
    The name of the RaiPolicy associated with the Cognitive Services Account
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AccountName string
    The name of Cognitive Services account.
    RaiPolicyName string
    The name of the RaiPolicy associated with the Cognitive Services Account
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of Cognitive Services account.
    raiPolicyName String
    The name of the RaiPolicy associated with the Cognitive Services Account
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    accountName string
    The name of Cognitive Services account.
    raiPolicyName string
    The name of the RaiPolicy associated with the Cognitive Services Account
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    account_name str
    The name of Cognitive Services account.
    rai_policy_name str
    The name of the RaiPolicy associated with the Cognitive Services Account
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    accountName String
    The name of Cognitive Services account.
    raiPolicyName String
    The name of the RaiPolicy associated with the Cognitive Services Account
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getRaiPolicy Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    Resource Etag.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.CognitiveServices.Outputs.RaiPolicyPropertiesResponse
    Properties of Cognitive Services RaiPolicy.
    SystemData Pulumi.AzureNative.CognitiveServices.Outputs.SystemDataResponse
    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"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Etag string
    Resource Etag.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Properties RaiPolicyPropertiesResponse
    Properties of Cognitive Services RaiPolicy.
    SystemData SystemDataResponse
    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"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    Resource Etag.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    properties RaiPolicyPropertiesResponse
    Properties of Cognitive Services RaiPolicy.
    systemData SystemDataResponse
    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"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    etag string
    Resource Etag.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    properties RaiPolicyPropertiesResponse
    Properties of Cognitive Services RaiPolicy.
    systemData SystemDataResponse
    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"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    etag str
    Resource Etag.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    properties RaiPolicyPropertiesResponse
    Properties of Cognitive Services RaiPolicy.
    system_data SystemDataResponse
    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"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    etag String
    Resource Etag.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    properties Property Map
    Properties of Cognitive Services RaiPolicy.
    systemData 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"
    tags Map<String>
    Resource tags.

    Supporting Types

    CustomBlocklistConfigResponse

    Blocking bool
    If blocking would occur.
    BlocklistName string
    Name of ContentFilter.
    Source string
    Content source to apply the Content Filters.
    Blocking bool
    If blocking would occur.
    BlocklistName string
    Name of ContentFilter.
    Source string
    Content source to apply the Content Filters.
    blocking Boolean
    If blocking would occur.
    blocklistName String
    Name of ContentFilter.
    source String
    Content source to apply the Content Filters.
    blocking boolean
    If blocking would occur.
    blocklistName string
    Name of ContentFilter.
    source string
    Content source to apply the Content Filters.
    blocking bool
    If blocking would occur.
    blocklist_name str
    Name of ContentFilter.
    source str
    Content source to apply the Content Filters.
    blocking Boolean
    If blocking would occur.
    blocklistName String
    Name of ContentFilter.
    source String
    Content source to apply the Content Filters.

    RaiPolicyContentFilterResponse

    Blocking bool
    If blocking would occur.
    Enabled bool
    If the ContentFilter is enabled.
    Name string
    Name of ContentFilter.
    SeverityThreshold string
    Level at which content is filtered.
    Source string
    Content source to apply the Content Filters.
    Blocking bool
    If blocking would occur.
    Enabled bool
    If the ContentFilter is enabled.
    Name string
    Name of ContentFilter.
    SeverityThreshold string
    Level at which content is filtered.
    Source string
    Content source to apply the Content Filters.
    blocking Boolean
    If blocking would occur.
    enabled Boolean
    If the ContentFilter is enabled.
    name String
    Name of ContentFilter.
    severityThreshold String
    Level at which content is filtered.
    source String
    Content source to apply the Content Filters.
    blocking boolean
    If blocking would occur.
    enabled boolean
    If the ContentFilter is enabled.
    name string
    Name of ContentFilter.
    severityThreshold string
    Level at which content is filtered.
    source string
    Content source to apply the Content Filters.
    blocking bool
    If blocking would occur.
    enabled bool
    If the ContentFilter is enabled.
    name str
    Name of ContentFilter.
    severity_threshold str
    Level at which content is filtered.
    source str
    Content source to apply the Content Filters.
    blocking Boolean
    If blocking would occur.
    enabled Boolean
    If the ContentFilter is enabled.
    name String
    Name of ContentFilter.
    severityThreshold String
    Level at which content is filtered.
    source String
    Content source to apply the Content Filters.

    RaiPolicyPropertiesResponse

    Type string
    Content Filters policy type.
    BasePolicyName string
    Name of Rai policy.
    ContentFilters List<Pulumi.AzureNative.CognitiveServices.Inputs.RaiPolicyContentFilterResponse>
    The list of Content Filters.
    CustomBlocklists List<Pulumi.AzureNative.CognitiveServices.Inputs.CustomBlocklistConfigResponse>
    The list of custom Blocklist.
    Mode string
    Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.
    Type string
    Content Filters policy type.
    BasePolicyName string
    Name of Rai policy.
    ContentFilters []RaiPolicyContentFilterResponse
    The list of Content Filters.
    CustomBlocklists []CustomBlocklistConfigResponse
    The list of custom Blocklist.
    Mode string
    Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.
    type String
    Content Filters policy type.
    basePolicyName String
    Name of Rai policy.
    contentFilters List<RaiPolicyContentFilterResponse>
    The list of Content Filters.
    customBlocklists List<CustomBlocklistConfigResponse>
    The list of custom Blocklist.
    mode String
    Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.
    type string
    Content Filters policy type.
    basePolicyName string
    Name of Rai policy.
    contentFilters RaiPolicyContentFilterResponse[]
    The list of Content Filters.
    customBlocklists CustomBlocklistConfigResponse[]
    The list of custom Blocklist.
    mode string
    Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.
    type str
    Content Filters policy type.
    base_policy_name str
    Name of Rai policy.
    content_filters Sequence[RaiPolicyContentFilterResponse]
    The list of Content Filters.
    custom_blocklists Sequence[CustomBlocklistConfigResponse]
    The list of custom Blocklist.
    mode str
    Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.
    type String
    Content Filters policy type.
    basePolicyName String
    Name of Rai policy.
    contentFilters List<Property Map>
    The list of Content Filters.
    customBlocklists List<Property Map>
    The list of custom Blocklist.
    mode String
    Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2024-10-01. It is the same as 'Deferred' in previous version.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi