encryption_scopes

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

Overview

Name	encryption_scopes
Type	Resource
Id	azure.cognitive_services.encryption_scopes

Fields

vw_encryption_scopes

Name	Datatype	Description
accountName	text	field from the properties object
encryptionScopeName	text	field from the properties object
etag	text	Resource Etag.
key_source	text	field from the properties object
key_vault_properties	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.

encryption_scopes

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

Methods

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

SELECT examples

Gets the content filters associated with the Azure OpenAI account.

vw_encryption_scopes

SELECT
accountName,
encryptionScopeName,
etag,
key_source,
key_vault_properties,
provisioning_state,
resourceGroupName,
state,
subscriptionId,
system_data,
tags
FROM azure.cognitive_services.vw_encryption_scopes
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

encryption_scopes

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

INSERT example

Use the following StackQL query and manifest file to create a new encryption_scopes resource.

All Properties

/*+ create */
INSERT INTO azure.cognitive_services.encryption_scopes (
accountName,
encryptionScopeName,
resourceGroupName,
subscriptionId,
tags,
properties
)
SELECT 
'{{ accountName }}',
'{{ encryptionScopeName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: etag
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: state
          value: string
        - name: keyVaultProperties
          value:
            - name: keyIdentifier
              value: string
            - name: identity
              value: string
        - name: keySource
          value: string

DELETE example

Deletes the specified encryption_scopes resource.

/*+ delete */
DELETE FROM azure.cognitive_services.encryption_scopes
WHERE accountName = '{{ accountName }}'
AND encryptionScopeName = '{{ encryptionScopeName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';