deployments

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

Overview

Name	deployments
Type	Resource
Id	azure.cognitive_services.deployments

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the deployments properties successfully.

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.

list

Successfully retrieved 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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, accountName, subscriptionId, deploymentName		Gets the specified deployments associated with the Cognitive Services account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the deployments associated with the Cognitive Services account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, deploymentName		Update the state of specified deployments associated with the Cognitive Services account.
update	update	resourceGroupName, accountName, subscriptionId, deploymentName		Update specified deployments associated with the Cognitive Services account.
delete	delete	resourceGroupName, accountName, subscriptionId, deploymentName		Deletes the specified deployment 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.
deploymentName	string	The name of the deployment 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 deployments associated with the Cognitive Services account.

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

list

Gets the deployments associated with the Cognitive Services account.

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

INSERT examples

create_or_update

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

INSERT INTO azure.cognitive_services.deployments (
data__sku,
data__tags,
data__properties,
resourceGroupName,
accountName,
subscriptionId,
deploymentName
)
SELECT 
'{{ sku }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ subscriptionId }}',
'{{ deploymentName }}'
RETURNING
etag,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: deployments
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the deployments resource.
    - name: accountName
      value: string
      description: Required parameter for the deployments resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the deployments resource.
    - name: deploymentName
      value: string
      description: Required parameter for the deployments resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Properties of Cognitive Services account deployment.

UPDATE examples

update

Update specified deployments associated with the Cognitive Services account.

UPDATE azure.cognitive_services.deployments
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND deploymentName = '{{ deploymentName }}' --required
RETURNING
etag,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes the specified deployment associated with the Cognitive Services account.

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