Export (0) Print
Expand All

ApplicationRole Class

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

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

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

The ApplicationRole type exposes the following members.

  NameDescription
Public methodApplicationRole()Initializes a new instance of the ApplicationRole class.
Public methodApplicationRole(Database, String)Initializes a new instance of the ApplicationRole class.
Top

  NameDescription
Public propertyCreateDateGets the date and time when the application role was created.
Public propertyDateLastModifiedGets the date and time when the application role was last modified.
Public propertyDefaultSchemaGets or sets the default schema for the application role.
Public propertyEventsGets the events that are supported by the application role.
Public propertyExtendedPropertiesRepresents a collection of ExtendedProperty objects that contain information about the extended properties of the ApplicationRole object.
Public propertyIDGets the ID value that uniquely identifies the application role.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyParentGets the Database object that is the parent of the ApplicationRole object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any ApplicationRole object property changes on the instance of Microsoft SQL Server.
Public methodChangePassword(SecureString)Modifies the password of the application role.
Public methodChangePassword(String)Modifies the password of the application role.
Public methodCreate(SecureString)Creates an application role on the instance of SQL Server as defined by the ApplicationRole object and with the specified password.
Public methodCreate(String)Creates an application role on the instance of SQL Server as defined by the ApplicationRole object and with the specified password.
Public methodDeny(ObjectPermissionSet, String)Denies the specified permission for the specified grantee on the application role.
Public methodDeny(ObjectPermissionSet, array<String>)Denies the specified permission for the specified grantees on the application role.
Public methodDeny(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 methodDeny(ObjectPermissionSet, array<String>, Boolean)Denies the specified permission for the specified grantees on the application role.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the application role from the instance of Microsoft SQL Server.
Public methodEnumObjectPermissions()Enumerates a list of object permissions for the application role.
Public methodEnumObjectPermissions(String)Enumerates a list of object permissions for a specified grantee on the application role.
Public methodEnumObjectPermissions(ObjectPermissionSet)Enumerates a list of object permissions for a specified permission on the application role.
Public methodEnumObjectPermissions(String, ObjectPermissionSet)Enumerates a list of object permissions for a specified grantee and a specified permission on the application role.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodGrant(ObjectPermissionSet, String)Grants the specified set of permissions to the specified grantee on the application role.
Public methodGrant(ObjectPermissionSet, array<String>)Grants the specified set of permissions to the specified grantees on the application role.
Public methodGrant(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 methodGrant(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 methodGrant(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 methodGrant(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 methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRenameRenames the application role.
Public methodRevoke(ObjectPermissionSet, String)Revokes a previously granted set of permissions from a grantee on the application role.
Public methodRevoke(ObjectPermissionSet, array<String>)Revokes a previously granted set of permissions from a list of grantees on the application role.
Public methodRevoke(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 methodRevoke(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 methodRevoke(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 methodRevoke(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 methodScript()Generates a Transact-SQL script that can be used to re-create the application role.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the application role as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject::DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetParentGets 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 methodIAlienObject::GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::GetUrnGets 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 methodIAlienObject::ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject::SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider::GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode::IsDesignModeGets a Boolean value that indicates whether the object supports design mode.
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft