Compartilhar via

  • Artigo

Classe JobStep

The JobStep class represents a Microsoft SQL Server job step.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (em Microsoft.SqlServer.Smo.dll)

Sintaxe

'Declaração
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Uso
Dim instance As JobStep

[SfcElementTypeAttribute("Step")]
public sealed class JobStep : AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[SfcElementTypeAttribute(L"Step")]
public ref class JobStep sealed : public AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Step")>]
type JobStep =  
    class
        inherit AgentObjectBase
        interface IAlterable
        interface ICreatable
        interface IDroppable
        interface IRenamable
        interface IScriptable
    end

public final class JobStep extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

O tipo JobStep expõe os membros a seguir.

Construtores

  Nome Descrição
Método público JobStep() () () () Initializes a new instance of the JobStep class.
Método público JobStep(Job, String) Initializes a new instance of the JobStep class for the specified job and with the specified name.

Início

Propriedades

  Nome Descrição
Propriedade pública Command Gets or sets the command execution string for the job step.
Propriedade pública CommandExecutionSuccessCode Gets or sets the process exit code from a command shell process executed as a job step.
Propriedade pública DatabaseName Gets or sets the name of the database to which the job step command execution is confined.
Propriedade pública DatabaseUserName Gets or sets the database user account that the job step assumes when executing the command string.
Propriedade protegida ExecuteForScalar Obtém ou define o valor da propriedade Boolean que especifica se o objeto esta definido para a opção execute for scalar. (Herdado de SqlSmoObject.)
Propriedade pública ID Gets or sets the ID value that uniquely identifies the job step.
Propriedade protegida IsTouched Obtém o valor da propriedade Boolean que especifica se as propriedades do objeto foram atualizadas, mas ainda não foram persistidas no servidor. (Herdado de SqlSmoObject.)
Propriedade pública JobStepFlags The JobStepFlags property is reserved for future use.
Propriedade pública LastRunDate Gets the date and time when the job step was last executed.
Propriedade pública LastRunDuration Gets the time that the referenced job step took to run when it was last executed.
Propriedade pública LastRunOutcome Gets the outcome of the job step when it was last executed.
Propriedade pública LastRunRetries Gets the number of retries that were attempted when the job step was last executed.
Propriedade pública Name Gets or sets the name of the object. (Herdado de NamedSmoObject.)
Propriedade protegida ObjectInSpace Obtém o valor da propriedade Boolean que especifica se o objeto existe em isolamento ou se está direta ou indiretamente conectado com a instância do SQL Server. (Herdado de SqlSmoObject.)
Propriedade pública OnFailAction Gets or sets the action to take when the job step finishes execution with failure.
Propriedade pública OnFailStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure.
Propriedade pública OnSuccessAction Gets or sets the action to take when the job step finishes execution with success.
Propriedade pública OnSuccessStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success.
Propriedade pública OSRunPriority Gets or sets the execution thread scheduling for job steps executing operating system tasks.
Propriedade pública OutputFileName Gets or sets the name and path of the operating system file that records job step result message text.
Propriedade pública Parent Gets or sets the Job object that is the parent of the JobStep object.
Propriedade pública Properties Obtém uma coleção de objetos Property que representam as propriedades do objeto. (Herdado de SqlSmoObject.)
Propriedade pública ProxyName Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step.
Propriedade pública RetryAttempts Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure.
Propriedade pública RetryInterval Gets or sets the number of minutes that Microsoft SQL Server Agent waits before trying to execute a job step that has previously failed.
Propriedade protegida ScalarResult Obtém o resultado escalar do objeto referenciado. (Herdado de SqlSmoObject.)
Propriedade pública Server Gets or sets the name of the server on which the job step runs.
Propriedade pública State Gets the state of the referenced object. (Herdado de SmoObjectBase.)
Propriedade pública SubSystem Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.
Propriedade pública Urn Obtém o valor do endereço do URN (Uniform Resource Name) que identifica exclusivamente o objeto. (Herdado de SqlSmoObject.)
Propriedade pública UserData Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.)

