EncryptionScopes interface

Interface representing a EncryptionScopes.

Methods

beginDelete(string, string, string, EncryptionScopesDeleteOptionalParams)

Deletes the specified encryptionScope associated with the Cognitive Services account.

beginDeleteAndWait(string, string, string, EncryptionScopesDeleteOptionalParams)

Deletes the specified encryptionScope associated with the Cognitive Services account.

createOrUpdate(string, string, string, EncryptionScope, EncryptionScopesCreateOrUpdateOptionalParams)

Update the state of specified encryptionScope associated with the Cognitive Services account.

get(string, string, string, EncryptionScopesGetOptionalParams)

Gets the specified EncryptionScope associated with the Cognitive Services account.

list(string, string, EncryptionScopesListOptionalParams)

Gets the content filters associated with the Azure OpenAI account.

Method Details

beginDelete(string, string, string, EncryptionScopesDeleteOptionalParams)

Deletes the specified encryptionScope associated with the Cognitive Services account.

function beginDelete(resourceGroupName: string, accountName: string, encryptionScopeName: string, options?: EncryptionScopesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<EncryptionScopesDeleteHeaders>, EncryptionScopesDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of Cognitive Services account.

encryptionScopeName

string

The name of the encryptionScope associated with the Cognitive Services Account

options
EncryptionScopesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<EncryptionScopesDeleteHeaders>, EncryptionScopesDeleteHeaders>>

beginDeleteAndWait(string, string, string, EncryptionScopesDeleteOptionalParams)

Deletes the specified encryptionScope associated with the Cognitive Services account.

function beginDeleteAndWait(resourceGroupName: string, accountName: string, encryptionScopeName: string, options?: EncryptionScopesDeleteOptionalParams): Promise<EncryptionScopesDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of Cognitive Services account.

encryptionScopeName

string

The name of the encryptionScope associated with the Cognitive Services Account

options
EncryptionScopesDeleteOptionalParams

The options parameters.

Returns

createOrUpdate(string, string, string, EncryptionScope, EncryptionScopesCreateOrUpdateOptionalParams)

Update the state of specified encryptionScope associated with the Cognitive Services account.

function createOrUpdate(resourceGroupName: string, accountName: string, encryptionScopeName: string, encryptionScope: EncryptionScope, options?: EncryptionScopesCreateOrUpdateOptionalParams): Promise<EncryptionScope>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of Cognitive Services account.

encryptionScopeName

string

The name of the encryptionScope associated with the Cognitive Services Account

encryptionScope
EncryptionScope

The encryptionScope properties.

options
EncryptionScopesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<EncryptionScope>

get(string, string, string, EncryptionScopesGetOptionalParams)

Gets the specified EncryptionScope associated with the Cognitive Services account.

function get(resourceGroupName: string, accountName: string, encryptionScopeName: string, options?: EncryptionScopesGetOptionalParams): Promise<EncryptionScope>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of Cognitive Services account.

encryptionScopeName

string

The name of the encryptionScope associated with the Cognitive Services Account

options
EncryptionScopesGetOptionalParams

The options parameters.

Returns

Promise<EncryptionScope>

list(string, string, EncryptionScopesListOptionalParams)

Gets the content filters associated with the Azure OpenAI account.

function list(resourceGroupName: string, accountName: string, options?: EncryptionScopesListOptionalParams): PagedAsyncIterableIterator<EncryptionScope, EncryptionScope[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

accountName

string

The name of Cognitive Services account.

options
EncryptionScopesListOptionalParams

The options parameters.

Returns