Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Tenantmanagercontrolplane.getSubscription

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSubscription = oci.Tenantmanagercontrolplane.getSubscription({
    subscriptionId: testSubscriptionOciTenantmanagercontrolplaneSubscription.id,
});

import pulumi
import pulumi_oci as oci

test_subscription = oci.Tenantmanagercontrolplane.get_subscription(subscription_id=test_subscription_oci_tenantmanagercontrolplane_subscription["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/tenantmanagercontrolplane"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tenantmanagercontrolplane.GetSubscription(ctx, &tenantmanagercontrolplane.GetSubscriptionArgs{
			SubscriptionId: testSubscriptionOciTenantmanagercontrolplaneSubscription.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSubscription = Oci.Tenantmanagercontrolplane.GetSubscription.Invoke(new()
    {
        SubscriptionId = testSubscriptionOciTenantmanagercontrolplaneSubscription.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Tenantmanagercontrolplane.TenantmanagercontrolplaneFunctions;
import com.pulumi.oci.Tenantmanagercontrolplane.inputs.GetSubscriptionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testSubscription = TenantmanagercontrolplaneFunctions.getSubscription(GetSubscriptionArgs.builder()
            .subscriptionId(testSubscriptionOciTenantmanagercontrolplaneSubscription.id())
            .build());

    }
}

variables:
  testSubscription:
    fn::invoke:
      function: oci:Tenantmanagercontrolplane:getSubscription
      arguments:
        subscriptionId: ${testSubscriptionOciTenantmanagercontrolplaneSubscription.id}

Using getSubscription

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.

TypeScript
Python
Go
C#
Java
YAML

function getSubscription(args: GetSubscriptionArgs, opts?: InvokeOptions): Promise<GetSubscriptionResult>
function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: InvokeOptions): Output<GetSubscriptionResult>

def get_subscription(subscription_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSubscriptionResult
def get_subscription_output(subscription_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetSubscriptionResult]

func GetSubscription(ctx *Context, args *GetSubscriptionArgs, opts ...InvokeOption) (*GetSubscriptionResult, error)
func GetSubscriptionOutput(ctx *Context, args *GetSubscriptionOutputArgs, opts ...InvokeOption) GetSubscriptionResultOutput

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

public static class GetSubscription 
{
    public static Task<GetSubscriptionResult> InvokeAsync(GetSubscriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetSubscriptionResult> Invoke(GetSubscriptionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)
public static Output<GetSubscriptionResult> getSubscription(GetSubscriptionArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Tenantmanagercontrolplane/getSubscription:getSubscription
  arguments:
    # arguments dictionary

The following arguments are supported:

SubscriptionId string: OCID of the subscription.

SubscriptionId string: OCID of the subscription.

subscriptionId String: OCID of the subscription.

subscriptionId string: OCID of the subscription.

subscription_id str: OCID of the subscription.

subscriptionId String: OCID of the subscription.

getSubscription Result

The following output properties are available:

ClassicSubscriptionId string: Classic subscription ID.
CloudAmountCurrency string: The currency code for the customer associated with the subscription.
CompartmentId string: The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.
CsiNumber string: Customer service identifier for the customer associated with the subscription.
CurrencyCode string: Currency code. For example USD, MXN.
CustomerCountryCode string: The country code for the customer associated with the subscription.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
EndDate string: Date and time when the SKU ended.
EntityVersion string: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The provider-assigned unique ID for this managed resource.
IsClassicSubscription bool: Specifies whether or not the subscription is from classic systems.
IsGovernmentSubscription bool: Specifies whether or not the subscription is a government subscription.
PaymentModel string: The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
ProgramType string: Specifies any program that is associated with the subscription.
Promotions List<GetSubscriptionPromotion>: List of promotions related to the subscription.
PurchaseEntitlementId string: Purchase entitlement ID associated with the subscription.
RegionAssignment string: Region for the subscription.
ServiceName string: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
Skuses List<GetSubscriptionSkus>: List of SKUs linked to this subscription.
StartDate string: Subscription start time.
State string: Lifecycle state of the subscription.
SubscriptionId string
SubscriptionNumber string: Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
SubscriptionTier string: Tier for the subscription, whether a free promotion subscription or a paid subscription.
TimeCreated string: The date and time of creation, as described in RFC 3339, section 14.29.
TimeUpdated string: The date and time of update, as described in RFC 3339, section 14.29.

ClassicSubscriptionId string: Classic subscription ID.
CloudAmountCurrency string: The currency code for the customer associated with the subscription.
CompartmentId string: The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.
CsiNumber string: Customer service identifier for the customer associated with the subscription.
CurrencyCode string: Currency code. For example USD, MXN.
CustomerCountryCode string: The country code for the customer associated with the subscription.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
EndDate string: Date and time when the SKU ended.
EntityVersion string: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The provider-assigned unique ID for this managed resource.
IsClassicSubscription bool: Specifies whether or not the subscription is from classic systems.
IsGovernmentSubscription bool: Specifies whether or not the subscription is a government subscription.
PaymentModel string: The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
ProgramType string: Specifies any program that is associated with the subscription.
Promotions []GetSubscriptionPromotion: List of promotions related to the subscription.
PurchaseEntitlementId string: Purchase entitlement ID associated with the subscription.
RegionAssignment string: Region for the subscription.
ServiceName string: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
Skuses []GetSubscriptionSkus: List of SKUs linked to this subscription.
StartDate string: Subscription start time.
State string: Lifecycle state of the subscription.
SubscriptionId string
SubscriptionNumber string: Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
SubscriptionTier string: Tier for the subscription, whether a free promotion subscription or a paid subscription.
TimeCreated string: The date and time of creation, as described in RFC 3339, section 14.29.
TimeUpdated string: The date and time of update, as described in RFC 3339, section 14.29.

classicSubscriptionId String: Classic subscription ID.
cloudAmountCurrency String: The currency code for the customer associated with the subscription.
compartmentId String: The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.
csiNumber String: Customer service identifier for the customer associated with the subscription.
currencyCode String: Currency code. For example USD, MXN.
customerCountryCode String: The country code for the customer associated with the subscription.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
endDate String: Date and time when the SKU ended.
entityVersion String: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The provider-assigned unique ID for this managed resource.
isClassicSubscription Boolean: Specifies whether or not the subscription is from classic systems.
isGovernmentSubscription Boolean: Specifies whether or not the subscription is a government subscription.
paymentModel String: The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
programType String: Specifies any program that is associated with the subscription.
promotions List<GetSubscriptionPromotion>: List of promotions related to the subscription.
purchaseEntitlementId String: Purchase entitlement ID associated with the subscription.
regionAssignment String: Region for the subscription.
serviceName String: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
skuses List<GetSubscriptionSkus>: List of SKUs linked to this subscription.
startDate String: Subscription start time.
state String: Lifecycle state of the subscription.
subscriptionId String
subscriptionNumber String: Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
subscriptionTier String: Tier for the subscription, whether a free promotion subscription or a paid subscription.
timeCreated String: The date and time of creation, as described in RFC 3339, section 14.29.
timeUpdated String: The date and time of update, as described in RFC 3339, section 14.29.

classicSubscriptionId string: Classic subscription ID.
cloudAmountCurrency string: The currency code for the customer associated with the subscription.
compartmentId string: The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.
csiNumber string: Customer service identifier for the customer associated with the subscription.
currencyCode string: Currency code. For example USD, MXN.
customerCountryCode string: The country code for the customer associated with the subscription.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
endDate string: Date and time when the SKU ended.
entityVersion string: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The provider-assigned unique ID for this managed resource.
isClassicSubscription boolean: Specifies whether or not the subscription is from classic systems.
isGovernmentSubscription boolean: Specifies whether or not the subscription is a government subscription.
paymentModel string: The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
programType string: Specifies any program that is associated with the subscription.
promotions GetSubscriptionPromotion[]: List of promotions related to the subscription.
purchaseEntitlementId string: Purchase entitlement ID associated with the subscription.
regionAssignment string: Region for the subscription.
serviceName string: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
skuses GetSubscriptionSkus[]: List of SKUs linked to this subscription.
startDate string: Subscription start time.
state string: Lifecycle state of the subscription.
subscriptionId string
subscriptionNumber string: Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
subscriptionTier string: Tier for the subscription, whether a free promotion subscription or a paid subscription.
timeCreated string: The date and time of creation, as described in RFC 3339, section 14.29.
timeUpdated string: The date and time of update, as described in RFC 3339, section 14.29.

classic_subscription_id str: Classic subscription ID.
cloud_amount_currency str: The currency code for the customer associated with the subscription.
compartment_id str: The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.
csi_number str: Customer service identifier for the customer associated with the subscription.
currency_code str: Currency code. For example USD, MXN.
customer_country_code str: The country code for the customer associated with the subscription.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
end_date str: Date and time when the SKU ended.
entity_version str: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The provider-assigned unique ID for this managed resource.
is_classic_subscription bool: Specifies whether or not the subscription is from classic systems.
is_government_subscription bool: Specifies whether or not the subscription is a government subscription.
payment_model str: The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
program_type str: Specifies any program that is associated with the subscription.
promotions Sequence[tenantmanagercontrolplane.GetSubscriptionPromotion]: List of promotions related to the subscription.
purchase_entitlement_id str: Purchase entitlement ID associated with the subscription.
region_assignment str: Region for the subscription.
service_name str: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
skuses Sequence[tenantmanagercontrolplane.GetSubscriptionSkus]: List of SKUs linked to this subscription.
start_date str: Subscription start time.
state str: Lifecycle state of the subscription.
subscription_id str
subscription_number str: Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
subscription_tier str: Tier for the subscription, whether a free promotion subscription or a paid subscription.
time_created str: The date and time of creation, as described in RFC 3339, section 14.29.
time_updated str: The date and time of update, as described in RFC 3339, section 14.29.

classicSubscriptionId String: Classic subscription ID.
cloudAmountCurrency String: The currency code for the customer associated with the subscription.
compartmentId String: The Oracle ID (OCID) of the owning compartment. Always a tenancy OCID.
csiNumber String: Customer service identifier for the customer associated with the subscription.
currencyCode String: Currency code. For example USD, MXN.
customerCountryCode String: The country code for the customer associated with the subscription.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
endDate String: Date and time when the SKU ended.
entityVersion String: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The provider-assigned unique ID for this managed resource.
isClassicSubscription Boolean: Specifies whether or not the subscription is from classic systems.
isGovernmentSubscription Boolean: Specifies whether or not the subscription is a government subscription.
paymentModel String: The pay model of the subscription, such as 'Pay as you go' or 'Monthly'.
programType String: Specifies any program that is associated with the subscription.
promotions List<Property Map>: List of promotions related to the subscription.
purchaseEntitlementId String: Purchase entitlement ID associated with the subscription.
regionAssignment String: Region for the subscription.
serviceName String: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
skuses List<Property Map>: List of SKUs linked to this subscription.
startDate String: Subscription start time.
state String: Lifecycle state of the subscription.
subscriptionId String
subscriptionNumber String: Unique Oracle Cloud Subscriptions identifier that is immutable on creation.
subscriptionTier String: Tier for the subscription, whether a free promotion subscription or a paid subscription.
timeCreated String: The date and time of creation, as described in RFC 3339, section 14.29.
timeUpdated String: The date and time of update, as described in RFC 3339, section 14.29.

Supporting Types

GetSubscriptionPromotion

Amount double: If a subscription is present, indicates the total amount of promotional subscription credits.
CurrencyUnit string: Currency unit associated with the promotion.
Duration int: Specifies how long the promotion related to the subscription, if any, is valid in duration units.
DurationUnit string: Unit for the duration.
IsIntentToPay bool: Speficies whether or not the customer intends to pay after the promotion has expired.
Status string: If a subscription is present, indicates the current status of the subscription promotion.
TimeExpired string: Date and time when the promotion ends.
TimeStarted string: Date and time when the promotion starts.

Amount float64: If a subscription is present, indicates the total amount of promotional subscription credits.
CurrencyUnit string: Currency unit associated with the promotion.
Duration int: Specifies how long the promotion related to the subscription, if any, is valid in duration units.
DurationUnit string: Unit for the duration.
IsIntentToPay bool: Speficies whether or not the customer intends to pay after the promotion has expired.
Status string: If a subscription is present, indicates the current status of the subscription promotion.
TimeExpired string: Date and time when the promotion ends.
TimeStarted string: Date and time when the promotion starts.

amount Double: If a subscription is present, indicates the total amount of promotional subscription credits.
currencyUnit String: Currency unit associated with the promotion.
duration Integer: Specifies how long the promotion related to the subscription, if any, is valid in duration units.
durationUnit String: Unit for the duration.
isIntentToPay Boolean: Speficies whether or not the customer intends to pay after the promotion has expired.
status String: If a subscription is present, indicates the current status of the subscription promotion.
timeExpired String: Date and time when the promotion ends.
timeStarted String: Date and time when the promotion starts.

amount number: If a subscription is present, indicates the total amount of promotional subscription credits.
currencyUnit string: Currency unit associated with the promotion.
duration number: Specifies how long the promotion related to the subscription, if any, is valid in duration units.
durationUnit string: Unit for the duration.
isIntentToPay boolean: Speficies whether or not the customer intends to pay after the promotion has expired.
status string: If a subscription is present, indicates the current status of the subscription promotion.
timeExpired string: Date and time when the promotion ends.
timeStarted string: Date and time when the promotion starts.

amount float: If a subscription is present, indicates the total amount of promotional subscription credits.
currency_unit str: Currency unit associated with the promotion.
duration int: Specifies how long the promotion related to the subscription, if any, is valid in duration units.
duration_unit str: Unit for the duration.
is_intent_to_pay bool: Speficies whether or not the customer intends to pay after the promotion has expired.
status str: If a subscription is present, indicates the current status of the subscription promotion.
time_expired str: Date and time when the promotion ends.
time_started str: Date and time when the promotion starts.

amount Number: If a subscription is present, indicates the total amount of promotional subscription credits.
currencyUnit String: Currency unit associated with the promotion.
duration Number: Specifies how long the promotion related to the subscription, if any, is valid in duration units.
durationUnit String: Unit for the duration.
isIntentToPay Boolean: Speficies whether or not the customer intends to pay after the promotion has expired.
status String: If a subscription is present, indicates the current status of the subscription promotion.
timeExpired String: Date and time when the promotion ends.
timeStarted String: Date and time when the promotion starts.

GetSubscriptionSkus

Description string: Description of the stock units.
EndDate string: Date and time when the SKU ended.
GsiOrderLineId string: Sales order line identifier.
IsAdditionalInstance bool: Specifies if an additional test instance can be provisioned by the SaaS application.
IsBaseServiceComponent bool: Specifies if the SKU is considered as a parent or child.
LicensePartDescription string: Description of the covered product belonging to this SKU.
MetricName string: Base metric for billing the service.
Quantity int: Quantity of the stock units.
Sku string: Stock Keeping Unit (SKU) ID.
StartDate string: Subscription start time.

Description string: Description of the stock units.
EndDate string: Date and time when the SKU ended.
GsiOrderLineId string: Sales order line identifier.
IsAdditionalInstance bool: Specifies if an additional test instance can be provisioned by the SaaS application.
IsBaseServiceComponent bool: Specifies if the SKU is considered as a parent or child.
LicensePartDescription string: Description of the covered product belonging to this SKU.
MetricName string: Base metric for billing the service.
Quantity int: Quantity of the stock units.
Sku string: Stock Keeping Unit (SKU) ID.
StartDate string: Subscription start time.

description String: Description of the stock units.
endDate String: Date and time when the SKU ended.
gsiOrderLineId String: Sales order line identifier.
isAdditionalInstance Boolean: Specifies if an additional test instance can be provisioned by the SaaS application.
isBaseServiceComponent Boolean: Specifies if the SKU is considered as a parent or child.
licensePartDescription String: Description of the covered product belonging to this SKU.
metricName String: Base metric for billing the service.
quantity Integer: Quantity of the stock units.
sku String: Stock Keeping Unit (SKU) ID.
startDate String: Subscription start time.

description string: Description of the stock units.
endDate string: Date and time when the SKU ended.
gsiOrderLineId string: Sales order line identifier.
isAdditionalInstance boolean: Specifies if an additional test instance can be provisioned by the SaaS application.
isBaseServiceComponent boolean: Specifies if the SKU is considered as a parent or child.
licensePartDescription string: Description of the covered product belonging to this SKU.
metricName string: Base metric for billing the service.
quantity number: Quantity of the stock units.
sku string: Stock Keeping Unit (SKU) ID.
startDate string: Subscription start time.

description str: Description of the stock units.
end_date str: Date and time when the SKU ended.
gsi_order_line_id str: Sales order line identifier.
is_additional_instance bool: Specifies if an additional test instance can be provisioned by the SaaS application.
is_base_service_component bool: Specifies if the SKU is considered as a parent or child.
license_part_description str: Description of the covered product belonging to this SKU.
metric_name str: Base metric for billing the service.
quantity int: Quantity of the stock units.
sku str: Stock Keeping Unit (SKU) ID.
start_date str: Subscription start time.

description String: Description of the stock units.
endDate String: Date and time when the SKU ended.
gsiOrderLineId String: Sales order line identifier.
isAdditionalInstance Boolean: Specifies if an additional test instance can be provisioned by the SaaS application.
isBaseServiceComponent Boolean: Specifies if the SKU is considered as a parent or child.
licensePartDescription String: Description of the covered product belonging to this SKU.
metricName String: Base metric for billing the service.
quantity Number: Quantity of the stock units.
sku String: Stock Keeping Unit (SKU) ID.
startDate String: Subscription start time.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.Tenantmanagercontrolplane.getSubscription

On this page

On this page

Example Usage

Using getSubscription

getSubscription Result

Supporting Types

GetSubscriptionPromotion

GetSubscriptionSkus

Package Details

On this page

On this page