commitment_plans_plans

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

Overview

Name	commitment_plans_plans
Type	Resource
Id	azure.cognitive_services.commitment_plans_plans

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved commitment plan resources.

Name	Datatype	Description
etag	string	Resource Etag.
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 commitment plan.
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, commitmentPlanName, subscriptionId		Returns a Cognitive Services commitment plan specified by the parameters.
create_or_update	insert	resourceGroupName, commitmentPlanName, subscriptionId		Create Cognitive Services commitment plan.
update	update	resourceGroupName, commitmentPlanName, subscriptionId		Create Cognitive Services commitment plan.
delete	delete	resourceGroupName, commitmentPlanName, subscriptionId		Deletes a Cognitive Services commitment plan from the resource group.

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
commitmentPlanName	string	The name of the commitmentPlan 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

Returns a Cognitive Services commitment plan specified by the parameters.

SELECT
etag,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.cognitive_services.commitment_plans_plans
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND commitmentPlanName = '{{ commitmentPlanName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create Cognitive Services commitment plan.

INSERT INTO azure.cognitive_services.commitment_plans_plans (
data__kind,
data__sku,
data__tags,
data__location,
data__properties,
resourceGroupName,
commitmentPlanName,
subscriptionId
)
SELECT 
'{{ kind }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ commitmentPlanName }}',
'{{ subscriptionId }}'
RETURNING
etag,
kind,
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: commitment_plans_plans
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the commitment_plans_plans resource.
    - name: commitmentPlanName
      value: string
      description: Required parameter for the commitment_plans_plans resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the commitment_plans_plans resource.
    - name: kind
      value: string
      description: |
        The kind (type) of cognitive service account.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of Cognitive Services account commitment plan.

UPDATE examples

update

Create Cognitive Services commitment plan.

UPDATE azure.cognitive_services.commitment_plans_plans
SET 
data__sku = '{{ sku }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND commitmentPlanName = '{{ commitmentPlanName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
etag,
kind,
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes a Cognitive Services commitment plan from the resource group.

DELETE FROM azure.cognitive_services.commitment_plans_plans
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND commitmentPlanName = '{{ commitmentPlanName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;