CommitmentPlansOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
CognitiveServicesManagementClient's
<xref:commitment_plans> attribute.
- Inheritance
-
builtins.objectCommitmentPlansOperations
Constructor
CommitmentPlansOperations(*args, **kwargs)
Methods
begin_create_or_update_association |
Create or update the association of the Cognitive Services commitment plan. |
begin_create_or_update_plan |
Create Cognitive Services commitment plan. |
begin_delete |
Deletes the specified commitmentPlan associated with the Cognitive Services account. |
begin_delete_association |
Deletes the association of the Cognitive Services commitment plan. |
begin_delete_plan |
Deletes a Cognitive Services commitment plan from the resource group. |
begin_update_plan |
Create Cognitive Services commitment plan. |
create_or_update |
Update the state of specified commitmentPlans associated with the Cognitive Services account. |
get |
Gets the specified commitmentPlans associated with the Cognitive Services account. |
get_association |
Gets the association of the Cognitive Services commitment plan. |
get_plan |
Returns a Cognitive Services commitment plan specified by the parameters. |
list |
Gets the commitmentPlans associated with the Cognitive Services account. |
list_associations |
Gets the associations of the Cognitive Services commitment plan. |
list_plans_by_resource_group |
Returns all the resources of a particular type belonging to a resource group. |
list_plans_by_subscription |
Returns all the resources of a particular type belonging to a subscription. |
begin_create_or_update_association
Create or update the association of the Cognitive Services commitment plan.
begin_create_or_update_association(resource_group_name: str, commitment_plan_name: str, commitment_plan_association_name: str, association: _models.CommitmentPlanAccountAssociation, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CommitmentPlanAccountAssociation]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
commitment_plan_association_name
Required
|
The name of the commitment plan association with the Cognitive Services Account. Required. |
association
Required
|
The commitmentPlan properties. Is either a CommitmentPlanAccountAssociation type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either CommitmentPlanAccountAssociation or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_create_or_update_plan
Create Cognitive Services commitment plan.
begin_create_or_update_plan(resource_group_name: str, commitment_plan_name: str, commitment_plan: _models.CommitmentPlan, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CommitmentPlan]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
commitment_plan
Required
|
CommitmentPlan or
IO
The parameters to provide for the created commitment plan. Is either a CommitmentPlan type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete
Deletes the specified commitmentPlan associated with the Cognitive Services account.
begin_delete(resource_group_name: str, account_name: str, commitment_plan_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
account_name
Required
|
The name of Cognitive Services account. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete_association
Deletes the association of the Cognitive Services commitment plan.
begin_delete_association(resource_group_name: str, commitment_plan_name: str, commitment_plan_association_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
commitment_plan_association_name
Required
|
The name of the commitment plan association with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_delete_plan
Deletes a Cognitive Services commitment plan from the resource group.
begin_delete_plan(resource_group_name: str, commitment_plan_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
Type | Description |
---|---|
begin_update_plan
Create Cognitive Services commitment plan.
begin_update_plan(resource_group_name: str, commitment_plan_name: str, commitment_plan: _models.PatchResourceTagsAndSku, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CommitmentPlan]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
commitment_plan
Required
|
The parameters to provide for the created commitment plan. Is either a PatchResourceTagsAndSku type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
continuation_token
|
A continuation token to restart a poller from a saved state. |
polling
|
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy. |
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
Type | Description |
---|---|
An instance of LROPoller that returns either CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
create_or_update
Update the state of specified commitmentPlans associated with the Cognitive Services account.
create_or_update(resource_group_name: str, account_name: str, commitment_plan_name: str, commitment_plan: _models.CommitmentPlan, *, content_type: str = 'application/json', **kwargs: Any) -> _models.CommitmentPlan
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
account_name
Required
|
The name of Cognitive Services account. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
commitment_plan
Required
|
CommitmentPlan or
IO
The commitmentPlan properties. Is either a CommitmentPlan type or a IO type. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get
Gets the specified commitmentPlans associated with the Cognitive Services account.
get(resource_group_name: str, account_name: str, commitment_plan_name: str, **kwargs: Any) -> CommitmentPlan
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
account_name
Required
|
The name of Cognitive Services account. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_association
Gets the association of the Cognitive Services commitment plan.
get_association(resource_group_name: str, commitment_plan_name: str, commitment_plan_association_name: str, **kwargs: Any) -> CommitmentPlanAccountAssociation
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
commitment_plan_association_name
Required
|
The name of the commitment plan association with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
CommitmentPlanAccountAssociation or the result of cls(response) |
Exceptions
Type | Description |
---|---|
get_plan
Returns a Cognitive Services commitment plan specified by the parameters.
get_plan(resource_group_name: str, commitment_plan_name: str, **kwargs: Any) -> CommitmentPlan
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list
Gets the commitmentPlans associated with the Cognitive Services account.
list(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[CommitmentPlan]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
account_name
Required
|
The name of Cognitive Services account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_associations
Gets the associations of the Cognitive Services commitment plan.
list_associations(resource_group_name: str, commitment_plan_name: str, **kwargs: Any) -> Iterable[CommitmentPlanAccountAssociation]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
commitment_plan_name
Required
|
The name of the commitmentPlan associated with the Cognitive Services Account. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either CommitmentPlanAccountAssociation or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_plans_by_resource_group
Returns all the resources of a particular type belonging to a resource group.
list_plans_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[CommitmentPlan]
Parameters
Name | Description |
---|---|
resource_group_name
Required
|
The name of the resource group. The name is case insensitive. Required. |
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
list_plans_by_subscription
Returns all the resources of a particular type belonging to a subscription.
list_plans_by_subscription(**kwargs: Any) -> Iterable[CommitmentPlan]
Keyword-Only Parameters
Name | Description |
---|---|
cls
|
A custom type or function that will be passed the direct response |
Returns
Type | Description |
---|---|
An iterator like instance of either CommitmentPlan or the result of cls(response) |
Exceptions
Type | Description |
---|---|
Attributes
models
models = <module 'azure.mgmt.cognitiveservices.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cognitiveservices\\models\\__init__.py'>
Azure SDK for Python