Skip to content

Commit

Permalink
doc: rai blocklist documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
feliperezende-barbosa committed Nov 18, 2024
1 parent 8ea214f commit 9b7683b
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions website/docs/r/cognitive_rai_blocklist.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
subcategory: "Cognitive Services"
layout: "azurerm"
page_title: "Azure Resource Manager: azurerm_cognitive_rai_blocklist"
description: |-
Manages a Cognitive Rai Blocklist.
---

# azurerm_cognitive_rai_blocklist

Manages a Cognitive Rai Blocklist.

## Example Usage

```hcl
resource "azurerm_resource_group" "example" {
name = "example-resources"
location = "Brazil South"
}
resource "azurerm_cognitive_account" "example" {
name = "example-ca"
location = azurerm_resource_group.example.location
resource_group_name = azurerm_resource_group.example.name
kind = "OpenAI"
sku_name = "S0"
}
resource "azurerm_cognitive_rai_blocklist" "example" {
name = "example-crb"
cognitive_account_id = azurerm_cognitive_account.example.id
description = "Azure OpenAI Rai Blocklist"
}
```

## Arguments Reference

The following arguments are supported:

* `name` - (Required) The name of the Cognitive Services Rai Blocklist. Changing this forces a new Cognitive Rai Blocklist Example to be created.

* `cognitive_account_id` - (Required) The ID of the Cognitive Services Account. Changing this forces a new Cognitive Rai Blocklist Example to be created.

---

* `description` - (Optional) A short description for the Rai Blocklist.

## Attributes Reference

In addition to the Arguments listed above - the following Attributes are exported:

* `id` - The ID of the Cognitive Rai Blocklist.

## Timeouts

The `timeouts` block allows you to specify [timeouts](https://www.terraform.io/language/resources/syntax#operation-timeouts) for certain actions:

* `create` - (Defaults to 30 minutes) Used when creating the Cognitive Rai Blocklist.
* `read` - (Defaults to 5 minutes) Used when retrieving the Cognitive Rai Blocklist.
* `update` - (Defaults to 30 minutes) Used when updating the Cognitive Rai Blocklist.
* `delete` - (Defaults to 30 minutes) Used when deleting the Cognitive Rai Blocklist.

## Import

Cognitive Rai Blocklist can be imported using the `resource id`, e.g.

```shell
terraform import azurerm_cognitive_rai_blocklist.example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.CognitiveServices/accounts/account1/raiBlocklists/raiblocklist1
```

0 comments on commit 9b7683b

Please sign in to comment.