Início

Métodos

  Nome Descrição
Método protegido AddDatabaseContext(StringCollection) Adiciona o contexto do banco de dados à coleção de consultas identificadas pelo parâmetro queries. (Herdado de SqlSmoObject.)
Método protegido AddDatabaseContext(StringCollection, ScriptingOptions) Adiciona o contexto de banco de dados à coleção de consultas identificadas pelo parâmetro queries e usando as opções de script especificadas. (Herdado de SqlSmoObject.)
Método público Alter Updates any JobStep object property changes on instance of Microsoft SQL Server. 
Método protegido AlterImpl Ativa o evento alterado do objeto. (Herdado de SqlSmoObject.)
Método protegido AlterImplFinish Método chamado quando o evento alterado do objeto é concluído. (Herdado de SqlSmoObject.)
Método protegido AlterImplInit Método chamado quando o evento de alteração do objeto é inicializado. (Herdado de SqlSmoObject.)
Método protegido AlterImplWorker Chama os métodos Alter. (Herdado de SqlSmoObject.)
Método protegido BindDefaultImpl Associa os itens padrão identificados pelos parâmetros. (Herdado de SqlSmoObject.)
Método protegido BindRuleImpl Associa o esquema de regra à regra e às colunas identificadas pelos parâmetros. (Herdado de SqlSmoObject.)
Método protegido CheckCollation Verifica a ordem das opções de script pelo método de agrupamento identificado pelo parâmetro collationName. (Herdado de SqlSmoObject.)
Método protegido CheckObjectState() () () () Valida o estado do objeto referenciado. (Herdado de SqlSmoObject.)
Método protegido CheckObjectState(Boolean) Valida o estado do objeto referenciado com a opção de especificar que uma exceção será gerada se o objeto ainda não tiver sido criado. (Herdado de SqlSmoObject.)
Método protegido CheckObjectStateImpl Verifica o estado de um SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido CheckVersion100 Verifica se a versão do SQL Server é SQL Server 2008. (Herdado de SqlSmoObject.)
Método protegido CheckVersion80 Verifica a validade do objeto no SQL Server 2000. (Herdado de SqlSmoObject.)
Método protegido CheckVersion80SP3 Verifica a validade do objeto no SQL Server 2000 SP3. (Herdado de SqlSmoObject.)
Método protegido CheckVersion90 Verifica a validade do objeto no SQL Server 2005. (Herdado de SqlSmoObject.)
Método protegido CheckVersionBelow90 Verifica se a versão do SQL Server é anterior ao SQL Server 2005. (Herdado de SqlSmoObject.)
Método protegido CleanObject Define o objeto como estado inalterado. (Herdado de SqlSmoObject.)
Método público Create Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
Método protegido CreateImpl Cria um objeto com as opções do script. (Herdado de SqlSmoObject.)
Método protegido CreateImplFinish Método chamado quando o evento de criação é concluído. (Herdado de SqlSmoObject.)
Método protegido CreateImplInit Método chamado quando o evento de criação é inicializado. (Herdado de SqlSmoObject.)
Método público DeleteLogs(DateTime) Deletes job step log files that are older than the specified date.
Método público DeleteLogs(Int32) Deletes job step log files that have log numbers lower than the specified value.
Método público Discover Descobre uma lista do tipo Object. (Herdado de SqlSmoObject.)
Método público Drop Removes the referenced job step.
Método protegido DropImpl Remove um SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido DropImplWorker Chama os métodos de remoção. (Herdado de SqlSmoObject.)
Método público EnumLogs Returns an enumerated list of the job step log files.
Método protegido EnumScriptImpl Enumera scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.)
Método protegido EnumScriptImplWorker Chama os métodos que enumeram scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.)
Método protegido EnumScriptImplWorkerSOChanged Retorna uma cadeia de caracteres IEnumerable que descreve as opções de script de um objeto. (Herdado de SqlSmoObject.)
Método público Equals (Herdado de Object.)
Método protegido ExecuteNonQuery (Herdado de SqlSmoObject.)
Método protegido Finalize (Herdado de Object.)
Método protegido FormatSqlVariant Formata um objeto como tipo SqlVariant. (Herdado de SqlSmoObject.)
Método protegido GenerateDataSpaceFileStreamScript Gera um script para criar arquivo de dados. (Herdado de SqlSmoObject.)
Método protegido GenerateDataSpaceScript Gera um script para alocar espaço no arquivo de dados. (Herdado de SqlSmoObject.)
Método protegido GetBindDefaultScript Obtém o script que associa padrões especificados pelos parâmetros defSchema e defName. (Herdado de SqlSmoObject.)
Método protegido GetBindRuleScript Obtém o script que especifica as regras de associação. (Herdado de SqlSmoObject.)
Método protegido GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Atribui um parâmetro booliano do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Atribui uma propriedade booliana do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetDateTimeParameter Atribui a propriedade datetime do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetDateTimeParameterAsInt Atribuirá a propriedade datetime do SqlSmoObject como um valor inteiro se a propriedade datetime não for nula. (Herdado de SqlSmoObject.)
Método protegido GetDBName Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. Gets the database name that is associated with the object. (Herdado de AgentObjectBase.)
Método protegido GetEnumParameter Atribui uma propriedade de enumeração do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetFragOptionString Obtém um objeto FragmentationOption como um valor de cadeia de caracteres. (Herdado de SqlSmoObject.)
Método protegido GetGuidParameter Atribui uma propriedade Guid do SqlSmoObject. (Herdado de SqlSmoObject.)
Método público GetHashCode (Herdado de Object.)
Método protegido GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetPropValue Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptional Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetRealValue Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetScriptingOptionsForCreate Obtém ScriptingOptions para o objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetServerName Obtém o nome da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.)
Método protegido GetServerObject Obtém o servidor do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetSqlServerVersionName Obtém o nome da versão da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.)
Método protegido GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetTimeSpanParameterAsInt Atribui um parâmetro de período de tempo do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método público GetType (Herdado de Object.)
Método protegido GetUrnRecursive(StringBuilder) Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido GetUrnRecursive(StringBuilder, UrnIdOption) Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ImplInitialize Inicializa os campos do objeto SqlSmoObject. (Herdado de SqlSmoObject.)
Método público Initialize() () () () Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.)
Método público Initialize(Boolean) Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.)
Método protegido IsObjectDirty Verifica se as propriedades de objeto foram modificadas e se as alterações ainda não foram persistidas na instância do SQL Server. (Herdado de SqlSmoObject.)
Método protegido IsObjectInitialized Verifica se o objeto foi inicializado. (Herdado de SqlSmoObject.)
Método protegido IsObjectInSpace Verifica se o objeto está isolado ou conectado com a instância do SQL Server. (Herdado de SqlSmoObject.)
Método protegido IsVersion80SP3 Determina se a versão do SQL Server é SQL Server 2000 com SP3. (Herdado de SqlSmoObject.)
Método protegido IsVersion90AndAbove Determina se a versão do SQL Server é SQL Server 2005 ou posterior. (Herdado de SqlSmoObject.)
Método protegido MarkDropped Define o SqlSmoState como removido. (Herdado de SqlSmoObject.)
Método protegido MarkForDropImpl Define o SqlSmoState como removido. (Herdado de SqlSmoObject.)
Método protegido MemberwiseClone (Herdado de Object.)
Método protegido PostAlter Método ativado depois da alteração do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido PostCreate Método ativado depois da criação do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido PostDrop Método ativado depois da remoção do SqlSmoObject. (Herdado de SqlSmoObject.)
Método público Refresh Atualiza o objeto e recupera as propriedades na próxima vez que o objeto é acessado. (Herdado de SqlSmoObject.)
Método público Rename Renames the job step.
Método protegido RenameImpl Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida. (Herdado de NamedSmoObject.)
Método protegido RenameImplWorker Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida. (Herdado de NamedSmoObject.)
Método público Script() () () () Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step.
Método público Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step as specified by the scripting options.
Método protegido ScriptAlter Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.)
Método protegido ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (Herdado de NamedSmoObject.)
Método protegido ScriptCreate Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.)
Método protegido ScriptDdl Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.)
Método protegido ScriptDrop Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.)
Método protegido ScriptImpl() () () () Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ScriptImpl(ScriptingOptions) Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ScriptImplWorker Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido ScriptOwner Alters the script owner authorization. (Herdado de NamedSmoObject.)
Método protegido ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (Herdado de NamedSmoObject.)
Método protegido SetParentImpl Define o pai do SqlSmoObject como o parâmetro newParent. (Herdado de SqlSmoObject.)
Método protegido SetSchemaOwned Sets the schema owned value. (Herdado de NamedSmoObject.)
Método público ToString Retorna um String que representa o objeto referenciado. (Herdado de SqlSmoObject.)
Método protegido TouchImpl Não implementado. (Herdado de SqlSmoObject.)
Método protegido UnbindDefaultImpl Desassocia as colunas padrão do SqlSmoObject. (Herdado de SqlSmoObject.)
Método protegido UnbindRuleImpl Desassocia as regras do SqlSmoObject. (Herdado de SqlSmoObject.)
Método público Validate Validates the state of an object. (Herdado de SmoObjectBase.)

