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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoRenew	boolean	AutoRenew commitment plan.
commitmentPlanGuid	string	Commitment plan guid.
current	object	Cognitive Services account commitment period.
etag	string	Resource Etag.
hostingModel	string	Account hosting model. Known values are: "Web", "ConnectedContainer", "DisconnectedContainer", and "ProvisionedWeb". (Web, ConnectedContainer, DisconnectedContainer, ProvisionedWeb)
kind	string	The kind (type) of cognitive service account.
last	object	Cognitive Services account commitment period.
location	string	The geo-location where the resource lives.
next	object	Cognitive Services account commitment period.
planType	string	Commitment plan type.
provisioningIssues	array	The list of ProvisioningIssue.
provisioningState	string	Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", and "Canceled". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled)
sku	object	The resource model definition representing SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_association

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountId	string	The Azure resource id of the account.
etag	string	Resource Etag.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoRenew	boolean	AutoRenew commitment plan.
commitmentPlanGuid	string	Commitment plan guid.
current	object	Cognitive Services account commitment period.
etag	string	Resource Etag.
hostingModel	string	Account hosting model. Known values are: "Web", "ConnectedContainer", "DisconnectedContainer", and "ProvisionedWeb". (Web, ConnectedContainer, DisconnectedContainer, ProvisionedWeb)
kind	string	The kind (type) of cognitive service account.
last	object	Cognitive Services account commitment period.
location	string	The geo-location where the resource lives.
next	object	Cognitive Services account commitment period.
planType	string	Commitment plan type.
provisioningIssues	array	The list of ProvisioningIssue.
provisioningState	string	Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", and "Canceled". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled)
sku	object	The resource model definition representing SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_associations

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
accountId	string	The Azure resource id of the account.
etag	string	Resource Etag.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_plans_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoRenew	boolean	AutoRenew commitment plan.
commitmentPlanGuid	string	Commitment plan guid.
current	object	Cognitive Services account commitment period.
etag	string	Resource Etag.
hostingModel	string	Account hosting model. Known values are: "Web", "ConnectedContainer", "DisconnectedContainer", and "ProvisionedWeb". (Web, ConnectedContainer, DisconnectedContainer, ProvisionedWeb)
kind	string	The kind (type) of cognitive service account.
last	object	Cognitive Services account commitment period.
location	string	The geo-location where the resource lives.
next	object	Cognitive Services account commitment period.
planType	string	Commitment plan type.
provisioningIssues	array	The list of ProvisioningIssue.
provisioningState	string	Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", and "Canceled". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled)
sku	object	The resource model definition representing SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_plans_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autoRenew	boolean	AutoRenew commitment plan.
commitmentPlanGuid	string	Commitment plan guid.
current	object	Cognitive Services account commitment period.
etag	string	Resource Etag.
hostingModel	string	Account hosting model. Known values are: "Web", "ConnectedContainer", "DisconnectedContainer", and "ProvisionedWeb". (Web, ConnectedContainer, DisconnectedContainer, ProvisionedWeb)
kind	string	The kind (type) of cognitive service account.
last	object	Cognitive Services account commitment period.
location	string	The geo-location where the resource lives.
next	object	Cognitive Services account commitment period.
planType	string	Commitment plan type.
provisioningIssues	array	The list of ProvisioningIssue.
provisioningState	string	Gets the status of the resource at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", and "Canceled". (Accepted, Creating, Deleting, Moving, Failed, Succeeded, Canceled)
sku	object	The resource model definition representing SKU.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, commitment_plan_name, subscription_id		Gets the specified commitmentPlans associated with the Cognitive Services account.
get_association	select	resource_group_name, commitment_plan_name, commitment_plan_association_name, subscription_id		Gets the association of the Cognitive Services commitment plan.
list	select	resource_group_name, account_name, subscription_id		Gets the commitmentPlans associated with the Cognitive Services account.
list_associations	select	resource_group_name, commitment_plan_name, subscription_id		Gets the associations of the Cognitive Services commitment plan.
list_plans_by_resource_group	select	resource_group_name, subscription_id		Returns all the resources of a particular type belonging to a resource group.
list_plans_by_subscription	select	subscription_id		Returns all the resources of a particular type belonging to a subscription.
create_or_update	insert	resource_group_name, account_name, commitment_plan_name, subscription_id		Update the state of specified commitmentPlans associated with the Cognitive Services account.
create_or_update	replace	resource_group_name, account_name, commitment_plan_name, subscription_id		Update the state of specified commitmentPlans associated with the Cognitive Services account.
delete	delete	resource_group_name, account_name, commitment_plan_name, subscription_id		Deletes the specified commitmentPlan associated with the Cognitive Services account.
get_plan	exec	resource_group_name, commitment_plan_name, subscription_id		Returns a Cognitive Services commitment plan specified by the parameters.
create_or_update_plan	exec	resource_group_name, commitment_plan_name, subscription_id		Create Cognitive Services commitment plan.
update_plan	exec	resource_group_name, commitment_plan_name, subscription_id		Create Cognitive Services commitment plan.
delete_plan	exec	resource_group_name, commitment_plan_name, subscription_id		Deletes a Cognitive Services commitment plan from the resource group.
create_or_update_association	exec	resource_group_name, commitment_plan_name, commitment_plan_association_name, subscription_id		Create or update the association of the Cognitive Services commitment plan.
delete_association	exec	resource_group_name, commitment_plan_name, commitment_plan_association_name, subscription_id		Deletes the association of the Cognitive Services commitment plan.

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
account_name	string	The name of Cognitive Services account. Required.
commitment_plan_association_name	string	The name of the commitment plan association with the Cognitive Services Account. Required.
commitment_plan_name	string	The name of the commitmentPlan associated with the Cognitive Services Account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified commitmentPlans associated with the Cognitive Services account.

