pulumi-azure-kotlin/com.pulumi.azure.core.kotlin/Subscription

Subscription

class Subscription : KotlinCustomResource

Example Usage

Creating A New Alias And Subscription For An Enrollment Account

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.billing.getEnrollmentAccountScope({
    billingAccountName: "1234567890",
    enrollmentAccountName: "0123456",
});
const exampleSubscription = new azure.core.Subscription("example", {
    subscriptionName: "My Example EA Subscription",
    billingScopeId: example.then(example => example.id),
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.billing.get_enrollment_account_scope(billing_account_name="1234567890",
    enrollment_account_name="0123456")
example_subscription = azure.core.Subscription("example",
    subscription_name="My Example EA Subscription",
    billing_scope_id=example.id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = Azure.Billing.GetEnrollmentAccountScope.Invoke(new()
    {
        BillingAccountName = "1234567890",
        EnrollmentAccountName = "0123456",
    });
    var exampleSubscription = new Azure.Core.Subscription("example", new()
    {
        SubscriptionName = "My Example EA Subscription",
        BillingScopeId = example.Apply(getEnrollmentAccountScopeResult => getEnrollmentAccountScopeResult.Id),
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/billing"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := billing.GetEnrollmentAccountScope(ctx, &billing.GetEnrollmentAccountScopeArgs{
			BillingAccountName:    "1234567890",
			EnrollmentAccountName: "0123456",
		}, nil)
		if err != nil {
			return err
		}
		_, err = core.NewSubscription(ctx, "example", &core.SubscriptionArgs{
			SubscriptionName: pulumi.String("My Example EA Subscription"),
			BillingScopeId:   pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.billing.BillingFunctions;
import com.pulumi.azure.billing.inputs.GetEnrollmentAccountScopeArgs;
import com.pulumi.azure.core.Subscription;
import com.pulumi.azure.core.SubscriptionArgs;
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 example = BillingFunctions.getEnrollmentAccountScope(GetEnrollmentAccountScopeArgs.builder()
            .billingAccountName("1234567890")
            .enrollmentAccountName("0123456")
            .build());
        var exampleSubscription = new Subscription("exampleSubscription", SubscriptionArgs.builder()
            .subscriptionName("My Example EA Subscription")
            .billingScopeId(example.id())
            .build());
    }
}
Content copied to clipboard
resources:
  exampleSubscription:
    type: azure:core:Subscription
    name: example
    properties:
      subscriptionName: My Example EA Subscription
      billingScopeId: ${example.id}
variables:
  example:
    fn::invoke:
      function: azure:billing:getEnrollmentAccountScope
      arguments:
        billingAccountName: '1234567890'
        enrollmentAccountName: '0123456'
Content copied to clipboard

Creating A New Alias And Subscription For A Microsoft Customer Account

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.billing.getMcaAccountScope({
    billingAccountName: "e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
    billingProfileName: "PE2Q-NOIT-BG7-TGB",
    invoiceSectionName: "MTT4-OBS7-PJA-TGB",
});
const exampleSubscription = new azure.core.Subscription("example", {
    subscriptionName: "My Example MCA Subscription",
    billingScopeId: example.then(example => example.id),
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.billing.get_mca_account_scope(billing_account_name="e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
    billing_profile_name="PE2Q-NOIT-BG7-TGB",
    invoice_section_name="MTT4-OBS7-PJA-TGB")
example_subscription = azure.core.Subscription("example",
    subscription_name="My Example MCA Subscription",
    billing_scope_id=example.id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = Azure.Billing.GetMcaAccountScope.Invoke(new()
    {
        BillingAccountName = "e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
        BillingProfileName = "PE2Q-NOIT-BG7-TGB",
        InvoiceSectionName = "MTT4-OBS7-PJA-TGB",
    });
    var exampleSubscription = new Azure.Core.Subscription("example", new()
    {
        SubscriptionName = "My Example MCA Subscription",
        BillingScopeId = example.Apply(getMcaAccountScopeResult => getMcaAccountScopeResult.Id),
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/billing"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := billing.GetMcaAccountScope(ctx, &billing.GetMcaAccountScopeArgs{
			BillingAccountName: "e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
			BillingProfileName: "PE2Q-NOIT-BG7-TGB",
			InvoiceSectionName: "MTT4-OBS7-PJA-TGB",
		}, nil)
		if err != nil {
			return err
		}
		_, err = core.NewSubscription(ctx, "example", &core.SubscriptionArgs{
			SubscriptionName: pulumi.String("My Example MCA Subscription"),
			BillingScopeId:   pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.billing.BillingFunctions;
import com.pulumi.azure.billing.inputs.GetMcaAccountScopeArgs;
import com.pulumi.azure.core.Subscription;
import com.pulumi.azure.core.SubscriptionArgs;
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 example = BillingFunctions.getMcaAccountScope(GetMcaAccountScopeArgs.builder()
            .billingAccountName("e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31")
            .billingProfileName("PE2Q-NOIT-BG7-TGB")
            .invoiceSectionName("MTT4-OBS7-PJA-TGB")
            .build());
        var exampleSubscription = new Subscription("exampleSubscription", SubscriptionArgs.builder()
            .subscriptionName("My Example MCA Subscription")
            .billingScopeId(example.id())
            .build());
    }
}
Content copied to clipboard
resources:
  exampleSubscription:
    type: azure:core:Subscription
    name: example
    properties:
      subscriptionName: My Example MCA Subscription
      billingScopeId: ${example.id}
variables:
  example:
    fn::invoke:
      function: azure:billing:getMcaAccountScope
      arguments:
        billingAccountName: e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31
        billingProfileName: PE2Q-NOIT-BG7-TGB
        invoiceSectionName: MTT4-OBS7-PJA-TGB
Content copied to clipboard

Creating A New Alias And Subscription For A Microsoft Partner Account

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.billing.getMpaAccountScope({
    billingAccountName: "e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
    customerName: "2281f543-7321-4cf9-1e23-edb4Oc31a31c",
});
const exampleSubscription = new azure.core.Subscription("example", {
    subscriptionName: "My Example MPA Subscription",
    billingScopeId: example.then(example => example.id),
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.billing.get_mpa_account_scope(billing_account_name="e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
    customer_name="2281f543-7321-4cf9-1e23-edb4Oc31a31c")
example_subscription = azure.core.Subscription("example",
    subscription_name="My Example MPA Subscription",
    billing_scope_id=example.id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = Azure.Billing.GetMpaAccountScope.Invoke(new()
    {
        BillingAccountName = "e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
        CustomerName = "2281f543-7321-4cf9-1e23-edb4Oc31a31c",
    });
    var exampleSubscription = new Azure.Core.Subscription("example", new()
    {
        SubscriptionName = "My Example MPA Subscription",
        BillingScopeId = example.Apply(getMpaAccountScopeResult => getMpaAccountScopeResult.Id),
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/billing"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := billing.GetMpaAccountScope(ctx, &billing.GetMpaAccountScopeArgs{
			BillingAccountName: "e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31",
			CustomerName:       "2281f543-7321-4cf9-1e23-edb4Oc31a31c",
		}, nil)
		if err != nil {
			return err
		}
		_, err = core.NewSubscription(ctx, "example", &core.SubscriptionArgs{
			SubscriptionName: pulumi.String("My Example MPA Subscription"),
			BillingScopeId:   pulumi.String(example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.billing.BillingFunctions;
import com.pulumi.azure.billing.inputs.GetMpaAccountScopeArgs;
import com.pulumi.azure.core.Subscription;
import com.pulumi.azure.core.SubscriptionArgs;
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 example = BillingFunctions.getMpaAccountScope(GetMpaAccountScopeArgs.builder()
            .billingAccountName("e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31")
            .customerName("2281f543-7321-4cf9-1e23-edb4Oc31a31c")
            .build());
        var exampleSubscription = new Subscription("exampleSubscription", SubscriptionArgs.builder()
            .subscriptionName("My Example MPA Subscription")
            .billingScopeId(example.id())
            .build());
    }
}
Content copied to clipboard
resources:
  exampleSubscription:
    type: azure:core:Subscription
    name: example
    properties:
      subscriptionName: My Example MPA Subscription
      billingScopeId: ${example.id}
variables:
  example:
    fn::invoke:
      function: azure:billing:getMpaAccountScope
      arguments:
        billingAccountName: e879cf0f-2b4d-5431-109a-f72fc9868693:024cabf4-7321-4cf9-be59-df0c77ca51de_2019-05-31
        customerName: 2281f543-7321-4cf9-1e23-edb4Oc31a31c
Content copied to clipboard

Adding An Alias To An Existing Subscription

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.Subscription("example", {
    alias: "examplesub",
    subscriptionName: "My Example Subscription",
    subscriptionId: "12345678-12234-5678-9012-123456789012",
});
Content copied to clipboard
import pulumi
import pulumi_azure as azure
example = azure.core.Subscription("example",
    alias="examplesub",
    subscription_name="My Example Subscription",
    subscription_id="12345678-12234-5678-9012-123456789012")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
    var example = new Azure.Core.Subscription("example", new()
    {
        Alias = "examplesub",
        SubscriptionName = "My Example Subscription",
        SubscriptionId = "12345678-12234-5678-9012-123456789012",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewSubscription(ctx, "example", &core.SubscriptionArgs{
			Alias:            pulumi.String("examplesub"),
			SubscriptionName: pulumi.String("My Example Subscription"),
			SubscriptionId:   pulumi.String("12345678-12234-5678-9012-123456789012"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.Subscription;
import com.pulumi.azure.core.SubscriptionArgs;
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) {
        var example = new Subscription("example", SubscriptionArgs.builder()
            .alias("examplesub")
            .subscriptionName("My Example Subscription")
            .subscriptionId("12345678-12234-5678-9012-123456789012")
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: azure:core:Subscription
    properties:
      alias: examplesub
      subscriptionName: My Example Subscription
      subscriptionId: 12345678-12234-5678-9012-123456789012
Content copied to clipboard

Import

Subscriptions can be imported using the resource id, e.g.

$ pulumi import azure:core/subscription:Subscription example "/providers/Microsoft.Subscription/aliases/subscription1"
Content copied to clipboard

In this scenario, the subscription_id property can be completed and the provider will assume control of the existing subscription by creating an Alias. See the adding an Alias to an existing Subscription above. This provider requires an alias to correctly manage Subscription resources due to Azure Subscription API design.

Properties

Link copied to clipboard
val alias: Output<String>

The Alias name for the subscription. This provider will generate a new GUID if this is not supplied. Changing this forces a new Subscription to be created.

Link copied to clipboard
val billingScopeId: Output<String>?

The Azure Billing Scope ID. Can be a Microsoft Customer Account Billing Scope ID, a Microsoft Partner Account Billing Scope ID or an Enrollment Billing Scope ID.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val subscriptionId: Output<String>

The ID of the Subscription. Changing this forces a new Subscription to be created.

Link copied to clipboard
val subscriptionName: Output<String>

The Name of the Subscription. This is the Display Name in the portal.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags to assign to the Subscription.

Link copied to clipboard
val tenantId: Output<String>

The ID of the Tenant to which the subscription belongs.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val workload: Output<String>?

The workload type of the Subscription. Possible values are Production (default) and DevTest. Changing this forces a new Subscription to be created.