Class Job.Deployment
- Namespace
- Invex.StructuredText.AzureDevopsPipelines.DevopsPipelineModel.Jobs
- Assembly
- Invex.StructuredText.AzureDevopsPipelines.dll
A deployment job is a special type of job for deployment scenarios.
public sealed record Job.Deployment : Job
- Inheritance
-
objectJob.Deployment
Constructors
Deployment()
public Deployment()
Properties
CancelTimeoutInMinutes
Time to wait for the job to cancel before forcibly terminating it.
public Template? CancelTimeoutInMinutes { get; init; }
Property Value
Condition
Evaluate this condition expression to determine whether to run this deployment.
public BoolExpr? Condition { get; init; }
Property Value
Container
Container resource name.
public JobContainer? Container { get; init; }
Property Value
ContinueOnError
Continue running even on failure?
public Template? ContinueOnError { get; init; }
Property Value
DependsOn
Any jobs which must complete before this one.
public IReadOnlyList<Template>? DependsOn { get; init; }
Property Value
- IReadOnlyList<Template>
DeploymentId
ID of the deployment job. Valid names may only contain alphanumeric characters and '_' and may not start with a number.
public required Template DeploymentId { get; init; }
Property Value
DisplayName
Human-readable name for the deployment.
public Template? DisplayName { get; init; }
Property Value
Environment
Target environment for the deployment.
public required DeploymentEnvironment Environment { get; init; }
Property Value
Pool
Pool where this deployment job will run.
public Pool? Pool { get; init; }
Property Value
Services
Container resources to run as a service container.
public IReadOnlyDictionary<string, Template>? Services { get; init; }
Property Value
- IReadOnlyDictionary<string, Template>
Strategy
Deployment strategy (runOnce, rolling, or canary).
public required DeploymentStrategy Strategy { get; init; }
Property Value
TemplateContext
Deployment related information passed from a pipeline when extending a template.
public IReadOnlyDictionary<string, Template>? TemplateContext { get; init; }
Property Value
- IReadOnlyDictionary<string, Template>
TimeoutInMinutes
Time to wait for this job to complete before the server kills it.
public Template? TimeoutInMinutes { get; init; }
Property Value
Uses
Any resources required by this job that are not already referenced.
public ExplicitResources? Uses { get; init; }
Property Value
Variables
Deployment-specific variables.
public Variables? Variables { get; init; }
Property Value
Workspace
Workspace options on the agent.
public Workspace? Workspace { get; init; }
Property Value
Methods
Match(Action<RegularJob>, Action<Deployment>, Action<Template>)
public override void Match(Action<Job.RegularJob> regularJob, Action<Job.Deployment> deployment, Action<Job.Template> template)
Parameters
regularJobAction<Job.RegularJob>deploymentAction<Job.Deployment>templateAction<Job.Template>
MatchDeployment(Action<Deployment>, Action)
public override void MatchDeployment(Action<Job.Deployment> deployment, Action @else)
Parameters
deploymentAction<Job.Deployment>elseAction
MatchDeployment<TMatchOutput>(Func<Deployment, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchDeployment<TMatchOutput>(Func<Job.Deployment, TMatchOutput> deployment, Func<TMatchOutput> @else)
Parameters
deploymentFunc<Job.Deployment, TMatchOutput>elseFunc<TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchDeployment<TState>(TState, Action<TState, Deployment>, Action<TState>)
public override void MatchDeployment<TState>(TState state, Action<TState, Job.Deployment> deployment, Action<TState> @else)
Parameters
stateTStatedeploymentAction<TState, Job.Deployment>elseAction<TState>
Type Parameters
TState
MatchDeployment<TState, TMatchOutput>(TState, Func<TState, Deployment, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchDeployment<TState, TMatchOutput>(TState state, Func<TState, Job.Deployment, TMatchOutput> deployment, Func<TState, TMatchOutput> @else)
Parameters
stateTStatedeploymentFunc<TState, Job.Deployment, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchRegularJob(Action<RegularJob>, Action)
public override void MatchRegularJob(Action<Job.RegularJob> regularJob, Action @else)
Parameters
regularJobAction<Job.RegularJob>elseAction
MatchRegularJob<TMatchOutput>(Func<RegularJob, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchRegularJob<TMatchOutput>(Func<Job.RegularJob, TMatchOutput> regularJob, Func<TMatchOutput> @else)
Parameters
regularJobFunc<Job.RegularJob, TMatchOutput>elseFunc<TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchRegularJob<TState>(TState, Action<TState, RegularJob>, Action<TState>)
public override void MatchRegularJob<TState>(TState state, Action<TState, Job.RegularJob> regularJob, Action<TState> @else)
Parameters
stateTStateregularJobAction<TState, Job.RegularJob>elseAction<TState>
Type Parameters
TState
MatchRegularJob<TState, TMatchOutput>(TState, Func<TState, RegularJob, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchRegularJob<TState, TMatchOutput>(TState state, Func<TState, Job.RegularJob, TMatchOutput> regularJob, Func<TState, TMatchOutput> @else)
Parameters
stateTStateregularJobFunc<TState, Job.RegularJob, TMatchOutput>elseFunc<TState, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
MatchTemplate(Action<Template>, Action)
public override void MatchTemplate(Action<Job.Template> template, Action @else)
Parameters
MatchTemplate<TMatchOutput>(Func<Template, TMatchOutput>, Func<TMatchOutput>)
public override TMatchOutput MatchTemplate<TMatchOutput>(Func<Job.Template, TMatchOutput> template, Func<TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TMatchOutput
MatchTemplate<TState>(TState, Action<TState, Template>, Action<TState>)
public override void MatchTemplate<TState>(TState state, Action<TState, Job.Template> template, Action<TState> @else)
Parameters
Type Parameters
TState
MatchTemplate<TState, TMatchOutput>(TState, Func<TState, Template, TMatchOutput>, Func<TState, TMatchOutput>)
public override TMatchOutput MatchTemplate<TState, TMatchOutput>(TState state, Func<TState, Job.Template, TMatchOutput> template, Func<TState, TMatchOutput> @else)
Parameters
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
Match<TMatchOutput>(Func<RegularJob, TMatchOutput>, Func<Deployment, TMatchOutput>, Func<Template, TMatchOutput>)
public override TMatchOutput Match<TMatchOutput>(Func<Job.RegularJob, TMatchOutput> regularJob, Func<Job.Deployment, TMatchOutput> deployment, Func<Job.Template, TMatchOutput> template)
Parameters
regularJobFunc<Job.RegularJob, TMatchOutput>deploymentFunc<Job.Deployment, TMatchOutput>templateFunc<Job.Template, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TMatchOutput
Match<TState>(TState, Action<TState, RegularJob>, Action<TState, Deployment>, Action<TState, Template>)
public override void Match<TState>(TState state, Action<TState, Job.RegularJob> regularJob, Action<TState, Job.Deployment> deployment, Action<TState, Job.Template> template)
Parameters
stateTStateregularJobAction<TState, Job.RegularJob>deploymentAction<TState, Job.Deployment>templateAction<TState, Job.Template>
Type Parameters
TState
Match<TState, TMatchOutput>(TState, Func<TState, RegularJob, TMatchOutput>, Func<TState, Deployment, TMatchOutput>, Func<TState, Template, TMatchOutput>)
public override TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, Job.RegularJob, TMatchOutput> regularJob, Func<TState, Job.Deployment, TMatchOutput> deployment, Func<TState, Job.Template, TMatchOutput> template)
Parameters
stateTStateregularJobFunc<TState, Job.RegularJob, TMatchOutput>deploymentFunc<TState, Job.Deployment, TMatchOutput>templateFunc<TState, Job.Template, TMatchOutput>
Returns
- TMatchOutput
Type Parameters
TStateTMatchOutput
UnwrapDeployment()
public override Job.Deployment UnwrapDeployment()
Returns
UnwrapRegularJob()
public override Job.RegularJob UnwrapRegularJob()
Returns
UnwrapTemplate()
public override Job.Template UnwrapTemplate()