encryption_scopes

Creates, updates, deletes, gets or lists an encryption_scopes resource.

Overview

Name	encryption_scopes
Type	Resource
Id	azure.cognitive_services.encryption_scopes

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the EncryptionScopes properties successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services EncryptionScope.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

Successfully retrieved Content Filters.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services EncryptionScope.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, encryptionScopeName		Gets the specified EncryptionScope associated with the Cognitive Services account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the content filters associated with the Azure OpenAI account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, encryptionScopeName		Update the state of specified encryptionScope associated with the Cognitive Services account.
delete	delete	resourceGroupName, accountName, subscriptionId, encryptionScopeName		Deletes the specified encryptionScope associated with the Cognitive Services account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
accountName	string	The name of Cognitive Services account.
encryptionScopeName	string	The name of the encryptionScope associated with the Cognitive Services Account
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the specified EncryptionScope associated with the Cognitive Services account.

SELECT
etag,
properties,
systemData,
tags
FROM azure.cognitive_services.encryption_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND encryptionScopeName = '{{ encryptionScopeName }}' -- required
;

list

Gets the content filters associated with the Azure OpenAI account.

SELECT
etag,
properties,
systemData,
tags
FROM azure.cognitive_services.encryption_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.cognitive_services.encryption_scopes (
data__tags,
data__properties,
resourceGroupName,
accountName,
subscriptionId,
encryptionScopeName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ encryptionScopeName }}'
RETURNING
etag,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: encryption_scopes
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the encryption_scopes resource.
    - name: accountName
      value: string
      description: Required parameter for the encryption_scopes resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the encryption_scopes resource.
    - name: encryptionScopeName
      value: string
      description: Required parameter for the encryption_scopes resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Properties of Cognitive Services EncryptionScope.

DELETE examples

delete

Deletes the specified encryptionScope associated with the Cognitive Services account.

DELETE FROM azure.cognitive_services.encryption_scopes
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND encryptionScopeName = '{{ encryptionScopeName }}' --required
;