deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.cognitive_services.deployments

Fields

vw_deployments

Name	Datatype	Description
accountName	text	field from the properties object
call_rate_limit	text	field from the properties object
capabilities	text	field from the properties object
capacity_settings	text	field from the properties object
current_capacity	text	field from the properties object
deploymentName	text	field from the properties object
dynamic_throttling_enabled	text	field from the properties object
etag	text	Resource Etag.
model	text	field from the properties object
provisioning_state	text	field from the properties object
rai_policy_name	text	field from the properties object
rate_limits	text	field from the properties object
resourceGroupName	text	field from the properties object
scale_settings	text	field from the properties object
sku	text	The resource model definition representing SKU
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
version_upgrade_option	text	field from the properties object

deployments

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services account deployment.
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, deploymentName, resourceGroupName, subscriptionId	Gets the specified deployments associated with the Cognitive Services account.
list	SELECT	accountName, resourceGroupName, subscriptionId	Gets the deployments associated with the Cognitive Services account.
create_or_update	INSERT	accountName, deploymentName, resourceGroupName, subscriptionId	Update the state of specified deployments associated with the Cognitive Services account.
delete	DELETE	accountName, deploymentName, resourceGroupName, subscriptionId	Deletes the specified deployment associated with the Cognitive Services account.
update	UPDATE	accountName, deploymentName, resourceGroupName, subscriptionId	Update specified deployments associated with the Cognitive Services account.

SELECT examples

Gets the deployments associated with the Cognitive Services account.

vw_deployments

SELECT
accountName,
call_rate_limit,
capabilities,
capacity_settings,
current_capacity,
deploymentName,
dynamic_throttling_enabled,
etag,
model,
provisioning_state,
rai_policy_name,
rate_limits,
resourceGroupName,
scale_settings,
sku,
subscriptionId,
system_data,
tags,
version_upgrade_option
FROM azure.cognitive_services.vw_deployments
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

deployments

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - 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: model
          value:
            - name: format
              value: string
            - name: name
              value: string
            - name: version
              value: string
            - name: source
              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: scaleSettings
          value:
            - name: scaleType
              value: string
            - name: capacity
              value: integer
            - name: activeCapacity
              value: integer
        - name: capabilities
          value: object
        - name: raiPolicyName
          value: string
        - name: rateLimits
          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: versionUpgradeOption
          value: string
        - name: dynamicThrottlingEnabled
          value: boolean
        - name: currentCapacity
          value: integer
        - name: capacitySettings
          value:
            - name: designatedCapacity
              value: integer
            - name: priority
              value: integer

UPDATE example

Updates a deployments resource.

/*+ update */
UPDATE azure.cognitive_services.deployments
SET 
sku = '{{ sku }}',
tags = '{{ tags }}'
WHERE 
accountName = '{{ accountName }}'
AND deploymentName = '{{ deploymentName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified deployments resource.

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