1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getRaiBlocklist
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.cognitiveservices.getRaiBlocklist

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Gets the specified custom blocklist 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 getRaiBlocklist

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 getRaiBlocklist(args: GetRaiBlocklistArgs, opts?: InvokeOptions): Promise<GetRaiBlocklistResult>
function getRaiBlocklistOutput(args: GetRaiBlocklistOutputArgs, opts?: InvokeOptions): Output<GetRaiBlocklistResult>
Copy
def get_rai_blocklist(account_name: Optional[str] = None,
                      rai_blocklist_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetRaiBlocklistResult
def get_rai_blocklist_output(account_name: Optional[pulumi.Input[str]] = None,
                      rai_blocklist_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetRaiBlocklistResult]
Copy
func LookupRaiBlocklist(ctx *Context, args *LookupRaiBlocklistArgs, opts ...InvokeOption) (*LookupRaiBlocklistResult, error)
func LookupRaiBlocklistOutput(ctx *Context, args *LookupRaiBlocklistOutputArgs, opts ...InvokeOption) LookupRaiBlocklistResultOutput
Copy

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

public static class GetRaiBlocklist 
{
    public static Task<GetRaiBlocklistResult> InvokeAsync(GetRaiBlocklistArgs args, InvokeOptions? opts = null)
    public static Output<GetRaiBlocklistResult> Invoke(GetRaiBlocklistInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRaiBlocklistResult> getRaiBlocklist(GetRaiBlocklistArgs args, InvokeOptions options)
public static Output<GetRaiBlocklistResult> getRaiBlocklist(GetRaiBlocklistArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cognitiveservices:getRaiBlocklist
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account.
RaiBlocklistName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RaiBlocklist associated with the Cognitive Services Account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account.
RaiBlocklistName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RaiBlocklist associated with the Cognitive Services Account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of Cognitive Services account.
raiBlocklistName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RaiBlocklist associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account.
raiBlocklistName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RaiBlocklist associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Cognitive Services account.
rai_blocklist_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the RaiBlocklist associated with the Cognitive Services Account
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of Cognitive Services account.
raiBlocklistName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RaiBlocklist associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getRaiBlocklist 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.RaiBlocklistPropertiesResponse
Properties of Cognitive Services RaiBlocklist.
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 RaiBlocklistPropertiesResponse
Properties of Cognitive Services RaiBlocklist.
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 RaiBlocklistPropertiesResponse
Properties of Cognitive Services RaiBlocklist.
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 RaiBlocklistPropertiesResponse
Properties of Cognitive Services RaiBlocklist.
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 RaiBlocklistPropertiesResponse
Properties of Cognitive Services RaiBlocklist.
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 RaiBlocklist.
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

RaiBlocklistPropertiesResponse

Description string
Description of the block list.
Description string
Description of the block list.
description String
Description of the block list.
description string
Description of the block list.
description str
Description of the block list.
description String
Description of the block list.

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
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi