azure-native.cognitiveservices.getCommitmentPlan
Explore with Pulumi AI
Gets the specified commitmentPlans associated with the Cognitive Services account.
Uses Azure REST API version 2024-10-01.
Other available API versions: 2023-05-01, 2023-10-01-preview, 2024-04-01-preview, 2024-06-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cognitiveservices [ApiVersion]
. See the version guide for details.
Using getCommitmentPlan
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCommitmentPlan(args: GetCommitmentPlanArgs, opts?: InvokeOptions): Promise<GetCommitmentPlanResult>
function getCommitmentPlanOutput(args: GetCommitmentPlanOutputArgs, opts?: InvokeOptions): Output<GetCommitmentPlanResult>
def get_commitment_plan(account_name: Optional[str] = None,
commitment_plan_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCommitmentPlanResult
def get_commitment_plan_output(account_name: Optional[pulumi.Input[str]] = None,
commitment_plan_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCommitmentPlanResult]
func LookupCommitmentPlan(ctx *Context, args *LookupCommitmentPlanArgs, opts ...InvokeOption) (*LookupCommitmentPlanResult, error)
func LookupCommitmentPlanOutput(ctx *Context, args *LookupCommitmentPlanOutputArgs, opts ...InvokeOption) LookupCommitmentPlanResultOutput
> Note: This function is named LookupCommitmentPlan
in the Go SDK.
public static class GetCommitmentPlan
{
public static Task<GetCommitmentPlanResult> InvokeAsync(GetCommitmentPlanArgs args, InvokeOptions? opts = null)
public static Output<GetCommitmentPlanResult> Invoke(GetCommitmentPlanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCommitmentPlanResult> getCommitmentPlan(GetCommitmentPlanArgs args, InvokeOptions options)
public static Output<GetCommitmentPlanResult> getCommitmentPlan(GetCommitmentPlanArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cognitiveservices:getCommitmentPlan
arguments:
# arguments dictionary
The following arguments are supported:
- Account
Name string - The name of Cognitive Services account.
- Commitment
Plan stringName - The name of the commitmentPlan associated with the Cognitive Services Account
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - The name of Cognitive Services account.
- Commitment
Plan stringName - The name of the commitmentPlan associated with the Cognitive Services Account
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- commitment
Plan StringName - The name of the commitmentPlan associated with the Cognitive Services Account
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - The name of Cognitive Services account.
- commitment
Plan stringName - The name of the commitmentPlan associated with the Cognitive Services Account
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- account_
name str - The name of Cognitive Services account.
- commitment_
plan_ strname - The name of the commitmentPlan associated with the Cognitive Services Account
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- commitment
Plan StringName - The name of the commitmentPlan associated with the Cognitive Services Account
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getCommitmentPlan Result
The following output properties are available:
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- Resource Etag.
- 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
- Properties
Pulumi.
Azure Native. Cognitive Services. Outputs. Commitment Plan Properties Response - Properties of Cognitive Services account commitment plan.
- System
Data Pulumi.Azure Native. Cognitive Services. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Kind string
- The Kind of the resource.
- Location string
- The geo-location where the resource lives
- Sku
Pulumi.
Azure Native. Cognitive Services. Outputs. Sku Response - The resource model definition representing SKU
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- Resource Etag.
- 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
- Properties
Commitment
Plan Properties Response - Properties of Cognitive Services account commitment plan.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Kind string
- The Kind of the resource.
- Location string
- The geo-location where the resource lives
- Sku
Sku
Response - The resource model definition representing SKU
- map[string]string
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- Resource Etag.
- 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
- properties
Commitment
Plan Properties Response - Properties of Cognitive Services account commitment plan.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- kind String
- The Kind of the resource.
- location String
- The geo-location where the resource lives
- sku
Sku
Response - The resource model definition representing SKU
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - The Azure API version of the resource.
- etag string
- Resource Etag.
- 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
- properties
Commitment
Plan Properties Response - Properties of Cognitive Services account commitment plan.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- kind string
- The Kind of the resource.
- location string
- The geo-location where the resource lives
- sku
Sku
Response - The resource model definition representing SKU
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - The Azure API version of the resource.
- etag str
- Resource Etag.
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name str
- The name of the resource
- properties
Commitment
Plan Properties Response - Properties of Cognitive Services account commitment plan.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- kind str
- The Kind of the resource.
- location str
- The geo-location where the resource lives
- sku
Sku
Response - The resource model definition representing SKU
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- Resource Etag.
- 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
- properties Property Map
- Properties of Cognitive Services account commitment plan.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- kind String
- The Kind of the resource.
- location String
- The geo-location where the resource lives
- sku Property Map
- The resource model definition representing SKU
- Map<String>
- Resource tags.
Supporting Types
CommitmentPeriodResponse
- end_
date str - Commitment period end date.
- quota
Commitment
Quota Response - Cognitive Services account commitment quota.
- start_
date str - Commitment period start date.
- count int
- Commitment period commitment count.
- tier str
- Commitment period commitment tier.
CommitmentPlanPropertiesResponse
- Last
Pulumi.
Azure Native. Cognitive Services. Inputs. Commitment Period Response - Cognitive Services account commitment period.
- Provisioning
Issues List<string> - The list of ProvisioningIssue.
- Provisioning
State string - Gets the status of the resource at the time the operation was called.
- Auto
Renew bool - AutoRenew commitment plan.
- Commitment
Plan stringGuid - Commitment plan guid.
- Current
Pulumi.
Azure Native. Cognitive Services. Inputs. Commitment Period Response - Cognitive Services account commitment period.
- Hosting
Model string - Account hosting model.
- Next
Pulumi.
Azure Native. Cognitive Services. Inputs. Commitment Period Response - Cognitive Services account commitment period.
- Plan
Type string - Commitment plan type.
- Last
Commitment
Period Response - Cognitive Services account commitment period.
- Provisioning
Issues []string - The list of ProvisioningIssue.
- Provisioning
State string - Gets the status of the resource at the time the operation was called.
- Auto
Renew bool - AutoRenew commitment plan.
- Commitment
Plan stringGuid - Commitment plan guid.
- Current
Commitment
Period Response - Cognitive Services account commitment period.
- Hosting
Model string - Account hosting model.
- Next
Commitment
Period Response - Cognitive Services account commitment period.
- Plan
Type string - Commitment plan type.
- last
Commitment
Period Response - Cognitive Services account commitment period.
- provisioning
Issues List<String> - The list of ProvisioningIssue.
- provisioning
State String - Gets the status of the resource at the time the operation was called.
- auto
Renew Boolean - AutoRenew commitment plan.
- commitment
Plan StringGuid - Commitment plan guid.
- current
Commitment
Period Response - Cognitive Services account commitment period.
- hosting
Model String - Account hosting model.
- next
Commitment
Period Response - Cognitive Services account commitment period.
- plan
Type String - Commitment plan type.
- last
Commitment
Period Response - Cognitive Services account commitment period.
- provisioning
Issues string[] - The list of ProvisioningIssue.
- provisioning
State string - Gets the status of the resource at the time the operation was called.
- auto
Renew boolean - AutoRenew commitment plan.
- commitment
Plan stringGuid - Commitment plan guid.
- current
Commitment
Period Response - Cognitive Services account commitment period.
- hosting
Model string - Account hosting model.
- next
Commitment
Period Response - Cognitive Services account commitment period.
- plan
Type string - Commitment plan type.
- last
Commitment
Period Response - Cognitive Services account commitment period.
- provisioning_
issues Sequence[str] - The list of ProvisioningIssue.
- provisioning_
state str - Gets the status of the resource at the time the operation was called.
- auto_
renew bool - AutoRenew commitment plan.
- commitment_
plan_ strguid - Commitment plan guid.
- current
Commitment
Period Response - Cognitive Services account commitment period.
- hosting_
model str - Account hosting model.
- next
Commitment
Period Response - Cognitive Services account commitment period.
- plan_
type str - Commitment plan type.
- last Property Map
- Cognitive Services account commitment period.
- provisioning
Issues List<String> - The list of ProvisioningIssue.
- provisioning
State String - Gets the status of the resource at the time the operation was called.
- auto
Renew Boolean - AutoRenew commitment plan.
- commitment
Plan StringGuid - Commitment plan guid.
- current Property Map
- Cognitive Services account commitment period.
- hosting
Model String - Account hosting model.
- next Property Map
- Cognitive Services account commitment period.
- plan
Type String - Commitment plan type.
CommitmentQuotaResponse
SkuResponse
- Name string
- The name of the SKU. Ex - P3. It is typically a letter+number code
- Capacity int
- If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
- Family string
- If the service has different generations of hardware, for the same SKU, then that can be captured here.
- Size string
- The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
- Tier string
- This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
- Name string
- The name of the SKU. Ex - P3. It is typically a letter+number code
- Capacity int
- If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
- Family string
- If the service has different generations of hardware, for the same SKU, then that can be captured here.
- Size string
- The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
- Tier string
- This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
- name String
- The name of the SKU. Ex - P3. It is typically a letter+number code
- capacity Integer
- If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
- family String
- If the service has different generations of hardware, for the same SKU, then that can be captured here.
- size String
- The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
- tier String
- This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
- name string
- The name of the SKU. Ex - P3. It is typically a letter+number code
- capacity number
- If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
- family string
- If the service has different generations of hardware, for the same SKU, then that can be captured here.
- size string
- The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
- tier string
- This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
- name str
- The name of the SKU. Ex - P3. It is typically a letter+number code
- capacity int
- If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
- family str
- If the service has different generations of hardware, for the same SKU, then that can be captured here.
- size str
- The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
- tier str
- This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
- name String
- The name of the SKU. Ex - P3. It is typically a letter+number code
- capacity Number
- If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
- family String
- If the service has different generations of hardware, for the same SKU, then that can be captured here.
- size String
- The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
- tier String
- This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0