Início

Eventos

  Nome Descrição
Evento público PropertyChanged Representa o evento que ocorre quando uma propriedade é alterada. (Herdado de SqlSmoObject.)
Evento público PropertyMetadataChanged Representa o evento que ocorre quando os metadados da propriedade são alterados. (Herdado de SqlSmoObject.)

Início

Campos

  Nome Descrição
Campo protegido m_ExtendedProperties Representa uma propriedade definida para estender as propriedades fornecidas por um SqlSmoObject. (Herdado de SqlSmoObject.)
Campo protegido singletonParent Representa o pai do singleton. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .Discover Descobre quaisquer dependências. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetDomainRoot Retorna a raiz do domínio. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetParent Obtém o pai do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetPropertyType Obtém o tipo da propriedade especificada. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetPropertyValue Obtém o valor da propriedade especificada. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .GetUrn Obtém o Unified Resource Name do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .Resolve Obtém a instância que contém as informações sobre o objeto a partir do Unified Resource Name do objeto. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .SetObjectState Define o estado do objeto como o valor SfcObjectState especificado. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject. . :: . .SetPropertyValue Define o valor da propriedade. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider. . :: . .GetPropertySet Obtém a referência da interface para o conjunto de propriedades deste objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)

Início

Comentários

SQL Server Agent jobs contain one or more execution units called steps. Each job step contains a textual command, type of execution that specifies command interpretation, and logic that determines the behavior of the job if the step succeeds or fails. For example, a job step can contain:

  • The command text. For example:

    DBCC CHECKDB ('Northwind') WITH NO_INFOMSGS

  • A job step execution type: Transact-SQL for example.

  • An indication that the job should stop if the step fails.

With the JobStep object, you can do the following:

  • Create a SQL Server Agent job step.

  • Remove a job step from a SQL Server Agent job.

  • Manage existing job steps by changing, for example, the command text or the actions taken on success or failure of the step.

  • Obtain details about the last attempted execution of the step.

To get JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role.

To set JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the owner of the job step, or be a member of the sysadmin fixed server role.

To create a job step, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role. The user must also have permission on any proxy accounts used by the job step.

To drop a job step, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the job step, or be a member of the sysadmin fixed server role.

Thread Safety

Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads. 

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.