1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. AzureSubscriptionAccount
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

octopusdeploy.AzureSubscriptionAccount

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs

    This resource manages Azure subscription accounts in Octopus Deploy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as octopusdeploy from "@pulumi/octopusdeploy";
    
    const example = new octopusdeploy.AzureSubscriptionAccount("example", {subscriptionId: "00000000-0000-0000-0000-000000000000"});
    
    import pulumi
    import pulumi_octopusdeploy as octopusdeploy
    
    example = octopusdeploy.AzureSubscriptionAccount("example", subscription_id="00000000-0000-0000-0000-000000000000")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := octopusdeploy.NewAzureSubscriptionAccount(ctx, "example", &octopusdeploy.AzureSubscriptionAccountArgs{
    			SubscriptionId: pulumi.String("00000000-0000-0000-0000-000000000000"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Octopusdeploy = Pulumi.Octopusdeploy;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Octopusdeploy.AzureSubscriptionAccount("example", new()
        {
            SubscriptionId = "00000000-0000-0000-0000-000000000000",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.octopusdeploy.AzureSubscriptionAccount;
    import com.pulumi.octopusdeploy.AzureSubscriptionAccountArgs;
    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 AzureSubscriptionAccount("example", AzureSubscriptionAccountArgs.builder()
                .subscriptionId("00000000-0000-0000-0000-000000000000")
                .build());
    
        }
    }
    
    resources:
      example:
        type: octopusdeploy:AzureSubscriptionAccount
        properties:
          subscriptionId: 00000000-0000-0000-0000-000000000000
    

    Create AzureSubscriptionAccount Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AzureSubscriptionAccount(name: string, args: AzureSubscriptionAccountArgs, opts?: CustomResourceOptions);
    @overload
    def AzureSubscriptionAccount(resource_name: str,
                                 args: AzureSubscriptionAccountArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def AzureSubscriptionAccount(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 subscription_id: Optional[str] = None,
                                 management_endpoint: Optional[str] = None,
                                 certificate: Optional[str] = None,
                                 certificate_thumbprint: Optional[str] = None,
                                 description: Optional[str] = None,
                                 environments: Optional[Sequence[str]] = None,
                                 azure_environment: Optional[str] = None,
                                 name: Optional[str] = None,
                                 space_id: Optional[str] = None,
                                 storage_endpoint_suffix: Optional[str] = None,
                                 azure_subscription_account_id: Optional[str] = None,
                                 tenant_tags: Optional[Sequence[str]] = None,
                                 tenanted_deployment_participation: Optional[str] = None,
                                 tenants: Optional[Sequence[str]] = None)
    func NewAzureSubscriptionAccount(ctx *Context, name string, args AzureSubscriptionAccountArgs, opts ...ResourceOption) (*AzureSubscriptionAccount, error)
    public AzureSubscriptionAccount(string name, AzureSubscriptionAccountArgs args, CustomResourceOptions? opts = null)
    public AzureSubscriptionAccount(String name, AzureSubscriptionAccountArgs args)
    public AzureSubscriptionAccount(String name, AzureSubscriptionAccountArgs args, CustomResourceOptions options)
    
    type: octopusdeploy:AzureSubscriptionAccount
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AzureSubscriptionAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AzureSubscriptionAccountArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AzureSubscriptionAccountArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzureSubscriptionAccountArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzureSubscriptionAccountArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureSubscriptionAccountResource = new Octopusdeploy.AzureSubscriptionAccount("azureSubscriptionAccountResource", new()
    {
        SubscriptionId = "string",
        ManagementEndpoint = "string",
        Certificate = "string",
        CertificateThumbprint = "string",
        Description = "string",
        Environments = new[]
        {
            "string",
        },
        AzureEnvironment = "string",
        Name = "string",
        SpaceId = "string",
        StorageEndpointSuffix = "string",
        AzureSubscriptionAccountId = "string",
        TenantTags = new[]
        {
            "string",
        },
        TenantedDeploymentParticipation = "string",
        Tenants = new[]
        {
            "string",
        },
    });
    
    example, err := octopusdeploy.NewAzureSubscriptionAccount(ctx, "azureSubscriptionAccountResource", &octopusdeploy.AzureSubscriptionAccountArgs{
    	SubscriptionId:        pulumi.String("string"),
    	ManagementEndpoint:    pulumi.String("string"),
    	Certificate:           pulumi.String("string"),
    	CertificateThumbprint: pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	Environments: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AzureEnvironment:           pulumi.String("string"),
    	Name:                       pulumi.String("string"),
    	SpaceId:                    pulumi.String("string"),
    	StorageEndpointSuffix:      pulumi.String("string"),
    	AzureSubscriptionAccountId: pulumi.String("string"),
    	TenantTags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TenantedDeploymentParticipation: pulumi.String("string"),
    	Tenants: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var azureSubscriptionAccountResource = new AzureSubscriptionAccount("azureSubscriptionAccountResource", AzureSubscriptionAccountArgs.builder()
        .subscriptionId("string")
        .managementEndpoint("string")
        .certificate("string")
        .certificateThumbprint("string")
        .description("string")
        .environments("string")
        .azureEnvironment("string")
        .name("string")
        .spaceId("string")
        .storageEndpointSuffix("string")
        .azureSubscriptionAccountId("string")
        .tenantTags("string")
        .tenantedDeploymentParticipation("string")
        .tenants("string")
        .build());
    
    azure_subscription_account_resource = octopusdeploy.AzureSubscriptionAccount("azureSubscriptionAccountResource",
        subscription_id="string",
        management_endpoint="string",
        certificate="string",
        certificate_thumbprint="string",
        description="string",
        environments=["string"],
        azure_environment="string",
        name="string",
        space_id="string",
        storage_endpoint_suffix="string",
        azure_subscription_account_id="string",
        tenant_tags=["string"],
        tenanted_deployment_participation="string",
        tenants=["string"])
    
    const azureSubscriptionAccountResource = new octopusdeploy.AzureSubscriptionAccount("azureSubscriptionAccountResource", {
        subscriptionId: "string",
        managementEndpoint: "string",
        certificate: "string",
        certificateThumbprint: "string",
        description: "string",
        environments: ["string"],
        azureEnvironment: "string",
        name: "string",
        spaceId: "string",
        storageEndpointSuffix: "string",
        azureSubscriptionAccountId: "string",
        tenantTags: ["string"],
        tenantedDeploymentParticipation: "string",
        tenants: ["string"],
    });
    
    type: octopusdeploy:AzureSubscriptionAccount
    properties:
        azureEnvironment: string
        azureSubscriptionAccountId: string
        certificate: string
        certificateThumbprint: string
        description: string
        environments:
            - string
        managementEndpoint: string
        name: string
        spaceId: string
        storageEndpointSuffix: string
        subscriptionId: string
        tenantTags:
            - string
        tenantedDeploymentParticipation: string
        tenants:
            - string
    

    AzureSubscriptionAccount Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AzureSubscriptionAccount resource accepts the following input properties:

    SubscriptionId string
    The subscription ID of this resource.
    AzureEnvironment string
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    AzureSubscriptionAccountId string
    The ID of this resource.
    Certificate string
    CertificateThumbprint string
    Description string
    The description of this Azure subscription account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    ManagementEndpoint string
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this resource.
    StorageEndpointSuffix string
    The storage endpoint suffix associated with this Azure subscription account.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    SubscriptionId string
    The subscription ID of this resource.
    AzureEnvironment string
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    AzureSubscriptionAccountId string
    The ID of this resource.
    Certificate string
    CertificateThumbprint string
    Description string
    The description of this Azure subscription account.
    Environments []string
    A list of environment IDs associated with this resource.
    ManagementEndpoint string
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this resource.
    StorageEndpointSuffix string
    The storage endpoint suffix associated with this Azure subscription account.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    subscriptionId String
    The subscription ID of this resource.
    azureEnvironment String
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azureSubscriptionAccountId String
    The ID of this resource.
    certificate String
    certificateThumbprint String
    description String
    The description of this Azure subscription account.
    environments List<String>
    A list of environment IDs associated with this resource.
    managementEndpoint String
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this resource.
    storageEndpointSuffix String
    The storage endpoint suffix associated with this Azure subscription account.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    subscriptionId string
    The subscription ID of this resource.
    azureEnvironment string
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azureSubscriptionAccountId string
    The ID of this resource.
    certificate string
    certificateThumbprint string
    description string
    The description of this Azure subscription account.
    environments string[]
    A list of environment IDs associated with this resource.
    managementEndpoint string
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this resource.
    storageEndpointSuffix string
    The storage endpoint suffix associated with this Azure subscription account.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    subscription_id str
    The subscription ID of this resource.
    azure_environment str
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azure_subscription_account_id str
    The ID of this resource.
    certificate str
    certificate_thumbprint str
    description str
    The description of this Azure subscription account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    management_endpoint str
    name str
    The name of this resource.
    space_id str
    The space ID associated with this resource.
    storage_endpoint_suffix str
    The storage endpoint suffix associated with this Azure subscription account.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    subscriptionId String
    The subscription ID of this resource.
    azureEnvironment String
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azureSubscriptionAccountId String
    The ID of this resource.
    certificate String
    certificateThumbprint String
    description String
    The description of this Azure subscription account.
    environments List<String>
    A list of environment IDs associated with this resource.
    managementEndpoint String
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this resource.
    storageEndpointSuffix String
    The storage endpoint suffix associated with this Azure subscription account.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AzureSubscriptionAccount resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AzureSubscriptionAccount Resource

    Get an existing AzureSubscriptionAccount resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AzureSubscriptionAccountState, opts?: CustomResourceOptions): AzureSubscriptionAccount
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            azure_environment: Optional[str] = None,
            azure_subscription_account_id: Optional[str] = None,
            certificate: Optional[str] = None,
            certificate_thumbprint: Optional[str] = None,
            description: Optional[str] = None,
            environments: Optional[Sequence[str]] = None,
            management_endpoint: Optional[str] = None,
            name: Optional[str] = None,
            space_id: Optional[str] = None,
            storage_endpoint_suffix: Optional[str] = None,
            subscription_id: Optional[str] = None,
            tenant_tags: Optional[Sequence[str]] = None,
            tenanted_deployment_participation: Optional[str] = None,
            tenants: Optional[Sequence[str]] = None) -> AzureSubscriptionAccount
    func GetAzureSubscriptionAccount(ctx *Context, name string, id IDInput, state *AzureSubscriptionAccountState, opts ...ResourceOption) (*AzureSubscriptionAccount, error)
    public static AzureSubscriptionAccount Get(string name, Input<string> id, AzureSubscriptionAccountState? state, CustomResourceOptions? opts = null)
    public static AzureSubscriptionAccount get(String name, Output<String> id, AzureSubscriptionAccountState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:AzureSubscriptionAccount    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AzureEnvironment string
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    AzureSubscriptionAccountId string
    The ID of this resource.
    Certificate string
    CertificateThumbprint string
    Description string
    The description of this Azure subscription account.
    Environments List<string>
    A list of environment IDs associated with this resource.
    ManagementEndpoint string
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this resource.
    StorageEndpointSuffix string
    The storage endpoint suffix associated with this Azure subscription account.
    SubscriptionId string
    The subscription ID of this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    AzureEnvironment string
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    AzureSubscriptionAccountId string
    The ID of this resource.
    Certificate string
    CertificateThumbprint string
    Description string
    The description of this Azure subscription account.
    Environments []string
    A list of environment IDs associated with this resource.
    ManagementEndpoint string
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this resource.
    StorageEndpointSuffix string
    The storage endpoint suffix associated with this Azure subscription account.
    SubscriptionId string
    The subscription ID of this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    azureEnvironment String
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azureSubscriptionAccountId String
    The ID of this resource.
    certificate String
    certificateThumbprint String
    description String
    The description of this Azure subscription account.
    environments List<String>
    A list of environment IDs associated with this resource.
    managementEndpoint String
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this resource.
    storageEndpointSuffix String
    The storage endpoint suffix associated with this Azure subscription account.
    subscriptionId String
    The subscription ID of this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    azureEnvironment string
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azureSubscriptionAccountId string
    The ID of this resource.
    certificate string
    certificateThumbprint string
    description string
    The description of this Azure subscription account.
    environments string[]
    A list of environment IDs associated with this resource.
    managementEndpoint string
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this resource.
    storageEndpointSuffix string
    The storage endpoint suffix associated with this Azure subscription account.
    subscriptionId string
    The subscription ID of this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    azure_environment str
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azure_subscription_account_id str
    The ID of this resource.
    certificate str
    certificate_thumbprint str
    description str
    The description of this Azure subscription account.
    environments Sequence[str]
    A list of environment IDs associated with this resource.
    management_endpoint str
    name str
    The name of this resource.
    space_id str
    The space ID associated with this resource.
    storage_endpoint_suffix str
    The storage endpoint suffix associated with this Azure subscription account.
    subscription_id str
    The subscription ID of this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    azureEnvironment String
    The Azure environment associated with this resource. Valid Azure environments are AzureCloud, AzureChinaCloud, AzureGermanCloud, or AzureUSGovernment.
    azureSubscriptionAccountId String
    The ID of this resource.
    certificate String
    certificateThumbprint String
    description String
    The description of this Azure subscription account.
    environments List<String>
    A list of environment IDs associated with this resource.
    managementEndpoint String
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this resource.
    storageEndpointSuffix String
    The storage endpoint suffix associated with this Azure subscription account.
    subscriptionId String
    The subscription ID of this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.

    Import

    $ pulumi import octopusdeploy:index/azureSubscriptionAccount:AzureSubscriptionAccount [options] octopusdeploy_azure_subscription_account.<name> <account-id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs