octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
octopusdeploy.getDeploymentFreezes
octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs
Provides information about deployment freezes
Example Usage
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.
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:
- Environment
Ids List<string> - A filter to search by a list of environment IDs
- Ids List<string>
- A filter to search by a list of IDs.
- Include
Complete bool - Include deployment freezes that completed, default is true
- Partial
Name string - A filter to search by a partial name.
- Project
Ids 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.
- Tenant
Ids List<string> - A filter to search by a list of tenant IDs
- Environment
Ids []string - A filter to search by a list of environment IDs
- Ids []string
- A filter to search by a list of IDs.
- Include
Complete bool - Include deployment freezes that completed, default is true
- Partial
Name string - A filter to search by a partial name.
- Project
Ids []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.
- Tenant
Ids []string - A filter to search by a list of tenant IDs
- environment
Ids List<String> - A filter to search by a list of environment IDs
- ids List<String>
- A filter to search by a list of IDs.
- include
Complete Boolean - Include deployment freezes that completed, default is true
- partial
Name String - A filter to search by a partial name.
- project
Ids 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.
- tenant
Ids List<String> - A filter to search by a list of tenant IDs
- environment
Ids string[] - A filter to search by a list of environment IDs
- ids string[]
- A filter to search by a list of IDs.
- include
Complete boolean - Include deployment freezes that completed, default is true
- partial
Name string - A filter to search by a partial name.
- project
Ids 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.
- tenant
Ids 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
- environment
Ids List<String> - A filter to search by a list of environment IDs
- ids List<String>
- A filter to search by a list of IDs.
- include
Complete Boolean - Include deployment freezes that completed, default is true
- partial
Name String - A filter to search by a partial name.
- project
Ids 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.
- tenant
Ids List<String> - A filter to search by a list of tenant IDs
getDeploymentFreezes Result
The following output properties are available:
- Deployment
Freezes List<GetDeployment Freezes Deployment Freeze> - Id string
- The unique ID for this resource.
- Include
Complete bool - Include deployment freezes that completed, default is true
- Environment
Ids List<string> - A filter to search by a list of environment IDs
- Ids List<string>
- A filter to search by a list of IDs.
- Partial
Name string - A filter to search by a partial name.
- Project
Ids 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.
- Tenant
Ids List<string> - A filter to search by a list of tenant IDs
- Deployment
Freezes []GetDeployment Freezes Deployment Freeze - Id string
- The unique ID for this resource.
- Include
Complete bool - Include deployment freezes that completed, default is true
- Environment
Ids []string - A filter to search by a list of environment IDs
- Ids []string
- A filter to search by a list of IDs.
- Partial
Name string - A filter to search by a partial name.
- Project
Ids []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.
- Tenant
Ids []string - A filter to search by a list of tenant IDs
- deployment
Freezes List<GetDeployment Freezes Deployment Freeze> - id String
- The unique ID for this resource.
- include
Complete Boolean - Include deployment freezes that completed, default is true
- environment
Ids List<String> - A filter to search by a list of environment IDs
- ids List<String>
- A filter to search by a list of IDs.
- partial
Name String - A filter to search by a partial name.
- project
Ids 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.
- tenant
Ids List<String> - A filter to search by a list of tenant IDs
- deployment
Freezes GetDeployment Freezes Deployment Freeze[] - id string
- The unique ID for this resource.
- include
Complete boolean - Include deployment freezes that completed, default is true
- environment
Ids string[] - A filter to search by a list of environment IDs
- ids string[]
- A filter to search by a list of IDs.
- partial
Name string - A filter to search by a partial name.
- project
Ids 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.
- tenant
Ids string[] - A filter to search by a list of tenant IDs
- deployment_
freezes Sequence[GetDeployment Freezes Deployment Freeze] - 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
- deployment
Freezes List<Property Map> - id String
- The unique ID for this resource.
- include
Complete Boolean - Include deployment freezes that completed, default is true
- environment
Ids List<String> - A filter to search by a list of environment IDs
- ids List<String>
- A filter to search by a list of IDs.
- partial
Name String - A filter to search by a partial name.
- project
Ids 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.
- tenant
Ids 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.
- Project
Environment Dictionary<string, ImmutableScope Array<string>> - The project environment scope of the deployment freeze
- Recurring
Schedule GetDeployment Freezes Deployment Freeze Recurring Schedule - Start string
- The start time of the freeze
- Tenant
Project List<GetEnvironment Scopes Deployment Freezes Deployment Freeze Tenant Project Environment Scope> - 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.
- Project
Environment map[string][]stringScope - The project environment scope of the deployment freeze
- Recurring
Schedule GetDeployment Freezes Deployment Freeze Recurring Schedule - Start string
- The start time of the freeze
- Tenant
Project []GetEnvironment Scopes Deployment Freezes Deployment Freeze Tenant Project Environment Scope - 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.
- project
Environment Map<String,List<String>>Scope - The project environment scope of the deployment freeze
- recurring
Schedule GetDeployment Freezes Deployment Freeze Recurring Schedule - start String
- The start time of the freeze
- tenant
Project List<GetEnvironment Scopes Deployment Freezes Deployment Freeze Tenant Project Environment Scope> - 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.
- project
Environment {[key: string]: string[]}Scope - The project environment scope of the deployment freeze
- recurring
Schedule GetDeployment Freezes Deployment Freeze Recurring Schedule - start string
- The start time of the freeze
- tenant
Project GetEnvironment Scopes Deployment Freezes Deployment Freeze Tenant Project Environment Scope[] - 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_ Mapping[str, Sequence[str]]scope - The project environment scope of the deployment freeze
- recurring_
schedule GetDeployment Freezes Deployment Freeze Recurring Schedule - start str
- The start time of the freeze
- tenant_
project_ Sequence[Getenvironment_ scopes Deployment Freezes Deployment Freeze Tenant Project Environment Scope] - 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.
- project
Environment Map<List<String>>Scope - The project environment scope of the deployment freeze
- recurring
Schedule Property Map - start String
- The start time of the freeze
- tenant
Project List<Property Map>Environment Scopes - The tenant project environment scope of the deployment freeze
GetDeploymentFreezesDeploymentFreezeRecurringSchedule
- Date
Of stringMonth - The date of the month for monthly schedules
- Day
Number stringOf Month - The day number of the month for monthly schedules
- Day
Of stringWeek - The day of the week for monthly schedules
- Days
Of List<string>Weeks - List of days of the week for weekly schedules
- End
After doubleOccurrences - Number of occurrences after which the schedule should end
- End
On stringDate - The date when the recurring schedule should end
- End
Type string - When the recurring schedule should end (Never, OnDate, AfterOccurrences)
- Monthly
Schedule stringType - Type of monthly schedule (DayOfMonth, DateOfMonth)
- Type string
- Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
- Unit double
- The unit value for the schedule
- Date
Of stringMonth - The date of the month for monthly schedules
- Day
Number stringOf Month - The day number of the month for monthly schedules
- Day
Of stringWeek - The day of the week for monthly schedules
- Days
Of []stringWeeks - List of days of the week for weekly schedules
- End
After float64Occurrences - Number of occurrences after which the schedule should end
- End
On stringDate - The date when the recurring schedule should end
- End
Type string - When the recurring schedule should end (Never, OnDate, AfterOccurrences)
- Monthly
Schedule stringType - Type of monthly schedule (DayOfMonth, DateOfMonth)
- Type string
- Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
- Unit float64
- The unit value for the schedule
- date
Of StringMonth - The date of the month for monthly schedules
- day
Number StringOf Month - The day number of the month for monthly schedules
- day
Of StringWeek - The day of the week for monthly schedules
- days
Of List<String>Weeks - List of days of the week for weekly schedules
- end
After DoubleOccurrences - Number of occurrences after which the schedule should end
- end
On StringDate - The date when the recurring schedule should end
- end
Type String - When the recurring schedule should end (Never, OnDate, AfterOccurrences)
- monthly
Schedule StringType - Type of monthly schedule (DayOfMonth, DateOfMonth)
- type String
- Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
- unit Double
- The unit value for the schedule
- date
Of stringMonth - The date of the month for monthly schedules
- day
Number stringOf Month - The day number of the month for monthly schedules
- day
Of stringWeek - The day of the week for monthly schedules
- days
Of string[]Weeks - List of days of the week for weekly schedules
- end
After numberOccurrences - Number of occurrences after which the schedule should end
- end
On stringDate - The date when the recurring schedule should end
- end
Type string - When the recurring schedule should end (Never, OnDate, AfterOccurrences)
- monthly
Schedule stringType - 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_ strmonth - The date of the month for monthly schedules
- day_
number_ strof_ month - The day number of the month for monthly schedules
- day_
of_ strweek - The day of the week for monthly schedules
- days_
of_ Sequence[str]weeks - List of days of the week for weekly schedules
- end_
after_ floatoccurrences - Number of occurrences after which the schedule should end
- end_
on_ strdate - The date when the recurring schedule should end
- end_
type str - When the recurring schedule should end (Never, OnDate, AfterOccurrences)
- monthly_
schedule_ strtype - Type of monthly schedule (DayOfMonth, DateOfMonth)
- type str
- Type of recurring schedule (OnceDaily, DaysPerWeek, DaysPerMonth, Annually)
- unit float
- The unit value for the schedule
- date
Of StringMonth - The date of the month for monthly schedules
- day
Number StringOf Month - The day number of the month for monthly schedules
- day
Of StringWeek - The day of the week for monthly schedules
- days
Of List<String>Weeks - List of days of the week for weekly schedules
- end
After NumberOccurrences - Number of occurrences after which the schedule should end
- end
On StringDate - The date when the recurring schedule should end
- end
Type String - When the recurring schedule should end (Never, OnDate, AfterOccurrences)
- monthly
Schedule StringType - 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
- Environment
Id string - The environment ID
- Project
Id string - The project ID
- Tenant
Id string - The tenant ID
- Environment
Id string - The environment ID
- Project
Id string - The project ID
- Tenant
Id string - The tenant ID
- environment
Id String - The environment ID
- project
Id String - The project ID
- tenant
Id String - The tenant ID
- environment
Id string - The environment ID
- project
Id string - The project ID
- tenant
Id string - The tenant ID
- environment_
id str - The environment ID
- project_
id str - The project ID
- tenant_
id str - The tenant ID
- environment
Id String - The environment ID
- project
Id String - The project ID
- tenant
Id 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.2 published on Friday, May 30, 2025 by octopusdeploylabs