Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. DeploymentFreezeTenant
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.DeploymentFreezeTenant

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    Supported by Octopus Server starting from version 2025.1

    Example Usage

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

// Deployment freeze
const example = new octopusdeploy.DeploymentFreeze("example", {
    start: "2024-06-25T00:00:00+10:00",
    end: "2024-06-27T00:00:00+08:00",
});
// Freeze with ids sourced from resources and data sources. 
// Tenants can be sourced from different spaces, a single scope can only reference resources from the same space.
const productionFreeze = new octopusdeploy.DeploymentFreezeTenant("productionFreeze", {
    deploymentfreezeId: example.id,
    tenantId: resource.octopusdeploy_tenant.example.id,
    projectId: resource.octopusdeploy_project.example.id,
    environmentId: data.environments.production.id,
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

# Deployment freeze
example = octopusdeploy.DeploymentFreeze("example",
    start="2024-06-25T00:00:00+10:00",
    end="2024-06-27T00:00:00+08:00")
# Freeze with ids sourced from resources and data sources. 
# Tenants can be sourced from different spaces, a single scope can only reference resources from the same space.
production_freeze = octopusdeploy.DeploymentFreezeTenant("productionFreeze",
    deploymentfreeze_id=example.id,
    tenant_id=resource["octopusdeploy_tenant"]["example"]["id"],
    project_id=resource["octopusdeploy_project"]["example"]["id"],
    environment_id=data["environments"]["production"]["id"])

    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 {
		// Deployment freeze
		example, err := octopusdeploy.NewDeploymentFreeze(ctx, "example", &octopusdeploy.DeploymentFreezeArgs{
			Start: pulumi.String("2024-06-25T00:00:00+10:00"),
			End:   pulumi.String("2024-06-27T00:00:00+08:00"),
		})
		if err != nil {
			return err
		}
		_, err = octopusdeploy.NewDeploymentFreezeTenant(ctx, "productionFreeze", &octopusdeploy.DeploymentFreezeTenantArgs{
			DeploymentfreezeId: example.ID(),
			TenantId:           pulumi.Any(resource.Octopusdeploy_tenant.Example.Id),
			ProjectId:          pulumi.Any(resource.Octopusdeploy_project.Example.Id),
			EnvironmentId:      pulumi.Any(data.Environments.Production.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Deployment freeze
    var example = new Octopusdeploy.DeploymentFreeze("example", new()
    {
        Start = "2024-06-25T00:00:00+10:00",
        End = "2024-06-27T00:00:00+08:00",
    });

    // Freeze with ids sourced from resources and data sources. 
    // Tenants can be sourced from different spaces, a single scope can only reference resources from the same space.
    var productionFreeze = new Octopusdeploy.DeploymentFreezeTenant("productionFreeze", new()
    {
        DeploymentfreezeId = example.Id,
        TenantId = resource.Octopusdeploy_tenant.Example.Id,
        ProjectId = resource.Octopusdeploy_project.Example.Id,
        EnvironmentId = data.Environments.Production.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.DeploymentFreeze;
import com.pulumi.octopusdeploy.DeploymentFreezeArgs;
import com.pulumi.octopusdeploy.DeploymentFreezeTenant;
import com.pulumi.octopusdeploy.DeploymentFreezeTenantArgs;
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) {
        // Deployment freeze
        var example = new DeploymentFreeze("example", DeploymentFreezeArgs.builder()
            .start("2024-06-25T00:00:00+10:00")
            .end("2024-06-27T00:00:00+08:00")
            .build());

        // Freeze with ids sourced from resources and data sources. 
        // Tenants can be sourced from different spaces, a single scope can only reference resources from the same space.
        var productionFreeze = new DeploymentFreezeTenant("productionFreeze", DeploymentFreezeTenantArgs.builder()
            .deploymentfreezeId(example.id())
            .tenantId(resource.octopusdeploy_tenant().example().id())
            .projectId(resource.octopusdeploy_project().example().id())
            .environmentId(data.environments().production().id())
            .build());

    }
}

    resources:
  # Deployment freeze
  example: # Freeze with ids sourced from resources and data sources. 
  # Tenants can be sourced from different spaces, a single scope can only reference resources from the same space.
    type: octopusdeploy:DeploymentFreeze
    properties:
      start: 2024-06-25T00:00:00+10:00
      end: 2024-06-27T00:00:00+08:00
  productionFreeze:
    type: octopusdeploy:DeploymentFreezeTenant
    properties:
      deploymentfreezeId: ${example.id}
      tenantId: ${resource.octopusdeploy_tenant.example.id}
      projectId: ${resource.octopusdeploy_project.example.id}
      environmentId: ${data.environments.production.id}

    Create DeploymentFreezeTenant Resource

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

    Constructor syntax

    new DeploymentFreezeTenant(name: string, args: DeploymentFreezeTenantArgs, opts?: CustomResourceOptions);
    @overload
def DeploymentFreezeTenant(resource_name: str,
                           args: DeploymentFreezeTenantArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def DeploymentFreezeTenant(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           deploymentfreeze_id: Optional[str] = None,
                           environment_id: Optional[str] = None,
                           project_id: Optional[str] = None,
                           tenant_id: Optional[str] = None)
    func NewDeploymentFreezeTenant(ctx *Context, name string, args DeploymentFreezeTenantArgs, opts ...ResourceOption) (*DeploymentFreezeTenant, error)
    public DeploymentFreezeTenant(string name, DeploymentFreezeTenantArgs args, CustomResourceOptions? opts = null)
    public DeploymentFreezeTenant(String name, DeploymentFreezeTenantArgs args)
public DeploymentFreezeTenant(String name, DeploymentFreezeTenantArgs args, CustomResourceOptions options)

    type: octopusdeploy:DeploymentFreezeTenant
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 DeploymentFreezeTenantArgs
    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 DeploymentFreezeTenantArgs
    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 DeploymentFreezeTenantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeploymentFreezeTenantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeploymentFreezeTenantArgs
    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 deploymentFreezeTenantResource = new Octopusdeploy.DeploymentFreezeTenant("deploymentFreezeTenantResource", new()
{
    DeploymentfreezeId = "string",
    EnvironmentId = "string",
    ProjectId = "string",
    TenantId = "string",
});

    example, err := octopusdeploy.NewDeploymentFreezeTenant(ctx, "deploymentFreezeTenantResource", &octopusdeploy.DeploymentFreezeTenantArgs{
	DeploymentfreezeId: pulumi.String("string"),
	EnvironmentId:      pulumi.String("string"),
	ProjectId:          pulumi.String("string"),
	TenantId:           pulumi.String("string"),
})

    var deploymentFreezeTenantResource = new DeploymentFreezeTenant("deploymentFreezeTenantResource", DeploymentFreezeTenantArgs.builder()
    .deploymentfreezeId("string")
    .environmentId("string")
    .projectId("string")
    .tenantId("string")
    .build());

    deployment_freeze_tenant_resource = octopusdeploy.DeploymentFreezeTenant("deploymentFreezeTenantResource",
    deploymentfreeze_id="string",
    environment_id="string",
    project_id="string",
    tenant_id="string")

    const deploymentFreezeTenantResource = new octopusdeploy.DeploymentFreezeTenant("deploymentFreezeTenantResource", {
    deploymentfreezeId: "string",
    environmentId: "string",
    projectId: "string",
    tenantId: "string",
});

    type: octopusdeploy:DeploymentFreezeTenant
properties:
    deploymentfreezeId: string
    environmentId: string
    projectId: string
    tenantId: string

    DeploymentFreezeTenant 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 DeploymentFreezeTenant resource accepts the following input properties:

    DeploymentfreezeId string
    The deployment freeze ID associated with this freeze scope.
    EnvironmentId string
    The environment ID associated with this freeze scope.
    ProjectId string
    The project ID associated with this freeze scope.
    TenantId string
    The tenant ID associated with this freeze scope.
    DeploymentfreezeId string
    The deployment freeze ID associated with this freeze scope.
    EnvironmentId string
    The environment ID associated with this freeze scope.
    ProjectId string
    The project ID associated with this freeze scope.
    TenantId string
    The tenant ID associated with this freeze scope.
    deploymentfreezeId String
    The deployment freeze ID associated with this freeze scope.
    environmentId String
    The environment ID associated with this freeze scope.
    projectId String
    The project ID associated with this freeze scope.
    tenantId String
    The tenant ID associated with this freeze scope.
    deploymentfreezeId string
    The deployment freeze ID associated with this freeze scope.
    environmentId string
    The environment ID associated with this freeze scope.
    projectId string
    The project ID associated with this freeze scope.
    tenantId string
    The tenant ID associated with this freeze scope.
    deploymentfreeze_id str
    The deployment freeze ID associated with this freeze scope.
    environment_id str
    The environment ID associated with this freeze scope.
    project_id str
    The project ID associated with this freeze scope.
    tenant_id str
    The tenant ID associated with this freeze scope.
    deploymentfreezeId String
    The deployment freeze ID associated with this freeze scope.
    environmentId String
    The environment ID associated with this freeze scope.
    projectId String
    The project ID associated with this freeze scope.
    tenantId String
    The tenant ID associated with this freeze scope.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DeploymentFreezeTenant 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 DeploymentFreezeTenant Resource

    Get an existing DeploymentFreezeTenant 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?: DeploymentFreezeTenantState, opts?: CustomResourceOptions): DeploymentFreezeTenant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deploymentfreeze_id: Optional[str] = None,
        environment_id: Optional[str] = None,
        project_id: Optional[str] = None,
        tenant_id: Optional[str] = None) -> DeploymentFreezeTenant
    func GetDeploymentFreezeTenant(ctx *Context, name string, id IDInput, state *DeploymentFreezeTenantState, opts ...ResourceOption) (*DeploymentFreezeTenant, error)
    public static DeploymentFreezeTenant Get(string name, Input<string> id, DeploymentFreezeTenantState? state, CustomResourceOptions? opts = null)
    public static DeploymentFreezeTenant get(String name, Output<String> id, DeploymentFreezeTenantState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:DeploymentFreezeTenant    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:
    DeploymentfreezeId string
    The deployment freeze ID associated with this freeze scope.
    EnvironmentId string
    The environment ID associated with this freeze scope.
    ProjectId string
    The project ID associated with this freeze scope.
    TenantId string
    The tenant ID associated with this freeze scope.
    DeploymentfreezeId string
    The deployment freeze ID associated with this freeze scope.
    EnvironmentId string
    The environment ID associated with this freeze scope.
    ProjectId string
    The project ID associated with this freeze scope.
    TenantId string
    The tenant ID associated with this freeze scope.
    deploymentfreezeId String
    The deployment freeze ID associated with this freeze scope.
    environmentId String
    The environment ID associated with this freeze scope.
    projectId String
    The project ID associated with this freeze scope.
    tenantId String
    The tenant ID associated with this freeze scope.
    deploymentfreezeId string
    The deployment freeze ID associated with this freeze scope.
    environmentId string
    The environment ID associated with this freeze scope.
    projectId string
    The project ID associated with this freeze scope.
    tenantId string
    The tenant ID associated with this freeze scope.
    deploymentfreeze_id str
    The deployment freeze ID associated with this freeze scope.
    environment_id str
    The environment ID associated with this freeze scope.
    project_id str
    The project ID associated with this freeze scope.
    tenant_id str
    The tenant ID associated with this freeze scope.
    deploymentfreezeId String
    The deployment freeze ID associated with this freeze scope.
    environmentId String
    The environment ID associated with this freeze scope.
    projectId String
    The project ID associated with this freeze scope.
    tenantId String
    The tenant ID associated with this freeze scope.

    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.2 published on Friday, May 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy