Sdílet prostřednictvím

ApplicationRole Class

  • Článek

The ApplicationRole object represents a security role that is used to set access privileges from an application regardless of the user's permissions.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ApplicationRole

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None Or AutomatedPolicyEvaluationMode.Enforce Or AutomatedPolicyEvaluationMode.CheckOnChanges Or AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
<StateChangeEventAttribute("CREATE_APPLICATION_ROLE", "APPLICATION ROLE")> _
<StateChangeEventAttribute("ALTER_APPLICATION_ROLE", "APPLICATION ROLE")> _
Public NotInheritable Class ApplicationRole _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, IAlterable, IDroppable,  _
    IRenamable, IExtendedProperties, IScriptable
'Usage
Dim instance As ApplicationRole

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
[StateChangeEventAttribute("CREATE_APPLICATION_ROLE", "APPLICATION ROLE")]
[StateChangeEventAttribute("ALTER_APPLICATION_ROLE", "APPLICATION ROLE")]
public sealed class ApplicationRole : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, IAlterable, IDroppable, IRenamable, 
    IExtendedProperties, IScriptable

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None|AutomatedPolicyEvaluationMode::Enforce|AutomatedPolicyEvaluationMode::CheckOnChanges|AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
[StateChangeEventAttribute(L"CREATE_APPLICATION_ROLE", L"APPLICATION ROLE")]
[StateChangeEventAttribute(L"ALTER_APPLICATION_ROLE", L"APPLICATION ROLE")]
public ref class ApplicationRole sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, IAlterable, IDroppable, IRenamable, 
    IExtendedProperties, IScriptable

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.None|AutomatedPolicyEvaluationMode.Enforce|AutomatedPolicyEvaluationMode.CheckOnChanges|AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
[<StateChangeEventAttribute("CREATE_APPLICATION_ROLE", "APPLICATION ROLE")>]
[<StateChangeEventAttribute("ALTER_APPLICATION_ROLE", "APPLICATION ROLE")>]
type ApplicationRole =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
    end

public final class ApplicationRole extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, IAlterable, IDroppable, IRenamable, IExtendedProperties, IScriptable

The ApplicationRole type exposes the following members.

Constructors

  Name Description
Public method ApplicationRole() Initializes a new instance of the ApplicationRole class.
Public method ApplicationRole(Database, String) Initializes a new instance of the ApplicationRole class.

Top

Properties

  Name Description
Public property CreateDate Gets the date and time when the application role was created.
Public property DateLastModified Gets the date and time when the application role was last modified.
Public property DefaultSchema Gets or sets the default schema for the application role.
Public property Events Gets the events that are supported by the application role.
Public property ExtendedProperties Represents a collection of ExtendedProperty objects that contain information about the extended properties of the ApplicationRole object.
Public property ID Gets the ID value that uniquely identifies the application role.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Parent Gets the Database object that is the parent of the ApplicationRole object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any ApplicationRole object property changes on the instance of Microsoft SQL Server.
Public method ChangePassword(SecureString) Modifies the password of the application role.
Public method ChangePassword(String) Modifies the password of the application role.
Public method Create(SecureString) Creates an application role on the instance of SQL Server as defined by the ApplicationRole object and with the specified password.
Public method Create(String) Creates an application role on the instance of SQL Server as defined by the ApplicationRole object and with the specified password.
Public method Deny(ObjectPermissionSet, String) Denies the specified permission for the specified grantee on the application role.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified permission for the specified grantees on the application role.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies access to the specified permission for the specified grantee and other users that the grantee granted the specified set of permissions on the application role.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified permission for the specified grantees on the application role.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the application role from the instance of Microsoft SQL Server.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the application role.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the application role.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for a specified permission on the application role.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the application role.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the application role.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the application role.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants the specified permission and the ability to grant the set of permissions to the specified grantee on the application role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants the specified permission and the ability to grant the set of permissions to other users on the application role.
Public method Grant(ObjectPermissionSet, String, Boolean, String) Grants the specified set of permissions and the ability to grant the set of permissions to other users on the application role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants the specified set of permissions and the ability to grant the set of permissions to other users on the application role under an assumed role.
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Renames the application role.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the application role.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the application role.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the application role and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the set of permissions from other users.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes previously granted permissions from grantees on the application role and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes previously granted permissions from a grantee on the application role and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes previously granted permissions from grantees on the application role and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Script() Generates a Transact-SQL script that can be used to re-create the application role.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the application role as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode.

Top

Remarks

To get ApplicationRole object properties, users can be a member of the public fixed server role.

To set any ApplicationRole object properties and run the Alter method, users must have ALTER permission on the database.

To create a ApplicationRole object, users must have ALTER ANY APPLICATION role permission on the parent database.

To drop an ApplicationRole object, users must be the owner of the application role or have ALTER ANY APPLICATION role permission on the parent database.

To grant, deny, and revoke permission on the ApplicationRole object, users must have CONTROL permission on the application role.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Managing Users, Roles, and Logins

Application Roles

CREATE APPLICATION ROLE (Transact-SQL)