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

Name	Datatype	Description
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.
etag	string	Resource Etag.
keySource	string	Enumerates the possible value of keySource for Encryption. Known values are: "Microsoft.CognitiveServices" and "Microsoft.KeyVault". (Microsoft.CognitiveServices, Microsoft.KeyVault)
keyVaultProperties	object	Properties of KeyVault.
provisioningState	string	Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", and "Canceled". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled)
state	string	The encryptionScope state. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
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.
etag	string	Resource Etag.
keySource	string	Enumerates the possible value of keySource for Encryption. Known values are: "Microsoft.CognitiveServices" and "Microsoft.KeyVault". (Microsoft.CognitiveServices, Microsoft.KeyVault)
keyVaultProperties	object	Properties of KeyVault.
provisioningState	string	Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", and "Canceled". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled)
state	string	The encryptionScope state. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, encryption_scope_name, subscription_id		Gets the specified EncryptionScope associated with the Cognitive Services account.
list	select	resource_group_name, account_name, subscription_id		Gets the content filters associated with the Azure OpenAI account.
create_or_update	insert	resource_group_name, account_name, encryption_scope_name, subscription_id		Update the state of specified encryptionScope associated with the Cognitive Services account.
create_or_update	replace	resource_group_name, account_name, encryption_scope_name, subscription_id		Update the state of specified encryptionScope associated with the Cognitive Services account.
delete	delete	resource_group_name, account_name, encryption_scope_name, subscription_id		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
account_name	string	The name of Cognitive Services account. Required.
encryption_scope_name	string	The name of the encryptionScope associated with the Cognitive Services Account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified EncryptionScope associated with the Cognitive Services account.

SELECT
id,
name,
etag,
keySource,
keyVaultProperties,
provisioningState,
state,
systemData,
tags,
type
FROM azure.cognitive_services.encryption_scopes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND encryption_scope_name = '{{ encryption_scope_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the content filters associated with the Azure OpenAI account.

SELECT
id,
name,
etag,
keySource,
keyVaultProperties,
provisioningState,
state,
systemData,
tags,
type
FROM azure.cognitive_services.encryption_scopes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
properties,
tags,
resource_group_name,
account_name,
encryption_scope_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ encryption_scope_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: encryption_scopes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the encryption_scopes resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the encryption_scopes resource.
  - name: encryption_scope_name
    value: "{{ encryption_scope_name }}"
    description: Required parameter for the encryption_scopes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the encryption_scopes resource.
  - name: properties
    description: |
      Properties of Cognitive Services EncryptionScope.
    value:
      keyVaultProperties:
        keyName: "{{ keyName }}"
        keyVersion: "{{ keyVersion }}"
        keyVaultUri: "{{ keyVaultUri }}"
        identityClientId: "{{ identityClientId }}"
      keySource: "{{ keySource }}"
      provisioningState: "{{ provisioningState }}"
      state: "{{ state }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.

REPLACE examples

create_or_update

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

REPLACE azure.cognitive_services.encryption_scopes
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND encryption_scope_name = '{{ encryption_scope_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified encryptionScope associated with the Cognitive Services account.

DELETE FROM azure.cognitive_services.encryption_scopes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND encryption_scope_name = '{{ encryption_scope_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;