azure-native.cognitiveservices.getRaiPolicy
Explore with Pulumi AI
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:
- Account
Name string - The name of Cognitive Services account.
- Rai
Policy stringName - The name of the RaiPolicy associated with the Cognitive Services Account
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - The name of Cognitive Services account.
- Rai
Policy stringName - The name of the RaiPolicy associated with the Cognitive Services Account
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- rai
Policy StringName - The name of the RaiPolicy associated with the Cognitive Services Account
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - The name of Cognitive Services account.
- rai
Policy stringName - The name of the RaiPolicy associated with the Cognitive Services Account
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- account_
name str - The name of Cognitive Services account.
- rai_
policy_ strname - The name of the RaiPolicy associated with the Cognitive Services Account
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- rai
Policy StringName - The name of the RaiPolicy associated with the Cognitive Services Account
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getRaiPolicy Result
The following output properties are available:
- Azure
Api stringVersion - 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.
Azure Native. Cognitive Services. Outputs. Rai Policy Properties Response - Properties of Cognitive Services RaiPolicy.
- 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"
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - 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
Rai
Policy Properties Response - Properties of Cognitive Services RaiPolicy.
- 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"
- map[string]string
- Resource tags.
- azure
Api StringVersion - 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
Rai
Policy Properties Response - Properties of Cognitive Services RaiPolicy.
- 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"
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - 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
Rai
Policy Properties Response - Properties of Cognitive Services RaiPolicy.
- 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"
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - 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
Rai
Policy Properties Response - Properties of Cognitive Services RaiPolicy.
- 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"
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - 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.
- 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"
- Map<String>
- Resource tags.
Supporting Types
CustomBlocklistConfigResponse
- Blocking bool
- If blocking would occur.
- Blocklist
Name string - Name of ContentFilter.
- Source string
- Content source to apply the Content Filters.
- Blocking bool
- If blocking would occur.
- Blocklist
Name string - Name of ContentFilter.
- Source string
- Content source to apply the Content Filters.
- blocking Boolean
- If blocking would occur.
- blocklist
Name String - Name of ContentFilter.
- source String
- Content source to apply the Content Filters.
- blocking boolean
- If blocking would occur.
- blocklist
Name 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.
- blocklist
Name 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.
- Severity
Threshold 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.
- Severity
Threshold 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.
- severity
Threshold 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.
- severity
Threshold 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.
- severity
Threshold String - Level at which content is filtered.
- source String
- Content source to apply the Content Filters.
RaiPolicyPropertiesResponse
- Type string
- Content Filters policy type.
- Base
Policy stringName - Name of Rai policy.
- Content
Filters List<Pulumi.Azure Native. Cognitive Services. Inputs. Rai Policy Content Filter Response> - The list of Content Filters.
- Custom
Blocklists List<Pulumi.Azure Native. Cognitive Services. Inputs. Custom Blocklist Config Response> - 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.
- Base
Policy stringName - Name of Rai policy.
- Content
Filters []RaiPolicy Content Filter Response - The list of Content Filters.
- Custom
Blocklists []CustomBlocklist Config Response - 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.
- base
Policy StringName - Name of Rai policy.
- content
Filters List<RaiPolicy Content Filter Response> - The list of Content Filters.
- custom
Blocklists List<CustomBlocklist Config Response> - 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.
- base
Policy stringName - Name of Rai policy.
- content
Filters RaiPolicy Content Filter Response[] - The list of Content Filters.
- custom
Blocklists CustomBlocklist Config Response[] - 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_ strname - Name of Rai policy.
- content_
filters Sequence[RaiPolicy Content Filter Response] - The list of Content Filters.
- custom_
blocklists Sequence[CustomBlocklist Config Response] - 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.
- base
Policy StringName - Name of Rai policy.
- content
Filters List<Property Map> - The list of Content Filters.
- custom
Blocklists 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
- 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.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0