commitment_plans

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

Overview

Name	commitment_plans
Type	Resource
Id	azure.cognitive_services.commitment_plans

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the commitmentPlans properties successfully.

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.

list

Successfully retrieved commitmentPlans.

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, accountName, subscriptionId, commitmentPlanName		Gets the specified commitmentPlans associated with the Cognitive Services account.
list	select	resourceGroupName, accountName, subscriptionId		Gets the commitmentPlans associated with the Cognitive Services account.
create_or_update	insert	resourceGroupName, accountName, subscriptionId, commitmentPlanName		Update the state of specified commitmentPlans associated with the Cognitive Services account.
delete	delete	resourceGroupName, accountName, subscriptionId, commitmentPlanName		Deletes the specified commitmentPlan 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.
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

Gets the specified commitmentPlans associated with the Cognitive Services account.

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

list

Gets the commitmentPlans associated with the Cognitive Services account.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: commitment_plans
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the commitment_plans resource.
    - name: accountName
      value: string
      description: Required parameter for the commitment_plans resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the commitment_plans resource.
    - name: commitmentPlanName
      value: string
      description: Required parameter for the commitment_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.

DELETE examples

delete

Deletes the specified commitmentPlan associated with the Cognitive Services account.

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