accounts

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

Overview

Name	accounts
Type	Resource
Id	azure.cognitive_services.accounts

Fields

vw_accounts

Name	Datatype	Description
abuse_penalty	text	field from the properties object
accountName	text	field from the properties object
allowed_fqdn_list	text	field from the properties object
aml_workspace	text	field from the properties object
api_properties	text	field from the properties object
call_rate_limit	text	field from the properties object
capabilities	text	field from the properties object
commitment_plan_associations	text	field from the properties object
custom_sub_domain_name	text	field from the properties object
date_created	text	field from the properties object
deletion_date	text	field from the properties object
disable_local_auth	text	field from the properties object
dynamic_throttling_enabled	text	field from the properties object
encryption	text	field from the properties object
endpoint	text	field from the properties object
endpoints	text	field from the properties object
etag	text	Resource Etag.
identity	text	Identity for the resource.
internal_id	text	field from the properties object
is_migrated	text	field from the properties object
kind	text	The kind (type) of cognitive service account.
location	text	The geo-location where the resource lives
locations	text	field from the properties object
migration_token	text	field from the properties object
network_acls	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
quota_limit	text	field from the properties object
rai_monitor_config	text	field from the properties object
resourceGroupName	text	field from the properties object
restore	text	field from the properties object
restrict_outbound_network_access	text	field from the properties object
scheduled_purge_date	text	field from the properties object
sku	text	The resource model definition representing SKU
sku_change_info	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.
user_owned_storage	text	field from the properties object

accounts

Name	Datatype	Description
etag	string	Resource Etag.
identity	object	Identity for the resource.
kind	string	The kind (type) of cognitive service account.
location	string	The geo-location where the resource lives
properties	object	Properties of Cognitive Services account.
sku	object	The resource model definition representing SKU
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, resourceGroupName, subscriptionId	Returns a Cognitive Services account specified by the parameters.
list	SELECT	subscriptionId	Returns all the resources of a particular type belonging to a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Returns all the resources of a particular type belonging to a resource group
create	INSERT	accountName, resourceGroupName, subscriptionId	Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.
delete	DELETE	accountName, resourceGroupName, subscriptionId	Deletes a Cognitive Services account from the resource group.
update	UPDATE	accountName, resourceGroupName, subscriptionId	Updates a Cognitive Services account
regenerate_key	EXEC	accountName, resourceGroupName, subscriptionId, data__keyName	Regenerates the specified account key for the specified Cognitive Services account.

SELECT examples

Returns all the resources of a particular type belonging to a subscription.

vw_accounts

SELECT
abuse_penalty,
accountName,
allowed_fqdn_list,
aml_workspace,
api_properties,
call_rate_limit,
capabilities,
commitment_plan_associations,
custom_sub_domain_name,
date_created,
deletion_date,
disable_local_auth,
dynamic_throttling_enabled,
encryption,
endpoint,
endpoints,
etag,
identity,
internal_id,
is_migrated,
kind,
location,
locations,
migration_token,
network_acls,
private_endpoint_connections,
provisioning_state,
public_network_access,
quota_limit,
rai_monitor_config,
resourceGroupName,
restore,
restrict_outbound_network_access,
scheduled_purge_date,
sku,
sku_change_info,
subscriptionId,
system_data,
tags,
user_owned_storage
FROM azure.cognitive_services.vw_accounts
WHERE subscriptionId = '{{ subscriptionId }}';

accounts

