octopusdeploy 0.43.0, Apr 17 25

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.getDeploymentFreezes

Explore with Pulumi AI

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploylabs/terraform-provider-octopusdeploy

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

const testFreeze = octopusdeploy.getDeploymentFreezes({
    ids: undefined,
    partialName: "Freeze Name",
    skip: 5,
    take: 100,
});
const projectFreezes = octopusdeploy.getDeploymentFreezes({
    projectIds: ["projects-1"],
    skip: 0,
    take: 5,
});
const tenantFreezes = octopusdeploy.getDeploymentFreezes({
    tenantIds: ["tenants-1"],
    skip: 0,
    take: 10,
});

import pulumi
import pulumi_octopusdeploy as octopusdeploy

test_freeze = octopusdeploy.get_deployment_freezes(ids=None,
    partial_name="Freeze Name",
    skip=5,
    take=100)
project_freezes = octopusdeploy.get_deployment_freezes(project_ids=["projects-1"],
    skip=0,
    take=5)
tenant_freezes = octopusdeploy.get_deployment_freezes(tenant_ids=["tenants-1"],
    skip=0,
    take=10)

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.GetDeploymentFreezes(ctx, &octopusdeploy.GetDeploymentFreezesArgs{
			Ids:         nil,
			PartialName: pulumi.StringRef("Freeze Name"),
			Skip:        pulumi.Float64Ref(5),
			Take:        pulumi.Float64Ref(100),
		}, nil)
		if err != nil {
			return err
		}
		_, err = octopusdeploy.GetDeploymentFreezes(ctx, &octopusdeploy.GetDeploymentFreezesArgs{
			ProjectIds: []string{
				"projects-1",
			},
			Skip: pulumi.Float64Ref(0),
			Take: pulumi.Float64Ref(5),
		}, nil)
		if err != nil {
			return err
		}
		_, err = octopusdeploy.GetDeploymentFreezes(ctx, &octopusdeploy.GetDeploymentFreezesArgs{
			TenantIds: []string{
				"tenants-1",
			},
			Skip: pulumi.Float64Ref(0),
			Take: pulumi.Float64Ref(10),
		}, nil)
		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 testFreeze = Octopusdeploy.GetDeploymentFreezes.Invoke(new()
    {
        Ids = null,
        PartialName = "Freeze Name",
        Skip = 5,
        Take = 100,
    });

    var projectFreezes = Octopusdeploy.GetDeploymentFreezes.Invoke(new()
    {
        ProjectIds = new[]
        {
            "projects-1",
        },
        Skip = 0,
        Take = 5,
    });

    var tenantFreezes = Octopusdeploy.GetDeploymentFreezes.Invoke(new()
    {
        TenantIds = new[]
        {
            "tenants-1",
        },
        Skip = 0,
        Take = 10,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetDeploymentFreezesArgs;
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 testFreeze = OctopusdeployFunctions.getDeploymentFreezes(GetDeploymentFreezesArgs.builder()
            .ids(null)
            .partialName("Freeze Name")
            .skip(5)
            .take(100)
            .build());

        final var projectFreezes = OctopusdeployFunctions.getDeploymentFreezes(GetDeploymentFreezesArgs.builder()
            .projectIds("projects-1")
            .skip(0)
            .take(5)
            .build());

        final var tenantFreezes = OctopusdeployFunctions.getDeploymentFreezes(GetDeploymentFreezesArgs.builder()
            .tenantIds("tenants-1")
            .skip(0)
            .take(10)
            .build());

    }
}

variables:
  testFreeze:
    fn::invoke:
      function: octopusdeploy:getDeploymentFreezes
      arguments:
        ids: null
        partialName: Freeze Name
        skip: 5
        take: 100
  projectFreezes:
    fn::invoke:
      function: octopusdeploy:getDeploymentFreezes
      arguments:
        projectIds:
          - projects-1
        skip: 0
        take: 5
  tenantFreezes:
    fn::invoke:
      function: octopusdeploy:getDeploymentFreezes
      arguments:
        tenantIds:
          - tenants-1
        skip: 0
        take: 10

