Class JobTarget

A job target, for example a specific database or a container of databases that is evaluated during job execution.

Inheritance

Object

JobTarget

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.Management.Sql.dll

Syntax

public class JobTarget

Constructors

JobTarget()

Initializes a new instance of the JobTarget class.

Declaration

public JobTarget ();

JobTarget(String, Nullable<JobTargetGroupMembershipType>, String, String, String, String, String)

Initializes a new instance of the JobTarget class.

Declaration

public JobTarget (string type, Nullable<Microsoft.Azure.Management.Sql.Models.JobTargetGroupMembershipType> membershipType = null, string serverName = null, string databaseName = null, string elasticPoolName = null, string shardMapName = null, string refreshCredential = null);

Parameters

String type The target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'

Nullable<JobTargetGroupMembershipType> membershipType Whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'

String serverName The target server name.

String databaseName The target database name.

String elasticPoolName The target elastic pool name.

String shardMapName The target shard map.

String refreshCredential The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target.

Properties

DatabaseName

Gets or sets the target database name.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="databaseName")]
public string DatabaseName { get; set; }

Property Value

String

ElasticPoolName

Gets or sets the target elastic pool name.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="elasticPoolName")]
public string ElasticPoolName { get; set; }

Property Value

String

MembershipType

Gets or sets whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="membershipType")]
public Nullable<Microsoft.Azure.Management.Sql.Models.JobTargetGroupMembershipType> MembershipType { get; set; }

Property Value

Nullable<JobTargetGroupMembershipType>

RefreshCredential

Gets or sets the resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="refreshCredential")]
public string RefreshCredential { get; set; }

Property Value

String

ServerName

Gets or sets the target server name.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="serverName")]
public string ServerName { get; set; }

Property Value

String

ShardMapName

Gets or sets the target shard map.

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="shardMapName")]
public string ShardMapName { get; set; }

Property Value

String

Type

Gets or sets the target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'

Declaration

[Newtonsoft.Json.JsonProperty(PropertyName="type")]
public string Type { get; set; }

Property Value

String

Methods

Validate()

Validate the object.

Declaration

public virtual void Validate ();

Exceptions

ValidationException Thrown if validation fails