RaiBlocklistsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
CognitiveServicesManagementClient's
<xref:rai_blocklists> attribute.
Constructor
RaiBlocklistsOperations(*args, **kwargs)Methods
| begin_delete |
Deletes the specified custom blocklist associated with the Azure OpenAI account. |
| create_or_update |
Update the state of specified blocklist associated with the Azure OpenAI account. |
| get |
Gets the specified custom blocklist associated with the Azure OpenAI account. |
| list |
Gets the custom blocklists associated with the Azure OpenAI account. |
begin_delete
Deletes the specified custom blocklist associated with the Azure OpenAI account.
begin_delete(resource_group_name: str, account_name: str, rai_blocklist_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
account_name
Required
|
The name of Cognitive Services account. Required. |
|
rai_blocklist_name
Required
|
The name of the RaiBlocklist associated with the Cognitive Services Account. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
create_or_update
Update the state of specified blocklist associated with the Azure OpenAI account.
create_or_update(resource_group_name: str, account_name: str, rai_blocklist_name: str, rai_blocklist: _models.RaiBlocklist, *, content_type: str = 'application/json', **kwargs: Any) -> _models.RaiBlocklistParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
account_name
Required
|
The name of Cognitive Services account. Required. |
|
rai_blocklist_name
Required
|
The name of the RaiBlocklist associated with the Cognitive Services Account. Required. |
|
rai_blocklist
Required
|
Properties describing the custom blocklist. Is either a RaiBlocklist type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
RaiBlocklist or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets the specified custom blocklist associated with the Azure OpenAI account.
get(resource_group_name: str, account_name: str, rai_blocklist_name: str, **kwargs: Any) -> RaiBlocklistParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
account_name
Required
|
The name of Cognitive Services account. Required. |
|
rai_blocklist_name
Required
|
The name of the RaiBlocklist associated with the Cognitive Services Account. Required. |
Returns
| Type | Description |
|---|---|
|
RaiBlocklist or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
Gets the custom blocklists associated with the Azure OpenAI account.
list(resource_group_name: str, account_name: str, **kwargs: Any) -> ItemPaged[RaiBlocklist]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
|
account_name
Required
|
The name of Cognitive Services account. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either RaiBlocklist or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.cognitiveservices.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv86\\Lib\\site-packages\\azure\\mgmt\\cognitiveservices\\models\\__init__.py'>