Show / Hide Table of Contents

    Class JobStep

    A job step.

    Inheritance
    Object
    Resource
    ProxyResource
    JobStep
    Inherited Members
    Resource.Id
    Resource.Name
    Resource.Type
    Namespace: System.Dynamic.ExpandoObject
    Assembly: Microsoft.Azure.Management.Sql.dll
    Syntax
    [Microsoft.Rest.Serialization.JsonTransformation]
    public class JobStep : Microsoft.Azure.Management.Sql.Models.ProxyResource

    Constructors

    JobStep()

    Initializes a new instance of the JobStep class.

    Declaration
    public JobStep ();

    JobStep(String, String, JobStepAction, String, String, String, Nullable<Int32>, JobStepOutput, JobStepExecutionOptions)

    Initializes a new instance of the JobStep class.

    Declaration
    public JobStep (string targetGroup, string credential, Microsoft.Azure.Management.Sql.Models.JobStepAction action, string id = null, string name = null, string type = null, Nullable<int> stepId = null, Microsoft.Azure.Management.Sql.Models.JobStepOutput output = null, Microsoft.Azure.Management.Sql.Models.JobStepExecutionOptions executionOptions = null);
    Parameters
    String targetGroup

    The resource ID of the target group that the job step will be executed on.

    String credential

    The resource ID of the job credential that will be used to connect to the targets.

    JobStepAction action

    The action payload of the job step.

    String id

    Resource ID.

    String name

    Resource name.

    String type

    Resource type.

    Nullable<Int32> stepId

    The job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.

    JobStepOutput output

    Output destination properties of the job step.

    JobStepExecutionOptions executionOptions

    Execution options for the job step.

    Properties

    Action

    Gets or sets the action payload of the job step.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.action")]
    public Microsoft.Azure.Management.Sql.Models.JobStepAction Action { get; set; }
    Property Value
    JobStepAction

    Credential

    Gets or sets the resource ID of the job credential that will be used to connect to the targets.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.credential")]
    public string Credential { get; set; }
    Property Value
    String

    ExecutionOptions

    Gets or sets execution options for the job step.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.executionOptions")]
    public Microsoft.Azure.Management.Sql.Models.JobStepExecutionOptions ExecutionOptions { get; set; }
    Property Value
    JobStepExecutionOptions

    Output

    Gets or sets output destination properties of the job step.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.output")]
    public Microsoft.Azure.Management.Sql.Models.JobStepOutput Output { get; set; }
    Property Value
    JobStepOutput

    StepId

    Gets or sets the job step's index within the job. If not specified when creating the job step, it will be created as the last step. If not specified when updating the job step, the step id is not modified.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.stepId")]
    public Nullable<int> StepId { get; set; }
    Property Value
    Nullable<Int32>

    TargetGroup

    Gets or sets the resource ID of the target group that the job step will be executed on.

    Declaration
    [Newtonsoft.Json.JsonProperty(PropertyName="properties.targetGroup")]
    public string TargetGroup { get; set; }
    Property Value
    String

    Methods

    Validate()

    Validate the object.

    Declaration
    public virtual void Validate ();
    Exceptions
    ValidationException

    Thrown if validation fails

    Back to top Azure SDK for Net