commitment_plans_associations

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

Overview

Name	commitment_plans_associations
Type	Resource
Id	azure.cognitive_services.commitment_plans_associations

Fields

The following fields are returned by SELECT queries:

get

OK -- Get the Commitment Plan Association successfully.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services account commitment plan association.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

Successfully retrieved Commitment Plan Associations.

Name	Datatype	Description
etag	string	Resource Etag.
properties	object	Properties of Cognitive Services account commitment plan association.
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, subscriptionId, commitmentPlanName, commitmentPlanAssociationName		Gets the association of the Cognitive Services commitment plan.
list	select	resourceGroupName, subscriptionId, commitmentPlanName		Gets the associations of the Cognitive Services commitment plan.
create_or_update	insert	resourceGroupName, subscriptionId, commitmentPlanName, commitmentPlanAssociationName		Create or update the association of the Cognitive Services commitment plan.
delete	delete	resourceGroupName, subscriptionId, commitmentPlanName, commitmentPlanAssociationName		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
commitmentPlanAssociationName	string	The name of the commitment plan association with the 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 association of the Cognitive Services commitment plan.

SELECT
etag,
properties,
systemData,
tags
FROM azure.cognitive_services.commitment_plans_associations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND commitmentPlanName = '{{ commitmentPlanName }}' -- required
AND commitmentPlanAssociationName = '{{ commitmentPlanAssociationName }}' -- required
;

list

Gets the associations of the Cognitive Services commitment plan.

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

INSERT examples

create_or_update

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

INSERT INTO azure.cognitive_services.commitment_plans_associations (
data__tags,
data__properties,
resourceGroupName,
subscriptionId,
commitmentPlanName,
commitmentPlanAssociationName
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ commitmentPlanName }}',
'{{ commitmentPlanAssociationName }}'
RETURNING
etag,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: commitment_plans_associations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the commitment_plans_associations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the commitment_plans_associations resource.
    - name: commitmentPlanName
      value: string
      description: Required parameter for the commitment_plans_associations resource.
    - name: commitmentPlanAssociationName
      value: string
      description: Required parameter for the commitment_plans_associations resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Properties of Cognitive Services account commitment plan association.

DELETE examples

delete

Deletes the association of the Cognitive Services commitment plan.

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