Azure Native v1.102.0, May 2 23

azure-native.machinelearning.getCommitmentPlan

Explore with Pulumi AI

Retrieve an Azure ML commitment plan by its subscription, resource group and name. API Version: 2016-05-01-preview.

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(commitment_plan_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCommitmentPlanResult
def get_commitment_plan_output(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)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:machinelearning:getCommitmentPlan
  arguments:
    # arguments dictionary

The following arguments are supported:

CommitmentPlanName string: The Azure ML commitment plan name.
ResourceGroupName string: The resource group name.

CommitmentPlanName string: The Azure ML commitment plan name.
ResourceGroupName string: The resource group name.

commitmentPlanName String: The Azure ML commitment plan name.
resourceGroupName String: The resource group name.

commitmentPlanName string: The Azure ML commitment plan name.
resourceGroupName string: The resource group name.

commitment_plan_name str: The Azure ML commitment plan name.
resource_group_name str: The resource group name.

commitmentPlanName String: The Azure ML commitment plan name.
resourceGroupName String: The resource group name.

getCommitmentPlan Result

The following output properties are available:

Id string: Resource Id.
Location string: Resource location.
Name string: Resource name.
Properties Pulumi.AzureNative.MachineLearning.Outputs.CommitmentPlanPropertiesResponse: The commitment plan properties.
Type string: Resource type.
Etag string: An entity tag used to enforce optimistic concurrency.
Sku Pulumi.AzureNative.MachineLearning.Outputs.ResourceSkuResponse: The commitment plan SKU.
Tags Dictionary<string, string>: User-defined tags for the resource.

Id string: Resource Id.
Location string: Resource location.
Name string: Resource name.
Properties CommitmentPlanPropertiesResponse: The commitment plan properties.
Type string: Resource type.
Etag string: An entity tag used to enforce optimistic concurrency.
Sku ResourceSkuResponse: The commitment plan SKU.
Tags map[string]string: User-defined tags for the resource.

id String: Resource Id.
location String: Resource location.
name String: Resource name.
properties CommitmentPlanPropertiesResponse: The commitment plan properties.
type String: Resource type.
etag String: An entity tag used to enforce optimistic concurrency.
sku ResourceSkuResponse: The commitment plan SKU.
tags Map<String,String>: User-defined tags for the resource.

id string: Resource Id.
location string: Resource location.
name string: Resource name.
properties CommitmentPlanPropertiesResponse: The commitment plan properties.
type string: Resource type.
etag string: An entity tag used to enforce optimistic concurrency.
sku ResourceSkuResponse: The commitment plan SKU.
tags {[key: string]: string}: User-defined tags for the resource.

id str: Resource Id.
location str: Resource location.
name str: Resource name.
properties CommitmentPlanPropertiesResponse: The commitment plan properties.
type str: Resource type.
etag str: An entity tag used to enforce optimistic concurrency.
sku ResourceSkuResponse: The commitment plan SKU.
tags Mapping[str, str]: User-defined tags for the resource.

id String: Resource Id.
location String: Resource location.
name String: Resource name.
properties Property Map: The commitment plan properties.
type String: Resource type.
etag String: An entity tag used to enforce optimistic concurrency.
sku Property Map: The commitment plan SKU.
tags Map<String>: User-defined tags for the resource.

Supporting Types

CommitmentPlanPropertiesResponse

ChargeForOverage bool: Indicates whether usage beyond the commitment plan's included quantities will be charged.
ChargeForPlan bool: Indicates whether the commitment plan will incur a charge.
CreationDate string: The date at which this commitment plan was created, in ISO 8601 format.
IncludedQuantities Dictionary<string, Pulumi.AzureNative.MachineLearning.Inputs.PlanQuantityResponse>: The included resource quantities this plan gives you.
MaxAssociationLimit int: The maximum number of commitment associations that can be children of this commitment plan.
MaxCapacityLimit int: The maximum scale-out capacity for this commitment plan.
MinCapacityLimit int: The minimum scale-out capacity for this commitment plan.
PlanMeter string: The Azure meter which will be used to charge for this commitment plan.
RefillFrequencyInDays int: The frequency at which this commitment plan's included quantities are refilled.
SuspendPlanOnOverage bool: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

ChargeForOverage bool: Indicates whether usage beyond the commitment plan's included quantities will be charged.
ChargeForPlan bool: Indicates whether the commitment plan will incur a charge.
CreationDate string: The date at which this commitment plan was created, in ISO 8601 format.
IncludedQuantities map[string]PlanQuantityResponse: The included resource quantities this plan gives you.
MaxAssociationLimit int: The maximum number of commitment associations that can be children of this commitment plan.
MaxCapacityLimit int: The maximum scale-out capacity for this commitment plan.
MinCapacityLimit int: The minimum scale-out capacity for this commitment plan.
PlanMeter string: The Azure meter which will be used to charge for this commitment plan.
RefillFrequencyInDays int: The frequency at which this commitment plan's included quantities are refilled.
SuspendPlanOnOverage bool: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

chargeForOverage Boolean: Indicates whether usage beyond the commitment plan's included quantities will be charged.
chargeForPlan Boolean: Indicates whether the commitment plan will incur a charge.
creationDate String: The date at which this commitment plan was created, in ISO 8601 format.
includedQuantities Map<String,PlanQuantityResponse>: The included resource quantities this plan gives you.
maxAssociationLimit Integer: The maximum number of commitment associations that can be children of this commitment plan.
maxCapacityLimit Integer: The maximum scale-out capacity for this commitment plan.
minCapacityLimit Integer: The minimum scale-out capacity for this commitment plan.
planMeter String: The Azure meter which will be used to charge for this commitment plan.
refillFrequencyInDays Integer: The frequency at which this commitment plan's included quantities are refilled.
suspendPlanOnOverage Boolean: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

chargeForOverage boolean: Indicates whether usage beyond the commitment plan's included quantities will be charged.
chargeForPlan boolean: Indicates whether the commitment plan will incur a charge.
creationDate string: The date at which this commitment plan was created, in ISO 8601 format.
includedQuantities {[key: string]: PlanQuantityResponse}: The included resource quantities this plan gives you.
maxAssociationLimit number: The maximum number of commitment associations that can be children of this commitment plan.
maxCapacityLimit number: The maximum scale-out capacity for this commitment plan.
minCapacityLimit number: The minimum scale-out capacity for this commitment plan.
planMeter string: The Azure meter which will be used to charge for this commitment plan.
refillFrequencyInDays number: The frequency at which this commitment plan's included quantities are refilled.
suspendPlanOnOverage boolean: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

charge_for_overage bool: Indicates whether usage beyond the commitment plan's included quantities will be charged.
charge_for_plan bool: Indicates whether the commitment plan will incur a charge.
creation_date str: The date at which this commitment plan was created, in ISO 8601 format.
included_quantities Mapping[str, PlanQuantityResponse]: The included resource quantities this plan gives you.
max_association_limit int: The maximum number of commitment associations that can be children of this commitment plan.
max_capacity_limit int: The maximum scale-out capacity for this commitment plan.
min_capacity_limit int: The minimum scale-out capacity for this commitment plan.
plan_meter str: The Azure meter which will be used to charge for this commitment plan.
refill_frequency_in_days int: The frequency at which this commitment plan's included quantities are refilled.
suspend_plan_on_overage bool: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

chargeForOverage Boolean: Indicates whether usage beyond the commitment plan's included quantities will be charged.
chargeForPlan Boolean: Indicates whether the commitment plan will incur a charge.
creationDate String: The date at which this commitment plan was created, in ISO 8601 format.
includedQuantities Map<Property Map>: The included resource quantities this plan gives you.
maxAssociationLimit Number: The maximum number of commitment associations that can be children of this commitment plan.
maxCapacityLimit Number: The maximum scale-out capacity for this commitment plan.
minCapacityLimit Number: The minimum scale-out capacity for this commitment plan.
planMeter String: The Azure meter which will be used to charge for this commitment plan.
refillFrequencyInDays Number: The frequency at which this commitment plan's included quantities are refilled.
suspendPlanOnOverage Boolean: Indicates whether this commitment plan will be moved into a suspended state if usage goes beyond the commitment plan's included quantities.

PlanQuantityResponse

Allowance double: The quantity added to the commitment plan at an interval specified by its allowance frequency.
Amount double: The quantity available to the plan the last time usage was calculated.
IncludedQuantityMeter string: The Azure meter for usage against included quantities.
OverageMeter string: The Azure meter for usage which exceeds included quantities.

Allowance float64: The quantity added to the commitment plan at an interval specified by its allowance frequency.
Amount float64: The quantity available to the plan the last time usage was calculated.
IncludedQuantityMeter string: The Azure meter for usage against included quantities.
OverageMeter string: The Azure meter for usage which exceeds included quantities.

allowance Double: The quantity added to the commitment plan at an interval specified by its allowance frequency.
amount Double: The quantity available to the plan the last time usage was calculated.
includedQuantityMeter String: The Azure meter for usage against included quantities.
overageMeter String: The Azure meter for usage which exceeds included quantities.

allowance number: The quantity added to the commitment plan at an interval specified by its allowance frequency.
amount number: The quantity available to the plan the last time usage was calculated.
includedQuantityMeter string: The Azure meter for usage against included quantities.
overageMeter string: The Azure meter for usage which exceeds included quantities.

allowance float: The quantity added to the commitment plan at an interval specified by its allowance frequency.
amount float: The quantity available to the plan the last time usage was calculated.
included_quantity_meter str: The Azure meter for usage against included quantities.
overage_meter str: The Azure meter for usage which exceeds included quantities.

allowance Number: The quantity added to the commitment plan at an interval specified by its allowance frequency.
amount Number: The quantity available to the plan the last time usage was calculated.
includedQuantityMeter String: The Azure meter for usage against included quantities.
overageMeter String: The Azure meter for usage which exceeds included quantities.

ResourceSkuResponse

Capacity int: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
Name string: The SKU name. Along with tier, uniquely identifies the SKU.
Tier string: The SKU tier. Along with name, uniquely identifies the SKU.

Capacity int: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
Name string: The SKU name. Along with tier, uniquely identifies the SKU.
Tier string: The SKU tier. Along with name, uniquely identifies the SKU.

capacity Integer: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
name String: The SKU name. Along with tier, uniquely identifies the SKU.
tier String: The SKU tier. Along with name, uniquely identifies the SKU.

capacity number: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
name string: The SKU name. Along with tier, uniquely identifies the SKU.
tier string: The SKU tier. Along with name, uniquely identifies the SKU.

capacity int: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
name str: The SKU name. Along with tier, uniquely identifies the SKU.
tier str: The SKU tier. Along with name, uniquely identifies the SKU.

capacity Number: The scale-out capacity of the resource. 1 is 1x, 2 is 2x, etc. This impacts the quantities and cost of any commitment plan resource.
name String: The SKU name. Along with tier, uniquely identifies the SKU.
tier String: The SKU tier. Along with name, uniquely identifies the SKU.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0