Compartilhar via


Classe ProxyAccount

The ProxyAccount class represents a SQL Server Agent proxy account.

Hierarquia de herança

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase
          Microsoft.SqlServer.Management.Smo.Agent.ProxyAccount

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

Sintaxe

'Declaração
Public NotInheritable Class ProxyAccount _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Uso
Dim instance As ProxyAccount
public sealed class ProxyAccount : AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
public ref class ProxyAccount sealed : public AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
type ProxyAccount =  
    class 
        inherit AgentObjectBase 
        interface IAlterable 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IScriptable 
    end
public final class ProxyAccount extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

O tipo ProxyAccount expõe os membros a seguir.

Construtores

  Nome Descrição
Método público ProxyAccount() Initializes a new instance of the ProxyAccount class.
Método público ProxyAccount(JobServer, String) Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service, with the specified name.
Método público ProxyAccount(JobServer, String, String) Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential.
Método público ProxyAccount(JobServer, String, String, Boolean) Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential. It also specifies whether the proxy account is enabled.
Método público ProxyAccount(JobServer, String, String, Boolean, String) Initializes a new instance of the ProxyAccount class on the specified SQL Server Agent Service with the specified name and credential. It also specifies whether the proxy account is enabled.

Início

Propriedades

  Nome Descrição
Propriedade pública CredentialID Gets the ID value that uniquely identifies the proxy agent credential.
Propriedade pública CredentialIdentity Gets the credential identity.
Propriedade pública CredentialName Gets or sets the name of the credential.
Propriedade pública Description Gets or sets a textual description of the proxy account.
Propriedade pública ID Gets the ID value that uniquely identifies the proxy account.
Propriedade pública IsEnabled Gets or sets the Boolean property value that specifies whether the proxy account is enabled or not.
Propriedade pública Name Gets or sets the name of the object. (Herdado de NamedSmoObject.)
Propriedade pública Parent Gets or sets the JobServer object that is the parent of the ProxyAccount object.
Propriedade pública Properties Gets a collection of Property objects that represent the object properties. (Herdado de SqlSmoObject.)
Propriedade pública State Gets the state of the referenced object. (Herdado de SmoObjectBase.)
Propriedade pública Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (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 público AddLogin Adds a Microsoft Windows login account to the proxy account.
Método público AddMsdbRole Adds a Microsoft SQL Server database role to the proxy account.
Método público AddServerRole Adds a Microsoft SQL Server server role to the proxy account.
Método público AddSubSystem Adds a Microsoft SQL Server subsystem to the proxy account.
Método público Alter Updates any ProxyAccount object property changes on an instance of Microsoft SQL Server.
Método público Create Creates a job on the instance of Microsoft SQL Server as defined by the ProxyAccount object.
Método público Discover Discovers a list of type Object. (Herdado de SqlSmoObject.)
Método público Drop Removes an existing proxy account.
Método público EnumLogins Enumerates a list of Microsoft Windows login accounts associated with the referenced proxy account.
Método público EnumMsdbRoles Enumerates a list of Microsoft SQL Server database roles associated with the referenced proxy account.
Método público EnumServerRoles Enumerates a list of Microsoft SQL Server server roles associated with the referenced proxy account.
Método público EnumSubSystems Enumerates a list of Microsoft SQL Server subsystems associated with the referenced proxy account.
Método público Equals (Herdado de Object.)
Método protegido FormatSqlVariant Formats an object as SqlVariant type. (Herdado de SqlSmoObject.)
Método protegido GetContextDB Gets the context database that is associated with this object. (Herdado de SqlSmoObject.)
Método protegido GetDBName Gets the database name that is associated with the object. (Herdado de AgentObjectBase.)
Método público GetHashCode (Herdado de Object.)
Método protegido GetPropValue Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptional Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetServerObject Gets the server of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método público GetType (Herdado de Object.)
Método público Initialize() Initializes the object and forces the properties be loaded. (Herdado de SqlSmoObject.)
Método público Initialize(Boolean) Initializes the object and forces the properties be loaded. (Herdado de SqlSmoObject.)
Método protegido IsObjectInitialized Verifies whether the object has been initialized. (Herdado de SqlSmoObject.)
Método protegido IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Herdado de SqlSmoObject.)
Método público Reassign Reassign the job steps that refer to the current proxy account name to a new proxy account name.
Método público Refresh Refreshes the object and retrieves properties when the object is next accessed. (Herdado de SqlSmoObject.)
Método público RemoveLogin Removes a Microsoft Windows login account from the referenced proxy account.
Método público RemoveMsdbRole Removes a Microsoft SQL Server database role from the referenced proxy account.
Método público RemoveServerRole Removes a Microsoft SQL Server server role from the referenced proxy account.
Método público RemoveSubSystem Removes a Microsoft SQL Server subsystem from the referenced proxy account.
Método público Rename Renames a proxy account.
Método público Script() Generates a Transact-SQL script that can be used to re-create the SQL Server Agent proxy account.
Método público Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the SQL Server Agent proxy account as specified by the scripting options.
Método protegido SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Herdado de SqlSmoObject.)
Método público ToString Returns a String that represents the referenced object. (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 Represents the event that occurs when a property is changed. (Herdado de SqlSmoObject.)
Evento público PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. 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 Returns the root of the domain. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetParent Gets the parent of this object. 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 Gets the type of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. 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 Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Herdado de SqlSmoObject.)

Início

Comentários

Proxy accounts allow for the impersonation of logins, server roles, and database roles when executing a job step in any subsystem other than Transact-SQL. In SQL Server Management Objects (SMO), the ProxyAccount object allows programmatic control over proxy accounts. The ProxyAccount object describes the relationship between an alternative (proxy) login account, a subsystem that is used for job step execution, and a list of Microsoft SQL Server logins, server roles, and database roles.

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

To set ProxyAccount object properties, users must be a member of the sysadmin fixed server role.

To create or drop a proxy account, users must be a member of the sysadmin fixed server role.

To add or remove subsystems from the proxy account, users must 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.

Exemplos

Agendando tarefas administrativas automáticas no SQL Server Agent

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.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo.Agent

Outros recursos

Agendando tarefas administrativas automáticas no SQL Server Agent

Tarefas de administração automatizadas (SQL Server Agent)

sp_add_proxy (Transact-SQL)

sp_grant_proxy_to_subsystem (Transact-SQL)