SELECT
etag,
identity,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.cognitive_services.accounts
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.cognitive_services.accounts (
accountName,
resourceGroupName,
subscriptionId,
kind,
sku,
identity,
tags,
location,
properties
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ kind }}',
'{{ sku }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: kind
      value: []
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
    - 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: tags
      value: object
    - name: location
      value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: endpoint
          value: string
        - name: internalId
          value: string
        - name: capabilities
          value:
            - - name: name
                value: string
              - name: value
                value: string
        - name: isMigrated
          value: boolean
        - name: migrationToken
          value: string
        - name: skuChangeInfo
          value:
            - name: countOfDowngrades
              value: number
            - name: countOfUpgradesAfterDowngrades
              value: number
            - name: lastChangeDate
              value: string
        - name: customSubDomainName
          value: string
        - name: networkAcls
          value:
            - name: defaultAction
              value: string
            - name: bypass
              value: string
            - name: ipRules
              value:
                - - name: value
                    value: string
            - name: virtualNetworkRules
              value:
                - - name: id
                    value: string
                  - name: state
                    value: string
                  - name: ignoreMissingVnetServiceEndpoint
                    value: boolean
        - name: encryption
          value:
            - name: keyVaultProperties
              value:
                - name: keyIdentifier
                  value: string
                - name: identity
                  value: string
            - name: keySource
              value: string
        - name: userOwnedStorage
          value:
            - - name: resourceId
                value: string
              - name: identityClientId
                value: string
        - name: amlWorkspace
          value:
            - name: resourceId
              value: string
            - name: identityClientId
              value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
                  - name: groupIds
                    value:
                      - string
              - name: location
                value: string
              - name: etag
                value: string
        - name: publicNetworkAccess
          value: string
        - name: apiProperties
          value:
            - name: qnaRuntimeEndpoint
              value: string
            - name: qnaAzureSearchEndpointKey
              value: string
            - name: qnaAzureSearchEndpointId
              value: string
            - name: statisticsEnabled
              value: boolean
            - name: eventHubConnectionString
              value: string
            - name: storageAccountConnectionString
              value: string
            - name: aadClientId
              value: string
            - name: aadTenantId
              value: string
            - name: superUser
              value: string
            - name: websiteName
              value: string
        - name: dateCreated
          value: string
        - name: callRateLimit
          value:
            - name: count
              value: number
            - name: renewalPeriod
              value: number
            - name: rules
              value:
                - - name: key
                    value: string
                  - name: renewalPeriod
                    value: number
                  - name: count
                    value: number
                  - name: minCount
                    value: number
                  - name: dynamicThrottlingEnabled
                    value: boolean
                  - name: matchPatterns
                    value:
                      - - name: path
                          value: string
                        - name: method
                          value: string
        - name: dynamicThrottlingEnabled
          value: boolean
        - name: quotaLimit
          value:
            - name: count
              value: number
            - name: renewalPeriod
              value: number
            - name: rules
              value:
                - - name: key
                    value: string
                  - name: renewalPeriod
                    value: number
                  - name: count
                    value: number
                  - name: minCount
                    value: number
                  - name: dynamicThrottlingEnabled
                    value: boolean
                  - name: matchPatterns
                    value:
                      - - name: path
                          value: string
                        - name: method
                          value: string
        - name: restrictOutboundNetworkAccess
          value: boolean
        - name: allowedFqdnList
          value:
            - string
        - name: disableLocalAuth
          value: boolean
        - name: endpoints
          value: object
        - name: restore
          value: boolean
        - name: deletionDate
          value: string
        - name: scheduledPurgeDate
          value: string
        - name: locations
          value:
            - name: routingMethod
              value: string
            - name: regions
              value:
                - - name: name
                    value: string
                  - name: value
                    value: number
                  - name: customsubdomain
                    value: string
        - name: commitmentPlanAssociations
          value:
            - - name: commitmentPlanId
                value: string
              - name: commitmentPlanLocation
                value: string
        - name: abusePenalty
          value:
            - name: action
              value: string
            - name: rateLimitPercentage
              value: number
            - name: expiration
              value: string
        - name: raiMonitorConfig
          value:
            - name: adxStorageResourceId
              value: string
            - name: identityClientId
              value: string
    - name: etag
      value: string

UPDATE example

Updates a accounts resource.

/*+ update */
UPDATE azure.cognitive_services.accounts
SET 
kind = '{{ kind }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified accounts resource.

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