Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getSharedCommitmentPlan
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.cognitiveservices.getSharedCommitmentPlan

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns a Cognitive Services commitment plan specified by the parameters.

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 getSharedCommitmentPlan

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 getSharedCommitmentPlan(args: GetSharedCommitmentPlanArgs, opts?: InvokeOptions): Promise<GetSharedCommitmentPlanResult>
function getSharedCommitmentPlanOutput(args: GetSharedCommitmentPlanOutputArgs, opts?: InvokeOptions): Output<GetSharedCommitmentPlanResult>
Copy
def get_shared_commitment_plan(commitment_plan_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetSharedCommitmentPlanResult
def get_shared_commitment_plan_output(commitment_plan_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetSharedCommitmentPlanResult]
Copy
func LookupSharedCommitmentPlan(ctx *Context, args *LookupSharedCommitmentPlanArgs, opts ...InvokeOption) (*LookupSharedCommitmentPlanResult, error)
func LookupSharedCommitmentPlanOutput(ctx *Context, args *LookupSharedCommitmentPlanOutputArgs, opts ...InvokeOption) LookupSharedCommitmentPlanResultOutput
Copy

> Note: This function is named LookupSharedCommitmentPlan in the Go SDK.

public static class GetSharedCommitmentPlan 
{
    public static Task<GetSharedCommitmentPlanResult> InvokeAsync(GetSharedCommitmentPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetSharedCommitmentPlanResult> Invoke(GetSharedCommitmentPlanInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSharedCommitmentPlanResult> getSharedCommitmentPlan(GetSharedCommitmentPlanArgs args, InvokeOptions options)
public static Output<GetSharedCommitmentPlanResult> getSharedCommitmentPlan(GetSharedCommitmentPlanArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cognitiveservices:getSharedCommitmentPlan
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CommitmentPlanName
This property is required.
Changes to this property will trigger replacement.
string
The name of the commitmentPlan associated with the Cognitive Services Account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
CommitmentPlanName
This property is required.
Changes to this property will trigger replacement.
string
The name of the commitmentPlan associated with the Cognitive Services Account
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
commitmentPlanName
This property is required.
Changes to this property will trigger replacement.
String
The name of the commitmentPlan associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
commitmentPlanName
This property is required.
Changes to this property will trigger replacement.
string
The name of the commitmentPlan associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
commitment_plan_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the commitmentPlan associated with the Cognitive Services Account
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
commitmentPlanName
This property is required.
Changes to this property will trigger replacement.
String
The name of the commitmentPlan associated with the Cognitive Services Account
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getSharedCommitmentPlan Result

The following output properties are available:

AzureApiVersion string
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.AzureNative.CognitiveServices.Outputs.CommitmentPlanPropertiesResponse
Properties of Cognitive Services account commitment plan.
SystemData Pulumi.AzureNative.CognitiveServices.Outputs.SystemDataResponse
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.AzureNative.CognitiveServices.Outputs.SkuResponse
The resource model definition representing SKU
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
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 CommitmentPlanPropertiesResponse
Properties of Cognitive Services account commitment plan.
SystemData SystemDataResponse
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 SkuResponse
The resource model definition representing SKU
Tags map[string]string
Resource tags.
azureApiVersion String
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 CommitmentPlanPropertiesResponse
Properties of Cognitive Services account commitment plan.
systemData SystemDataResponse
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 SkuResponse
The resource model definition representing SKU
tags Map<String,String>
Resource tags.
azureApiVersion string
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 CommitmentPlanPropertiesResponse
Properties of Cognitive Services account commitment plan.
systemData SystemDataResponse
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 SkuResponse
The resource model definition representing SKU
tags {[key: string]: string}
Resource tags.
azure_api_version str
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 CommitmentPlanPropertiesResponse
Properties of Cognitive Services account commitment plan.
system_data SystemDataResponse
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 SkuResponse
The resource model definition representing SKU
tags Mapping[str, str]
Resource tags.
azureApiVersion String
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.
systemData 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
tags Map<String>
Resource tags.

Supporting Types

CommitmentPeriodResponse

EndDate This property is required. string
Commitment period end date.
Quota This property is required. Pulumi.AzureNative.CognitiveServices.Inputs.CommitmentQuotaResponse
Cognitive Services account commitment quota.
StartDate This property is required. string
Commitment period start date.
Count int
Commitment period commitment count.
Tier string
Commitment period commitment tier.
EndDate This property is required. string
Commitment period end date.
Quota This property is required. CommitmentQuotaResponse
Cognitive Services account commitment quota.
StartDate This property is required. string
Commitment period start date.
Count int
Commitment period commitment count.
Tier string
Commitment period commitment tier.
endDate This property is required. String
Commitment period end date.
quota This property is required. CommitmentQuotaResponse
Cognitive Services account commitment quota.
startDate This property is required. String
Commitment period start date.
count Integer
Commitment period commitment count.
tier String
Commitment period commitment tier.
endDate This property is required. string
Commitment period end date.
quota This property is required. CommitmentQuotaResponse
Cognitive Services account commitment quota.
startDate This property is required. string
Commitment period start date.
count number
Commitment period commitment count.
tier string
Commitment period commitment tier.
end_date This property is required. str
Commitment period end date.
quota This property is required. CommitmentQuotaResponse
Cognitive Services account commitment quota.
start_date This property is required. str
Commitment period start date.
count int
Commitment period commitment count.
tier str
Commitment period commitment tier.
endDate This property is required. String
Commitment period end date.
quota This property is required. Property Map
Cognitive Services account commitment quota.
startDate This property is required. String
Commitment period start date.
count Number
Commitment period commitment count.
tier String
Commitment period commitment tier.

CommitmentPlanPropertiesResponse

Last This property is required. Pulumi.AzureNative.CognitiveServices.Inputs.CommitmentPeriodResponse
Cognitive Services account commitment period.
ProvisioningIssues This property is required. List<string>
The list of ProvisioningIssue.
ProvisioningState This property is required. string
Gets the status of the resource at the time the operation was called.
AutoRenew bool
AutoRenew commitment plan.
CommitmentPlanGuid string
Commitment plan guid.
Current Pulumi.AzureNative.CognitiveServices.Inputs.CommitmentPeriodResponse
Cognitive Services account commitment period.
HostingModel string
Account hosting model.
Next Pulumi.AzureNative.CognitiveServices.Inputs.CommitmentPeriodResponse
Cognitive Services account commitment period.
PlanType string
Commitment plan type.
Last This property is required. CommitmentPeriodResponse
Cognitive Services account commitment period.
ProvisioningIssues This property is required. []string
The list of ProvisioningIssue.
ProvisioningState This property is required. string
Gets the status of the resource at the time the operation was called.
AutoRenew bool
AutoRenew commitment plan.
CommitmentPlanGuid string
Commitment plan guid.
Current CommitmentPeriodResponse
Cognitive Services account commitment period.
HostingModel string
Account hosting model.
Next CommitmentPeriodResponse
Cognitive Services account commitment period.
PlanType string
Commitment plan type.
last This property is required. CommitmentPeriodResponse
Cognitive Services account commitment period.
provisioningIssues This property is required. List<String>
The list of ProvisioningIssue.
provisioningState This property is required. String
Gets the status of the resource at the time the operation was called.
autoRenew Boolean
AutoRenew commitment plan.
commitmentPlanGuid String
Commitment plan guid.
current CommitmentPeriodResponse
Cognitive Services account commitment period.
hostingModel String
Account hosting model.
next CommitmentPeriodResponse
Cognitive Services account commitment period.
planType String
Commitment plan type.
last This property is required. CommitmentPeriodResponse
Cognitive Services account commitment period.
provisioningIssues This property is required. string[]
The list of ProvisioningIssue.
provisioningState This property is required. string
Gets the status of the resource at the time the operation was called.
autoRenew boolean
AutoRenew commitment plan.
commitmentPlanGuid string
Commitment plan guid.
current CommitmentPeriodResponse
Cognitive Services account commitment period.
hostingModel string
Account hosting model.
next CommitmentPeriodResponse
Cognitive Services account commitment period.
planType string
Commitment plan type.
last This property is required. CommitmentPeriodResponse
Cognitive Services account commitment period.
provisioning_issues This property is required. Sequence[str]
The list of ProvisioningIssue.
provisioning_state This property is required. str
Gets the status of the resource at the time the operation was called.
auto_renew bool
AutoRenew commitment plan.
commitment_plan_guid str
Commitment plan guid.
current CommitmentPeriodResponse
Cognitive Services account commitment period.
hosting_model str
Account hosting model.
next CommitmentPeriodResponse
Cognitive Services account commitment period.
plan_type str
Commitment plan type.
last This property is required. Property Map
Cognitive Services account commitment period.
provisioningIssues This property is required. List<String>
The list of ProvisioningIssue.
provisioningState This property is required. String
Gets the status of the resource at the time the operation was called.
autoRenew Boolean
AutoRenew commitment plan.
commitmentPlanGuid String
Commitment plan guid.
current Property Map
Cognitive Services account commitment period.
hostingModel String
Account hosting model.
next Property Map
Cognitive Services account commitment period.
planType String
Commitment plan type.

CommitmentQuotaResponse

Quantity double
Commitment quota quantity.
Unit string
Commitment quota unit.
Quantity float64
Commitment quota quantity.
Unit string
Commitment quota unit.
quantity Double
Commitment quota quantity.
unit String
Commitment quota unit.
quantity number
Commitment quota quantity.
unit string
Commitment quota unit.
quantity float
Commitment quota quantity.
unit str
Commitment quota unit.
quantity Number
Commitment quota quantity.
unit String
Commitment quota unit.

SkuResponse

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
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_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native