Using getDeploymentFreezes

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 getDeploymentFreezes(args: GetDeploymentFreezesArgs, opts?: InvokeOptions): Promise<GetDeploymentFreezesResult>
function getDeploymentFreezesOutput(args: GetDeploymentFreezesOutputArgs, opts?: InvokeOptions): Output<GetDeploymentFreezesResult>

def get_deployment_freezes(environment_ids: Optional[Sequence[str]] = None,
                           ids: Optional[Sequence[str]] = None,
                           include_complete: Optional[bool] = None,
                           partial_name: Optional[str] = None,
                           project_ids: Optional[Sequence[str]] = None,
                           skip: Optional[float] = None,
                           status: Optional[str] = None,
                           take: Optional[float] = None,
                           tenant_ids: Optional[Sequence[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetDeploymentFreezesResult
def get_deployment_freezes_output(environment_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           include_complete: Optional[pulumi.Input[bool]] = None,
                           partial_name: Optional[pulumi.Input[str]] = None,
                           project_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           skip: Optional[pulumi.Input[float]] = None,
                           status: Optional[pulumi.Input[str]] = None,
                           take: Optional[pulumi.Input[float]] = None,
                           tenant_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentFreezesResult]

func GetDeploymentFreezes(ctx *Context, args *GetDeploymentFreezesArgs, opts ...InvokeOption) (*GetDeploymentFreezesResult, error)
func GetDeploymentFreezesOutput(ctx *Context, args *GetDeploymentFreezesOutputArgs, opts ...InvokeOption) GetDeploymentFreezesResultOutput

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

public static class GetDeploymentFreezes 
{
    public static Task<GetDeploymentFreezesResult> InvokeAsync(GetDeploymentFreezesArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentFreezesResult> Invoke(GetDeploymentFreezesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDeploymentFreezesResult> getDeploymentFreezes(GetDeploymentFreezesArgs args, InvokeOptions options)
public static Output<GetDeploymentFreezesResult> getDeploymentFreezes(GetDeploymentFreezesArgs args, InvokeOptions options)

fn::invoke:
  function: octopusdeploy:index/getDeploymentFreezes:getDeploymentFreezes
  arguments:
    # arguments dictionary

The following arguments are supported:

EnvironmentIds List<string>: A filter to search by a list of environment IDs
Ids List<string>: A filter to search by a list of IDs.
IncludeComplete bool: Include deployment freezes that completed, default is true
PartialName string: A filter to search by a partial name.
ProjectIds List<string>: A filter to search by a list of project IDs
Skip double: A filter to specify the number of items to skip in the response.
Status string: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
Take double: A filter to specify the number of items to take (or return) in the response.
TenantIds List<string>: A filter to search by a list of tenant IDs

EnvironmentIds []string: A filter to search by a list of environment IDs
Ids []string: A filter to search by a list of IDs.
IncludeComplete bool: Include deployment freezes that completed, default is true
PartialName string: A filter to search by a partial name.
ProjectIds []string: A filter to search by a list of project IDs
Skip float64: A filter to specify the number of items to skip in the response.
Status string: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
Take float64: A filter to specify the number of items to take (or return) in the response.
TenantIds []string: A filter to search by a list of tenant IDs

environmentIds List<String>: A filter to search by a list of environment IDs
ids List<String>: A filter to search by a list of IDs.
includeComplete Boolean: Include deployment freezes that completed, default is true
partialName String: A filter to search by a partial name.
projectIds List<String>: A filter to search by a list of project IDs
skip Double: A filter to specify the number of items to skip in the response.
status String: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take Double: A filter to specify the number of items to take (or return) in the response.
tenantIds List<String>: A filter to search by a list of tenant IDs

environmentIds string[]: A filter to search by a list of environment IDs
ids string[]: A filter to search by a list of IDs.
includeComplete boolean: Include deployment freezes that completed, default is true
partialName string: A filter to search by a partial name.
projectIds string[]: A filter to search by a list of project IDs
skip number: A filter to specify the number of items to skip in the response.
status string: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take number: A filter to specify the number of items to take (or return) in the response.
tenantIds string[]: A filter to search by a list of tenant IDs

environment_ids Sequence[str]: A filter to search by a list of environment IDs
ids Sequence[str]: A filter to search by a list of IDs.
include_complete bool: Include deployment freezes that completed, default is true
partial_name str: A filter to search by a partial name.
project_ids Sequence[str]: A filter to search by a list of project IDs
skip float: A filter to specify the number of items to skip in the response.
status str: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take float: A filter to specify the number of items to take (or return) in the response.
tenant_ids Sequence[str]: A filter to search by a list of tenant IDs

environmentIds List<String>: A filter to search by a list of environment IDs
ids List<String>: A filter to search by a list of IDs.
includeComplete Boolean: Include deployment freezes that completed, default is true
partialName String: A filter to search by a partial name.
projectIds List<String>: A filter to search by a list of project IDs
skip Number: A filter to specify the number of items to skip in the response.
status String: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take Number: A filter to specify the number of items to take (or return) in the response.
tenantIds List<String>: A filter to search by a list of tenant IDs

getDeploymentFreezes Result

The following output properties are available:

DeploymentFreezes List<GetDeploymentFreezesDeploymentFreeze>
Id string: The unique ID for this resource.
IncludeComplete bool: Include deployment freezes that completed, default is true
EnvironmentIds List<string>: A filter to search by a list of environment IDs
Ids List<string>: A filter to search by a list of IDs.
PartialName string: A filter to search by a partial name.
ProjectIds List<string>: A filter to search by a list of project IDs
Skip double: A filter to specify the number of items to skip in the response.
Status string: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
Take double: A filter to specify the number of items to take (or return) in the response.
TenantIds List<string>: A filter to search by a list of tenant IDs

DeploymentFreezes []GetDeploymentFreezesDeploymentFreeze
Id string: The unique ID for this resource.
IncludeComplete bool: Include deployment freezes that completed, default is true
EnvironmentIds []string: A filter to search by a list of environment IDs
Ids []string: A filter to search by a list of IDs.
PartialName string: A filter to search by a partial name.
ProjectIds []string: A filter to search by a list of project IDs
Skip float64: A filter to specify the number of items to skip in the response.
Status string: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
Take float64: A filter to specify the number of items to take (or return) in the response.
TenantIds []string: A filter to search by a list of tenant IDs

deploymentFreezes List<GetDeploymentFreezesDeploymentFreeze>
id String: The unique ID for this resource.
includeComplete Boolean: Include deployment freezes that completed, default is true
environmentIds List<String>: A filter to search by a list of environment IDs
ids List<String>: A filter to search by a list of IDs.
partialName String: A filter to search by a partial name.
projectIds List<String>: A filter to search by a list of project IDs
skip Double: A filter to specify the number of items to skip in the response.
status String: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take Double: A filter to specify the number of items to take (or return) in the response.
tenantIds List<String>: A filter to search by a list of tenant IDs

deploymentFreezes GetDeploymentFreezesDeploymentFreeze[]
id string: The unique ID for this resource.
includeComplete boolean: Include deployment freezes that completed, default is true
environmentIds string[]: A filter to search by a list of environment IDs
ids string[]: A filter to search by a list of IDs.
partialName string: A filter to search by a partial name.
projectIds string[]: A filter to search by a list of project IDs
skip number: A filter to specify the number of items to skip in the response.
status string: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take number: A filter to specify the number of items to take (or return) in the response.
tenantIds string[]: A filter to search by a list of tenant IDs

deployment_freezes Sequence[GetDeploymentFreezesDeploymentFreeze]
id str: The unique ID for this resource.
include_complete bool: Include deployment freezes that completed, default is true
environment_ids Sequence[str]: A filter to search by a list of environment IDs
ids Sequence[str]: A filter to search by a list of IDs.
partial_name str: A filter to search by a partial name.
project_ids Sequence[str]: A filter to search by a list of project IDs
skip float: A filter to specify the number of items to skip in the response.
status str: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take float: A filter to specify the number of items to take (or return) in the response.
tenant_ids Sequence[str]: A filter to search by a list of tenant IDs

deploymentFreezes List<Property Map>
id String: The unique ID for this resource.
includeComplete Boolean: Include deployment freezes that completed, default is true
environmentIds List<String>: A filter to search by a list of environment IDs
ids List<String>: A filter to search by a list of IDs.
partialName String: A filter to search by a partial name.
projectIds List<String>: A filter to search by a list of project IDs
skip Number: A filter to specify the number of items to skip in the response.
status String: Filter by the status of the deployment freeze, value values are Expired, Active, Scheduled (case-insensitive)
take Number: A filter to specify the number of items to take (or return) in the response.
tenantIds List<String>: A filter to search by a list of tenant IDs

Supporting Types

GetDeploymentFreezesDeploymentFreeze

End string: The end time of the freeze
Id string: The unique ID for this resource.
Name string: The name of this resource.
ProjectEnvironmentScope Dictionary<string, ImmutableArray<string>>: The project environment scope of the deployment freeze
RecurringSchedule GetDeploymentFreezesDeploymentFreezeRecurringSchedule
Start string: The start time of the freeze
TenantProjectEnvironmentScopes List<GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope>: The tenant project environment scope of the deployment freeze

End string: The end time of the freeze
Id string: The unique ID for this resource.
Name string: The name of this resource.
ProjectEnvironmentScope map[string][]string: The project environment scope of the deployment freeze
RecurringSchedule GetDeploymentFreezesDeploymentFreezeRecurringSchedule
Start string: The start time of the freeze
TenantProjectEnvironmentScopes []GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope: The tenant project environment scope of the deployment freeze

end String: The end time of the freeze
id String: The unique ID for this resource.
name String: The name of this resource.
projectEnvironmentScope Map<String,List<String>>: The project environment scope of the deployment freeze
recurringSchedule GetDeploymentFreezesDeploymentFreezeRecurringSchedule
start String: The start time of the freeze
tenantProjectEnvironmentScopes List<GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope>: The tenant project environment scope of the deployment freeze

end string: The end time of the freeze
id string: The unique ID for this resource.
name string: The name of this resource.
projectEnvironmentScope {[key: string]: string[]}: The project environment scope of the deployment freeze
recurringSchedule GetDeploymentFreezesDeploymentFreezeRecurringSchedule
start string: The start time of the freeze
tenantProjectEnvironmentScopes GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope[]: The tenant project environment scope of the deployment freeze

end str: The end time of the freeze
id str: The unique ID for this resource.
name str: The name of this resource.
project_environment_scope Mapping[str, Sequence[str]]: The project environment scope of the deployment freeze
recurring_schedule GetDeploymentFreezesDeploymentFreezeRecurringSchedule
start str: The start time of the freeze
tenant_project_environment_scopes Sequence[GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope]: The tenant project environment scope of the deployment freeze

end String: The end time of the freeze
id String: The unique ID for this resource.
name String: The name of this resource.
projectEnvironmentScope Map<List<String>>: The project environment scope of the deployment freeze
recurringSchedule Property Map
start String: The start time of the freeze
tenantProjectEnvironmentScopes List<Property Map>: The tenant project environment scope of the deployment freeze

GetDeploymentFreezesDeploymentFreezeRecurringSchedule

DateOfMonth string: The date of the month for monthly schedules
DayNumberOfMonth string: The day number of the month for monthly schedules
DayOfWeek string: The day of the week for monthly schedules
DaysOfWeeks List<string>: List of days of the week for weekly schedules
EndAfterOccurrences double: Number of occurrences after which the schedule should end
EndOnDate string: The date when the recurring schedule should end
EndType string: When the recurring schedule should end (Never, OnDate, AfterOccurrences)
MonthlyScheduleType string: Type of monthly schedule (DayOfMonth, DateOfMonth)
Type string: Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
Unit double: The unit value for the schedule

DateOfMonth string: The date of the month for monthly schedules
DayNumberOfMonth string: The day number of the month for monthly schedules
DayOfWeek string: The day of the week for monthly schedules
DaysOfWeeks []string: List of days of the week for weekly schedules
EndAfterOccurrences float64: Number of occurrences after which the schedule should end
EndOnDate string: The date when the recurring schedule should end
EndType string: When the recurring schedule should end (Never, OnDate, AfterOccurrences)
MonthlyScheduleType string: Type of monthly schedule (DayOfMonth, DateOfMonth)
Type string: Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
Unit float64: The unit value for the schedule

dateOfMonth String: The date of the month for monthly schedules
dayNumberOfMonth String: The day number of the month for monthly schedules
dayOfWeek String: The day of the week for monthly schedules
daysOfWeeks List<String>: List of days of the week for weekly schedules
endAfterOccurrences Double: Number of occurrences after which the schedule should end
endOnDate String: The date when the recurring schedule should end
endType String: When the recurring schedule should end (Never, OnDate, AfterOccurrences)
monthlyScheduleType String: Type of monthly schedule (DayOfMonth, DateOfMonth)
type String: Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
unit Double: The unit value for the schedule

dateOfMonth string: The date of the month for monthly schedules
dayNumberOfMonth string: The day number of the month for monthly schedules
dayOfWeek string: The day of the week for monthly schedules
daysOfWeeks string[]: List of days of the week for weekly schedules
endAfterOccurrences number: Number of occurrences after which the schedule should end
endOnDate string: The date when the recurring schedule should end
endType string: When the recurring schedule should end (Never, OnDate, AfterOccurrences)
monthlyScheduleType string: Type of monthly schedule (DayOfMonth, DateOfMonth)
type string: Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
unit number: The unit value for the schedule

date_of_month str: The date of the month for monthly schedules
day_number_of_month str: The day number of the month for monthly schedules
day_of_week str: The day of the week for monthly schedules
days_of_weeks Sequence[str]: List of days of the week for weekly schedules
end_after_occurrences float: Number of occurrences after which the schedule should end
end_on_date str: The date when the recurring schedule should end
end_type str: When the recurring schedule should end (Never, OnDate, AfterOccurrences)
monthly_schedule_type str: Type of monthly schedule (DayOfMonth, DateOfMonth)
type str: Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
unit float: The unit value for the schedule

dateOfMonth String: The date of the month for monthly schedules
dayNumberOfMonth String: The day number of the month for monthly schedules
dayOfWeek String: The day of the week for monthly schedules
daysOfWeeks List<String>: List of days of the week for weekly schedules
endAfterOccurrences Number: Number of occurrences after which the schedule should end
endOnDate String: The date when the recurring schedule should end
endType String: When the recurring schedule should end (Never, OnDate, AfterOccurrences)
monthlyScheduleType String: Type of monthly schedule (DayOfMonth, DateOfMonth)
type String: Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
unit Number: The unit value for the schedule

GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope

EnvironmentId string: The environment ID
ProjectId string: The project ID
TenantId string: The tenant ID

EnvironmentId string: The environment ID
ProjectId string: The project ID
TenantId string: The tenant ID

environmentId String: The environment ID
projectId String: The project ID
tenantId String: The tenant ID

environmentId string: The environment ID
projectId string: The project ID
tenantId string: The tenant ID

environment_id str: The environment ID
project_id str: The project ID
tenant_id str: The tenant ID

environmentId String: The environment ID
projectId String: The project ID
tenantId String: The tenant ID

Package Details

Repository: octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
License
Notes: This Pulumi package is based on the octopusdeploy Terraform Provider.

octopusdeploy 0.43.0 published on Thursday, Apr 17, 2025 by octopusdeploylabs

octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.getDeploymentFreezes

On this page

On this page

Example Usage

Using getDeploymentFreezes

getDeploymentFreezes Result

Supporting Types

GetDeploymentFreezesDeploymentFreeze

GetDeploymentFreezesDeploymentFreezeRecurringSchedule

GetDeploymentFreezesDeploymentFreezeTenantProjectEnvironmentScope

Package Details

On this page

On this page