SELECT
id,
name,
autoRenew,
commitmentPlanGuid,
current,
etag,
hostingModel,
kind,
last,
location,
next,
planType,
provisioningIssues,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.cognitive_services.commitment_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND commitment_plan_name = '{{ commitment_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_association

Gets the association of the Cognitive Services commitment plan.

SELECT
id,
name,
accountId,
etag,
systemData,
tags,
type
FROM azure.cognitive_services.commitment_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND commitment_plan_name = '{{ commitment_plan_name }}' -- required
AND commitment_plan_association_name = '{{ commitment_plan_association_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets the commitmentPlans associated with the Cognitive Services account.

SELECT
id,
name,
autoRenew,
commitmentPlanGuid,
current,
etag,
hostingModel,
kind,
last,
location,
next,
planType,
provisioningIssues,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.cognitive_services.commitment_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_associations

Gets the associations of the Cognitive Services commitment plan.

SELECT
id,
name,
accountId,
etag,
systemData,
tags,
type
FROM azure.cognitive_services.commitment_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND commitment_plan_name = '{{ commitment_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_plans_by_resource_group

Returns all the resources of a particular type belonging to a resource group.

SELECT
id,
name,
autoRenew,
commitmentPlanGuid,
current,
etag,
hostingModel,
kind,
last,
location,
next,
planType,
provisioningIssues,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.cognitive_services.commitment_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_plans_by_subscription

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

SELECT
id,
name,
autoRenew,
commitmentPlanGuid,
current,
etag,
hostingModel,
kind,
last,
location,
next,
planType,
provisioningIssues,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.cognitive_services.commitment_plans
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
properties,
tags,
location,
kind,
sku,
resource_group_name,
account_name,
commitment_plan_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ kind }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ commitment_plan_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: commitment_plans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the commitment_plans resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the commitment_plans resource.
  - name: commitment_plan_name
    value: "{{ commitment_plan_name }}"
    description: Required parameter for the commitment_plans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the commitment_plans resource.
  - name: properties
    description: |
      Properties of Cognitive Services account commitment plan.
    value:
      provisioningState: "{{ provisioningState }}"
      commitmentPlanGuid: "{{ commitmentPlanGuid }}"
      hostingModel: "{{ hostingModel }}"
      planType: "{{ planType }}"
      current:
        tier: "{{ tier }}"
        count: {{ count }}
        quota:
          quantity: {{ quantity }}
          unit: "{{ unit }}"
        startDate: "{{ startDate }}"
        endDate: "{{ endDate }}"
      autoRenew: {{ autoRenew }}
      next:
        tier: "{{ tier }}"
        count: {{ count }}
        quota:
          quantity: {{ quantity }}
          unit: "{{ unit }}"
        startDate: "{{ startDate }}"
        endDate: "{{ endDate }}"
      last:
        tier: "{{ tier }}"
        count: {{ count }}
        quota:
          quantity: {{ quantity }}
          unit: "{{ unit }}"
        startDate: "{{ startDate }}"
        endDate: "{{ endDate }}"
      provisioningIssues:
        - "{{ provisioningIssues }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind (type) of cognitive service account.
  - name: sku
    description: |
      The resource model definition representing SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}

REPLACE examples

create_or_update

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

REPLACE azure.cognitive_services.commitment_plans
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}',
kind = '{{ kind }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND commitment_plan_name = '{{ commitment_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified commitmentPlan associated with the Cognitive Services account.

DELETE FROM azure.cognitive_services.commitment_plans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND commitment_plan_name = '{{ commitment_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_plan

Returns a Cognitive Services commitment plan specified by the parameters.

EXEC azure.cognitive_services.commitment_plans.get_plan 
@resource_group_name='{{ resource_group_name }}' --required, 
@commitment_plan_name='{{ commitment_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_plan

Create Cognitive Services commitment plan.

EXEC azure.cognitive_services.commitment_plans.create_or_update_plan 
@resource_group_name='{{ resource_group_name }}' --required, 
@commitment_plan_name='{{ commitment_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}", 
"location": "{{ location }}", 
"kind": "{{ kind }}", 
"sku": "{{ sku }}"
}'
;

update_plan

Create Cognitive Services commitment plan.

EXEC azure.cognitive_services.commitment_plans.update_plan 
@resource_group_name='{{ resource_group_name }}' --required, 
@commitment_plan_name='{{ commitment_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"tags": "{{ tags }}", 
"sku": "{{ sku }}"
}'
;

delete_plan

Deletes a Cognitive Services commitment plan from the resource group.

EXEC azure.cognitive_services.commitment_plans.delete_plan 
@resource_group_name='{{ resource_group_name }}' --required, 
@commitment_plan_name='{{ commitment_plan_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_association

Create or update the association of the Cognitive Services commitment plan.

EXEC azure.cognitive_services.commitment_plans.create_or_update_association 
@resource_group_name='{{ resource_group_name }}' --required, 
@commitment_plan_name='{{ commitment_plan_name }}' --required, 
@commitment_plan_association_name='{{ commitment_plan_association_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}", 
"tags": "{{ tags }}"
}'
;

delete_association

Deletes the association of the Cognitive Services commitment plan.

EXEC azure.cognitive_services.commitment_plans.delete_association 
@resource_group_name='{{ resource_group_name }}' --required, 
@commitment_plan_name='{{ commitment_plan_name }}' --required, 
@commitment_plan_association_name='{{ commitment_plan_association_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;